quicksight

package module
v1.79.1 Latest Latest
Warning

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

 Go to latest Published: Nov 18, 2024 License: Apache-2.0 Imports: 43 Imported by: 28

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 deprecated 

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.

To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 added in v1.40.0 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName added in v1.50.2 

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion added in v1.50.2 

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

Types

type AuthResolverParameters added in v1.50.2 

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver added in v1.50.2 

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

type BatchCreateTopicReviewedAnswerInput added in v1.68.0 

type BatchCreateTopicReviewedAnswerInput struct {

	// The definition of the Answers to be created.
	//
	// This member is required.
	Answers []types.CreateTopicReviewedAnswer

	// The ID of the Amazon Web Services account that you want to create a reviewed
	// answer in.
	//
	// This member is required.
	AwsAccountId *string

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

type BatchCreateTopicReviewedAnswerOutput added in v1.68.0 

type BatchCreateTopicReviewedAnswerOutput struct {

	// The definition of Answers that are invalid and not created.
	InvalidAnswers []types.InvalidTopicReviewedAnswer

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

	// The HTTP status of the request.
	Status int32

	// The definition of Answers that are successfully created.
	SucceededAnswers []types.SucceededTopicReviewedAnswer

	// The Amazon Resource Name (ARN) of the topic.
	TopicArn *string

	// The ID for the topic reviewed answer that you want to create. This ID is unique
	// per Amazon Web Services Region for each Amazon Web Services account.
	TopicId *string

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

type BatchDeleteTopicReviewedAnswerInput added in v1.68.0 

type BatchDeleteTopicReviewedAnswerInput struct {

	// The ID of the Amazon Web Services account that you want to delete a reviewed
	// answers in.
	//
	// This member is required.
	AwsAccountId *string

	// The ID for the topic reviewed answer that you want to delete. This ID is unique
	// per Amazon Web Services Region for each Amazon Web Services account.
	//
	// This member is required.
	TopicId *string

	// The Answer IDs of the Answers to be deleted.
	AnswerIds []string
	// contains filtered or unexported fields
}

type BatchDeleteTopicReviewedAnswerOutput added in v1.68.0 

type BatchDeleteTopicReviewedAnswerOutput struct {

	// The definition of Answers that are invalid and not deleted.
	InvalidAnswers []types.InvalidTopicReviewedAnswer

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

	// The HTTP status of the request.
	Status int32

	// The definition of Answers that are successfully deleted.
	SucceededAnswers []types.SucceededTopicReviewedAnswer

	// The Amazon Resource Name (ARN) of the topic.
	TopicArn *string

	// The ID of the topic reviewed answer that you want to delete. This ID is unique
	// per Amazon Web Services Region for each Amazon Web Services account.
	TopicId *string

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

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) BatchCreateTopicReviewedAnswer added in v1.68.0 

func (c *Client) BatchCreateTopicReviewedAnswer(ctx context.Context, params *BatchCreateTopicReviewedAnswerInput, optFns ...func(*Options)) (*BatchCreateTopicReviewedAnswerOutput, error)

Creates new reviewed answers for a Q Topic.

func (*Client) BatchDeleteTopicReviewedAnswer added in v1.68.0 

func (c *Client) BatchDeleteTopicReviewedAnswer(ctx context.Context, params *BatchDeleteTopicReviewedAnswerInput, optFns ...func(*Options)) (*BatchDeleteTopicReviewedAnswerOutput, error)

Deletes reviewed answers for Q Topic.

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 for 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 QuickSightin 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 DescribeThemePermissionsAPI operation. To share the theme, grant permissions by using the UpdateThemePermissionsAPI operation.

func (*Client) CreateAccountSubscription added in v1.23.0 

func (c *Client) CreateAccountSubscription(ctx context.Context, params *CreateAccountSubscriptionInput, optFns ...func(*Options)) (*CreateAccountSubscriptionOutput, error)

Creates an Amazon QuickSight account, or subscribes to Amazon QuickSight Q.

The Amazon Web Services Region for the account is derived from what is configured in the CLI or SDK.

Before you use this operation, make sure that you can connect to an existing Amazon Web Services account. If you don't have an Amazon Web Services account, see Sign up for Amazon Web Servicesin the Amazon QuickSight User Guide. The person who signs up for Amazon QuickSight needs to have the correct Identity and Access Management (IAM) permissions. For more information, see IAM Policy Examples for Amazon QuickSightin the Amazon QuickSight User Guide.

If your IAM policy includes both the Subscribe and CreateAccountSubscription actions, make sure that both actions are set to Allow . If either action is set to Deny , the Deny action prevails and your API call fails.

You can't pass an existing IAM role to access other Amazon Web Services services using this API operation. To pass your existing IAM role to Amazon QuickSight, see Passing IAM roles to Amazon QuickSightin the Amazon QuickSight User Guide.

You can't set default resource access on the new account from the Amazon QuickSight API. Instead, add default resource access from the Amazon QuickSight console. For more information about setting default resource access to Amazon Web Services services, see Setting default resource access to Amazon Web Services servicesin the Amazon QuickSight User Guide.

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. Analyses can be created either from a template or from an AnalysisDefinition .

func (*Client) CreateBrand added in v1.79.0 

func (c *Client) CreateBrand(ctx context.Context, params *CreateBrandInput, optFns ...func(*Options)) (*CreateBrandOutput, error)

Creates an Amazon QuickSight brand.

func (*Client) CreateCustomPermissions added in v1.79.0 

func (c *Client) CreateCustomPermissions(ctx context.Context, params *CreateCustomPermissionsInput, optFns ...func(*Options)) (*CreateCustomPermissionsOutput, error)

Creates a custom permissions profile.

func (*Client) CreateDashboard 

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

Creates a dashboard from either a template or directly with a DashboardDefinition . To first create a template, see the CreateTemplate 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)

Use the CreateGroup operation to create a group in Amazon QuickSight. You can create up to 10,000 groups in a namespace. If you want to create more than 10,000 groups in a namespace, contact Amazon Web Services Support.

The permissions resource is arn:aws:quicksight:::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?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) CreateRefreshSchedule added in v1.34.0 

func (c *Client) CreateRefreshSchedule(ctx context.Context, params *CreateRefreshScheduleInput, optFns ...func(*Options)) (*CreateRefreshScheduleOutput, error)

Creates a refresh schedule for a dataset. You can create up to 5 different schedules for a single dataset.

func (*Client) CreateRoleMembership added in v1.51.0 

func (c *Client) CreateRoleMembership(ctx context.Context, params *CreateRoleMembershipInput, optFns ...func(*Options)) (*CreateRoleMembershipOutput, error)

Use CreateRoleMembership to add an existing Amazon QuickSight group to an existing role.

func (*Client) CreateTemplate 

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

Creates a template either from a TemplateDefinition or from an existing Amazon QuickSight analysis or template. You can use the resulting template to create additional dashboards, templates, or analyses.

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 QuickSightin 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) CreateTopic added in v1.35.0 

func (c *Client) CreateTopic(ctx context.Context, params *CreateTopicInput, optFns ...func(*Options)) (*CreateTopicOutput, error)

Creates a new Q topic.

func (*Client) CreateTopicRefreshSchedule added in v1.35.0 

func (c *Client) CreateTopicRefreshSchedule(ctx context.Context, params *CreateTopicRefreshScheduleInput, optFns ...func(*Options)) (*CreateTopicRefreshScheduleOutput, error)

Creates a topic refresh schedule.

func (*Client) CreateVPCConnection added in v1.35.0 

func (c *Client) CreateVPCConnection(ctx context.Context, params *CreateVPCConnectionInput, optFns ...func(*Options)) (*CreateVPCConnectionOutput, error)

Creates a new VPC connection.

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) DeleteAccountSubscription added in v1.27.0 

func (c *Client) DeleteAccountSubscription(ctx context.Context, params *DeleteAccountSubscriptionInput, optFns ...func(*Options)) (*DeleteAccountSubscriptionOutput, error)

Use the DeleteAccountSubscription operation to delete an Amazon QuickSight account. This operation will result in an error message if you have configured your account termination protection settings to True . To change this setting and delete your account, call the UpdateAccountSettings API and set the value of the TerminationProtectionEnabled parameter to False , then make another call to the DeleteAccountSubscription API.

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) DeleteBrand added in v1.79.0 

func (c *Client) DeleteBrand(ctx context.Context, params *DeleteBrandInput, optFns ...func(*Options)) (*DeleteBrandOutput, error)

Deletes an Amazon QuickSight brand.

func (*Client) DeleteBrandAssignment added in v1.79.0 

func (c *Client) DeleteBrandAssignment(ctx context.Context, params *DeleteBrandAssignmentInput, optFns ...func(*Options)) (*DeleteBrandAssignmentOutput, error)

Deletes a brand assignment.

func (*Client) DeleteCustomPermissions added in v1.79.0 

func (c *Client) DeleteCustomPermissions(ctx context.Context, params *DeleteCustomPermissionsInput, optFns ...func(*Options)) (*DeleteCustomPermissionsOutput, error)

Deletes a custom permissions profile.

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) DeleteDataSetRefreshProperties added in v1.34.0 

func (c *Client) DeleteDataSetRefreshProperties(ctx context.Context, params *DeleteDataSetRefreshPropertiesInput, optFns ...func(*Options)) (*DeleteDataSetRefreshPropertiesOutput, error)

Deletes the dataset refresh properties of the 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) DeleteIdentityPropagationConfig added in v1.52.0 

func (c *Client) DeleteIdentityPropagationConfig(ctx context.Context, params *DeleteIdentityPropagationConfigInput, optFns ...func(*Options)) (*DeleteIdentityPropagationConfigOutput, error)

Deletes all access scopes and authorized targets that are associated with a service from the Amazon QuickSight IAM Identity Center application.

This operation is only supported for Amazon QuickSight accounts that use IAM Identity Center.

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) DeleteRefreshSchedule added in v1.34.0 

func (c *Client) DeleteRefreshSchedule(ctx context.Context, params *DeleteRefreshScheduleInput, optFns ...func(*Options)) (*DeleteRefreshScheduleOutput, error)

Deletes a refresh schedule from a dataset.

func (*Client) DeleteRoleCustomPermission added in v1.51.0 

func (c *Client) DeleteRoleCustomPermission(ctx context.Context, params *DeleteRoleCustomPermissionInput, optFns ...func(*Options)) (*DeleteRoleCustomPermissionOutput, error)

Removes custom permissions from the role.

func (*Client) DeleteRoleMembership added in v1.51.0 

func (c *Client) DeleteRoleMembership(ctx context.Context, params *DeleteRoleMembershipInput, optFns ...func(*Options)) (*DeleteRoleMembershipOutput, error)

Removes a group from a role.

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) DeleteTopic added in v1.35.0 

func (c *Client) DeleteTopic(ctx context.Context, params *DeleteTopicInput, optFns ...func(*Options)) (*DeleteTopicOutput, error)

Deletes a topic.

func (*Client) DeleteTopicRefreshSchedule added in v1.35.0 

func (c *Client) DeleteTopicRefreshSchedule(ctx context.Context, params *DeleteTopicRefreshScheduleInput, optFns ...func(*Options)) (*DeleteTopicRefreshScheduleOutput, error)

Deletes a topic refresh schedule.

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 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) DeleteUserCustomPermission added in v1.79.0 

func (c *Client) DeleteUserCustomPermission(ctx context.Context, params *DeleteUserCustomPermissionInput, optFns ...func(*Options)) (*DeleteUserCustomPermissionOutput, error)

Deletes a custom permissions profile from a user.

func (*Client) DeleteVPCConnection added in v1.35.0 

func (c *Client) DeleteVPCConnection(ctx context.Context, params *DeleteVPCConnectionInput, optFns ...func(*Options)) (*DeleteVPCConnectionOutput, error)

Deletes a VPC connection.

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].

- Use [named profiles].

- 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].

- 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) DescribeAccountSubscription added in v1.23.0 

func (c *Client) DescribeAccountSubscription(ctx context.Context, params *DescribeAccountSubscriptionInput, optFns ...func(*Options)) (*DescribeAccountSubscriptionOutput, error)

Use the DescribeAccountSubscription operation to receive a description of an Amazon QuickSight account's subscription. A successful API call returns an AccountInfo object that includes an account's name, subscription status, authentication type, edition, and notification email address.

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) DescribeAnalysisDefinition added in v1.28.0 

func (c *Client) DescribeAnalysisDefinition(ctx context.Context, params *DescribeAnalysisDefinitionInput, optFns ...func(*Options)) (*DescribeAnalysisDefinitionOutput, error)

Provides a detailed description of the definition of an analysis.

If you do not need to know details about the content of an Analysis, for instance if you are trying to check the status of a recently created or updated Analysis, use the DescribeAnalysisDescribeAnalysis instead.

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) DescribeAssetBundleExportJob added in v1.36.0 

func (c *Client) DescribeAssetBundleExportJob(ctx context.Context, params *DescribeAssetBundleExportJobInput, optFns ...func(*Options)) (*DescribeAssetBundleExportJobOutput, error)

Describes an existing export job.

Poll job descriptions after a job starts to know the status of the job. When a job succeeds, a URL is provided to download the exported assets' data from. Download URLs are valid for five minutes after they are generated. You can call the DescribeAssetBundleExportJob API for a new download URL as needed.

Job descriptions are available for 14 days after the job starts.

func (*Client) DescribeAssetBundleImportJob added in v1.36.0 

func (c *Client) DescribeAssetBundleImportJob(ctx context.Context, params *DescribeAssetBundleImportJobInput, optFns ...func(*Options)) (*DescribeAssetBundleImportJobOutput, error)

Describes an existing import job.

Poll job descriptions after starting a job to know when it has succeeded or failed. Job descriptions are available for 14 days after job starts.

func (*Client) DescribeBrand added in v1.79.0 

func (c *Client) DescribeBrand(ctx context.Context, params *DescribeBrandInput, optFns ...func(*Options)) (*DescribeBrandOutput, error)

Describes a brand.

func (*Client) DescribeBrandAssignment added in v1.79.0 

func (c *Client) DescribeBrandAssignment(ctx context.Context, params *DescribeBrandAssignmentInput, optFns ...func(*Options)) (*DescribeBrandAssignmentOutput, error)

Describes a brand assignment.

func (*Client) DescribeBrandPublishedVersion added in v1.79.0 

func (c *Client) DescribeBrandPublishedVersion(ctx context.Context, params *DescribeBrandPublishedVersionInput, optFns ...func(*Options)) (*DescribeBrandPublishedVersionOutput, error)

Describes the published version of the brand.

func (*Client) DescribeCustomPermissions added in v1.79.0 

func (c *Client) DescribeCustomPermissions(ctx context.Context, params *DescribeCustomPermissionsInput, optFns ...func(*Options)) (*DescribeCustomPermissionsOutput, error)

Describes a custom permissions profile.

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) DescribeDashboardDefinition added in v1.28.0 

func (c *Client) DescribeDashboardDefinition(ctx context.Context, params *DescribeDashboardDefinitionInput, optFns ...func(*Options)) (*DescribeDashboardDefinitionOutput, error)

Provides a detailed description of the definition of a dashboard.

If you do not need to know details about the content of a dashboard, for instance if you are trying to check the status of a recently created or updated dashboard, use the DescribeDashboardDescribeDashboard instead.

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) DescribeDashboardSnapshotJob added in v1.39.0 

func (c *Client) DescribeDashboardSnapshotJob(ctx context.Context, params *DescribeDashboardSnapshotJobInput, optFns ...func(*Options)) (*DescribeDashboardSnapshotJobOutput, error)

Describes an existing snapshot job.

Poll job descriptions after a job starts to know the status of the job. For information on available status codes, see JobStatus .

func (*Client) DescribeDashboardSnapshotJobResult added in v1.39.0 

func (c *Client) DescribeDashboardSnapshotJobResult(ctx context.Context, params *DescribeDashboardSnapshotJobResultInput, optFns ...func(*Options)) (*DescribeDashboardSnapshotJobResultOutput, error)

Describes the result of an existing snapshot job that has finished running.

A finished snapshot job will return a COMPLETED or FAILED status when you poll the job with a DescribeDashboardSnapshotJob API call.

If the job has not finished running, this operation returns a message that says Dashboard Snapshot Job with id has not reached a terminal state. .

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) DescribeDataSetRefreshProperties added in v1.34.0 

func (c *Client) DescribeDataSetRefreshProperties(ctx context.Context, params *DescribeDataSetRefreshPropertiesInput, optFns ...func(*Options)) (*DescribeDataSetRefreshPropertiesOutput, error)

Describes the refresh properties of a dataset.

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) DescribeGroupMembership added in v1.21.0 

func (c *Client) DescribeGroupMembership(ctx context.Context, params *DescribeGroupMembershipInput, optFns ...func(*Options)) (*DescribeGroupMembershipOutput, error)

Use the DescribeGroupMembership operation to determine if a user is a member of the specified group. If the user exists and is a member of the specified group, an associated GroupMember object is returned.

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) DescribeKeyRegistration added in v1.64.0 

func (c *Client) DescribeKeyRegistration(ctx context.Context, params *DescribeKeyRegistrationInput, optFns ...func(*Options)) (*DescribeKeyRegistrationOutput, error)

Describes all customer managed key registrations in a Amazon QuickSight account.

func (*Client) DescribeNamespace 

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

Describes the current namespace.

func (*Client) DescribeQPersonalizationConfiguration added in v1.74.0 

func (c *Client) DescribeQPersonalizationConfiguration(ctx context.Context, params *DescribeQPersonalizationConfigurationInput, optFns ...func(*Options)) (*DescribeQPersonalizationConfigurationOutput, error)

Describes a personalization configuration.

func (*Client) DescribeRefreshSchedule added in v1.34.0 

func (c *Client) DescribeRefreshSchedule(ctx context.Context, params *DescribeRefreshScheduleInput, optFns ...func(*Options)) (*DescribeRefreshScheduleOutput, error)

Provides a summary of a refresh schedule.

func (*Client) DescribeRoleCustomPermission added in v1.51.0 

func (c *Client) DescribeRoleCustomPermission(ctx context.Context, params *DescribeRoleCustomPermissionInput, optFns ...func(*Options)) (*DescribeRoleCustomPermissionOutput, error)

Describes all custom permissions that are mapped to a role.

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) DescribeTemplateDefinition added in v1.28.0 

func (c *Client) DescribeTemplateDefinition(ctx context.Context, params *DescribeTemplateDefinitionInput, optFns ...func(*Options)) (*DescribeTemplateDefinitionOutput, error)

Provides a detailed description of the definition of a template.

If you do not need to know details about the content of a template, for instance if you are trying to check the status of a recently created or updated template, use the DescribeTemplateDescribeTemplate instead.

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) DescribeTopic added in v1.35.0 

func (c *Client) DescribeTopic(ctx context.Context, params *DescribeTopicInput, optFns ...func(*Options)) (*DescribeTopicOutput, error)

Describes a topic.

func (*Client) DescribeTopicPermissions added in v1.35.0 

func (c *Client) DescribeTopicPermissions(ctx context.Context, params *DescribeTopicPermissionsInput, optFns ...func(*Options)) (*DescribeTopicPermissionsOutput, error)

Describes the permissions of a topic.

func (*Client) DescribeTopicRefresh added in v1.35.0 

func (c *Client) DescribeTopicRefresh(ctx context.Context, params *DescribeTopicRefreshInput, optFns ...func(*Options)) (*DescribeTopicRefreshOutput, error)

Describes the status of a topic refresh.

func (*Client) DescribeTopicRefreshSchedule added in v1.35.0 

func (c *Client) DescribeTopicRefreshSchedule(ctx context.Context, params *DescribeTopicRefreshScheduleInput, optFns ...func(*Options)) (*DescribeTopicRefreshScheduleOutput, error)

Deletes a topic refresh schedule.

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) DescribeVPCConnection added in v1.35.0 

func (c *Client) DescribeVPCConnection(ctx context.Context, params *DescribeVPCConnectionInput, optFns ...func(*Options)) (*DescribeVPCConnectionOutput, error)

Describes a VPC connection.

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 or visual 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 SessionLifetimeInMinutesparameter. The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours.

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

For more information, see Embedded Analytics 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.

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 SessionLifetimeInMinutesparameter.

The resulting user session is valid for 15 minutes (minimum) to 10 hours 

(maximum). The default session duration is 10 hours.

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

For more information, see Embedded Analytics 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.

func (*Client) GetDashboardEmbedUrl 

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

Generates a temporary session URL and authorization code(bearer token) that you can use to embed an Amazon QuickSight read-only dashboard in your website or application. 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 generated URL:

  • They must be used together.

  • They can be used one time only.

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

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

  • The resulting user session is valid for 15 minutes (default) up to 10 hours (maximum). You can use the optional SessionLifetimeInMinutes parameter to customize session duration.

For more information, see Embedding Analytics Using GetDashboardEmbedUrl 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.

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 UpdateUserAPI operation. Use RegisterUser 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

Customizing Access to the Amazon QuickSight Console

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) ListAssetBundleExportJobs added in v1.36.0 

func (c *Client) ListAssetBundleExportJobs(ctx context.Context, params *ListAssetBundleExportJobsInput, optFns ...func(*Options)) (*ListAssetBundleExportJobsOutput, error)

Lists all asset bundle export jobs that have been taken place in the last 14 days. Jobs created more than 14 days ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs, ListAssetBundleExportJobs only returns the most recent job that uses the repeated job ID.

func (*Client) ListAssetBundleImportJobs added in v1.36.0 

func (c *Client) ListAssetBundleImportJobs(ctx context.Context, params *ListAssetBundleImportJobsInput, optFns ...func(*Options)) (*ListAssetBundleImportJobsOutput, error)

Lists all asset bundle import jobs that have taken place in the last 14 days. Jobs created more than 14 days ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs, ListAssetBundleImportJobs only returns the most recent job that uses the repeated job ID.

func (*Client) ListBrands added in v1.79.0 

func (c *Client) ListBrands(ctx context.Context, params *ListBrandsInput, optFns ...func(*Options)) (*ListBrandsOutput, error)

Lists all brands in an Amazon QuickSight account.

func (*Client) ListCustomPermissions added in v1.79.0 

func (c *Client) ListCustomPermissions(ctx context.Context, params *ListCustomPermissionsInput, optFns ...func(*Options)) (*ListCustomPermissionsOutput, error)

Returns a list of all the custom permissions profiles.

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) ListFoldersForResource added in v1.72.0 

func (c *Client) ListFoldersForResource(ctx context.Context, params *ListFoldersForResourceInput, optFns ...func(*Options)) (*ListFoldersForResourceOutput, error)

List all folders that a resource is a member of.

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 the 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 of 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) ListIdentityPropagationConfigs added in v1.52.0 

func (c *Client) ListIdentityPropagationConfigs(ctx context.Context, params *ListIdentityPropagationConfigsInput, optFns ...func(*Options)) (*ListIdentityPropagationConfigsOutput, error)

Lists all services and authorized targets that the Amazon QuickSight IAM Identity Center application can access.

This operation is only supported for Amazon QuickSight accounts that use IAM Identity Center.

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. This operation doesn't list deleted namespaces.

func (*Client) ListRefreshSchedules added in v1.34.0 

func (c *Client) ListRefreshSchedules(ctx context.Context, params *ListRefreshSchedulesInput, optFns ...func(*Options)) (*ListRefreshSchedulesOutput, error)

Lists the refresh schedules of a dataset. Each dataset can have up to 5 schedules.

func (*Client) ListRoleMemberships added in v1.51.0 

func (c *Client) ListRoleMemberships(ctx context.Context, params *ListRoleMembershipsInput, optFns ...func(*Options)) (*ListRoleMembershipsOutput, error)

Lists all groups that are associated with a role.

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) ListTopicRefreshSchedules added in v1.35.0 

func (c *Client) ListTopicRefreshSchedules(ctx context.Context, params *ListTopicRefreshSchedulesInput, optFns ...func(*Options)) (*ListTopicRefreshSchedulesOutput, error)

Lists all of the refresh schedules for a topic.

func (*Client) ListTopicReviewedAnswers added in v1.68.0 

func (c *Client) ListTopicReviewedAnswers(ctx context.Context, params *ListTopicReviewedAnswersInput, optFns ...func(*Options)) (*ListTopicReviewedAnswersOutput, error)

Lists all reviewed answers for a Q Topic.

func (*Client) ListTopics added in v1.35.0 

func (c *Client) ListTopics(ctx context.Context, params *ListTopicsInput, optFns ...func(*Options)) (*ListTopicsOutput, error)

Lists all of the topics within an 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) ListVPCConnections added in v1.35.0 

func (c *Client) ListVPCConnections(ctx context.Context, params *ListVPCConnectionsInput, optFns ...func(*Options)) (*ListVPCConnectionsOutput, error)

Lists all of the VPC connections in the current set Amazon Web Services Region of an Amazon Web Services account.

func (*Client) Options added in v1.53.0 

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

func (*Client) PutDataSetRefreshProperties added in v1.34.0 

func (c *Client) PutDataSetRefreshProperties(ctx context.Context, params *PutDataSetRefreshPropertiesInput, optFns ...func(*Options)) (*PutDataSetRefreshPropertiesOutput, error)

Creates or updates the dataset refresh properties for the dataset.

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. When you register a new user from the Amazon QuickSight API, Amazon QuickSight generates a registration URL. The user accesses this registration URL to create their account. Amazon QuickSight doesn't send a registration email to users who are registered from the Amazon QuickSight API. If you want new users to receive a registration email, then add those users in the Amazon QuickSight console. For more information on registering a new user in the Amazon QuickSight console, see Inviting users to access Amazon QuickSight.

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) SearchDataSets added in v1.27.0 

func (c *Client) SearchDataSets(ctx context.Context, params *SearchDataSetsInput, optFns ...func(*Options)) (*SearchDataSetsOutput, error)

Use the SearchDataSets operation to search for datasets that belong to an account.

func (*Client) SearchDataSources added in v1.27.0 

func (c *Client) SearchDataSources(ctx context.Context, params *SearchDataSourcesInput, optFns ...func(*Options)) (*SearchDataSourcesOutput, error)

Use the SearchDataSources operation to search for data sources that belong to an account.

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) SearchGroups added in v1.21.0 

func (c *Client) SearchGroups(ctx context.Context, params *SearchGroupsInput, optFns ...func(*Options)) (*SearchGroupsOutput, error)

Use the SearchGroups operation to search groups in a specified Amazon QuickSight namespace using the supplied filters.

func (*Client) StartAssetBundleExportJob added in v1.36.0 

func (c *Client) StartAssetBundleExportJob(ctx context.Context, params *StartAssetBundleExportJobInput, optFns ...func(*Options)) (*StartAssetBundleExportJobOutput, error)

Starts an Asset Bundle export job.

An Asset Bundle export job exports specified Amazon QuickSight assets. You can also choose to export any asset dependencies in the same job. Export jobs run asynchronously and can be polled with a DescribeAssetBundleExportJob API call. When a job is successfully completed, a download URL that contains the exported assets is returned. The URL is valid for 5 minutes and can be refreshed with a DescribeAssetBundleExportJob API call. Each Amazon QuickSight account can run up to 5 export jobs concurrently.

The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported.

func (*Client) StartAssetBundleImportJob added in v1.36.0 

func (c *Client) StartAssetBundleImportJob(ctx context.Context, params *StartAssetBundleImportJobInput, optFns ...func(*Options)) (*StartAssetBundleImportJobOutput, error)

Starts an Asset Bundle import job.

An Asset Bundle import job imports specified Amazon QuickSight assets into an Amazon QuickSight account. You can also choose to import a naming prefix and specified configuration overrides. The assets that are contained in the bundle file that you provide are used to create or update a new or existing asset in your Amazon QuickSight account. Each Amazon QuickSight account can run up to 5 import jobs concurrently.

The API caller must have the necessary "create" , "describe" , and "update" permissions in their IAM role to access each resource type that is contained in the bundle file before the resources can be imported.

func (*Client) StartDashboardSnapshotJob added in v1.39.0 

func (c *Client) StartDashboardSnapshotJob(ctx context.Context, params *StartDashboardSnapshotJobInput, optFns ...func(*Options)) (*StartDashboardSnapshotJobOutput, error)

Starts an asynchronous job that generates a snapshot of a dashboard's output. You can request one or several of the following format configurations in each API call.

  • 1 Paginated PDF

  • 1 Excel workbook that includes up to 5 table or pivot table visuals

  • 5 CSVs from table or pivot table visuals

The status of a submitted job can be polled with the DescribeDashboardSnapshotJob API. When you call the DescribeDashboardSnapshotJob API, check the JobStatus field in the response. Once the job reaches a COMPLETED or FAILED status, use the DescribeDashboardSnapshotJobResult API to obtain the URLs for the generated files. If the job fails, the DescribeDashboardSnapshotJobResult API returns detailed information about the error that occurred.

StartDashboardSnapshotJob API throttling

Amazon QuickSight utilizes API throttling to create a more consistent user experience within a time span for customers when they call the StartDashboardSnapshotJob . By default, 12 jobs can run simlutaneously in one Amazon Web Services account and users can submit up 10 API requests per second before an account is throttled. If an overwhelming number of API requests are made by the same user in a short period of time, Amazon QuickSight throttles the API calls to maintin an optimal experience and reliability for all Amazon QuickSight users.

Common throttling scenarios

The following list provides information about the most commin throttling scenarios that can occur.

  • A large number of SnapshotExport API jobs are running simultaneously on an Amazon Web Services account. When a new StartDashboardSnapshotJob is created and there are already 12 jobs with the RUNNING status, the new job request fails and returns a LimitExceededException error. Wait for a current job to comlpete before you resubmit the new job.

  • A large number of API requests are submitted on an Amazon Web Services account. When a user makes more than 10 API calls to the Amazon QuickSight API in one second, a ThrottlingException is returned.

If your use case requires a higher throttling limit, contact your account admin or Amazon Web ServicesSupportto explore options to tailor a more optimal expereince for your account.

Best practices to handle throttling

If your use case projects high levels of API traffic, try to reduce the degree of frequency and parallelism of API calls as much as you can to avoid throttling. You can also perform a timing test to calculate an estimate for the total processing time of your projected load that stays within the throttling limits of the Amazon QuickSight APIs. For example, if your projected traffic is 100 snapshot jobs before 12:00 PM per day, start 12 jobs in parallel and measure the amount of time it takes to proccess all 12 jobs. Once you obtain the result, multiply the duration by 9, for example (12 minutes * 9 = 108 minutes) . Use the new result to determine the latest time at which the jobs need to be started to meet your target deadline.

The time that it takes to process a job can be impacted by the following factors:

  • The dataset type (Direct Query or SPICE).

  • The size of the dataset.

  • The complexity of the calculated fields that are used in the dashboard.

  • The number of visuals that are on a sheet.

  • The types of visuals that are on the sheet.

  • The number of formats and snapshots that are requested in the job configuration.

  • The size of the generated snapshots.

func (*Client) StartDashboardSnapshotJobSchedule added in v1.77.0 

func (c *Client) StartDashboardSnapshotJobSchedule(ctx context.Context, params *StartDashboardSnapshotJobScheduleInput, optFns ...func(*Options)) (*StartDashboardSnapshotJobScheduleOutput, error)

Starts an asynchronous job that runs an existing dashboard schedule and sends the dashboard snapshot through email.

Only one job can run simultaneously in a given schedule. Repeated requests are skipped with a 202 HTTP status code.

For more information, see Scheduling and sending Amazon QuickSight reports by email and Configuring email report settings for a Amazon QuickSight dashboard in the Amazon QuickSight User Guide.

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, template, topic, and user.

Tagging for Amazon QuickSight works in a similar way to tagging for other Amazon Web Services services, except for the following:

  • Tags are used to track costs for users in Amazon QuickSight. You can't tag other resources that Amazon QuickSight costs are based on, such as storage capacoty (SPICE), session usage, alert consumption, or reporting units.

  • 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 for the current Amazon Web Services Region. Currently, the only customization that 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) UpdateBrand added in v1.79.0 

func (c *Client) UpdateBrand(ctx context.Context, params *UpdateBrandInput, optFns ...func(*Options)) (*UpdateBrandOutput, error)

Updates a brand.

func (*Client) UpdateBrandAssignment added in v1.79.0 

func (c *Client) UpdateBrandAssignment(ctx context.Context, params *UpdateBrandAssignmentInput, optFns ...func(*Options)) (*UpdateBrandAssignmentOutput, error)

Updates a brand assignment.

func (*Client) UpdateBrandPublishedVersion added in v1.79.0 

func (c *Client) UpdateBrandPublishedVersion(ctx context.Context, params *UpdateBrandPublishedVersionInput, optFns ...func(*Options)) (*UpdateBrandPublishedVersionOutput, error)

Updates the published version of a brand.

func (*Client) UpdateCustomPermissions added in v1.79.0 

func (c *Client) UpdateCustomPermissions(ctx context.Context, params *UpdateCustomPermissionsInput, optFns ...func(*Options)) (*UpdateCustomPermissionsOutput, error)

Updates a custom permissions profile.

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 UpdateDashboardPublishedVersionAPI operation. 

func (c *Client) UpdateDashboardLinks(ctx context.Context, params *UpdateDashboardLinksInput, optFns ...func(*Options)) (*UpdateDashboardLinksOutput, error)

Updates the linked analyses on a dashboard.

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. Partial updates are not supported by this operation.

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) UpdateIdentityPropagationConfig added in v1.52.0 

func (c *Client) UpdateIdentityPropagationConfig(ctx context.Context, params *UpdateIdentityPropagationConfigInput, optFns ...func(*Options)) (*UpdateIdentityPropagationConfigOutput, error)

Adds or updates services and authorized targets to configure what the Amazon QuickSight IAM Identity Center application can access.

This operation is only supported for Amazon QuickSight accounts using IAM Identity Center

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. Traffic from a source is allowed when the source satisfies either the IpRestrictionRule , VpcIdRestrictionRule , or VpcEndpointIdRestrictionRule . To use this operation, you must provide the entire map of rules. You can use the DescribeIpRestriction operation to get the current rule map.

func (*Client) UpdateKeyRegistration added in v1.64.0 

func (c *Client) UpdateKeyRegistration(ctx context.Context, params *UpdateKeyRegistrationInput, optFns ...func(*Options)) (*UpdateKeyRegistrationOutput, error)

Updates a customer managed key in a Amazon QuickSight account.

func (*Client) UpdatePublicSharingSettings added in v1.22.0 

func (c *Client) UpdatePublicSharingSettings(ctx context.Context, params *UpdatePublicSharingSettingsInput, optFns ...func(*Options)) (*UpdatePublicSharingSettingsOutput, error)

Use the UpdatePublicSharingSettings operation to turn on or turn off the public sharing settings of an Amazon QuickSight dashboard.

To use this operation, turn on session capacity pricing for your Amazon QuickSight account.

Before you can turn on public sharing on your account, make sure to give public sharing permissions to an administrative user in the Identity and Access Management (IAM) console. For more information on using IAM with Amazon QuickSight, see Using Amazon QuickSight with IAMin the Amazon QuickSight User Guide.

func (*Client) UpdateQPersonalizationConfiguration added in v1.74.0 

func (c *Client) UpdateQPersonalizationConfiguration(ctx context.Context, params *UpdateQPersonalizationConfigurationInput, optFns ...func(*Options)) (*UpdateQPersonalizationConfigurationOutput, error)

Updates a personalization configuration.

func (*Client) UpdateRefreshSchedule added in v1.34.0 

func (c *Client) UpdateRefreshSchedule(ctx context.Context, params *UpdateRefreshScheduleInput, optFns ...func(*Options)) (*UpdateRefreshScheduleOutput, error)

Updates a refresh schedule for a dataset.

func (*Client) UpdateRoleCustomPermission added in v1.51.0 

func (c *Client) UpdateRoleCustomPermission(ctx context.Context, params *UpdateRoleCustomPermissionInput, optFns ...func(*Options)) (*UpdateRoleCustomPermissionOutput, error)

Updates the custom permissions that are associated with a role.

func (*Client) UpdateSPICECapacityConfiguration added in v1.63.0 

func (c *Client) UpdateSPICECapacityConfiguration(ctx context.Context, params *UpdateSPICECapacityConfigurationInput, optFns ...func(*Options)) (*UpdateSPICECapacityConfigurationOutput, error)

Updates the SPICE capacity configuration for a Amazon QuickSight account.

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) UpdateTopic added in v1.35.0 

func (c *Client) UpdateTopic(ctx context.Context, params *UpdateTopicInput, optFns ...func(*Options)) (*UpdateTopicOutput, error)

Updates a topic.

func (*Client) UpdateTopicPermissions added in v1.35.0 

func (c *Client) UpdateTopicPermissions(ctx context.Context, params *UpdateTopicPermissionsInput, optFns ...func(*Options)) (*UpdateTopicPermissionsOutput, error)

Updates the permissions of a topic.

func (*Client) UpdateTopicRefreshSchedule added in v1.35.0 

func (c *Client) UpdateTopicRefreshSchedule(ctx context.Context, params *UpdateTopicRefreshScheduleInput, optFns ...func(*Options)) (*UpdateTopicRefreshScheduleOutput, error)

Updates a topic refresh schedule.

func (*Client) UpdateUser 

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

Updates an Amazon QuickSight user.

func (*Client) UpdateUserCustomPermission added in v1.79.0 

func (c *Client) UpdateUserCustomPermission(ctx context.Context, params *UpdateUserCustomPermissionInput, optFns ...func(*Options)) (*UpdateUserCustomPermissionOutput, error)

Updates a custom permissions profile for a user.

func (*Client) UpdateVPCConnection added in v1.35.0 

func (c *Client) UpdateVPCConnection(ctx context.Context, params *UpdateVPCConnectionInput, optFns ...func(*Options)) (*UpdateVPCConnectionOutput, error)

Updates a VPC connection.

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 CreateAccountSubscriptionInput added in v1.23.0 

type CreateAccountSubscriptionInput struct {

	// The name of your Amazon QuickSight account. This name is unique over all of
	// Amazon Web Services, and it appears only when users sign in. You can't change
	// AccountName value after the Amazon QuickSight account is created.
	//
	// This member is required.
	AccountName *string

	// The method that you want to use to authenticate your Amazon QuickSight account.
	//
	// If you choose ACTIVE_DIRECTORY , provide an ActiveDirectoryName and an
	// AdminGroup associated with your Active Directory.
	//
	// If you choose IAM_IDENTITY_CENTER , provide an AdminGroup associated with your
	// IAM Identity Center account.
	//
	// This member is required.
	AuthenticationMethod types.AuthenticationMethodOption

	// The Amazon Web Services account ID of the account that you're using to create
	// your Amazon QuickSight account.
	//
	// This member is required.
	AwsAccountId *string

	// The email address that you want Amazon QuickSight to send notifications to
	// regarding your Amazon QuickSight account or Amazon QuickSight subscription.
	//
	// This member is required.
	NotificationEmail *string

	// The name of your Active Directory. This field is required if ACTIVE_DIRECTORY
	// is the selected authentication method of the new Amazon QuickSight account.
	ActiveDirectoryName *string

	// The admin group associated with your Active Directory or IAM Identity Center
	// account. Either this field or the AdminProGroup field is required if
	// ACTIVE_DIRECTORY or IAM_IDENTITY_CENTER is the selected authentication method
	// of the new Amazon QuickSight account.
	//
	// For more information about using IAM Identity Center in Amazon QuickSight, see [Using IAM Identity Center with Amazon QuickSight Enterprise Edition]
	// in the Amazon QuickSight User Guide. For more information about using Active
	// Directory in Amazon QuickSight, see [Using Active Directory with Amazon QuickSight Enterprise Edition]in the Amazon QuickSight User Guide.
	//
	// [Using Active Directory with Amazon QuickSight Enterprise Edition]: https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html
	// [Using IAM Identity Center with Amazon QuickSight Enterprise Edition]: https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html
	AdminGroup []string

	// The admin pro group associated with your Active Directory or IAM Identity
	// Center account. Either this field or the AdminGroup field is required if
	// ACTIVE_DIRECTORY or IAM_IDENTITY_CENTER is the selected authentication method
	// of the new Amazon QuickSight account.
	//
	// For more information about using IAM Identity Center in Amazon QuickSight, see [Using IAM Identity Center with Amazon QuickSight Enterprise Edition]
	// in the Amazon QuickSight User Guide. For more information about using Active
	// Directory in Amazon QuickSight, see [Using Active Directory with Amazon QuickSight Enterprise Edition]in the Amazon QuickSight User Guide.
	//
	// [Using Active Directory with Amazon QuickSight Enterprise Edition]: https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html
	// [Using IAM Identity Center with Amazon QuickSight Enterprise Edition]: https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html
	AdminProGroup []string

	// The author group associated with your Active Directory or IAM Identity Center
	// account.
	//
	// For more information about using IAM Identity Center in Amazon QuickSight, see [Using IAM Identity Center with Amazon QuickSight Enterprise Edition]
	// in the Amazon QuickSight User Guide. For more information about using Active
	// Directory in Amazon QuickSight, see [Using Active Directory with Amazon QuickSight Enterprise Edition]in the Amazon QuickSight User Guide.
	//
	// [Using Active Directory with Amazon QuickSight Enterprise Edition]: https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html
	// [Using IAM Identity Center with Amazon QuickSight Enterprise Edition]: https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html
	AuthorGroup []string

	// The author pro group associated with your Active Directory or IAM Identity
	// Center account.
	//
	// For more information about using IAM Identity Center in Amazon QuickSight, see [Using IAM Identity Center with Amazon QuickSight Enterprise Edition]
	// in the Amazon QuickSight User Guide. For more information about using Active
	// Directory in Amazon QuickSight, see [Using Active Directory with Amazon QuickSight Enterprise Edition]in the Amazon QuickSight User Guide.
	//
	// [Using Active Directory with Amazon QuickSight Enterprise Edition]: https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html
	// [Using IAM Identity Center with Amazon QuickSight Enterprise Edition]: https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html
	AuthorProGroup []string

	// A 10-digit phone number for the author of the Amazon QuickSight account to use
	// for future communications. This field is required if ENTERPPRISE_AND_Q is the
	// selected edition of the new Amazon QuickSight account.
	ContactNumber *string

	// The ID of the Active Directory that is associated with your Amazon QuickSight
	// account.
	DirectoryId *string

	// The edition of Amazon QuickSight that you want your account to have. Currently,
	// you can choose from ENTERPRISE or ENTERPRISE_AND_Q .
	//
	// If you choose ENTERPRISE_AND_Q , the following parameters are required:
	//
	//   - FirstName
	//
	//   - LastName
	//
	//   - EmailAddress
	//
	//   - ContactNumber
	Edition types.Edition

	// The email address of the author of the Amazon QuickSight account to use for
	// future communications. This field is required if ENTERPPRISE_AND_Q is the
	// selected edition of the new Amazon QuickSight account.
	EmailAddress *string

	// The first name of the author of the Amazon QuickSight account to use for future
	// communications. This field is required if ENTERPPRISE_AND_Q is the selected
	// edition of the new Amazon QuickSight account.
	FirstName *string

	// The Amazon Resource Name (ARN) for the IAM Identity Center instance.
	IAMIdentityCenterInstanceArn *string

	// The last name of the author of the Amazon QuickSight account to use for future
	// communications. This field is required if ENTERPPRISE_AND_Q is the selected
	// edition of the new Amazon QuickSight account.
	LastName *string

	// The reader group associated with your Active Directory or IAM Identity Center
	// account.
	//
	// For more information about using IAM Identity Center in Amazon QuickSight, see [Using IAM Identity Center with Amazon QuickSight Enterprise Edition]
	// in the Amazon QuickSight User Guide. For more information about using Active
	// Directory in Amazon QuickSight, see [Using Active Directory with Amazon QuickSight Enterprise Edition]in the Amazon QuickSight User Guide.
	//
	// [Using Active Directory with Amazon QuickSight Enterprise Edition]: https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html
	// [Using IAM Identity Center with Amazon QuickSight Enterprise Edition]: https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html
	ReaderGroup []string

	// The reader pro group associated with your Active Directory or IAM Identity
	// Center account.
	//
	// For more information about using IAM Identity Center in Amazon QuickSight, see [Using IAM Identity Center with Amazon QuickSight Enterprise Edition]
	// in the Amazon QuickSight User Guide. For more information about using Active
	// Directory in Amazon QuickSight, see [Using Active Directory with Amazon QuickSight Enterprise Edition]in the Amazon QuickSight User Guide.
	//
	// [Using Active Directory with Amazon QuickSight Enterprise Edition]: https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html
	// [Using IAM Identity Center with Amazon QuickSight Enterprise Edition]: https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html
	ReaderProGroup []string

	// The realm of the Active Directory that is associated with your Amazon
	// QuickSight account. This field is required if ACTIVE_DIRECTORY is the selected
	// authentication method of the new Amazon QuickSight account.
	Realm *string
	// contains filtered or unexported fields
}

type CreateAccountSubscriptionOutput added in v1.23.0 

type CreateAccountSubscriptionOutput struct {

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

	// A SignupResponse object that returns information about a newly created Amazon
	// QuickSight account.
	SignupResponse *types.SignupResponse

	// 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

	// The definition of an analysis.
	//
	// A definition is the data model of all features in a Dashboard, Template, or
	// Analysis.
	//
	// Either a SourceEntity or a Definition must be provided in order for the request
	// to be valid.
	Definition *types.AnalysisDefinition

	// When you create the analysis, Amazon QuickSight adds the analysis to these
	// folders.
	FolderArns []string

	// 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

	// 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.
	//
	// Either a SourceEntity or a Definition must be provided in order for the request
	// to be valid.
	SourceEntity *types.AnalysisSourceEntity

	// 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

	// The option to relax the validation needed to create an analysis with definition
	// objects. This skips the validation step for specific errors.
	ValidationStrategy *types.ValidationStrategy
	// 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 CreateBrandInput added in v1.79.0 

type CreateBrandInput struct {

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

	// The ID of the Amazon QuickSight brand.
	//
	// This member is required.
	BrandId *string

	// The definition of the brand.
	BrandDefinition *types.BrandDefinition

	// A map of the key-value pairs that are assigned to the brand.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateBrandOutput added in v1.79.0 

type CreateBrandOutput struct {

	// The definition of the brand.
	BrandDefinition *types.BrandDefinition

	// The details of the brand.
	BrandDetail *types.BrandDetail

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

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

type CreateCustomPermissionsInput added in v1.79.0 

type CreateCustomPermissionsInput struct {

	// The ID of the Amazon Web Services account that you want to create the custom
	// permissions profile in.
	//
	// This member is required.
	AwsAccountId *string

	// The name of the custom permissions profile that you want to create.
	//
	// This member is required.
	CustomPermissionsName *string

	// A set of actions to include in the custom permissions profile.
	Capabilities *types.Capabilities

	// The tags to associate with the custom permissions profile.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateCustomPermissionsOutput added in v1.79.0 

type CreateCustomPermissionsOutput struct {

	// The Amazon Resource Name (ARN) of the custom permissions profile.
	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 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

	// 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 definition of a dashboard.
	//
	// A definition is the data model of all features in a Dashboard, Template, or
	// Analysis.
	//
	// Either a SourceEntity or a Definition must be provided in order for the request
	// to be valid.
	Definition *types.DashboardVersionDefinition

	// When you create the dashboard, Amazon QuickSight adds the dashboard to these
	// folders.
	FolderArns []string

	// A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.
	LinkEntities []string

	// A structure that contains the permissions of a shareable link to the dashboard.
	LinkSharingConfiguration *types.LinkSharingConfiguration

	// 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

	// 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]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.
	//
	// Either a SourceEntity or a Definition must be provided in order for the request
	// to be valid.
	//
	// [CreateTemplate]: https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CreateTemplate.html
	SourceEntity *types.DashboardSourceEntity

	// 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

	// The option to relax the validation needed to create a dashboard with definition
	// objects. This option skips the validation step for specific errors.
	ValidationStrategy *types.ValidationStrategy

	// 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].
	//
	// [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 parameter declarations of the dataset.
	DatasetParameters []types.DatasetParameter

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

	// When you create the dataset, Amazon QuickSight adds the dataset to these
	// folders.
	FolderArns []string

	// 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

	// When you create the data source, Amazon QuickSight adds the data source to
	// these folders.
	FolderArns []string

	// 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

	// An optional parameter that determines the sharing scope of the folder. The
	// default value for this parameter is ACCOUNT .
	SharingModel types.SharingModel

	// 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 that you want to add to the folder.
	//
	// This member is required.
	MemberId *string

	// The member type of the asset that you want to add to a folder.
	//
	// 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 that you want the group to be a part of.
	//
	// 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 that you want the user to be a part of.
	//
	// 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. The name must be unique within
	// the 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. The 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 CreateRefreshScheduleInput added in v1.34.0 

type CreateRefreshScheduleInput struct {

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

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

	// The refresh schedule.
	//
	// This member is required.
	Schedule *types.RefreshSchedule
	// contains filtered or unexported fields
}

type CreateRefreshScheduleOutput added in v1.34.0 

type CreateRefreshScheduleOutput struct {

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

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

	// The ID of the refresh schedule.
	ScheduleId *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 CreateRoleMembershipInput added in v1.51.0 

type CreateRoleMembershipInput struct {

	// The ID for the Amazon Web Services account that you want to create a group in.
	// The Amazon Web Services account ID that you provide must be the same 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 to the role.
	//
	// This member is required.
	MemberName *string

	// The namespace that the role belongs to.
	//
	// This member is required.
	Namespace *string

	// The role that you want to add a group to.
	//
	// This member is required.
	Role types.Role
	// contains filtered or unexported fields
}

type CreateRoleMembershipOutput added in v1.51.0 

type CreateRoleMembershipOutput 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 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

	// 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

	// The definition of a template.
	//
	// A definition is the data model of all features in a Dashboard, Template, or
	// Analysis.
	//
	// Either a SourceEntity or a Definition must be provided in order for the request
	// to be valid.
	Definition *types.TemplateVersionDefinition

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

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

	// 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.
	//
	// Either a SourceEntity or a Definition must be provided in order for the request
	// to be valid.
	SourceEntity *types.TemplateSourceEntity

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

	// TThe option to relax the validation needed to create a template with definition
	// objects. This skips the validation step for specific errors.
	ValidationStrategy *types.ValidationStrategy

	// 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 CreateTopicInput added in v1.35.0 

type CreateTopicInput struct {

	// The ID of the Amazon Web Services account that you want to create a topic in.
	//
	// This member is required.
	AwsAccountId *string

	// The definition of a topic to create.
	//
	// This member is required.
	Topic *types.TopicDetails

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

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

type CreateTopicOutput added in v1.35.0 

type CreateTopicOutput struct {

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

	// The Amazon Resource Name (ARN) of the topic refresh.
	RefreshArn *string

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

	// The HTTP status of the request.
	Status int32

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

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

type CreateTopicRefreshScheduleInput added in v1.35.0 

type CreateTopicRefreshScheduleInput struct {

	// The ID of the Amazon Web Services account that contains the topic you're
	// creating a refresh schedule for.
	//
	// This member is required.
	AwsAccountId *string

	// The Amazon Resource Name (ARN) of the dataset.
	//
	// This member is required.
	DatasetArn *string

	// The definition of a refresh schedule.
	//
	// This member is required.
	RefreshSchedule *types.TopicRefreshSchedule

	// The ID of the topic that you want to modify. This ID is unique per Amazon Web
	// Services Region for each Amazon Web Services account.
	//
	// This member is required.
	TopicId *string

	// The name of the dataset.
	DatasetName *string
	// contains filtered or unexported fields
}

type CreateTopicRefreshScheduleOutput added in v1.35.0 

type CreateTopicRefreshScheduleOutput struct {

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

	// 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 topic.
	TopicArn *string

	// The ID of the topic that you want to modify. This ID is unique per Amazon Web
	// Services Region for each Amazon Web Services account.
	TopicId *string

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

type CreateVPCConnectionInput added in v1.35.0 

type CreateVPCConnectionInput struct {

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

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

	// The IAM role to associate with the VPC connection.
	//
	// This member is required.
	RoleArn *string

	// A list of security group IDs for the VPC connection.
	//
	// This member is required.
	SecurityGroupIds []string

	// A list of subnet IDs for the VPC connection.
	//
	// This member is required.
	SubnetIds []string

	// The ID of the VPC connection that you're creating. This ID is a unique
	// identifier for each Amazon Web Services Region in an Amazon Web Services
	// account.
	//
	// This member is required.
	VPCConnectionId *string

	// A list of IP addresses of DNS resolver endpoints for the VPC connection.
	DnsResolvers []string

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

type CreateVPCConnectionOutput added in v1.35.0 

type CreateVPCConnectionOutput struct {

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

	// The availability status of the VPC connection.
	AvailabilityStatus types.VPCConnectionAvailabilityStatus

	// The status of the creation of the VPC connection.
	CreationStatus types.VPCConnectionResourceStatus

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

	// The HTTP status of the request.
	Status int32

	// The ID for the VPC connection that you're creating. This ID is unique per
	// Amazon Web Services Region for each Amazon Web Services account.
	VPCConnectionId *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 DeleteAccountSubscriptionInput added in v1.27.0 

type DeleteAccountSubscriptionInput struct {

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

type DeleteAccountSubscriptionOutput added in v1.27.0 

type DeleteAccountSubscriptionOutput 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 DeleteBrandAssignmentInput added in v1.79.0 

type DeleteBrandAssignmentInput struct {

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

type DeleteBrandAssignmentOutput added in v1.79.0 

type DeleteBrandAssignmentOutput struct {

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

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

type DeleteBrandInput added in v1.79.0 

type DeleteBrandInput struct {

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

	// The ID of the Amazon QuickSight brand.
	//
	// This member is required.
	BrandId *string
	// contains filtered or unexported fields
}

type DeleteBrandOutput added in v1.79.0 

type DeleteBrandOutput struct {

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

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

type DeleteCustomPermissionsInput added in v1.79.0 

type DeleteCustomPermissionsInput struct {

	// The ID of the Amazon Web Services account that contains the custom permissions
	// profile that you want to delete.
	//
	// This member is required.
	AwsAccountId *string

	// The name of the custom permissions profile that you want to delete.
	//
	// This member is required.
	CustomPermissionsName *string
	// contains filtered or unexported fields
}

type DeleteCustomPermissionsOutput added in v1.79.0 

type DeleteCustomPermissionsOutput struct {

	// The Amazon Resource Name (ARN) of the custom permissions profile.
	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 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 DeleteDataSetRefreshPropertiesInput added in v1.34.0 

type DeleteDataSetRefreshPropertiesInput struct {

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

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

type DeleteDataSetRefreshPropertiesOutput added in v1.34.0 

type DeleteDataSetRefreshPropertiesOutput 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 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 that you want to delete.
	//
	// This member is required.
	MemberId *string

	// The member type of the asset that you want to delete from a folder.
	//
	// 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 of the group that you want to delete.
	//
	// 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 of the group that you want to remove a user from.
	//
	// 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 DeleteIdentityPropagationConfigInput added in v1.52.0 

type DeleteIdentityPropagationConfigInput struct {

	// The ID of the Amazon Web Services account that you want to delete an identity
	// propagation configuration from.
	//
	// This member is required.
	AwsAccountId *string

	// The name of the Amazon Web Services service that you want to delete the
	// associated access scopes and authorized targets from.
	//
	// This member is required.
	Service types.ServiceType
	// contains filtered or unexported fields
}

type DeleteIdentityPropagationConfigOutput added in v1.52.0 

type DeleteIdentityPropagationConfigOutput 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 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 DeleteRefreshScheduleInput added in v1.34.0 

type DeleteRefreshScheduleInput struct {

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

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

	// The ID of the refresh schedule.
	//
	// This member is required.
	ScheduleId *string
	// contains filtered or unexported fields
}

type DeleteRefreshScheduleOutput added in v1.34.0 

type DeleteRefreshScheduleOutput struct {

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

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

	// The ID of the refresh schedule.
	ScheduleId *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 DeleteRoleCustomPermissionInput added in v1.51.0 

type DeleteRoleCustomPermissionInput 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 that includes the role.
	//
	// This member is required.
	Namespace *string

	// The role that you want to remove permissions from.
	//
	// This member is required.
	Role types.Role
	// contains filtered or unexported fields
}

type DeleteRoleCustomPermissionOutput added in v1.51.0 

type DeleteRoleCustomPermissionOutput 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 DeleteRoleMembershipInput added in v1.51.0 

type DeleteRoleMembershipInput struct {

	// The ID for the Amazon Web Services account that you want to create a group in.
	// The Amazon Web Services account ID that you provide must be the same Amazon Web
	// Services account that contains your Amazon QuickSight account.
	//
	// This member is required.
	AwsAccountId *string

	// The name of the group.
	//
	// This member is required.
	MemberName *string

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

	// The role that you want to remove permissions from.
	//
	// This member is required.
	Role types.Role
	// contains filtered or unexported fields
}

type DeleteRoleMembershipOutput added in v1.51.0 

type DeleteRoleMembershipOutput 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 DeleteTopicInput added in v1.35.0 

type DeleteTopicInput struct {

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

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

type DeleteTopicOutput added in v1.35.0 

type DeleteTopicOutput struct {

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

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

	// The HTTP status of the request.
	Status int32

	// The ID of the topic that you want to delete. This ID is unique per Amazon Web
	// Services Region for each Amazon Web Services account.
	TopicId *string

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

type DeleteTopicRefreshScheduleInput added in v1.35.0 

type DeleteTopicRefreshScheduleInput struct {

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

	// The ID of the dataset.
	//
	// This member is required.
	DatasetId *string

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

type DeleteTopicRefreshScheduleOutput added in v1.35.0 

type DeleteTopicRefreshScheduleOutput struct {

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

	// 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 topic.
	TopicArn *string

	// The ID of the topic that you want to modify. This ID is unique per Amazon Web
	// Services Region for each Amazon Web Services account.
	TopicId *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 DeleteUserCustomPermissionInput added in v1.79.0 

type DeleteUserCustomPermissionInput struct {

	// The ID of the Amazon Web Services account that contains the custom permission
	// configuration that you want to delete.
	//
	// This member is required.
	AwsAccountId *string

	// The namespace that the user belongs to.
	//
	// This member is required.
	Namespace *string

	// The username of the user that you want to remove custom permissions from.
	//
	// This member is required.
	UserName *string
	// contains filtered or unexported fields
}

type DeleteUserCustomPermissionOutput added in v1.79.0 

type DeleteUserCustomPermissionOutput 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 DeleteVPCConnectionInput added in v1.35.0 

type DeleteVPCConnectionInput struct {

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

	// The ID of the VPC connection that you're creating. This ID is a unique
	// identifier for each Amazon Web Services Region in an Amazon Web Services
	// account.
	//
	// This member is required.
	VPCConnectionId *string
	// contains filtered or unexported fields
}

type DeleteVPCConnectionOutput added in v1.35.0 

type DeleteVPCConnectionOutput struct {

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

	// The availability status of the VPC connection.
	AvailabilityStatus types.VPCConnectionAvailabilityStatus

	// The deletion status of the VPC connection.
	DeletionStatus types.VPCConnectionResourceStatus

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

	// The HTTP status of the request.
	Status int32

	// The ID of the VPC connection that you're creating. This ID is a unique
	// identifier for each Amazon Web Services Region in an Amazon Web Services
	// account.
	VPCConnectionId *string

	// 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 DescribeAccountSubscriptionInput added in v1.23.0 

type DescribeAccountSubscriptionInput struct {

	// The Amazon Web Services account ID associated with your Amazon QuickSight
	// account.
	//
	// This member is required.
	AwsAccountId *string
	// contains filtered or unexported fields
}

type DescribeAccountSubscriptionOutput added in v1.23.0 

type DescribeAccountSubscriptionOutput struct {

	// A structure that contains the following elements:
	//
	//   - Your Amazon QuickSight account name.
	//
	//   - The edition of Amazon QuickSight that your account is using.
	//
	//   - The notification email address that is associated with the Amazon
	//   QuickSight account.
	//
	//   - The authentication type of the Amazon QuickSight account.
	//
	//   - The status of the Amazon QuickSight account's subscription.
	AccountInfo *types.AccountInfo

	// 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 DescribeAnalysisDefinitionInput added in v1.28.0 

type DescribeAnalysisDefinitionInput 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 DescribeAnalysisDefinitionOutput added in v1.28.0 

type DescribeAnalysisDefinitionOutput struct {

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

	// The definition of an analysis.
	//
	// A definition is the data model of all features in a Dashboard, Template, or
	// Analysis.
	Definition *types.AnalysisDefinition

	// Errors associated with the analysis.
	Errors []types.AnalysisError

	// The descriptive name of the analysis.
	Name *string

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

	// Status associated with the analysis.
	//
	//   - CREATION_IN_PROGRESS
	//
	//   - CREATION_SUCCESSFUL
	//
	//   - CREATION_FAILED
	//
	//   - UPDATE_IN_PROGRESS
	//
	//   - UPDATE_SUCCESSFUL
	//
	//   - UPDATE_FAILED
	//
	//   - DELETED
	ResourceStatus types.ResourceStatus

	// The HTTP status of the request.
	Status int32

	// The ARN of the theme of the analysis.
	ThemeArn *string

	// 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 DescribeAssetBundleExportJobInput added in v1.36.0 

type DescribeAssetBundleExportJobInput struct {

	// The ID of the job that you want described. The job ID is set when you start a
	// new job with a StartAssetBundleExportJob API call.
	//
	// This member is required.
	AssetBundleExportJobId *string

	// The ID of the Amazon Web Services account the export job is executed in.
	//
	// This member is required.
	AwsAccountId *string
	// contains filtered or unexported fields
}

type DescribeAssetBundleExportJobOutput added in v1.36.0 

type DescribeAssetBundleExportJobOutput struct {

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

	// The ID of the job. The job ID is set when you start a new job with a
	// StartAssetBundleExportJob API call.
	AssetBundleExportJobId *string

	// The ID of the Amazon Web Services account that the export job was executed in.
	AwsAccountId *string

	// The CloudFormation override property configuration for the export job.
	CloudFormationOverridePropertyConfiguration *types.AssetBundleCloudFormationOverridePropertyConfiguration

	// The time that the export job was created.
	CreatedTime *time.Time

	// The URL to download the exported asset bundle data from.
	//
	// This URL is available only after the job has succeeded. This URL is valid for 5
	// minutes after issuance. Call DescribeAssetBundleExportJob again for a fresh URL
	// if needed.
	//
	// The downloaded asset bundle is a zip file named assetbundle-{jobId}.qs . The
	// file has a .qs extension.
	//
	// This URL can't be used in a StartAssetBundleImportJob API call and should only
	// be used for download purposes.
	DownloadUrl *string

	// An array of error records that describes any failures that occurred during the
	// export job processing.
	//
	// Error records accumulate while the job runs. The complete set of error records
	// is available after the job has completed and failed.
	Errors []types.AssetBundleExportJobError

	// The format of the exported asset bundle. A QUICKSIGHT_JSON formatted file can
	// be used to make a StartAssetBundleImportJob API call. A CLOUDFORMATION_JSON
	// formatted file can be used in the CloudFormation console and with the
	// CloudFormation APIs.
	ExportFormat types.AssetBundleExportFormat

	// The include dependencies flag.
	IncludeAllDependencies bool

	// A setting that determines whether folder members are included.
	IncludeFolderMembers types.IncludeFolderMembers

	// The include folder memberships flag.
	IncludeFolderMemberships bool

	// The include permissions flag.
	IncludePermissions bool

	// The include tags flag.
	IncludeTags bool

	// Indicates the status of a job through its queuing and execution.
	//
	// Poll this DescribeAssetBundleExportApi until JobStatus is either SUCCESSFUL or
	// FAILED .
	JobStatus types.AssetBundleExportJobStatus

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

	// A list of resource ARNs that exported with the job.
	ResourceArns []string

	// The HTTP status of the response.
	Status int32

	// The validation strategy that is used to export the analysis or dashboard.
	ValidationStrategy *types.AssetBundleExportJobValidationStrategy

	// An array of warning records that describe the analysis or dashboard that is
	// exported. This array includes UI errors that can be skipped during the
	// validation process.
	//
	// This property only appears if StrictModeForAllResources in ValidationStrategy
	// is set to FALSE .
	Warnings []types.AssetBundleExportJobWarning

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

type DescribeAssetBundleImportJobInput added in v1.36.0 

type DescribeAssetBundleImportJobInput struct {

	// The ID of the job. The job ID is set when you start a new job with a
	// StartAssetBundleImportJob API call.
	//
	// This member is required.
	AssetBundleImportJobId *string

	// The ID of the Amazon Web Services account the import job was executed in.
	//
	// This member is required.
	AwsAccountId *string
	// contains filtered or unexported fields
}

type DescribeAssetBundleImportJobOutput added in v1.36.0 

type DescribeAssetBundleImportJobOutput struct {

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

	// The ID of the job. The job ID is set when you start a new job with a
	// StartAssetBundleImportJob API call.
	AssetBundleImportJobId *string

	// The source of the asset bundle zip file that contains the data that is imported
	// by the job.
	AssetBundleImportSource *types.AssetBundleImportSourceDescription

	// The ID of the Amazon Web Services account the import job was executed in.
	AwsAccountId *string

	// The time that the import job was created.
	CreatedTime *time.Time

	// An array of error records that describes any failures that occurred during the
	// export job processing.
	//
	// Error records accumulate while the job is still running. The complete set of
	// error records is available after the job has completed and failed.
	Errors []types.AssetBundleImportJobError

	// The failure action for the import job.
	FailureAction types.AssetBundleImportFailureAction

	// Indicates the status of a job through its queuing and execution.
	//
	// Poll the DescribeAssetBundleImport API until JobStatus returns one of the
	// following values:
	//
	//   - SUCCESSFUL
	//
	//   - FAILED
	//
	//   - FAILED_ROLLBACK_COMPLETED
	//
	//   - FAILED_ROLLBACK_ERROR
	JobStatus types.AssetBundleImportJobStatus

	// Optional overrides that are applied to the resource configuration before import.
	OverrideParameters *types.AssetBundleImportJobOverrideParameters

	// Optional permission overrides that are applied to the resource configuration
	// before import.
	OverridePermissions *types.AssetBundleImportJobOverridePermissions

	// Optional tag overrides that are applied to the resource configuration before
	// import.
	OverrideTags *types.AssetBundleImportJobOverrideTags

	// An optional validation strategy override for all analyses and dashboards to be
	// applied to the resource configuration before import.
	OverrideValidationStrategy *types.AssetBundleImportJobOverrideValidationStrategy

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

	// An array of error records that describes any failures that occurred while an
	// import job was attempting a rollback.
	//
	// Error records accumulate while the job is still running. The complete set of
	// error records is available after the job has completed and failed.
	RollbackErrors []types.AssetBundleImportJobError

	// The HTTP status of the response.
	Status int32

	// An array of warning records that describe all permitted errors that are
	// encountered during the import job.
	Warnings []types.AssetBundleImportJobWarning

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

type DescribeBrandAssignmentInput added in v1.79.0 

type DescribeBrandAssignmentInput struct {

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

type DescribeBrandAssignmentOutput added in v1.79.0 

type DescribeBrandAssignmentOutput struct {

	// The Amazon Resource Name (ARN) of the brand.
	BrandArn *string

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

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

type DescribeBrandInput added in v1.79.0 

type DescribeBrandInput struct {

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

	// The ID of the Amazon QuickSight brand.
	//
	// This member is required.
	BrandId *string

	// The ID of the specific version. The default value is the latest version.
	VersionId *string
	// contains filtered or unexported fields
}

type DescribeBrandOutput added in v1.79.0 

type DescribeBrandOutput struct {

	// The definition of the brand.
	BrandDefinition *types.BrandDefinition

	// The details of the brand.
	BrandDetail *types.BrandDetail

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

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

type DescribeBrandPublishedVersionInput added in v1.79.0 

type DescribeBrandPublishedVersionInput struct {

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

	// The ID of the Amazon QuickSight brand.
	//
	// This member is required.
	BrandId *string
	// contains filtered or unexported fields
}

type DescribeBrandPublishedVersionOutput added in v1.79.0 

type DescribeBrandPublishedVersionOutput struct {

	// The definition of the brand.
	BrandDefinition *types.BrandDefinition

	// The details of the brand.
	BrandDetail *types.BrandDetail

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

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

type DescribeCustomPermissionsInput added in v1.79.0 

type DescribeCustomPermissionsInput struct {

	// The ID of the Amazon Web Services account that contains the custom permissions
	// profile that you want described.
	//
	// This member is required.
	AwsAccountId *string

	// The name of the custom permissions profile to describe.
	//
	// This member is required.
	CustomPermissionsName *string
	// contains filtered or unexported fields
}

type DescribeCustomPermissionsOutput added in v1.79.0 

type DescribeCustomPermissionsOutput struct {

	// The custom permissions profile.
	CustomPermissions *types.CustomPermissions

	// 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 DescribeDashboardDefinitionInput added in v1.28.0 

type DescribeDashboardDefinitionInput 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 DescribeDashboardDefinitionOutput added in v1.28.0 

type DescribeDashboardDefinitionOutput struct {

	// The ID of the dashboard described.
	DashboardId *string

	// Options for publishing the dashboard:
	//
	//   - 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 definition of a dashboard.
	//
	// A definition is the data model of all features in a Dashboard, Template, or
	// Analysis.
	Definition *types.DashboardVersionDefinition

	// Errors associated with this dashboard version.
	Errors []types.DashboardError

	// The display name of the dashboard.
	Name *string

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

	// Status associated with the dashboard version.
	//
	//   - CREATION_IN_PROGRESS
	//
	//   - CREATION_SUCCESSFUL
	//
	//   - CREATION_FAILED
	//
	//   - UPDATE_IN_PROGRESS
	//
	//   - UPDATE_SUCCESSFUL
	//
	//   - UPDATE_FAILED
	//
	//   - DELETED
	ResourceStatus types.ResourceStatus

	// The HTTP status of the request.
	Status int32

	// The ARN of the theme of the dashboard.
	ThemeArn *string

	// 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].
	//
	// [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 DescribeDashboardSnapshotJobInput added in v1.39.0 

type DescribeDashboardSnapshotJobInput struct {

	// The ID of the Amazon Web Services account that the dashboard snapshot job is
	// executed in.
	//
	// This member is required.
	AwsAccountId *string

	// The ID of the dashboard that you have started a snapshot job for.
	//
	// This member is required.
	DashboardId *string

	// The ID of the job to be described. The job ID is set when you start a new job
	// with a StartDashboardSnapshotJob API call.
	//
	// This member is required.
	SnapshotJobId *string
	// contains filtered or unexported fields
}

type DescribeDashboardSnapshotJobOutput added in v1.39.0 

type DescribeDashboardSnapshotJobOutput struct {

	// The Amazon Resource Name (ARN) for the snapshot job. The job ARN is generated
	// when you start a new job with a StartDashboardSnapshotJob API call.
	Arn *string

	//  The ID of the Amazon Web Services account that the dashboard snapshot job is
	// executed in.
	AwsAccountId *string

	//  The time that the snapshot job was created.
	CreatedTime *time.Time

	// The ID of the dashboard that you have started a snapshot job for.
	DashboardId *string

	// Indicates the status of a job. The status updates as the job executes. This
	// shows one of the following values.
	//
	//   - COMPLETED - The job was completed successfully.
	//
	//   - FAILED - The job failed to execute.
	//
	//   - QUEUED - The job is queued and hasn't started yet.
	//
	//   - RUNNING - The job is still running.
	JobStatus types.SnapshotJobStatus

	//  The time that the snapshot job status was last updated.
	LastUpdatedTime *time.Time

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

	// The snapshot configuration of the job. This information is provided when you
	// make a StartDashboardSnapshotJob API call.
	SnapshotConfiguration *types.SnapshotConfiguration

	// The ID of the job to be described. The job ID is set when you start a new job
	// with a StartDashboardSnapshotJob API call.
	SnapshotJobId *string

	// The HTTP status of the request
	Status int32

	// The user configuration for the snapshot job. This information is provided when
	// you make a StartDashboardSnapshotJob API call.
	UserConfiguration *types.SnapshotUserConfigurationRedacted

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

type DescribeDashboardSnapshotJobResultInput added in v1.39.0 

type DescribeDashboardSnapshotJobResultInput struct {

	// The ID of the Amazon Web Services account that the dashboard snapshot job is
	// executed in.
	//
	// This member is required.
	AwsAccountId *string

	// The ID of the dashboard that you have started a snapshot job for.
	//
	// This member is required.
	DashboardId *string

	// The ID of the job to be described. The job ID is set when you start a new job
	// with a StartDashboardSnapshotJob API call.
	//
	// This member is required.
	SnapshotJobId *string
	// contains filtered or unexported fields
}

type DescribeDashboardSnapshotJobResultOutput added in v1.39.0 

type DescribeDashboardSnapshotJobResultOutput struct {

	// The Amazon Resource Name (ARN) for the snapshot job. The job ARN is generated
	// when you start a new job with a StartDashboardSnapshotJob API call.
	Arn *string

	// The time that a snapshot job was created.
	CreatedTime *time.Time

	// Displays information for the error that caused a job to fail.
	ErrorInfo *types.SnapshotJobErrorInfo

	// Indicates the status of a job after it has reached a terminal state. A finished
	// snapshot job will retuen a COMPLETED or FAILED status.
	JobStatus types.SnapshotJobStatus

	// The time that a snapshot job status was last updated.
	LastUpdatedTime *time.Time

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

	// The result of the snapshot job. Jobs that have successfully completed will
	// return the S3Uri where they are located. Jobs that have failedwill return
	// information on the error that caused the job to fail.
	Result *types.SnapshotJobResult

	// 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 DescribeDataSetRefreshPropertiesInput added in v1.34.0 

type DescribeDataSetRefreshPropertiesInput struct {

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

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

type DescribeDataSetRefreshPropertiesOutput added in v1.34.0 

type DescribeDataSetRefreshPropertiesOutput struct {

	// The dataset refresh properties.
	DataSetRefreshProperties *types.DataSetRefreshProperties

	// 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 DescribeFolderPermissionsAPIClient added in v1.42.0 

type DescribeFolderPermissionsAPIClient interface {
	DescribeFolderPermissions(context.Context, *DescribeFolderPermissionsInput, ...func(*Options)) (*DescribeFolderPermissionsOutput, error)
}

DescribeFolderPermissionsAPIClient is a client that implements the DescribeFolderPermissions operation.

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

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

	// The namespace of the folder whose permissions you want described.
	Namespace *string

	// A pagination token for the next set of results.
	NextToken *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

	// The pagination token for the next set of results, or null if there are no more
	// results.
	NextToken *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 DescribeFolderPermissionsPaginator added in v1.42.0 

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

DescribeFolderPermissionsPaginator is a paginator for DescribeFolderPermissions

func NewDescribeFolderPermissionsPaginator added in v1.42.0 

func NewDescribeFolderPermissionsPaginator(client DescribeFolderPermissionsAPIClient, params *DescribeFolderPermissionsInput, optFns ...func(*DescribeFolderPermissionsPaginatorOptions)) *DescribeFolderPermissionsPaginator

NewDescribeFolderPermissionsPaginator returns a new DescribeFolderPermissionsPaginator

func (*DescribeFolderPermissionsPaginator) HasMorePages added in v1.42.0 

func (p *DescribeFolderPermissionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeFolderPermissionsPaginator) NextPage added in v1.42.0 

func (p *DescribeFolderPermissionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeFolderPermissionsOutput, error)

NextPage retrieves the next DescribeFolderPermissions page.

type DescribeFolderPermissionsPaginatorOptions added in v1.42.0 

type DescribeFolderPermissionsPaginatorOptions 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
}

DescribeFolderPermissionsPaginatorOptions is the paginator options for DescribeFolderPermissions

type DescribeFolderResolvedPermissionsAPIClient added in v1.42.0 

type DescribeFolderResolvedPermissionsAPIClient interface {
	DescribeFolderResolvedPermissions(context.Context, *DescribeFolderResolvedPermissionsInput, ...func(*Options)) (*DescribeFolderResolvedPermissionsOutput, error)
}

DescribeFolderResolvedPermissionsAPIClient is a client that implements the DescribeFolderResolvedPermissions operation.

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

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

	// The namespace of the folder whose permissions you want described.
	Namespace *string

	// A pagination token for the next set of results.
	NextToken *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

	// A pagination token for the next set of results, or null if there are no more
	// results.
	NextToken *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 DescribeFolderResolvedPermissionsPaginator added in v1.42.0 

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

DescribeFolderResolvedPermissionsPaginator is a paginator for DescribeFolderResolvedPermissions

func NewDescribeFolderResolvedPermissionsPaginator added in v1.42.0 

func NewDescribeFolderResolvedPermissionsPaginator(client DescribeFolderResolvedPermissionsAPIClient, params *DescribeFolderResolvedPermissionsInput, optFns ...func(*DescribeFolderResolvedPermissionsPaginatorOptions)) *DescribeFolderResolvedPermissionsPaginator

NewDescribeFolderResolvedPermissionsPaginator returns a new DescribeFolderResolvedPermissionsPaginator

func (*DescribeFolderResolvedPermissionsPaginator) HasMorePages added in v1.42.0 

func (p *DescribeFolderResolvedPermissionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeFolderResolvedPermissionsPaginator) NextPage added in v1.42.0 

func (p *DescribeFolderResolvedPermissionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeFolderResolvedPermissionsOutput, error)

NextPage retrieves the next DescribeFolderResolvedPermissions page.

type DescribeFolderResolvedPermissionsPaginatorOptions added in v1.42.0 

type DescribeFolderResolvedPermissionsPaginatorOptions 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
}

DescribeFolderResolvedPermissionsPaginatorOptions is the paginator options for DescribeFolderResolvedPermissions

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 of the group that you want described.
	//
	// This member is required.
	Namespace *string
	// contains filtered or unexported fields
}

type DescribeGroupMembershipInput added in v1.21.0 

type DescribeGroupMembershipInput 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 search.
	//
	// This member is required.
	GroupName *string

	// The user name of the user that you want to search for.
	//
	// This member is required.
	MemberName *string

	// The namespace that includes the group you are searching within.
	//
	// This member is required.
	Namespace *string
	// contains filtered or unexported fields
}

type DescribeGroupMembershipOutput added in v1.21.0 

type DescribeGroupMembershipOutput struct {

	// A member of an Amazon QuickSight group. Currently, group members must be users.
	// Groups can't be members of another group. .
	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 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

	// A map of allowed VPC endpoint IDs and their rule descriptions.
	VpcEndpointIdRestrictionRuleMap map[string]string

	// A map of allowed VPC IDs and their rule descriptions.
	VpcIdRestrictionRuleMap map[string]string

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

type DescribeKeyRegistrationInput added in v1.64.0 

type DescribeKeyRegistrationInput struct {

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

	// Determines whether the request returns the default key only.
	DefaultKeyOnly bool
	// contains filtered or unexported fields
}

type DescribeKeyRegistrationOutput added in v1.64.0 

type DescribeKeyRegistrationOutput struct {

	// The ID of the Amazon Web Services account that contains the customer managed
	// key registration specified in the request.
	AwsAccountId *string

	// A list of RegisteredCustomerManagedKey objects in a Amazon QuickSight account.
	KeyRegistration []types.RegisteredCustomerManagedKey

	// 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 DescribeQPersonalizationConfigurationInput added in v1.74.0 

type DescribeQPersonalizationConfigurationInput struct {

	// The ID of the Amazon Web Services account that contains the personalization
	// configuration that the user wants described.
	//
	// This member is required.
	AwsAccountId *string
	// contains filtered or unexported fields
}

type DescribeQPersonalizationConfigurationOutput added in v1.74.0 

type DescribeQPersonalizationConfigurationOutput struct {

	// A value that indicates whether personalization is enabled or not.
	PersonalizationMode types.PersonalizationMode

	// 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 DescribeRefreshScheduleInput added in v1.34.0 

type DescribeRefreshScheduleInput struct {

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

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

	// The ID of the refresh schedule.
	//
	// This member is required.
	ScheduleId *string
	// contains filtered or unexported fields
}

type DescribeRefreshScheduleOutput added in v1.34.0 

type DescribeRefreshScheduleOutput struct {

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

	// The refresh schedule.
	RefreshSchedule *types.RefreshSchedule

	// 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 DescribeRoleCustomPermissionInput added in v1.51.0 

type DescribeRoleCustomPermissionInput struct {

	// The ID for the Amazon Web Services account that you want to create a group in.
	// The Amazon Web Services account ID that you provide must be the same Amazon Web
	// Services account that contains your Amazon QuickSight account.
	//
	// This member is required.
	AwsAccountId *string

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

	// The name of the role whose permissions you want described.
	//
	// This member is required.
	Role types.Role
	// contains filtered or unexported fields
}

type DescribeRoleCustomPermissionOutput added in v1.51.0 

type DescribeRoleCustomPermissionOutput struct {

	// The name of the custom permission that is described.
	CustomPermissionsName *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 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 DescribeTemplateDefinitionInput added in v1.28.0 

type DescribeTemplateDefinitionInput struct {

	// The ID of the Amazon Web Services account that contains the template. You must
	// be using the Amazon Web Services account that the template is in.
	//
	// This member is required.
	AwsAccountId *string

	// The ID of the template that you're describing.
	//
	// 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

	// The version number of the template.
	VersionNumber *int64
	// contains filtered or unexported fields
}

type DescribeTemplateDefinitionOutput added in v1.28.0 

type DescribeTemplateDefinitionOutput struct {

	// The definition of the template.
	//
	// A definition is the data model of all features in a Dashboard, Template, or
	// Analysis.
	Definition *types.TemplateVersionDefinition

	// Errors associated with the template version.
	Errors []types.TemplateError

	// The descriptive name of the template.
	Name *string

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

	// Status associated with the template.
	//
	//   - CREATION_IN_PROGRESS
	//
	//   - CREATION_SUCCESSFUL
	//
	//   - CREATION_FAILED
	//
	//   - UPDATE_IN_PROGRESS
	//
	//   - UPDATE_SUCCESSFUL
	//
	//   - UPDATE_FAILED
	//
	//   - DELETED
	ResourceStatus types.ResourceStatus

	// The HTTP status of the request.
	Status int32

	// The ID of the template described.
	TemplateId *string

	// The ARN of the theme of the template.
	ThemeArn *string

	// 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 DescribeTopicInput added in v1.35.0 

type DescribeTopicInput struct {

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

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

type DescribeTopicOutput added in v1.35.0 

type DescribeTopicOutput struct {

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

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

	// The HTTP status of the request.
	Status int32

	// The definition of a topic.
	Topic *types.TopicDetails

	// The ID of the topic that you want to describe. This ID is unique per Amazon Web
	// Services Region for each Amazon Web Services account.
	TopicId *string

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

type DescribeTopicPermissionsInput added in v1.35.0 

type DescribeTopicPermissionsInput struct {

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

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

type DescribeTopicPermissionsOutput added in v1.35.0 

type DescribeTopicPermissionsOutput struct {

	// A list of resource permissions that are configured to the topic.
	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 topic.
	TopicArn *string

	// The ID of the topic that you want to describe. This ID is unique per Amazon Web
	// Services Region for each Amazon Web Services account.
	TopicId *string

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

type DescribeTopicRefreshInput added in v1.35.0 

type DescribeTopicRefreshInput struct {

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

	// The ID of the refresh, which is performed when the topic is created or updated.
	//
	// This member is required.
	RefreshId *string

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

type DescribeTopicRefreshOutput added in v1.35.0 

type DescribeTopicRefreshOutput struct {

	// Details of the refresh, which is performed when the topic is created or updated.
	RefreshDetails *types.TopicRefreshDetails

	// 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 DescribeTopicRefreshScheduleInput added in v1.35.0 

type DescribeTopicRefreshScheduleInput struct {

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

	// The ID of the dataset.
	//
	// This member is required.
	DatasetId *string

	// The ID of the topic that contains the refresh schedule that you want to
	// describe. This ID is unique per Amazon Web Services Region for each Amazon Web
	// Services account.
	//
	// This member is required.
	TopicId *string
	// contains filtered or unexported fields
}

type DescribeTopicRefreshScheduleOutput added in v1.35.0 

type DescribeTopicRefreshScheduleOutput struct {

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

	// The definition of a refresh schedule.
	RefreshSchedule *types.TopicRefreshSchedule

	// 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 topic.
	TopicArn *string

	// The ID of the topic that contains the refresh schedule that you want to
	// describe. This ID is unique per Amazon Web Services Region for each Amazon Web
	// Services account.
	TopicId *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 DescribeVPCConnectionInput added in v1.35.0 

type DescribeVPCConnectionInput struct {

	// The Amazon Web Services account ID of the account that contains the VPC
	// connection that you want described.
	//
	// This member is required.
	AwsAccountId *string

	// The ID of the VPC connection that you're creating. This ID is a unique
	// identifier for each Amazon Web Services Region in an Amazon Web Services
	// account.
	//
	// This member is required.
	VPCConnectionId *string
	// contains filtered or unexported fields
}

type DescribeVPCConnectionOutput added in v1.35.0 

type DescribeVPCConnectionOutput struct {

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

	// The HTTP status of the request.
	Status int32

	// A response object that provides information for the specified VPC connection.
	VPCConnection *types.VPCConnection

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

type EndpointParameters added in v1.40.0 

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired added in v1.40.0 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.40.0 

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

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 EndpointResolverV2 added in v1.40.0 

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 added in v1.40.0 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GenerateEmbedUrlForAnonymousUserInput added in v1.7.0 

type GenerateEmbedUrlForAnonymousUserInput struct {

	// The Amazon Resource Names (ARNs) 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.
	//
	// If you want to make changes to the theme of your embedded content, pass a list
	// of theme ARNs that the anonymous users need access to.
	//
	// Currently, you can pass up to 25 theme ARNs in each API call.
	//
	// 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 that 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

	// The domains that you want to add to the allow list for access to the generated
	// URL that is then embedded. This optional parameter overrides the static domains
	// that are configured in the Manage QuickSight menu in the Amazon QuickSight
	// console. Instead, it allows only the domains that you include in this parameter.
	// You can list up to three domains or subdomains in each API call.
	//
	// To include all subdomains under a specific domain to the allow list, use * . For
	// example, https://*.sapp.amazon.com includes all subdomains under
	// https://sapp.amazon.com .
	AllowedDomains []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]in the Amazon QuickSight User Guide.
	//
	// [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 Amazon Resource Name (ARN) to use for the anonymous Amazon QuickSight user.
	//
	// This member is required.
	AnonymousUserArn *string

	// 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 that you want to embed. For registered users, you can embed
	// Amazon QuickSight dashboards, Amazon QuickSight visuals, the Amazon QuickSight Q
	// search bar, the Amazon QuickSight Generative Q&A experience, 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

	// The domains that you want to add to the allow list for access to the generated
	// URL that is then embedded. This optional parameter overrides the static domains
	// that are configured in the Manage QuickSight menu in the Amazon QuickSight
	// console. Instead, it allows only the domains that you include in this parameter.
	// You can list up to three domains or subdomains in each API call.
	//
	// To include all subdomains under a specific domain to the allow list, use * . For
	// example, https://*.sapp.amazon.com includes all subdomains under
	// https://sapp.amazon.com .
	AllowedDomains []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, visual, Q search bar,
	// Generative Q&A experience, 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 anonymous users to have
	// tempporary access to. Currently, the IdentityType parameter must be set to
	// ANONYMOUS 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
	//
	//   - 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 ListAssetBundleExportJobsAPIClient added in v1.36.0 

type ListAssetBundleExportJobsAPIClient interface {
	ListAssetBundleExportJobs(context.Context, *ListAssetBundleExportJobsInput, ...func(*Options)) (*ListAssetBundleExportJobsOutput, error)
}

ListAssetBundleExportJobsAPIClient is a client that implements the ListAssetBundleExportJobs operation.

type ListAssetBundleExportJobsInput added in v1.36.0 

type ListAssetBundleExportJobsInput struct {

	// The ID of the Amazon Web Services account that the export jobs were executed
	// in.
	//
	// 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 ListAssetBundleExportJobsOutput added in v1.36.0 

type ListAssetBundleExportJobsOutput struct {

	// A list of export job summaries.
	AssetBundleExportJobSummaryList []types.AssetBundleExportJobSummary

	// 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 ListAssetBundleExportJobsPaginator added in v1.36.0 

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

ListAssetBundleExportJobsPaginator is a paginator for ListAssetBundleExportJobs

func NewListAssetBundleExportJobsPaginator added in v1.36.0 

func NewListAssetBundleExportJobsPaginator(client ListAssetBundleExportJobsAPIClient, params *ListAssetBundleExportJobsInput, optFns ...func(*ListAssetBundleExportJobsPaginatorOptions)) *ListAssetBundleExportJobsPaginator

NewListAssetBundleExportJobsPaginator returns a new ListAssetBundleExportJobsPaginator

func (*ListAssetBundleExportJobsPaginator) HasMorePages added in v1.36.0 

func (p *ListAssetBundleExportJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAssetBundleExportJobsPaginator) NextPage added in v1.36.0 

func (p *ListAssetBundleExportJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAssetBundleExportJobsOutput, error)

NextPage retrieves the next ListAssetBundleExportJobs page.

type ListAssetBundleExportJobsPaginatorOptions added in v1.36.0 

type ListAssetBundleExportJobsPaginatorOptions 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
}

ListAssetBundleExportJobsPaginatorOptions is the paginator options for ListAssetBundleExportJobs

type ListAssetBundleImportJobsAPIClient added in v1.36.0 

type ListAssetBundleImportJobsAPIClient interface {
	ListAssetBundleImportJobs(context.Context, *ListAssetBundleImportJobsInput, ...func(*Options)) (*ListAssetBundleImportJobsOutput, error)
}

ListAssetBundleImportJobsAPIClient is a client that implements the ListAssetBundleImportJobs operation.

type ListAssetBundleImportJobsInput added in v1.36.0 

type ListAssetBundleImportJobsInput struct {

	// The ID of the Amazon Web Services account that the import jobs were executed in.
	//
	// 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 ListAssetBundleImportJobsOutput added in v1.36.0 

type ListAssetBundleImportJobsOutput struct {

	// A list of import job summaries.
	AssetBundleImportJobSummaryList []types.AssetBundleImportJobSummary

	// 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 response.
	Status int32

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

type ListAssetBundleImportJobsPaginator added in v1.36.0 

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

ListAssetBundleImportJobsPaginator is a paginator for ListAssetBundleImportJobs

func NewListAssetBundleImportJobsPaginator added in v1.36.0 

func NewListAssetBundleImportJobsPaginator(client ListAssetBundleImportJobsAPIClient, params *ListAssetBundleImportJobsInput, optFns ...func(*ListAssetBundleImportJobsPaginatorOptions)) *ListAssetBundleImportJobsPaginator

NewListAssetBundleImportJobsPaginator returns a new ListAssetBundleImportJobsPaginator

func (*ListAssetBundleImportJobsPaginator) HasMorePages added in v1.36.0 

func (p *ListAssetBundleImportJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAssetBundleImportJobsPaginator) NextPage added in v1.36.0 

func (p *ListAssetBundleImportJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAssetBundleImportJobsOutput, error)

NextPage retrieves the next ListAssetBundleImportJobs page.

type ListAssetBundleImportJobsPaginatorOptions added in v1.36.0 

type ListAssetBundleImportJobsPaginatorOptions 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
}

ListAssetBundleImportJobsPaginatorOptions is the paginator options for ListAssetBundleImportJobs

type ListBrandsAPIClient added in v1.79.0 

type ListBrandsAPIClient interface {
	ListBrands(context.Context, *ListBrandsInput, ...func(*Options)) (*ListBrandsOutput, error)
}

ListBrandsAPIClient is a client that implements the ListBrands operation.

type ListBrandsInput added in v1.79.0 

type ListBrandsInput struct {

	// The ID of the Amazon Web Services account that owns the brands that you want to
	// list.
	//
	// This member is required.
	AwsAccountId *string

	// The maximum number of results to be returned in a single 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 ListBrandsOutput added in v1.79.0 

type ListBrandsOutput struct {

	// A list of all brands in your Amazon Web Services account. This structure
	// provides basic information about each brand.
	Brands []types.BrandSummary

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

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

type ListBrandsPaginator added in v1.79.0 

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

ListBrandsPaginator is a paginator for ListBrands

func NewListBrandsPaginator added in v1.79.0 

func NewListBrandsPaginator(client ListBrandsAPIClient, params *ListBrandsInput, optFns ...func(*ListBrandsPaginatorOptions)) *ListBrandsPaginator

NewListBrandsPaginator returns a new ListBrandsPaginator

func (*ListBrandsPaginator) HasMorePages added in v1.79.0 

func (p *ListBrandsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListBrandsPaginator) NextPage added in v1.79.0 

func (p *ListBrandsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListBrandsOutput, error)

NextPage retrieves the next ListBrands page.

type ListBrandsPaginatorOptions added in v1.79.0 

type ListBrandsPaginatorOptions struct {
	// The maximum number of results to be returned in a single 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
}

ListBrandsPaginatorOptions is the paginator options for ListBrands

type ListCustomPermissionsAPIClient added in v1.79.0 

type ListCustomPermissionsAPIClient interface {
	ListCustomPermissions(context.Context, *ListCustomPermissionsInput, ...func(*Options)) (*ListCustomPermissionsOutput, error)
}

ListCustomPermissionsAPIClient is a client that implements the ListCustomPermissions operation.

type ListCustomPermissionsInput added in v1.79.0 

type ListCustomPermissionsInput struct {

	// The ID of the Amazon Web Services account that contains the custom permissions
	// profiles that you want to list.
	//
	// This member is required.
	AwsAccountId *string

	// The maximum number of results to return.
	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 ListCustomPermissionsOutput added in v1.79.0 

type ListCustomPermissionsOutput struct {

	// A list of custom permissions profiles.
	CustomPermissionsList []types.CustomPermissions

	// 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 ListCustomPermissionsPaginator added in v1.79.0 

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

ListCustomPermissionsPaginator is a paginator for ListCustomPermissions

func NewListCustomPermissionsPaginator added in v1.79.0 

func NewListCustomPermissionsPaginator(client ListCustomPermissionsAPIClient, params *ListCustomPermissionsInput, optFns ...func(*ListCustomPermissionsPaginatorOptions)) *ListCustomPermissionsPaginator

NewListCustomPermissionsPaginator returns a new ListCustomPermissionsPaginator

func (*ListCustomPermissionsPaginator) HasMorePages added in v1.79.0 

func (p *ListCustomPermissionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListCustomPermissionsPaginator) NextPage added in v1.79.0 

func (p *ListCustomPermissionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListCustomPermissionsOutput, error)

NextPage retrieves the next ListCustomPermissions page.

type ListCustomPermissionsPaginatorOptions added in v1.79.0 

type ListCustomPermissionsPaginatorOptions 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
}

ListCustomPermissionsPaginatorOptions is the paginator options for ListCustomPermissions

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 ListFolderMembersAPIClient added in v1.42.0 

type ListFolderMembersAPIClient interface {
	ListFolderMembers(context.Context, *ListFolderMembersInput, ...func(*Options)) (*ListFolderMembersOutput, error)
}

ListFolderMembersAPIClient is a client that implements the ListFolderMembers operation.

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 ListFolderMembersPaginator added in v1.42.0 

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

ListFolderMembersPaginator is a paginator for ListFolderMembers

func NewListFolderMembersPaginator added in v1.42.0 

func NewListFolderMembersPaginator(client ListFolderMembersAPIClient, params *ListFolderMembersInput, optFns ...func(*ListFolderMembersPaginatorOptions)) *ListFolderMembersPaginator

NewListFolderMembersPaginator returns a new ListFolderMembersPaginator

func (*ListFolderMembersPaginator) HasMorePages added in v1.42.0 

func (p *ListFolderMembersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListFolderMembersPaginator) NextPage added in v1.42.0 

func (p *ListFolderMembersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListFolderMembersOutput, error)

NextPage retrieves the next ListFolderMembers page.

type ListFolderMembersPaginatorOptions added in v1.42.0 

type ListFolderMembersPaginatorOptions 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
}

ListFolderMembersPaginatorOptions is the paginator options for ListFolderMembers

type ListFoldersAPIClient added in v1.42.0 

type ListFoldersAPIClient interface {
	ListFolders(context.Context, *ListFoldersInput, ...func(*Options)) (*ListFoldersOutput, error)
}

ListFoldersAPIClient is a client that implements the ListFolders operation.

type ListFoldersForResourceAPIClient added in v1.72.0 

type ListFoldersForResourceAPIClient interface {
	ListFoldersForResource(context.Context, *ListFoldersForResourceInput, ...func(*Options)) (*ListFoldersForResourceOutput, error)
}

ListFoldersForResourceAPIClient is a client that implements the ListFoldersForResource operation.

type ListFoldersForResourceInput added in v1.72.0 

type ListFoldersForResourceInput struct {

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

	// The Amazon Resource Name (ARN) the resource whose folders you need to list.
	//
	// This member is required.
	ResourceArn *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 ListFoldersForResourceOutput added in v1.72.0 

type ListFoldersForResourceOutput struct {

	// A list that contains the Amazon Resource Names (ARNs) of all folders that the
	// resource is a member of.
	Folders []string

	// 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 ListFoldersForResourcePaginator added in v1.72.0 

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

ListFoldersForResourcePaginator is a paginator for ListFoldersForResource

func NewListFoldersForResourcePaginator added in v1.72.0 

func NewListFoldersForResourcePaginator(client ListFoldersForResourceAPIClient, params *ListFoldersForResourceInput, optFns ...func(*ListFoldersForResourcePaginatorOptions)) *ListFoldersForResourcePaginator

NewListFoldersForResourcePaginator returns a new ListFoldersForResourcePaginator

func (*ListFoldersForResourcePaginator) HasMorePages added in v1.72.0 

func (p *ListFoldersForResourcePaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListFoldersForResourcePaginator) NextPage added in v1.72.0 

func (p *ListFoldersForResourcePaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListFoldersForResourceOutput, error)

NextPage retrieves the next ListFoldersForResource page.

type ListFoldersForResourcePaginatorOptions added in v1.72.0 

type ListFoldersForResourcePaginatorOptions 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
}

ListFoldersForResourcePaginatorOptions is the paginator options for ListFoldersForResource

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 ListFoldersPaginator added in v1.42.0 

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

ListFoldersPaginator is a paginator for ListFolders

func NewListFoldersPaginator added in v1.42.0 

func NewListFoldersPaginator(client ListFoldersAPIClient, params *ListFoldersInput, optFns ...func(*ListFoldersPaginatorOptions)) *ListFoldersPaginator

NewListFoldersPaginator returns a new ListFoldersPaginator

func (*ListFoldersPaginator) HasMorePages added in v1.42.0 

func (p *ListFoldersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListFoldersPaginator) NextPage added in v1.42.0 

func (p *ListFoldersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListFoldersOutput, error)

NextPage retrieves the next ListFolders page.

type ListFoldersPaginatorOptions added in v1.42.0 

type ListFoldersPaginatorOptions 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
}

ListFoldersPaginatorOptions is the paginator options for ListFolders

type ListGroupMembershipsAPIClient added in v1.39.0 

type ListGroupMembershipsAPIClient interface {
	ListGroupMemberships(context.Context, *ListGroupMembershipsInput, ...func(*Options)) (*ListGroupMembershipsOutput, error)
}

ListGroupMembershipsAPIClient is a client that implements the ListGroupMemberships operation.

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 of the group that you want a list of users from.
	//
	// 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 ListGroupMembershipsPaginator added in v1.39.0 

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

ListGroupMembershipsPaginator is a paginator for ListGroupMemberships

func NewListGroupMembershipsPaginator added in v1.39.0 

func NewListGroupMembershipsPaginator(client ListGroupMembershipsAPIClient, params *ListGroupMembershipsInput, optFns ...func(*ListGroupMembershipsPaginatorOptions)) *ListGroupMembershipsPaginator

NewListGroupMembershipsPaginator returns a new ListGroupMembershipsPaginator

func (*ListGroupMembershipsPaginator) HasMorePages added in v1.39.0 

func (p *ListGroupMembershipsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListGroupMembershipsPaginator) NextPage added in v1.39.0 

func (p *ListGroupMembershipsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListGroupMembershipsOutput, error)

NextPage retrieves the next ListGroupMemberships page.

type ListGroupMembershipsPaginatorOptions added in v1.39.0 

type ListGroupMembershipsPaginatorOptions struct {
	// The maximum number of results to return from this 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
}

ListGroupMembershipsPaginatorOptions is the paginator options for ListGroupMemberships

type ListGroupsAPIClient added in v1.39.0 

type ListGroupsAPIClient interface {
	ListGroups(context.Context, *ListGroupsInput, ...func(*Options)) (*ListGroupsOutput, error)
}

ListGroupsAPIClient is a client that implements the ListGroups operation.

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 that you want a list of groups from.
	//
	// 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 ListGroupsPaginator added in v1.39.0 

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

ListGroupsPaginator is a paginator for ListGroups

func NewListGroupsPaginator added in v1.39.0 

func NewListGroupsPaginator(client ListGroupsAPIClient, params *ListGroupsInput, optFns ...func(*ListGroupsPaginatorOptions)) *ListGroupsPaginator

NewListGroupsPaginator returns a new ListGroupsPaginator

func (*ListGroupsPaginator) HasMorePages added in v1.39.0 

func (p *ListGroupsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListGroupsPaginator) NextPage added in v1.39.0 

func (p *ListGroupsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListGroupsOutput, error)

NextPage retrieves the next ListGroups page.

type ListGroupsPaginatorOptions added in v1.39.0 

type ListGroupsPaginatorOptions 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
}

ListGroupsPaginatorOptions is the paginator options for ListGroups

type ListIAMPolicyAssignmentsAPIClient added in v1.39.0 

type ListIAMPolicyAssignmentsAPIClient interface {
	ListIAMPolicyAssignments(context.Context, *ListIAMPolicyAssignmentsInput, ...func(*Options)) (*ListIAMPolicyAssignmentsOutput, error)
}

ListIAMPolicyAssignmentsAPIClient is a client that implements the ListIAMPolicyAssignments operation.

type ListIAMPolicyAssignmentsForUserAPIClient added in v1.39.0 

type ListIAMPolicyAssignmentsForUserAPIClient interface {
	ListIAMPolicyAssignmentsForUser(context.Context, *ListIAMPolicyAssignmentsForUserInput, ...func(*Options)) (*ListIAMPolicyAssignmentsForUserOutput, error)
}

ListIAMPolicyAssignmentsForUserAPIClient is a client that implements the ListIAMPolicyAssignmentsForUser operation.

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 ListIAMPolicyAssignmentsForUserPaginator added in v1.39.0 

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

ListIAMPolicyAssignmentsForUserPaginator is a paginator for ListIAMPolicyAssignmentsForUser

func NewListIAMPolicyAssignmentsForUserPaginator added in v1.39.0 

func NewListIAMPolicyAssignmentsForUserPaginator(client ListIAMPolicyAssignmentsForUserAPIClient, params *ListIAMPolicyAssignmentsForUserInput, optFns ...func(*ListIAMPolicyAssignmentsForUserPaginatorOptions)) *ListIAMPolicyAssignmentsForUserPaginator

NewListIAMPolicyAssignmentsForUserPaginator returns a new ListIAMPolicyAssignmentsForUserPaginator

func (*ListIAMPolicyAssignmentsForUserPaginator) HasMorePages added in v1.39.0 

func (p *ListIAMPolicyAssignmentsForUserPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListIAMPolicyAssignmentsForUserPaginator) NextPage added in v1.39.0 

func (p *ListIAMPolicyAssignmentsForUserPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListIAMPolicyAssignmentsForUserOutput, error)

NextPage retrieves the next ListIAMPolicyAssignmentsForUser page.

type ListIAMPolicyAssignmentsForUserPaginatorOptions added in v1.39.0 

type ListIAMPolicyAssignmentsForUserPaginatorOptions 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
}

ListIAMPolicyAssignmentsForUserPaginatorOptions is the paginator options for ListIAMPolicyAssignmentsForUser

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 ListIAMPolicyAssignmentsPaginator added in v1.39.0 

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

ListIAMPolicyAssignmentsPaginator is a paginator for ListIAMPolicyAssignments

func NewListIAMPolicyAssignmentsPaginator added in v1.39.0 

func NewListIAMPolicyAssignmentsPaginator(client ListIAMPolicyAssignmentsAPIClient, params *ListIAMPolicyAssignmentsInput, optFns ...func(*ListIAMPolicyAssignmentsPaginatorOptions)) *ListIAMPolicyAssignmentsPaginator

NewListIAMPolicyAssignmentsPaginator returns a new ListIAMPolicyAssignmentsPaginator

func (*ListIAMPolicyAssignmentsPaginator) HasMorePages added in v1.39.0 

func (p *ListIAMPolicyAssignmentsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListIAMPolicyAssignmentsPaginator) NextPage added in v1.39.0 

func (p *ListIAMPolicyAssignmentsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListIAMPolicyAssignmentsOutput, error)

NextPage retrieves the next ListIAMPolicyAssignments page.

type ListIAMPolicyAssignmentsPaginatorOptions added in v1.39.0 

type ListIAMPolicyAssignmentsPaginatorOptions 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
}

ListIAMPolicyAssignmentsPaginatorOptions is the paginator options for ListIAMPolicyAssignments

type ListIdentityPropagationConfigsInput added in v1.52.0 

type ListIdentityPropagationConfigsInput struct {

	// The ID of the Amazon Web Services account that contain the identity propagation
	// configurations of.
	//
	// This member is required.
	AwsAccountId *string

	// The maximum number of results to be returned.
	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 ListIdentityPropagationConfigsOutput added in v1.52.0 

type ListIdentityPropagationConfigsOutput 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

	// A list of services and their authorized targets that the Amazon QuickSight IAM
	// Identity Center application can access.
	Services []types.AuthorizedTargetsByService

	// 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 unique pagination token that can be used in a subsequent request. You will
	// receive a pagination token in the response body of a previous ListNameSpaces
	// API call if there is more data that can be returned. To receive the data, make
	// another ListNamespaces API call with the returned token to retrieve the next
	// page of data. Each token is valid for 24 hours. If you try to make a
	// ListNamespaces API call with an expired token, you will receive a HTTP 400
	// InvalidNextTokenException error.
	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 unique pagination token that can be used in a subsequent request. Receiving
	// NextToken in your response inticates that there is more data that can be
	// returned. To receive the data, make another ListNamespaces API call with the
	// returned token to retrieve the next page of data. Each token is valid for 24
	// hours. If you try to make a ListNamespaces API call with an expired token, you
	// will receive a HTTP 400 InvalidNextTokenException error.
	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 ListRefreshSchedulesInput added in v1.34.0 

type ListRefreshSchedulesInput struct {

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

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

type ListRefreshSchedulesOutput added in v1.34.0 

type ListRefreshSchedulesOutput struct {

	// The list of refresh schedules for the dataset.
	RefreshSchedules []types.RefreshSchedule

	// 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 ListRoleMembershipsAPIClient added in v1.51.0 

type ListRoleMembershipsAPIClient interface {
	ListRoleMemberships(context.Context, *ListRoleMembershipsInput, ...func(*Options)) (*ListRoleMembershipsOutput, error)
}

ListRoleMembershipsAPIClient is a client that implements the ListRoleMemberships operation.

type ListRoleMembershipsInput added in v1.51.0 

type ListRoleMembershipsInput struct {

	// The ID for the Amazon Web Services account that you want to create a group in.
	// The Amazon Web Services account ID that you provide must be the same Amazon Web
	// Services account that contains your Amazon QuickSight account.
	//
	// This member is required.
	AwsAccountId *string

	// The namespace that includes the role.
	//
	// This member is required.
	Namespace *string

	// The name of the role.
	//
	// This member is required.
	Role types.Role

	// 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 ListRoleMembershipsOutput added in v1.51.0 

type ListRoleMembershipsOutput struct {

	// The list of groups associated with a role
	MembersList []string

	// 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 ListRoleMembershipsPaginator added in v1.51.0 

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

ListRoleMembershipsPaginator is a paginator for ListRoleMemberships

func NewListRoleMembershipsPaginator added in v1.51.0 

func NewListRoleMembershipsPaginator(client ListRoleMembershipsAPIClient, params *ListRoleMembershipsInput, optFns ...func(*ListRoleMembershipsPaginatorOptions)) *ListRoleMembershipsPaginator

NewListRoleMembershipsPaginator returns a new ListRoleMembershipsPaginator

func (*ListRoleMembershipsPaginator) HasMorePages added in v1.51.0 

func (p *ListRoleMembershipsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListRoleMembershipsPaginator) NextPage added in v1.51.0 

func (p *ListRoleMembershipsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListRoleMembershipsOutput, error)

NextPage retrieves the next ListRoleMemberships page.

type ListRoleMembershipsPaginatorOptions added in v1.51.0 

type ListRoleMembershipsPaginatorOptions 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
}

ListRoleMembershipsPaginatorOptions is the paginator options for ListRoleMemberships

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 ListTopicRefreshSchedulesInput added in v1.35.0 

type ListTopicRefreshSchedulesInput struct {

	// The ID of the Amazon Web Services account that contains the topic whose refresh
	// schedule you want described.
	//
	// This member is required.
	AwsAccountId *string

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

type ListTopicRefreshSchedulesOutput added in v1.35.0 

type ListTopicRefreshSchedulesOutput struct {

	// The list of topic refresh schedules.
	RefreshSchedules []types.TopicRefreshScheduleSummary

	// 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 topic.
	TopicArn *string

	// The ID for the topic that you want to describe. This ID is unique per Amazon
	// Web Services Region for each Amazon Web Services account.
	TopicId *string

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

type ListTopicReviewedAnswersInput added in v1.68.0 

type ListTopicReviewedAnswersInput struct {

	// The ID of the Amazon Web Services account that containd the reviewed answers
	// that you want listed.
	//
	// This member is required.
	AwsAccountId *string

	// The ID for the topic that contains the reviewed answer that you want to list.
	// This ID is unique per Amazon Web Services Region for each Amazon Web Services
	// account.
	//
	// This member is required.
	TopicId *string
	// contains filtered or unexported fields
}

type ListTopicReviewedAnswersOutput added in v1.68.0 

type ListTopicReviewedAnswersOutput struct {

	// The definition of all Answers in the topic.
	Answers []types.TopicReviewedAnswer

	// 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 topic.
	TopicArn *string

	// The ID for the topic that contains the reviewed answer that you want to list.
	// This ID is unique per Amazon Web Services Region for each Amazon Web Services
	// account.
	TopicId *string

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

type ListTopicsAPIClient added in v1.35.0 

type ListTopicsAPIClient interface {
	ListTopics(context.Context, *ListTopicsInput, ...func(*Options)) (*ListTopicsOutput, error)
}

ListTopicsAPIClient is a client that implements the ListTopics operation.

type ListTopicsInput added in v1.35.0 

type ListTopicsInput struct {

	// The ID of the Amazon Web Services account that contains the topics that you
	// want to list.
	//
	// 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 ListTopicsOutput added in v1.35.0 

type ListTopicsOutput 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 list of topic summaries.
	TopicsSummaries []types.TopicSummary

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

type ListTopicsPaginator added in v1.35.0 

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

ListTopicsPaginator is a paginator for ListTopics

func NewListTopicsPaginator added in v1.35.0 

func NewListTopicsPaginator(client ListTopicsAPIClient, params *ListTopicsInput, optFns ...func(*ListTopicsPaginatorOptions)) *ListTopicsPaginator

NewListTopicsPaginator returns a new ListTopicsPaginator

func (*ListTopicsPaginator) HasMorePages added in v1.35.0 

func (p *ListTopicsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTopicsPaginator) NextPage added in v1.35.0 

func (p *ListTopicsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTopicsOutput, error)

NextPage retrieves the next ListTopics page.

type ListTopicsPaginatorOptions added in v1.35.0 

type ListTopicsPaginatorOptions 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
}

ListTopicsPaginatorOptions is the paginator options for ListTopics

type ListUserGroupsAPIClient added in v1.39.0 

type ListUserGroupsAPIClient interface {
	ListUserGroups(context.Context, *ListUserGroupsInput, ...func(*Options)) (*ListUserGroupsOutput, error)
}

ListUserGroupsAPIClient is a client that implements the ListUserGroups operation.

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 ListUserGroupsPaginator added in v1.39.0 

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

ListUserGroupsPaginator is a paginator for ListUserGroups

func NewListUserGroupsPaginator added in v1.39.0 

func NewListUserGroupsPaginator(client ListUserGroupsAPIClient, params *ListUserGroupsInput, optFns ...func(*ListUserGroupsPaginatorOptions)) *ListUserGroupsPaginator

NewListUserGroupsPaginator returns a new ListUserGroupsPaginator

func (*ListUserGroupsPaginator) HasMorePages added in v1.39.0 

func (p *ListUserGroupsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListUserGroupsPaginator) NextPage added in v1.39.0 

func (p *ListUserGroupsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListUserGroupsOutput, error)

NextPage retrieves the next ListUserGroups page.

type ListUserGroupsPaginatorOptions added in v1.39.0 

type ListUserGroupsPaginatorOptions struct {
	// The maximum number of results to return from this 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
}

ListUserGroupsPaginatorOptions is the paginator options for ListUserGroups

type ListUsersAPIClient added in v1.39.0 

type ListUsersAPIClient interface {
	ListUsers(context.Context, *ListUsersInput, ...func(*Options)) (*ListUsersOutput, error)
}

ListUsersAPIClient is a client that implements the ListUsers operation.

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 ListUsersPaginator added in v1.39.0 

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

ListUsersPaginator is a paginator for ListUsers

func NewListUsersPaginator added in v1.39.0 

func NewListUsersPaginator(client ListUsersAPIClient, params *ListUsersInput, optFns ...func(*ListUsersPaginatorOptions)) *ListUsersPaginator

NewListUsersPaginator returns a new ListUsersPaginator

func (*ListUsersPaginator) HasMorePages added in v1.39.0 

func (p *ListUsersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListUsersPaginator) NextPage added in v1.39.0 

func (p *ListUsersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListUsersOutput, error)

NextPage retrieves the next ListUsers page.

type ListUsersPaginatorOptions added in v1.39.0 

type ListUsersPaginatorOptions struct {
	// The maximum number of results to return from this 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
}

ListUsersPaginatorOptions is the paginator options for ListUsers

type ListVPCConnectionsAPIClient added in v1.35.0 

type ListVPCConnectionsAPIClient interface {
	ListVPCConnections(context.Context, *ListVPCConnectionsInput, ...func(*Options)) (*ListVPCConnectionsOutput, error)
}

ListVPCConnectionsAPIClient is a client that implements the ListVPCConnections operation.

type ListVPCConnectionsInput added in v1.35.0 

type ListVPCConnectionsInput struct {

	// The Amazon Web Services account ID of the account that contains the VPC
	// connections that you want to list.
	//
	// 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 ListVPCConnectionsOutput added in v1.35.0 

type ListVPCConnectionsOutput 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 VPCConnectionSummaries object that returns a summary of VPC connection
	// objects.
	VPCConnectionSummaries []types.VPCConnectionSummary

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

type ListVPCConnectionsPaginator added in v1.35.0 

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

ListVPCConnectionsPaginator is a paginator for ListVPCConnections

func NewListVPCConnectionsPaginator added in v1.35.0 

func NewListVPCConnectionsPaginator(client ListVPCConnectionsAPIClient, params *ListVPCConnectionsInput, optFns ...func(*ListVPCConnectionsPaginatorOptions)) *ListVPCConnectionsPaginator

NewListVPCConnectionsPaginator returns a new ListVPCConnectionsPaginator

func (*ListVPCConnectionsPaginator) HasMorePages added in v1.35.0 

func (p *ListVPCConnectionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListVPCConnectionsPaginator) NextPage added in v1.35.0 

func (p *ListVPCConnectionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListVPCConnectionsOutput, error)

NextPage retrieves the next ListVPCConnections page.

type ListVPCConnectionsPaginatorOptions added in v1.35.0 

type ListVPCConnectionsPaginatorOptions 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
}

ListVPCConnectionsPaginatorOptions is the paginator options for ListVPCConnections

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

	// The optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// 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.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint.
	//
	// To migrate an EndpointResolver implementation that uses a custom endpoint, set
	// the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The client meter provider.
	MeterProvider metrics.MeterProvider

	// 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.
	//
	// 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 client tracer provider.
	TracerProvider tracing.TracerProvider

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy 

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetIdentityResolver added in v1.50.2 

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type PutDataSetRefreshPropertiesInput added in v1.34.0 

type PutDataSetRefreshPropertiesInput struct {

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

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

	// The dataset refresh properties.
	//
	// This member is required.
	DataSetRefreshProperties *types.DataSetRefreshProperties
	// contains filtered or unexported fields
}

type PutDataSetRefreshPropertiesOutput added in v1.34.0 

type PutDataSetRefreshPropertiesOutput 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 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

	// The identity type that your Amazon QuickSight account uses to manage the
	// identity of users.
	//
	// 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.
	//
	//   - READER_PRO : Reader Pro adds Generative BI capabilities to the Reader role.
	//   Reader Pros have access to Amazon Q in Amazon QuickSight, can build stories with
	//   Amazon Q, and can generate executive summaries from dashboards.
	//
	//   - AUTHOR_PRO : Author Pro adds Generative BI capabilities to the Author role.
	//   Author Pros can author dashboards with natural language with Amazon Q, build
	//   stories with Amazon Q, create Topics for Q&A, and generate executive summaries
	//   from dashboards.
	//
	//   - ADMIN_PRO : Admin Pros are Author Pros who can also manage Amazon QuickSight
	//   administrative settings. Admin Pro users are billed at Author Pro pricing.
	//
	//   - 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] 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 Amazon 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, admin pro, author pro, reader pro).
	//
	// This feature is available only to Amazon QuickSight Enterprise edition
	// subscriptions.
	//
	// [UpdateUser]: https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateUser.html
	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]assume-role in the CLI Reference.
	//
	// [assume-role]: https://docs.aws.amazon.com/cli/latest/reference/sts/assume-role.html
	SessionName *string

	// The tags to associate with the user.
	Tags []types.Tag

	// 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

	// A boolean value that determines if the analysis will be restored to folders
	// that it previously resided in. A True value restores analysis back to all
	// folders that it previously resided in. A False value restores the analysis but
	// does not restore the analysis back to all previously resided folders. Restoring
	// a restricted analysis requires this parameter to be set to True .
	RestoreToFolders bool
	// 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

	// A list of folder arns thatthe analysis failed to be restored to.
	RestorationFailedFolderArns []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 SearchDataSetsAPIClient added in v1.27.0 

type SearchDataSetsAPIClient interface {
	SearchDataSets(context.Context, *SearchDataSetsInput, ...func(*Options)) (*SearchDataSetsOutput, error)
}

SearchDataSetsAPIClient is a client that implements the SearchDataSets operation.

type SearchDataSetsInput added in v1.27.0 

type SearchDataSetsInput struct {

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

	// The filters to apply to the search.
	//
	// This member is required.
	Filters []types.DataSetSearchFilter

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

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

type SearchDataSetsOutput added in v1.27.0 

type SearchDataSetsOutput struct {

	// A DataSetSummaries object that returns a summary of a dataset.
	DataSetSummaries []types.DataSetSummary

	// 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 SearchDataSetsPaginator added in v1.27.0 

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

SearchDataSetsPaginator is a paginator for SearchDataSets

func NewSearchDataSetsPaginator added in v1.27.0 

func NewSearchDataSetsPaginator(client SearchDataSetsAPIClient, params *SearchDataSetsInput, optFns ...func(*SearchDataSetsPaginatorOptions)) *SearchDataSetsPaginator

NewSearchDataSetsPaginator returns a new SearchDataSetsPaginator

func (*SearchDataSetsPaginator) HasMorePages added in v1.27.0 

func (p *SearchDataSetsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*SearchDataSetsPaginator) NextPage added in v1.27.0 

func (p *SearchDataSetsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchDataSetsOutput, error)

NextPage retrieves the next SearchDataSets page.

type SearchDataSetsPaginatorOptions added in v1.27.0 

type SearchDataSetsPaginatorOptions 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
}

SearchDataSetsPaginatorOptions is the paginator options for SearchDataSets

type SearchDataSourcesAPIClient added in v1.27.0 

type SearchDataSourcesAPIClient interface {
	SearchDataSources(context.Context, *SearchDataSourcesInput, ...func(*Options)) (*SearchDataSourcesOutput, error)
}

SearchDataSourcesAPIClient is a client that implements the SearchDataSources operation.

type SearchDataSourcesInput added in v1.27.0 

type SearchDataSourcesInput struct {

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

	// The filters to apply to the search.
	//
	// This member is required.
	Filters []types.DataSourceSearchFilter

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

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

type SearchDataSourcesOutput added in v1.27.0 

type SearchDataSourcesOutput struct {

	// A DataSourceSummaries object that returns a summary of a data source.
	DataSourceSummaries []types.DataSourceSummary

	// 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 SearchDataSourcesPaginator added in v1.27.0 

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

SearchDataSourcesPaginator is a paginator for SearchDataSources

func NewSearchDataSourcesPaginator added in v1.27.0 

func NewSearchDataSourcesPaginator(client SearchDataSourcesAPIClient, params *SearchDataSourcesInput, optFns ...func(*SearchDataSourcesPaginatorOptions)) *SearchDataSourcesPaginator

NewSearchDataSourcesPaginator returns a new SearchDataSourcesPaginator

func (*SearchDataSourcesPaginator) HasMorePages added in v1.27.0 

func (p *SearchDataSourcesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*SearchDataSourcesPaginator) NextPage added in v1.27.0 

func (p *SearchDataSourcesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchDataSourcesOutput, error)

NextPage retrieves the next SearchDataSources page.

type SearchDataSourcesPaginatorOptions added in v1.27.0 

type SearchDataSourcesPaginatorOptions 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
}

SearchDataSourcesPaginatorOptions is the paginator options for SearchDataSources

type SearchFoldersAPIClient added in v1.42.0 

type SearchFoldersAPIClient interface {
	SearchFolders(context.Context, *SearchFoldersInput, ...func(*Options)) (*SearchFoldersOutput, error)
}

SearchFoldersAPIClient is a client that implements the SearchFolders operation.

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 SearchFoldersPaginator added in v1.42.0 

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

SearchFoldersPaginator is a paginator for SearchFolders

func NewSearchFoldersPaginator added in v1.42.0 

func NewSearchFoldersPaginator(client SearchFoldersAPIClient, params *SearchFoldersInput, optFns ...func(*SearchFoldersPaginatorOptions)) *SearchFoldersPaginator

NewSearchFoldersPaginator returns a new SearchFoldersPaginator

func (*SearchFoldersPaginator) HasMorePages added in v1.42.0 

func (p *SearchFoldersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*SearchFoldersPaginator) NextPage added in v1.42.0 

func (p *SearchFoldersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchFoldersOutput, error)

NextPage retrieves the next SearchFolders page.

type SearchFoldersPaginatorOptions added in v1.42.0 

type SearchFoldersPaginatorOptions 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
}

SearchFoldersPaginatorOptions is the paginator options for SearchFolders

type SearchGroupsAPIClient added in v1.39.0 

type SearchGroupsAPIClient interface {
	SearchGroups(context.Context, *SearchGroupsInput, ...func(*Options)) (*SearchGroupsOutput, error)
}

SearchGroupsAPIClient is a client that implements the SearchGroups operation.

type SearchGroupsInput added in v1.21.0 

type SearchGroupsInput 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 structure for the search filters that you want to apply to your search.
	//
	// This member is required.
	Filters []types.GroupSearchFilter

	// The namespace that you want to search.
	//
	// 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 SearchGroupsOutput added in v1.21.0 

type SearchGroupsOutput struct {

	// A list of groups in a specified namespace that match the filters you set in
	// your SearchGroups request.
	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 SearchGroupsPaginator added in v1.39.0 

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

SearchGroupsPaginator is a paginator for SearchGroups

func NewSearchGroupsPaginator added in v1.39.0 

func NewSearchGroupsPaginator(client SearchGroupsAPIClient, params *SearchGroupsInput, optFns ...func(*SearchGroupsPaginatorOptions)) *SearchGroupsPaginator

NewSearchGroupsPaginator returns a new SearchGroupsPaginator

func (*SearchGroupsPaginator) HasMorePages added in v1.39.0 

func (p *SearchGroupsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*SearchGroupsPaginator) NextPage added in v1.39.0 

func (p *SearchGroupsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchGroupsOutput, error)

NextPage retrieves the next SearchGroups page.

type SearchGroupsPaginatorOptions added in v1.39.0 

type SearchGroupsPaginatorOptions struct {
	// The maximum number of results to return from this 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
}

SearchGroupsPaginatorOptions is the paginator options for SearchGroups

type StartAssetBundleExportJobInput added in v1.36.0 

type StartAssetBundleExportJobInput struct {

	// The ID of the job. This ID is unique while the job is running. After the job is
	// completed, you can reuse this ID for another job.
	//
	// This member is required.
	AssetBundleExportJobId *string

	// The ID of the Amazon Web Services account to export assets from.
	//
	// This member is required.
	AwsAccountId *string

	// The export data format.
	//
	// This member is required.
	ExportFormat types.AssetBundleExportFormat

	// An array of resource ARNs to export. The following resources are supported.
	//
	//   - Analysis
	//
	//   - Dashboard
	//
	//   - DataSet
	//
	//   - DataSource
	//
	//   - RefreshSchedule
	//
	//   - Theme
	//
	//   - VPCConnection
	//
	// The API caller must have the necessary permissions in their IAM role to access
	// each resource before the resources can be exported.
	//
	// This member is required.
	ResourceArns []string

	// An optional collection of structures that generate CloudFormation parameters to
	// override the existing resource property values when the resource is exported to
	// a new CloudFormation template.
	//
	// Use this field if the ExportFormat field of a StartAssetBundleExportJobRequest
	// API call is set to CLOUDFORMATION_JSON .
	CloudFormationOverridePropertyConfiguration *types.AssetBundleCloudFormationOverridePropertyConfiguration

	// A Boolean that determines whether all dependencies of each resource ARN are
	// recursively exported with the job. For example, say you provided a Dashboard ARN
	// to the ResourceArns parameter. If you set IncludeAllDependencies to TRUE , any
	// theme, dataset, and data source resource that is a dependency of the dashboard
	// is also exported.
	IncludeAllDependencies bool

	// A setting that indicates whether you want to include folder assets. You can
	// also use this setting to recusrsively include all subfolders of an exported
	// folder.
	IncludeFolderMembers types.IncludeFolderMembers

	// A Boolean that determines if the exported asset carries over information about
	// the folders that the asset is a member of.
	IncludeFolderMemberships bool

	// A Boolean that determines whether all permissions for each resource ARN are
	// exported with the job. If you set IncludePermissions to TRUE , any permissions
	// associated with each resource are exported.
	IncludePermissions bool

	//  A Boolean that determines whether all tags for each resource ARN are exported
	// with the job. If you set IncludeTags to TRUE , any tags associated with each
	// resource are exported.
	IncludeTags bool

	// An optional parameter that determines which validation strategy to use for the
	// export job. If StrictModeForAllResources is set to TRUE , strict validation for
	// every error is enforced. If it is set to FALSE , validation is skipped for
	// specific UI errors that are shown as warnings. The default value for
	// StrictModeForAllResources is FALSE .
	ValidationStrategy *types.AssetBundleExportJobValidationStrategy
	// contains filtered or unexported fields
}

type StartAssetBundleExportJobOutput added in v1.36.0 

type StartAssetBundleExportJobOutput struct {

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

	// The ID of the job. This ID is unique while the job is running. After the job is
	// completed, you can reuse this ID for another job.
	AssetBundleExportJobId *string

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

	// The HTTP status of the response.
	Status int32

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

type StartAssetBundleImportJobInput added in v1.36.0 

type StartAssetBundleImportJobInput struct {

	// The ID of the job. This ID is unique while the job is running. After the job is
	// completed, you can reuse this ID for another job.
	//
	// This member is required.
	AssetBundleImportJobId *string

	// The source of the asset bundle zip file that contains the data that you want to
	// import. The file must be in QUICKSIGHT_JSON format.
	//
	// This member is required.
	AssetBundleImportSource *types.AssetBundleImportSource

	// The ID of the Amazon Web Services account to import assets into.
	//
	// This member is required.
	AwsAccountId *string

	// The failure action for the import job.
	//
	// If you choose ROLLBACK , failed import jobs will attempt to undo any asset
	// changes caused by the failed job.
	//
	// If you choose DO_NOTHING , failed import jobs will not attempt to roll back any
	// asset changes caused by the failed job, possibly keeping the Amazon QuickSight
	// account in an inconsistent state.
	FailureAction types.AssetBundleImportFailureAction

	// Optional overrides that are applied to the resource configuration before import.
	OverrideParameters *types.AssetBundleImportJobOverrideParameters

	// Optional permission overrides that are applied to the resource configuration
	// before import.
	OverridePermissions *types.AssetBundleImportJobOverridePermissions

	// Optional tag overrides that are applied to the resource configuration before
	// import.
	OverrideTags *types.AssetBundleImportJobOverrideTags

	// An optional validation strategy override for all analyses and dashboards that
	// is applied to the resource configuration before import.
	OverrideValidationStrategy *types.AssetBundleImportJobOverrideValidationStrategy
	// contains filtered or unexported fields
}

type StartAssetBundleImportJobOutput added in v1.36.0 

type StartAssetBundleImportJobOutput struct {

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

	// The ID of the job. This ID is unique while the job is running. After the job is
	// completed, you can reuse this ID for another job.
	AssetBundleImportJobId *string

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

	// The HTTP status of the response.
	Status int32

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

type StartDashboardSnapshotJobInput added in v1.39.0 

type StartDashboardSnapshotJobInput struct {

	// The ID of the Amazon Web Services account that the dashboard snapshot job is
	// executed in.
	//
	// This member is required.
	AwsAccountId *string

	// The ID of the dashboard that you want to start a snapshot job for.
	//
	// This member is required.
	DashboardId *string

	// A structure that describes the configuration of the dashboard snapshot.
	//
	// This member is required.
	SnapshotConfiguration *types.SnapshotConfiguration

	// An ID for the dashboard snapshot job. This ID is unique to the dashboard while
	// the job is running. This ID can be used to poll the status of a job with a
	// DescribeDashboardSnapshotJob while the job runs. You can reuse this ID for
	// another job 24 hours after the current job is completed.
	//
	// This member is required.
	SnapshotJobId *string

	//  A structure that contains information about the anonymous users that the
	// generated snapshot is for. This API will not return information about registered
	// Amazon QuickSight.
	//
	// This member is required.
	UserConfiguration *types.SnapshotUserConfiguration
	// contains filtered or unexported fields
}

type StartDashboardSnapshotJobOutput added in v1.39.0 

type StartDashboardSnapshotJobOutput struct {

	// The Amazon Resource Name (ARN) for the dashboard snapshot job.
	Arn *string

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

	// The ID of the job. The job ID is set when you start a new job with a
	// StartDashboardSnapshotJob API call.
	SnapshotJobId *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 StartDashboardSnapshotJobScheduleInput added in v1.77.0 

type StartDashboardSnapshotJobScheduleInput struct {

	// The ID of the Amazon Web Services account that the dashboard snapshot job is
	// executed in.
	//
	// This member is required.
	AwsAccountId *string

	// The ID of the dashboard that you want to start a snapshot job schedule for.
	//
	// This member is required.
	DashboardId *string

	// The ID of the schedule that you want to start a snapshot job schedule for. The
	// schedule ID can be found in the Amazon QuickSight console in the Schedules pane
	// of the dashboard that the schedule is configured for.
	//
	// This member is required.
	ScheduleId *string
	// contains filtered or unexported fields
}

type StartDashboardSnapshotJobScheduleOutput added in v1.77.0 

type StartDashboardSnapshotJobScheduleOutput 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 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 . IAM users that register for the first time with Amazon
	// QuickSight provide an email address 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

	// A boolean value that determines whether or not an Amazon QuickSight account can
	// be deleted. A True value doesn't allow the account to be deleted and results in
	// an error message if a user tries to make a DeleteAccountSubscription request. A
	// False value will allow the account to be deleted.
	TerminationProtectionEnabled bool
	// 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

	// The definition of an analysis.
	//
	// A definition is the data model of all features in a Dashboard, Template, or
	// Analysis.
	Definition *types.AnalysisDefinition

	// 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 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.
	SourceEntity *types.AnalysisSourceEntity

	// 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

	// The option to relax the validation needed to update an analysis with definition
	// objects. This skips the validation step for specific errors.
	ValidationStrategy *types.ValidationStrategy
	// 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 UpdateBrandAssignmentInput added in v1.79.0 

type UpdateBrandAssignmentInput struct {

	// The ID of the Amazon Web Services account that owns the brand assignment.
	//
	// This member is required.
	AwsAccountId *string

	// The Amazon Resource Name (ARN) of the brand.
	//
	// This member is required.
	BrandArn *string
	// contains filtered or unexported fields
}

type UpdateBrandAssignmentOutput added in v1.79.0 

type UpdateBrandAssignmentOutput struct {

	// The Amazon Resource Name (ARN) of the brand.
	BrandArn *string

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

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

type UpdateBrandInput added in v1.79.0 

type UpdateBrandInput struct {

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

	// The ID of the Amazon QuickSight brand.
	//
	// This member is required.
	BrandId *string

	// The definition of the brand.
	BrandDefinition *types.BrandDefinition
	// contains filtered or unexported fields
}

type UpdateBrandOutput added in v1.79.0 

type UpdateBrandOutput struct {

	// The definition of the brand.
	BrandDefinition *types.BrandDefinition

	// The details of the brand.
	BrandDetail *types.BrandDetail

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

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

type UpdateBrandPublishedVersionInput added in v1.79.0 

type UpdateBrandPublishedVersionInput struct {

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

	// The ID of the Amazon QuickSight brand.
	//
	// This member is required.
	BrandId *string

	// The ID of the published version.
	//
	// This member is required.
	VersionId *string
	// contains filtered or unexported fields
}

type UpdateBrandPublishedVersionOutput added in v1.79.0 

type UpdateBrandPublishedVersionOutput struct {

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

	// The ID of the published version.
	VersionId *string

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

type UpdateCustomPermissionsInput added in v1.79.0 

type UpdateCustomPermissionsInput struct {

	// The ID of the Amazon Web Services account that contains the custom permissions
	// profile that you want to update.
	//
	// This member is required.
	AwsAccountId *string

	// The name of the custom permissions profile that you want to update.
	//
	// This member is required.
	CustomPermissionsName *string

	// A set of actions to include in the custom permissions profile.
	Capabilities *types.Capabilities
	// contains filtered or unexported fields
}

type UpdateCustomPermissionsOutput added in v1.79.0 

type UpdateCustomPermissionsOutput struct {

	// The Amazon Resource Name (ARN) of the custom permissions profile.
	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 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

	// 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 definition of a dashboard.
	//
	// A definition is the data model of all features in a Dashboard, Template, or
	// Analysis.
	Definition *types.DashboardVersionDefinition

	// 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 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]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.
	//
	// [CreateTemplate]: https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CreateTemplate.html
	SourceEntity *types.DashboardSourceEntity

	// 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

	// The option to relax the validation needed to update a dashboard with definition
	// objects. This skips the validation step for specific errors.
	ValidationStrategy *types.ValidationStrategy

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

type UpdateDashboardLinksInput added in v1.54.0 

type UpdateDashboardLinksInput struct {

	// The ID of the Amazon Web Services account that contains the dashboard whose
	// links you want to update.
	//
	// This member is required.
	AwsAccountId *string

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

	//  list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.
	//
	// This member is required.
	LinkEntities []string
	// contains filtered or unexported fields
}

type UpdateDashboardLinksOutput added in v1.54.0 

type UpdateDashboardLinksOutput struct {

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

	// A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.
	LinkEntities []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 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].
	//
	// [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 parameter declarations of the dataset.
	DatasetParameters []types.DatasetParameter

	// 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. Namespace ARNs are not
	// supported Principal values for folder permissions.
	GrantPermissions []types.ResourcePermission

	// The permissions that you want to revoke from a resource. Namespace ARNs are not
	// supported Principal values for folder permissions.
	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 of the group that you want to update.
	//
	// 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. The name must be unique within
	// the 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 UpdateIdentityPropagationConfigInput added in v1.52.0 

type UpdateIdentityPropagationConfigInput struct {

	// The ID of the Amazon Web Services account that contains the identity
	// propagation configuration that you want to update.
	//
	// This member is required.
	AwsAccountId *string

	// The name of the Amazon Web Services service that contains the authorized
	// targets that you want to add or update.
	//
	// This member is required.
	Service types.ServiceType

	// Specifies a list of application ARNs that represent the authorized targets for
	// a service.
	AuthorizedTargets []string
	// contains filtered or unexported fields
}

type UpdateIdentityPropagationConfigOutput added in v1.52.0 

type UpdateIdentityPropagationConfigOutput 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 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

	// A map of allowed VPC endpoint IDs and their corresponding rule descriptions.
	VpcEndpointIdRestrictionRuleMap map[string]string

	// A map of VPC IDs and their corresponding rules. When you configure this
	// parameter, traffic from all VPC endpoints that are present in the specified VPC
	// is allowed.
	VpcIdRestrictionRuleMap 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 UpdateKeyRegistrationInput added in v1.64.0 

type UpdateKeyRegistrationInput struct {

	// The ID of the Amazon Web Services account that contains the customer managed
	// key registration that you want to update.
	//
	// This member is required.
	AwsAccountId *string

	// A list of RegisteredCustomerManagedKey objects to be updated to the Amazon
	// QuickSight account.
	//
	// This member is required.
	KeyRegistration []types.RegisteredCustomerManagedKey
	// contains filtered or unexported fields
}

type UpdateKeyRegistrationOutput added in v1.64.0 

type UpdateKeyRegistrationOutput struct {

	// A list of all customer managed key registrations that failed to update.
	FailedKeyRegistration []types.FailedKeyRegistrationEntry

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

	// A list of all customer managed key registrations that were successfully updated.
	SuccessfulKeyRegistration []types.SuccessfulKeyRegistrationEntry

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

type UpdatePublicSharingSettingsInput added in v1.22.0 

type UpdatePublicSharingSettingsInput struct {

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

	// A Boolean value that indicates whether public sharing is turned on for an
	// Amazon QuickSight account.
	PublicSharingEnabled bool
	// contains filtered or unexported fields
}

type UpdatePublicSharingSettingsOutput added in v1.22.0 

type UpdatePublicSharingSettingsOutput 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 UpdateQPersonalizationConfigurationInput added in v1.74.0 

type UpdateQPersonalizationConfigurationInput struct {

	// The ID of the Amazon Web Services account account that contains the
	// personalization configuration that the user wants to update.
	//
	// This member is required.
	AwsAccountId *string

	// An option to allow Amazon QuickSight to customize data stories with user
	// specific metadata, specifically location and job information, in your IAM
	// Identity Center instance.
	//
	// This member is required.
	PersonalizationMode types.PersonalizationMode
	// contains filtered or unexported fields
}

type UpdateQPersonalizationConfigurationOutput added in v1.74.0 

type UpdateQPersonalizationConfigurationOutput struct {

	// The personalization mode that is used for the personalization configuration.
	PersonalizationMode types.PersonalizationMode

	// 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 UpdateRefreshScheduleInput added in v1.34.0 

type UpdateRefreshScheduleInput struct {

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

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

	// The refresh schedule.
	//
	// This member is required.
	Schedule *types.RefreshSchedule
	// contains filtered or unexported fields
}

type UpdateRefreshScheduleOutput added in v1.34.0 

type UpdateRefreshScheduleOutput struct {

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

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

	// The ID of the refresh schedule.
	ScheduleId *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 UpdateRoleCustomPermissionInput added in v1.51.0 

type UpdateRoleCustomPermissionInput struct {

	// The ID for the Amazon Web Services account that you want to create a group in.
	// The Amazon Web Services account ID that you provide must be the same Amazon Web
	// Services account that contains your Amazon QuickSight account.
	//
	// This member is required.
	AwsAccountId *string

	// The name of the custom permission that you want to update the role with.
	//
	// This member is required.
	CustomPermissionsName *string

	// The namespace that contains the role that you want to update.
	//
	// This member is required.
	Namespace *string

	// The name of role tht you want to update.
	//
	// This member is required.
	Role types.Role
	// contains filtered or unexported fields
}

type UpdateRoleCustomPermissionOutput added in v1.51.0 

type UpdateRoleCustomPermissionOutput 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 UpdateSPICECapacityConfigurationInput added in v1.63.0 

type UpdateSPICECapacityConfigurationInput struct {

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

	// Determines how SPICE capacity can be purchased. The following options are
	// available.
	//
	//   - MANUAL : SPICE capacity can only be purchased manually.
	//
	//   - AUTO_PURCHASE : Extra SPICE capacity is automatically purchased on your
	//   behalf as needed. SPICE capacity can also be purchased manually with this
	//   option.
	//
	// This member is required.
	PurchaseMode types.PurchaseMode
	// contains filtered or unexported fields
}

type UpdateSPICECapacityConfigurationOutput added in v1.63.0 

type UpdateSPICECapacityConfigurationOutput 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 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 ID for the template.
	//
	// This member is required.
	TemplateId *string

	// The definition of a template.
	//
	// A definition is the data model of all features in a Dashboard, Template, or
	// Analysis.
	Definition *types.TemplateVersionDefinition

	// The name for the template.
	Name *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.
	SourceEntity *types.TemplateSourceEntity

	// The option to relax the validation needed to update a template with definition
	// objects. This skips the validation step for specific errors.
	ValidationStrategy *types.ValidationStrategy

	// 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 UpdateTopicInput added in v1.35.0 

type UpdateTopicInput struct {

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

	// The definition of the topic that you want to update.
	//
	// This member is required.
	Topic *types.TopicDetails

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

type UpdateTopicOutput added in v1.35.0 

type UpdateTopicOutput struct {

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

	// The Amazon Resource Name (ARN) of the topic refresh.
	RefreshArn *string

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

	// The HTTP status of the request.
	Status int32

	// The ID of the topic that you want to modify. This ID is unique per Amazon Web
	// Services Region for each Amazon Web Services account.
	TopicId *string

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

type UpdateTopicPermissionsInput added in v1.35.0 

type UpdateTopicPermissionsInput struct {

	// The ID of the Amazon Web Services account that contains the topic that you want
	// to update the permissions for.
	//
	// This member is required.
	AwsAccountId *string

	// The ID of the topic that you want to modify. This ID is unique per Amazon Web
	// Services Region for each Amazon Web Services account.
	//
	// This member is required.
	TopicId *string

	// The resource permissions that you want to grant to the topic.
	GrantPermissions []types.ResourcePermission

	// The resource permissions that you want to revoke from the topic.
	RevokePermissions []types.ResourcePermission
	// contains filtered or unexported fields
}

type UpdateTopicPermissionsOutput added in v1.35.0 

type UpdateTopicPermissionsOutput struct {

	// A list of resource permissions on the topic.
	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 topic.
	TopicArn *string

	// The ID of the topic that you want to modify. This ID is unique per Amazon Web
	// Services Region for each Amazon Web Services account.
	TopicId *string

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

type UpdateTopicRefreshScheduleInput added in v1.35.0 

type UpdateTopicRefreshScheduleInput struct {

	// The ID of the Amazon Web Services account that contains the topic whose refresh
	// schedule you want to update.
	//
	// This member is required.
	AwsAccountId *string

	// The ID of the dataset.
	//
	// This member is required.
	DatasetId *string

	// The definition of a refresh schedule.
	//
	// This member is required.
	RefreshSchedule *types.TopicRefreshSchedule

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

type UpdateTopicRefreshScheduleOutput added in v1.35.0 

type UpdateTopicRefreshScheduleOutput struct {

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

	// 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 topic.
	TopicArn *string

	// The ID of the topic that you want to modify. This ID is unique per Amazon Web
	// Services Region for each Amazon Web Services account.
	TopicId *string

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

type UpdateUserCustomPermissionInput added in v1.79.0 

type UpdateUserCustomPermissionInput struct {

	// The ID of the Amazon Web Services account that contains the custom permission
	// configuration that you want to update.
	//
	// This member is required.
	AwsAccountId *string

	// The name of the custom permissions that you want to update.
	//
	// This member is required.
	CustomPermissionsName *string

	// The namespace that the user belongs to.
	//
	// This member is required.
	Namespace *string

	// The username of the user that you want to update custom permissions for.
	//
	// This member is required.
	UserName *string
	// contains filtered or unexported fields
}

type UpdateUserCustomPermissionOutput added in v1.79.0 

type UpdateUserCustomPermissionOutput 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 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.
	//
	//   - READER_PRO : Reader Pro adds Generative BI capabilities to the Reader role.
	//   Reader Pros have access to Amazon Q in Amazon QuickSight, can build stories with
	//   Amazon Q, and can generate executive summaries from dashboards.
	//
	//   - AUTHOR_PRO : Author Pro adds Generative BI capabilities to the Author role.
	//   Author Pros can author dashboards with natural language with Amazon Q, build
	//   stories with Amazon Q, create Topics for Q&A, and generate executive summaries
	//   from dashboards.
	//
	//   - ADMIN_PRO : Admin Pros are Author Pros who can also manage Amazon QuickSight
	//   administrative settings. Admin Pro users are billed at Author Pro pricing.
	//
	// 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 Amazon 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]API operation to check the external login information.
	//
	// [DescribeUser]: https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeUser.html
	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
}

type UpdateVPCConnectionInput added in v1.35.0 

type UpdateVPCConnectionInput struct {

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

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

	// An IAM role associated with the VPC connection.
	//
	// This member is required.
	RoleArn *string

	// A list of security group IDs for the VPC connection.
	//
	// This member is required.
	SecurityGroupIds []string

	// A list of subnet IDs for the VPC connection.
	//
	// This member is required.
	SubnetIds []string

	// The ID of the VPC connection that you're updating. This ID is a unique
	// identifier for each Amazon Web Services Region in an Amazon Web Services
	// account.
	//
	// This member is required.
	VPCConnectionId *string

	// A list of IP addresses of DNS resolver endpoints for the VPC connection.
	DnsResolvers []string
	// contains filtered or unexported fields
}

type UpdateVPCConnectionOutput added in v1.35.0 

type UpdateVPCConnectionOutput struct {

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

	// The availability status of the VPC connection.
	AvailabilityStatus types.VPCConnectionAvailabilityStatus

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

	// The HTTP status of the request.
	Status int32

	// The update status of the VPC connection's last update.
	UpdateStatus types.VPCConnectionResourceStatus

	// The ID of the VPC connection that you are updating. This ID is a unique
	// identifier for each Amazon Web Services Region in anAmazon Web Services account.
	VPCConnectionId *string

	// 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.