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.

Examples

Constructing a client and invoking an operation

    // create a shared configuration. This can be used & shared between multiple service clients.
    let shared_config = aws_config::load_from_env().await;
    let client = aws_sdk_quicksight::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

use aws_config::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_quicksight::config::Builder::from(&shared_config)
  .retry_config(RetryConfig::disabled())
  .build();
let client = aws_sdk_quicksight::Client::from_conf(config);

Implementations

impl Client

pub fn with_config(
    client: Client<DynConnector, DynMiddleware<DynConnector>>,
    conf: Config
) -> Self

Creates a client with the given service configuration.

pub fn conf(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn cancel_ingestion(&self) -> CancelIngestion

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>):

    The Amazon Web Services account ID.

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

    The ID of the dataset used in the ingestion.

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

    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>

pub fn create_account_customization(&self) -> CreateAccountCustomization

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>):

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

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

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

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

    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(Vec<Tag>) / set_tags(Option<Vec<Tag>>):

    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>

pub fn create_analysis(&self) -> CreateAnalysis

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>):

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

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

    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>):

    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>):

    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(Vec<ResourcePermission>) / set_permissions(Option<Vec<ResourcePermission>>):

    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>):

    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.

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

    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(Vec<Tag>) / set_tags(Option<Vec<Tag>>):

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

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

pub fn create_dashboard(&self) -> CreateDashboard

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>):

    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>):

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

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

    The display name of the dashboard.

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

    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(Vec<ResourcePermission>) / set_permissions(Option<Vec<ResourcePermission>>):

    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>):

    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.

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

    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>):

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

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

    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>):

    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.

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

pub fn create_data_set(&self) -> CreateDataSet

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>):

    The Amazon Web Services account ID.

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

    An ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

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

    The display name for the dataset.

  • physical_table_map(HashMap<String, PhysicalTable>) / set_physical_table_map(Option<HashMap<String, PhysicalTable>>):

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

  • logical_table_map(HashMap<String, LogicalTable>) / set_logical_table_map(Option<HashMap<String, LogicalTable>>):

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

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

    Indicates whether you want to import the data into SPICE.

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

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

  • field_folders(HashMap<String, FieldFolder>) / set_field_folders(Option<HashMap<String, FieldFolder>>):

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

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

    A list of resource permissions on the dataset.

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

    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>):

    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(Vec<ColumnLevelPermissionRule>) / set_column_level_permission_rules(Option<Vec<ColumnLevelPermissionRule>>):

    A set of one or more definitions of a ColumnLevelPermissionRule .

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

    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>):

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

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

pub fn create_data_source(&self) -> CreateDataSource

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>):

    The Amazon Web Services account ID.

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

    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>):

    A display name for the data source.

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

    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>):

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

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

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

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

    A list of resource permissions on the data source.

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

    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>):

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

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

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

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

pub fn create_folder(&self) -> CreateFolder

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>):

    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>):

    The ID of the folder.

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

    The name of the folder.

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

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

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

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

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

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

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

    To specify no permissions, omit Permissions.

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

    Tags for the folder.

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

pub fn create_folder_membership(&self) -> CreateFolderMembership

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>):

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

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

    The ID of the folder.

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

    The ID of the asset (the dashboard, analysis, or dataset).

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

    The type of the member, including DASHBOARD, ANALYSIS, and DATASET.

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

pub fn create_group(&self) -> CreateGroup

Constructs a fluent builder for the CreateGroup operation.

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

    A name for the group that you want to create.

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

    A description for the group that you want to create.

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

    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>):

    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>

pub fn create_group_membership(&self) -> CreateGroupMembership

Constructs a fluent builder for the CreateGroupMembership operation.

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

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

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

    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>):

    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>):

    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>

pub fn create_iam_policy_assignment(&self) -> CreateIAMPolicyAssignment

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>):

    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>):

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

  • assignment_status(AssignmentStatus) / set_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(impl Into<String>) / set_policy_arn(Option<String>):

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

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

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

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

    The namespace that contains the assignment.

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

    The name of the assignment. This 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>

pub fn create_ingestion(&self) -> CreateIngestion

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>):

    The ID of the dataset used in the ingestion.

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

    An ID for the ingestion.

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

    The Amazon Web Services account ID.

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

    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>

pub fn create_namespace(&self) -> CreateNamespace

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>):

    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>):

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

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

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

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

    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>

pub fn create_template(&self) -> CreateTemplate

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>):

    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>):

    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>):

    A display name for the template.

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

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

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

    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.

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

    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>):

    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.

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

pub fn create_template_alias(&self) -> CreateTemplateAlias

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>):

    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>):

    An ID for the template.

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

    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>):

    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>

pub fn create_theme(&self) -> CreateTheme

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>):

    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>):

    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>):

    A display name for the theme.

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

    The ID of the theme that a custom theme will inherit from. All themes inherit from one of the starting themes defined by Amazon QuickSight. For a list of the starting themes, use ListThemes or choose Themes from within an analysis.

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

    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>):

    The theme configuration, which contains the theme display properties.

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

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

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

    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>

pub fn create_theme_alias(&self) -> CreateThemeAlias

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>):

    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>):

    An ID for the theme alias.

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

    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>):

    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>

pub fn delete_account_customization(&self) -> DeleteAccountCustomization

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>):

    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>):

    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>

pub fn delete_analysis(&self) -> DeleteAnalysis

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>):

    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>):

    The ID of the analysis that you’re deleting.

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

    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(bool):

    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>

pub fn delete_dashboard(&self) -> DeleteDashboard

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>):

    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>):

    The ID for the dashboard.

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

    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>

pub fn delete_data_set(&self) -> DeleteDataSet

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>):

    The Amazon Web Services account ID.

  • data_set_id(impl Into<String>) / set_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.

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

pub fn delete_data_source(&self) -> DeleteDataSource

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>):

    The Amazon Web Services account ID.

  • data_source_id(impl Into<String>) / set_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.

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

pub fn delete_folder(&self) -> DeleteFolder

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>):

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

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

    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>

pub fn delete_folder_membership(&self) -> DeleteFolderMembership

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>):

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

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

    The Folder ID.

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

    The ID of the asset (the dashboard, analysis, or dataset) that you want to delete.

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

    The type of the member, including DASHBOARD, ANALYSIS, and DATASET

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

pub fn delete_group(&self) -> DeleteGroup

Constructs a fluent builder for the DeleteGroup operation.

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

    The name of the group that you want to delete.

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

    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>):

    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>

pub fn delete_group_membership(&self) -> DeleteGroupMembership

Constructs a fluent builder for the DeleteGroupMembership operation.

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

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

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

    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>):

    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>):

    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>

pub fn delete_iam_policy_assignment(&self) -> DeleteIAMPolicyAssignment

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>):

    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>):

    The name of the assignment.

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

    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>

pub fn delete_namespace(&self) -> DeleteNamespace

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>):

    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>):

    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>

pub fn delete_template(&self) -> DeleteTemplate

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>):

    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>):

    An ID for the template you want to delete.

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

    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>

pub fn delete_template_alias(&self) -> DeleteTemplateAlias

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>):

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

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

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

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

    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>

pub fn delete_theme(&self) -> DeleteTheme

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>):

    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>):

    An ID for the theme that you want to delete.

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

    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>

pub fn delete_theme_alias(&self) -> DeleteThemeAlias

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>):

    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>):

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

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

    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>

pub fn delete_user(&self) -> DeleteUser

Constructs a fluent builder for the DeleteUser operation.

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

    The name of the user that you want to delete.

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

    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>):

    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>

pub fn delete_user_by_principal_id(&self) -> DeleteUserByPrincipalId

Constructs a fluent builder for the DeleteUserByPrincipalId operation.

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

    The principal ID of the user.

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

    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>):

    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>

pub fn describe_account_customization(&self) -> DescribeAccountCustomization

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>):

    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>):

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

  • resolved(bool) / set_resolved(bool):

    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>

pub fn describe_account_settings(&self) -> DescribeAccountSettings

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>):

    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>

pub fn describe_analysis(&self) -> DescribeAnalysis

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>):

    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>):

    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>

pub fn describe_analysis_permissions(&self) -> DescribeAnalysisPermissions

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>):

    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>):

    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>

pub fn describe_dashboard(&self) -> DescribeDashboard

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>):

    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>):

    The ID for the dashboard.

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

    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>):

    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>

pub fn describe_dashboard_permissions(&self) -> DescribeDashboardPermissions

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>):

    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>):

    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>

pub fn describe_data_set(&self) -> DescribeDataSet

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>):

    The Amazon Web Services account ID.

  • data_set_id(impl Into<String>) / set_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.

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

pub fn describe_data_set_permissions(&self) -> DescribeDataSetPermissions

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>):

    The Amazon Web Services account ID.

  • data_set_id(impl Into<String>) / set_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.

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

pub fn describe_data_source(&self) -> DescribeDataSource

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>):

    The Amazon Web Services account ID.

  • data_source_id(impl Into<String>) / set_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.

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

pub fn describe_data_source_permissions(&self) -> DescribeDataSourcePermissions

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>):

    The Amazon Web Services account ID.

  • data_source_id(impl Into<String>) / set_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.

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

pub fn describe_folder(&self) -> DescribeFolder

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>):

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

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

    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>

pub fn describe_folder_permissions(&self) -> DescribeFolderPermissions

Constructs a fluent builder for the DescribeFolderPermissions operation.

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

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

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

    The ID of the folder.

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

• On failure, responds with SdkError<DescribeFolderPermissionsError>

pub fn describe_folder_resolved_permissions(
    &self
) -> DescribeFolderResolvedPermissions

Constructs a fluent builder for the DescribeFolderResolvedPermissions operation.

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

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

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

    The ID of the folder.

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

• On failure, responds with SdkError<DescribeFolderResolvedPermissionsError>

pub fn describe_group(&self) -> DescribeGroup

Constructs a fluent builder for the DescribeGroup operation.

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

    The name of the group that you want to describe.

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

    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>):

    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>

pub fn describe_group_membership(&self) -> DescribeGroupMembership

Constructs a fluent builder for the DescribeGroupMembership operation.

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

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

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

    The name of the group that you want to search.

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

    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>):

    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>

pub fn describe_iam_policy_assignment(&self) -> DescribeIAMPolicyAssignment

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>):

    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>):

    The name of the assignment, also called a rule.

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

    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>

pub fn describe_ingestion(&self) -> DescribeIngestion

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>):

    The Amazon Web Services account ID.

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

    The ID of the dataset used in the ingestion.

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

    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>

pub fn describe_ip_restriction(&self) -> DescribeIpRestriction

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>):

    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.

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

pub fn describe_namespace(&self) -> DescribeNamespace

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>):

    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>):

    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>

pub fn describe_template(&self) -> DescribeTemplate

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>):

    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>):

    The ID for the template.

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

    (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>):

    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>

pub fn describe_template_alias(&self) -> DescribeTemplateAlias

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>):

    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>):

    The ID for the template.

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

    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>

pub fn describe_template_permissions(&self) -> DescribeTemplatePermissions

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>):

    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>):

    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>

pub fn describe_theme(&self) -> DescribeTheme

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>):

    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>):

    The ID for the theme.

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

    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>):

    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>

pub fn describe_theme_alias(&self) -> DescribeThemeAlias

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>):

    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>):

    The ID for the theme.

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

    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>

pub fn describe_theme_permissions(&self) -> DescribeThemePermissions

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>):

    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>):

    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>

pub fn describe_user(&self) -> DescribeUser

Constructs a fluent builder for the DescribeUser operation.

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

    The name of the user that you want to describe.

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

    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>):

    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>

pub fn generate_embed_url_for_anonymous_user(
    &self
) -> GenerateEmbedUrlForAnonymousUser

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>):

    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>):

    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>):

    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(Vec<SessionTag>) / set_session_tags(Option<Vec<SessionTag>>):

    The session tags used for row-level security. Before you use this parameter, make sure that you have configured the relevant datasets using the DataSet$RowLevelPermissionTagConfiguration parameter so that session tags can be used to provide row-level security.

    These are not the tags used for the Amazon Web Services resource tagging feature. For more information, see Using Row-Level Security (RLS) with Tags.

  • authorized_resource_arns(Vec<String>) / set_authorized_resource_arns(Option<Vec<String>>):

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

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

    The configuration of the experience you are embedding.

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

    The embed URL for 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<GenerateEmbedUrlForAnonymousUserError>

pub fn generate_embed_url_for_registered_user(
    &self
) -> GenerateEmbedUrlForRegisteredUser

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>):

    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>):

    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>):

    The Amazon Resource Name for the registered user.

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

    The experience you are embedding. For registered users, you can embed Amazon QuickSight dashboards or the entire Amazon QuickSight console.

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

    The embed URL for the Amazon QuickSight dashboard or console.

  • 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<GenerateEmbedUrlForRegisteredUserError>

pub fn get_dashboard_embed_url(&self) -> GetDashboardEmbedUrl

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>):

    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>):

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

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

    The authentication method that the user uses to sign in.

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

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

  • undo_redo_disabled(bool) / set_undo_redo_disabled(bool):

    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(bool):

    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(bool):

    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>):

    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>):

    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(Vec<String>) / set_additional_dashboard_ids(Option<Vec<String>>):

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

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

pub fn get_session_embed_url(&self) -> GetSessionEmbedUrl

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>):

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

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

    The URL you use to access the embedded session. The entry point URL is constrained to the following paths:

    • /start

    • /start/analyses

    • /start/dashboards

    • /start/favorites

    • /dashboards/DashboardId - where DashboardId is the actual ID key from the Amazon QuickSight console URL of the dashboard

    • /analyses/AnalysisId - where AnalysisId is the actual ID key from the Amazon QuickSight console URL of the analysis

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

    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>):

    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. Identity and Access Management (IAM) users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect, or IAM federation

    Omit this parameter for users in the third group, IAM users and IAM role-based sessions.

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

pub fn list_analyses(&self) -> ListAnalyses

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>):

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

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

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

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

    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>

pub fn list_dashboards(&self) -> ListDashboards

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>):

    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>):

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

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

    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>

pub fn list_dashboard_versions(&self) -> ListDashboardVersions

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>):

    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>):

    The ID for the dashboard.

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

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

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

    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>

pub fn list_data_sets(&self) -> ListDataSets

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>):

    The Amazon Web Services account ID.

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

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

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

    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>

pub fn list_data_sources(&self) -> ListDataSources

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>):

    The Amazon Web Services account ID.

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

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

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

    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>

pub fn list_folder_members(&self) -> ListFolderMembers

Constructs a fluent builder for the ListFolderMembers operation.

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

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

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

    The ID of the folder.

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

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

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

    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>

pub fn list_folders(&self) -> ListFolders

Constructs a fluent builder for the ListFolders operation.

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

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

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

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

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

    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>

pub fn list_group_memberships(&self) -> ListGroupMemberships

Constructs a fluent builder for the ListGroupMemberships operation.

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

    The name of the group that you want to see a membership list of.

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

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

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

    The maximum number of results to return from this request.

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

    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>):

    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>

pub fn list_groups(&self) -> ListGroups

Constructs a fluent builder for the ListGroups operation.

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

    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>):

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

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

    The maximum number of results to return.

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

    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>

pub fn list_iam_policy_assignments(&self) -> ListIAMPolicyAssignments

Constructs a fluent builder for the ListIAMPolicyAssignments operation.

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

    The ID of the Amazon Web Services account that contains these IAM policy assignments.

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

    The status of the assignments.

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

    The namespace for the assignments.

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

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

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

    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>

pub fn list_iam_policy_assignments_for_user(
    &self
) -> ListIAMPolicyAssignmentsForUser

Constructs a fluent builder for the ListIAMPolicyAssignmentsForUser operation.

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

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

  • user_name(impl Into<String>) / set_user_name(Option<String>):

    The name of the user.

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

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

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

    The maximum number of results to be returned per request.

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

    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>

pub fn list_ingestions(&self) -> ListIngestions

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>):

    The ID of the dataset used in the ingestion.

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

    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>):

    The Amazon Web Services account ID.

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

    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>

pub fn list_namespaces(&self) -> ListNamespaces

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>):

    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>):

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

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

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

pub fn list_tags_for_resource(&self) -> ListTagsForResource

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):

    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>

pub fn list_template_aliases(&self) -> ListTemplateAliases

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>):

    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>):

    The ID for the template.

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

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

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

    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>

pub fn list_templates(&self) -> ListTemplates

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>):

    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>):

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

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

    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>

pub fn list_template_versions(&self) -> ListTemplateVersions

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>):

    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>):

    The ID for the template.

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

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

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

    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>

pub fn list_theme_aliases(&self) -> ListThemeAliases

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>):

    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>):

    The ID for the theme.

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

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

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

    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>

pub fn list_themes(&self) -> ListThemes

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>):

    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>):

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

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

    The maximum number of results to be returned per request.

  • r#type(ThemeType) / set_type(Option<ThemeType>):

    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>

pub fn list_theme_versions(&self) -> ListThemeVersions

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>):

    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>):

    The ID for the theme.

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

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

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

    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>

pub fn list_user_groups(&self) -> ListUserGroups

Constructs a fluent builder for the ListUserGroups operation.

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

    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>):

    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>):

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

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

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

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

    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>

pub fn list_users(&self) -> ListUsers

Constructs a fluent builder for the ListUsers operation.

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

    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>):

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

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

    The maximum number of results to return from this request.

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

    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>

pub fn register_user(&self) -> RegisterUser

Constructs a fluent builder for the RegisterUser operation.

• The fluent builder is configurable:
  • identity_type(IdentityType) / set_identity_type(Option<IdentityType>):

    Amazon QuickSight supports several ways of managing the identity of users. This parameter accepts two values:

    • IAM: A user whose identity maps to an existing IAM user or role.

    • QUICKSIGHT: A user whose identity is owned and managed internally by Amazon QuickSight.

  • email(impl Into<String>) / set_email(Option<String>):

    The email address of the user that you want to register.

  • user_role(UserRole) / set_user_role(Option<UserRole>):

    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>):

    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>):

    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>):

    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>):

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

  • user_name(impl Into<String>) / set_user_name(Option<String>):

    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>):

    (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).

    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>):

    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>):

    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>):

    The identity ID for a user in the external login provider.

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

pub fn restore_analysis(&self) -> RestoreAnalysis

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>):

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

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

    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>

pub fn search_analyses(&self) -> SearchAnalyses

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>):

    The ID of the Amazon Web Services account that contains the analyses that you’re searching for.

  • filters(Vec<AnalysisSearchFilter>) / set_filters(Option<Vec<AnalysisSearchFilter>>):

    The structure for the search filters that you want to apply to your search.

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

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

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

    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>

pub fn search_dashboards(&self) -> SearchDashboards

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>):

    The ID of the Amazon Web Services account that contains the user whose dashboards you’re searching for.

  • filters(Vec<DashboardSearchFilter>) / set_filters(Option<Vec<DashboardSearchFilter>>):

    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>):

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

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

    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>

pub fn search_folders(&self) -> SearchFolders

Constructs a fluent builder for the SearchFolders operation.

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

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

  • filters(Vec<FolderSearchFilter>) / set_filters(Option<Vec<FolderSearchFilter>>):

    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>):

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

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

    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>

pub fn search_groups(&self) -> SearchGroups

Constructs a fluent builder for the SearchGroups operation.

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

    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>):

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

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

    The maximum number of results to return from this request.

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

    The namespace that you want to search.

  • filters(Vec<GroupSearchFilter>) / set_filters(Option<Vec<GroupSearchFilter>>):

    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>

pub fn tag_resource(&self) -> TagResource

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):

    The Amazon Resource Name (ARN) of the resource that you want to tag.

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

    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>

pub fn untag_resource(&self) -> UntagResource

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):

    The Amazon Resource Name (ARN) of the resource that you want to untag.

  • tag_keys(Vec<String>) / set_tag_keys(Option<Vec<String>>):

    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>

pub fn update_account_customization(&self) -> UpdateAccountCustomization

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>):

    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>):

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

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

    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>

pub fn update_account_settings(&self) -> UpdateAccountSettings

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>):

    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>):

    The default namespace for this Amazon Web Services account. Currently, the default is default. Identity and Access Management (IAM) users that register for the first time with Amazon QuickSight provide an email that becomes associated with the default namespace.

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

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

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

pub fn update_analysis(&self) -> UpdateAnalysis

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>):

    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>):

    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>):

    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>):

    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>):

    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>):

    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.

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

pub fn update_analysis_permissions(&self) -> UpdateAnalysisPermissions

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>):

    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>):

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

  • grant_permissions(Vec<ResourcePermission>) / set_grant_permissions(Option<Vec<ResourcePermission>>):

    A structure that describes the permissions to add and the principal to add them to.

  • revoke_permissions(Vec<ResourcePermission>) / set_revoke_permissions(Option<Vec<ResourcePermission>>):

    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>

pub fn update_dashboard(&self) -> UpdateDashboard

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>):

    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>):

    The ID for the dashboard.

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

    The display name of the dashboard.

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

    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>):

    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>):

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

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

    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>):

    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.

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

pub fn update_dashboard_permissions(&self) -> UpdateDashboardPermissions

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>):

    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>):

    The ID for the dashboard.

  • grant_permissions(Vec<ResourcePermission>) / set_grant_permissions(Option<Vec<ResourcePermission>>):

    The permissions that you want to grant on this resource.

  • revoke_permissions(Vec<ResourcePermission>) / set_revoke_permissions(Option<Vec<ResourcePermission>>):

    The permissions that you want to revoke from this resource.

  • grant_link_permissions(Vec<ResourcePermission>) / set_grant_link_permissions(Option<Vec<ResourcePermission>>):

    Grants link permissions to all users in a defined namespace.

  • revoke_link_permissions(Vec<ResourcePermission>) / set_revoke_link_permissions(Option<Vec<ResourcePermission>>):

    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>

pub fn update_dashboard_published_version(
    &self
) -> UpdateDashboardPublishedVersion

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>):

    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>):

    The ID for the dashboard.

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

    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>

pub fn update_data_set(&self) -> UpdateDataSet

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>):

    The Amazon Web Services account ID.

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

    The ID for the dataset that you want to update. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

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

    The display name for the dataset.

  • physical_table_map(HashMap<String, PhysicalTable>) / set_physical_table_map(Option<HashMap<String, PhysicalTable>>):

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

  • logical_table_map(HashMap<String, LogicalTable>) / set_logical_table_map(Option<HashMap<String, LogicalTable>>):

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

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

    Indicates whether you want to import the data into SPICE.

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

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

  • field_folders(HashMap<String, FieldFolder>) / set_field_folders(Option<HashMap<String, FieldFolder>>):

    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>):

    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>):

    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(Vec<ColumnLevelPermissionRule>) / set_column_level_permission_rules(Option<Vec<ColumnLevelPermissionRule>>):

    A set of one or more definitions of a ColumnLevelPermissionRule .

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

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

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

pub fn update_data_set_permissions(&self) -> UpdateDataSetPermissions

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>):

    The Amazon Web Services account ID.

  • data_set_id(impl Into<String>) / set_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.

  • grant_permissions(Vec<ResourcePermission>) / set_grant_permissions(Option<Vec<ResourcePermission>>):

    The resource permissions that you want to grant to the dataset.

  • revoke_permissions(Vec<ResourcePermission>) / set_revoke_permissions(Option<Vec<ResourcePermission>>):

    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>

pub fn update_data_source(&self) -> UpdateDataSource

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>):

    The Amazon Web Services account ID.

  • data_source_id(impl Into<String>) / set_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.

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

    A display name for the data source.

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

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

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

    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>):

    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>):

    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>

pub fn update_data_source_permissions(&self) -> UpdateDataSourcePermissions

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>):

    The Amazon Web Services account ID.

  • data_source_id(impl Into<String>) / set_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.

  • grant_permissions(Vec<ResourcePermission>) / set_grant_permissions(Option<Vec<ResourcePermission>>):

    A list of resource permissions that you want to grant on the data source.

  • revoke_permissions(Vec<ResourcePermission>) / set_revoke_permissions(Option<Vec<ResourcePermission>>):

    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>

pub fn update_folder(&self) -> UpdateFolder

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>):

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

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

    The ID of the folder.

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

    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>

pub fn update_folder_permissions(&self) -> UpdateFolderPermissions

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>):

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

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

    The ID of the folder.

  • grant_permissions(Vec<ResourcePermission>) / set_grant_permissions(Option<Vec<ResourcePermission>>):

    The permissions that you want to grant on a resource.

  • revoke_permissions(Vec<ResourcePermission>) / set_revoke_permissions(Option<Vec<ResourcePermission>>):

    The permissions that you want to revoke from a resource.

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

pub fn update_group(&self) -> UpdateGroup

Constructs a fluent builder for the UpdateGroup operation.

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

    The name of the group that you want to update.

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

    The description for the group that you want to update.

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

    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>):

    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>

pub fn update_iam_policy_assignment(&self) -> UpdateIAMPolicyAssignment

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>):

    The ID of the Amazon Web Services account that contains the IAM policy assignment.

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

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

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

    The namespace of the assignment.

  • assignment_status(AssignmentStatus) / set_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(impl Into<String>) / set_policy_arn(Option<String>):

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

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

    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>

pub fn update_ip_restriction(&self) -> UpdateIpRestriction

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>):

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

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

    A map that describes the updated IP rules with CIDR ranges and descriptions.

  • enabled(bool) / set_enabled(Option<bool>):

    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>

pub fn update_template(&self) -> UpdateTemplate

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>):

    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>):

    The ID for the template.

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

    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>):

    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>):

    The name for the template.

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

pub fn update_template_alias(&self) -> UpdateTemplateAlias

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>):

    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>):

    The ID for the template.

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

    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>):

    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>

pub fn update_template_permissions(&self) -> UpdateTemplatePermissions

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>):

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

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

    The ID for the template.

  • grant_permissions(Vec<ResourcePermission>) / set_grant_permissions(Option<Vec<ResourcePermission>>):

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

  • revoke_permissions(Vec<ResourcePermission>) / set_revoke_permissions(Option<Vec<ResourcePermission>>):

    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>

pub fn update_theme(&self) -> UpdateTheme

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>):

    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>):

    The ID for the theme.

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

    The name for the theme.

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

    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>):

    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>):

    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>

pub fn update_theme_alias(&self) -> UpdateThemeAlias

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>):

    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>):

    The ID for the theme.

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

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

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

    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>

pub fn update_theme_permissions(&self) -> UpdateThemePermissions

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>):

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

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

    The ID for the theme.

  • grant_permissions(Vec<ResourcePermission>) / set_grant_permissions(Option<Vec<ResourcePermission>>):

    A list of resource permissions to be granted for the theme.

  • revoke_permissions(Vec<ResourcePermission>) / set_revoke_permissions(Option<Vec<ResourcePermission>>):

    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>

pub fn update_user(&self) -> UpdateUser

Constructs a fluent builder for the UpdateUser operation.

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

    The Amazon QuickSight user name that you want to update.

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

    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>):

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

  • email(impl Into<String>) / set_email(Option<String>):

    The email address of the user that you want to update.

  • role(UserRole) / set_role(Option<UserRole>):

    The Amazon QuickSight role of the user. The role can be one of the following default security cohorts:

    • READER: A user who has read-only access to dashboards.

    • AUTHOR: A user who can create data sources, datasets, analyses, and dashboards.

    • ADMIN: A user who is an author, who can also manage Amazon QuickSight settings.

    The name of the Amazon QuickSight role is invisible to the user except for the console screens dealing with permissions.

  • custom_permissions_name(impl Into<String>) / set_custom_permissions_name(Option<String>):

    (Enterprise edition only) The name of the custom permissions profile that you want to assign to this user. Customized permissions allows you to control a user’s access by restricting access the following operations:

    • Create and update data sources

    • Create and update datasets

    • Create and update email reports

    • Subscribe to email reports

    A set of custom permissions includes any combination of these restrictions. Currently, you need to create the profile names for custom permission sets by using the Amazon QuickSight console. Then, you use the RegisterUser API operation to assign the named set of permissions to a Amazon QuickSight user.

    Amazon QuickSight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning Amazon QuickSight users to one of the default security cohorts in Amazon QuickSight (admin, author, reader).

    This feature is available only to Amazon QuickSight Enterprise edition subscriptions.

  • unapply_custom_permissions(bool) / set_unapply_custom_permissions(bool):

    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>):

    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>):

    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>):

    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 from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
    C: SmithyConnector<Error = E> + Send + 'static,
    E: Into<ConnectorError>, 

Creates a client with the given service config and connector override.

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from a shared config.

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Self

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.

impl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client

fn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self

Converts to this type from the input type.