Struct aws_sdk_quicksight::Client

pub struct Client { /* private fields */ }

Client for Amazon QuickSight

Client for invoking operations on Amazon QuickSight. Each operation on Amazon QuickSight is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_quicksight::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Config struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_quicksight::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the CancelIngestion operation has a Client::cancel_ingestion, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.cancel_ingestion()
    .aws_account_id("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn cancel_ingestion(&self) -> CancelIngestionFluentBuilder

Constructs a fluent builder for the CancelIngestion operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID.

    
    
  • data_set_id(impl Into<String>) / set_data_set_id(Option<String>):
    required: true
    

    The ID of the dataset used in the ingestion.

    
    
  • ingestion_id(impl Into<String>) / set_ingestion_id(Option<String>):
    required: true
    

    An ID for the ingestion.

    
    
• On success, responds with CancelIngestionOutput with field(s):
  • arn(Option<String>):

    The Amazon Resource Name (ARN) for the data ingestion.

  • ingestion_id(Option<String>):

    An ID for the ingestion.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<CancelIngestionError>

impl Client

pub fn create_account_customization( &self ) -> CreateAccountCustomizationFluentBuilder

Constructs a fluent builder for the CreateAccountCustomization operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID for the Amazon Web Services account that you want to customize Amazon QuickSight for.

    
    
  • namespace(impl Into<String>) / set_namespace(Option<String>):
    required: false
    

    The Amazon QuickSight namespace that you want to add customizations to.

    
    
  • account_customization(AccountCustomization) / set_account_customization(Option<AccountCustomization>):
    required: true
    

    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” }.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    A list of the tags that you want to attach to this resource.

    
    
• On success, responds with CreateAccountCustomizationOutput with field(s):
  • arn(Option<String>):

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

  • aws_account_id(Option<String>):

    The ID for the Amazon Web Services account that you want to customize Amazon QuickSight for.

  • namespace(Option<String>):

    The namespace associated with the customization you’re creating.

  • account_customization(Option<AccountCustomization>):

    The Amazon QuickSight customizations you’re adding in the current Amazon Web Services Region.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<CreateAccountCustomizationError>

impl Client

pub fn create_account_subscription( &self ) -> CreateAccountSubscriptionFluentBuilder

Constructs a fluent builder for the CreateAccountSubscription operation.

• The fluent builder is configurable:
  • edition(Edition) / set_edition(Option<Edition>):
    required: false
    

    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

    
    
  • authentication_method(AuthenticationMethodOption) / set_authentication_method(Option<AuthenticationMethodOption>):
    required: true
    

    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.

    
    
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID of the account that you’re using to create your Amazon QuickSight account.

    
    
  • account_name(impl Into<String>) / set_account_name(Option<String>):
    required: true
    

    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.

    
    
  • notification_email(impl Into<String>) / set_notification_email(Option<String>):
    required: true
    

    The email address that you want Amazon QuickSight to send notifications to regarding your Amazon QuickSight account or Amazon QuickSight subscription.

    
    
  • active_directory_name(impl Into<String>) / set_active_directory_name(Option<String>):
    required: false
    

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

    
    
  • realm(impl Into<String>) / set_realm(Option<String>):
    required: false
    

    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.

    
    
  • directory_id(impl Into<String>) / set_directory_id(Option<String>):
    required: false
    

    The ID of the Active Directory that is associated with your Amazon QuickSight account.

    
    
  • admin_group(impl Into<String>) / set_admin_group(Option<Vec::<String>>):
    required: false
    

    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.

    
    
  • author_group(impl Into<String>) / set_author_group(Option<Vec::<String>>):
    required: false
    

    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.

    
    
  • reader_group(impl Into<String>) / set_reader_group(Option<Vec::<String>>):
    required: false
    

    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.

    
    
  • admin_pro_group(impl Into<String>) / set_admin_pro_group(Option<Vec::<String>>):
    required: false
    

    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.

    
    
  • author_pro_group(impl Into<String>) / set_author_pro_group(Option<Vec::<String>>):
    required: false
    

    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.

    
    
  • reader_pro_group(impl Into<String>) / set_reader_pro_group(Option<Vec::<String>>):
    required: false
    

    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.

    
    
  • first_name(impl Into<String>) / set_first_name(Option<String>):
    required: false
    

    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.

    
    
  • last_name(impl Into<String>) / set_last_name(Option<String>):
    required: false
    

    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.

    
    
  • email_address(impl Into<String>) / set_email_address(Option<String>):
    required: false
    

    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.

    
    
  • contact_number(impl Into<String>) / set_contact_number(Option<String>):
    required: false
    

    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.

    
    
  • iam_identity_center_instance_arn(impl Into<String>) / set_iam_identity_center_instance_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) for the IAM Identity Center instance.

    
    
• On success, responds with CreateAccountSubscriptionOutput with field(s):
  • signup_response(Option<SignupResponse>):

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

  • status(i32):

    The HTTP status of the request.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

• On failure, responds with SdkError<CreateAccountSubscriptionError>

impl Client

pub fn create_analysis(&self) -> CreateAnalysisFluentBuilder

Constructs a fluent builder for the CreateAnalysis operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account where you are creating an analysis.

    
    
  • analysis_id(impl Into<String>) / set_analysis_id(Option<String>):
    required: true
    

    The ID for the analysis that you’re creating. This ID displays in the URL of the analysis.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    A descriptive name for the analysis that you’re creating. This name displays for the analysis in the Amazon QuickSight console.

    
    
  • parameters(Parameters) / set_parameters(Option<Parameters>):
    required: false
    

    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.

    
    
  • permissions(ResourcePermission) / set_permissions(Option<Vec::<ResourcePermission>>):
    required: false
    

    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.

    
    
  • source_entity(AnalysisSourceEntity) / set_source_entity(Option<AnalysisSourceEntity>):
    required: false
    

    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.

    
    
  • theme_arn(impl Into<String>) / set_theme_arn(Option<String>):
    required: false
    

    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.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.

    
    
  • definition(AnalysisDefinition) / set_definition(Option<AnalysisDefinition>):
    required: false
    

    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.

    
    
  • validation_strategy(ValidationStrategy) / set_validation_strategy(Option<ValidationStrategy>):
    required: false
    

    The option to relax the validation needed to create an analysis with definition objects. This skips the validation step for specific errors.

    
    
  • folder_arns(impl Into<String>) / set_folder_arns(Option<Vec::<String>>):
    required: false
    

    When you create the analysis, Amazon QuickSight adds the analysis to these folders.

    
    
• On success, responds with CreateAnalysisOutput with field(s):
  • arn(Option<String>):

    The ARN for the analysis.

  • analysis_id(Option<String>):

    The ID of the analysis.

  • creation_status(Option<ResourceStatus>):

    The status of the creation of the analysis.

  • status(i32):

    The HTTP status of the request.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

• On failure, responds with SdkError<CreateAnalysisError>

impl Client

pub fn create_dashboard(&self) -> CreateDashboardFluentBuilder

Constructs a fluent builder for the CreateDashboard operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account where you want to create the dashboard.

    
    
  • dashboard_id(impl Into<String>) / set_dashboard_id(Option<String>):
    required: true
    

    The ID for the dashboard, also added to the IAM policy.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The display name of the dashboard.

    
    
  • parameters(Parameters) / set_parameters(Option<Parameters>):
    required: false
    

    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.

    
    
  • permissions(ResourcePermission) / set_permissions(Option<Vec::<ResourcePermission>>):
    required: false
    

    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.

    
    
  • source_entity(DashboardSourceEntity) / set_source_entity(Option<DashboardSourceEntity>):
    required: false
    

    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 SourceTemplateARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region.

    Use the DataSetReferences entity within SourceTemplate to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.

    Either a SourceEntity or a Definition must be provided in order for the request to be valid.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.

    
    
  • version_description(impl Into<String>) / set_version_description(Option<String>):
    required: false
    

    A description for the first version of the dashboard being created.

    
    
  • dashboard_publish_options(DashboardPublishOptions) / set_dashboard_publish_options(Option<DashboardPublishOptions>):
    required: false
    

    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.

    
    
  • theme_arn(impl Into<String>) / set_theme_arn(Option<String>):
    required: false
    

    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.

    
    
  • definition(DashboardVersionDefinition) / set_definition(Option<DashboardVersionDefinition>):
    required: false
    

    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.

    
    
  • validation_strategy(ValidationStrategy) / set_validation_strategy(Option<ValidationStrategy>):
    required: false
    

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

    
    
  • folder_arns(impl Into<String>) / set_folder_arns(Option<Vec::<String>>):
    required: false
    

    When you create the dashboard, Amazon QuickSight adds the dashboard to these folders.

    
    
  • link_sharing_configuration(LinkSharingConfiguration) / set_link_sharing_configuration(Option<LinkSharingConfiguration>):
    required: false
    

    A structure that contains the permissions of a shareable link to the dashboard.

    
    
  • link_entities(impl Into<String>) / set_link_entities(Option<Vec::<String>>):
    required: false
    

    A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

    
    
• On success, responds with CreateDashboardOutput with field(s):
  • arn(Option<String>):

    The ARN of the dashboard.

  • version_arn(Option<String>):

    The ARN of the dashboard, including the version number of the first version that is created.

  • dashboard_id(Option<String>):

    The ID for the dashboard.

  • creation_status(Option<ResourceStatus>):

    The status of the dashboard creation request.

  • status(i32):

    The HTTP status of the request.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

• On failure, responds with SdkError<CreateDashboardError>

impl Client

pub fn create_data_set(&self) -> CreateDataSetFluentBuilder

Constructs a fluent builder for the CreateDataSet operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID.

    
    
  • data_set_id(impl Into<String>) / set_data_set_id(Option<String>):
    required: true
    

    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.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The display name for the dataset.

    
    
  • physical_table_map(impl Into<String>, PhysicalTable) / set_physical_table_map(Option<HashMap::<String, PhysicalTable>>):
    required: true
    

    Declares the physical tables that are available in the underlying data sources.

    
    
  • logical_table_map(impl Into<String>, LogicalTable) / set_logical_table_map(Option<HashMap::<String, LogicalTable>>):
    required: false
    

    Configures the combination and transformation of the data from the physical tables.

    
    
  • import_mode(DataSetImportMode) / set_import_mode(Option<DataSetImportMode>):
    required: true
    

    Indicates whether you want to import the data into SPICE.

    
    
  • column_groups(ColumnGroup) / set_column_groups(Option<Vec::<ColumnGroup>>):
    required: false
    

    Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.

    
    
  • field_folders(impl Into<String>, FieldFolder) / set_field_folders(Option<HashMap::<String, FieldFolder>>):
    required: false
    

    The folder that contains fields and nested subfolders for your dataset.

    
    
  • permissions(ResourcePermission) / set_permissions(Option<Vec::<ResourcePermission>>):
    required: false
    

    A list of resource permissions on the dataset.

    
    
  • row_level_permission_data_set(RowLevelPermissionDataSet) / set_row_level_permission_data_set(Option<RowLevelPermissionDataSet>):
    required: false
    

    The row-level security configuration for the data that you want to create.

    
    
  • row_level_permission_tag_configuration(RowLevelPermissionTagConfiguration) / set_row_level_permission_tag_configuration(Option<RowLevelPermissionTagConfiguration>):
    required: false
    

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

    
    
  • column_level_permission_rules(ColumnLevelPermissionRule) / set_column_level_permission_rules(Option<Vec::<ColumnLevelPermissionRule>>):
    required: false
    

    A set of one or more definitions of a ColumnLevelPermissionRule .

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.

    
    
  • data_set_usage_configuration(DataSetUsageConfiguration) / set_data_set_usage_configuration(Option<DataSetUsageConfiguration>):
    required: false
    

    The usage configuration to apply to child datasets that reference this dataset as a source.

    
    
  • dataset_parameters(DatasetParameter) / set_dataset_parameters(Option<Vec::<DatasetParameter>>):
    required: false
    

    The parameter declarations of the dataset.

    
    
  • folder_arns(impl Into<String>) / set_folder_arns(Option<Vec::<String>>):
    required: false
    

    When you create the dataset, Amazon QuickSight adds the dataset to these folders.

    
    
• On success, responds with CreateDataSetOutput with field(s):
  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the dataset.

  • data_set_id(Option<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.

  • ingestion_arn(Option<String>):

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

  • ingestion_id(Option<String>):

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

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<CreateDataSetError>

impl Client

pub fn create_data_source(&self) -> CreateDataSourceFluentBuilder

Constructs a fluent builder for the CreateDataSource operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID.

    
    
  • data_source_id(impl Into<String>) / set_data_source_id(Option<String>):
    required: true
    

    An ID for the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    A display name for the data source.

    
    
  • r#type(DataSourceType) / set_type(Option<DataSourceType>):
    required: true
    

    The type of the data source. To return a list of all data sources, use ListDataSources.

    Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service.

    
    
  • data_source_parameters(DataSourceParameters) / set_data_source_parameters(Option<DataSourceParameters>):
    required: false
    

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

    
    
  • credentials(DataSourceCredentials) / set_credentials(Option<DataSourceCredentials>):
    required: false
    

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

    
    
  • permissions(ResourcePermission) / set_permissions(Option<Vec::<ResourcePermission>>):
    required: false
    

    A list of resource permissions on the data source.

    
    
  • vpc_connection_properties(VpcConnectionProperties) / set_vpc_connection_properties(Option<VpcConnectionProperties>):
    required: false
    

    Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.

    
    
  • ssl_properties(SslProperties) / set_ssl_properties(Option<SslProperties>):
    required: false
    

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

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.

    
    
  • folder_arns(impl Into<String>) / set_folder_arns(Option<Vec::<String>>):
    required: false
    

    When you create the data source, Amazon QuickSight adds the data source to these folders.

    
    
• On success, responds with CreateDataSourceOutput with field(s):
  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the data source.

  • data_source_id(Option<String>):

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

  • creation_status(Option<ResourceStatus>):

    The status of creating the data source.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<CreateDataSourceError>

impl Client

pub fn create_folder(&self) -> CreateFolderFluentBuilder

Constructs a fluent builder for the CreateFolder operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID for the Amazon Web Services account where you want to create the folder.

    
    
  • folder_id(impl Into<String>) / set_folder_id(Option<String>):
    required: true
    

    The ID of the folder.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The name of the folder.

    
    
  • folder_type(FolderType) / set_folder_type(Option<FolderType>):
    required: false
    

    The type of folder. By default, folderType is SHARED.

    
    
  • parent_folder_arn(impl Into<String>) / set_parent_folder_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) for the parent folder.

    ParentFolderArn can be null. An empty parentFolderArn creates a root-level folder.

    
    
  • permissions(ResourcePermission) / set_permissions(Option<Vec::<ResourcePermission>>):
    required: false
    

    A structure that describes the principals and the resource-level permissions of a folder.

    To specify no permissions, omit Permissions.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Tags for the folder.

    
    
  • sharing_model(SharingModel) / set_sharing_model(Option<SharingModel>):
    required: false
    

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

    
    
• On success, responds with CreateFolderOutput with field(s):
  • status(i32):

    The HTTP status of the request.

  • arn(Option<String>):

    The Amazon Resource Name (ARN) for the newly created folder.

  • folder_id(Option<String>):

    The folder ID for the newly created folder.

  • request_id(Option<String>):

    The request ID for the newly created folder.

• On failure, responds with SdkError<CreateFolderError>

impl Client

pub fn create_folder_membership(&self) -> CreateFolderMembershipFluentBuilder

Constructs a fluent builder for the CreateFolderMembership operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID for the Amazon Web Services account that contains the folder.

    
    
  • folder_id(impl Into<String>) / set_folder_id(Option<String>):
    required: true
    

    The ID of the folder.

    
    
  • member_id(impl Into<String>) / set_member_id(Option<String>):
    required: true
    

    The ID of the asset that you want to add to the folder.

    
    
  • member_type(MemberType) / set_member_type(Option<MemberType>):
    required: true
    

    The member type of the asset that you want to add to a folder.

    
    
• On success, responds with CreateFolderMembershipOutput with field(s):
  • status(i32):

    The HTTP status of the request.

  • folder_member(Option<FolderMember>):

    Information about the member in the folder.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

• On failure, responds with SdkError<CreateFolderMembershipError>

impl Client

pub fn create_group(&self) -> CreateGroupFluentBuilder

Constructs a fluent builder for the CreateGroup operation.

• The fluent builder is configurable:
  • group_name(impl Into<String>) / set_group_name(Option<String>):
    required: true
    

    A name for the group that you want to create.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description for the group that you want to create.

    
    
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    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.

    
    
  • namespace(impl Into<String>) / set_namespace(Option<String>):
    required: true
    

    The namespace that you want the group to be a part of.

    
    
• On success, responds with CreateGroupOutput with field(s):
  • group(Option<Group>):

    The name of the group.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<CreateGroupError>

impl Client

pub fn create_group_membership(&self) -> CreateGroupMembershipFluentBuilder

Constructs a fluent builder for the CreateGroupMembership operation.

• The fluent builder is configurable:
  • member_name(impl Into<String>) / set_member_name(Option<String>):
    required: true
    

    The name of the user that you want to add to the group membership.

    
    
  • group_name(impl Into<String>) / set_group_name(Option<String>):
    required: true
    

    The name of the group that you want to add the user to.

    
    
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    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.

    
    
  • namespace(impl Into<String>) / set_namespace(Option<String>):
    required: true
    

    The namespace that you want the user to be a part of.

    
    
• On success, responds with CreateGroupMembershipOutput with field(s):
  • group_member(Option<GroupMember>):

    The group member.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<CreateGroupMembershipError>

impl Client

pub fn create_iam_policy_assignment( &self ) -> CreateIAMPolicyAssignmentFluentBuilder

Constructs a fluent builder for the CreateIAMPolicyAssignment operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account where you want to assign an IAM policy to Amazon QuickSight users or groups.

    
    
  • assignment_name(impl Into<String>) / set_assignment_name(Option<String>):
    required: true
    

    The name of the assignment, also called a rule. The name must be unique within the Amazon Web Services account.

    
    
  • assignment_status(AssignmentStatus) / set_assignment_status(Option<AssignmentStatus>):
    required: true
    

    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.

    
    
  • policy_arn(impl Into<String>) / set_policy_arn(Option<String>):
    required: false
    

    The ARN for the IAM policy to apply to the Amazon QuickSight users and groups specified in this assignment.

    
    
  • identities(impl Into<String>, Vec::<String>) / set_identities(Option<HashMap::<String, Vec::<String>>>):
    required: false
    

    The Amazon QuickSight users, groups, or both that you want to assign the policy to.

    
    
  • namespace(impl Into<String>) / set_namespace(Option<String>):
    required: true
    

    The namespace that contains the assignment.

    
    
• On success, responds with CreateIamPolicyAssignmentOutput with field(s):
  • assignment_name(Option<String>):

    The name of the assignment. The name must be unique within the Amazon Web Services account.

  • assignment_id(Option<String>):

    The ID for the assignment.

  • assignment_status(Option<AssignmentStatus>):

    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.

  • policy_arn(Option<String>):

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

  • identities(Option<HashMap::<String, Vec::<String>>>):

    The Amazon QuickSight users, groups, or both that the IAM policy is assigned to.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<CreateIAMPolicyAssignmentError>

impl Client

pub fn create_ingestion(&self) -> CreateIngestionFluentBuilder

Constructs a fluent builder for the CreateIngestion operation.

• The fluent builder is configurable:
  • data_set_id(impl Into<String>) / set_data_set_id(Option<String>):
    required: true
    

    The ID of the dataset used in the ingestion.

    
    
  • ingestion_id(impl Into<String>) / set_ingestion_id(Option<String>):
    required: true
    

    An ID for the ingestion.

    
    
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID.

    
    
  • ingestion_type(IngestionType) / set_ingestion_type(Option<IngestionType>):
    required: false
    

    The type of ingestion that you want to create.

    
    
• On success, responds with CreateIngestionOutput with field(s):
  • arn(Option<String>):

    The Amazon Resource Name (ARN) for the data ingestion.

  • ingestion_id(Option<String>):

    An ID for the ingestion.

  • ingestion_status(Option<IngestionStatus>):

    The ingestion status.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<CreateIngestionError>

impl Client

pub fn create_namespace(&self) -> CreateNamespaceFluentBuilder

Constructs a fluent builder for the CreateNamespace operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID for the Amazon Web Services account that you want to create the Amazon QuickSight namespace in.

    
    
  • namespace(impl Into<String>) / set_namespace(Option<String>):
    required: true
    

    The name that you want to use to describe the new namespace.

    
    
  • identity_store(IdentityStore) / set_identity_store(Option<IdentityStore>):
    required: true
    

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

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    The tags that you want to associate with the namespace that you’re creating.

    
    
• On success, responds with CreateNamespaceOutput with field(s):
  • arn(Option<String>):

    The ARN of the Amazon QuickSight namespace you created.

  • name(Option<String>):

    The name of the new namespace that you created.

  • capacity_region(Option<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.

  • creation_status(Option<NamespaceStatus>):

    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.

  • identity_store(Option<IdentityStore>):

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

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<CreateNamespaceError>

impl Client

pub fn create_refresh_schedule(&self) -> CreateRefreshScheduleFluentBuilder

Constructs a fluent builder for the CreateRefreshSchedule operation.

• The fluent builder is configurable:
  • data_set_id(impl Into<String>) / set_data_set_id(Option<String>):
    required: true
    

    The ID of the dataset.

    
    
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID.

    
    
  • schedule(RefreshSchedule) / set_schedule(Option<RefreshSchedule>):
    required: true
    

    The refresh schedule.

    
    
• On success, responds with CreateRefreshScheduleOutput with field(s):
  • status(i32):

    The HTTP status of the request.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • schedule_id(Option<String>):

    The ID of the refresh schedule.

  • arn(Option<String>):

    The Amazon Resource Name (ARN) for the refresh schedule.

• On failure, responds with SdkError<CreateRefreshScheduleError>

impl Client

pub fn create_role_membership(&self) -> CreateRoleMembershipFluentBuilder

Constructs a fluent builder for the CreateRoleMembership operation.

• The fluent builder is configurable:
  • member_name(impl Into<String>) / set_member_name(Option<String>):
    required: true
    

    The name of the group that you want to add to the role.

    
    
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    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.

    
    
  • namespace(impl Into<String>) / set_namespace(Option<String>):
    required: true
    

    The namespace that the role belongs to.

    
    
  • role(Role) / set_role(Option<Role>):
    required: true
    

    The role that you want to add a group to.

    
    
• On success, responds with CreateRoleMembershipOutput with field(s):
  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<CreateRoleMembershipError>

impl Client

pub fn create_template(&self) -> CreateTemplateFluentBuilder

Constructs a fluent builder for the CreateTemplate operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    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.

    
    
  • template_id(impl Into<String>) / set_template_id(Option<String>):
    required: true
    

    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.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    A display name for the template.

    
    
  • permissions(ResourcePermission) / set_permissions(Option<Vec::<ResourcePermission>>):
    required: false
    

    A list of resource permissions to be set on the template.

    
    
  • source_entity(TemplateSourceEntity) / set_source_entity(Option<TemplateSourceEntity>):
    required: false
    

    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.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.

    
    
  • version_description(impl Into<String>) / set_version_description(Option<String>):
    required: false
    

    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.

    
    
  • definition(TemplateVersionDefinition) / set_definition(Option<TemplateVersionDefinition>):
    required: false
    

    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.

    
    
  • validation_strategy(ValidationStrategy) / set_validation_strategy(Option<ValidationStrategy>):
    required: false
    

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

    
    
• On success, responds with CreateTemplateOutput with field(s):
  • arn(Option<String>):

    The ARN for the template.

  • version_arn(Option<String>):

    The ARN for the template, including the version information of the first version.

  • template_id(Option<String>):

    The ID of the template.

  • creation_status(Option<ResourceStatus>):

    The template creation status.

  • status(i32):

    The HTTP status of the request.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

• On failure, responds with SdkError<CreateTemplateError>

impl Client

pub fn create_template_alias(&self) -> CreateTemplateAliasFluentBuilder

Constructs a fluent builder for the CreateTemplateAlias operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that contains the template that you creating an alias for.

    
    
  • template_id(impl Into<String>) / set_template_id(Option<String>):
    required: true
    

    An ID for the template.

    
    
  • alias_name(impl Into<String>) / set_alias_name(Option<String>):
    required: true
    

    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.

    
    
  • template_version_number(i64) / set_template_version_number(Option<i64>):
    required: true
    

    The version number of the template.

    
    
• On success, responds with CreateTemplateAliasOutput with field(s):
  • template_alias(Option<TemplateAlias>):

    Information about the template alias.

  • status(i32):

    The HTTP status of the request.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

• On failure, responds with SdkError<CreateTemplateAliasError>

impl Client

pub fn create_theme(&self) -> CreateThemeFluentBuilder

Constructs a fluent builder for the CreateTheme operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account where you want to store the new theme.

    
    
  • theme_id(impl Into<String>) / set_theme_id(Option<String>):
    required: true
    

    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.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    A display name for the theme.

    
    
  • base_theme_id(impl Into<String>) / set_base_theme_id(Option<String>):
    required: true
    

    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.

    
    
  • version_description(impl Into<String>) / set_version_description(Option<String>):
    required: false
    

    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.

    
    
  • configuration(ThemeConfiguration) / set_configuration(Option<ThemeConfiguration>):
    required: true
    

    The theme configuration, which contains the theme display properties.

    
    
  • permissions(ResourcePermission) / set_permissions(Option<Vec::<ResourcePermission>>):
    required: false
    

    A valid grouping of resource permissions to apply to the new theme.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    A map of the key-value pairs for the resource tag or tags that you want to add to the resource.

    
    
• On success, responds with CreateThemeOutput with field(s):
  • arn(Option<String>):

    The Amazon Resource Name (ARN) for the theme.

  • version_arn(Option<String>):

    The Amazon Resource Name (ARN) for the new theme.

  • theme_id(Option<String>):

    The ID of the theme.

  • creation_status(Option<ResourceStatus>):

    The theme creation status.

  • status(i32):

    The HTTP status of the request.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

• On failure, responds with SdkError<CreateThemeError>

impl Client

pub fn create_theme_alias(&self) -> CreateThemeAliasFluentBuilder

Constructs a fluent builder for the CreateThemeAlias operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that contains the theme for the new theme alias.

    
    
  • theme_id(impl Into<String>) / set_theme_id(Option<String>):
    required: true
    

    An ID for the theme alias.

    
    
  • alias_name(impl Into<String>) / set_alias_name(Option<String>):
    required: true
    

    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.

    
    
  • theme_version_number(i64) / set_theme_version_number(Option<i64>):
    required: true
    

    The version number of the theme.

    
    
• On success, responds with CreateThemeAliasOutput with field(s):
  • theme_alias(Option<ThemeAlias>):

    Information about the theme alias.

  • status(i32):

    The HTTP status of the request.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

• On failure, responds with SdkError<CreateThemeAliasError>

impl Client

pub fn create_topic(&self) -> CreateTopicFluentBuilder

Constructs a fluent builder for the CreateTopic operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that you want to create a topic in.

    
    
  • topic_id(impl Into<String>) / set_topic_id(Option<String>):
    required: true
    

    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.

    
    
  • topic(TopicDetails) / set_topic(Option<TopicDetails>):
    required: true
    

    The definition of a topic to create.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Contains a map of the key-value pairs for the resource tag or tags that are assigned to the dataset.

    
    
• On success, responds with CreateTopicOutput with field(s):
  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the topic.

  • topic_id(Option<String>):

    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.

  • refresh_arn(Option<String>):

    The Amazon Resource Name (ARN) of the topic refresh.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<CreateTopicError>

impl Client

pub fn create_topic_refresh_schedule( &self ) -> CreateTopicRefreshScheduleFluentBuilder

Constructs a fluent builder for the CreateTopicRefreshSchedule operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that contains the topic you’re creating a refresh schedule for.

    
    
  • topic_id(impl Into<String>) / set_topic_id(Option<String>):
    required: true
    

    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.

    
    
  • dataset_arn(impl Into<String>) / set_dataset_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the dataset.

    
    
  • dataset_name(impl Into<String>) / set_dataset_name(Option<String>):
    required: false
    

    The name of the dataset.

    
    
  • refresh_schedule(TopicRefreshSchedule) / set_refresh_schedule(Option<TopicRefreshSchedule>):
    required: true
    

    The definition of a refresh schedule.

    
    
• On success, responds with CreateTopicRefreshScheduleOutput with field(s):
  • topic_id(Option<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.

  • topic_arn(Option<String>):

    The Amazon Resource Name (ARN) of the topic.

  • dataset_arn(Option<String>):

    The Amazon Resource Name (ARN) of the dataset.

  • status(i32):

    The HTTP status of the request.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

• On failure, responds with SdkError<CreateTopicRefreshScheduleError>

impl Client

pub fn create_vpc_connection(&self) -> CreateVPCConnectionFluentBuilder

Constructs a fluent builder for the CreateVPCConnection operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID of the account where you want to create a new VPC connection.

    
    
  • vpc_connection_id(impl Into<String>) / set_vpc_connection_id(Option<String>):
    required: true
    

    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.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The display name for the VPC connection.

    
    
  • subnet_ids(impl Into<String>) / set_subnet_ids(Option<Vec::<String>>):
    required: true
    

    A list of subnet IDs for the VPC connection.

    
    
  • security_group_ids(impl Into<String>) / set_security_group_ids(Option<Vec::<String>>):
    required: true
    

    A list of security group IDs for the VPC connection.

    
    
  • dns_resolvers(impl Into<String>) / set_dns_resolvers(Option<Vec::<String>>):
    required: false
    

    A list of IP addresses of DNS resolver endpoints for the VPC connection.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: true
    

    The IAM role to associate with the VPC connection.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    A map of the key-value pairs for the resource tag or tags assigned to the VPC connection.

    
    
• On success, responds with CreateVpcConnectionOutput with field(s):
  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the VPC connection.

  • vpc_connection_id(Option<String>):

    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.

  • creation_status(Option<VpcConnectionResourceStatus>):

    The status of the creation of the VPC connection.

  • availability_status(Option<VpcConnectionAvailabilityStatus>):

    The availability status of the VPC connection.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<CreateVPCConnectionError>

impl Client

pub fn delete_account_customization( &self ) -> DeleteAccountCustomizationFluentBuilder

Constructs a fluent builder for the DeleteAccountCustomization operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID for the Amazon Web Services account that you want to delete Amazon QuickSight customizations from in this Amazon Web Services Region.

    
    
  • namespace(impl Into<String>) / set_namespace(Option<String>):
    required: false
    

    The Amazon QuickSight namespace that you’re deleting the customizations from.

    
    
• On success, responds with DeleteAccountCustomizationOutput with field(s):
  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<DeleteAccountCustomizationError>

impl Client

pub fn delete_account_subscription( &self ) -> DeleteAccountSubscriptionFluentBuilder

Constructs a fluent builder for the DeleteAccountSubscription operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID of the account that you want to delete.

    
    
• On success, responds with DeleteAccountSubscriptionOutput with field(s):
  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<DeleteAccountSubscriptionError>

impl Client

pub fn delete_analysis(&self) -> DeleteAnalysisFluentBuilder

Constructs a fluent builder for the DeleteAnalysis operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account where you want to delete an analysis.

    
    
  • analysis_id(impl Into<String>) / set_analysis_id(Option<String>):
    required: true
    

    The ID of the analysis that you’re deleting.

    
    
  • recovery_window_in_days(i64) / set_recovery_window_in_days(Option<i64>):
    required: false
    

    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.

    
    
  • force_delete_without_recovery(bool) / set_force_delete_without_recovery(Option<bool>):
    required: false
    

    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.

    
    
• On success, responds with DeleteAnalysisOutput with field(s):
  • status(i32):

    The HTTP status of the request.

  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the deleted analysis.

  • analysis_id(Option<String>):

    The ID of the deleted analysis.

  • deletion_time(Option<DateTime>):

    The date and time that the analysis is scheduled to be deleted.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

• On failure, responds with SdkError<DeleteAnalysisError>

impl Client

pub fn delete_dashboard(&self) -> DeleteDashboardFluentBuilder

Constructs a fluent builder for the DeleteDashboard operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that contains the dashboard that you’re deleting.

    
    
  • dashboard_id(impl Into<String>) / set_dashboard_id(Option<String>):
    required: true
    

    The ID for the dashboard.

    
    
  • version_number(i64) / set_version_number(Option<i64>):
    required: false
    

    The version number of the dashboard. If the version number property is provided, only the specified version of the dashboard is deleted.

    
    
• On success, responds with DeleteDashboardOutput with field(s):
  • status(i32):

    The HTTP status of the request.

  • arn(Option<String>):

    The Secure Socket Layer (SSL) properties that apply for the resource.

  • dashboard_id(Option<String>):

    The ID of the dashboard.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

• On failure, responds with SdkError<DeleteDashboardError>

impl Client

pub fn delete_data_set(&self) -> DeleteDataSetFluentBuilder

Constructs a fluent builder for the DeleteDataSet operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID.

    
    
  • data_set_id(impl Into<String>) / set_data_set_id(Option<String>):
    required: true
    

    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.

    
    
• On success, responds with DeleteDataSetOutput with field(s):
  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the dataset.

  • data_set_id(Option<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.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<DeleteDataSetError>

impl Client

pub fn delete_data_set_refresh_properties( &self ) -> DeleteDataSetRefreshPropertiesFluentBuilder

Constructs a fluent builder for the DeleteDataSetRefreshProperties operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID.

    
    
  • data_set_id(impl Into<String>) / set_data_set_id(Option<String>):
    required: true
    

    The ID of the dataset.

    
    
• On success, responds with DeleteDataSetRefreshPropertiesOutput with field(s):
  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<DeleteDataSetRefreshPropertiesError>

impl Client

pub fn delete_data_source(&self) -> DeleteDataSourceFluentBuilder

Constructs a fluent builder for the DeleteDataSource operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID.

    
    
  • data_source_id(impl Into<String>) / set_data_source_id(Option<String>):
    required: true
    

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

    
    
• On success, responds with DeleteDataSourceOutput with field(s):
  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the data source that you deleted.

  • data_source_id(Option<String>):

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

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<DeleteDataSourceError>

impl Client

pub fn delete_folder(&self) -> DeleteFolderFluentBuilder

Constructs a fluent builder for the DeleteFolder operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID for the Amazon Web Services account that contains the folder.

    
    
  • folder_id(impl Into<String>) / set_folder_id(Option<String>):
    required: true
    

    The ID of the folder.

    
    
• On success, responds with DeleteFolderOutput with field(s):
  • status(i32):

    The HTTP status of the request.

  • arn(Option<String>):

    The Amazon Resource Name of the deleted folder.

  • folder_id(Option<String>):

    The ID of the folder.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

• On failure, responds with SdkError<DeleteFolderError>

impl Client

pub fn delete_folder_membership(&self) -> DeleteFolderMembershipFluentBuilder

Constructs a fluent builder for the DeleteFolderMembership operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID for the Amazon Web Services account that contains the folder.

    
    
  • folder_id(impl Into<String>) / set_folder_id(Option<String>):
    required: true
    

    The Folder ID.

    
    
  • member_id(impl Into<String>) / set_member_id(Option<String>):
    required: true
    

    The ID of the asset that you want to delete.

    
    
  • member_type(MemberType) / set_member_type(Option<MemberType>):
    required: true
    

    The member type of the asset that you want to delete from a folder.

    
    
• On success, responds with DeleteFolderMembershipOutput with field(s):
  • status(i32):

    The HTTP status of the request.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

• On failure, responds with SdkError<DeleteFolderMembershipError>

impl Client

pub fn delete_group(&self) -> DeleteGroupFluentBuilder

Constructs a fluent builder for the DeleteGroup operation.

• The fluent builder is configurable:
  • group_name(impl Into<String>) / set_group_name(Option<String>):
    required: true
    

    The name of the group that you want to delete.

    
    
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    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.

    
    
  • namespace(impl Into<String>) / set_namespace(Option<String>):
    required: true
    

    The namespace of the group that you want to delete.

    
    
• On success, responds with DeleteGroupOutput with field(s):
  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<DeleteGroupError>

impl Client

pub fn delete_group_membership(&self) -> DeleteGroupMembershipFluentBuilder

Constructs a fluent builder for the DeleteGroupMembership operation.

• The fluent builder is configurable:
  • member_name(impl Into<String>) / set_member_name(Option<String>):
    required: true
    

    The name of the user that you want to delete from the group membership.

    
    
  • group_name(impl Into<String>) / set_group_name(Option<String>):
    required: true
    

    The name of the group that you want to delete the user from.

    
    
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    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.

    
    
  • namespace(impl Into<String>) / set_namespace(Option<String>):
    required: true
    

    The namespace of the group that you want to remove a user from.

    
    
• On success, responds with DeleteGroupMembershipOutput with field(s):
  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<DeleteGroupMembershipError>

impl Client

pub fn delete_iam_policy_assignment( &self ) -> DeleteIAMPolicyAssignmentFluentBuilder

Constructs a fluent builder for the DeleteIAMPolicyAssignment operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID where you want to delete the IAM policy assignment.

    
    
  • assignment_name(impl Into<String>) / set_assignment_name(Option<String>):
    required: true
    

    The name of the assignment.

    
    
  • namespace(impl Into<String>) / set_namespace(Option<String>):
    required: true
    

    The namespace that contains the assignment.

    
    
• On success, responds with DeleteIamPolicyAssignmentOutput with field(s):
  • assignment_name(Option<String>):

    The name of the assignment.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<DeleteIAMPolicyAssignmentError>

impl Client

pub fn delete_identity_propagation_config( &self ) -> DeleteIdentityPropagationConfigFluentBuilder

Constructs a fluent builder for the DeleteIdentityPropagationConfig operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that you want to delete an identity propagation configuration from.

    
    
  • service(ServiceType) / set_service(Option<ServiceType>):
    required: true
    

    The name of the Amazon Web Services service that you want to delete the associated access scopes and authorized targets from.

    
    
• On success, responds with DeleteIdentityPropagationConfigOutput with field(s):
  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<DeleteIdentityPropagationConfigError>

impl Client

pub fn delete_namespace(&self) -> DeleteNamespaceFluentBuilder

Constructs a fluent builder for the DeleteNamespace operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID for the Amazon Web Services account that you want to delete the Amazon QuickSight namespace from.

    
    
  • namespace(impl Into<String>) / set_namespace(Option<String>):
    required: true
    

    The namespace that you want to delete.

    
    
• On success, responds with DeleteNamespaceOutput with field(s):
  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<DeleteNamespaceError>

impl Client

pub fn delete_refresh_schedule(&self) -> DeleteRefreshScheduleFluentBuilder

Constructs a fluent builder for the DeleteRefreshSchedule operation.

• The fluent builder is configurable:
  • data_set_id(impl Into<String>) / set_data_set_id(Option<String>):
    required: true
    

    The ID of the dataset.

    
    
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID.

    
    
  • schedule_id(impl Into<String>) / set_schedule_id(Option<String>):
    required: true
    

    The ID of the refresh schedule.

    
    
• On success, responds with DeleteRefreshScheduleOutput with field(s):
  • status(i32):

    The HTTP status of the request.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • schedule_id(Option<String>):

    The ID of the refresh schedule.

  • arn(Option<String>):

    The Amazon Resource Name (ARN) for the refresh schedule.

• On failure, responds with SdkError<DeleteRefreshScheduleError>

impl Client

pub fn delete_role_custom_permission( &self ) -> DeleteRoleCustomPermissionFluentBuilder

Constructs a fluent builder for the DeleteRoleCustomPermission operation.

• The fluent builder is configurable:
  • role(Role) / set_role(Option<Role>):
    required: true
    

    The role that you want to remove permissions from.

    
    
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    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.

    
    
  • namespace(impl Into<String>) / set_namespace(Option<String>):
    required: true
    

    The namespace that includes the role.

    
    
• On success, responds with DeleteRoleCustomPermissionOutput with field(s):
  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<DeleteRoleCustomPermissionError>

impl Client

pub fn delete_role_membership(&self) -> DeleteRoleMembershipFluentBuilder

Constructs a fluent builder for the DeleteRoleMembership operation.

• The fluent builder is configurable:
  • member_name(impl Into<String>) / set_member_name(Option<String>):
    required: true
    

    The name of the group.

    
    
  • role(Role) / set_role(Option<Role>):
    required: true
    

    The role that you want to remove permissions from.

    
    
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    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.

    
    
  • namespace(impl Into<String>) / set_namespace(Option<String>):
    required: true
    

    The namespace that contains the role.

    
    
• On success, responds with DeleteRoleMembershipOutput with field(s):
  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<DeleteRoleMembershipError>

impl Client

pub fn delete_template(&self) -> DeleteTemplateFluentBuilder

Constructs a fluent builder for the DeleteTemplate operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that contains the template that you’re deleting.

    
    
  • template_id(impl Into<String>) / set_template_id(Option<String>):
    required: true
    

    An ID for the template you want to delete.

    
    
  • version_number(i64) / set_version_number(Option<i64>):
    required: false
    

    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.

    
    
• On success, responds with DeleteTemplateOutput with field(s):
  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the resource.

  • template_id(Option<String>):

    An ID for the template.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<DeleteTemplateError>

impl Client

pub fn delete_template_alias(&self) -> DeleteTemplateAliasFluentBuilder

Constructs a fluent builder for the DeleteTemplateAlias operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that contains the item to delete.

    
    
  • template_id(impl Into<String>) / set_template_id(Option<String>):
    required: true
    

    The ID for the template that the specified alias is for.

    
    
  • alias_name(impl Into<String>) / set_alias_name(Option<String>):
    required: true
    

    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.

    
    
• On success, responds with DeleteTemplateAliasOutput with field(s):
  • status(i32):

    The HTTP status of the request.

  • template_id(Option<String>):

    An ID for the template associated with the deletion.

  • alias_name(Option<String>):

    The name for the template alias.

  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the template you want to delete.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

• On failure, responds with SdkError<DeleteTemplateAliasError>

impl Client

pub fn delete_theme(&self) -> DeleteThemeFluentBuilder

Constructs a fluent builder for the DeleteTheme operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that contains the theme that you’re deleting.

    
    
  • theme_id(impl Into<String>) / set_theme_id(Option<String>):
    required: true
    

    An ID for the theme that you want to delete.

    
    
  • version_number(i64) / set_version_number(Option<i64>):
    required: false
    

    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.

    
    
• On success, responds with DeleteThemeOutput with field(s):
  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the resource.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

  • theme_id(Option<String>):

    An ID for the theme.

• On failure, responds with SdkError<DeleteThemeError>

impl Client

pub fn delete_theme_alias(&self) -> DeleteThemeAliasFluentBuilder

Constructs a fluent builder for the DeleteThemeAlias operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that contains the theme alias to delete.

    
    
  • theme_id(impl Into<String>) / set_theme_id(Option<String>):
    required: true
    

    The ID for the theme that the specified alias is for.

    
    
  • alias_name(impl Into<String>) / set_alias_name(Option<String>):
    required: true
    

    The unique name for the theme alias to delete.

    
    
• On success, responds with DeleteThemeAliasOutput with field(s):
  • alias_name(Option<String>):

    The name for the theme alias.

  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the theme resource using the deleted alias.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

  • theme_id(Option<String>):

    An ID for the theme associated with the deletion.

• On failure, responds with SdkError<DeleteThemeAliasError>

impl Client

pub fn delete_topic(&self) -> DeleteTopicFluentBuilder

Constructs a fluent builder for the DeleteTopic operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that contains the topic that you want to delete.

    
    
  • topic_id(impl Into<String>) / set_topic_id(Option<String>):
    required: true
    

    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.

    
    
• On success, responds with DeleteTopicOutput with field(s):
  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the topic.

  • topic_id(Option<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.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<DeleteTopicError>

impl Client

pub fn delete_topic_refresh_schedule( &self ) -> DeleteTopicRefreshScheduleFluentBuilder

Constructs a fluent builder for the DeleteTopicRefreshSchedule operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID.

    
    
  • topic_id(impl Into<String>) / set_topic_id(Option<String>):
    required: true
    

    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.

    
    
  • dataset_id(impl Into<String>) / set_dataset_id(Option<String>):
    required: true
    

    The ID of the dataset.

    
    
• On success, responds with DeleteTopicRefreshScheduleOutput with field(s):
  • topic_id(Option<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.

  • topic_arn(Option<String>):

    The Amazon Resource Name (ARN) of the topic.

  • dataset_arn(Option<String>):

    The Amazon Resource Name (ARN) of the dataset.

  • status(i32):

    The HTTP status of the request.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

• On failure, responds with SdkError<DeleteTopicRefreshScheduleError>

impl Client

pub fn delete_user(&self) -> DeleteUserFluentBuilder

Constructs a fluent builder for the DeleteUser operation.

• The fluent builder is configurable:
  • user_name(impl Into<String>) / set_user_name(Option<String>):
    required: true
    

    The name of the user that you want to delete.

    
    
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    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.

    
    
  • namespace(impl Into<String>) / set_namespace(Option<String>):
    required: true
    

    The namespace. Currently, you should set this to default.

    
    
• On success, responds with DeleteUserOutput with field(s):
  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<DeleteUserError>

impl Client

pub fn delete_user_by_principal_id( &self ) -> DeleteUserByPrincipalIdFluentBuilder

Constructs a fluent builder for the DeleteUserByPrincipalId operation.

• The fluent builder is configurable:
  • principal_id(impl Into<String>) / set_principal_id(Option<String>):
    required: true
    

    The principal ID of the user.

    
    
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    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.

    
    
  • namespace(impl Into<String>) / set_namespace(Option<String>):
    required: true
    

    The namespace. Currently, you should set this to default.

    
    
• On success, responds with DeleteUserByPrincipalIdOutput with field(s):
  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<DeleteUserByPrincipalIdError>

impl Client

pub fn delete_vpc_connection(&self) -> DeleteVPCConnectionFluentBuilder

Constructs a fluent builder for the DeleteVPCConnection operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID of the account where you want to delete a VPC connection.

    
    
  • vpc_connection_id(impl Into<String>) / set_vpc_connection_id(Option<String>):
    required: true
    

    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.

    
    
• On success, responds with DeleteVpcConnectionOutput with field(s):
  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the deleted VPC connection.

  • vpc_connection_id(Option<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.

  • deletion_status(Option<VpcConnectionResourceStatus>):

    The deletion status of the VPC connection.

  • availability_status(Option<VpcConnectionAvailabilityStatus>):

    The availability status of the VPC connection.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<DeleteVPCConnectionError>

impl Client

pub fn describe_account_customization( &self ) -> DescribeAccountCustomizationFluentBuilder

Constructs a fluent builder for the DescribeAccountCustomization operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID for the Amazon Web Services account that you want to describe Amazon QuickSight customizations for.

    
    
  • namespace(impl Into<String>) / set_namespace(Option<String>):
    required: false
    

    The Amazon QuickSight namespace that you want to describe Amazon QuickSight customizations for.

    
    
  • resolved(bool) / set_resolved(Option<bool>):
    required: false
    

    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.

    
    
• On success, responds with DescribeAccountCustomizationOutput with field(s):
  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the customization that’s associated with this Amazon Web Services account.

  • aws_account_id(Option<String>):

    The ID for the Amazon Web Services account that you’re describing.

  • namespace(Option<String>):

    The Amazon QuickSight namespace that you’re describing.

  • account_customization(Option<AccountCustomization>):

    The Amazon QuickSight customizations that exist in the current Amazon Web Services Region.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<DescribeAccountCustomizationError>

impl Client

pub fn describe_account_settings(&self) -> DescribeAccountSettingsFluentBuilder

Constructs a fluent builder for the DescribeAccountSettings operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID for the Amazon Web Services account that contains the settings that you want to list.

    
    
• On success, responds with DescribeAccountSettingsOutput with field(s):
  • account_settings(Option<AccountSettings>):

    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.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<DescribeAccountSettingsError>

impl Client

pub fn describe_account_subscription( &self ) -> DescribeAccountSubscriptionFluentBuilder

Constructs a fluent builder for the DescribeAccountSubscription operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID associated with your Amazon QuickSight account.

    
    
• On success, responds with DescribeAccountSubscriptionOutput with field(s):
  • account_info(Option<AccountInfo>):

    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.

  • status(i32):

    The HTTP status of the request.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

• On failure, responds with SdkError<DescribeAccountSubscriptionError>

impl Client

pub fn describe_analysis(&self) -> DescribeAnalysisFluentBuilder

Constructs a fluent builder for the DescribeAnalysis operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    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.

    
    
  • analysis_id(impl Into<String>) / set_analysis_id(Option<String>):
    required: true
    

    The ID of the analysis that you’re describing. The ID is part of the URL of the analysis.

    
    
• On success, responds with DescribeAnalysisOutput with field(s):
  • analysis(Option<Analysis>):

    A metadata structure that contains summary information for the analysis that you’re describing.

  • status(i32):

    The HTTP status of the request.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

• On failure, responds with SdkError<DescribeAnalysisError>

impl Client

pub fn describe_analysis_definition( &self ) -> DescribeAnalysisDefinitionFluentBuilder

Constructs a fluent builder for the DescribeAnalysisDefinition operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    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.

    
    
  • analysis_id(impl Into<String>) / set_analysis_id(Option<String>):
    required: true
    

    The ID of the analysis that you’re describing. The ID is part of the URL of the analysis.

    
    
• On success, responds with DescribeAnalysisDefinitionOutput with field(s):
  • analysis_id(Option<String>):

    The ID of the analysis described.

  • name(Option<String>):

    The descriptive name of the analysis.

  • errors(Option<Vec::<AnalysisError>>):

    Errors associated with the analysis.

  • resource_status(Option<ResourceStatus>):

    Status associated with the analysis.

    • CREATION_IN_PROGRESS

    • CREATION_SUCCESSFUL

    • CREATION_FAILED

    • UPDATE_IN_PROGRESS

    • UPDATE_SUCCESSFUL

    • UPDATE_FAILED

    • DELETED

  • theme_arn(Option<String>):

    The ARN of the theme of the analysis.

  • definition(Option<AnalysisDefinition>):

    The definition of an analysis.

    A definition is the data model of all features in a Dashboard, Template, or Analysis.

  • status(i32):

    The HTTP status of the request.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

• On failure, responds with SdkError<DescribeAnalysisDefinitionError>

impl Client

pub fn describe_analysis_permissions( &self ) -> DescribeAnalysisPermissionsFluentBuilder

Constructs a fluent builder for the DescribeAnalysisPermissions operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    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.

    
    
  • analysis_id(impl Into<String>) / set_analysis_id(Option<String>):
    required: true
    

    The ID of the analysis whose permissions you’re describing. The ID is part of the analysis URL.

    
    
• On success, responds with DescribeAnalysisPermissionsOutput with field(s):
  • analysis_id(Option<String>):

    The ID of the analysis whose permissions you’re describing.

  • analysis_arn(Option<String>):

    The Amazon Resource Name (ARN) of the analysis whose permissions you’re describing.

  • permissions(Option<Vec::<ResourcePermission>>):

    A structure that describes the principals and the resource-level permissions on an analysis.

  • status(i32):

    The HTTP status of the request.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

• On failure, responds with SdkError<DescribeAnalysisPermissionsError>

impl Client

pub fn describe_asset_bundle_export_job( &self ) -> DescribeAssetBundleExportJobFluentBuilder

Constructs a fluent builder for the DescribeAssetBundleExportJob operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account the export job is executed in.

    
    
  • asset_bundle_export_job_id(impl Into<String>) / set_asset_bundle_export_job_id(Option<String>):
    required: true
    

    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.

    
    
• On success, responds with DescribeAssetBundleExportJobOutput with field(s):
  • job_status(Option<AssetBundleExportJobStatus>):

    Indicates the status of a job through its queuing and execution.

    Poll this DescribeAssetBundleExportApi until JobStatus is either SUCCESSFUL or FAILED.

  • download_url(Option<String>):

    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.

  • errors(Option<Vec::<AssetBundleExportJobError>>):

    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.

  • arn(Option<String>):

    The Amazon Resource Name (ARN) for the export job.

  • created_time(Option<DateTime>):

    The time that the export job was created.

  • asset_bundle_export_job_id(Option<String>):

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

  • aws_account_id(Option<String>):

    The ID of the Amazon Web Services account that the export job was executed in.

  • resource_arns(Option<Vec::<String>>):

    A list of resource ARNs that exported with the job.

  • include_all_dependencies(bool):

    The include dependencies flag.

  • export_format(Option<AssetBundleExportFormat>):

    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.

  • cloud_formation_override_property_configuration(Option<AssetBundleCloudFormationOverridePropertyConfiguration>):

    The CloudFormation override property configuration for the export job.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the response.

  • include_permissions(bool):

    The include permissions flag.

  • include_tags(bool):

    The include tags flag.

  • validation_strategy(Option<AssetBundleExportJobValidationStrategy>):

    The validation strategy that is used to export the analysis or dashboard.

  • warnings(Option<Vec::<AssetBundleExportJobWarning>>):

    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.

• On failure, responds with SdkError<DescribeAssetBundleExportJobError>

impl Client

pub fn describe_asset_bundle_import_job( &self ) -> DescribeAssetBundleImportJobFluentBuilder

Constructs a fluent builder for the DescribeAssetBundleImportJob operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account the import job was executed in.

    
    
  • asset_bundle_import_job_id(impl Into<String>) / set_asset_bundle_import_job_id(Option<String>):
    required: true
    

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

    
    
• On success, responds with DescribeAssetBundleImportJobOutput with field(s):
  • job_status(Option<AssetBundleImportJobStatus>):

    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

  • errors(Option<Vec::<AssetBundleImportJobError>>):

    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.

  • rollback_errors(Option<Vec::<AssetBundleImportJobError>>):

    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.

  • arn(Option<String>):

    The Amazon Resource Name (ARN) for the import job.

  • created_time(Option<DateTime>):

    The time that the import job was created.

  • asset_bundle_import_job_id(Option<String>):

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

  • aws_account_id(Option<String>):

    The ID of the Amazon Web Services account the import job was executed in.

  • asset_bundle_import_source(Option<AssetBundleImportSourceDescription>):

    The source of the asset bundle zip file that contains the data that is imported by the job.

  • override_parameters(Option<AssetBundleImportJobOverrideParameters>):

    Optional overrides that are applied to the resource configuration before import.

  • failure_action(Option<AssetBundleImportFailureAction>):

    The failure action for the import job.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the response.

  • override_permissions(Option<AssetBundleImportJobOverridePermissions>):

    Optional permission overrides that are applied to the resource configuration before import.

  • override_tags(Option<AssetBundleImportJobOverrideTags>):

    Optional tag overrides that are applied to the resource configuration before import.

  • override_validation_strategy(Option<AssetBundleImportJobOverrideValidationStrategy>):

    An optional validation strategy override for all analyses and dashboards to be applied to the resource configuration before import.

  • warnings(Option<Vec::<AssetBundleImportJobWarning>>):

    An array of warning records that describe all permitted errors that are encountered during the import job.

• On failure, responds with SdkError<DescribeAssetBundleImportJobError>

impl Client

pub fn describe_dashboard(&self) -> DescribeDashboardFluentBuilder

Constructs a fluent builder for the DescribeDashboard operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that contains the dashboard that you’re describing.

    
    
  • dashboard_id(impl Into<String>) / set_dashboard_id(Option<String>):
    required: true
    

    The ID for the dashboard.

    
    
  • version_number(i64) / set_version_number(Option<i64>):
    required: false
    

    The version number for the dashboard. If a version number isn’t passed, the latest published dashboard version is described.

    
    
  • alias_name(impl Into<String>) / set_alias_name(Option<String>):
    required: false
    

    The alias name.

    
    
• On success, responds with DescribeDashboardOutput with field(s):
  • dashboard(Option<Dashboard>):

    Information about the dashboard.

  • status(i32):

    The HTTP status of this request.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

• On failure, responds with SdkError<DescribeDashboardError>

impl Client

pub fn describe_dashboard_definition( &self ) -> DescribeDashboardDefinitionFluentBuilder

Constructs a fluent builder for the DescribeDashboardDefinition operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that contains the dashboard that you’re describing.

    
    
  • dashboard_id(impl Into<String>) / set_dashboard_id(Option<String>):
    required: true
    

    The ID for the dashboard.

    
    
  • version_number(i64) / set_version_number(Option<i64>):
    required: false
    

    The version number for the dashboard. If a version number isn’t passed, the latest published dashboard version is described.

    
    
  • alias_name(impl Into<String>) / set_alias_name(Option<String>):
    required: false
    

    The alias name.

    
    
• On success, responds with DescribeDashboardDefinitionOutput with field(s):
  • dashboard_id(Option<String>):

    The ID of the dashboard described.

  • errors(Option<Vec::<DashboardError>>):

    Errors associated with this dashboard version.

  • name(Option<String>):

    The display name of the dashboard.

  • resource_status(Option<ResourceStatus>):

    Status associated with the dashboard version.

    • CREATION_IN_PROGRESS

    • CREATION_SUCCESSFUL

    • CREATION_FAILED

    • UPDATE_IN_PROGRESS

    • UPDATE_SUCCESSFUL

    • UPDATE_FAILED

    • DELETED

  • theme_arn(Option<String>):

    The ARN of the theme of the dashboard.

  • definition(Option<DashboardVersionDefinition>):

    The definition of a dashboard.

    A definition is the data model of all features in a Dashboard, Template, or Analysis.

  • status(i32):

    The HTTP status of the request.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • dashboard_publish_options(Option<DashboardPublishOptions>):

    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.

• On failure, responds with SdkError<DescribeDashboardDefinitionError>

impl Client

pub fn describe_dashboard_permissions( &self ) -> DescribeDashboardPermissionsFluentBuilder

Constructs a fluent builder for the DescribeDashboardPermissions operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that contains the dashboard that you’re describing permissions for.

    
    
  • dashboard_id(impl Into<String>) / set_dashboard_id(Option<String>):
    required: true
    

    The ID for the dashboard, also added to the IAM policy.

    
    
• On success, responds with DescribeDashboardPermissionsOutput with field(s):
  • dashboard_id(Option<String>):

    The ID for the dashboard.

  • dashboard_arn(Option<String>):

    The Amazon Resource Name (ARN) of the dashboard.

  • permissions(Option<Vec::<ResourcePermission>>):

    A structure that contains the permissions for the dashboard.

  • status(i32):

    The HTTP status of the request.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • link_sharing_configuration(Option<LinkSharingConfiguration>):

    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.

• On failure, responds with SdkError<DescribeDashboardPermissionsError>

impl Client

pub fn describe_dashboard_snapshot_job( &self ) -> DescribeDashboardSnapshotJobFluentBuilder

Constructs a fluent builder for the DescribeDashboardSnapshotJob operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

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

    
    
  • dashboard_id(impl Into<String>) / set_dashboard_id(Option<String>):
    required: true
    

    The ID of the dashboard that you have started a snapshot job for.

    
    
  • snapshot_job_id(impl Into<String>) / set_snapshot_job_id(Option<String>):
    required: true
    

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

    
    
• On success, responds with DescribeDashboardSnapshotJobOutput with field(s):
  • aws_account_id(Option<String>):

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

  • dashboard_id(Option<String>):

    The ID of the dashboard that you have started a snapshot job for.

  • snapshot_job_id(Option<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.

  • user_configuration(Option<SnapshotUserConfigurationRedacted>):

    The user configuration for the snapshot job. This information is provided when you make a StartDashboardSnapshotJob API call.

  • snapshot_configuration(Option<SnapshotConfiguration>):

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

  • arn(Option<String>):

    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.

  • job_status(Option<SnapshotJobStatus>):

    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.

  • created_time(Option<DateTime>):

    The time that the snapshot job was created.

  • last_updated_time(Option<DateTime>):

    The time that the snapshot job status was last updated.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request

• On failure, responds with SdkError<DescribeDashboardSnapshotJobError>

impl Client

pub fn describe_dashboard_snapshot_job_result( &self ) -> DescribeDashboardSnapshotJobResultFluentBuilder

Constructs a fluent builder for the DescribeDashboardSnapshotJobResult operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

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

    
    
  • dashboard_id(impl Into<String>) / set_dashboard_id(Option<String>):
    required: true
    

    The ID of the dashboard that you have started a snapshot job for.

    
    
  • snapshot_job_id(impl Into<String>) / set_snapshot_job_id(Option<String>):
    required: true
    

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

    
    
• On success, responds with DescribeDashboardSnapshotJobResultOutput with field(s):
  • arn(Option<String>):

    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.

  • job_status(Option<SnapshotJobStatus>):

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

  • created_time(Option<DateTime>):

    The time that a snapshot job was created.

  • last_updated_time(Option<DateTime>):

    The time that a snapshot job status was last updated.

  • result(Option<SnapshotJobResult>):

    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.

  • error_info(Option<SnapshotJobErrorInfo>):

    Displays information for the error that caused a job to fail.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request

• On failure, responds with SdkError<DescribeDashboardSnapshotJobResultError>

impl Client

pub fn describe_data_set(&self) -> DescribeDataSetFluentBuilder

Constructs a fluent builder for the DescribeDataSet operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID.

    
    
  • data_set_id(impl Into<String>) / set_data_set_id(Option<String>):
    required: true
    

    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.

    
    
• On success, responds with DescribeDataSetOutput with field(s):
  • data_set(Option<DataSet>):

    Information on the dataset.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<DescribeDataSetError>

impl Client

pub fn describe_data_set_permissions( &self ) -> DescribeDataSetPermissionsFluentBuilder

Constructs a fluent builder for the DescribeDataSetPermissions operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID.

    
    
  • data_set_id(impl Into<String>) / set_data_set_id(Option<String>):
    required: true
    

    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.

    
    
• On success, responds with DescribeDataSetPermissionsOutput with field(s):
  • data_set_arn(Option<String>):

    The Amazon Resource Name (ARN) of the dataset.

  • data_set_id(Option<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.

  • permissions(Option<Vec::<ResourcePermission>>):

    A list of resource permissions on the dataset.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<DescribeDataSetPermissionsError>

impl Client

pub fn describe_data_set_refresh_properties( &self ) -> DescribeDataSetRefreshPropertiesFluentBuilder

Constructs a fluent builder for the DescribeDataSetRefreshProperties operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID.

    
    
  • data_set_id(impl Into<String>) / set_data_set_id(Option<String>):
    required: true
    

    The ID of the dataset.

    
    
• On success, responds with DescribeDataSetRefreshPropertiesOutput with field(s):
  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

  • data_set_refresh_properties(Option<DataSetRefreshProperties>):

    The dataset refresh properties.

• On failure, responds with SdkError<DescribeDataSetRefreshPropertiesError>

impl Client

pub fn describe_data_source(&self) -> DescribeDataSourceFluentBuilder

Constructs a fluent builder for the DescribeDataSource operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID.

    
    
  • data_source_id(impl Into<String>) / set_data_source_id(Option<String>):
    required: true
    

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

    
    
• On success, responds with DescribeDataSourceOutput with field(s):
  • data_source(Option<DataSource>):

    The information on the data source.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<DescribeDataSourceError>

impl Client

pub fn describe_data_source_permissions( &self ) -> DescribeDataSourcePermissionsFluentBuilder

Constructs a fluent builder for the DescribeDataSourcePermissions operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID.

    
    
  • data_source_id(impl Into<String>) / set_data_source_id(Option<String>):
    required: true
    

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

    
    
• On success, responds with DescribeDataSourcePermissionsOutput with field(s):
  • data_source_arn(Option<String>):

    The Amazon Resource Name (ARN) of the data source.

  • data_source_id(Option<String>):

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

  • permissions(Option<Vec::<ResourcePermission>>):

    A list of resource permissions on the data source.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<DescribeDataSourcePermissionsError>

impl Client

pub fn describe_folder(&self) -> DescribeFolderFluentBuilder

Constructs a fluent builder for the DescribeFolder operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID for the Amazon Web Services account that contains the folder.

    
    
  • folder_id(impl Into<String>) / set_folder_id(Option<String>):
    required: true
    

    The ID of the folder.

    
    
• On success, responds with DescribeFolderOutput with field(s):
  • status(i32):

    The HTTP status of the request.

  • folder(Option<Folder>):

    Information about the folder.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

• On failure, responds with SdkError<DescribeFolderError>

impl Client

pub fn describe_folder_permissions( &self ) -> DescribeFolderPermissionsFluentBuilder

Constructs a fluent builder for the DescribeFolderPermissions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID for the Amazon Web Services account that contains the folder.

    
    
  • folder_id(impl Into<String>) / set_folder_id(Option<String>):
    required: true
    

    The ID of the folder.

    
    
  • namespace(impl Into<String>) / set_namespace(Option<String>):
    required: false
    

    The namespace of the folder whose permissions you want described.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to be returned per request.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A pagination token for the next set of results.

    
    
• On success, responds with DescribeFolderPermissionsOutput with field(s):
  • status(i32):

    The HTTP status of the request.

  • folder_id(Option<String>):

    The ID of the folder.

  • arn(Option<String>):

    The Amazon Resource Name (ARN) for the folder.

  • permissions(Option<Vec::<ResourcePermission>>):

    Information about the permissions on the folder.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • next_token(Option<String>):

    The pagination token for the next set of results, or null if there are no more results.

• On failure, responds with SdkError<DescribeFolderPermissionsError>

impl Client

pub fn describe_folder_resolved_permissions( &self ) -> DescribeFolderResolvedPermissionsFluentBuilder

Constructs a fluent builder for the DescribeFolderResolvedPermissions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID for the Amazon Web Services account that contains the folder.

    
    
  • folder_id(impl Into<String>) / set_folder_id(Option<String>):
    required: true
    

    The ID of the folder.

    
    
  • namespace(impl Into<String>) / set_namespace(Option<String>):
    required: false
    

    The namespace of the folder whose permissions you want described.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to be returned per request.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A pagination token for the next set of results.

    
    
• On success, responds with DescribeFolderResolvedPermissionsOutput with field(s):
  • status(i32):

    The HTTP status of the request.

  • folder_id(Option<String>):

    The ID of the folder.

  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the folder.

  • permissions(Option<Vec::<ResourcePermission>>):

    Information about the permissions for the folder.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • next_token(Option<String>):

    A pagination token for the next set of results, or null if there are no more results.

• On failure, responds with SdkError<DescribeFolderResolvedPermissionsError>

impl Client

pub fn describe_group(&self) -> DescribeGroupFluentBuilder

Constructs a fluent builder for the DescribeGroup operation.

• The fluent builder is configurable:
  • group_name(impl Into<String>) / set_group_name(Option<String>):
    required: true
    

    The name of the group that you want to describe.

    
    
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    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.

    
    
  • namespace(impl Into<String>) / set_namespace(Option<String>):
    required: true
    

    The namespace of the group that you want described.

    
    
• On success, responds with DescribeGroupOutput with field(s):
  • group(Option<Group>):

    The name of the group.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<DescribeGroupError>

impl Client

pub fn describe_group_membership(&self) -> DescribeGroupMembershipFluentBuilder

Constructs a fluent builder for the DescribeGroupMembership operation.

• The fluent builder is configurable:
  • member_name(impl Into<String>) / set_member_name(Option<String>):
    required: true
    

    The user name of the user that you want to search for.

    
    
  • group_name(impl Into<String>) / set_group_name(Option<String>):
    required: true
    

    The name of the group that you want to search.

    
    
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    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.

    
    
  • namespace(impl Into<String>) / set_namespace(Option<String>):
    required: true
    

    The namespace that includes the group you are searching within.

    
    
• On success, responds with DescribeGroupMembershipOutput with field(s):
  • group_member(Option<GroupMember>):

    A member of an Amazon QuickSight group. Currently, group members must be users. Groups can’t be members of another group. .

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<DescribeGroupMembershipError>

impl Client

pub fn describe_iam_policy_assignment( &self ) -> DescribeIAMPolicyAssignmentFluentBuilder

Constructs a fluent builder for the DescribeIAMPolicyAssignment operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that contains the assignment that you want to describe.

    
    
  • assignment_name(impl Into<String>) / set_assignment_name(Option<String>):
    required: true
    

    The name of the assignment, also called a rule.

    
    
  • namespace(impl Into<String>) / set_namespace(Option<String>):
    required: true
    

    The namespace that contains the assignment.

    
    
• On success, responds with DescribeIamPolicyAssignmentOutput with field(s):
  • iam_policy_assignment(Option<IamPolicyAssignment>):

    Information describing the IAM policy assignment.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<DescribeIAMPolicyAssignmentError>

impl Client

pub fn describe_ingestion(&self) -> DescribeIngestionFluentBuilder

Constructs a fluent builder for the DescribeIngestion operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID.

    
    
  • data_set_id(impl Into<String>) / set_data_set_id(Option<String>):
    required: true
    

    The ID of the dataset used in the ingestion.

    
    
  • ingestion_id(impl Into<String>) / set_ingestion_id(Option<String>):
    required: true
    

    An ID for the ingestion.

    
    
• On success, responds with DescribeIngestionOutput with field(s):
  • ingestion(Option<Ingestion>):

    Information about the ingestion.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<DescribeIngestionError>

impl Client

pub fn describe_ip_restriction(&self) -> DescribeIpRestrictionFluentBuilder

Constructs a fluent builder for the DescribeIpRestriction operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that contains the IP rules.

    
    
• On success, responds with DescribeIpRestrictionOutput with field(s):
  • aws_account_id(Option<String>):

    The ID of the Amazon Web Services account that contains the IP rules.

  • ip_restriction_rule_map(Option<HashMap::<String, String>>):

    A map that describes the IP rules with CIDR range and description.

  • vpc_id_restriction_rule_map(Option<HashMap::<String, String>>):

    A map of allowed VPC IDs and their rule descriptions.

  • vpc_endpoint_id_restriction_rule_map(Option<HashMap::<String, String>>):

    A map of allowed VPC endpoint IDs and their rule descriptions.

  • enabled(Option<bool>):

    A value that specifies whether IP rules are turned on.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<DescribeIpRestrictionError>

impl Client

pub fn describe_namespace(&self) -> DescribeNamespaceFluentBuilder

Constructs a fluent builder for the DescribeNamespace operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID for the Amazon Web Services account that contains the Amazon QuickSight namespace that you want to describe.

    
    
  • namespace(impl Into<String>) / set_namespace(Option<String>):
    required: true
    

    The namespace that you want to describe.

    
    
• On success, responds with DescribeNamespaceOutput with field(s):
  • namespace(Option<NamespaceInfoV2>):

    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.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<DescribeNamespaceError>

impl Client

pub fn describe_refresh_schedule(&self) -> DescribeRefreshScheduleFluentBuilder

Constructs a fluent builder for the DescribeRefreshSchedule operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID.

    
    
  • data_set_id(impl Into<String>) / set_data_set_id(Option<String>):
    required: true
    

    The ID of the dataset.

    
    
  • schedule_id(impl Into<String>) / set_schedule_id(Option<String>):
    required: true
    

    The ID of the refresh schedule.

    
    
• On success, responds with DescribeRefreshScheduleOutput with field(s):
  • refresh_schedule(Option<RefreshSchedule>):

    The refresh schedule.

  • status(i32):

    The HTTP status of the request.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • arn(Option<String>):

    The Amazon Resource Name (ARN) for the refresh schedule.

• On failure, responds with SdkError<DescribeRefreshScheduleError>

impl Client

pub fn describe_role_custom_permission( &self ) -> DescribeRoleCustomPermissionFluentBuilder

Constructs a fluent builder for the DescribeRoleCustomPermission operation.

• The fluent builder is configurable:
  • role(Role) / set_role(Option<Role>):
    required: true
    

    The name of the role whose permissions you want described.

    
    
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    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.

    
    
  • namespace(impl Into<String>) / set_namespace(Option<String>):
    required: true
    

    The namespace that contains the role.

    
    
• On success, responds with DescribeRoleCustomPermissionOutput with field(s):
  • custom_permissions_name(Option<String>):

    The name of the custom permission that is described.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<DescribeRoleCustomPermissionError>

impl Client

pub fn describe_template(&self) -> DescribeTemplateFluentBuilder

Constructs a fluent builder for the DescribeTemplate operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that contains the template that you’re describing.

    
    
  • template_id(impl Into<String>) / set_template_id(Option<String>):
    required: true
    

    The ID for the template.

    
    
  • version_number(i64) / set_version_number(Option<i64>):
    required: false
    

    (Optional) The number for the version to describe. If a VersionNumber parameter value isn’t provided, the latest version of the template is described.

    
    
  • alias_name(impl Into<String>) / set_alias_name(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with DescribeTemplateOutput with field(s):
  • template(Option<Template>):

    The template structure for the object you want to describe.

  • status(i32):

    The HTTP status of the request.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

• On failure, responds with SdkError<DescribeTemplateError>

impl Client

pub fn describe_template_alias(&self) -> DescribeTemplateAliasFluentBuilder

Constructs a fluent builder for the DescribeTemplateAlias operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that contains the template alias that you’re describing.

    
    
  • template_id(impl Into<String>) / set_template_id(Option<String>):
    required: true
    

    The ID for the template.

    
    
  • alias_name(impl Into<String>) / set_alias_name(Option<String>):
    required: true
    

    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.

    
    
• On success, responds with DescribeTemplateAliasOutput with field(s):
  • template_alias(Option<TemplateAlias>):

    Information about the template alias.

  • status(i32):

    The HTTP status of the request.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

• On failure, responds with SdkError<DescribeTemplateAliasError>

impl Client

pub fn describe_template_definition( &self ) -> DescribeTemplateDefinitionFluentBuilder

Constructs a fluent builder for the DescribeTemplateDefinition operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    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.

    
    
  • template_id(impl Into<String>) / set_template_id(Option<String>):
    required: true
    

    The ID of the template that you’re describing.

    
    
  • version_number(i64) / set_version_number(Option<i64>):
    required: false
    

    The version number of the template.

    
    
  • alias_name(impl Into<String>) / set_alias_name(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with DescribeTemplateDefinitionOutput with field(s):
  • name(Option<String>):

    The descriptive name of the template.

  • template_id(Option<String>):

    The ID of the template described.

  • errors(Option<Vec::<TemplateError>>):

    Errors associated with the template version.

  • resource_status(Option<ResourceStatus>):

    Status associated with the template.

    • CREATION_IN_PROGRESS

    • CREATION_SUCCESSFUL

    • CREATION_FAILED

    • UPDATE_IN_PROGRESS

    • UPDATE_SUCCESSFUL

    • UPDATE_FAILED

    • DELETED

  • theme_arn(Option<String>):

    The ARN of the theme of the template.

  • definition(Option<TemplateVersionDefinition>):

    The definition of the template.

    A definition is the data model of all features in a Dashboard, Template, or Analysis.

  • status(i32):

    The HTTP status of the request.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

• On failure, responds with SdkError<DescribeTemplateDefinitionError>

impl Client

pub fn describe_template_permissions( &self ) -> DescribeTemplatePermissionsFluentBuilder

Constructs a fluent builder for the DescribeTemplatePermissions operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that contains the template that you’re describing.

    
    
  • template_id(impl Into<String>) / set_template_id(Option<String>):
    required: true
    

    The ID for the template.

    
    
• On success, responds with DescribeTemplatePermissionsOutput with field(s):
  • template_id(Option<String>):

    The ID for the template.

  • template_arn(Option<String>):

    The Amazon Resource Name (ARN) of the template.

  • permissions(Option<Vec::<ResourcePermission>>):

    A list of resource permissions to be set on the template.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<DescribeTemplatePermissionsError>

impl Client

pub fn describe_theme(&self) -> DescribeThemeFluentBuilder

Constructs a fluent builder for the DescribeTheme operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that contains the theme that you’re describing.

    
    
  • theme_id(impl Into<String>) / set_theme_id(Option<String>):
    required: true
    

    The ID for the theme.

    
    
  • version_number(i64) / set_version_number(Option<i64>):
    required: false
    

    The version number for the version to describe. If a VersionNumber parameter value isn’t provided, the latest version of the theme is described.

    
    
  • alias_name(impl Into<String>) / set_alias_name(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with DescribeThemeOutput with field(s):
  • theme(Option<Theme>):

    The information about the theme that you are describing.

  • status(i32):

    The HTTP status of the request.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

• On failure, responds with SdkError<DescribeThemeError>

impl Client

pub fn describe_theme_alias(&self) -> DescribeThemeAliasFluentBuilder

Constructs a fluent builder for the DescribeThemeAlias operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that contains the theme alias that you’re describing.

    
    
  • theme_id(impl Into<String>) / set_theme_id(Option<String>):
    required: true
    

    The ID for the theme.

    
    
  • alias_name(impl Into<String>) / set_alias_name(Option<String>):
    required: true
    

    The name of the theme alias that you want to describe.

    
    
• On success, responds with DescribeThemeAliasOutput with field(s):
  • theme_alias(Option<ThemeAlias>):

    Information about the theme alias.

  • status(i32):

    The HTTP status of the request.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

• On failure, responds with SdkError<DescribeThemeAliasError>

impl Client

pub fn describe_theme_permissions( &self ) -> DescribeThemePermissionsFluentBuilder

Constructs a fluent builder for the DescribeThemePermissions operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that contains the theme that you’re describing.

    
    
  • theme_id(impl Into<String>) / set_theme_id(Option<String>):
    required: true
    

    The ID for the theme that you want to describe permissions for.

    
    
• On success, responds with DescribeThemePermissionsOutput with field(s):
  • theme_id(Option<String>):

    The ID for the theme.

  • theme_arn(Option<String>):

    The Amazon Resource Name (ARN) of the theme.

  • permissions(Option<Vec::<ResourcePermission>>):

    A list of resource permissions set on the theme.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<DescribeThemePermissionsError>

impl Client

pub fn describe_topic(&self) -> DescribeTopicFluentBuilder

Constructs a fluent builder for the DescribeTopic operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID.

    
    
  • topic_id(impl Into<String>) / set_topic_id(Option<String>):
    required: true
    

    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.

    
    
• On success, responds with DescribeTopicOutput with field(s):
  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the topic.

  • topic_id(Option<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.

  • topic(Option<TopicDetails>):

    The definition of a topic.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<DescribeTopicError>

impl Client

pub fn describe_topic_permissions( &self ) -> DescribeTopicPermissionsFluentBuilder

Constructs a fluent builder for the DescribeTopicPermissions operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that contains the topic that you want described.

    
    
  • topic_id(impl Into<String>) / set_topic_id(Option<String>):
    required: true
    

    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.

    
    
• On success, responds with DescribeTopicPermissionsOutput with field(s):
  • topic_id(Option<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.

  • topic_arn(Option<String>):

    The Amazon Resource Name (ARN) of the topic.

  • permissions(Option<Vec::<ResourcePermission>>):

    A list of resource permissions that are configured to the topic.

  • status(i32):

    The HTTP status of the request.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

• On failure, responds with SdkError<DescribeTopicPermissionsError>

impl Client

pub fn describe_topic_refresh(&self) -> DescribeTopicRefreshFluentBuilder

Constructs a fluent builder for the DescribeTopicRefresh operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that contains the topic whose refresh you want to describe.

    
    
  • topic_id(impl Into<String>) / set_topic_id(Option<String>):
    required: true
    

    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.

    
    
  • refresh_id(impl Into<String>) / set_refresh_id(Option<String>):
    required: true
    

    The ID of the refresh, which is performed when the topic is created or updated.

    
    
• On success, responds with DescribeTopicRefreshOutput with field(s):
  • refresh_details(Option<TopicRefreshDetails>):

    Details of the refresh, which is performed when the topic is created or updated.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<DescribeTopicRefreshError>

impl Client

pub fn describe_topic_refresh_schedule( &self ) -> DescribeTopicRefreshScheduleFluentBuilder

Constructs a fluent builder for the DescribeTopicRefreshSchedule operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID.

    
    
  • topic_id(impl Into<String>) / set_topic_id(Option<String>):
    required: true
    

    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.

    
    
  • dataset_id(impl Into<String>) / set_dataset_id(Option<String>):
    required: true
    

    The ID of the dataset.

    
    
• On success, responds with DescribeTopicRefreshScheduleOutput with field(s):
  • topic_id(Option<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.

  • topic_arn(Option<String>):

    The Amazon Resource Name (ARN) of the topic.

  • dataset_arn(Option<String>):

    The Amazon Resource Name (ARN) of the dataset.

  • refresh_schedule(Option<TopicRefreshSchedule>):

    The definition of a refresh schedule.

  • status(i32):

    The HTTP status of the request.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

• On failure, responds with SdkError<DescribeTopicRefreshScheduleError>

impl Client

pub fn describe_user(&self) -> DescribeUserFluentBuilder

Constructs a fluent builder for the DescribeUser operation.

• The fluent builder is configurable:
  • user_name(impl Into<String>) / set_user_name(Option<String>):
    required: true
    

    The name of the user that you want to describe.

    
    
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    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.

    
    
  • namespace(impl Into<String>) / set_namespace(Option<String>):
    required: true
    

    The namespace. Currently, you should set this to default.

    
    
• On success, responds with DescribeUserOutput with field(s):
  • user(Option<User>):

    The user name.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<DescribeUserError>

impl Client

pub fn describe_vpc_connection(&self) -> DescribeVPCConnectionFluentBuilder

Constructs a fluent builder for the DescribeVPCConnection operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID of the account that contains the VPC connection that you want described.

    
    
  • vpc_connection_id(impl Into<String>) / set_vpc_connection_id(Option<String>):
    required: true
    

    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.

    
    
• On success, responds with DescribeVpcConnectionOutput with field(s):
  • vpc_connection(Option<VpcConnection>):

    A response object that provides information for the specified VPC connection.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<DescribeVPCConnectionError>

impl Client

pub fn generate_embed_url_for_anonymous_user( &self ) -> GenerateEmbedUrlForAnonymousUserFluentBuilder

Constructs a fluent builder for the GenerateEmbedUrlForAnonymousUser operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID for the Amazon Web Services account that contains the dashboard that you’re embedding.

    
    
  • session_lifetime_in_minutes(i64) / set_session_lifetime_in_minutes(Option<i64>):
    required: false
    

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

    
    
  • namespace(impl Into<String>) / set_namespace(Option<String>):
    required: true
    

    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.

    
    
  • session_tags(SessionTag) / set_session_tags(Option<Vec::<SessionTag>>):
    required: false
    

    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 Tagsin the Amazon QuickSight User Guide.

    
    
  • authorized_resource_arns(impl Into<String>) / set_authorized_resource_arns(Option<Vec::<String>>):
    required: true
    

    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.

    
    
  • experience_configuration(AnonymousUserEmbeddingExperienceConfiguration) / set_experience_configuration(Option<AnonymousUserEmbeddingExperienceConfiguration>):
    required: true
    

    The configuration of the experience that you are embedding.

    
    
  • allowed_domains(impl Into<String>) / set_allowed_domains(Option<Vec::<String>>):
    required: false
    

    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.

    
    
• On success, responds with GenerateEmbedUrlForAnonymousUserOutput with field(s):
  • embed_url(String):

    The embed URL for the dashboard.

  • status(i32):

    The HTTP status of the request.

  • request_id(String):

    The Amazon Web Services request ID for this operation.

  • anonymous_user_arn(String):

    The Amazon Resource Name (ARN) to use for the anonymous Amazon QuickSight user.

• On failure, responds with SdkError<GenerateEmbedUrlForAnonymousUserError>

impl Client

pub fn generate_embed_url_for_registered_user( &self ) -> GenerateEmbedUrlForRegisteredUserFluentBuilder

Constructs a fluent builder for the GenerateEmbedUrlForRegisteredUser operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID for the Amazon Web Services account that contains the dashboard that you’re embedding.

    
    
  • session_lifetime_in_minutes(i64) / set_session_lifetime_in_minutes(Option<i64>):
    required: false
    

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

    
    
  • user_arn(impl Into<String>) / set_user_arn(Option<String>):
    required: true
    

    The Amazon Resource Name for the registered user.

    
    
  • experience_configuration(RegisteredUserEmbeddingExperienceConfiguration) / set_experience_configuration(Option<RegisteredUserEmbeddingExperienceConfiguration>):
    required: true
    

    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.

    
    
  • allowed_domains(impl Into<String>) / set_allowed_domains(Option<Vec::<String>>):
    required: false
    

    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.

    
    
• On success, responds with GenerateEmbedUrlForRegisteredUserOutput with field(s):
  • embed_url(String):

    The embed URL for the Amazon QuickSight dashboard, visual, Q search bar, Generative Q&A experience, or console.

  • status(i32):

    The HTTP status of the request.

  • request_id(String):

    The Amazon Web Services request ID for this operation.

• On failure, responds with SdkError<GenerateEmbedUrlForRegisteredUserError>

impl Client

pub fn get_dashboard_embed_url(&self) -> GetDashboardEmbedUrlFluentBuilder

Constructs a fluent builder for the GetDashboardEmbedUrl operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID for the Amazon Web Services account that contains the dashboard that you’re embedding.

    
    
  • dashboard_id(impl Into<String>) / set_dashboard_id(Option<String>):
    required: true
    

    The ID for the dashboard, also added to the Identity and Access Management (IAM) policy.

    
    
  • identity_type(EmbeddingIdentityType) / set_identity_type(Option<EmbeddingIdentityType>):
    required: true
    

    The authentication method that the user uses to sign in.

    
    
  • session_lifetime_in_minutes(i64) / set_session_lifetime_in_minutes(Option<i64>):
    required: false
    

    How many minutes the session is valid. The session lifetime must be 15-600 minutes.

    
    
  • undo_redo_disabled(bool) / set_undo_redo_disabled(Option<bool>):
    required: false
    

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

    
    
  • reset_disabled(bool) / set_reset_disabled(Option<bool>):
    required: false
    

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

    
    
  • state_persistence_enabled(bool) / set_state_persistence_enabled(Option<bool>):
    required: false
    

    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.

    
    
  • user_arn(impl Into<String>) / set_user_arn(Option<String>):
    required: false
    

    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.

    
    
  • namespace(impl Into<String>) / set_namespace(Option<String>):
    required: false
    

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

    
    
  • additional_dashboard_ids(impl Into<String>) / set_additional_dashboard_ids(Option<Vec::<String>>):
    required: false
    

    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.

    
    
• On success, responds with GetDashboardEmbedUrlOutput with field(s):
  • embed_url(Option<String>):

    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.

  • status(i32):

    The HTTP status of the request.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

• On failure, responds with SdkError<GetDashboardEmbedUrlError>

impl Client

pub fn get_session_embed_url(&self) -> GetSessionEmbedUrlFluentBuilder

Constructs a fluent builder for the GetSessionEmbedUrl operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID for the Amazon Web Services account associated with your Amazon QuickSight subscription.

    
    
  • entry_point(impl Into<String>) / set_entry_point(Option<String>):
    required: false
    

    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

    
    
  • session_lifetime_in_minutes(i64) / set_session_lifetime_in_minutes(Option<i64>):
    required: false
    

    How many minutes the session is valid. The session lifetime must be 15-600 minutes.

    
    
  • user_arn(impl Into<String>) / set_user_arn(Option<String>):
    required: false
    

    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:

    1. Active Directory (AD) users or group members

    2. Invited nonfederated users

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

    
    
• On success, responds with GetSessionEmbedUrlOutput with field(s):
  • embed_url(Option<String>):

    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.

  • status(i32):

    The HTTP status of the request.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

• On failure, responds with SdkError<GetSessionEmbedUrlError>

impl Client

pub fn list_analyses(&self) -> ListAnalysesFluentBuilder

Constructs a fluent builder for the ListAnalyses operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that contains the analyses.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A pagination token that can be used in a subsequent request.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return.

    
    
• On success, responds with ListAnalysesOutput with field(s):
  • analysis_summary_list(Option<Vec::<AnalysisSummary>>):

    Metadata describing each of the analyses that are listed.

  • next_token(Option<String>):

    A pagination token that can be used in a subsequent request.

  • status(i32):

    The HTTP status of the request.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

• On failure, responds with SdkError<ListAnalysesError>

impl Client

pub fn list_asset_bundle_export_jobs( &self ) -> ListAssetBundleExportJobsFluentBuilder

Constructs a fluent builder for the ListAssetBundleExportJobs operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that the export jobs were executed in.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

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

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to be returned per request.

    
    
• On success, responds with ListAssetBundleExportJobsOutput with field(s):
  • asset_bundle_export_job_summary_list(Option<Vec::<AssetBundleExportJobSummary>>):

    A list of export job summaries.

  • next_token(Option<String>):

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

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<ListAssetBundleExportJobsError>

impl Client

pub fn list_asset_bundle_import_jobs( &self ) -> ListAssetBundleImportJobsFluentBuilder

Constructs a fluent builder for the ListAssetBundleImportJobs operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that the import jobs were executed in.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

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

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to be returned per request.

    
    
• On success, responds with ListAssetBundleImportJobsOutput with field(s):
  • asset_bundle_import_job_summary_list(Option<Vec::<AssetBundleImportJobSummary>>):

    A list of import job summaries.

  • next_token(Option<String>):

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

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the response.

• On failure, responds with SdkError<ListAssetBundleImportJobsError>

impl Client

pub fn list_dashboard_versions(&self) -> ListDashboardVersionsFluentBuilder

Constructs a fluent builder for the ListDashboardVersions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that contains the dashboard that you’re listing versions for.

    
    
  • dashboard_id(impl Into<String>) / set_dashboard_id(Option<String>):
    required: true
    

    The ID for the dashboard.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

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

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to be returned per request.

    
    
• On success, responds with ListDashboardVersionsOutput with field(s):
  • dashboard_version_summary_list(Option<Vec::<DashboardVersionSummary>>):

    A structure that contains information about each version of the dashboard.

  • next_token(Option<String>):

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

  • status(i32):

    The HTTP status of the request.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

• On failure, responds with SdkError<ListDashboardVersionsError>

impl Client

pub fn list_dashboards(&self) -> ListDashboardsFluentBuilder

Constructs a fluent builder for the ListDashboards operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that contains the dashboards that you’re listing.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

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

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to be returned per request.

    
    
• On success, responds with ListDashboardsOutput with field(s):
  • dashboard_summary_list(Option<Vec::<DashboardSummary>>):

    A structure that contains all of the dashboards in your Amazon Web Services account. This structure provides basic information about the dashboards.

  • next_token(Option<String>):

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

  • status(i32):

    The HTTP status of the request.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

• On failure, responds with SdkError<ListDashboardsError>

impl Client

pub fn list_data_sets(&self) -> ListDataSetsFluentBuilder

Constructs a fluent builder for the ListDataSets operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

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

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to be returned per request.

    
    
• On success, responds with ListDataSetsOutput with field(s):
  • data_set_summaries(Option<Vec::<DataSetSummary>>):

    The list of dataset summaries.

  • next_token(Option<String>):

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

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<ListDataSetsError>

impl Client

pub fn list_data_sources(&self) -> ListDataSourcesFluentBuilder

Constructs a fluent builder for the ListDataSources operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

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

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to be returned per request.

    
    
• On success, responds with ListDataSourcesOutput with field(s):
  • data_sources(Option<Vec::<DataSource>>):

    A list of data sources.

  • next_token(Option<String>):

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

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<ListDataSourcesError>

impl Client

pub fn list_folder_members(&self) -> ListFolderMembersFluentBuilder

Constructs a fluent builder for the ListFolderMembers operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID for the Amazon Web Services account that contains the folder.

    
    
  • folder_id(impl Into<String>) / set_folder_id(Option<String>):
    required: true
    

    The ID of the folder.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

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

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to be returned per request.

    
    
• On success, responds with ListFolderMembersOutput with field(s):
  • status(i32):

    The HTTP status of the request.

  • folder_member_list(Option<Vec::<MemberIdArnPair>>):

    A structure that contains all of the folder members (dashboards, analyses, and datasets) in the folder.

  • next_token(Option<String>):

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

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

• On failure, responds with SdkError<ListFolderMembersError>

impl Client

pub fn list_folders(&self) -> ListFoldersFluentBuilder

Constructs a fluent builder for the ListFolders operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID for the Amazon Web Services account that contains the folder.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

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

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to be returned per request.

    
    
• On success, responds with ListFoldersOutput with field(s):
  • status(i32):

    The HTTP status of the request.

  • folder_summary_list(Option<Vec::<FolderSummary>>):

    A structure that contains all of the folders in the Amazon Web Services account. This structure provides basic information about the folders.

  • next_token(Option<String>):

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

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

• On failure, responds with SdkError<ListFoldersError>

impl Client

pub fn list_group_memberships(&self) -> ListGroupMembershipsFluentBuilder

Constructs a fluent builder for the ListGroupMemberships operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • group_name(impl Into<String>) / set_group_name(Option<String>):
    required: true
    

    The name of the group that you want to see a membership list of.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A pagination token that can be used in a subsequent request.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return from this request.

    
    
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    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.

    
    
  • namespace(impl Into<String>) / set_namespace(Option<String>):
    required: true
    

    The namespace of the group that you want a list of users from.

    
    
• On success, responds with ListGroupMembershipsOutput with field(s):
  • group_member_list(Option<Vec::<GroupMember>>):

    The list of the members of the group.

  • next_token(Option<String>):

    A pagination token that can be used in a subsequent request.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<ListGroupMembershipsError>

impl Client

pub fn list_groups(&self) -> ListGroupsFluentBuilder

Constructs a fluent builder for the ListGroups operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    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.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A pagination token that can be used in a subsequent request.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return.

    
    
  • namespace(impl Into<String>) / set_namespace(Option<String>):
    required: true
    

    The namespace that you want a list of groups from.

    
    
• On success, responds with ListGroupsOutput with field(s):
  • group_list(Option<Vec::<Group>>):

    The list of the groups.

  • next_token(Option<String>):

    A pagination token that can be used in a subsequent request.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<ListGroupsError>

impl Client

pub fn list_iam_policy_assignments( &self ) -> ListIAMPolicyAssignmentsFluentBuilder

Constructs a fluent builder for the ListIAMPolicyAssignments operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that contains these IAM policy assignments.

    
    
  • assignment_status(AssignmentStatus) / set_assignment_status(Option<AssignmentStatus>):
    required: false
    

    The status of the assignments.

    
    
  • namespace(impl Into<String>) / set_namespace(Option<String>):
    required: true
    

    The namespace for the assignments.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

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

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to be returned per request.

    
    
• On success, responds with ListIamPolicyAssignmentsOutput with field(s):
  • iam_policy_assignments(Option<Vec::<IamPolicyAssignmentSummary>>):

    Information describing the IAM policy assignments.

  • next_token(Option<String>):

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

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<ListIAMPolicyAssignmentsError>

impl Client

pub fn list_iam_policy_assignments_for_user( &self ) -> ListIAMPolicyAssignmentsForUserFluentBuilder

Constructs a fluent builder for the ListIAMPolicyAssignmentsForUser operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that contains the assignments.

    
    
  • user_name(impl Into<String>) / set_user_name(Option<String>):
    required: true
    

    The name of the user.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

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

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to be returned per request.

    
    
  • namespace(impl Into<String>) / set_namespace(Option<String>):
    required: true
    

    The namespace of the assignment.

    
    
• On success, responds with ListIamPolicyAssignmentsForUserOutput with field(s):
  • active_assignments(Option<Vec::<ActiveIamPolicyAssignment>>):

    The active assignments for this user.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • next_token(Option<String>):

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

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<ListIAMPolicyAssignmentsForUserError>

impl Client

pub fn list_identity_propagation_configs( &self ) -> ListIdentityPropagationConfigsFluentBuilder

Constructs a fluent builder for the ListIdentityPropagationConfigs operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that contain the identity propagation configurations of.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to be returned.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

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

    
    
• On success, responds with ListIdentityPropagationConfigsOutput with field(s):
  • services(Option<Vec::<AuthorizedTargetsByService>>):

    A list of services and their authorized targets that the Amazon QuickSight IAM Identity Center application can access.

  • next_token(Option<String>):

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

  • status(i32):

    The HTTP status of the request.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

• On failure, responds with SdkError<ListIdentityPropagationConfigsError>

impl Client

pub fn list_ingestions(&self) -> ListIngestionsFluentBuilder

Constructs a fluent builder for the ListIngestions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • data_set_id(impl Into<String>) / set_data_set_id(Option<String>):
    required: true
    

    The ID of the dataset used in the ingestion.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

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

    
    
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to be returned per request.

    
    
• On success, responds with ListIngestionsOutput with field(s):
  • ingestions(Option<Vec::<Ingestion>>):

    A list of the ingestions.

  • next_token(Option<String>):

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

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<ListIngestionsError>

impl Client

pub fn list_namespaces(&self) -> ListNamespacesFluentBuilder

Constructs a fluent builder for the ListNamespaces operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID for the Amazon Web Services account that contains the Amazon QuickSight namespaces that you want to list.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return.

    
    
• On success, responds with ListNamespacesOutput with field(s):
  • namespaces(Option<Vec::<NamespaceInfoV2>>):

    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.

  • next_token(Option<String>):

    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.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<ListNamespacesError>

impl Client

pub fn list_refresh_schedules(&self) -> ListRefreshSchedulesFluentBuilder

Constructs a fluent builder for the ListRefreshSchedules operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID.

    
    
  • data_set_id(impl Into<String>) / set_data_set_id(Option<String>):
    required: true
    

    The ID of the dataset.

    
    
• On success, responds with ListRefreshSchedulesOutput with field(s):
  • refresh_schedules(Option<Vec::<RefreshSchedule>>):

    The list of refresh schedules for the dataset.

  • status(i32):

    The HTTP status of the request.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

• On failure, responds with SdkError<ListRefreshSchedulesError>

impl Client

pub fn list_role_memberships(&self) -> ListRoleMembershipsFluentBuilder

Constructs a fluent builder for the ListRoleMemberships operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • role(Role) / set_role(Option<Role>):
    required: true
    

    The name of the role.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A pagination token that can be used in a subsequent request.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return.

    
    
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    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.

    
    
  • namespace(impl Into<String>) / set_namespace(Option<String>):
    required: true
    

    The namespace that includes the role.

    
    
• On success, responds with ListRoleMembershipsOutput with field(s):
  • members_list(Option<Vec::<String>>):

    The list of groups associated with a role

  • next_token(Option<String>):

    A pagination token that can be used in a subsequent request.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<ListRoleMembershipsError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource that you want a list of tags for.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<Vec::<Tag>>):

    Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn list_template_aliases(&self) -> ListTemplateAliasesFluentBuilder

Constructs a fluent builder for the ListTemplateAliases operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that contains the template aliases that you’re listing.

    
    
  • template_id(impl Into<String>) / set_template_id(Option<String>):
    required: true
    

    The ID for the template.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

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

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to be returned per request.

    
    
• On success, responds with ListTemplateAliasesOutput with field(s):
  • template_alias_list(Option<Vec::<TemplateAlias>>):

    A structure containing the list of the template’s aliases.

  • status(i32):

    The HTTP status of the request.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListTemplateAliasesError>

impl Client

pub fn list_template_versions(&self) -> ListTemplateVersionsFluentBuilder

Constructs a fluent builder for the ListTemplateVersions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that contains the templates that you’re listing.

    
    
  • template_id(impl Into<String>) / set_template_id(Option<String>):
    required: true
    

    The ID for the template.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

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

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to be returned per request.

    
    
• On success, responds with ListTemplateVersionsOutput with field(s):
  • template_version_summary_list(Option<Vec::<TemplateVersionSummary>>):

    A structure containing a list of all the versions of the specified template.

  • next_token(Option<String>):

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

  • status(i32):

    The HTTP status of the request.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

• On failure, responds with SdkError<ListTemplateVersionsError>

impl Client

pub fn list_templates(&self) -> ListTemplatesFluentBuilder

Constructs a fluent builder for the ListTemplates operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that contains the templates that you’re listing.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

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

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to be returned per request.

    
    
• On success, responds with ListTemplatesOutput with field(s):
  • template_summary_list(Option<Vec::<TemplateSummary>>):

    A structure containing information about the templates in the list.

  • next_token(Option<String>):

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

  • status(i32):

    The HTTP status of the request.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

• On failure, responds with SdkError<ListTemplatesError>

impl Client

pub fn list_theme_aliases(&self) -> ListThemeAliasesFluentBuilder

Constructs a fluent builder for the ListThemeAliases operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that contains the theme aliases that you’re listing.

    
    
  • theme_id(impl Into<String>) / set_theme_id(Option<String>):
    required: true
    

    The ID for the theme.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

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

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to be returned per request.

    
    
• On success, responds with ListThemeAliasesOutput with field(s):
  • theme_alias_list(Option<Vec::<ThemeAlias>>):

    A structure containing the list of the theme’s aliases.

  • status(i32):

    The HTTP status of the request.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListThemeAliasesError>

impl Client

pub fn list_theme_versions(&self) -> ListThemeVersionsFluentBuilder

Constructs a fluent builder for the ListThemeVersions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that contains the themes that you’re listing.

    
    
  • theme_id(impl Into<String>) / set_theme_id(Option<String>):
    required: true
    

    The ID for the theme.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

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

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to be returned per request.

    
    
• On success, responds with ListThemeVersionsOutput with field(s):
  • theme_version_summary_list(Option<Vec::<ThemeVersionSummary>>):

    A structure containing a list of all the versions of the specified theme.

  • next_token(Option<String>):

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

  • status(i32):

    The HTTP status of the request.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

• On failure, responds with SdkError<ListThemeVersionsError>

impl Client

pub fn list_themes(&self) -> ListThemesFluentBuilder

Constructs a fluent builder for the ListThemes operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that contains the themes that you’re listing.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

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

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to be returned per request.

    
    
  • r#type(ThemeType) / set_type(Option<ThemeType>):
    required: false
    

    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.

    
    
• On success, responds with ListThemesOutput with field(s):
  • theme_summary_list(Option<Vec::<ThemeSummary>>):

    Information about the themes in the list.

  • next_token(Option<String>):

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

  • status(i32):

    The HTTP status of the request.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

• On failure, responds with SdkError<ListThemesError>

impl Client

pub fn list_topic_refresh_schedules( &self ) -> ListTopicRefreshSchedulesFluentBuilder

Constructs a fluent builder for the ListTopicRefreshSchedules operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that contains the topic whose refresh schedule you want described.

    
    
  • topic_id(impl Into<String>) / set_topic_id(Option<String>):
    required: true
    

    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.

    
    
• On success, responds with ListTopicRefreshSchedulesOutput with field(s):
  • topic_id(Option<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.

  • topic_arn(Option<String>):

    The Amazon Resource Name (ARN) of the topic.

  • refresh_schedules(Option<Vec::<TopicRefreshScheduleSummary>>):

    The list of topic refresh schedules.

  • status(i32):

    The HTTP status of the request.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

• On failure, responds with SdkError<ListTopicRefreshSchedulesError>

impl Client

pub fn list_topics(&self) -> ListTopicsFluentBuilder

Constructs a fluent builder for the ListTopics operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that contains the topics that you want to list.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

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

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to be returned per request.

    
    
• On success, responds with ListTopicsOutput with field(s):
  • topics_summaries(Option<Vec::<TopicSummary>>):

    A list of topic summaries.

  • next_token(Option<String>):

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

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<ListTopicsError>

impl Client

pub fn list_user_groups(&self) -> ListUserGroupsFluentBuilder

Constructs a fluent builder for the ListUserGroups operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • user_name(impl Into<String>) / set_user_name(Option<String>):
    required: true
    

    The Amazon QuickSight user name that you want to list group memberships for.

    
    
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    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.

    
    
  • namespace(impl Into<String>) / set_namespace(Option<String>):
    required: true
    

    The namespace. Currently, you should set this to default.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A pagination token that can be used in a subsequent request.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return from this request.

    
    
• On success, responds with ListUserGroupsOutput with field(s):
  • group_list(Option<Vec::<Group>>):

    The list of groups the user is a member of.

  • next_token(Option<String>):

    A pagination token that can be used in a subsequent request.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<ListUserGroupsError>

impl Client

pub fn list_users(&self) -> ListUsersFluentBuilder

Constructs a fluent builder for the ListUsers operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    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.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A pagination token that can be used in a subsequent request.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return from this request.

    
    
  • namespace(impl Into<String>) / set_namespace(Option<String>):
    required: true
    

    The namespace. Currently, you should set this to default.

    
    
• On success, responds with ListUsersOutput with field(s):
  • user_list(Option<Vec::<User>>):

    The list of users.

  • next_token(Option<String>):

    A pagination token that can be used in a subsequent request.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<ListUsersError>

impl Client

pub fn list_vpc_connections(&self) -> ListVPCConnectionsFluentBuilder

Constructs a fluent builder for the ListVPCConnections operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID of the account that contains the VPC connections that you want to list.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

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

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to be returned per request.

    
    
• On success, responds with ListVpcConnectionsOutput with field(s):
  • vpc_connection_summaries(Option<Vec::<VpcConnectionSummary>>):

    A VPCConnectionSummaries object that returns a summary of VPC connection objects.

  • next_token(Option<String>):

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

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<ListVPCConnectionsError>

impl Client

pub fn put_data_set_refresh_properties( &self ) -> PutDataSetRefreshPropertiesFluentBuilder

Constructs a fluent builder for the PutDataSetRefreshProperties operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID.

    
    
  • data_set_id(impl Into<String>) / set_data_set_id(Option<String>):
    required: true
    

    The ID of the dataset.

    
    
  • data_set_refresh_properties(DataSetRefreshProperties) / set_data_set_refresh_properties(Option<DataSetRefreshProperties>):
    required: true
    

    The dataset refresh properties.

    
    
• On success, responds with PutDataSetRefreshPropertiesOutput with field(s):
  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<PutDataSetRefreshPropertiesError>

impl Client

pub fn register_user(&self) -> RegisterUserFluentBuilder

Constructs a fluent builder for the RegisterUser operation.

• The fluent builder is configurable:
  • identity_type(IdentityType) / set_identity_type(Option<IdentityType>):
    required: true
    

    The identity type that your Amazon QuickSight account uses to manage the identity of users.

    
    
  • email(impl Into<String>) / set_email(Option<String>):
    required: true
    

    The email address of the user that you want to register.

    
    
  • user_role(UserRole) / set_user_role(Option<UserRole>):
    required: true
    

    The Amazon QuickSight role for the user. The user role can be one of the following:

    • READER: A user who has read-only access to dashboards.

    • AUTHOR: A user who can create data sources, datasets, analyses, and dashboards.

    • ADMIN: A user who is an author, who can also manage Amazon QuickSight settings.

    • RESTRICTED_READER: This role isn’t currently available for use.

    • RESTRICTED_AUTHOR: This role isn’t currently available for use.

    
    
  • iam_arn(impl Into<String>) / set_iam_arn(Option<String>):
    required: false
    

    The ARN of the IAM user or role that you are registering with Amazon QuickSight.

    
    
  • session_name(impl Into<String>) / set_session_name(Option<String>):
    required: false
    

    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 in the CLI Reference.

    
    
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    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.

    
    
  • namespace(impl Into<String>) / set_namespace(Option<String>):
    required: true
    

    The namespace. Currently, you should set this to default.

    
    
  • user_name(impl Into<String>) / set_user_name(Option<String>):
    required: false
    

    The Amazon QuickSight user name that you want to create for the user you are registering.

    
    
  • custom_permissions_name(impl Into<String>) / set_custom_permissions_name(Option<String>):
    required: false
    

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

    
    
  • external_login_federation_provider_type(impl Into<String>) / set_external_login_federation_provider_type(Option<String>):
    required: false
    

    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.

    
    
  • custom_federation_provider_url(impl Into<String>) / set_custom_federation_provider_url(Option<String>):
    required: false
    

    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.

    
    
  • external_login_id(impl Into<String>) / set_external_login_id(Option<String>):
    required: false
    

    The identity ID for a user in the external login provider.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    The tags to associate with the user.

    
    
• On success, responds with RegisterUserOutput with field(s):
  • user(Option<User>):

    The user’s user name.

  • user_invitation_url(Option<String>):

    The URL the user visits to complete registration and provide a password. This is returned only for users with an identity type of QUICKSIGHT.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<RegisterUserError>

impl Client

pub fn restore_analysis(&self) -> RestoreAnalysisFluentBuilder

Constructs a fluent builder for the RestoreAnalysis operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that contains the analysis.

    
    
  • analysis_id(impl Into<String>) / set_analysis_id(Option<String>):
    required: true
    

    The ID of the analysis that you’re restoring.

    
    
• On success, responds with RestoreAnalysisOutput with field(s):
  • status(i32):

    The HTTP status of the request.

  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the analysis that you’re restoring.

  • analysis_id(Option<String>):

    The ID of the analysis that you’re restoring.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

• On failure, responds with SdkError<RestoreAnalysisError>

impl Client

pub fn search_analyses(&self) -> SearchAnalysesFluentBuilder

Constructs a fluent builder for the SearchAnalyses operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that contains the analyses that you’re searching for.

    
    
  • filters(AnalysisSearchFilter) / set_filters(Option<Vec::<AnalysisSearchFilter>>):
    required: true
    

    The structure for the search filters that you want to apply to your search.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A pagination token that can be used in a subsequent request.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return.

    
    
• On success, responds with SearchAnalysesOutput with field(s):
  • analysis_summary_list(Option<Vec::<AnalysisSummary>>):

    Metadata describing the analyses that you searched for.

  • next_token(Option<String>):

    A pagination token that can be used in a subsequent request.

  • status(i32):

    The HTTP status of the request.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

• On failure, responds with SdkError<SearchAnalysesError>

impl Client

pub fn search_dashboards(&self) -> SearchDashboardsFluentBuilder

Constructs a fluent builder for the SearchDashboards operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that contains the user whose dashboards you’re searching for.

    
    
  • filters(DashboardSearchFilter) / set_filters(Option<Vec::<DashboardSearchFilter>>):
    required: true
    

    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” } ]

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

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

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to be returned per request.

    
    
• On success, responds with SearchDashboardsOutput with field(s):
  • dashboard_summary_list(Option<Vec::<DashboardSummary>>):

    The list of dashboards owned by the user specified in Filters in your request.

  • next_token(Option<String>):

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

  • status(i32):

    The HTTP status of the request.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

• On failure, responds with SdkError<SearchDashboardsError>

impl Client

pub fn search_data_sets(&self) -> SearchDataSetsFluentBuilder

Constructs a fluent builder for the SearchDataSets operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID.

    
    
  • filters(DataSetSearchFilter) / set_filters(Option<Vec::<DataSetSearchFilter>>):
    required: true
    

    The filters to apply to the search.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A pagination token that can be used in a subsequent request.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to be returned per request.

    
    
• On success, responds with SearchDataSetsOutput with field(s):
  • data_set_summaries(Option<Vec::<DataSetSummary>>):

    A DataSetSummaries object that returns a summary of a dataset.

  • next_token(Option<String>):

    A pagination token that can be used in a subsequent request.

  • status(i32):

    The HTTP status of the request.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

• On failure, responds with SdkError<SearchDataSetsError>

impl Client

pub fn search_data_sources(&self) -> SearchDataSourcesFluentBuilder

Constructs a fluent builder for the SearchDataSources operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID.

    
    
  • filters(DataSourceSearchFilter) / set_filters(Option<Vec::<DataSourceSearchFilter>>):
    required: true
    

    The filters to apply to the search.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A pagination token that can be used in a subsequent request.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to be returned per request.

    
    
• On success, responds with SearchDataSourcesOutput with field(s):
  • data_source_summaries(Option<Vec::<DataSourceSummary>>):

    A DataSourceSummaries object that returns a summary of a data source.

  • next_token(Option<String>):

    A pagination token that can be used in a subsequent request.

  • status(i32):

    The HTTP status of the request.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

• On failure, responds with SdkError<SearchDataSourcesError>

impl Client

pub fn search_folders(&self) -> SearchFoldersFluentBuilder

Constructs a fluent builder for the SearchFolders operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID for the Amazon Web Services account that contains the folder.

    
    
  • filters(FolderSearchFilter) / set_filters(Option<Vec::<FolderSearchFilter>>):
    required: true
    

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

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

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

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to be returned per request.

    
    
• On success, responds with SearchFoldersOutput with field(s):
  • status(i32):

    The HTTP status of the request.

  • folder_summary_list(Option<Vec::<FolderSummary>>):

    A structure that contains all of the folders in the Amazon Web Services account. This structure provides basic information about the folders.

  • next_token(Option<String>):

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

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

• On failure, responds with SdkError<SearchFoldersError>

impl Client

pub fn search_groups(&self) -> SearchGroupsFluentBuilder

Constructs a fluent builder for the SearchGroups operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    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.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A pagination token that can be used in a subsequent request.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return from this request.

    
    
  • namespace(impl Into<String>) / set_namespace(Option<String>):
    required: true
    

    The namespace that you want to search.

    
    
  • filters(GroupSearchFilter) / set_filters(Option<Vec::<GroupSearchFilter>>):
    required: true
    

    The structure for the search filters that you want to apply to your search.

    
    
• On success, responds with SearchGroupsOutput with field(s):
  • group_list(Option<Vec::<Group>>):

    A list of groups in a specified namespace that match the filters you set in your SearchGroups request.

  • next_token(Option<String>):

    A pagination token that can be used in a subsequent request.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<SearchGroupsError>

impl Client

pub fn start_asset_bundle_export_job( &self ) -> StartAssetBundleExportJobFluentBuilder

Constructs a fluent builder for the StartAssetBundleExportJob operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account to export assets from.

    
    
  • asset_bundle_export_job_id(impl Into<String>) / set_asset_bundle_export_job_id(Option<String>):
    required: true
    

    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.

    
    
  • resource_arns(impl Into<String>) / set_resource_arns(Option<Vec::<String>>):
    required: true
    

    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.

    
    
  • include_all_dependencies(bool) / set_include_all_dependencies(Option<bool>):
    required: false
    

    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.

    
    
  • export_format(AssetBundleExportFormat) / set_export_format(Option<AssetBundleExportFormat>):
    required: true
    

    The export data format.

    
    
  • cloud_formation_override_property_configuration(AssetBundleCloudFormationOverridePropertyConfiguration) / set_cloud_formation_override_property_configuration(Option<AssetBundleCloudFormationOverridePropertyConfiguration>):
    required: false
    

    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.

    
    
  • include_permissions(bool) / set_include_permissions(Option<bool>):
    required: false
    

    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.

    
    
  • include_tags(bool) / set_include_tags(Option<bool>):
    required: false
    

    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.

    
    
  • validation_strategy(AssetBundleExportJobValidationStrategy) / set_validation_strategy(Option<AssetBundleExportJobValidationStrategy>):
    required: false
    

    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.

    
    
• On success, responds with StartAssetBundleExportJobOutput with field(s):
  • arn(Option<String>):

    The Amazon Resource Name (ARN) for the export job.

  • asset_bundle_export_job_id(Option<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.

  • request_id(Option<String>):

    The Amazon Web Services response ID for this operation.

  • status(i32):

    The HTTP status of the response.

• On failure, responds with SdkError<StartAssetBundleExportJobError>

impl Client

pub fn start_asset_bundle_import_job( &self ) -> StartAssetBundleImportJobFluentBuilder

Constructs a fluent builder for the StartAssetBundleImportJob operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account to import assets into.

    
    
  • asset_bundle_import_job_id(impl Into<String>) / set_asset_bundle_import_job_id(Option<String>):
    required: true
    

    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.

    
    
  • asset_bundle_import_source(AssetBundleImportSource) / set_asset_bundle_import_source(Option<AssetBundleImportSource>):
    required: true
    

    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.

    
    
  • override_parameters(AssetBundleImportJobOverrideParameters) / set_override_parameters(Option<AssetBundleImportJobOverrideParameters>):
    required: false
    

    Optional overrides that are applied to the resource configuration before import.

    
    
  • failure_action(AssetBundleImportFailureAction) / set_failure_action(Option<AssetBundleImportFailureAction>):
    required: false
    

    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.

    
    
  • override_permissions(AssetBundleImportJobOverridePermissions) / set_override_permissions(Option<AssetBundleImportJobOverridePermissions>):
    required: false
    

    Optional permission overrides that are applied to the resource configuration before import.

    
    
  • override_tags(AssetBundleImportJobOverrideTags) / set_override_tags(Option<AssetBundleImportJobOverrideTags>):
    required: false
    

    Optional tag overrides that are applied to the resource configuration before import.

    
    
  • override_validation_strategy(AssetBundleImportJobOverrideValidationStrategy) / set_override_validation_strategy(Option<AssetBundleImportJobOverrideValidationStrategy>):
    required: false
    

    An optional validation strategy override for all analyses and dashboards that is applied to the resource configuration before import.

    
    
• On success, responds with StartAssetBundleImportJobOutput with field(s):
  • arn(Option<String>):

    The Amazon Resource Name (ARN) for the import job.

  • asset_bundle_import_job_id(Option<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.

  • request_id(Option<String>):

    The Amazon Web Services response ID for this operation.

  • status(i32):

    The HTTP status of the response.

• On failure, responds with SdkError<StartAssetBundleImportJobError>

impl Client

pub fn start_dashboard_snapshot_job( &self ) -> StartDashboardSnapshotJobFluentBuilder

Constructs a fluent builder for the StartDashboardSnapshotJob operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

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

    
    
  • dashboard_id(impl Into<String>) / set_dashboard_id(Option<String>):
    required: true
    

    The ID of the dashboard that you want to start a snapshot job for.

    
    
  • snapshot_job_id(impl Into<String>) / set_snapshot_job_id(Option<String>):
    required: true
    

    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.

    
    
  • user_configuration(SnapshotUserConfiguration) / set_user_configuration(Option<SnapshotUserConfiguration>):
    required: true
    

    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.

    
    
  • snapshot_configuration(SnapshotConfiguration) / set_snapshot_configuration(Option<SnapshotConfiguration>):
    required: true
    

    A structure that describes the configuration of the dashboard snapshot.

    
    
• On success, responds with StartDashboardSnapshotJobOutput with field(s):
  • arn(Option<String>):

    The Amazon Resource Name (ARN) for the dashboard snapshot job.

  • snapshot_job_id(Option<String>):

    The ID of the job. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request

• On failure, responds with SdkError<StartDashboardSnapshotJobError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource that you want to tag.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: true
    

    Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.

    
    
• On success, responds with TagResourceOutput with field(s):
  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource that you want to untag.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    The keys of the key-value pairs for the resource tag or tags assigned to the resource.

    
    
• On success, responds with UntagResourceOutput with field(s):
  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_account_customization( &self ) -> UpdateAccountCustomizationFluentBuilder

Constructs a fluent builder for the UpdateAccountCustomization operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID for the Amazon Web Services account that you want to update Amazon QuickSight customizations for.

    
    
  • namespace(impl Into<String>) / set_namespace(Option<String>):
    required: false
    

    The namespace that you want to update Amazon QuickSight customizations for.

    
    
  • account_customization(AccountCustomization) / set_account_customization(Option<AccountCustomization>):
    required: true
    

    The Amazon QuickSight customizations you’re updating in the current Amazon Web Services Region.

    
    
• On success, responds with UpdateAccountCustomizationOutput with field(s):
  • arn(Option<String>):

    The Amazon Resource Name (ARN) for the updated customization for this Amazon Web Services account.

  • aws_account_id(Option<String>):

    The ID for the Amazon Web Services account that you want to update Amazon QuickSight customizations for.

  • namespace(Option<String>):

    The namespace associated with the customization that you’re updating.

  • account_customization(Option<AccountCustomization>):

    The Amazon QuickSight customizations you’re updating in the current Amazon Web Services Region.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<UpdateAccountCustomizationError>

impl Client

pub fn update_account_settings(&self) -> UpdateAccountSettingsFluentBuilder

Constructs a fluent builder for the UpdateAccountSettings operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID for the Amazon Web Services account that contains the Amazon QuickSight settings that you want to list.

    
    
  • default_namespace(impl Into<String>) / set_default_namespace(Option<String>):
    required: true
    

    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.

    
    
  • notification_email(impl Into<String>) / set_notification_email(Option<String>):
    required: false
    

    The email address that you want Amazon QuickSight to send notifications to regarding your Amazon Web Services account or Amazon QuickSight subscription.

    
    
  • termination_protection_enabled(bool) / set_termination_protection_enabled(Option<bool>):
    required: false
    

    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.

    
    
• On success, responds with UpdateAccountSettingsOutput with field(s):
  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<UpdateAccountSettingsError>

impl Client

pub fn update_analysis(&self) -> UpdateAnalysisFluentBuilder

Constructs a fluent builder for the UpdateAnalysis operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that contains the analysis that you’re updating.

    
    
  • analysis_id(impl Into<String>) / set_analysis_id(Option<String>):
    required: true
    

    The ID for the analysis that you’re updating. This ID displays in the URL of the analysis.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    A descriptive name for the analysis that you’re updating. This name displays for the analysis in the Amazon QuickSight console.

    
    
  • parameters(Parameters) / set_parameters(Option<Parameters>):
    required: false
    

    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.

    
    
  • source_entity(AnalysisSourceEntity) / set_source_entity(Option<AnalysisSourceEntity>):
    required: false
    

    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.

    
    
  • theme_arn(impl Into<String>) / set_theme_arn(Option<String>):
    required: false
    

    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.

    
    
  • definition(AnalysisDefinition) / set_definition(Option<AnalysisDefinition>):
    required: false
    

    The definition of an analysis.

    A definition is the data model of all features in a Dashboard, Template, or Analysis.

    
    
  • validation_strategy(ValidationStrategy) / set_validation_strategy(Option<ValidationStrategy>):
    required: false
    

    The option to relax the validation needed to update an analysis with definition objects. This skips the validation step for specific errors.

    
    
• On success, responds with UpdateAnalysisOutput with field(s):
  • arn(Option<String>):

    The ARN of the analysis that you’re updating.

  • analysis_id(Option<String>):

    The ID of the analysis.

  • update_status(Option<ResourceStatus>):

    The update status of the last update that was made to the analysis.

  • status(i32):

    The HTTP status of the request.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

• On failure, responds with SdkError<UpdateAnalysisError>

impl Client

pub fn update_analysis_permissions( &self ) -> UpdateAnalysisPermissionsFluentBuilder

Constructs a fluent builder for the UpdateAnalysisPermissions operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    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.

    
    
  • analysis_id(impl Into<String>) / set_analysis_id(Option<String>):
    required: true
    

    The ID of the analysis whose permissions you’re updating. The ID is part of the analysis URL.

    
    
  • grant_permissions(ResourcePermission) / set_grant_permissions(Option<Vec::<ResourcePermission>>):
    required: false
    

    A structure that describes the permissions to add and the principal to add them to.

    
    
  • revoke_permissions(ResourcePermission) / set_revoke_permissions(Option<Vec::<ResourcePermission>>):
    required: false
    

    A structure that describes the permissions to remove and the principal to remove them from.

    
    
• On success, responds with UpdateAnalysisPermissionsOutput with field(s):
  • analysis_arn(Option<String>):

    The Amazon Resource Name (ARN) of the analysis that you updated.

  • analysis_id(Option<String>):

    The ID of the analysis that you updated permissions for.

  • permissions(Option<Vec::<ResourcePermission>>):

    A structure that describes the principals and the resource-level permissions on an analysis.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<UpdateAnalysisPermissionsError>

impl Client

pub fn update_dashboard(&self) -> UpdateDashboardFluentBuilder

Constructs a fluent builder for the UpdateDashboard operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that contains the dashboard that you’re updating.

    
    
  • dashboard_id(impl Into<String>) / set_dashboard_id(Option<String>):
    required: true
    

    The ID for the dashboard.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The display name of the dashboard.

    
    
  • source_entity(DashboardSourceEntity) / set_source_entity(Option<DashboardSourceEntity>):
    required: false
    

    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.

    
    
  • parameters(Parameters) / set_parameters(Option<Parameters>):
    required: false
    

    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.

    
    
  • version_description(impl Into<String>) / set_version_description(Option<String>):
    required: false
    

    A description for the first version of the dashboard being created.

    
    
  • dashboard_publish_options(DashboardPublishOptions) / set_dashboard_publish_options(Option<DashboardPublishOptions>):
    required: false
    

    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.

    
    
  • theme_arn(impl Into<String>) / set_theme_arn(Option<String>):
    required: false
    

    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.

    
    
  • definition(DashboardVersionDefinition) / set_definition(Option<DashboardVersionDefinition>):
    required: false
    

    The definition of a dashboard.

    A definition is the data model of all features in a Dashboard, Template, or Analysis.

    
    
  • validation_strategy(ValidationStrategy) / set_validation_strategy(Option<ValidationStrategy>):
    required: false
    

    The option to relax the validation needed to update a dashboard with definition objects. This skips the validation step for specific errors.

    
    
• On success, responds with UpdateDashboardOutput with field(s):
  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the resource.

  • version_arn(Option<String>):

    The ARN of the dashboard, including the version number.

  • dashboard_id(Option<String>):

    The ID for the dashboard.

  • creation_status(Option<ResourceStatus>):

    The creation status of the request.

  • status(i32):

    The HTTP status of the request.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

• On failure, responds with SdkError<UpdateDashboardError>

impl Client

pub fn update_dashboard_links(&self) -> UpdateDashboardLinksFluentBuilder

Constructs a fluent builder for the UpdateDashboardLinks operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that contains the dashboard whose links you want to update.

    
    
  • dashboard_id(impl Into<String>) / set_dashboard_id(Option<String>):
    required: true
    

    The ID for the dashboard.

    
    
  • link_entities(impl Into<String>) / set_link_entities(Option<Vec::<String>>):
    required: true
    

    list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

    
    
• On success, responds with UpdateDashboardLinksOutput with field(s):
  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

  • dashboard_arn(Option<String>):

    The Amazon Resource Name (ARN) of the dashboard.

  • link_entities(Option<Vec::<String>>):

    A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

• On failure, responds with SdkError<UpdateDashboardLinksError>

impl Client

pub fn update_dashboard_permissions( &self ) -> UpdateDashboardPermissionsFluentBuilder

Constructs a fluent builder for the UpdateDashboardPermissions operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that contains the dashboard whose permissions you’re updating.

    
    
  • dashboard_id(impl Into<String>) / set_dashboard_id(Option<String>):
    required: true
    

    The ID for the dashboard.

    
    
  • grant_permissions(ResourcePermission) / set_grant_permissions(Option<Vec::<ResourcePermission>>):
    required: false
    

    The permissions that you want to grant on this resource.

    
    
  • revoke_permissions(ResourcePermission) / set_revoke_permissions(Option<Vec::<ResourcePermission>>):
    required: false
    

    The permissions that you want to revoke from this resource.

    
    
  • grant_link_permissions(ResourcePermission) / set_grant_link_permissions(Option<Vec::<ResourcePermission>>):
    required: false
    

    Grants link permissions to all users in a defined namespace.

    
    
  • revoke_link_permissions(ResourcePermission) / set_revoke_link_permissions(Option<Vec::<ResourcePermission>>):
    required: false
    

    Revokes link permissions from all users in a defined namespace.

    
    
• On success, responds with UpdateDashboardPermissionsOutput with field(s):
  • dashboard_arn(Option<String>):

    The Amazon Resource Name (ARN) of the dashboard.

  • dashboard_id(Option<String>):

    The ID for the dashboard.

  • permissions(Option<Vec::<ResourcePermission>>):

    Information about the permissions on the dashboard.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

  • link_sharing_configuration(Option<LinkSharingConfiguration>):

    Updates the permissions of a shared link to an Amazon QuickSight dashboard.

• On failure, responds with SdkError<UpdateDashboardPermissionsError>

impl Client

pub fn update_dashboard_published_version( &self ) -> UpdateDashboardPublishedVersionFluentBuilder

Constructs a fluent builder for the UpdateDashboardPublishedVersion operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that contains the dashboard that you’re updating.

    
    
  • dashboard_id(impl Into<String>) / set_dashboard_id(Option<String>):
    required: true
    

    The ID for the dashboard.

    
    
  • version_number(i64) / set_version_number(Option<i64>):
    required: true
    

    The version number of the dashboard.

    
    
• On success, responds with UpdateDashboardPublishedVersionOutput with field(s):
  • dashboard_id(Option<String>):

    The ID for the dashboard.

  • dashboard_arn(Option<String>):

    The Amazon Resource Name (ARN) of the dashboard.

  • status(i32):

    The HTTP status of the request.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

• On failure, responds with SdkError<UpdateDashboardPublishedVersionError>

impl Client

pub fn update_data_set(&self) -> UpdateDataSetFluentBuilder

Constructs a fluent builder for the UpdateDataSet operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID.

    
    
  • data_set_id(impl Into<String>) / set_data_set_id(Option<String>):
    required: true
    

    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.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The display name for the dataset.

    
    
  • physical_table_map(impl Into<String>, PhysicalTable) / set_physical_table_map(Option<HashMap::<String, PhysicalTable>>):
    required: true
    

    Declares the physical tables that are available in the underlying data sources.

    
    
  • logical_table_map(impl Into<String>, LogicalTable) / set_logical_table_map(Option<HashMap::<String, LogicalTable>>):
    required: false
    

    Configures the combination and transformation of the data from the physical tables.

    
    
  • import_mode(DataSetImportMode) / set_import_mode(Option<DataSetImportMode>):
    required: true
    

    Indicates whether you want to import the data into SPICE.

    
    
  • column_groups(ColumnGroup) / set_column_groups(Option<Vec::<ColumnGroup>>):
    required: false
    

    Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.

    
    
  • field_folders(impl Into<String>, FieldFolder) / set_field_folders(Option<HashMap::<String, FieldFolder>>):
    required: false
    

    The folder that contains fields and nested subfolders for your dataset.

    
    
  • row_level_permission_data_set(RowLevelPermissionDataSet) / set_row_level_permission_data_set(Option<RowLevelPermissionDataSet>):
    required: false
    

    The row-level security configuration for the data you want to create.

    
    
  • row_level_permission_tag_configuration(RowLevelPermissionTagConfiguration) / set_row_level_permission_tag_configuration(Option<RowLevelPermissionTagConfiguration>):
    required: false
    

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

    
    
  • column_level_permission_rules(ColumnLevelPermissionRule) / set_column_level_permission_rules(Option<Vec::<ColumnLevelPermissionRule>>):
    required: false
    

    A set of one or more definitions of a ColumnLevelPermissionRule .

    
    
  • data_set_usage_configuration(DataSetUsageConfiguration) / set_data_set_usage_configuration(Option<DataSetUsageConfiguration>):
    required: false
    

    The usage configuration to apply to child datasets that reference this dataset as a source.

    
    
  • dataset_parameters(DatasetParameter) / set_dataset_parameters(Option<Vec::<DatasetParameter>>):
    required: false
    

    The parameter declarations of the dataset.

    
    
• On success, responds with UpdateDataSetOutput with field(s):
  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the dataset.

  • data_set_id(Option<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.

  • ingestion_arn(Option<String>):

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

  • ingestion_id(Option<String>):

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

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<UpdateDataSetError>

impl Client

pub fn update_data_set_permissions( &self ) -> UpdateDataSetPermissionsFluentBuilder

Constructs a fluent builder for the UpdateDataSetPermissions operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID.

    
    
  • data_set_id(impl Into<String>) / set_data_set_id(Option<String>):
    required: true
    

    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.

    
    
  • grant_permissions(ResourcePermission) / set_grant_permissions(Option<Vec::<ResourcePermission>>):
    required: false
    

    The resource permissions that you want to grant to the dataset.

    
    
  • revoke_permissions(ResourcePermission) / set_revoke_permissions(Option<Vec::<ResourcePermission>>):
    required: false
    

    The resource permissions that you want to revoke from the dataset.

    
    
• On success, responds with UpdateDataSetPermissionsOutput with field(s):
  • data_set_arn(Option<String>):

    The Amazon Resource Name (ARN) of the dataset.

  • data_set_id(Option<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.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<UpdateDataSetPermissionsError>

impl Client

pub fn update_data_source(&self) -> UpdateDataSourceFluentBuilder

Constructs a fluent builder for the UpdateDataSource operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID.

    
    
  • data_source_id(impl Into<String>) / set_data_source_id(Option<String>):
    required: true
    

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

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    A display name for the data source.

    
    
  • data_source_parameters(DataSourceParameters) / set_data_source_parameters(Option<DataSourceParameters>):
    required: false
    

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

    
    
  • credentials(DataSourceCredentials) / set_credentials(Option<DataSourceCredentials>):
    required: false
    

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

    
    
  • vpc_connection_properties(VpcConnectionProperties) / set_vpc_connection_properties(Option<VpcConnectionProperties>):
    required: false
    

    Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.

    
    
  • ssl_properties(SslProperties) / set_ssl_properties(Option<SslProperties>):
    required: false
    

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

    
    
• On success, responds with UpdateDataSourceOutput with field(s):
  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the data source.

  • data_source_id(Option<String>):

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

  • update_status(Option<ResourceStatus>):

    The update status of the data source’s last update.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<UpdateDataSourceError>

impl Client

pub fn update_data_source_permissions( &self ) -> UpdateDataSourcePermissionsFluentBuilder

Constructs a fluent builder for the UpdateDataSourcePermissions operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID.

    
    
  • data_source_id(impl Into<String>) / set_data_source_id(Option<String>):
    required: true
    

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

    
    
  • grant_permissions(ResourcePermission) / set_grant_permissions(Option<Vec::<ResourcePermission>>):
    required: false
    

    A list of resource permissions that you want to grant on the data source.

    
    
  • revoke_permissions(ResourcePermission) / set_revoke_permissions(Option<Vec::<ResourcePermission>>):
    required: false
    

    A list of resource permissions that you want to revoke on the data source.

    
    
• On success, responds with UpdateDataSourcePermissionsOutput with field(s):
  • data_source_arn(Option<String>):

    The Amazon Resource Name (ARN) of the data source.

  • data_source_id(Option<String>):

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

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<UpdateDataSourcePermissionsError>

impl Client

pub fn update_folder(&self) -> UpdateFolderFluentBuilder

Constructs a fluent builder for the UpdateFolder operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID for the Amazon Web Services account that contains the folder to update.

    
    
  • folder_id(impl Into<String>) / set_folder_id(Option<String>):
    required: true
    

    The ID of the folder.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the folder.

    
    
• On success, responds with UpdateFolderOutput with field(s):
  • status(i32):

    The HTTP status of the request.

  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the folder.

  • folder_id(Option<String>):

    The ID of the folder.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

• On failure, responds with SdkError<UpdateFolderError>

impl Client

pub fn update_folder_permissions(&self) -> UpdateFolderPermissionsFluentBuilder

Constructs a fluent builder for the UpdateFolderPermissions operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID for the Amazon Web Services account that contains the folder to update.

    
    
  • folder_id(impl Into<String>) / set_folder_id(Option<String>):
    required: true
    

    The ID of the folder.

    
    
  • grant_permissions(ResourcePermission) / set_grant_permissions(Option<Vec::<ResourcePermission>>):
    required: false
    

    The permissions that you want to grant on a resource. Namespace ARNs are not supported Principal values for folder permissions.

    
    
  • revoke_permissions(ResourcePermission) / set_revoke_permissions(Option<Vec::<ResourcePermission>>):
    required: false
    

    The permissions that you want to revoke from a resource. Namespace ARNs are not supported Principal values for folder permissions.

    
    
• On success, responds with UpdateFolderPermissionsOutput with field(s):
  • status(i32):

    The HTTP status of the request.

  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the folder.

  • folder_id(Option<String>):

    The ID of the folder.

  • permissions(Option<Vec::<ResourcePermission>>):

    Information about the permissions for the folder.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

• On failure, responds with SdkError<UpdateFolderPermissionsError>

impl Client

pub fn update_group(&self) -> UpdateGroupFluentBuilder

Constructs a fluent builder for the UpdateGroup operation.

• The fluent builder is configurable:
  • group_name(impl Into<String>) / set_group_name(Option<String>):
    required: true
    

    The name of the group that you want to update.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description for the group that you want to update.

    
    
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    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.

    
    
  • namespace(impl Into<String>) / set_namespace(Option<String>):
    required: true
    

    The namespace of the group that you want to update.

    
    
• On success, responds with UpdateGroupOutput with field(s):
  • group(Option<Group>):

    The name of the group.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<UpdateGroupError>

impl Client

pub fn update_iam_policy_assignment( &self ) -> UpdateIAMPolicyAssignmentFluentBuilder

Constructs a fluent builder for the UpdateIAMPolicyAssignment operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that contains the IAM policy assignment.

    
    
  • assignment_name(impl Into<String>) / set_assignment_name(Option<String>):
    required: true
    

    The name of the assignment, also called a rule. The name must be unique within the Amazon Web Services account.

    
    
  • namespace(impl Into<String>) / set_namespace(Option<String>):
    required: true
    

    The namespace of the assignment.

    
    
  • assignment_status(AssignmentStatus) / set_assignment_status(Option<AssignmentStatus>):
    required: false
    

    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.

    
    
  • policy_arn(impl Into<String>) / set_policy_arn(Option<String>):
    required: false
    

    The ARN for the IAM policy to apply to the Amazon QuickSight users and groups specified in this assignment.

    
    
  • identities(impl Into<String>, Vec::<String>) / set_identities(Option<HashMap::<String, Vec::<String>>>):
    required: false
    

    The Amazon QuickSight users, groups, or both that you want to assign the policy to.

    
    
• On success, responds with UpdateIamPolicyAssignmentOutput with field(s):
  • assignment_name(Option<String>):

    The name of the assignment or rule.

  • assignment_id(Option<String>):

    The ID of the assignment.

  • policy_arn(Option<String>):

    The ARN for the IAM policy applied to the Amazon QuickSight users and groups specified in this assignment.

  • identities(Option<HashMap::<String, Vec::<String>>>):

    The Amazon QuickSight users, groups, or both that the IAM policy is assigned to.

  • assignment_status(Option<AssignmentStatus>):

    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.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<UpdateIAMPolicyAssignmentError>

impl Client

pub fn update_identity_propagation_config( &self ) -> UpdateIdentityPropagationConfigFluentBuilder

Constructs a fluent builder for the UpdateIdentityPropagationConfig operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that contains the identity propagation configuration that you want to update.

    
    
  • service(ServiceType) / set_service(Option<ServiceType>):
    required: true
    

    The name of the Amazon Web Services service that contains the authorized targets that you want to add or update.

    
    
  • authorized_targets(impl Into<String>) / set_authorized_targets(Option<Vec::<String>>):
    required: false
    

    Specifies a list of application ARNs that represent the authorized targets for a service.

    
    
• On success, responds with UpdateIdentityPropagationConfigOutput with field(s):
  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<UpdateIdentityPropagationConfigError>

impl Client

pub fn update_ip_restriction(&self) -> UpdateIpRestrictionFluentBuilder

Constructs a fluent builder for the UpdateIpRestriction operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that contains the IP rules.

    
    
  • ip_restriction_rule_map(impl Into<String>, impl Into<String>) / set_ip_restriction_rule_map(Option<HashMap::<String, String>>):
    required: false
    

    A map that describes the updated IP rules with CIDR ranges and descriptions.

    
    
  • vpc_id_restriction_rule_map(impl Into<String>, impl Into<String>) / set_vpc_id_restriction_rule_map(Option<HashMap::<String, String>>):
    required: false
    

    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.

    
    
  • vpc_endpoint_id_restriction_rule_map(impl Into<String>, impl Into<String>) / set_vpc_endpoint_id_restriction_rule_map(Option<HashMap::<String, String>>):
    required: false
    

    A map of allowed VPC endpoint IDs and their corresponding rule descriptions.

    
    
  • enabled(bool) / set_enabled(Option<bool>):
    required: false
    

    A value that specifies whether IP rules are turned on.

    
    
• On success, responds with UpdateIpRestrictionOutput with field(s):
  • aws_account_id(Option<String>):

    The ID of the Amazon Web Services account that contains the IP rules.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<UpdateIpRestrictionError>

impl Client

pub fn update_public_sharing_settings( &self ) -> UpdatePublicSharingSettingsFluentBuilder

Constructs a fluent builder for the UpdatePublicSharingSettings operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID associated with your Amazon QuickSight subscription.

    
    
  • public_sharing_enabled(bool) / set_public_sharing_enabled(Option<bool>):
    required: false
    

    A Boolean value that indicates whether public sharing is turned on for an Amazon QuickSight account.

    
    
• On success, responds with UpdatePublicSharingSettingsOutput with field(s):
  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<UpdatePublicSharingSettingsError>

impl Client

pub fn update_refresh_schedule(&self) -> UpdateRefreshScheduleFluentBuilder

Constructs a fluent builder for the UpdateRefreshSchedule operation.

• The fluent builder is configurable:
  • data_set_id(impl Into<String>) / set_data_set_id(Option<String>):
    required: true
    

    The ID of the dataset.

    
    
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID.

    
    
  • schedule(RefreshSchedule) / set_schedule(Option<RefreshSchedule>):
    required: true
    

    The refresh schedule.

    
    
• On success, responds with UpdateRefreshScheduleOutput with field(s):
  • status(i32):

    The HTTP status of the request.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • schedule_id(Option<String>):

    The ID of the refresh schedule.

  • arn(Option<String>):

    The Amazon Resource Name (ARN) for the refresh schedule.

• On failure, responds with SdkError<UpdateRefreshScheduleError>

impl Client

pub fn update_role_custom_permission( &self ) -> UpdateRoleCustomPermissionFluentBuilder

Constructs a fluent builder for the UpdateRoleCustomPermission operation.

• The fluent builder is configurable:
  • custom_permissions_name(impl Into<String>) / set_custom_permissions_name(Option<String>):
    required: true
    

    The name of the custom permission that you want to update the role with.

    
    
  • role(Role) / set_role(Option<Role>):
    required: true
    

    The name of role tht you want to update.

    
    
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    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.

    
    
  • namespace(impl Into<String>) / set_namespace(Option<String>):
    required: true
    

    The namespace that contains the role that you want to update.

    
    
• On success, responds with UpdateRoleCustomPermissionOutput with field(s):
  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<UpdateRoleCustomPermissionError>

impl Client

pub fn update_spice_capacity_configuration( &self ) -> UpdateSPICECapacityConfigurationFluentBuilder

Constructs a fluent builder for the UpdateSPICECapacityConfiguration operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that contains the SPICE configuration that you want to update.

    
    
  • purchase_mode(PurchaseMode) / set_purchase_mode(Option<PurchaseMode>):
    required: true
    

    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.

    
    
• On success, responds with UpdateSpiceCapacityConfigurationOutput with field(s):
  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<UpdateSPICECapacityConfigurationError>

impl Client

pub fn update_template(&self) -> UpdateTemplateFluentBuilder

Constructs a fluent builder for the UpdateTemplate operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that contains the template that you’re updating.

    
    
  • template_id(impl Into<String>) / set_template_id(Option<String>):
    required: true
    

    The ID for the template.

    
    
  • source_entity(TemplateSourceEntity) / set_source_entity(Option<TemplateSourceEntity>):
    required: false
    

    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.

    
    
  • version_description(impl Into<String>) / set_version_description(Option<String>):
    required: false
    

    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.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The name for the template.

    
    
  • definition(TemplateVersionDefinition) / set_definition(Option<TemplateVersionDefinition>):
    required: false
    

    The definition of a template.

    A definition is the data model of all features in a Dashboard, Template, or Analysis.

    
    
  • validation_strategy(ValidationStrategy) / set_validation_strategy(Option<ValidationStrategy>):
    required: false
    

    The option to relax the validation needed to update a template with definition objects. This skips the validation step for specific errors.

    
    
• On success, responds with UpdateTemplateOutput with field(s):
  • template_id(Option<String>):

    The ID for the template.

  • arn(Option<String>):

    The Amazon Resource Name (ARN) for the template.

  • version_arn(Option<String>):

    The ARN for the template, including the version information of the first version.

  • creation_status(Option<ResourceStatus>):

    The creation status of the template.

  • status(i32):

    The HTTP status of the request.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

• On failure, responds with SdkError<UpdateTemplateError>

impl Client

pub fn update_template_alias(&self) -> UpdateTemplateAliasFluentBuilder

Constructs a fluent builder for the UpdateTemplateAlias operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that contains the template alias that you’re updating.

    
    
  • template_id(impl Into<String>) / set_template_id(Option<String>):
    required: true
    

    The ID for the template.

    
    
  • alias_name(impl Into<String>) / set_alias_name(Option<String>):
    required: true
    

    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.

    
    
  • template_version_number(i64) / set_template_version_number(Option<i64>):
    required: true
    

    The version number of the template.

    
    
• On success, responds with UpdateTemplateAliasOutput with field(s):
  • template_alias(Option<TemplateAlias>):

    The template alias.

  • status(i32):

    The HTTP status of the request.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

• On failure, responds with SdkError<UpdateTemplateAliasError>

impl Client

pub fn update_template_permissions( &self ) -> UpdateTemplatePermissionsFluentBuilder

Constructs a fluent builder for the UpdateTemplatePermissions operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that contains the template.

    
    
  • template_id(impl Into<String>) / set_template_id(Option<String>):
    required: true
    

    The ID for the template.

    
    
  • grant_permissions(ResourcePermission) / set_grant_permissions(Option<Vec::<ResourcePermission>>):
    required: false
    

    A list of resource permissions to be granted on the template.

    
    
  • revoke_permissions(ResourcePermission) / set_revoke_permissions(Option<Vec::<ResourcePermission>>):
    required: false
    

    A list of resource permissions to be revoked from the template.

    
    
• On success, responds with UpdateTemplatePermissionsOutput with field(s):
  • template_id(Option<String>):

    The ID for the template.

  • template_arn(Option<String>):

    The Amazon Resource Name (ARN) of the template.

  • permissions(Option<Vec::<ResourcePermission>>):

    A list of resource permissions to be set on the template.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<UpdateTemplatePermissionsError>

impl Client

pub fn update_theme(&self) -> UpdateThemeFluentBuilder

Constructs a fluent builder for the UpdateTheme operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that contains the theme that you’re updating.

    
    
  • theme_id(impl Into<String>) / set_theme_id(Option<String>):
    required: true
    

    The ID for the theme.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The name for the theme.

    
    
  • base_theme_id(impl Into<String>) / set_base_theme_id(Option<String>):
    required: true
    

    The theme ID, defined by Amazon QuickSight, that a custom theme inherits from. All themes initially inherit from a default Amazon QuickSight theme.

    
    
  • version_description(impl Into<String>) / set_version_description(Option<String>):
    required: false
    

    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.

    
    
  • configuration(ThemeConfiguration) / set_configuration(Option<ThemeConfiguration>):
    required: false
    

    The theme configuration, which contains the theme display properties.

    
    
• On success, responds with UpdateThemeOutput with field(s):
  • theme_id(Option<String>):

    The ID for the theme.

  • arn(Option<String>):

    The Amazon Resource Name (ARN) for the theme.

  • version_arn(Option<String>):

    The Amazon Resource Name (ARN) for the new version of the theme.

  • creation_status(Option<ResourceStatus>):

    The creation status of the theme.

  • status(i32):

    The HTTP status of the request.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

• On failure, responds with SdkError<UpdateThemeError>

impl Client

pub fn update_theme_alias(&self) -> UpdateThemeAliasFluentBuilder

Constructs a fluent builder for the UpdateThemeAlias operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that contains the theme alias that you’re updating.

    
    
  • theme_id(impl Into<String>) / set_theme_id(Option<String>):
    required: true
    

    The ID for the theme.

    
    
  • alias_name(impl Into<String>) / set_alias_name(Option<String>):
    required: true
    

    The name of the theme alias that you want to update.

    
    
  • theme_version_number(i64) / set_theme_version_number(Option<i64>):
    required: true
    

    The version number of the theme that the alias should reference.

    
    
• On success, responds with UpdateThemeAliasOutput with field(s):
  • theme_alias(Option<ThemeAlias>):

    Information about the theme alias.

  • status(i32):

    The HTTP status of the request.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

• On failure, responds with SdkError<UpdateThemeAliasError>

impl Client

pub fn update_theme_permissions(&self) -> UpdateThemePermissionsFluentBuilder

Constructs a fluent builder for the UpdateThemePermissions operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that contains the theme.

    
    
  • theme_id(impl Into<String>) / set_theme_id(Option<String>):
    required: true
    

    The ID for the theme.

    
    
  • grant_permissions(ResourcePermission) / set_grant_permissions(Option<Vec::<ResourcePermission>>):
    required: false
    

    A list of resource permissions to be granted for the theme.

    
    
  • revoke_permissions(ResourcePermission) / set_revoke_permissions(Option<Vec::<ResourcePermission>>):
    required: false
    

    A list of resource permissions to be revoked from the theme.

    
    
• On success, responds with UpdateThemePermissionsOutput with field(s):
  • theme_id(Option<String>):

    The ID for the theme.

  • theme_arn(Option<String>):

    The Amazon Resource Name (ARN) of the theme.

  • permissions(Option<Vec::<ResourcePermission>>):

    The resulting list of resource permissions for the theme.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<UpdateThemePermissionsError>

impl Client

pub fn update_topic(&self) -> UpdateTopicFluentBuilder

Constructs a fluent builder for the UpdateTopic operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that contains the topic that you want to update.

    
    
  • topic_id(impl Into<String>) / set_topic_id(Option<String>):
    required: true
    

    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.

    
    
  • topic(TopicDetails) / set_topic(Option<TopicDetails>):
    required: true
    

    The definition of the topic that you want to update.

    
    
• On success, responds with UpdateTopicOutput with field(s):
  • topic_id(Option<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.

  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the topic.

  • refresh_arn(Option<String>):

    The Amazon Resource Name (ARN) of the topic refresh.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<UpdateTopicError>

impl Client

pub fn update_topic_permissions(&self) -> UpdateTopicPermissionsFluentBuilder

Constructs a fluent builder for the UpdateTopicPermissions operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that contains the topic that you want to update the permissions for.

    
    
  • topic_id(impl Into<String>) / set_topic_id(Option<String>):
    required: true
    

    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.

    
    
  • grant_permissions(ResourcePermission) / set_grant_permissions(Option<Vec::<ResourcePermission>>):
    required: false
    

    The resource permissions that you want to grant to the topic.

    
    
  • revoke_permissions(ResourcePermission) / set_revoke_permissions(Option<Vec::<ResourcePermission>>):
    required: false
    

    The resource permissions that you want to revoke from the topic.

    
    
• On success, responds with UpdateTopicPermissionsOutput with field(s):
  • topic_id(Option<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.

  • topic_arn(Option<String>):

    The Amazon Resource Name (ARN) of the topic.

  • permissions(Option<Vec::<ResourcePermission>>):

    A list of resource permissions on the topic.

  • status(i32):

    The HTTP status of the request.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

• On failure, responds with SdkError<UpdateTopicPermissionsError>

impl Client

pub fn update_topic_refresh_schedule( &self ) -> UpdateTopicRefreshScheduleFluentBuilder

Constructs a fluent builder for the UpdateTopicRefreshSchedule operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that contains the topic whose refresh schedule you want to update.

    
    
  • topic_id(impl Into<String>) / set_topic_id(Option<String>):
    required: true
    

    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.

    
    
  • dataset_id(impl Into<String>) / set_dataset_id(Option<String>):
    required: true
    

    The ID of the dataset.

    
    
  • refresh_schedule(TopicRefreshSchedule) / set_refresh_schedule(Option<TopicRefreshSchedule>):
    required: true
    

    The definition of a refresh schedule.

    
    
• On success, responds with UpdateTopicRefreshScheduleOutput with field(s):
  • topic_id(Option<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.

  • topic_arn(Option<String>):

    The Amazon Resource Name (ARN) of the topic.

  • dataset_arn(Option<String>):

    The Amazon Resource Name (ARN) of the dataset.

  • status(i32):

    The HTTP status of the request.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

• On failure, responds with SdkError<UpdateTopicRefreshScheduleError>

impl Client

pub fn update_user(&self) -> UpdateUserFluentBuilder

Constructs a fluent builder for the UpdateUser operation.

• The fluent builder is configurable:
  • user_name(impl Into<String>) / set_user_name(Option<String>):
    required: true
    

    The Amazon QuickSight user name that you want to update.

    
    
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    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.

    
    
  • namespace(impl Into<String>) / set_namespace(Option<String>):
    required: true
    

    The namespace. Currently, you should set this to default.

    
    
  • email(impl Into<String>) / set_email(Option<String>):
    required: true
    

    The email address of the user that you want to update.

    
    
  • role(UserRole) / set_role(Option<UserRole>):
    required: true
    

    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 Business, 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.

    
    
  • custom_permissions_name(impl Into<String>) / set_custom_permissions_name(Option<String>):
    required: false
    

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

    
    
  • unapply_custom_permissions(bool) / set_unapply_custom_permissions(Option<bool>):
    required: false
    

    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.

    
    
  • external_login_federation_provider_type(impl Into<String>) / set_external_login_federation_provider_type(Option<String>):
    required: false
    

    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.

    
    
  • custom_federation_provider_url(impl Into<String>) / set_custom_federation_provider_url(Option<String>):
    required: false
    

    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.

    
    
  • external_login_id(impl Into<String>) / set_external_login_id(Option<String>):
    required: false
    

    The identity ID for a user in the external login provider.

    
    
• On success, responds with UpdateUserOutput with field(s):
  • user(Option<User>):

    The Amazon QuickSight user.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<UpdateUserError>

impl Client

pub fn update_vpc_connection(&self) -> UpdateVPCConnectionFluentBuilder

Constructs a fluent builder for the UpdateVPCConnection operation.

• The fluent builder is configurable:
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID of the account that contains the VPC connection that you want to update.

    
    
  • vpc_connection_id(impl Into<String>) / set_vpc_connection_id(Option<String>):
    required: true
    

    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.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The display name for the VPC connection.

    
    
  • subnet_ids(impl Into<String>) / set_subnet_ids(Option<Vec::<String>>):
    required: true
    

    A list of subnet IDs for the VPC connection.

    
    
  • security_group_ids(impl Into<String>) / set_security_group_ids(Option<Vec::<String>>):
    required: true
    

    A list of security group IDs for the VPC connection.

    
    
  • dns_resolvers(impl Into<String>) / set_dns_resolvers(Option<Vec::<String>>):
    required: false
    

    A list of IP addresses of DNS resolver endpoints for the VPC connection.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: true
    

    An IAM role associated with the VPC connection.

    
    
• On success, responds with UpdateVpcConnectionOutput with field(s):
  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the VPC connection.

  • vpc_connection_id(Option<String>):

    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.

  • update_status(Option<VpcConnectionResourceStatus>):

    The update status of the VPC connection’s last update.

  • availability_status(Option<VpcConnectionAvailabilityStatus>):

    The availability status of the VPC connection.

  • request_id(Option<String>):

    The Amazon Web Services request ID for this operation.

  • status(i32):

    The HTTP status of the request.

• On failure, responds with SdkError<UpdateVPCConnectionError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.