quicksight

package module
v1.20.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 8, 2022 License: Apache-2.0 Imports: 32 Imported by: 23

Documentation

Overview

Package quicksight provides the API client, operations, and parameter types for Amazon QuickSight.

Amazon QuickSight API Reference Amazon QuickSight is a fully managed, serverless business intelligence service for the Amazon Web Services Cloud that makes it easy to extend data and insights to every user in your organization. This API reference contains documentation for a programming interface that you can use to manage Amazon QuickSight.

Index

Constants

View Source 
const ServiceAPIVersion = "2018-04-01"
View Source 
const ServiceID = "QuickSight"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions added in v1.0.0 

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver 

func WithEndpointResolver(v EndpointResolver) func(*Options)

WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.

Types

type CancelIngestionInput 

type CancelIngestionInput struct {

	// The Amazon Web Services account ID.
	//
	// This member is required.
	AwsAccountId *string

	// The ID of the dataset used in the ingestion.
	//
	// This member is required.
	DataSetId *string

	// An ID for the ingestion.
	//
	// This member is required.
	IngestionId *string
	// contains filtered or unexported fields
}

type CancelIngestionOutput 

type CancelIngestionOutput struct {

	// The Amazon Resource Name (ARN) for the data ingestion.
	Arn *string

	// An ID for the ingestion.
	IngestionId *string

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client provides the API client to make operations call for Amazon QuickSight.

func New 

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig 

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) CancelIngestion 

func (c *Client) CancelIngestion(ctx context.Context, params *CancelIngestionInput, optFns ...func(*Options)) (*CancelIngestionOutput, error)

Cancels an ongoing ingestion of data into SPICE.

func (*Client) CreateAccountCustomization 

func (c *Client) CreateAccountCustomization(ctx context.Context, params *CreateAccountCustomizationInput, optFns ...func(*Options)) (*CreateAccountCustomizationOutput, error)

Creates Amazon QuickSight customizations the current Amazon Web Services Region. Currently, you can add a custom default theme by using the CreateAccountCustomization or UpdateAccountCustomization API operation. To further customize Amazon QuickSight by removing Amazon QuickSight sample assets and videos for all new users, see Customizing Amazon QuickSight (https://docs.aws.amazon.com/quicksight/latest/user/customizing-quicksight.html) in the Amazon QuickSight User Guide. You can create customizations for your Amazon Web Services account or, if you specify a namespace, for a QuickSight namespace instead. Customizations that apply to a namespace always override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the DescribeAccountCustomization API operation. Before you use the CreateAccountCustomization API operation to add a theme as the namespace default, make sure that you first share the theme with the namespace. If you don't share it with the namespace, the theme isn't visible to your users even if you make it the default theme. To check if the theme is shared, view the current permissions by using the DescribeThemePermissions (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeThemePermissions.html) API operation. To share the theme, grant permissions by using the UpdateThemePermissions (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateThemePermissions.html) API operation.

func (*Client) CreateAnalysis added in v0.29.0 

func (c *Client) CreateAnalysis(ctx context.Context, params *CreateAnalysisInput, optFns ...func(*Options)) (*CreateAnalysisOutput, error)

Creates an analysis in Amazon QuickSight.

func (*Client) CreateDashboard 

func (c *Client) CreateDashboard(ctx context.Context, params *CreateDashboardInput, optFns ...func(*Options)) (*CreateDashboardOutput, error)

Creates a dashboard from a template. To first create a template, see the CreateTemplate (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CreateTemplate.html) API operation. A dashboard is an entity in Amazon QuickSight that identifies Amazon QuickSight reports, created from analyses. You can share Amazon QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different Amazon Web Services account.

func (*Client) CreateDataSet 

func (c *Client) CreateDataSet(ctx context.Context, params *CreateDataSetInput, optFns ...func(*Options)) (*CreateDataSetOutput, error)

Creates a dataset. This operation doesn't support datasets that include uploaded files as a source.

func (*Client) CreateDataSource 

func (c *Client) CreateDataSource(ctx context.Context, params *CreateDataSourceInput, optFns ...func(*Options)) (*CreateDataSourceOutput, error)

Creates a data source.

func (*Client) CreateFolder added in v1.6.0 

func (c *Client) CreateFolder(ctx context.Context, params *CreateFolderInput, optFns ...func(*Options)) (*CreateFolderOutput, error)

Creates an empty shared folder.

func (*Client) CreateFolderMembership added in v1.6.0 

func (c *Client) CreateFolderMembership(ctx context.Context, params *CreateFolderMembershipInput, optFns ...func(*Options)) (*CreateFolderMembershipOutput, error)

Adds an asset, such as a dashboard, analysis, or dataset into a folder.

func (*Client) CreateGroup 

func (c *Client) CreateGroup(ctx context.Context, params *CreateGroupInput, optFns ...func(*Options)) (*CreateGroupOutput, error)

Creates an Amazon QuickSight group. The permissions resource is arn:aws:quicksight:us-east-1::group/default/ . The response is a group object.

func (*Client) CreateGroupMembership 

func (c *Client) CreateGroupMembership(ctx context.Context, params *CreateGroupMembershipInput, optFns ...func(*Options)) (*CreateGroupMembershipOutput, error)

Adds an Amazon QuickSight user to an Amazon QuickSight group.

func (*Client) CreateIAMPolicyAssignment 

func (c *Client) CreateIAMPolicyAssignment(ctx context.Context, params *CreateIAMPolicyAssignmentInput, optFns ...func(*Options)) (*CreateIAMPolicyAssignmentOutput, error)

Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN). This policy assignment is attached to the specified groups or users of Amazon QuickSight. Assignment names are unique per Amazon Web Services account. To avoid overwriting rules in other namespaces, use assignment names that are unique.

func (*Client) CreateIngestion 

func (c *Client) CreateIngestion(ctx context.Context, params *CreateIngestionInput, optFns ...func(*Options)) (*CreateIngestionOutput, error)

Creates and starts a new SPICE ingestion for a dataset. You can manually refresh datasets in an Enterprise edition account 32 times in a 24-hour period. You can manually refresh datasets in a Standard edition account 8 times in a 24-hour period. Each 24-hour period is measured starting 24 hours before the current date and time. Any ingestions operating on tagged datasets inherit the same tags automatically for use in access control. For an example, see How do I create an IAM policy to control access to Amazon EC2 resources using tags? (http://aws.amazon.com/premiumsupport/knowledge-center/iam-ec2-resource-tags/) in the Amazon Web Services Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.

func (*Client) CreateNamespace 

func (c *Client) CreateNamespace(ctx context.Context, params *CreateNamespaceInput, optFns ...func(*Options)) (*CreateNamespaceOutput, error)

(Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight. A namespace allows you to isolate the Amazon QuickSight users and groups that are registered for that namespace. Users that access the namespace can share assets only with other users or groups in the same namespace. They can't see users and groups in other namespaces. You can create a namespace after your Amazon Web Services account is subscribed to Amazon QuickSight. The namespace must be unique within the Amazon Web Services account. By default, there is a limit of 100 namespaces per Amazon Web Services account. To increase your limit, create a ticket with Amazon Web Services Support.

func (*Client) CreateTemplate 

func (c *Client) CreateTemplate(ctx context.Context, params *CreateTemplateInput, optFns ...func(*Options)) (*CreateTemplateOutput, error)

Creates a template from an existing Amazon QuickSight analysis or template. You can use the resulting template to create a dashboard. A template is an entity in Amazon QuickSight that encapsulates the metadata required to create an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.

func (*Client) CreateTemplateAlias 

func (c *Client) CreateTemplateAlias(ctx context.Context, params *CreateTemplateAliasInput, optFns ...func(*Options)) (*CreateTemplateAliasOutput, error)

Creates a template alias for a template.

func (*Client) CreateTheme 

func (c *Client) CreateTheme(ctx context.Context, params *CreateThemeInput, optFns ...func(*Options)) (*CreateThemeOutput, error)

Creates a theme. A theme is set of configuration options for color and layout. Themes apply to analyses and dashboards. For more information, see Using Themes in Amazon QuickSight (https://docs.aws.amazon.com/quicksight/latest/user/themes-in-quicksight.html) in the Amazon QuickSight User Guide.

func (*Client) CreateThemeAlias 

func (c *Client) CreateThemeAlias(ctx context.Context, params *CreateThemeAliasInput, optFns ...func(*Options)) (*CreateThemeAliasOutput, error)

Creates a theme alias for a theme.

func (*Client) DeleteAccountCustomization 

func (c *Client) DeleteAccountCustomization(ctx context.Context, params *DeleteAccountCustomizationInput, optFns ...func(*Options)) (*DeleteAccountCustomizationOutput, error)

Deletes all Amazon QuickSight customizations in this Amazon Web Services Region for the specified Amazon Web Services account and Amazon QuickSight namespace.

func (*Client) DeleteAnalysis added in v0.29.0 

func (c *Client) DeleteAnalysis(ctx context.Context, params *DeleteAnalysisInput, optFns ...func(*Options)) (*DeleteAnalysisOutput, error)

Deletes an analysis from Amazon QuickSight. You can optionally include a recovery window during which you can restore the analysis. If you don't specify a recovery window value, the operation defaults to 30 days. Amazon QuickSight attaches a DeletionTime stamp to the response that specifies the end of the recovery window. At the end of the recovery window, Amazon QuickSight deletes the analysis permanently. At any time before recovery window ends, you can use the RestoreAnalysis API operation to remove the DeletionTime stamp and cancel the deletion of the analysis. The analysis remains visible in the API until it's deleted, so you can describe it but you can't make a template from it. An analysis that's scheduled for deletion isn't accessible in the Amazon QuickSight console. To access it in the console, restore it. Deleting an analysis doesn't delete the dashboards that you publish from it.

func (*Client) DeleteDashboard 

func (c *Client) DeleteDashboard(ctx context.Context, params *DeleteDashboardInput, optFns ...func(*Options)) (*DeleteDashboardOutput, error)

Deletes a dashboard.

func (*Client) DeleteDataSet 

func (c *Client) DeleteDataSet(ctx context.Context, params *DeleteDataSetInput, optFns ...func(*Options)) (*DeleteDataSetOutput, error)

Deletes a dataset.

func (*Client) DeleteDataSource 

func (c *Client) DeleteDataSource(ctx context.Context, params *DeleteDataSourceInput, optFns ...func(*Options)) (*DeleteDataSourceOutput, error)

Deletes the data source permanently. This operation breaks all the datasets that reference the deleted data source.

func (*Client) DeleteFolder added in v1.6.0 

func (c *Client) DeleteFolder(ctx context.Context, params *DeleteFolderInput, optFns ...func(*Options)) (*DeleteFolderOutput, error)

Deletes an empty folder.

func (*Client) DeleteFolderMembership added in v1.6.0 

func (c *Client) DeleteFolderMembership(ctx context.Context, params *DeleteFolderMembershipInput, optFns ...func(*Options)) (*DeleteFolderMembershipOutput, error)

Removes an asset, such as a dashboard, analysis, or dataset, from a folder.

func (*Client) DeleteGroup 

func (c *Client) DeleteGroup(ctx context.Context, params *DeleteGroupInput, optFns ...func(*Options)) (*DeleteGroupOutput, error)

Removes a user group from Amazon QuickSight.

func (*Client) DeleteGroupMembership 

func (c *Client) DeleteGroupMembership(ctx context.Context, params *DeleteGroupMembershipInput, optFns ...func(*Options)) (*DeleteGroupMembershipOutput, error)

Removes a user from a group so that the user is no longer a member of the group.

func (*Client) DeleteIAMPolicyAssignment 

func (c *Client) DeleteIAMPolicyAssignment(ctx context.Context, params *DeleteIAMPolicyAssignmentInput, optFns ...func(*Options)) (*DeleteIAMPolicyAssignmentOutput, error)

Deletes an existing IAM policy assignment.

func (*Client) DeleteNamespace 

func (c *Client) DeleteNamespace(ctx context.Context, params *DeleteNamespaceInput, optFns ...func(*Options)) (*DeleteNamespaceOutput, error)

Deletes a namespace and the users and groups that are associated with the namespace. This is an asynchronous process. Assets including dashboards, analyses, datasets and data sources are not deleted. To delete these assets, you use the API operations for the relevant asset.

func (*Client) DeleteTemplate 

func (c *Client) DeleteTemplate(ctx context.Context, params *DeleteTemplateInput, optFns ...func(*Options)) (*DeleteTemplateOutput, error)

Deletes a template.

func (*Client) DeleteTemplateAlias 

func (c *Client) DeleteTemplateAlias(ctx context.Context, params *DeleteTemplateAliasInput, optFns ...func(*Options)) (*DeleteTemplateAliasOutput, error)

Deletes the item that the specified template alias points to. If you provide a specific alias, you delete the version of the template that the alias points to.

func (*Client) DeleteTheme 

func (c *Client) DeleteTheme(ctx context.Context, params *DeleteThemeInput, optFns ...func(*Options)) (*DeleteThemeOutput, error)

Deletes a theme.

func (*Client) DeleteThemeAlias 

func (c *Client) DeleteThemeAlias(ctx context.Context, params *DeleteThemeAliasInput, optFns ...func(*Options)) (*DeleteThemeAliasOutput, error)

Deletes the version of the theme that the specified theme alias points to. If you provide a specific alias, you delete the version of the theme that the alias points to.

func (*Client) DeleteUser 

func (c *Client) DeleteUser(ctx context.Context, params *DeleteUserInput, optFns ...func(*Options)) (*DeleteUserOutput, error)

Deletes the Amazon QuickSight user that is associated with the identity of the Identity and Access Management (IAM) user or role that's making the call. The IAM user isn't deleted as a result of this call.

func (*Client) DeleteUserByPrincipalId 

func (c *Client) DeleteUserByPrincipalId(ctx context.Context, params *DeleteUserByPrincipalIdInput, optFns ...func(*Options)) (*DeleteUserByPrincipalIdOutput, error)

Deletes a user identified by its principal ID.

func (*Client) DescribeAccountCustomization 

func (c *Client) DescribeAccountCustomization(ctx context.Context, params *DescribeAccountCustomizationInput, optFns ...func(*Options)) (*DescribeAccountCustomizationOutput, error)

Describes the customizations associated with the provided Amazon Web Services account and Amazon Amazon QuickSight namespace in an Amazon Web Services Region. The Amazon QuickSight console evaluates which customizations to apply by running this API operation with the Resolved flag included. To determine what customizations display when you run this command, it can help to visualize the relationship of the entities involved.

* Amazon Web Services account - The Amazon Web Services account exists at the top of the hierarchy. It has the potential to use all of the Amazon Web Services Regions and Amazon Web Services Services. When you subscribe to Amazon QuickSight, you choose one Amazon Web Services Region to use as your home Region. That's where your free SPICE capacity is located. You can use Amazon QuickSight in any supported Amazon Web Services Region.

* Amazon Web Services Region - In each Amazon Web Services Region where you sign in to Amazon QuickSight at least once, Amazon QuickSight acts as a separate instance of the same service. If you have a user directory, it resides in us-east-1, which is the US East (N. Virginia). Generally speaking, these users have access to Amazon QuickSight in any Amazon Web Services Region, unless they are constrained to a namespace. To run the command in a different Amazon Web Services Region, you change your Region settings. If you're using the CLI, you can use one of the following options:

* Use command line options (https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-options.html).

* Use named profiles (https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html).

* Run aws configure to change your default Amazon Web Services Region. Use Enter to key the same settings for your keys. For more information, see Configuring the CLI (https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html).

* Namespace - A QuickSight namespace is a partition that contains users and assets (data sources, datasets, dashboards, and so on). To access assets that are in a specific namespace, users and groups must also be part of the same namespace. People who share a namespace are completely isolated from users and assets in other namespaces, even if they are in the same Amazon Web Services account and Amazon Web Services Region.

* Applied customizations - Within an Amazon Web Services Region, a set of Amazon QuickSight customizations can apply to an Amazon Web Services account or to a namespace. Settings that you apply to a namespace override settings that you apply to an Amazon Web Services account. All settings are isolated to a single Amazon Web Services Region. To apply them in other Amazon Web Services Regions, run the CreateAccountCustomization command in each Amazon Web Services Region where you want to apply the same customizations.

func (*Client) DescribeAccountSettings 

func (c *Client) DescribeAccountSettings(ctx context.Context, params *DescribeAccountSettingsInput, optFns ...func(*Options)) (*DescribeAccountSettingsOutput, error)

Describes the settings that were used when your Amazon QuickSight subscription was first created in this Amazon Web Services account.

func (*Client) DescribeAnalysis added in v0.29.0 

func (c *Client) DescribeAnalysis(ctx context.Context, params *DescribeAnalysisInput, optFns ...func(*Options)) (*DescribeAnalysisOutput, error)

Provides a summary of the metadata for an analysis.

func (*Client) DescribeAnalysisPermissions added in v0.29.0 

func (c *Client) DescribeAnalysisPermissions(ctx context.Context, params *DescribeAnalysisPermissionsInput, optFns ...func(*Options)) (*DescribeAnalysisPermissionsOutput, error)

Provides the read and write permissions for an analysis.

func (*Client) DescribeDashboard 

func (c *Client) DescribeDashboard(ctx context.Context, params *DescribeDashboardInput, optFns ...func(*Options)) (*DescribeDashboardOutput, error)

Provides a summary for a dashboard.

func (*Client) DescribeDashboardPermissions 

func (c *Client) DescribeDashboardPermissions(ctx context.Context, params *DescribeDashboardPermissionsInput, optFns ...func(*Options)) (*DescribeDashboardPermissionsOutput, error)

Describes read and write permissions for a dashboard.

func (*Client) DescribeDataSet 

func (c *Client) DescribeDataSet(ctx context.Context, params *DescribeDataSetInput, optFns ...func(*Options)) (*DescribeDataSetOutput, error)

Describes a dataset. This operation doesn't support datasets that include uploaded files as a source.

func (*Client) DescribeDataSetPermissions 

func (c *Client) DescribeDataSetPermissions(ctx context.Context, params *DescribeDataSetPermissionsInput, optFns ...func(*Options)) (*DescribeDataSetPermissionsOutput, error)

Describes the permissions on a dataset. The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.

func (*Client) DescribeDataSource 

func (c *Client) DescribeDataSource(ctx context.Context, params *DescribeDataSourceInput, optFns ...func(*Options)) (*DescribeDataSourceOutput, error)

Describes a data source.

func (*Client) DescribeDataSourcePermissions 

func (c *Client) DescribeDataSourcePermissions(ctx context.Context, params *DescribeDataSourcePermissionsInput, optFns ...func(*Options)) (*DescribeDataSourcePermissionsOutput, error)

Describes the resource permissions for a data source.

func (*Client) DescribeFolder added in v1.6.0 

func (c *Client) DescribeFolder(ctx context.Context, params *DescribeFolderInput, optFns ...func(*Options)) (*DescribeFolderOutput, error)

Describes a folder.

func (*Client) DescribeFolderPermissions added in v1.6.0 

func (c *Client) DescribeFolderPermissions(ctx context.Context, params *DescribeFolderPermissionsInput, optFns ...func(*Options)) (*DescribeFolderPermissionsOutput, error)

Describes permissions for a folder.

func (*Client) DescribeFolderResolvedPermissions added in v1.6.0 

func (c *Client) DescribeFolderResolvedPermissions(ctx context.Context, params *DescribeFolderResolvedPermissionsInput, optFns ...func(*Options)) (*DescribeFolderResolvedPermissionsOutput, error)

Describes the folder resolved permissions. Permissions consists of both folder direct permissions and the inherited permissions from the ancestor folders.

func (*Client) DescribeGroup 

func (c *Client) DescribeGroup(ctx context.Context, params *DescribeGroupInput, optFns ...func(*Options)) (*DescribeGroupOutput, error)

Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).

func (*Client) DescribeIAMPolicyAssignment 

func (c *Client) DescribeIAMPolicyAssignment(ctx context.Context, params *DescribeIAMPolicyAssignmentInput, optFns ...func(*Options)) (*DescribeIAMPolicyAssignmentOutput, error)

Describes an existing IAM policy assignment, as specified by the assignment name.

func (*Client) DescribeIngestion 

func (c *Client) DescribeIngestion(ctx context.Context, params *DescribeIngestionInput, optFns ...func(*Options)) (*DescribeIngestionOutput, error)

Describes a SPICE ingestion.

func (*Client) DescribeIpRestriction added in v1.13.0 

func (c *Client) DescribeIpRestriction(ctx context.Context, params *DescribeIpRestrictionInput, optFns ...func(*Options)) (*DescribeIpRestrictionOutput, error)

Provides a summary and status of IP rules.

func (*Client) DescribeNamespace 

func (c *Client) DescribeNamespace(ctx context.Context, params *DescribeNamespaceInput, optFns ...func(*Options)) (*DescribeNamespaceOutput, error)

Describes the current namespace.

func (*Client) DescribeTemplate 

func (c *Client) DescribeTemplate(ctx context.Context, params *DescribeTemplateInput, optFns ...func(*Options)) (*DescribeTemplateOutput, error)

Describes a template's metadata.

func (*Client) DescribeTemplateAlias 

func (c *Client) DescribeTemplateAlias(ctx context.Context, params *DescribeTemplateAliasInput, optFns ...func(*Options)) (*DescribeTemplateAliasOutput, error)

Describes the template alias for a template.

func (*Client) DescribeTemplatePermissions 

func (c *Client) DescribeTemplatePermissions(ctx context.Context, params *DescribeTemplatePermissionsInput, optFns ...func(*Options)) (*DescribeTemplatePermissionsOutput, error)

Describes read and write permissions on a template.

func (*Client) DescribeTheme 

func (c *Client) DescribeTheme(ctx context.Context, params *DescribeThemeInput, optFns ...func(*Options)) (*DescribeThemeOutput, error)

Describes a theme.

func (*Client) DescribeThemeAlias 

func (c *Client) DescribeThemeAlias(ctx context.Context, params *DescribeThemeAliasInput, optFns ...func(*Options)) (*DescribeThemeAliasOutput, error)

Describes the alias for a theme.

func (*Client) DescribeThemePermissions 

func (c *Client) DescribeThemePermissions(ctx context.Context, params *DescribeThemePermissionsInput, optFns ...func(*Options)) (*DescribeThemePermissionsOutput, error)

Describes the read and write permissions for a theme.

func (*Client) DescribeUser 

func (c *Client) DescribeUser(ctx context.Context, params *DescribeUserInput, optFns ...func(*Options)) (*DescribeUserOutput, error)

Returns information about a user, given the user name.

func (*Client) GenerateEmbedUrlForAnonymousUser added in v1.7.0 

func (c *Client) GenerateEmbedUrlForAnonymousUser(ctx context.Context, params *GenerateEmbedUrlForAnonymousUserInput, optFns ...func(*Options)) (*GenerateEmbedUrlForAnonymousUserOutput, error)

Generates an embed URL that you can use to embed an Amazon QuickSight dashboard in your website, without having to register any reader users. Before you use this action, make sure that you have configured the dashboards and permissions. The following rules apply to the generated URL:

* It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.

* The URL validity period should not be confused with the actual session lifetime that can be customized using the SessionLifetimeInMinutes (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_GenerateEmbedUrlForAnonymousUser.html#QS-GenerateEmbedUrlForAnonymousUser-request-SessionLifetimeInMinutes) parameter. The resulting user session is valid for 15 minutes (default) to 10 hours (maximum).

* You are charged only when the URL is used or there is interaction with Amazon QuickSight.

For more information, see Embedded Analytics (https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics.html) in the Amazon QuickSight User Guide. For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal (https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-portal.html).

func (*Client) GenerateEmbedUrlForRegisteredUser added in v1.7.0 

func (c *Client) GenerateEmbedUrlForRegisteredUser(ctx context.Context, params *GenerateEmbedUrlForRegisteredUserInput, optFns ...func(*Options)) (*GenerateEmbedUrlForRegisteredUserOutput, error)

Generates an embed URL that you can use to embed an Amazon QuickSight experience in your website. This action can be used for any type of user registered in an Amazon QuickSight account. Before you use this action, make sure that you have configured the relevant Amazon QuickSight resource and permissions. The following rules apply to the generated URL:

* It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.

* The URL validity period should not be confused with the actual session lifetime that can be customized using the SessionLifetimeInMinutes (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_GenerateEmbedUrlForRegisteredUser.html#QS-GenerateEmbedUrlForRegisteredUser-request-SessionLifetimeInMinutes) parameter. The resulting user session is valid for 15 minutes (default) to 10 hours (maximum).

* You are charged only when the URL is used or there is interaction with Amazon QuickSight.

For more information, see Embedded Analytics (https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics.html) in the Amazon QuickSight User Guide. For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal (https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-portal.html).

func (*Client) GetDashboardEmbedUrl 

func (c *Client) GetDashboardEmbedUrl(ctx context.Context, params *GetDashboardEmbedUrlInput, optFns ...func(*Options)) (*GetDashboardEmbedUrlOutput, error)

Generates a session URL and authorization code that you can use to embed an Amazon Amazon QuickSight read-only dashboard in your web server code. Before you use this command, make sure that you have configured the dashboards and permissions. Currently, you can use GetDashboardEmbedURL only from the server, not from the user's browser. The following rules apply to the combination of URL and authorization code:

* They must be used together.

* They can be used one time only.

* They are valid for 5 minutes after you run this command.

* The resulting user session is valid for 10 hours.

For more information, see Embedding Analytics Using GetDashboardEmbedUrl (https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics-deprecated.html) in the Amazon QuickSight User Guide. For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal (https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-portal.html).

func (*Client) GetSessionEmbedUrl 

func (c *Client) GetSessionEmbedUrl(ctx context.Context, params *GetSessionEmbedUrlInput, optFns ...func(*Options)) (*GetSessionEmbedUrlOutput, error)

Generates a session URL and authorization code that you can use to embed the Amazon Amazon QuickSight console in your web server code. Use GetSessionEmbedUrl where you want to provide an authoring portal that allows users to create data sources, datasets, analyses, and dashboards. The users who access an embedded Amazon QuickSight console need belong to the author or admin security cohort. If you want to restrict permissions to some of these features, add a custom permissions profile to the user with the UpdateUser (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateUser.html) API operation. Use RegisterUser (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_RegisterUser.html) API operation to add a new user with a custom permission profile attached. For more information, see the following sections in the Amazon QuickSight User Guide:

* Embedding Analytics (https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics.html)

* Customizing Access to the Amazon QuickSight Console (https://docs.aws.amazon.com/quicksight/latest/user/customizing-permissions-to-the-quicksight-console.html)

func (*Client) ListAnalyses added in v0.29.0 

func (c *Client) ListAnalyses(ctx context.Context, params *ListAnalysesInput, optFns ...func(*Options)) (*ListAnalysesOutput, error)

Lists Amazon QuickSight analyses that exist in the specified Amazon Web Services account.

func (*Client) ListDashboardVersions 

func (c *Client) ListDashboardVersions(ctx context.Context, params *ListDashboardVersionsInput, optFns ...func(*Options)) (*ListDashboardVersionsOutput, error)

Lists all the versions of the dashboards in the Amazon QuickSight subscription.

func (*Client) ListDashboards 

func (c *Client) ListDashboards(ctx context.Context, params *ListDashboardsInput, optFns ...func(*Options)) (*ListDashboardsOutput, error)

Lists dashboards in an Amazon Web Services account.

func (*Client) ListDataSets 

func (c *Client) ListDataSets(ctx context.Context, params *ListDataSetsInput, optFns ...func(*Options)) (*ListDataSetsOutput, error)

Lists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region. The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*.

func (*Client) ListDataSources 

func (c *Client) ListDataSources(ctx context.Context, params *ListDataSourcesInput, optFns ...func(*Options)) (*ListDataSourcesOutput, error)

Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account.

func (*Client) ListFolderMembers added in v1.6.0 

func (c *Client) ListFolderMembers(ctx context.Context, params *ListFolderMembersInput, optFns ...func(*Options)) (*ListFolderMembersOutput, error)

List all assets (DASHBOARD, ANALYSIS, and DATASET) in a folder.

func (*Client) ListFolders added in v1.6.0 

func (c *Client) ListFolders(ctx context.Context, params *ListFoldersInput, optFns ...func(*Options)) (*ListFoldersOutput, error)

Lists all folders in an account.

func (*Client) ListGroupMemberships 

func (c *Client) ListGroupMemberships(ctx context.Context, params *ListGroupMembershipsInput, optFns ...func(*Options)) (*ListGroupMembershipsOutput, error)

Lists member users in a group.

func (*Client) ListGroups 

func (c *Client) ListGroups(ctx context.Context, params *ListGroupsInput, optFns ...func(*Options)) (*ListGroupsOutput, error)

Lists all user groups in Amazon QuickSight.

func (*Client) ListIAMPolicyAssignments 

func (c *Client) ListIAMPolicyAssignments(ctx context.Context, params *ListIAMPolicyAssignmentsInput, optFns ...func(*Options)) (*ListIAMPolicyAssignmentsOutput, error)

Lists IAM policy assignments in the current Amazon QuickSight account.

func (*Client) ListIAMPolicyAssignmentsForUser 

func (c *Client) ListIAMPolicyAssignmentsForUser(ctx context.Context, params *ListIAMPolicyAssignmentsForUserInput, optFns ...func(*Options)) (*ListIAMPolicyAssignmentsForUserOutput, error)

Lists all the IAM policy assignments, including the Amazon Resource Names (ARNs) for the IAM policies assigned to the specified user and group or groups that the user belongs to.

func (*Client) ListIngestions 

func (c *Client) ListIngestions(ctx context.Context, params *ListIngestionsInput, optFns ...func(*Options)) (*ListIngestionsOutput, error)

Lists the history of SPICE ingestions for a dataset.

func (*Client) ListNamespaces 

func (c *Client) ListNamespaces(ctx context.Context, params *ListNamespacesInput, optFns ...func(*Options)) (*ListNamespacesOutput, error)

Lists the namespaces for the specified Amazon Web Services account.

func (*Client) ListTagsForResource 

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

Lists the tags assigned to a resource.

func (*Client) ListTemplateAliases 

func (c *Client) ListTemplateAliases(ctx context.Context, params *ListTemplateAliasesInput, optFns ...func(*Options)) (*ListTemplateAliasesOutput, error)

Lists all the aliases of a template.

func (*Client) ListTemplateVersions 

func (c *Client) ListTemplateVersions(ctx context.Context, params *ListTemplateVersionsInput, optFns ...func(*Options)) (*ListTemplateVersionsOutput, error)

Lists all the versions of the templates in the current Amazon QuickSight account.

func (*Client) ListTemplates 

func (c *Client) ListTemplates(ctx context.Context, params *ListTemplatesInput, optFns ...func(*Options)) (*ListTemplatesOutput, error)

Lists all the templates in the current Amazon QuickSight account.

func (*Client) ListThemeAliases 

func (c *Client) ListThemeAliases(ctx context.Context, params *ListThemeAliasesInput, optFns ...func(*Options)) (*ListThemeAliasesOutput, error)

Lists all the aliases of a theme.

func (*Client) ListThemeVersions 

func (c *Client) ListThemeVersions(ctx context.Context, params *ListThemeVersionsInput, optFns ...func(*Options)) (*ListThemeVersionsOutput, error)

Lists all the versions of the themes in the current Amazon Web Services account.

func (*Client) ListThemes 

func (c *Client) ListThemes(ctx context.Context, params *ListThemesInput, optFns ...func(*Options)) (*ListThemesOutput, error)

Lists all the themes in the current Amazon Web Services account.

func (*Client) ListUserGroups 

func (c *Client) ListUserGroups(ctx context.Context, params *ListUserGroupsInput, optFns ...func(*Options)) (*ListUserGroupsOutput, error)

Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.

func (*Client) ListUsers 

func (c *Client) ListUsers(ctx context.Context, params *ListUsersInput, optFns ...func(*Options)) (*ListUsersOutput, error)

Returns a list of all of the Amazon QuickSight users belonging to this account.

func (*Client) RegisterUser 

func (c *Client) RegisterUser(ctx context.Context, params *RegisterUserInput, optFns ...func(*Options)) (*RegisterUserOutput, error)

Creates an Amazon QuickSight user, whose identity is associated with the Identity and Access Management (IAM) identity or role specified in the request.

func (*Client) RestoreAnalysis added in v0.29.0 

func (c *Client) RestoreAnalysis(ctx context.Context, params *RestoreAnalysisInput, optFns ...func(*Options)) (*RestoreAnalysisOutput, error)

Restores an analysis.

func (*Client) SearchAnalyses added in v0.29.0 

func (c *Client) SearchAnalyses(ctx context.Context, params *SearchAnalysesInput, optFns ...func(*Options)) (*SearchAnalysesOutput, error)

Searches for analyses that belong to the user specified in the filter. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

func (*Client) SearchDashboards 

func (c *Client) SearchDashboards(ctx context.Context, params *SearchDashboardsInput, optFns ...func(*Options)) (*SearchDashboardsOutput, error)

Searches for dashboards that belong to a user. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

func (*Client) SearchFolders added in v1.6.0 

func (c *Client) SearchFolders(ctx context.Context, params *SearchFoldersInput, optFns ...func(*Options)) (*SearchFoldersOutput, error)

Searches the subfolders in a folder.

func (*Client) TagResource 

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

Assigns one or more tags (key-value pairs) to the specified Amazon QuickSight resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. You can use the TagResource operation with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag. You can associate as many as 50 tags with a resource. Amazon QuickSight supports tagging on data set, data source, dashboard, and template. Tagging for Amazon QuickSight works in a similar way to tagging for other Amazon Web Services services, except for the following:

* You can't use tags to track costs for Amazon QuickSight. This isn't possible because you can't tag the resources that Amazon QuickSight costs are based on, for example Amazon QuickSight storage capacity (SPICE), number of users, type of users, and usage metrics.

* Amazon QuickSight doesn't currently support the tag editor for Resource Groups.

func (*Client) UntagResource 

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

Removes a tag or tags from a resource.

func (*Client) UpdateAccountCustomization 

func (c *Client) UpdateAccountCustomization(ctx context.Context, params *UpdateAccountCustomizationInput, optFns ...func(*Options)) (*UpdateAccountCustomizationOutput, error)

Updates Amazon QuickSight customizations the current Amazon Web Services Region. Currently, the only customization you can use is a theme. You can use customizations for your Amazon Web Services account or, if you specify a namespace, for a Amazon QuickSight namespace instead. Customizations that apply to a namespace override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the DescribeAccountCustomization API operation.

func (*Client) UpdateAccountSettings 

func (c *Client) UpdateAccountSettings(ctx context.Context, params *UpdateAccountSettingsInput, optFns ...func(*Options)) (*UpdateAccountSettingsOutput, error)

Updates the Amazon QuickSight settings in your Amazon Web Services account.

func (*Client) UpdateAnalysis added in v0.29.0 

func (c *Client) UpdateAnalysis(ctx context.Context, params *UpdateAnalysisInput, optFns ...func(*Options)) (*UpdateAnalysisOutput, error)

Updates an analysis in Amazon QuickSight

func (*Client) UpdateAnalysisPermissions added in v0.29.0 

func (c *Client) UpdateAnalysisPermissions(ctx context.Context, params *UpdateAnalysisPermissionsInput, optFns ...func(*Options)) (*UpdateAnalysisPermissionsOutput, error)

Updates the read and write permissions for an analysis.

func (*Client) UpdateDashboard 

func (c *Client) UpdateDashboard(ctx context.Context, params *UpdateDashboardInput, optFns ...func(*Options)) (*UpdateDashboardOutput, error)

Updates a dashboard in an Amazon Web Services account. Updating a Dashboard creates a new dashboard version but does not immediately publish the new version. You can update the published version of a dashboard by using the UpdateDashboardPublishedVersion (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateDashboardPublishedVersion.html) API operation.

func (*Client) UpdateDashboardPermissions 

func (c *Client) UpdateDashboardPermissions(ctx context.Context, params *UpdateDashboardPermissionsInput, optFns ...func(*Options)) (*UpdateDashboardPermissionsOutput, error)

Updates read and write permissions on a dashboard.

func (*Client) UpdateDashboardPublishedVersion 

func (c *Client) UpdateDashboardPublishedVersion(ctx context.Context, params *UpdateDashboardPublishedVersionInput, optFns ...func(*Options)) (*UpdateDashboardPublishedVersionOutput, error)

Updates the published version of a dashboard.

func (*Client) UpdateDataSet 

func (c *Client) UpdateDataSet(ctx context.Context, params *UpdateDataSetInput, optFns ...func(*Options)) (*UpdateDataSetOutput, error)

Updates a dataset. This operation doesn't support datasets that include uploaded files as a source.

func (*Client) UpdateDataSetPermissions 

func (c *Client) UpdateDataSetPermissions(ctx context.Context, params *UpdateDataSetPermissionsInput, optFns ...func(*Options)) (*UpdateDataSetPermissionsOutput, error)

Updates the permissions on a dataset. The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.

func (*Client) UpdateDataSource 

func (c *Client) UpdateDataSource(ctx context.Context, params *UpdateDataSourceInput, optFns ...func(*Options)) (*UpdateDataSourceOutput, error)

Updates a data source.

func (*Client) UpdateDataSourcePermissions 

func (c *Client) UpdateDataSourcePermissions(ctx context.Context, params *UpdateDataSourcePermissionsInput, optFns ...func(*Options)) (*UpdateDataSourcePermissionsOutput, error)

Updates the permissions to a data source.

func (*Client) UpdateFolder added in v1.6.0 

func (c *Client) UpdateFolder(ctx context.Context, params *UpdateFolderInput, optFns ...func(*Options)) (*UpdateFolderOutput, error)

Updates the name of a folder.

func (*Client) UpdateFolderPermissions added in v1.6.0 

func (c *Client) UpdateFolderPermissions(ctx context.Context, params *UpdateFolderPermissionsInput, optFns ...func(*Options)) (*UpdateFolderPermissionsOutput, error)

Updates permissions of a folder.

func (*Client) UpdateGroup 

func (c *Client) UpdateGroup(ctx context.Context, params *UpdateGroupInput, optFns ...func(*Options)) (*UpdateGroupOutput, error)

Changes a group description.

func (*Client) UpdateIAMPolicyAssignment 

func (c *Client) UpdateIAMPolicyAssignment(ctx context.Context, params *UpdateIAMPolicyAssignmentInput, optFns ...func(*Options)) (*UpdateIAMPolicyAssignmentOutput, error)

Updates an existing IAM policy assignment. This operation updates only the optional parameter or parameters that are specified in the request. This overwrites all of the users included in Identities.

func (*Client) UpdateIpRestriction added in v1.13.0 

func (c *Client) UpdateIpRestriction(ctx context.Context, params *UpdateIpRestrictionInput, optFns ...func(*Options)) (*UpdateIpRestrictionOutput, error)

Updates the content and status of IP rules. To use this operation, you need to provide the entire map of rules. You can use the DescribeIpRestriction operation to get the current rule map.

func (*Client) UpdateTemplate 

func (c *Client) UpdateTemplate(ctx context.Context, params *UpdateTemplateInput, optFns ...func(*Options)) (*UpdateTemplateOutput, error)

Updates a template from an existing Amazon QuickSight analysis or another template.

func (*Client) UpdateTemplateAlias 

func (c *Client) UpdateTemplateAlias(ctx context.Context, params *UpdateTemplateAliasInput, optFns ...func(*Options)) (*UpdateTemplateAliasOutput, error)

Updates the template alias of a template.

func (*Client) UpdateTemplatePermissions 

func (c *Client) UpdateTemplatePermissions(ctx context.Context, params *UpdateTemplatePermissionsInput, optFns ...func(*Options)) (*UpdateTemplatePermissionsOutput, error)

Updates the resource permissions for a template.

func (*Client) UpdateTheme 

func (c *Client) UpdateTheme(ctx context.Context, params *UpdateThemeInput, optFns ...func(*Options)) (*UpdateThemeOutput, error)

Updates a theme.

func (*Client) UpdateThemeAlias 

func (c *Client) UpdateThemeAlias(ctx context.Context, params *UpdateThemeAliasInput, optFns ...func(*Options)) (*UpdateThemeAliasOutput, error)

Updates an alias of a theme.

func (*Client) UpdateThemePermissions 

func (c *Client) UpdateThemePermissions(ctx context.Context, params *UpdateThemePermissionsInput, optFns ...func(*Options)) (*UpdateThemePermissionsOutput, error)

Updates the resource permissions for a theme. Permissions apply to the action to grant or revoke permissions on, for example "quicksight:DescribeTheme". Theme permissions apply in groupings. Valid groupings include the following for the three levels of permissions, which are user, owner, or no permissions:

* User

* "quicksight:DescribeTheme"

* "quicksight:DescribeThemeAlias"

* "quicksight:ListThemeAliases"

* "quicksight:ListThemeVersions"

* Owner

* "quicksight:DescribeTheme"

* "quicksight:DescribeThemeAlias"

* "quicksight:ListThemeAliases"

* "quicksight:ListThemeVersions"

* "quicksight:DeleteTheme"

* "quicksight:UpdateTheme"

* "quicksight:CreateThemeAlias"

* "quicksight:DeleteThemeAlias"

* "quicksight:UpdateThemeAlias"

* "quicksight:UpdateThemePermissions"

* "quicksight:DescribeThemePermissions"

* To specify no permissions, omit the permissions list.

func (*Client) UpdateUser 

func (c *Client) UpdateUser(ctx context.Context, params *UpdateUserInput, optFns ...func(*Options)) (*UpdateUserOutput, error)

Updates an Amazon QuickSight user.

type CreateAccountCustomizationInput 

type CreateAccountCustomizationInput struct {

	// The Amazon QuickSight customizations you're adding in the current Amazon Web
	// Services Region. You can add these to an Amazon Web Services account and a
	// QuickSight namespace. For example, you can add a default theme by setting
	// AccountCustomization to the midnight theme: "AccountCustomization": {
	// "DefaultTheme": "arn:aws:quicksight::aws:theme/MIDNIGHT" }. Or, you can add a
	// custom theme by specifying "AccountCustomization": { "DefaultTheme":
	// "arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639"
	// }.
	//
	// This member is required.
	AccountCustomization *types.AccountCustomization

	// The ID for the Amazon Web Services account that you want to customize Amazon
	// QuickSight for.
	//
	// This member is required.
	AwsAccountId *string

	// The Amazon QuickSight namespace that you want to add customizations to.
	Namespace *string

	// A list of the tags that you want to attach to this resource.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateAccountCustomizationOutput 

type CreateAccountCustomizationOutput struct {

	// The Amazon QuickSight customizations you're adding in the current Amazon Web
	// Services Region.
	AccountCustomization *types.AccountCustomization

	// The Amazon Resource Name (ARN) for the customization that you created for this
	// Amazon Web Services account.
	Arn *string

	// The ID for the Amazon Web Services account that you want to customize Amazon
	// QuickSight for.
	AwsAccountId *string

	// The namespace associated with the customization you're creating.
	Namespace *string

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateAnalysisInput added in v0.29.0 

type CreateAnalysisInput struct {

	// The ID for the analysis that you're creating. This ID displays in the URL of the
	// analysis.
	//
	// This member is required.
	AnalysisId *string

	// The ID of the Amazon Web Services account where you are creating an analysis.
	//
	// This member is required.
	AwsAccountId *string

	// A descriptive name for the analysis that you're creating. This name displays for
	// the analysis in the Amazon QuickSight console.
	//
	// This member is required.
	Name *string

	// A source entity to use for the analysis that you're creating. This metadata
	// structure contains details that describe a source template and one or more
	// datasets.
	//
	// This member is required.
	SourceEntity *types.AnalysisSourceEntity

	// The parameter names and override values that you want to use. An analysis can
	// have any parameter type, and some parameters might accept multiple values.
	Parameters *types.Parameters

	// A structure that describes the principals and the resource-level permissions on
	// an analysis. You can use the Permissions structure to grant permissions by
	// providing a list of Identity and Access Management (IAM) action information for
	// each principal listed by Amazon Resource Name (ARN). To specify no permissions,
	// omit Permissions.
	Permissions []types.ResourcePermission

	// Contains a map of the key-value pairs for the resource tag or tags assigned to
	// the analysis.
	Tags []types.Tag

	// The ARN for the theme to apply to the analysis that you're creating. To see the
	// theme in the Amazon QuickSight console, make sure that you have access to it.
	ThemeArn *string
	// contains filtered or unexported fields
}

type CreateAnalysisOutput added in v0.29.0 

type CreateAnalysisOutput struct {

	// The ID of the analysis.
	AnalysisId *string

	// The ARN for the analysis.
	Arn *string

	// The status of the creation of the analysis.
	CreationStatus types.ResourceStatus

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateDashboardInput 

type CreateDashboardInput struct {

	// The ID of the Amazon Web Services account where you want to create the
	// dashboard.
	//
	// This member is required.
	AwsAccountId *string

	// The ID for the dashboard, also added to the IAM policy.
	//
	// This member is required.
	DashboardId *string

	// The display name of the dashboard.
	//
	// This member is required.
	Name *string

	// The entity that you are using as a source when you create the dashboard. In
	// SourceEntity, you specify the type of object you're using as source. You can
	// only create a dashboard from a template, so you use a SourceTemplate entity. If
	// you need to create a dashboard from an analysis, first convert the analysis to a
	// template by using the CreateTemplate
	// (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CreateTemplate.html)
	// API operation. For SourceTemplate, specify the Amazon Resource Name (ARN) of the
	// source template. The SourceTemplateARN can contain any Amazon Web Services
	// account and any Amazon QuickSight-supported Amazon Web Services Region. Use the
	// DataSetReferences entity within SourceTemplate to list the replacement datasets
	// for the placeholders listed in the original. The schema in each dataset must
	// match its placeholder.
	//
	// This member is required.
	SourceEntity *types.DashboardSourceEntity

	// Options for publishing the dashboard when you create it:
	//
	// * AvailabilityStatus
	// for AdHocFilteringOption - This status can be either ENABLED or DISABLED. When
	// this is set to DISABLED, Amazon QuickSight disables the left filter pane on the
	// published dashboard, which can be used for ad hoc (one-time) filtering. This
	// option is ENABLED by default.
	//
	// * AvailabilityStatus for ExportToCSVOption - This
	// status can be either ENABLED or DISABLED. The visual option to export data to
	// .CSV format isn't enabled when this is set to DISABLED. This option is ENABLED
	// by default.
	//
	// * VisibilityState for SheetControlsOption - This visibility state
	// can be either COLLAPSED or EXPANDED. This option is COLLAPSED by default.
	DashboardPublishOptions *types.DashboardPublishOptions

	// The parameters for the creation of the dashboard, which you want to use to
	// override the default settings. A dashboard can have any type of parameters, and
	// some parameters might accept multiple values.
	Parameters *types.Parameters

	// A structure that contains the permissions of the dashboard. You can use this
	// structure for granting permissions by providing a list of IAM action information
	// for each principal ARN. To specify no permissions, omit the permissions list.
	Permissions []types.ResourcePermission

	// Contains a map of the key-value pairs for the resource tag or tags assigned to
	// the dashboard.
	Tags []types.Tag

	// The Amazon Resource Name (ARN) of the theme that is being used for this
	// dashboard. If you add a value for this field, it overrides the value that is
	// used in the source entity. The theme ARN must exist in the same Amazon Web
	// Services account where you create the dashboard.
	ThemeArn *string

	// A description for the first version of the dashboard being created.
	VersionDescription *string
	// contains filtered or unexported fields
}

type CreateDashboardOutput 

type CreateDashboardOutput struct {

	// The ARN of the dashboard.
	Arn *string

	// The status of the dashboard creation request.
	CreationStatus types.ResourceStatus

	// The ID for the dashboard.
	DashboardId *string

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// The ARN of the dashboard, including the version number of the first version that
	// is created.
	VersionArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateDataSetInput 

type CreateDataSetInput struct {

	// The Amazon Web Services account ID.
	//
	// This member is required.
	AwsAccountId *string

	// An ID for the dataset that you want to create. This ID is unique per Amazon Web
	// Services Region for each Amazon Web Services account.
	//
	// This member is required.
	DataSetId *string

	// Indicates whether you want to import the data into SPICE.
	//
	// This member is required.
	ImportMode types.DataSetImportMode

	// The display name for the dataset.
	//
	// This member is required.
	Name *string

	// Declares the physical tables that are available in the underlying data sources.
	//
	// This member is required.
	PhysicalTableMap map[string]types.PhysicalTable

	// Groupings of columns that work together in certain Amazon QuickSight features.
	// Currently, only geospatial hierarchy is supported.
	ColumnGroups []types.ColumnGroup

	// A set of one or more definitions of a ColumnLevelPermissionRule
	// (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_ColumnLevelPermissionRule.html).
	ColumnLevelPermissionRules []types.ColumnLevelPermissionRule

	// The usage configuration to apply to child datasets that reference this dataset
	// as a source.
	DataSetUsageConfiguration *types.DataSetUsageConfiguration

	// The folder that contains fields and nested subfolders for your dataset.
	FieldFolders map[string]types.FieldFolder

	// Configures the combination and transformation of the data from the physical
	// tables.
	LogicalTableMap map[string]types.LogicalTable

	// A list of resource permissions on the dataset.
	Permissions []types.ResourcePermission

	// The row-level security configuration for the data that you want to create.
	RowLevelPermissionDataSet *types.RowLevelPermissionDataSet

	// The configuration of tags on a dataset to set row-level security. Row-level
	// security tags are currently supported for anonymous embedding only.
	RowLevelPermissionTagConfiguration *types.RowLevelPermissionTagConfiguration

	// Contains a map of the key-value pairs for the resource tag or tags assigned to
	// the dataset.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateDataSetOutput 

type CreateDataSetOutput struct {

	// The Amazon Resource Name (ARN) of the dataset.
	Arn *string

	// The ID for the dataset that you want to create. This ID is unique per Amazon Web
	// Services Region for each Amazon Web Services account.
	DataSetId *string

	// The ARN for the ingestion, which is triggered as a result of dataset creation if
	// the import mode is SPICE.
	IngestionArn *string

	// The ID of the ingestion, which is triggered as a result of dataset creation if
	// the import mode is SPICE.
	IngestionId *string

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateDataSourceInput 

type CreateDataSourceInput struct {

	// The Amazon Web Services account ID.
	//
	// This member is required.
	AwsAccountId *string

	// An ID for the data source. This ID is unique per Amazon Web Services Region for
	// each Amazon Web Services account.
	//
	// This member is required.
	DataSourceId *string

	// A display name for the data source.
	//
	// This member is required.
	Name *string

	// The type of the data source. To return a list of all data sources, use
	// ListDataSources. Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service.
	//
	// This member is required.
	Type types.DataSourceType

	// The credentials Amazon QuickSight that uses to connect to your underlying
	// source. Currently, only credentials based on user name and password are
	// supported.
	Credentials *types.DataSourceCredentials

	// The parameters that Amazon QuickSight uses to connect to your underlying source.
	DataSourceParameters types.DataSourceParameters

	// A list of resource permissions on the data source.
	Permissions []types.ResourcePermission

	// Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects
	// to your underlying source.
	SslProperties *types.SslProperties

	// Contains a map of the key-value pairs for the resource tag or tags assigned to
	// the data source.
	Tags []types.Tag

	// Use this parameter only when you want Amazon QuickSight to use a VPC connection
	// when connecting to your underlying source.
	VpcConnectionProperties *types.VpcConnectionProperties
	// contains filtered or unexported fields
}

type CreateDataSourceOutput 

type CreateDataSourceOutput struct {

	// The Amazon Resource Name (ARN) of the data source.
	Arn *string

	// The status of creating the data source.
	CreationStatus types.ResourceStatus

	// The ID of the data source. This ID is unique per Amazon Web Services Region for
	// each Amazon Web Services account.
	DataSourceId *string

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateFolderInput added in v1.6.0 

type CreateFolderInput struct {

	// The ID for the Amazon Web Services account where you want to create the folder.
	//
	// This member is required.
	AwsAccountId *string

	// The ID of the folder.
	//
	// This member is required.
	FolderId *string

	// The type of folder. By default, folderType is SHARED.
	FolderType types.FolderType

	// The name of the folder.
	Name *string

	// The Amazon Resource Name (ARN) for the parent folder. ParentFolderArn can be
	// null. An empty parentFolderArn creates a root-level folder.
	ParentFolderArn *string

	// A structure that describes the principals and the resource-level permissions of
	// a folder. To specify no permissions, omit Permissions.
	Permissions []types.ResourcePermission

	// Tags for the folder.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateFolderMembershipInput added in v1.6.0 

type CreateFolderMembershipInput struct {

	// The ID for the Amazon Web Services account that contains the folder.
	//
	// This member is required.
	AwsAccountId *string

	// The ID of the folder.
	//
	// This member is required.
	FolderId *string

	// The ID of the asset (the dashboard, analysis, or dataset).
	//
	// This member is required.
	MemberId *string

	// The type of the member, including DASHBOARD, ANALYSIS, and DATASET.
	//
	// This member is required.
	MemberType types.MemberType
	// contains filtered or unexported fields
}

type CreateFolderMembershipOutput added in v1.6.0 

type CreateFolderMembershipOutput struct {

	// Information about the member in the folder.
	FolderMember *types.FolderMember

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateFolderOutput added in v1.6.0 

type CreateFolderOutput struct {

	// The Amazon Resource Name (ARN) for the newly created folder.
	Arn *string

	// The folder ID for the newly created folder.
	FolderId *string

	// The request ID for the newly created folder.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateGroupInput 

type CreateGroupInput struct {

	// The ID for the Amazon Web Services account that the group is in. Currently, you
	// use the ID for the Amazon Web Services account that contains your Amazon
	// QuickSight account.
	//
	// This member is required.
	AwsAccountId *string

	// A name for the group that you want to create.
	//
	// This member is required.
	GroupName *string

	// The namespace. Currently, you should set this to default.
	//
	// This member is required.
	Namespace *string

	// A description for the group that you want to create.
	Description *string
	// contains filtered or unexported fields
}

The request object for this operation.

type CreateGroupMembershipInput 

type CreateGroupMembershipInput struct {

	// The ID for the Amazon Web Services account that the group is in. Currently, you
	// use the ID for the Amazon Web Services account that contains your Amazon
	// QuickSight account.
	//
	// This member is required.
	AwsAccountId *string

	// The name of the group that you want to add the user to.
	//
	// This member is required.
	GroupName *string

	// The name of the user that you want to add to the group membership.
	//
	// This member is required.
	MemberName *string

	// The namespace. Currently, you should set this to default.
	//
	// This member is required.
	Namespace *string
	// contains filtered or unexported fields
}

type CreateGroupMembershipOutput 

type CreateGroupMembershipOutput struct {

	// The group member.
	GroupMember *types.GroupMember

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateGroupOutput 

type CreateGroupOutput struct {

	// The name of the group.
	Group *types.Group

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The response object for this operation.

type CreateIAMPolicyAssignmentInput 

type CreateIAMPolicyAssignmentInput struct {

	// The name of the assignment, also called a rule. It must be unique within an
	// Amazon Web Services account.
	//
	// This member is required.
	AssignmentName *string

	// The status of the assignment. Possible values are as follows:
	//
	// * ENABLED -
	// Anything specified in this assignment is used when creating the data source.
	//
	// *
	// DISABLED - This assignment isn't used when creating the data source.
	//
	// * DRAFT -
	// This assignment is an unfinished draft and isn't used when creating the data
	// source.
	//
	// This member is required.
	AssignmentStatus types.AssignmentStatus

	// The ID of the Amazon Web Services account where you want to assign an IAM policy
	// to Amazon QuickSight users or groups.
	//
	// This member is required.
	AwsAccountId *string

	// The namespace that contains the assignment.
	//
	// This member is required.
	Namespace *string

	// The Amazon QuickSight users, groups, or both that you want to assign the policy
	// to.
	Identities map[string][]string

	// The ARN for the IAM policy to apply to the Amazon QuickSight users and groups
	// specified in this assignment.
	PolicyArn *string
	// contains filtered or unexported fields
}

type CreateIAMPolicyAssignmentOutput 

type CreateIAMPolicyAssignmentOutput struct {

	// The ID for the assignment.
	AssignmentId *string

	// The name of the assignment. This name must be unique within the Amazon Web
	// Services account.
	AssignmentName *string

	// The status of the assignment. Possible values are as follows:
	//
	// * ENABLED -
	// Anything specified in this assignment is used when creating the data source.
	//
	// *
	// DISABLED - This assignment isn't used when creating the data source.
	//
	// * DRAFT -
	// This assignment is an unfinished draft and isn't used when creating the data
	// source.
	AssignmentStatus types.AssignmentStatus

	// The Amazon QuickSight users, groups, or both that the IAM policy is assigned to.
	Identities map[string][]string

	// The ARN for the IAM policy that is applied to the Amazon QuickSight users and
	// groups specified in this assignment.
	PolicyArn *string

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateIngestionInput 

type CreateIngestionInput struct {

	// The Amazon Web Services account ID.
	//
	// This member is required.
	AwsAccountId *string

	// The ID of the dataset used in the ingestion.
	//
	// This member is required.
	DataSetId *string

	// An ID for the ingestion.
	//
	// This member is required.
	IngestionId *string

	// The type of ingestion that you want to create.
	IngestionType types.IngestionType
	// contains filtered or unexported fields
}

type CreateIngestionOutput 

type CreateIngestionOutput struct {

	// The Amazon Resource Name (ARN) for the data ingestion.
	Arn *string

	// An ID for the ingestion.
	IngestionId *string

	// The ingestion status.
	IngestionStatus types.IngestionStatus

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateNamespaceInput 

type CreateNamespaceInput struct {

	// The ID for the Amazon Web Services account that you want to create the Amazon
	// QuickSight namespace in.
	//
	// This member is required.
	AwsAccountId *string

	// Specifies the type of your user identity directory. Currently, this supports
	// users with an identity type of QUICKSIGHT.
	//
	// This member is required.
	IdentityStore types.IdentityStore

	// The name that you want to use to describe the new namespace.
	//
	// This member is required.
	Namespace *string

	// The tags that you want to associate with the namespace that you're creating.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateNamespaceOutput 

type CreateNamespaceOutput struct {

	// The ARN of the Amazon QuickSight namespace you created.
	Arn *string

	// The Amazon Web Services Region; that you want to use for the free SPICE capacity
	// for the new namespace. This is set to the region that you run CreateNamespace
	// in.
	CapacityRegion *string

	// The status of the creation of the namespace. This is an asynchronous process. A
	// status of CREATED means that your namespace is ready to use. If an error occurs,
	// it indicates if the process is retryable or non-retryable. In the case of a
	// non-retryable error, refer to the error message for follow-up tasks.
	CreationStatus types.NamespaceStatus

	// Specifies the type of your user identity directory. Currently, this supports
	// users with an identity type of QUICKSIGHT.
	IdentityStore types.IdentityStore

	// The name of the new namespace that you created.
	Name *string

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateTemplateAliasInput 

type CreateTemplateAliasInput struct {

	// The name that you want to give to the template alias that you're creating. Don't
	// start the alias name with the $ character. Alias names that start with $ are
	// reserved by Amazon QuickSight.
	//
	// This member is required.
	AliasName *string

	// The ID of the Amazon Web Services account that contains the template that you
	// creating an alias for.
	//
	// This member is required.
	AwsAccountId *string

	// An ID for the template.
	//
	// This member is required.
	TemplateId *string

	// The version number of the template.
	//
	// This member is required.
	TemplateVersionNumber *int64
	// contains filtered or unexported fields
}

type CreateTemplateAliasOutput 

type CreateTemplateAliasOutput struct {

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Information about the template alias.
	TemplateAlias *types.TemplateAlias

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateTemplateInput 

type CreateTemplateInput struct {

	// The ID for the Amazon Web Services account that the group is in. You use the ID
	// for the Amazon Web Services account that contains your Amazon QuickSight
	// account.
	//
	// This member is required.
	AwsAccountId *string

	// The entity that you are using as a source when you create the template. In
	// SourceEntity, you specify the type of object you're using as source:
	// SourceTemplate for a template or SourceAnalysis for an analysis. Both of these
	// require an Amazon Resource Name (ARN). For SourceTemplate, specify the ARN of
	// the source template. For SourceAnalysis, specify the ARN of the source analysis.
	// The SourceTemplate ARN can contain any Amazon Web Services account and any
	// Amazon QuickSight-supported Amazon Web Services Region. Use the
	// DataSetReferences entity within SourceTemplate or SourceAnalysis to list the
	// replacement datasets for the placeholders listed in the original. The schema in
	// each dataset must match its placeholder.
	//
	// This member is required.
	SourceEntity *types.TemplateSourceEntity

	// An ID for the template that you want to create. This template is unique per
	// Amazon Web Services Region; in each Amazon Web Services account.
	//
	// This member is required.
	TemplateId *string

	// A display name for the template.
	Name *string

	// A list of resource permissions to be set on the template.
	Permissions []types.ResourcePermission

	// Contains a map of the key-value pairs for the resource tag or tags assigned to
	// the resource.
	Tags []types.Tag

	// A description of the current template version being created. This API operation
	// creates the first version of the template. Every time UpdateTemplate is called,
	// a new version is created. Each version of the template maintains a description
	// of the version in the VersionDescription field.
	VersionDescription *string
	// contains filtered or unexported fields
}

type CreateTemplateOutput 

type CreateTemplateOutput struct {

	// The ARN for the template.
	Arn *string

	// The template creation status.
	CreationStatus types.ResourceStatus

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// The ID of the template.
	TemplateId *string

	// The ARN for the template, including the version information of the first
	// version.
	VersionArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateThemeAliasInput 

type CreateThemeAliasInput struct {

	// The name that you want to give to the theme alias that you are creating. The
	// alias name can't begin with a $. Alias names that start with $ are reserved by
	// Amazon QuickSight.
	//
	// This member is required.
	AliasName *string

	// The ID of the Amazon Web Services account that contains the theme for the new
	// theme alias.
	//
	// This member is required.
	AwsAccountId *string

	// An ID for the theme alias.
	//
	// This member is required.
	ThemeId *string

	// The version number of the theme.
	//
	// This member is required.
	ThemeVersionNumber *int64
	// contains filtered or unexported fields
}

type CreateThemeAliasOutput 

type CreateThemeAliasOutput struct {

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Information about the theme alias.
	ThemeAlias *types.ThemeAlias

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateThemeInput 

type CreateThemeInput struct {

	// The ID of the Amazon Web Services account where you want to store the new theme.
	//
	// This member is required.
	AwsAccountId *string

	// The ID of the theme that a custom theme will inherit from. All themes inherit
	// from one of the starting themes defined by Amazon QuickSight. For a list of the
	// starting themes, use ListThemes or choose Themes from within an analysis.
	//
	// This member is required.
	BaseThemeId *string

	// The theme configuration, which contains the theme display properties.
	//
	// This member is required.
	Configuration *types.ThemeConfiguration

	// A display name for the theme.
	//
	// This member is required.
	Name *string

	// An ID for the theme that you want to create. The theme ID is unique per Amazon
	// Web Services Region in each Amazon Web Services account.
	//
	// This member is required.
	ThemeId *string

	// A valid grouping of resource permissions to apply to the new theme.
	Permissions []types.ResourcePermission

	// A map of the key-value pairs for the resource tag or tags that you want to add
	// to the resource.
	Tags []types.Tag

	// A description of the first version of the theme that you're creating. Every time
	// UpdateTheme is called, a new version is created. Each version of the theme has a
	// description of the version in the VersionDescription field.
	VersionDescription *string
	// contains filtered or unexported fields
}

type CreateThemeOutput 

type CreateThemeOutput struct {

	// The Amazon Resource Name (ARN) for the theme.
	Arn *string

	// The theme creation status.
	CreationStatus types.ResourceStatus

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// The ID of the theme.
	ThemeId *string

	// The Amazon Resource Name (ARN) for the new theme.
	VersionArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteAccountCustomizationInput 

type DeleteAccountCustomizationInput struct {

	// The ID for the Amazon Web Services account that you want to delete Amazon
	// QuickSight customizations from in this Amazon Web Services Region.
	//
	// This member is required.
	AwsAccountId *string

	// The Amazon QuickSight namespace that you're deleting the customizations from.
	Namespace *string
	// contains filtered or unexported fields
}

type DeleteAccountCustomizationOutput 

type DeleteAccountCustomizationOutput struct {

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteAnalysisInput added in v0.29.0 

type DeleteAnalysisInput struct {

	// The ID of the analysis that you're deleting.
	//
	// This member is required.
	AnalysisId *string

	// The ID of the Amazon Web Services account where you want to delete an analysis.
	//
	// This member is required.
	AwsAccountId *string

	// This option defaults to the value NoForceDeleteWithoutRecovery. To immediately
	// delete the analysis, add the ForceDeleteWithoutRecovery option. You can't
	// restore an analysis after it's deleted.
	ForceDeleteWithoutRecovery bool

	// A value that specifies the number of days that Amazon QuickSight waits before it
	// deletes the analysis. You can't use this parameter with the
	// ForceDeleteWithoutRecovery option in the same API call. The default value is 30.
	RecoveryWindowInDays *int64
	// contains filtered or unexported fields
}

type DeleteAnalysisOutput added in v0.29.0 

type DeleteAnalysisOutput struct {

	// The ID of the deleted analysis.
	AnalysisId *string

	// The Amazon Resource Name (ARN) of the deleted analysis.
	Arn *string

	// The date and time that the analysis is scheduled to be deleted.
	DeletionTime *time.Time

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteDashboardInput 

type DeleteDashboardInput struct {

	// The ID of the Amazon Web Services account that contains the dashboard that
	// you're deleting.
	//
	// This member is required.
	AwsAccountId *string

	// The ID for the dashboard.
	//
	// This member is required.
	DashboardId *string

	// The version number of the dashboard. If the version number property is provided,
	// only the specified version of the dashboard is deleted.
	VersionNumber *int64
	// contains filtered or unexported fields
}

type DeleteDashboardOutput 

type DeleteDashboardOutput struct {

	// The Secure Socket Layer (SSL) properties that apply for the resource.
	Arn *string

	// The ID of the dashboard.
	DashboardId *string

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteDataSetInput 

type DeleteDataSetInput struct {

	// The Amazon Web Services account ID.
	//
	// This member is required.
	AwsAccountId *string

	// The ID for the dataset that you want to create. This ID is unique per Amazon Web
	// Services Region for each Amazon Web Services account.
	//
	// This member is required.
	DataSetId *string
	// contains filtered or unexported fields
}

type DeleteDataSetOutput 

type DeleteDataSetOutput struct {

	// The Amazon Resource Name (ARN) of the dataset.
	Arn *string

	// The ID for the dataset that you want to create. This ID is unique per Amazon Web
	// Services Region for each Amazon Web Services account.
	DataSetId *string

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteDataSourceInput 

type DeleteDataSourceInput struct {

	// The Amazon Web Services account ID.
	//
	// This member is required.
	AwsAccountId *string

	// The ID of the data source. This ID is unique per Amazon Web Services Region for
	// each Amazon Web Services account.
	//
	// This member is required.
	DataSourceId *string
	// contains filtered or unexported fields
}

type DeleteDataSourceOutput 

type DeleteDataSourceOutput struct {

	// The Amazon Resource Name (ARN) of the data source that you deleted.
	Arn *string

	// The ID of the data source. This ID is unique per Amazon Web Services Region for
	// each Amazon Web Services account.
	DataSourceId *string

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteFolderInput added in v1.6.0 

type DeleteFolderInput struct {

	// The ID for the Amazon Web Services account that contains the folder.
	//
	// This member is required.
	AwsAccountId *string

	// The ID of the folder.
	//
	// This member is required.
	FolderId *string
	// contains filtered or unexported fields
}

type DeleteFolderMembershipInput added in v1.6.0 

type DeleteFolderMembershipInput struct {

	// The ID for the Amazon Web Services account that contains the folder.
	//
	// This member is required.
	AwsAccountId *string

	// The Folder ID.
	//
	// This member is required.
	FolderId *string

	// The ID of the asset (the dashboard, analysis, or dataset) that you want to
	// delete.
	//
	// This member is required.
	MemberId *string

	// The type of the member, including DASHBOARD, ANALYSIS, and DATASET
	//
	// This member is required.
	MemberType types.MemberType
	// contains filtered or unexported fields
}

type DeleteFolderMembershipOutput added in v1.6.0 

type DeleteFolderMembershipOutput struct {

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteFolderOutput added in v1.6.0 

type DeleteFolderOutput struct {

	// The Amazon Resource Name of the deleted folder.
	Arn *string

	// The ID of the folder.
	FolderId *string

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteGroupInput 

type DeleteGroupInput struct {

	// The ID for the Amazon Web Services account that the group is in. Currently, you
	// use the ID for the Amazon Web Services account that contains your Amazon
	// QuickSight account.
	//
	// This member is required.
	AwsAccountId *string

	// The name of the group that you want to delete.
	//
	// This member is required.
	GroupName *string

	// The namespace. Currently, you should set this to default.
	//
	// This member is required.
	Namespace *string
	// contains filtered or unexported fields
}

type DeleteGroupMembershipInput 

type DeleteGroupMembershipInput struct {

	// The ID for the Amazon Web Services account that the group is in. Currently, you
	// use the ID for the Amazon Web Services account that contains your Amazon
	// QuickSight account.
	//
	// This member is required.
	AwsAccountId *string

	// The name of the group that you want to delete the user from.
	//
	// This member is required.
	GroupName *string

	// The name of the user that you want to delete from the group membership.
	//
	// This member is required.
	MemberName *string

	// The namespace. Currently, you should set this to default.
	//
	// This member is required.
	Namespace *string
	// contains filtered or unexported fields
}

type DeleteGroupMembershipOutput 

type DeleteGroupMembershipOutput struct {

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteGroupOutput 

type DeleteGroupOutput struct {

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteIAMPolicyAssignmentInput 

type DeleteIAMPolicyAssignmentInput struct {

	// The name of the assignment.
	//
	// This member is required.
	AssignmentName *string

	// The Amazon Web Services account ID where you want to delete the IAM policy
	// assignment.
	//
	// This member is required.
	AwsAccountId *string

	// The namespace that contains the assignment.
	//
	// This member is required.
	Namespace *string
	// contains filtered or unexported fields
}

type DeleteIAMPolicyAssignmentOutput 

type DeleteIAMPolicyAssignmentOutput struct {

	// The name of the assignment.
	AssignmentName *string

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteNamespaceInput 

type DeleteNamespaceInput struct {

	// The ID for the Amazon Web Services account that you want to delete the Amazon
	// QuickSight namespace from.
	//
	// This member is required.
	AwsAccountId *string

	// The namespace that you want to delete.
	//
	// This member is required.
	Namespace *string
	// contains filtered or unexported fields
}

type DeleteNamespaceOutput 

type DeleteNamespaceOutput struct {

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteTemplateAliasInput 

type DeleteTemplateAliasInput struct {

	// The name for the template alias. To delete a specific alias, you delete the
	// version that the alias points to. You can specify the alias name, or specify the
	// latest version of the template by providing the keyword $LATEST in the AliasName
	// parameter.
	//
	// This member is required.
	AliasName *string

	// The ID of the Amazon Web Services account that contains the item to delete.
	//
	// This member is required.
	AwsAccountId *string

	// The ID for the template that the specified alias is for.
	//
	// This member is required.
	TemplateId *string
	// contains filtered or unexported fields
}

type DeleteTemplateAliasOutput 

type DeleteTemplateAliasOutput struct {

	// The name for the template alias.
	AliasName *string

	// The Amazon Resource Name (ARN) of the template you want to delete.
	Arn *string

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// An ID for the template associated with the deletion.
	TemplateId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteTemplateInput 

type DeleteTemplateInput struct {

	// The ID of the Amazon Web Services account that contains the template that you're
	// deleting.
	//
	// This member is required.
	AwsAccountId *string

	// An ID for the template you want to delete.
	//
	// This member is required.
	TemplateId *string

	// Specifies the version of the template that you want to delete. If you don't
	// provide a version number, DeleteTemplate deletes all versions of the template.
	VersionNumber *int64
	// contains filtered or unexported fields
}

type DeleteTemplateOutput 

type DeleteTemplateOutput struct {

	// The Amazon Resource Name (ARN) of the resource.
	Arn *string

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// An ID for the template.
	TemplateId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteThemeAliasInput 

type DeleteThemeAliasInput struct {

	// The unique name for the theme alias to delete.
	//
	// This member is required.
	AliasName *string

	// The ID of the Amazon Web Services account that contains the theme alias to
	// delete.
	//
	// This member is required.
	AwsAccountId *string

	// The ID for the theme that the specified alias is for.
	//
	// This member is required.
	ThemeId *string
	// contains filtered or unexported fields
}

type DeleteThemeAliasOutput 

type DeleteThemeAliasOutput struct {

	// The name for the theme alias.
	AliasName *string

	// The Amazon Resource Name (ARN) of the theme resource using the deleted alias.
	Arn *string

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// An ID for the theme associated with the deletion.
	ThemeId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteThemeInput 

type DeleteThemeInput struct {

	// The ID of the Amazon Web Services account that contains the theme that you're
	// deleting.
	//
	// This member is required.
	AwsAccountId *string

	// An ID for the theme that you want to delete.
	//
	// This member is required.
	ThemeId *string

	// The version of the theme that you want to delete. Note: If you don't provide a
	// version number, you're using this call to DeleteTheme to delete all versions of
	// the theme.
	VersionNumber *int64
	// contains filtered or unexported fields
}

type DeleteThemeOutput 

type DeleteThemeOutput struct {

	// The Amazon Resource Name (ARN) of the resource.
	Arn *string

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// An ID for the theme.
	ThemeId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteUserByPrincipalIdInput 

type DeleteUserByPrincipalIdInput struct {

	// The ID for the Amazon Web Services account that the user is in. Currently, you
	// use the ID for the Amazon Web Services account that contains your Amazon
	// QuickSight account.
	//
	// This member is required.
	AwsAccountId *string

	// The namespace. Currently, you should set this to default.
	//
	// This member is required.
	Namespace *string

	// The principal ID of the user.
	//
	// This member is required.
	PrincipalId *string
	// contains filtered or unexported fields
}

type DeleteUserByPrincipalIdOutput 

type DeleteUserByPrincipalIdOutput struct {

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteUserInput 

type DeleteUserInput struct {

	// The ID for the Amazon Web Services account that the user is in. Currently, you
	// use the ID for the Amazon Web Services account that contains your Amazon
	// QuickSight account.
	//
	// This member is required.
	AwsAccountId *string

	// The namespace. Currently, you should set this to default.
	//
	// This member is required.
	Namespace *string

	// The name of the user that you want to delete.
	//
	// This member is required.
	UserName *string
	// contains filtered or unexported fields
}

type DeleteUserOutput 

type DeleteUserOutput struct {

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeAccountCustomizationInput 

type DescribeAccountCustomizationInput struct {

	// The ID for the Amazon Web Services account that you want to describe Amazon
	// QuickSight customizations for.
	//
	// This member is required.
	AwsAccountId *string

	// The Amazon QuickSight namespace that you want to describe Amazon QuickSight
	// customizations for.
	Namespace *string

	// The Resolved flag works with the other parameters to determine which view of
	// Amazon QuickSight customizations is returned. You can add this flag to your
	// command to use the same view that Amazon QuickSight uses to identify which
	// customizations to apply to the console. Omit this flag, or set it to
	// no-resolved, to reveal customizations that are configured at different levels.
	Resolved bool
	// contains filtered or unexported fields
}

type DescribeAccountCustomizationOutput 

type DescribeAccountCustomizationOutput struct {

	// The Amazon QuickSight customizations that exist in the current Amazon Web
	// Services Region.
	AccountCustomization *types.AccountCustomization

	// The Amazon Resource Name (ARN) of the customization that's associated with this
	// Amazon Web Services account.
	Arn *string

	// The ID for the Amazon Web Services account that you're describing.
	AwsAccountId *string

	// The Amazon QuickSight namespace that you're describing.
	Namespace *string

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeAccountSettingsInput 

type DescribeAccountSettingsInput struct {

	// The ID for the Amazon Web Services account that contains the settings that you
	// want to list.
	//
	// This member is required.
	AwsAccountId *string
	// contains filtered or unexported fields
}

type DescribeAccountSettingsOutput 

type DescribeAccountSettingsOutput struct {

	// The Amazon QuickSight settings for this Amazon Web Services account. This
	// information includes the edition of Amazon Amazon QuickSight that you subscribed
	// to (Standard or Enterprise) and the notification email for the Amazon QuickSight
	// subscription. In the QuickSight console, the Amazon QuickSight subscription is
	// sometimes referred to as a QuickSight "account" even though it's technically not
	// an account by itself. Instead, it's a subscription to the Amazon QuickSight
	// service for your Amazon Web Services account. The edition that you subscribe to
	// applies to Amazon QuickSight in every Amazon Web Services Region where you use
	// it.
	AccountSettings *types.AccountSettings

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeAnalysisInput added in v0.29.0 

type DescribeAnalysisInput struct {

	// The ID of the analysis that you're describing. The ID is part of the URL of the
	// analysis.
	//
	// This member is required.
	AnalysisId *string

	// The ID of the Amazon Web Services account that contains the analysis. You must
	// be using the Amazon Web Services account that the analysis is in.
	//
	// This member is required.
	AwsAccountId *string
	// contains filtered or unexported fields
}

type DescribeAnalysisOutput added in v0.29.0 

type DescribeAnalysisOutput struct {

	// A metadata structure that contains summary information for the analysis that
	// you're describing.
	Analysis *types.Analysis

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeAnalysisPermissionsInput added in v0.29.0 

type DescribeAnalysisPermissionsInput struct {

	// The ID of the analysis whose permissions you're describing. The ID is part of
	// the analysis URL.
	//
	// This member is required.
	AnalysisId *string

	// The ID of the Amazon Web Services account that contains the analysis whose
	// permissions you're describing. You must be using the Amazon Web Services account
	// that the analysis is in.
	//
	// This member is required.
	AwsAccountId *string
	// contains filtered or unexported fields
}

type DescribeAnalysisPermissionsOutput added in v0.29.0 

type DescribeAnalysisPermissionsOutput struct {

	// The Amazon Resource Name (ARN) of the analysis whose permissions you're
	// describing.
	AnalysisArn *string

	// The ID of the analysis whose permissions you're describing.
	AnalysisId *string

	// A structure that describes the principals and the resource-level permissions on
	// an analysis.
	Permissions []types.ResourcePermission

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeDashboardInput 

type DescribeDashboardInput struct {

	// The ID of the Amazon Web Services account that contains the dashboard that
	// you're describing.
	//
	// This member is required.
	AwsAccountId *string

	// The ID for the dashboard.
	//
	// This member is required.
	DashboardId *string

	// The alias name.
	AliasName *string

	// The version number for the dashboard. If a version number isn't passed, the
	// latest published dashboard version is described.
	VersionNumber *int64
	// contains filtered or unexported fields
}

type DescribeDashboardOutput 

type DescribeDashboardOutput struct {

	// Information about the dashboard.
	Dashboard *types.Dashboard

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of this request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeDashboardPermissionsInput 

type DescribeDashboardPermissionsInput struct {

	// The ID of the Amazon Web Services account that contains the dashboard that
	// you're describing permissions for.
	//
	// This member is required.
	AwsAccountId *string

	// The ID for the dashboard, also added to the IAM policy.
	//
	// This member is required.
	DashboardId *string
	// contains filtered or unexported fields
}

type DescribeDashboardPermissionsOutput 

type DescribeDashboardPermissionsOutput struct {

	// The Amazon Resource Name (ARN) of the dashboard.
	DashboardArn *string

	// The ID for the dashboard.
	DashboardId *string

	// A structure that contains the configuration of a shareable link that grants
	// access to the dashboard. Your users can use the link to view and interact with
	// the dashboard, if the dashboard has been shared with them. For more information
	// about sharing dashboards, see Sharing Dashboards
	// (https://docs.aws.amazon.com/quicksight/latest/user/sharing-a-dashboard.html).
	LinkSharingConfiguration *types.LinkSharingConfiguration

	// A structure that contains the permissions for the dashboard.
	Permissions []types.ResourcePermission

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeDataSetInput 

type DescribeDataSetInput struct {

	// The Amazon Web Services account ID.
	//
	// This member is required.
	AwsAccountId *string

	// The ID for the dataset that you want to create. This ID is unique per Amazon Web
	// Services Region for each Amazon Web Services account.
	//
	// This member is required.
	DataSetId *string
	// contains filtered or unexported fields
}

type DescribeDataSetOutput 

type DescribeDataSetOutput struct {

	// Information on the dataset.
	DataSet *types.DataSet

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeDataSetPermissionsInput 

type DescribeDataSetPermissionsInput struct {

	// The Amazon Web Services account ID.
	//
	// This member is required.
	AwsAccountId *string

	// The ID for the dataset that you want to create. This ID is unique per Amazon Web
	// Services Region for each Amazon Web Services account.
	//
	// This member is required.
	DataSetId *string
	// contains filtered or unexported fields
}

type DescribeDataSetPermissionsOutput 

type DescribeDataSetPermissionsOutput struct {

	// The Amazon Resource Name (ARN) of the dataset.
	DataSetArn *string

	// The ID for the dataset that you want to create. This ID is unique per Amazon Web
	// Services Region for each Amazon Web Services account.
	DataSetId *string

	// A list of resource permissions on the dataset.
	Permissions []types.ResourcePermission

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeDataSourceInput 

type DescribeDataSourceInput struct {

	// The Amazon Web Services account ID.
	//
	// This member is required.
	AwsAccountId *string

	// The ID of the data source. This ID is unique per Amazon Web Services Region for
	// each Amazon Web Services account.
	//
	// This member is required.
	DataSourceId *string
	// contains filtered or unexported fields
}

type DescribeDataSourceOutput 

type DescribeDataSourceOutput struct {

	// The information on the data source.
	DataSource *types.DataSource

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeDataSourcePermissionsInput 

type DescribeDataSourcePermissionsInput struct {

	// The Amazon Web Services account ID.
	//
	// This member is required.
	AwsAccountId *string

	// The ID of the data source. This ID is unique per Amazon Web Services Region for
	// each Amazon Web Services account.
	//
	// This member is required.
	DataSourceId *string
	// contains filtered or unexported fields
}

type DescribeDataSourcePermissionsOutput 

type DescribeDataSourcePermissionsOutput struct {

	// The Amazon Resource Name (ARN) of the data source.
	DataSourceArn *string

	// The ID of the data source. This ID is unique per Amazon Web Services Region for
	// each Amazon Web Services account.
	DataSourceId *string

	// A list of resource permissions on the data source.
	Permissions []types.ResourcePermission

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeFolderInput added in v1.6.0 

type DescribeFolderInput struct {

	// The ID for the Amazon Web Services account that contains the folder.
	//
	// This member is required.
	AwsAccountId *string

	// The ID of the folder.
	//
	// This member is required.
	FolderId *string
	// contains filtered or unexported fields
}

type DescribeFolderOutput added in v1.6.0 

type DescribeFolderOutput struct {

	// Information about the folder.
	Folder *types.Folder

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeFolderPermissionsInput added in v1.6.0 

type DescribeFolderPermissionsInput struct {

	// The ID for the Amazon Web Services account that contains the folder.
	//
	// This member is required.
	AwsAccountId *string

	// The ID of the folder.
	//
	// This member is required.
	FolderId *string
	// contains filtered or unexported fields
}

type DescribeFolderPermissionsOutput added in v1.6.0 

type DescribeFolderPermissionsOutput struct {

	// The Amazon Resource Name (ARN) for the folder.
	Arn *string

	// The ID of the folder.
	FolderId *string

	// Information about the permissions on the folder.
	Permissions []types.ResourcePermission

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeFolderResolvedPermissionsInput added in v1.6.0 

type DescribeFolderResolvedPermissionsInput struct {

	// The ID for the Amazon Web Services account that contains the folder.
	//
	// This member is required.
	AwsAccountId *string

	// The ID of the folder.
	//
	// This member is required.
	FolderId *string
	// contains filtered or unexported fields
}

type DescribeFolderResolvedPermissionsOutput added in v1.6.0 

type DescribeFolderResolvedPermissionsOutput struct {

	// The Amazon Resource Name (ARN) of the folder.
	Arn *string

	// The ID of the folder.
	FolderId *string

	// Information about the permissions for the folder.
	Permissions []types.ResourcePermission

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeGroupInput 

type DescribeGroupInput struct {

	// The ID for the Amazon Web Services account that the group is in. Currently, you
	// use the ID for the Amazon Web Services account that contains your Amazon
	// QuickSight account.
	//
	// This member is required.
	AwsAccountId *string

	// The name of the group that you want to describe.
	//
	// This member is required.
	GroupName *string

	// The namespace. Currently, you should set this to default.
	//
	// This member is required.
	Namespace *string
	// contains filtered or unexported fields
}

type DescribeGroupOutput 

type DescribeGroupOutput struct {

	// The name of the group.
	Group *types.Group

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeIAMPolicyAssignmentInput 

type DescribeIAMPolicyAssignmentInput struct {

	// The name of the assignment, also called a rule.
	//
	// This member is required.
	AssignmentName *string

	// The ID of the Amazon Web Services account that contains the assignment that you
	// want to describe.
	//
	// This member is required.
	AwsAccountId *string

	// The namespace that contains the assignment.
	//
	// This member is required.
	Namespace *string
	// contains filtered or unexported fields
}

type DescribeIAMPolicyAssignmentOutput 

type DescribeIAMPolicyAssignmentOutput struct {

	// Information describing the IAM policy assignment.
	IAMPolicyAssignment *types.IAMPolicyAssignment

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeIngestionInput 

type DescribeIngestionInput struct {

	// The Amazon Web Services account ID.
	//
	// This member is required.
	AwsAccountId *string

	// The ID of the dataset used in the ingestion.
	//
	// This member is required.
	DataSetId *string

	// An ID for the ingestion.
	//
	// This member is required.
	IngestionId *string
	// contains filtered or unexported fields
}

type DescribeIngestionOutput 

type DescribeIngestionOutput struct {

	// Information about the ingestion.
	Ingestion *types.Ingestion

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeIpRestrictionInput added in v1.13.0 

type DescribeIpRestrictionInput struct {

	// The ID of the Amazon Web Services account that contains the IP rules.
	//
	// This member is required.
	AwsAccountId *string
	// contains filtered or unexported fields
}

type DescribeIpRestrictionOutput added in v1.13.0 

type DescribeIpRestrictionOutput struct {

	// The ID of the Amazon Web Services account that contains the IP rules.
	AwsAccountId *string

	// A value that specifies whether IP rules are turned on.
	Enabled *bool

	// A map that describes the IP rules with CIDR range and description.
	IpRestrictionRuleMap map[string]string

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeNamespaceInput 

type DescribeNamespaceInput struct {

	// The ID for the Amazon Web Services account that contains the Amazon QuickSight
	// namespace that you want to describe.
	//
	// This member is required.
	AwsAccountId *string

	// The namespace that you want to describe.
	//
	// This member is required.
	Namespace *string
	// contains filtered or unexported fields
}

type DescribeNamespaceOutput 

type DescribeNamespaceOutput struct {

	// The information about the namespace that you're describing. The response
	// includes the namespace ARN, name, Amazon Web Services Region, creation status,
	// and identity store. DescribeNamespace also works for namespaces that are in the
	// process of being created. For incomplete namespaces, this API operation lists
	// the namespace error types and messages associated with the creation process.
	Namespace *types.NamespaceInfoV2

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeTemplateAliasInput 

type DescribeTemplateAliasInput struct {

	// The name of the template alias that you want to describe. If you name a specific
	// alias, you describe the version that the alias points to. You can specify the
	// latest version of the template by providing the keyword $LATEST in the AliasName
	// parameter. The keyword $PUBLISHED doesn't apply to templates.
	//
	// This member is required.
	AliasName *string

	// The ID of the Amazon Web Services account that contains the template alias that
	// you're describing.
	//
	// This member is required.
	AwsAccountId *string

	// The ID for the template.
	//
	// This member is required.
	TemplateId *string
	// contains filtered or unexported fields
}

type DescribeTemplateAliasOutput 

type DescribeTemplateAliasOutput struct {

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Information about the template alias.
	TemplateAlias *types.TemplateAlias

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeTemplateInput 

type DescribeTemplateInput struct {

	// The ID of the Amazon Web Services account that contains the template that you're
	// describing.
	//
	// This member is required.
	AwsAccountId *string

	// The ID for the template.
	//
	// This member is required.
	TemplateId *string

	// The alias of the template that you want to describe. If you name a specific
	// alias, you describe the version that the alias points to. You can specify the
	// latest version of the template by providing the keyword $LATEST in the AliasName
	// parameter. The keyword $PUBLISHED doesn't apply to templates.
	AliasName *string

	// (Optional) The number for the version to describe. If a VersionNumber parameter
	// value isn't provided, the latest version of the template is described.
	VersionNumber *int64
	// contains filtered or unexported fields
}

type DescribeTemplateOutput 

type DescribeTemplateOutput struct {

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// The template structure for the object you want to describe.
	Template *types.Template

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeTemplatePermissionsInput 

type DescribeTemplatePermissionsInput struct {

	// The ID of the Amazon Web Services account that contains the template that you're
	// describing.
	//
	// This member is required.
	AwsAccountId *string

	// The ID for the template.
	//
	// This member is required.
	TemplateId *string
	// contains filtered or unexported fields
}

type DescribeTemplatePermissionsOutput 

type DescribeTemplatePermissionsOutput struct {

	// A list of resource permissions to be set on the template.
	Permissions []types.ResourcePermission

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// The Amazon Resource Name (ARN) of the template.
	TemplateArn *string

	// The ID for the template.
	TemplateId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeThemeAliasInput 

type DescribeThemeAliasInput struct {

	// The name of the theme alias that you want to describe.
	//
	// This member is required.
	AliasName *string

	// The ID of the Amazon Web Services account that contains the theme alias that
	// you're describing.
	//
	// This member is required.
	AwsAccountId *string

	// The ID for the theme.
	//
	// This member is required.
	ThemeId *string
	// contains filtered or unexported fields
}

type DescribeThemeAliasOutput 

type DescribeThemeAliasOutput struct {

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Information about the theme alias.
	ThemeAlias *types.ThemeAlias

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeThemeInput 

type DescribeThemeInput struct {

	// The ID of the Amazon Web Services account that contains the theme that you're
	// describing.
	//
	// This member is required.
	AwsAccountId *string

	// The ID for the theme.
	//
	// This member is required.
	ThemeId *string

	// The alias of the theme that you want to describe. If you name a specific alias,
	// you describe the version that the alias points to. You can specify the latest
	// version of the theme by providing the keyword $LATEST in the AliasName
	// parameter. The keyword $PUBLISHED doesn't apply to themes.
	AliasName *string

	// The version number for the version to describe. If a VersionNumber parameter
	// value isn't provided, the latest version of the theme is described.
	VersionNumber *int64
	// contains filtered or unexported fields
}

type DescribeThemeOutput 

type DescribeThemeOutput struct {

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// The information about the theme that you are describing.
	Theme *types.Theme

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeThemePermissionsInput 

type DescribeThemePermissionsInput struct {

	// The ID of the Amazon Web Services account that contains the theme that you're
	// describing.
	//
	// This member is required.
	AwsAccountId *string

	// The ID for the theme that you want to describe permissions for.
	//
	// This member is required.
	ThemeId *string
	// contains filtered or unexported fields
}

type DescribeThemePermissionsOutput 

type DescribeThemePermissionsOutput struct {

	// A list of resource permissions set on the theme.
	Permissions []types.ResourcePermission

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// The Amazon Resource Name (ARN) of the theme.
	ThemeArn *string

	// The ID for the theme.
	ThemeId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeUserInput 

type DescribeUserInput struct {

	// The ID for the Amazon Web Services account that the user is in. Currently, you
	// use the ID for the Amazon Web Services account that contains your Amazon
	// QuickSight account.
	//
	// This member is required.
	AwsAccountId *string

	// The namespace. Currently, you should set this to default.
	//
	// This member is required.
	Namespace *string

	// The name of the user that you want to describe.
	//
	// This member is required.
	UserName *string
	// contains filtered or unexported fields
}

type DescribeUserOutput 

type DescribeUserOutput struct {

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// The user name.
	User *types.User

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EndpointResolver 

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL added in v1.1.0 

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc 

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint 

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions added in v0.29.0 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type GenerateEmbedUrlForAnonymousUserInput added in v1.7.0 

type GenerateEmbedUrlForAnonymousUserInput struct {

	// The Amazon Resource Names for the Amazon QuickSight resources that the user is
	// authorized to access during the lifetime of the session. If you choose Dashboard
	// embedding experience, pass the list of dashboard ARNs in the account that you
	// want the user to be able to view.
	//
	// This member is required.
	AuthorizedResourceArns []string

	// The ID for the Amazon Web Services account that contains the dashboard that
	// you're embedding.
	//
	// This member is required.
	AwsAccountId *string

	// The configuration of the experience you are embedding.
	//
	// This member is required.
	ExperienceConfiguration *types.AnonymousUserEmbeddingExperienceConfiguration

	// The Amazon QuickSight namespace that the anonymous user virtually belongs to. If
	// you are not using an Amazon QuickSight custom namespace, set this to default.
	//
	// This member is required.
	Namespace *string

	// How many minutes the session is valid. The session lifetime must be in [15-600]
	// minutes range.
	SessionLifetimeInMinutes *int64

	// The session tags used for row-level security. Before you use this parameter,
	// make sure that you have configured the relevant datasets using the
	// DataSet$RowLevelPermissionTagConfiguration parameter so that session tags can be
	// used to provide row-level security. These are not the tags used for the Amazon
	// Web Services resource tagging feature. For more information, see Using Row-Level
	// Security (RLS) with Tags
	// (https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-rls-tags.html).
	SessionTags []types.SessionTag
	// contains filtered or unexported fields
}

type GenerateEmbedUrlForAnonymousUserOutput added in v1.7.0 

type GenerateEmbedUrlForAnonymousUserOutput struct {

	// The embed URL for the dashboard.
	//
	// This member is required.
	EmbedUrl *string

	// The Amazon Web Services request ID for this operation.
	//
	// This member is required.
	RequestId *string

	// The HTTP status of the request.
	//
	// This member is required.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GenerateEmbedUrlForRegisteredUserInput added in v1.7.0 

type GenerateEmbedUrlForRegisteredUserInput struct {

	// The ID for the Amazon Web Services account that contains the dashboard that
	// you're embedding.
	//
	// This member is required.
	AwsAccountId *string

	// The experience you are embedding. For registered users, you can embed Amazon
	// QuickSight dashboards or the entire Amazon QuickSight console.
	//
	// This member is required.
	ExperienceConfiguration *types.RegisteredUserEmbeddingExperienceConfiguration

	// The Amazon Resource Name for the registered user.
	//
	// This member is required.
	UserArn *string

	// How many minutes the session is valid. The session lifetime must be in [15-600]
	// minutes range.
	SessionLifetimeInMinutes *int64
	// contains filtered or unexported fields
}

type GenerateEmbedUrlForRegisteredUserOutput added in v1.7.0 

type GenerateEmbedUrlForRegisteredUserOutput struct {

	// The embed URL for the Amazon QuickSight dashboard or console.
	//
	// This member is required.
	EmbedUrl *string

	// The Amazon Web Services request ID for this operation.
	//
	// This member is required.
	RequestId *string

	// The HTTP status of the request.
	//
	// This member is required.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetDashboardEmbedUrlInput 

type GetDashboardEmbedUrlInput struct {

	// The ID for the Amazon Web Services account that contains the dashboard that
	// you're embedding.
	//
	// This member is required.
	AwsAccountId *string

	// The ID for the dashboard, also added to the Identity and Access Management (IAM)
	// policy.
	//
	// This member is required.
	DashboardId *string

	// The authentication method that the user uses to sign in.
	//
	// This member is required.
	IdentityType types.EmbeddingIdentityType

	// A list of one or more dashboard IDs that you want to add to a session that
	// includes anonymous users. The IdentityType parameter must be set to ANONYMOUS
	// for this to work, because other identity types authenticate as Amazon QuickSight
	// or IAM users. For example, if you set "--dashboard-id dash_id1 --dashboard-id
	// dash_id2 dash_id3 identity-type ANONYMOUS", the session can access all three
	// dashboards.
	AdditionalDashboardIds []string

	// The Amazon QuickSight namespace that contains the dashboard IDs in this request.
	// If you're not using a custom namespace, set Namespace = default.
	Namespace *string

	// Remove the reset button on the embedded dashboard. The default is FALSE, which
	// enables the reset button.
	ResetDisabled bool

	// How many minutes the session is valid. The session lifetime must be 15-600
	// minutes.
	SessionLifetimeInMinutes *int64

	// Adds persistence of state for the user session in an embedded dashboard.
	// Persistence applies to the sheet and the parameter settings. These are control
	// settings that the dashboard subscriber (Amazon QuickSight reader) chooses while
	// viewing the dashboard. If this is set to TRUE, the settings are the same when
	// the subscriber reopens the same dashboard URL. The state is stored in Amazon
	// QuickSight, not in a browser cookie. If this is set to FALSE, the state of the
	// user session is not persisted. The default is FALSE.
	StatePersistenceEnabled bool

	// Remove the undo/redo button on the embedded dashboard. The default is FALSE,
	// which enables the undo/redo button.
	UndoRedoDisabled bool

	// The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT
	// identity type. You can use this for any Amazon QuickSight users in your account
	// (readers, authors, or admins) authenticated as one of the following:
	//
	// * Active
	// Directory (AD) users or group members
	//
	// * Invited nonfederated users
	//
	// * IAM users
	// and IAM role-based sessions authenticated through Federated Single Sign-On using
	// SAML, OpenID Connect, or IAM federation.
	//
	// Omit this parameter for users in the
	// third group – IAM users and IAM role-based sessions.
	UserArn *string
	// contains filtered or unexported fields
}

type GetDashboardEmbedUrlOutput 

type GetDashboardEmbedUrlOutput struct {

	// A single-use URL that you can put into your server-side webpage to embed your
	// dashboard. This URL is valid for 5 minutes. The API operation provides the URL
	// with an auth_code value that enables one (and only one) sign-on to a user
	// session that is valid for 10 hours.
	EmbedUrl *string

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Output returned from the GetDashboardEmbedUrl operation.

type GetSessionEmbedUrlInput 

type GetSessionEmbedUrlInput struct {

	// The ID for the Amazon Web Services account associated with your Amazon
	// QuickSight subscription.
	//
	// This member is required.
	AwsAccountId *string

	// The URL you use to access the embedded session. The entry point URL is
	// constrained to the following paths:
	//
	// * /start
	//
	// * /start/analyses
	//
	// *
	// /start/dashboards
	//
	// * /start/favorites
	//
	// * /dashboards/DashboardId  - where
	// DashboardId is the actual ID key from the Amazon QuickSight console URL of the
	// dashboard
	//
	// * /analyses/AnalysisId  - where AnalysisId is the actual ID key from
	// the Amazon QuickSight console URL of the analysis
	EntryPoint *string

	// How many minutes the session is valid. The session lifetime must be 15-600
	// minutes.
	SessionLifetimeInMinutes *int64

	// The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT
	// identity type. You can use this for any type of Amazon QuickSight users in your
	// account (readers, authors, or admins). They need to be authenticated as one of
	// the following:
	//
	// * Active Directory (AD) users or group members
	//
	// * Invited
	// nonfederated users
	//
	// * Identity and Access Management (IAM) users and IAM
	// role-based sessions authenticated through Federated Single Sign-On using SAML,
	// OpenID Connect, or IAM federation
	//
	// Omit this parameter for users in the third
	// group, IAM users and IAM role-based sessions.
	UserArn *string
	// contains filtered or unexported fields
}

type GetSessionEmbedUrlOutput 

type GetSessionEmbedUrlOutput struct {

	// A single-use URL that you can put into your server-side web page to embed your
	// Amazon QuickSight session. This URL is valid for 5 minutes. The API operation
	// provides the URL with an auth_code value that enables one (and only one) sign-on
	// to a user session that is valid for 10 hours.
	EmbedUrl *string

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type HTTPClient 

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4 

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type ListAnalysesAPIClient added in v0.30.0 

type ListAnalysesAPIClient interface {
	ListAnalyses(context.Context, *ListAnalysesInput, ...func(*Options)) (*ListAnalysesOutput, error)
}

ListAnalysesAPIClient is a client that implements the ListAnalyses operation.

type ListAnalysesInput added in v0.29.0 

type ListAnalysesInput struct {

	// The ID of the Amazon Web Services account that contains the analyses.
	//
	// This member is required.
	AwsAccountId *string

	// The maximum number of results to return.
	MaxResults int32

	// A pagination token that can be used in a subsequent request.
	NextToken *string
	// contains filtered or unexported fields
}

type ListAnalysesOutput added in v0.29.0 

type ListAnalysesOutput struct {

	// Metadata describing each of the analyses that are listed.
	AnalysisSummaryList []types.AnalysisSummary

	// A pagination token that can be used in a subsequent request.
	NextToken *string

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListAnalysesPaginator added in v0.30.0 

type ListAnalysesPaginator struct {
	// contains filtered or unexported fields
}

ListAnalysesPaginator is a paginator for ListAnalyses

func NewListAnalysesPaginator added in v0.30.0 

func NewListAnalysesPaginator(client ListAnalysesAPIClient, params *ListAnalysesInput, optFns ...func(*ListAnalysesPaginatorOptions)) *ListAnalysesPaginator

NewListAnalysesPaginator returns a new ListAnalysesPaginator

func (*ListAnalysesPaginator) HasMorePages added in v0.30.0 

func (p *ListAnalysesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAnalysesPaginator) NextPage added in v0.30.0 

func (p *ListAnalysesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAnalysesOutput, error)

NextPage retrieves the next ListAnalyses page.

type ListAnalysesPaginatorOptions added in v0.30.0 

type ListAnalysesPaginatorOptions struct {
	// The maximum number of results to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListAnalysesPaginatorOptions is the paginator options for ListAnalyses

type ListDashboardVersionsAPIClient added in v0.30.0 

type ListDashboardVersionsAPIClient interface {
	ListDashboardVersions(context.Context, *ListDashboardVersionsInput, ...func(*Options)) (*ListDashboardVersionsOutput, error)
}

ListDashboardVersionsAPIClient is a client that implements the ListDashboardVersions operation.

type ListDashboardVersionsInput 

type ListDashboardVersionsInput struct {

	// The ID of the Amazon Web Services account that contains the dashboard that
	// you're listing versions for.
	//
	// This member is required.
	AwsAccountId *string

	// The ID for the dashboard.
	//
	// This member is required.
	DashboardId *string

	// The maximum number of results to be returned per request.
	MaxResults int32

	// The token for the next set of results, or null if there are no more results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListDashboardVersionsOutput 

type ListDashboardVersionsOutput struct {

	// A structure that contains information about each version of the dashboard.
	DashboardVersionSummaryList []types.DashboardVersionSummary

	// The token for the next set of results, or null if there are no more results.
	NextToken *string

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListDashboardVersionsPaginator added in v0.30.0 

type ListDashboardVersionsPaginator struct {
	// contains filtered or unexported fields
}

ListDashboardVersionsPaginator is a paginator for ListDashboardVersions

func NewListDashboardVersionsPaginator added in v0.30.0 

func NewListDashboardVersionsPaginator(client ListDashboardVersionsAPIClient, params *ListDashboardVersionsInput, optFns ...func(*ListDashboardVersionsPaginatorOptions)) *ListDashboardVersionsPaginator

NewListDashboardVersionsPaginator returns a new ListDashboardVersionsPaginator

func (*ListDashboardVersionsPaginator) HasMorePages added in v0.30.0 

func (p *ListDashboardVersionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDashboardVersionsPaginator) NextPage added in v0.30.0 

func (p *ListDashboardVersionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDashboardVersionsOutput, error)

NextPage retrieves the next ListDashboardVersions page.

type ListDashboardVersionsPaginatorOptions added in v0.30.0 

type ListDashboardVersionsPaginatorOptions struct {
	// The maximum number of results to be returned per request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListDashboardVersionsPaginatorOptions is the paginator options for ListDashboardVersions

type ListDashboardsAPIClient added in v0.30.0 

type ListDashboardsAPIClient interface {
	ListDashboards(context.Context, *ListDashboardsInput, ...func(*Options)) (*ListDashboardsOutput, error)
}

ListDashboardsAPIClient is a client that implements the ListDashboards operation.

type ListDashboardsInput 

type ListDashboardsInput struct {

	// The ID of the Amazon Web Services account that contains the dashboards that
	// you're listing.
	//
	// This member is required.
	AwsAccountId *string

	// The maximum number of results to be returned per request.
	MaxResults int32

	// The token for the next set of results, or null if there are no more results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListDashboardsOutput 

type ListDashboardsOutput struct {

	// A structure that contains all of the dashboards in your Amazon Web Services
	// account. This structure provides basic information about the dashboards.
	DashboardSummaryList []types.DashboardSummary

	// The token for the next set of results, or null if there are no more results.
	NextToken *string

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListDashboardsPaginator added in v0.30.0 

type ListDashboardsPaginator struct {
	// contains filtered or unexported fields
}

ListDashboardsPaginator is a paginator for ListDashboards

func NewListDashboardsPaginator added in v0.30.0 

func NewListDashboardsPaginator(client ListDashboardsAPIClient, params *ListDashboardsInput, optFns ...func(*ListDashboardsPaginatorOptions)) *ListDashboardsPaginator

NewListDashboardsPaginator returns a new ListDashboardsPaginator

func (*ListDashboardsPaginator) HasMorePages added in v0.30.0 

func (p *ListDashboardsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDashboardsPaginator) NextPage added in v0.30.0 

func (p *ListDashboardsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDashboardsOutput, error)

NextPage retrieves the next ListDashboards page.

type ListDashboardsPaginatorOptions added in v0.30.0 

type ListDashboardsPaginatorOptions struct {
	// The maximum number of results to be returned per request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListDashboardsPaginatorOptions is the paginator options for ListDashboards

type ListDataSetsAPIClient added in v0.30.0 

type ListDataSetsAPIClient interface {
	ListDataSets(context.Context, *ListDataSetsInput, ...func(*Options)) (*ListDataSetsOutput, error)
}

ListDataSetsAPIClient is a client that implements the ListDataSets operation.

type ListDataSetsInput 

type ListDataSetsInput struct {

	// The Amazon Web Services account ID.
	//
	// This member is required.
	AwsAccountId *string

	// The maximum number of results to be returned per request.
	MaxResults int32

	// The token for the next set of results, or null if there are no more results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListDataSetsOutput 

type ListDataSetsOutput struct {

	// The list of dataset summaries.
	DataSetSummaries []types.DataSetSummary

	// The token for the next set of results, or null if there are no more results.
	NextToken *string

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListDataSetsPaginator added in v0.30.0 

type ListDataSetsPaginator struct {
	// contains filtered or unexported fields
}

ListDataSetsPaginator is a paginator for ListDataSets

func NewListDataSetsPaginator added in v0.30.0 

func NewListDataSetsPaginator(client ListDataSetsAPIClient, params *ListDataSetsInput, optFns ...func(*ListDataSetsPaginatorOptions)) *ListDataSetsPaginator

NewListDataSetsPaginator returns a new ListDataSetsPaginator

func (*ListDataSetsPaginator) HasMorePages added in v0.30.0 

func (p *ListDataSetsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDataSetsPaginator) NextPage added in v0.30.0 

func (p *ListDataSetsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDataSetsOutput, error)

NextPage retrieves the next ListDataSets page.

type ListDataSetsPaginatorOptions added in v0.30.0 

type ListDataSetsPaginatorOptions struct {
	// The maximum number of results to be returned per request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListDataSetsPaginatorOptions is the paginator options for ListDataSets

type ListDataSourcesAPIClient added in v0.30.0 

type ListDataSourcesAPIClient interface {
	ListDataSources(context.Context, *ListDataSourcesInput, ...func(*Options)) (*ListDataSourcesOutput, error)
}

ListDataSourcesAPIClient is a client that implements the ListDataSources operation.

type ListDataSourcesInput 

type ListDataSourcesInput struct {

	// The Amazon Web Services account ID.
	//
	// This member is required.
	AwsAccountId *string

	// The maximum number of results to be returned per request.
	MaxResults int32

	// The token for the next set of results, or null if there are no more results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListDataSourcesOutput 

type ListDataSourcesOutput struct {

	// A list of data sources.
	DataSources []types.DataSource

	// The token for the next set of results, or null if there are no more results.
	NextToken *string

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListDataSourcesPaginator added in v0.30.0 

type ListDataSourcesPaginator struct {
	// contains filtered or unexported fields
}

ListDataSourcesPaginator is a paginator for ListDataSources

func NewListDataSourcesPaginator added in v0.30.0 

func NewListDataSourcesPaginator(client ListDataSourcesAPIClient, params *ListDataSourcesInput, optFns ...func(*ListDataSourcesPaginatorOptions)) *ListDataSourcesPaginator

NewListDataSourcesPaginator returns a new ListDataSourcesPaginator

func (*ListDataSourcesPaginator) HasMorePages added in v0.30.0 

func (p *ListDataSourcesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDataSourcesPaginator) NextPage added in v0.30.0 

func (p *ListDataSourcesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDataSourcesOutput, error)

NextPage retrieves the next ListDataSources page.

type ListDataSourcesPaginatorOptions added in v0.30.0 

type ListDataSourcesPaginatorOptions struct {
	// The maximum number of results to be returned per request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListDataSourcesPaginatorOptions is the paginator options for ListDataSources

type ListFolderMembersInput added in v1.6.0 

type ListFolderMembersInput struct {

	// The ID for the Amazon Web Services account that contains the folder.
	//
	// This member is required.
	AwsAccountId *string

	// The ID of the folder.
	//
	// This member is required.
	FolderId *string

	// The maximum number of results to be returned per request.
	MaxResults int32

	// The token for the next set of results, or null if there are no more results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListFolderMembersOutput added in v1.6.0 

type ListFolderMembersOutput struct {

	// A structure that contains all of the folder members (dashboards, analyses, and
	// datasets) in the folder.
	FolderMemberList []types.MemberIdArnPair

	// The token for the next set of results, or null if there are no more results.
	NextToken *string

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListFoldersInput added in v1.6.0 

type ListFoldersInput struct {

	// The ID for the Amazon Web Services account that contains the folder.
	//
	// This member is required.
	AwsAccountId *string

	// The maximum number of results to be returned per request.
	MaxResults int32

	// The token for the next set of results, or null if there are no more results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListFoldersOutput added in v1.6.0 

type ListFoldersOutput struct {

	// A structure that contains all of the folders in the Amazon Web Services account.
	// This structure provides basic information about the folders.
	FolderSummaryList []types.FolderSummary

	// The token for the next set of results, or null if there are no more results.
	NextToken *string

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListGroupMembershipsInput 

type ListGroupMembershipsInput struct {

	// The ID for the Amazon Web Services account that the group is in. Currently, you
	// use the ID for the Amazon Web Services account that contains your Amazon
	// QuickSight account.
	//
	// This member is required.
	AwsAccountId *string

	// The name of the group that you want to see a membership list of.
	//
	// This member is required.
	GroupName *string

	// The namespace. Currently, you should set this to default.
	//
	// This member is required.
	Namespace *string

	// The maximum number of results to return from this request.
	MaxResults int32

	// A pagination token that can be used in a subsequent request.
	NextToken *string
	// contains filtered or unexported fields
}

type ListGroupMembershipsOutput 

type ListGroupMembershipsOutput struct {

	// The list of the members of the group.
	GroupMemberList []types.GroupMember

	// A pagination token that can be used in a subsequent request.
	NextToken *string

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListGroupsInput 

type ListGroupsInput struct {

	// The ID for the Amazon Web Services account that the group is in. Currently, you
	// use the ID for the Amazon Web Services account that contains your Amazon
	// QuickSight account.
	//
	// This member is required.
	AwsAccountId *string

	// The namespace. Currently, you should set this to default.
	//
	// This member is required.
	Namespace *string

	// The maximum number of results to return.
	MaxResults int32

	// A pagination token that can be used in a subsequent request.
	NextToken *string
	// contains filtered or unexported fields
}

type ListGroupsOutput 

type ListGroupsOutput struct {

	// The list of the groups.
	GroupList []types.Group

	// A pagination token that can be used in a subsequent request.
	NextToken *string

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListIAMPolicyAssignmentsForUserInput 

type ListIAMPolicyAssignmentsForUserInput struct {

	// The ID of the Amazon Web Services account that contains the assignments.
	//
	// This member is required.
	AwsAccountId *string

	// The namespace of the assignment.
	//
	// This member is required.
	Namespace *string

	// The name of the user.
	//
	// This member is required.
	UserName *string

	// The maximum number of results to be returned per request.
	MaxResults int32

	// The token for the next set of results, or null if there are no more results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListIAMPolicyAssignmentsForUserOutput 

type ListIAMPolicyAssignmentsForUserOutput struct {

	// The active assignments for this user.
	ActiveAssignments []types.ActiveIAMPolicyAssignment

	// The token for the next set of results, or null if there are no more results.
	NextToken *string

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListIAMPolicyAssignmentsInput 

type ListIAMPolicyAssignmentsInput struct {

	// The ID of the Amazon Web Services account that contains these IAM policy
	// assignments.
	//
	// This member is required.
	AwsAccountId *string

	// The namespace for the assignments.
	//
	// This member is required.
	Namespace *string

	// The status of the assignments.
	AssignmentStatus types.AssignmentStatus

	// The maximum number of results to be returned per request.
	MaxResults int32

	// The token for the next set of results, or null if there are no more results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListIAMPolicyAssignmentsOutput 

type ListIAMPolicyAssignmentsOutput struct {

	// Information describing the IAM policy assignments.
	IAMPolicyAssignments []types.IAMPolicyAssignmentSummary

	// The token for the next set of results, or null if there are no more results.
	NextToken *string

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListIngestionsAPIClient added in v0.30.0 

type ListIngestionsAPIClient interface {
	ListIngestions(context.Context, *ListIngestionsInput, ...func(*Options)) (*ListIngestionsOutput, error)
}

ListIngestionsAPIClient is a client that implements the ListIngestions operation.

type ListIngestionsInput 

type ListIngestionsInput struct {

	// The Amazon Web Services account ID.
	//
	// This member is required.
	AwsAccountId *string

	// The ID of the dataset used in the ingestion.
	//
	// This member is required.
	DataSetId *string

	// The maximum number of results to be returned per request.
	MaxResults int32

	// The token for the next set of results, or null if there are no more results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListIngestionsOutput 

type ListIngestionsOutput struct {

	// A list of the ingestions.
	Ingestions []types.Ingestion

	// The token for the next set of results, or null if there are no more results.
	NextToken *string

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListIngestionsPaginator added in v0.30.0 

type ListIngestionsPaginator struct {
	// contains filtered or unexported fields
}

ListIngestionsPaginator is a paginator for ListIngestions

func NewListIngestionsPaginator added in v0.30.0 

func NewListIngestionsPaginator(client ListIngestionsAPIClient, params *ListIngestionsInput, optFns ...func(*ListIngestionsPaginatorOptions)) *ListIngestionsPaginator

NewListIngestionsPaginator returns a new ListIngestionsPaginator

func (*ListIngestionsPaginator) HasMorePages added in v0.30.0 

func (p *ListIngestionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListIngestionsPaginator) NextPage added in v0.30.0 

func (p *ListIngestionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListIngestionsOutput, error)

NextPage retrieves the next ListIngestions page.

type ListIngestionsPaginatorOptions added in v0.30.0 

type ListIngestionsPaginatorOptions struct {
	// The maximum number of results to be returned per request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListIngestionsPaginatorOptions is the paginator options for ListIngestions

type ListNamespacesAPIClient added in v0.30.0 

type ListNamespacesAPIClient interface {
	ListNamespaces(context.Context, *ListNamespacesInput, ...func(*Options)) (*ListNamespacesOutput, error)
}

ListNamespacesAPIClient is a client that implements the ListNamespaces operation.

type ListNamespacesInput 

type ListNamespacesInput struct {

	// The ID for the Amazon Web Services account that contains the Amazon QuickSight
	// namespaces that you want to list.
	//
	// This member is required.
	AwsAccountId *string

	// The maximum number of results to return.
	MaxResults int32

	// A pagination token that can be used in a subsequent request.
	NextToken *string
	// contains filtered or unexported fields
}

type ListNamespacesOutput 

type ListNamespacesOutput struct {

	// The information about the namespaces in this Amazon Web Services account. The
	// response includes the namespace ARN, name, Amazon Web Services Region,
	// notification email address, creation status, and identity store.
	Namespaces []types.NamespaceInfoV2

	// A pagination token that can be used in a subsequent request.
	NextToken *string

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListNamespacesPaginator added in v0.30.0 

type ListNamespacesPaginator struct {
	// contains filtered or unexported fields
}

ListNamespacesPaginator is a paginator for ListNamespaces

func NewListNamespacesPaginator added in v0.30.0 

func NewListNamespacesPaginator(client ListNamespacesAPIClient, params *ListNamespacesInput, optFns ...func(*ListNamespacesPaginatorOptions)) *ListNamespacesPaginator

NewListNamespacesPaginator returns a new ListNamespacesPaginator

func (*ListNamespacesPaginator) HasMorePages added in v0.30.0 

func (p *ListNamespacesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListNamespacesPaginator) NextPage added in v0.30.0 

func (p *ListNamespacesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListNamespacesOutput, error)

NextPage retrieves the next ListNamespaces page.

type ListNamespacesPaginatorOptions added in v0.30.0 

type ListNamespacesPaginatorOptions struct {
	// The maximum number of results to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListNamespacesPaginatorOptions is the paginator options for ListNamespaces

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource that you want a list of tags for.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Contains a map of the key-value pairs for the resource tag or tags assigned to
	// the resource.
	Tags []types.Tag

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListTemplateAliasesAPIClient added in v0.30.0 

type ListTemplateAliasesAPIClient interface {
	ListTemplateAliases(context.Context, *ListTemplateAliasesInput, ...func(*Options)) (*ListTemplateAliasesOutput, error)
}

ListTemplateAliasesAPIClient is a client that implements the ListTemplateAliases operation.

type ListTemplateAliasesInput 

type ListTemplateAliasesInput struct {

	// The ID of the Amazon Web Services account that contains the template aliases
	// that you're listing.
	//
	// This member is required.
	AwsAccountId *string

	// The ID for the template.
	//
	// This member is required.
	TemplateId *string

	// The maximum number of results to be returned per request.
	MaxResults int32

	// The token for the next set of results, or null if there are no more results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListTemplateAliasesOutput 

type ListTemplateAliasesOutput struct {

	// The token for the next set of results, or null if there are no more results.
	NextToken *string

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// A structure containing the list of the template's aliases.
	TemplateAliasList []types.TemplateAlias

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListTemplateAliasesPaginator added in v0.30.0 

type ListTemplateAliasesPaginator struct {
	// contains filtered or unexported fields
}

ListTemplateAliasesPaginator is a paginator for ListTemplateAliases

func NewListTemplateAliasesPaginator added in v0.30.0 

func NewListTemplateAliasesPaginator(client ListTemplateAliasesAPIClient, params *ListTemplateAliasesInput, optFns ...func(*ListTemplateAliasesPaginatorOptions)) *ListTemplateAliasesPaginator

NewListTemplateAliasesPaginator returns a new ListTemplateAliasesPaginator

func (*ListTemplateAliasesPaginator) HasMorePages added in v0.30.0 

func (p *ListTemplateAliasesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTemplateAliasesPaginator) NextPage added in v0.30.0 

func (p *ListTemplateAliasesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTemplateAliasesOutput, error)

NextPage retrieves the next ListTemplateAliases page.

type ListTemplateAliasesPaginatorOptions added in v0.30.0 

type ListTemplateAliasesPaginatorOptions struct {
	// The maximum number of results to be returned per request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListTemplateAliasesPaginatorOptions is the paginator options for ListTemplateAliases

type ListTemplateVersionsAPIClient added in v0.30.0 

type ListTemplateVersionsAPIClient interface {
	ListTemplateVersions(context.Context, *ListTemplateVersionsInput, ...func(*Options)) (*ListTemplateVersionsOutput, error)
}

ListTemplateVersionsAPIClient is a client that implements the ListTemplateVersions operation.

type ListTemplateVersionsInput 

type ListTemplateVersionsInput struct {

	// The ID of the Amazon Web Services account that contains the templates that
	// you're listing.
	//
	// This member is required.
	AwsAccountId *string

	// The ID for the template.
	//
	// This member is required.
	TemplateId *string

	// The maximum number of results to be returned per request.
	MaxResults int32

	// The token for the next set of results, or null if there are no more results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListTemplateVersionsOutput 

type ListTemplateVersionsOutput struct {

	// The token for the next set of results, or null if there are no more results.
	NextToken *string

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// A structure containing a list of all the versions of the specified template.
	TemplateVersionSummaryList []types.TemplateVersionSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListTemplateVersionsPaginator added in v0.30.0 

type ListTemplateVersionsPaginator struct {
	// contains filtered or unexported fields
}

ListTemplateVersionsPaginator is a paginator for ListTemplateVersions

func NewListTemplateVersionsPaginator added in v0.30.0 

func NewListTemplateVersionsPaginator(client ListTemplateVersionsAPIClient, params *ListTemplateVersionsInput, optFns ...func(*ListTemplateVersionsPaginatorOptions)) *ListTemplateVersionsPaginator

NewListTemplateVersionsPaginator returns a new ListTemplateVersionsPaginator

func (*ListTemplateVersionsPaginator) HasMorePages added in v0.30.0 

func (p *ListTemplateVersionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTemplateVersionsPaginator) NextPage added in v0.30.0 

func (p *ListTemplateVersionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTemplateVersionsOutput, error)

NextPage retrieves the next ListTemplateVersions page.

type ListTemplateVersionsPaginatorOptions added in v0.30.0 

type ListTemplateVersionsPaginatorOptions struct {
	// The maximum number of results to be returned per request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListTemplateVersionsPaginatorOptions is the paginator options for ListTemplateVersions

type ListTemplatesAPIClient added in v0.30.0 

type ListTemplatesAPIClient interface {
	ListTemplates(context.Context, *ListTemplatesInput, ...func(*Options)) (*ListTemplatesOutput, error)
}

ListTemplatesAPIClient is a client that implements the ListTemplates operation.

type ListTemplatesInput 

type ListTemplatesInput struct {

	// The ID of the Amazon Web Services account that contains the templates that
	// you're listing.
	//
	// This member is required.
	AwsAccountId *string

	// The maximum number of results to be returned per request.
	MaxResults int32

	// The token for the next set of results, or null if there are no more results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListTemplatesOutput 

type ListTemplatesOutput struct {

	// The token for the next set of results, or null if there are no more results.
	NextToken *string

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// A structure containing information about the templates in the list.
	TemplateSummaryList []types.TemplateSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListTemplatesPaginator added in v0.30.0 

type ListTemplatesPaginator struct {
	// contains filtered or unexported fields
}

ListTemplatesPaginator is a paginator for ListTemplates

func NewListTemplatesPaginator added in v0.30.0 

func NewListTemplatesPaginator(client ListTemplatesAPIClient, params *ListTemplatesInput, optFns ...func(*ListTemplatesPaginatorOptions)) *ListTemplatesPaginator

NewListTemplatesPaginator returns a new ListTemplatesPaginator

func (*ListTemplatesPaginator) HasMorePages added in v0.30.0 

func (p *ListTemplatesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTemplatesPaginator) NextPage added in v0.30.0 

func (p *ListTemplatesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTemplatesOutput, error)

NextPage retrieves the next ListTemplates page.

type ListTemplatesPaginatorOptions added in v0.30.0 

type ListTemplatesPaginatorOptions struct {
	// The maximum number of results to be returned per request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListTemplatesPaginatorOptions is the paginator options for ListTemplates

type ListThemeAliasesInput 

type ListThemeAliasesInput struct {

	// The ID of the Amazon Web Services account that contains the theme aliases that
	// you're listing.
	//
	// This member is required.
	AwsAccountId *string

	// The ID for the theme.
	//
	// This member is required.
	ThemeId *string

	// The maximum number of results to be returned per request.
	MaxResults int32

	// The token for the next set of results, or null if there are no more results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListThemeAliasesOutput 

type ListThemeAliasesOutput struct {

	// The token for the next set of results, or null if there are no more results.
	NextToken *string

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// A structure containing the list of the theme's aliases.
	ThemeAliasList []types.ThemeAlias

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListThemeVersionsAPIClient added in v1.2.0 

type ListThemeVersionsAPIClient interface {
	ListThemeVersions(context.Context, *ListThemeVersionsInput, ...func(*Options)) (*ListThemeVersionsOutput, error)
}

ListThemeVersionsAPIClient is a client that implements the ListThemeVersions operation.

type ListThemeVersionsInput 

type ListThemeVersionsInput struct {

	// The ID of the Amazon Web Services account that contains the themes that you're
	// listing.
	//
	// This member is required.
	AwsAccountId *string

	// The ID for the theme.
	//
	// This member is required.
	ThemeId *string

	// The maximum number of results to be returned per request.
	MaxResults int32

	// The token for the next set of results, or null if there are no more results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListThemeVersionsOutput 

type ListThemeVersionsOutput struct {

	// The token for the next set of results, or null if there are no more results.
	NextToken *string

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// A structure containing a list of all the versions of the specified theme.
	ThemeVersionSummaryList []types.ThemeVersionSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListThemeVersionsPaginator added in v1.2.0 

type ListThemeVersionsPaginator struct {
	// contains filtered or unexported fields
}

ListThemeVersionsPaginator is a paginator for ListThemeVersions

func NewListThemeVersionsPaginator added in v1.2.0 

func NewListThemeVersionsPaginator(client ListThemeVersionsAPIClient, params *ListThemeVersionsInput, optFns ...func(*ListThemeVersionsPaginatorOptions)) *ListThemeVersionsPaginator

NewListThemeVersionsPaginator returns a new ListThemeVersionsPaginator

func (*ListThemeVersionsPaginator) HasMorePages added in v1.2.0 

func (p *ListThemeVersionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListThemeVersionsPaginator) NextPage added in v1.2.0 

func (p *ListThemeVersionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListThemeVersionsOutput, error)

NextPage retrieves the next ListThemeVersions page.

type ListThemeVersionsPaginatorOptions added in v1.2.0 

type ListThemeVersionsPaginatorOptions struct {
	// The maximum number of results to be returned per request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListThemeVersionsPaginatorOptions is the paginator options for ListThemeVersions

type ListThemesAPIClient added in v1.2.0 

type ListThemesAPIClient interface {
	ListThemes(context.Context, *ListThemesInput, ...func(*Options)) (*ListThemesOutput, error)
}

ListThemesAPIClient is a client that implements the ListThemes operation.

type ListThemesInput 

type ListThemesInput struct {

	// The ID of the Amazon Web Services account that contains the themes that you're
	// listing.
	//
	// This member is required.
	AwsAccountId *string

	// The maximum number of results to be returned per request.
	MaxResults int32

	// The token for the next set of results, or null if there are no more results.
	NextToken *string

	// The type of themes that you want to list. Valid options include the
	// following:
	//
	// * ALL (default)- Display all existing themes.
	//
	// * CUSTOM - Display
	// only the themes created by people using Amazon QuickSight.
	//
	// * QUICKSIGHT -
	// Display only the starting themes defined by Amazon QuickSight.
	Type types.ThemeType
	// contains filtered or unexported fields
}

type ListThemesOutput 

type ListThemesOutput struct {

	// The token for the next set of results, or null if there are no more results.
	NextToken *string

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Information about the themes in the list.
	ThemeSummaryList []types.ThemeSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListThemesPaginator added in v1.2.0 

type ListThemesPaginator struct {
	// contains filtered or unexported fields
}

ListThemesPaginator is a paginator for ListThemes

func NewListThemesPaginator added in v1.2.0 

func NewListThemesPaginator(client ListThemesAPIClient, params *ListThemesInput, optFns ...func(*ListThemesPaginatorOptions)) *ListThemesPaginator

NewListThemesPaginator returns a new ListThemesPaginator

func (*ListThemesPaginator) HasMorePages added in v1.2.0 

func (p *ListThemesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListThemesPaginator) NextPage added in v1.2.0 

func (p *ListThemesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListThemesOutput, error)

NextPage retrieves the next ListThemes page.

type ListThemesPaginatorOptions added in v1.2.0 

type ListThemesPaginatorOptions struct {
	// The maximum number of results to be returned per request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListThemesPaginatorOptions is the paginator options for ListThemes

type ListUserGroupsInput 

type ListUserGroupsInput struct {

	// The Amazon Web Services account ID that the user is in. Currently, you use the
	// ID for the Amazon Web Services account that contains your Amazon QuickSight
	// account.
	//
	// This member is required.
	AwsAccountId *string

	// The namespace. Currently, you should set this to default.
	//
	// This member is required.
	Namespace *string

	// The Amazon QuickSight user name that you want to list group memberships for.
	//
	// This member is required.
	UserName *string

	// The maximum number of results to return from this request.
	MaxResults int32

	// A pagination token that can be used in a subsequent request.
	NextToken *string
	// contains filtered or unexported fields
}

type ListUserGroupsOutput 

type ListUserGroupsOutput struct {

	// The list of groups the user is a member of.
	GroupList []types.Group

	// A pagination token that can be used in a subsequent request.
	NextToken *string

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListUsersInput 

type ListUsersInput struct {

	// The ID for the Amazon Web Services account that the user is in. Currently, you
	// use the ID for the Amazon Web Services account that contains your Amazon
	// QuickSight account.
	//
	// This member is required.
	AwsAccountId *string

	// The namespace. Currently, you should set this to default.
	//
	// This member is required.
	Namespace *string

	// The maximum number of results to return from this request.
	MaxResults int32

	// A pagination token that can be used in a subsequent request.
	NextToken *string
	// contains filtered or unexported fields
}

type ListUsersOutput 

type ListUsersOutput struct {

	// A pagination token that can be used in a subsequent request.
	NextToken *string

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// The list of users.
	UserList []types.User

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type Options 

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	EndpointResolver EndpointResolver

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The region to send requests to. (Required)
	Region string

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts. When creating a new API Clients this
	// member will only be used if the Retryer Options member is nil. This value will
	// be ignored if Retryer is not nil. If specified in an operation call's functional
	// options with a value that is different than the constructed client's Options,
	// the Client's Retryer will be wrapped to use the operation's specific
	// RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified. When creating a new API Clients this
	// member will only be used if the Retryer Options member is nil. This value will
	// be ignored if Retryer is not nil. Currently does not support per operation call
	// overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient
	// contains filtered or unexported fields
}

func (Options) Copy 

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

type RegisterUserInput 

type RegisterUserInput struct {

	// The ID for the Amazon Web Services account that the user is in. Currently, you
	// use the ID for the Amazon Web Services account that contains your Amazon
	// QuickSight account.
	//
	// This member is required.
	AwsAccountId *string

	// The email address of the user that you want to register.
	//
	// This member is required.
	Email *string

	// Amazon QuickSight supports several ways of managing the identity of users. This
	// parameter accepts two values:
	//
	// * IAM: A user whose identity maps to an existing
	// IAM user or role.
	//
	// * QUICKSIGHT: A user whose identity is owned and managed
	// internally by Amazon QuickSight.
	//
	// This member is required.
	IdentityType types.IdentityType

	// The namespace. Currently, you should set this to default.
	//
	// This member is required.
	Namespace *string

	// The Amazon QuickSight role for the user. The user role can be one of the
	// following:
	//
	// * READER: A user who has read-only access to dashboards.
	//
	// * AUTHOR:
	// A user who can create data sources, datasets, analyses, and dashboards.
	//
	// *
	// ADMIN: A user who is an author, who can also manage Amazon QuickSight
	// settings.
	//
	// * RESTRICTED_READER: This role isn't currently available for use.
	//
	// *
	// RESTRICTED_AUTHOR: This role isn't currently available for use.
	//
	// This member is required.
	UserRole types.UserRole

	// The URL of the custom OpenID Connect (OIDC) provider that provides identity to
	// let a user federate into Amazon QuickSight with an associated Identity and
	// Access Management(IAM) role. This parameter should only be used when
	// ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC.
	CustomFederationProviderUrl *string

	// (Enterprise edition only) The name of the custom permissions profile that you
	// want to assign to this user. Customized permissions allows you to control a
	// user's access by restricting access the following operations:
	//
	// * Create and
	// update data sources
	//
	// * Create and update datasets
	//
	// * Create and update email
	// reports
	//
	// * Subscribe to email reports
	//
	// To add custom permissions to an existing
	// user, use UpdateUser
	// (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateUser.html)
	// instead. A set of custom permissions includes any combination of these
	// restrictions. Currently, you need to create the profile names for custom
	// permission sets by using the Amazon QuickSight console. Then, you use the
	// RegisterUser API operation to assign the named set of permissions to a
	// QuickSight user. Amazon QuickSight custom permissions are applied through IAM
	// policies. Therefore, they override the permissions typically granted by
	// assigning Amazon QuickSight users to one of the default security cohorts in
	// Amazon QuickSight (admin, author, reader). This feature is available only to
	// Amazon QuickSight Enterprise edition subscriptions.
	CustomPermissionsName *string

	// The type of supported external login provider that provides identity to let a
	// user federate into Amazon QuickSight with an associated Identity and Access
	// Management(IAM) role. The type of supported external login provider can be one
	// of the following.
	//
	// * COGNITO: Amazon Cognito. The provider URL is
	// cognito-identity.amazonaws.com. When choosing the COGNITO provider type, don’t
	// use the "CustomFederationProviderUrl" parameter which is only needed when the
	// external provider is custom.
	//
	// * CUSTOM_OIDC: Custom OpenID Connect (OIDC)
	// provider. When choosing CUSTOM_OIDC type, use the CustomFederationProviderUrl
	// parameter to provide the custom OIDC provider URL.
	ExternalLoginFederationProviderType *string

	// The identity ID for a user in the external login provider.
	ExternalLoginId *string

	// The ARN of the IAM user or role that you are registering with Amazon QuickSight.
	IamArn *string

	// You need to use this parameter only when you register one or more users using an
	// assumed IAM role. You don't need to provide the session name for other
	// scenarios, for example when you are registering an IAM user or an Amazon
	// QuickSight user. You can register multiple users using the same IAM role if each
	// user has a different session name. For more information on assuming IAM roles,
	// see assume-role
	// (https://docs.aws.amazon.com/cli/latest/reference/sts/assume-role.html) in the
	// CLI Reference.
	SessionName *string

	// The Amazon QuickSight user name that you want to create for the user you are
	// registering.
	UserName *string
	// contains filtered or unexported fields
}

type RegisterUserOutput 

type RegisterUserOutput struct {

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// The user's user name.
	User *types.User

	// The URL the user visits to complete registration and provide a password. This is
	// returned only for users with an identity type of QUICKSIGHT.
	UserInvitationUrl *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type RestoreAnalysisInput added in v0.29.0 

type RestoreAnalysisInput struct {

	// The ID of the analysis that you're restoring.
	//
	// This member is required.
	AnalysisId *string

	// The ID of the Amazon Web Services account that contains the analysis.
	//
	// This member is required.
	AwsAccountId *string
	// contains filtered or unexported fields
}

type RestoreAnalysisOutput added in v0.29.0 

type RestoreAnalysisOutput struct {

	// The ID of the analysis that you're restoring.
	AnalysisId *string

	// The Amazon Resource Name (ARN) of the analysis that you're restoring.
	Arn *string

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type SearchAnalysesAPIClient added in v0.30.0 

type SearchAnalysesAPIClient interface {
	SearchAnalyses(context.Context, *SearchAnalysesInput, ...func(*Options)) (*SearchAnalysesOutput, error)
}

SearchAnalysesAPIClient is a client that implements the SearchAnalyses operation.

type SearchAnalysesInput added in v0.29.0 

type SearchAnalysesInput struct {

	// The ID of the Amazon Web Services account that contains the analyses that you're
	// searching for.
	//
	// This member is required.
	AwsAccountId *string

	// The structure for the search filters that you want to apply to your search.
	//
	// This member is required.
	Filters []types.AnalysisSearchFilter

	// The maximum number of results to return.
	MaxResults int32

	// A pagination token that can be used in a subsequent request.
	NextToken *string
	// contains filtered or unexported fields
}

type SearchAnalysesOutput added in v0.29.0 

type SearchAnalysesOutput struct {

	// Metadata describing the analyses that you searched for.
	AnalysisSummaryList []types.AnalysisSummary

	// A pagination token that can be used in a subsequent request.
	NextToken *string

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type SearchAnalysesPaginator added in v0.30.0 

type SearchAnalysesPaginator struct {
	// contains filtered or unexported fields
}

SearchAnalysesPaginator is a paginator for SearchAnalyses

func NewSearchAnalysesPaginator added in v0.30.0 

func NewSearchAnalysesPaginator(client SearchAnalysesAPIClient, params *SearchAnalysesInput, optFns ...func(*SearchAnalysesPaginatorOptions)) *SearchAnalysesPaginator

NewSearchAnalysesPaginator returns a new SearchAnalysesPaginator

func (*SearchAnalysesPaginator) HasMorePages added in v0.30.0 

func (p *SearchAnalysesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*SearchAnalysesPaginator) NextPage added in v0.30.0 

func (p *SearchAnalysesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchAnalysesOutput, error)

NextPage retrieves the next SearchAnalyses page.

type SearchAnalysesPaginatorOptions added in v0.30.0 

type SearchAnalysesPaginatorOptions struct {
	// The maximum number of results to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

SearchAnalysesPaginatorOptions is the paginator options for SearchAnalyses

type SearchDashboardsAPIClient added in v0.30.0 

type SearchDashboardsAPIClient interface {
	SearchDashboards(context.Context, *SearchDashboardsInput, ...func(*Options)) (*SearchDashboardsOutput, error)
}

SearchDashboardsAPIClient is a client that implements the SearchDashboards operation.

type SearchDashboardsInput 

type SearchDashboardsInput struct {

	// The ID of the Amazon Web Services account that contains the user whose
	// dashboards you're searching for.
	//
	// This member is required.
	AwsAccountId *string

	// The filters to apply to the search. Currently, you can search only by user name,
	// for example, "Filters": [ { "Name": "QUICKSIGHT_USER", "Operator":
	// "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1"
	// } ]
	//
	// This member is required.
	Filters []types.DashboardSearchFilter

	// The maximum number of results to be returned per request.
	MaxResults int32

	// The token for the next set of results, or null if there are no more results.
	NextToken *string
	// contains filtered or unexported fields
}

type SearchDashboardsOutput 

type SearchDashboardsOutput struct {

	// The list of dashboards owned by the user specified in Filters in your request.
	DashboardSummaryList []types.DashboardSummary

	// The token for the next set of results, or null if there are no more results.
	NextToken *string

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type SearchDashboardsPaginator added in v0.30.0 

type SearchDashboardsPaginator struct {
	// contains filtered or unexported fields
}

SearchDashboardsPaginator is a paginator for SearchDashboards

func NewSearchDashboardsPaginator added in v0.30.0 

func NewSearchDashboardsPaginator(client SearchDashboardsAPIClient, params *SearchDashboardsInput, optFns ...func(*SearchDashboardsPaginatorOptions)) *SearchDashboardsPaginator

NewSearchDashboardsPaginator returns a new SearchDashboardsPaginator

func (*SearchDashboardsPaginator) HasMorePages added in v0.30.0 

func (p *SearchDashboardsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*SearchDashboardsPaginator) NextPage added in v0.30.0 

func (p *SearchDashboardsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchDashboardsOutput, error)

NextPage retrieves the next SearchDashboards page.

type SearchDashboardsPaginatorOptions added in v0.30.0 

type SearchDashboardsPaginatorOptions struct {
	// The maximum number of results to be returned per request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

SearchDashboardsPaginatorOptions is the paginator options for SearchDashboards

type SearchFoldersInput added in v1.6.0 

type SearchFoldersInput struct {

	// The ID for the Amazon Web Services account that contains the folder.
	//
	// This member is required.
	AwsAccountId *string

	// The filters to apply to the search. Currently, you can search only by the parent
	// folder ARN. For example, "Filters": [ { "Name": "PARENT_FOLDER_ARN", "Operator":
	// "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:folder/folderId" } ].
	//
	// This member is required.
	Filters []types.FolderSearchFilter

	// The maximum number of results to be returned per request.
	MaxResults int32

	// The token for the next set of results, or null if there are no more results.
	NextToken *string
	// contains filtered or unexported fields
}

type SearchFoldersOutput added in v1.6.0 

type SearchFoldersOutput struct {

	// A structure that contains all of the folders in the Amazon Web Services account.
	// This structure provides basic information about the folders.
	FolderSummaryList []types.FolderSummary

	// The token for the next set of results, or null if there are no more results.
	NextToken *string

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type TagResourceInput 

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource that you want to tag.
	//
	// This member is required.
	ResourceArn *string

	// Contains a map of the key-value pairs for the resource tag or tags assigned to
	// the resource.
	//
	// This member is required.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type TagResourceOutput 

type TagResourceOutput struct {

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UntagResourceInput 

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource that you want to untag.
	//
	// This member is required.
	ResourceArn *string

	// The keys of the key-value pairs for the resource tag or tags assigned to the
	// resource.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput 

type UntagResourceOutput struct {

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateAccountCustomizationInput 

type UpdateAccountCustomizationInput struct {

	// The Amazon QuickSight customizations you're updating in the current Amazon Web
	// Services Region.
	//
	// This member is required.
	AccountCustomization *types.AccountCustomization

	// The ID for the Amazon Web Services account that you want to update Amazon
	// QuickSight customizations for.
	//
	// This member is required.
	AwsAccountId *string

	// The namespace that you want to update Amazon QuickSight customizations for.
	Namespace *string
	// contains filtered or unexported fields
}

type UpdateAccountCustomizationOutput 

type UpdateAccountCustomizationOutput struct {

	// The Amazon QuickSight customizations you're updating in the current Amazon Web
	// Services Region.
	AccountCustomization *types.AccountCustomization

	// The Amazon Resource Name (ARN) for the updated customization for this Amazon Web
	// Services account.
	Arn *string

	// The ID for the Amazon Web Services account that you want to update Amazon
	// QuickSight customizations for.
	AwsAccountId *string

	// The namespace associated with the customization that you're updating.
	Namespace *string

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateAccountSettingsInput 

type UpdateAccountSettingsInput struct {

	// The ID for the Amazon Web Services account that contains the Amazon QuickSight
	// settings that you want to list.
	//
	// This member is required.
	AwsAccountId *string

	// The default namespace for this Amazon Web Services account. Currently, the
	// default is default. Identity and Access Management (IAM) users that register for
	// the first time with Amazon QuickSight provide an email that becomes associated
	// with the default namespace.
	//
	// This member is required.
	DefaultNamespace *string

	// The email address that you want Amazon QuickSight to send notifications to
	// regarding your Amazon Web Services account or Amazon QuickSight subscription.
	NotificationEmail *string
	// contains filtered or unexported fields
}

type UpdateAccountSettingsOutput 

type UpdateAccountSettingsOutput struct {

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateAnalysisInput added in v0.29.0 

type UpdateAnalysisInput struct {

	// The ID for the analysis that you're updating. This ID displays in the URL of the
	// analysis.
	//
	// This member is required.
	AnalysisId *string

	// The ID of the Amazon Web Services account that contains the analysis that you're
	// updating.
	//
	// This member is required.
	AwsAccountId *string

	// A descriptive name for the analysis that you're updating. This name displays for
	// the analysis in the Amazon QuickSight console.
	//
	// This member is required.
	Name *string

	// A source entity to use for the analysis that you're updating. This metadata
	// structure contains details that describe a source template and one or more
	// datasets.
	//
	// This member is required.
	SourceEntity *types.AnalysisSourceEntity

	// The parameter names and override values that you want to use. An analysis can
	// have any parameter type, and some parameters might accept multiple values.
	Parameters *types.Parameters

	// The Amazon Resource Name (ARN) for the theme to apply to the analysis that
	// you're creating. To see the theme in the Amazon QuickSight console, make sure
	// that you have access to it.
	ThemeArn *string
	// contains filtered or unexported fields
}

type UpdateAnalysisOutput added in v0.29.0 

type UpdateAnalysisOutput struct {

	// The ID of the analysis.
	AnalysisId *string

	// The ARN of the analysis that you're updating.
	Arn *string

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// The update status of the last update that was made to the analysis.
	UpdateStatus types.ResourceStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateAnalysisPermissionsInput added in v0.29.0 

type UpdateAnalysisPermissionsInput struct {

	// The ID of the analysis whose permissions you're updating. The ID is part of the
	// analysis URL.
	//
	// This member is required.
	AnalysisId *string

	// The ID of the Amazon Web Services account that contains the analysis whose
	// permissions you're updating. You must be using the Amazon Web Services account
	// that the analysis is in.
	//
	// This member is required.
	AwsAccountId *string

	// A structure that describes the permissions to add and the principal to add them
	// to.
	GrantPermissions []types.ResourcePermission

	// A structure that describes the permissions to remove and the principal to remove
	// them from.
	RevokePermissions []types.ResourcePermission
	// contains filtered or unexported fields
}

type UpdateAnalysisPermissionsOutput added in v0.29.0 

type UpdateAnalysisPermissionsOutput struct {

	// The Amazon Resource Name (ARN) of the analysis that you updated.
	AnalysisArn *string

	// The ID of the analysis that you updated permissions for.
	AnalysisId *string

	// A structure that describes the principals and the resource-level permissions on
	// an analysis.
	Permissions []types.ResourcePermission

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateDashboardInput 

type UpdateDashboardInput struct {

	// The ID of the Amazon Web Services account that contains the dashboard that
	// you're updating.
	//
	// This member is required.
	AwsAccountId *string

	// The ID for the dashboard.
	//
	// This member is required.
	DashboardId *string

	// The display name of the dashboard.
	//
	// This member is required.
	Name *string

	// The entity that you are using as a source when you update the dashboard. In
	// SourceEntity, you specify the type of object you're using as source. You can
	// only update a dashboard from a template, so you use a SourceTemplate entity. If
	// you need to update a dashboard from an analysis, first convert the analysis to a
	// template by using the CreateTemplate
	// (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CreateTemplate.html)
	// API operation. For SourceTemplate, specify the Amazon Resource Name (ARN) of the
	// source template. The SourceTemplate ARN can contain any Amazon Web Services
	// account and any Amazon QuickSight-supported Amazon Web Services Region. Use the
	// DataSetReferences entity within SourceTemplate to list the replacement datasets
	// for the placeholders listed in the original. The schema in each dataset must
	// match its placeholder.
	//
	// This member is required.
	SourceEntity *types.DashboardSourceEntity

	// Options for publishing the dashboard when you create it:
	//
	// * AvailabilityStatus
	// for AdHocFilteringOption - This status can be either ENABLED or DISABLED. When
	// this is set to DISABLED, Amazon QuickSight disables the left filter pane on the
	// published dashboard, which can be used for ad hoc (one-time) filtering. This
	// option is ENABLED by default.
	//
	// * AvailabilityStatus for ExportToCSVOption - This
	// status can be either ENABLED or DISABLED. The visual option to export data to
	// .CSV format isn't enabled when this is set to DISABLED. This option is ENABLED
	// by default.
	//
	// * VisibilityState for SheetControlsOption - This visibility state
	// can be either COLLAPSED or EXPANDED. This option is COLLAPSED by default.
	DashboardPublishOptions *types.DashboardPublishOptions

	// A structure that contains the parameters of the dashboard. These are parameter
	// overrides for a dashboard. A dashboard can have any type of parameters, and some
	// parameters might accept multiple values.
	Parameters *types.Parameters

	// The Amazon Resource Name (ARN) of the theme that is being used for this
	// dashboard. If you add a value for this field, it overrides the value that was
	// originally associated with the entity. The theme ARN must exist in the same
	// Amazon Web Services account where you create the dashboard.
	ThemeArn *string

	// A description for the first version of the dashboard being created.
	VersionDescription *string
	// contains filtered or unexported fields
}

type UpdateDashboardOutput 

type UpdateDashboardOutput struct {

	// The Amazon Resource Name (ARN) of the resource.
	Arn *string

	// The creation status of the request.
	CreationStatus types.ResourceStatus

	// The ID for the dashboard.
	DashboardId *string

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// The ARN of the dashboard, including the version number.
	VersionArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateDashboardPermissionsInput 

type UpdateDashboardPermissionsInput struct {

	// The ID of the Amazon Web Services account that contains the dashboard whose
	// permissions you're updating.
	//
	// This member is required.
	AwsAccountId *string

	// The ID for the dashboard.
	//
	// This member is required.
	DashboardId *string

	// Grants link permissions to all users in a defined namespace.
	GrantLinkPermissions []types.ResourcePermission

	// The permissions that you want to grant on this resource.
	GrantPermissions []types.ResourcePermission

	// Revokes link permissions from all users in a defined namespace.
	RevokeLinkPermissions []types.ResourcePermission

	// The permissions that you want to revoke from this resource.
	RevokePermissions []types.ResourcePermission
	// contains filtered or unexported fields
}

type UpdateDashboardPermissionsOutput 

type UpdateDashboardPermissionsOutput struct {

	// The Amazon Resource Name (ARN) of the dashboard.
	DashboardArn *string

	// The ID for the dashboard.
	DashboardId *string

	// Updates the permissions of a shared link to an Amazon QuickSight dashboard.
	LinkSharingConfiguration *types.LinkSharingConfiguration

	// Information about the permissions on the dashboard.
	Permissions []types.ResourcePermission

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateDashboardPublishedVersionInput 

type UpdateDashboardPublishedVersionInput struct {

	// The ID of the Amazon Web Services account that contains the dashboard that
	// you're updating.
	//
	// This member is required.
	AwsAccountId *string

	// The ID for the dashboard.
	//
	// This member is required.
	DashboardId *string

	// The version number of the dashboard.
	//
	// This member is required.
	VersionNumber *int64
	// contains filtered or unexported fields
}

type UpdateDashboardPublishedVersionOutput 

type UpdateDashboardPublishedVersionOutput struct {

	// The Amazon Resource Name (ARN) of the dashboard.
	DashboardArn *string

	// The ID for the dashboard.
	DashboardId *string

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateDataSetInput 

type UpdateDataSetInput struct {

	// The Amazon Web Services account ID.
	//
	// This member is required.
	AwsAccountId *string

	// The ID for the dataset that you want to update. This ID is unique per Amazon Web
	// Services Region for each Amazon Web Services account.
	//
	// This member is required.
	DataSetId *string

	// Indicates whether you want to import the data into SPICE.
	//
	// This member is required.
	ImportMode types.DataSetImportMode

	// The display name for the dataset.
	//
	// This member is required.
	Name *string

	// Declares the physical tables that are available in the underlying data sources.
	//
	// This member is required.
	PhysicalTableMap map[string]types.PhysicalTable

	// Groupings of columns that work together in certain Amazon QuickSight features.
	// Currently, only geospatial hierarchy is supported.
	ColumnGroups []types.ColumnGroup

	// A set of one or more definitions of a ColumnLevelPermissionRule
	// (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_ColumnLevelPermissionRule.html).
	ColumnLevelPermissionRules []types.ColumnLevelPermissionRule

	// The usage configuration to apply to child datasets that reference this dataset
	// as a source.
	DataSetUsageConfiguration *types.DataSetUsageConfiguration

	// The folder that contains fields and nested subfolders for your dataset.
	FieldFolders map[string]types.FieldFolder

	// Configures the combination and transformation of the data from the physical
	// tables.
	LogicalTableMap map[string]types.LogicalTable

	// The row-level security configuration for the data you want to create.
	RowLevelPermissionDataSet *types.RowLevelPermissionDataSet

	// The configuration of tags on a dataset to set row-level security. Row-level
	// security tags are currently supported for anonymous embedding only.
	RowLevelPermissionTagConfiguration *types.RowLevelPermissionTagConfiguration
	// contains filtered or unexported fields
}

type UpdateDataSetOutput 

type UpdateDataSetOutput struct {

	// The Amazon Resource Name (ARN) of the dataset.
	Arn *string

	// The ID for the dataset that you want to create. This ID is unique per Amazon Web
	// Services Region for each Amazon Web Services account.
	DataSetId *string

	// The ARN for the ingestion, which is triggered as a result of dataset creation if
	// the import mode is SPICE.
	IngestionArn *string

	// The ID of the ingestion, which is triggered as a result of dataset creation if
	// the import mode is SPICE.
	IngestionId *string

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateDataSetPermissionsInput 

type UpdateDataSetPermissionsInput struct {

	// The Amazon Web Services account ID.
	//
	// This member is required.
	AwsAccountId *string

	// The ID for the dataset whose permissions you want to update. This ID is unique
	// per Amazon Web Services Region for each Amazon Web Services account.
	//
	// This member is required.
	DataSetId *string

	// The resource permissions that you want to grant to the dataset.
	GrantPermissions []types.ResourcePermission

	// The resource permissions that you want to revoke from the dataset.
	RevokePermissions []types.ResourcePermission
	// contains filtered or unexported fields
}

type UpdateDataSetPermissionsOutput 

type UpdateDataSetPermissionsOutput struct {

	// The Amazon Resource Name (ARN) of the dataset.
	DataSetArn *string

	// The ID for the dataset whose permissions you want to update. This ID is unique
	// per Amazon Web Services Region for each Amazon Web Services account.
	DataSetId *string

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateDataSourceInput 

type UpdateDataSourceInput struct {

	// The Amazon Web Services account ID.
	//
	// This member is required.
	AwsAccountId *string

	// The ID of the data source. This ID is unique per Amazon Web Services Region for
	// each Amazon Web Services account.
	//
	// This member is required.
	DataSourceId *string

	// A display name for the data source.
	//
	// This member is required.
	Name *string

	// The credentials that Amazon QuickSight that uses to connect to your underlying
	// source. Currently, only credentials based on user name and password are
	// supported.
	Credentials *types.DataSourceCredentials

	// The parameters that Amazon QuickSight uses to connect to your underlying source.
	DataSourceParameters types.DataSourceParameters

	// Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects
	// to your underlying source.
	SslProperties *types.SslProperties

	// Use this parameter only when you want Amazon QuickSight to use a VPC connection
	// when connecting to your underlying source.
	VpcConnectionProperties *types.VpcConnectionProperties
	// contains filtered or unexported fields
}

type UpdateDataSourceOutput 

type UpdateDataSourceOutput struct {

	// The Amazon Resource Name (ARN) of the data source.
	Arn *string

	// The ID of the data source. This ID is unique per Amazon Web Services Region for
	// each Amazon Web Services account.
	DataSourceId *string

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// The update status of the data source's last update.
	UpdateStatus types.ResourceStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateDataSourcePermissionsInput 

type UpdateDataSourcePermissionsInput struct {

	// The Amazon Web Services account ID.
	//
	// This member is required.
	AwsAccountId *string

	// The ID of the data source. This ID is unique per Amazon Web Services Region for
	// each Amazon Web Services account.
	//
	// This member is required.
	DataSourceId *string

	// A list of resource permissions that you want to grant on the data source.
	GrantPermissions []types.ResourcePermission

	// A list of resource permissions that you want to revoke on the data source.
	RevokePermissions []types.ResourcePermission
	// contains filtered or unexported fields
}

type UpdateDataSourcePermissionsOutput 

type UpdateDataSourcePermissionsOutput struct {

	// The Amazon Resource Name (ARN) of the data source.
	DataSourceArn *string

	// The ID of the data source. This ID is unique per Amazon Web Services Region for
	// each Amazon Web Services account.
	DataSourceId *string

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateFolderInput added in v1.6.0 

type UpdateFolderInput struct {

	// The ID for the Amazon Web Services account that contains the folder to update.
	//
	// This member is required.
	AwsAccountId *string

	// The ID of the folder.
	//
	// This member is required.
	FolderId *string

	// The name of the folder.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

type UpdateFolderOutput added in v1.6.0 

type UpdateFolderOutput struct {

	// The Amazon Resource Name (ARN) of the folder.
	Arn *string

	// The ID of the folder.
	FolderId *string

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateFolderPermissionsInput added in v1.6.0 

type UpdateFolderPermissionsInput struct {

	// The ID for the Amazon Web Services account that contains the folder to update.
	//
	// This member is required.
	AwsAccountId *string

	// The ID of the folder.
	//
	// This member is required.
	FolderId *string

	// The permissions that you want to grant on a resource.
	GrantPermissions []types.ResourcePermission

	// The permissions that you want to revoke from a resource.
	RevokePermissions []types.ResourcePermission
	// contains filtered or unexported fields
}

type UpdateFolderPermissionsOutput added in v1.6.0 

type UpdateFolderPermissionsOutput struct {

	// The Amazon Resource Name (ARN) of the folder.
	Arn *string

	// The ID of the folder.
	FolderId *string

	// Information about the permissions for the folder.
	Permissions []types.ResourcePermission

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateGroupInput 

type UpdateGroupInput struct {

	// The ID for the Amazon Web Services account that the group is in. Currently, you
	// use the ID for the Amazon Web Services account that contains your Amazon
	// QuickSight account.
	//
	// This member is required.
	AwsAccountId *string

	// The name of the group that you want to update.
	//
	// This member is required.
	GroupName *string

	// The namespace. Currently, you should set this to default.
	//
	// This member is required.
	Namespace *string

	// The description for the group that you want to update.
	Description *string
	// contains filtered or unexported fields
}

type UpdateGroupOutput 

type UpdateGroupOutput struct {

	// The name of the group.
	Group *types.Group

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateIAMPolicyAssignmentInput 

type UpdateIAMPolicyAssignmentInput struct {

	// The name of the assignment, also called a rule. This name must be unique within
	// an Amazon Web Services account.
	//
	// This member is required.
	AssignmentName *string

	// The ID of the Amazon Web Services account that contains the IAM policy
	// assignment.
	//
	// This member is required.
	AwsAccountId *string

	// The namespace of the assignment.
	//
	// This member is required.
	Namespace *string

	// The status of the assignment. Possible values are as follows:
	//
	// * ENABLED -
	// Anything specified in this assignment is used when creating the data source.
	//
	// *
	// DISABLED - This assignment isn't used when creating the data source.
	//
	// * DRAFT -
	// This assignment is an unfinished draft and isn't used when creating the data
	// source.
	AssignmentStatus types.AssignmentStatus

	// The Amazon QuickSight users, groups, or both that you want to assign the policy
	// to.
	Identities map[string][]string

	// The ARN for the IAM policy to apply to the Amazon QuickSight users and groups
	// specified in this assignment.
	PolicyArn *string
	// contains filtered or unexported fields
}

type UpdateIAMPolicyAssignmentOutput 

type UpdateIAMPolicyAssignmentOutput struct {

	// The ID of the assignment.
	AssignmentId *string

	// The name of the assignment or rule.
	AssignmentName *string

	// The status of the assignment. Possible values are as follows:
	//
	// * ENABLED -
	// Anything specified in this assignment is used when creating the data source.
	//
	// *
	// DISABLED - This assignment isn't used when creating the data source.
	//
	// * DRAFT -
	// This assignment is an unfinished draft and isn't used when creating the data
	// source.
	AssignmentStatus types.AssignmentStatus

	// The Amazon QuickSight users, groups, or both that the IAM policy is assigned to.
	Identities map[string][]string

	// The ARN for the IAM policy applied to the Amazon QuickSight users and groups
	// specified in this assignment.
	PolicyArn *string

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateIpRestrictionInput added in v1.13.0 

type UpdateIpRestrictionInput struct {

	// The ID of the Amazon Web Services account that contains the IP rules.
	//
	// This member is required.
	AwsAccountId *string

	// A value that specifies whether IP rules are turned on.
	Enabled *bool

	// A map that describes the updated IP rules with CIDR ranges and descriptions.
	IpRestrictionRuleMap map[string]string
	// contains filtered or unexported fields
}

type UpdateIpRestrictionOutput added in v1.13.0 

type UpdateIpRestrictionOutput struct {

	// The ID of the Amazon Web Services account that contains the IP rules.
	AwsAccountId *string

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateTemplateAliasInput 

type UpdateTemplateAliasInput struct {

	// The alias of the template that you want to update. If you name a specific alias,
	// you update the version that the alias points to. You can specify the latest
	// version of the template by providing the keyword $LATEST in the AliasName
	// parameter. The keyword $PUBLISHED doesn't apply to templates.
	//
	// This member is required.
	AliasName *string

	// The ID of the Amazon Web Services account that contains the template alias that
	// you're updating.
	//
	// This member is required.
	AwsAccountId *string

	// The ID for the template.
	//
	// This member is required.
	TemplateId *string

	// The version number of the template.
	//
	// This member is required.
	TemplateVersionNumber *int64
	// contains filtered or unexported fields
}

type UpdateTemplateAliasOutput 

type UpdateTemplateAliasOutput struct {

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// The template alias.
	TemplateAlias *types.TemplateAlias

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateTemplateInput 

type UpdateTemplateInput struct {

	// The ID of the Amazon Web Services account that contains the template that you're
	// updating.
	//
	// This member is required.
	AwsAccountId *string

	// The entity that you are using as a source when you update the template. In
	// SourceEntity, you specify the type of object you're using as source:
	// SourceTemplate for a template or SourceAnalysis for an analysis. Both of these
	// require an Amazon Resource Name (ARN). For SourceTemplate, specify the ARN of
	// the source template. For SourceAnalysis, specify the ARN of the source analysis.
	// The SourceTemplate ARN can contain any Amazon Web Services account and any
	// Amazon QuickSight-supported Amazon Web Services Region;. Use the
	// DataSetReferences entity within SourceTemplate or SourceAnalysis to list the
	// replacement datasets for the placeholders listed in the original. The schema in
	// each dataset must match its placeholder.
	//
	// This member is required.
	SourceEntity *types.TemplateSourceEntity

	// The ID for the template.
	//
	// This member is required.
	TemplateId *string

	// The name for the template.
	Name *string

	// A description of the current template version that is being updated. Every time
	// you call UpdateTemplate, you create a new version of the template. Each version
	// of the template maintains a description of the version in the VersionDescription
	// field.
	VersionDescription *string
	// contains filtered or unexported fields
}

type UpdateTemplateOutput 

type UpdateTemplateOutput struct {

	// The Amazon Resource Name (ARN) for the template.
	Arn *string

	// The creation status of the template.
	CreationStatus types.ResourceStatus

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// The ID for the template.
	TemplateId *string

	// The ARN for the template, including the version information of the first
	// version.
	VersionArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateTemplatePermissionsInput 

type UpdateTemplatePermissionsInput struct {

	// The ID of the Amazon Web Services account that contains the template.
	//
	// This member is required.
	AwsAccountId *string

	// The ID for the template.
	//
	// This member is required.
	TemplateId *string

	// A list of resource permissions to be granted on the template.
	GrantPermissions []types.ResourcePermission

	// A list of resource permissions to be revoked from the template.
	RevokePermissions []types.ResourcePermission
	// contains filtered or unexported fields
}

type UpdateTemplatePermissionsOutput 

type UpdateTemplatePermissionsOutput struct {

	// A list of resource permissions to be set on the template.
	Permissions []types.ResourcePermission

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// The Amazon Resource Name (ARN) of the template.
	TemplateArn *string

	// The ID for the template.
	TemplateId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateThemeAliasInput 

type UpdateThemeAliasInput struct {

	// The name of the theme alias that you want to update.
	//
	// This member is required.
	AliasName *string

	// The ID of the Amazon Web Services account that contains the theme alias that
	// you're updating.
	//
	// This member is required.
	AwsAccountId *string

	// The ID for the theme.
	//
	// This member is required.
	ThemeId *string

	// The version number of the theme that the alias should reference.
	//
	// This member is required.
	ThemeVersionNumber *int64
	// contains filtered or unexported fields
}

type UpdateThemeAliasOutput 

type UpdateThemeAliasOutput struct {

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// Information about the theme alias.
	ThemeAlias *types.ThemeAlias

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateThemeInput 

type UpdateThemeInput struct {

	// The ID of the Amazon Web Services account that contains the theme that you're
	// updating.
	//
	// This member is required.
	AwsAccountId *string

	// The theme ID, defined by Amazon QuickSight, that a custom theme inherits from.
	// All themes initially inherit from a default Amazon QuickSight theme.
	//
	// This member is required.
	BaseThemeId *string

	// The ID for the theme.
	//
	// This member is required.
	ThemeId *string

	// The theme configuration, which contains the theme display properties.
	Configuration *types.ThemeConfiguration

	// The name for the theme.
	Name *string

	// A description of the theme version that you're updating Every time that you call
	// UpdateTheme, you create a new version of the theme. Each version of the theme
	// maintains a description of the version in VersionDescription.
	VersionDescription *string
	// contains filtered or unexported fields
}

type UpdateThemeOutput 

type UpdateThemeOutput struct {

	// The Amazon Resource Name (ARN) for the theme.
	Arn *string

	// The creation status of the theme.
	CreationStatus types.ResourceStatus

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// The ID for the theme.
	ThemeId *string

	// The Amazon Resource Name (ARN) for the new version of the theme.
	VersionArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateThemePermissionsInput 

type UpdateThemePermissionsInput struct {

	// The ID of the Amazon Web Services account that contains the theme.
	//
	// This member is required.
	AwsAccountId *string

	// The ID for the theme.
	//
	// This member is required.
	ThemeId *string

	// A list of resource permissions to be granted for the theme.
	GrantPermissions []types.ResourcePermission

	// A list of resource permissions to be revoked from the theme.
	RevokePermissions []types.ResourcePermission
	// contains filtered or unexported fields
}

type UpdateThemePermissionsOutput 

type UpdateThemePermissionsOutput struct {

	// The resulting list of resource permissions for the theme.
	Permissions []types.ResourcePermission

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// The Amazon Resource Name (ARN) of the theme.
	ThemeArn *string

	// The ID for the theme.
	ThemeId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateUserInput 

type UpdateUserInput struct {

	// The ID for the Amazon Web Services account that the user is in. Currently, you
	// use the ID for the Amazon Web Services account that contains your Amazon
	// QuickSight account.
	//
	// This member is required.
	AwsAccountId *string

	// The email address of the user that you want to update.
	//
	// This member is required.
	Email *string

	// The namespace. Currently, you should set this to default.
	//
	// This member is required.
	Namespace *string

	// The Amazon QuickSight role of the user. The role can be one of the following
	// default security cohorts:
	//
	// * READER: A user who has read-only access to
	// dashboards.
	//
	// * AUTHOR: A user who can create data sources, datasets, analyses,
	// and dashboards.
	//
	// * ADMIN: A user who is an author, who can also manage Amazon
	// QuickSight settings.
	//
	// The name of the Amazon QuickSight role is invisible to the
	// user except for the console screens dealing with permissions.
	//
	// This member is required.
	Role types.UserRole

	// The Amazon QuickSight user name that you want to update.
	//
	// This member is required.
	UserName *string

	// The URL of the custom OpenID Connect (OIDC) provider that provides identity to
	// let a user federate into Amazon QuickSight with an associated Identity and
	// Access Management(IAM) role. This parameter should only be used when
	// ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC.
	CustomFederationProviderUrl *string

	// (Enterprise edition only) The name of the custom permissions profile that you
	// want to assign to this user. Customized permissions allows you to control a
	// user's access by restricting access the following operations:
	//
	// * Create and
	// update data sources
	//
	// * Create and update datasets
	//
	// * Create and update email
	// reports
	//
	// * Subscribe to email reports
	//
	// A set of custom permissions includes any
	// combination of these restrictions. Currently, you need to create the profile
	// names for custom permission sets by using the Amazon QuickSight console. Then,
	// you use the RegisterUser API operation to assign the named set of permissions to
	// a QuickSight user. Amazon QuickSight custom permissions are applied through IAM
	// policies. Therefore, they override the permissions typically granted by
	// assigning Amazon QuickSight users to one of the default security cohorts in
	// Amazon QuickSight (admin, author, reader). This feature is available only to
	// Amazon QuickSight Enterprise edition subscriptions.
	CustomPermissionsName *string

	// The type of supported external login provider that provides identity to let a
	// user federate into Amazon QuickSight with an associated Identity and Access
	// Management(IAM) role. The type of supported external login provider can be one
	// of the following.
	//
	// * COGNITO: Amazon Cognito. The provider URL is
	// cognito-identity.amazonaws.com. When choosing the COGNITO provider type, don’t
	// use the "CustomFederationProviderUrl" parameter which is only needed when the
	// external provider is custom.
	//
	// * CUSTOM_OIDC: Custom OpenID Connect (OIDC)
	// provider. When choosing CUSTOM_OIDC type, use the CustomFederationProviderUrl
	// parameter to provide the custom OIDC provider URL.
	//
	// * NONE: This clears all the
	// previously saved external login information for a user. Use the DescribeUser
	// (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeUser.html)
	// API operation to check the external login information.
	ExternalLoginFederationProviderType *string

	// The identity ID for a user in the external login provider.
	ExternalLoginId *string

	// A flag that you use to indicate that you want to remove all custom permissions
	// from this user. Using this parameter resets the user to the state it was in
	// before a custom permissions profile was applied. This parameter defaults to NULL
	// and it doesn't accept any other value.
	UnapplyCustomPermissions bool
	// contains filtered or unexported fields
}

type UpdateUserOutput 

type UpdateUserOutput struct {

	// The Amazon Web Services request ID for this operation.
	RequestId *string

	// The HTTP status of the request.
	Status int32

	// The Amazon QuickSight user.
	User *types.User

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.