QuickSight ********** Client ====== class QuickSight.Client A low-level client representing Amazon QuickSight Amazon QuickSight is a fully managed, serverless business intelligence service for the Amazon Web Services Cloud that makes it easy to extend data and insights to every user in your organization. This API reference contains documentation for a programming interface that you can use to manage Amazon QuickSight. import boto3 client = boto3.client('quicksight') These are the available methods: * batch_create_topic_reviewed_answer * batch_delete_topic_reviewed_answer * can_paginate * cancel_ingestion * close * create_account_customization * create_account_subscription * create_analysis * create_brand * create_custom_permissions * create_dashboard * create_data_set * create_data_source * create_folder * create_folder_membership * create_group * create_group_membership * create_iam_policy_assignment * create_ingestion * create_namespace * create_refresh_schedule * create_role_membership * create_template * create_template_alias * create_theme * create_theme_alias * create_topic * create_topic_refresh_schedule * create_vpc_connection * delete_account_customization * delete_account_subscription * delete_analysis * delete_brand * delete_brand_assignment * delete_custom_permissions * delete_dashboard * delete_data_set * delete_data_set_refresh_properties * delete_data_source * delete_default_q_business_application * delete_folder * delete_folder_membership * delete_group * delete_group_membership * delete_iam_policy_assignment * delete_identity_propagation_config * delete_namespace * delete_refresh_schedule * delete_role_custom_permission * delete_role_membership * delete_template * delete_template_alias * delete_theme * delete_theme_alias * delete_topic * delete_topic_refresh_schedule * delete_user * delete_user_by_principal_id * delete_user_custom_permission * delete_vpc_connection * describe_account_customization * describe_account_settings * describe_account_subscription * describe_analysis * describe_analysis_definition * describe_analysis_permissions * describe_asset_bundle_export_job * describe_asset_bundle_import_job * describe_brand * describe_brand_assignment * describe_brand_published_version * describe_custom_permissions * describe_dashboard * describe_dashboard_definition * describe_dashboard_permissions * describe_dashboard_snapshot_job * describe_dashboard_snapshot_job_result * describe_dashboards_qa_configuration * describe_data_set * describe_data_set_permissions * describe_data_set_refresh_properties * describe_data_source * describe_data_source_permissions * describe_default_q_business_application * describe_folder * describe_folder_permissions * describe_folder_resolved_permissions * describe_group * describe_group_membership * describe_iam_policy_assignment * describe_ingestion * describe_ip_restriction * describe_key_registration * describe_namespace * describe_q_personalization_configuration * describe_quick_sight_q_search_configuration * describe_refresh_schedule * describe_role_custom_permission * describe_template * describe_template_alias * describe_template_definition * describe_template_permissions * describe_theme * describe_theme_alias * describe_theme_permissions * describe_topic * describe_topic_permissions * describe_topic_refresh * describe_topic_refresh_schedule * describe_user * describe_vpc_connection * generate_embed_url_for_anonymous_user * generate_embed_url_for_registered_user * generate_embed_url_for_registered_user_with_identity * get_dashboard_embed_url * get_paginator * get_session_embed_url * get_waiter * list_analyses * list_asset_bundle_export_jobs * list_asset_bundle_import_jobs * list_brands * list_custom_permissions * list_dashboard_versions * list_dashboards * list_data_sets * list_data_sources * list_folder_members * list_folders * list_folders_for_resource * list_group_memberships * list_groups * list_iam_policy_assignments * list_iam_policy_assignments_for_user * list_identity_propagation_configs * list_ingestions * list_namespaces * list_refresh_schedules * list_role_memberships * list_tags_for_resource * list_template_aliases * list_template_versions * list_templates * list_theme_aliases * list_theme_versions * list_themes * list_topic_refresh_schedules * list_topic_reviewed_answers * list_topics * list_user_groups * list_users * list_vpc_connections * predict_qa_results * put_data_set_refresh_properties * register_user * restore_analysis * search_analyses * search_dashboards * search_data_sets * search_data_sources * search_folders * search_groups * search_topics * start_asset_bundle_export_job * start_asset_bundle_import_job * start_dashboard_snapshot_job * start_dashboard_snapshot_job_schedule * tag_resource * untag_resource * update_account_customization * update_account_settings * update_analysis * update_analysis_permissions * update_application_with_token_exchange_grant * update_brand * update_brand_assignment * update_brand_published_version * update_custom_permissions * update_dashboard * update_dashboard_links * update_dashboard_permissions * update_dashboard_published_version * update_dashboards_qa_configuration * update_data_set * update_data_set_permissions * update_data_source * update_data_source_permissions * update_default_q_business_application * update_folder * update_folder_permissions * update_group * update_iam_policy_assignment * update_identity_propagation_config * update_ip_restriction * update_key_registration * update_public_sharing_settings * update_q_personalization_configuration * update_quick_sight_q_search_configuration * update_refresh_schedule * update_role_custom_permission * update_spice_capacity_configuration * update_template * update_template_alias * update_template_permissions * update_theme * update_theme_alias * update_theme_permissions * update_topic * update_topic_permissions * update_topic_refresh_schedule * update_user * update_user_custom_permission * update_vpc_connection Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * DescribeFolderPermissions * DescribeFolderResolvedPermissions * ListAnalyses * ListAssetBundleExportJobs * ListAssetBundleImportJobs * ListBrands * ListCustomPermissions * ListDashboardVersions * ListDashboards * ListDataSets * ListDataSources * ListFolderMembers * ListFolders * ListFoldersForResource * ListGroupMemberships * ListGroups * ListIAMPolicyAssignments * ListIAMPolicyAssignmentsForUser * ListIngestions * ListNamespaces * ListRoleMemberships * ListTemplateAliases * ListTemplateVersions * ListTemplates * ListThemeVersions * ListThemes * ListUserGroups * ListUsers * SearchAnalyses * SearchDashboards * SearchDataSets * SearchDataSources * SearchFolders * SearchGroups * SearchTopics QuickSight / Paginator / DescribeFolderPermissions DescribeFolderPermissions ************************* class QuickSight.Paginator.DescribeFolderPermissions paginator = client.get_paginator('describe_folder_permissions') paginate(**kwargs) Creates an iterator that will paginate through responses from "QuickSight.Client.describe_folder_permissions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( AwsAccountId='string', FolderId='string', Namespace='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID for the Amazon Web Services account that contains the folder. * **FolderId** (*string*) -- **[REQUIRED]** The ID of the folder. * **Namespace** (*string*) -- The namespace of the folder whose permissions you want described. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Status': 123, 'FolderId': 'string', 'Arn': 'string', 'Permissions': [ { 'Principal': 'string', 'Actions': [ 'string', ] }, ], 'RequestId': 'string', } **Response Structure** * *(dict) --* * **Status** *(integer) --* The HTTP status of the request. * **FolderId** *(string) --* The ID of the folder. * **Arn** *(string) --* The Amazon Resource Name (ARN) for the folder. * **Permissions** *(list) --* Information about the permissions on the folder. * *(dict) --* Permission for the resource. * **Principal** *(string) --* The Amazon Resource Name (ARN) of the principal. This can be one of the following: * The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.) * The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.) * The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.) * **Actions** *(list) --* The IAM action to grant or revoke permissions on. * *(string) --* * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. QuickSight / Paginator / ListBrands ListBrands ********** class QuickSight.Paginator.ListBrands paginator = client.get_paginator('list_brands') paginate(**kwargs) Creates an iterator that will paginate through responses from "QuickSight.Client.list_brands()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( AwsAccountId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that owns the brands that you want to list. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Brands': [ { 'Arn': 'string', 'BrandId': 'string', 'BrandName': 'string', 'Description': 'string', 'BrandStatus': 'CREATE_IN_PROGRESS'|'CREATE_SUCCEEDED'|'CREATE_FAILED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED', 'CreatedTime': datetime(2015, 1, 1), 'LastUpdatedTime': datetime(2015, 1, 1) }, ] } **Response Structure** * *(dict) --* * **Brands** *(list) --* A list of all brands in your Amazon Web Services account. This structure provides basic information about each brand. * *(dict) --* A summary of the brand. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the brand. * **BrandId** *(string) --* The ID of the Amazon QuickSight brand. * **BrandName** *(string) --* The name of the brand. * **Description** *(string) --* The description of the brand. * **BrandStatus** *(string) --* The status of the brand. * **CreatedTime** *(datetime) --* The time that the brand was created. * **LastUpdatedTime** *(datetime) --* The time when the brand was last updated. QuickSight / Paginator / ListTemplates ListTemplates ************* class QuickSight.Paginator.ListTemplates paginator = client.get_paginator('list_templates') paginate(**kwargs) Creates an iterator that will paginate through responses from "QuickSight.Client.list_templates()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( AwsAccountId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the templates that you're listing. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'TemplateSummaryList': [ { 'Arn': 'string', 'TemplateId': 'string', 'Name': 'string', 'LatestVersionNumber': 123, 'CreatedTime': datetime(2015, 1, 1), 'LastUpdatedTime': datetime(2015, 1, 1) }, ], 'Status': 123, 'RequestId': 'string' } **Response Structure** * *(dict) --* * **TemplateSummaryList** *(list) --* A structure containing information about the templates in the list. * *(dict) --* The template summary. * **Arn** *(string) --* A summary of a template. * **TemplateId** *(string) --* The ID of the template. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. * **Name** *(string) --* A display name for the template. * **LatestVersionNumber** *(integer) --* A structure containing a list of version numbers for the template summary. * **CreatedTime** *(datetime) --* The last time that this template was created. * **LastUpdatedTime** *(datetime) --* The last time that this template was updated. * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. QuickSight / Paginator / ListIngestions ListIngestions ************** class QuickSight.Paginator.ListIngestions paginator = client.get_paginator('list_ingestions') paginate(**kwargs) Creates an iterator that will paginate through responses from "QuickSight.Client.list_ingestions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( DataSetId='string', AwsAccountId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **DataSetId** (*string*) -- **[REQUIRED]** The ID of the dataset used in the ingestion. * **AwsAccountId** (*string*) -- **[REQUIRED]** The Amazon Web Services account ID. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Ingestions': [ { 'Arn': 'string', 'IngestionId': 'string', 'IngestionStatus': 'INITIALIZED'|'QUEUED'|'RUNNING'|'FAILED'|'COMPLETED'|'CANCELLED', 'ErrorInfo': { 'Type': 'FAILURE_TO_ASSUME_ROLE'|'INGESTION_SUPERSEDED'|'INGESTION_CANCELED'|'DATA_SET_DELETED'|'DATA_SET_NOT_SPICE'|'S3_UPLOADED_FILE_DELETED'|'S3_MANIFEST_ERROR'|'DATA_TOLERANCE_EXCEPTION'|'SPICE_TABLE_NOT_FOUND'|'DATA_SET_SIZE_LIMIT_EXCEEDED'|'ROW_SIZE_LIMIT_EXCEEDED'|'ACCOUNT_CAPACITY_LIMIT_EXCEEDED'|'CUSTOMER_ERROR'|'DATA_SOURCE_NOT_FOUND'|'IAM_ROLE_NOT_AVAILABLE'|'CONNECTION_FAILURE'|'SQL_TABLE_NOT_FOUND'|'PERMISSION_DENIED'|'SSL_CERTIFICATE_VALIDATION_FAILURE'|'OAUTH_TOKEN_FAILURE'|'SOURCE_API_LIMIT_EXCEEDED_FAILURE'|'PASSWORD_AUTHENTICATION_FAILURE'|'SQL_SCHEMA_MISMATCH_ERROR'|'INVALID_DATE_FORMAT'|'INVALID_DATAPREP_SYNTAX'|'SOURCE_RESOURCE_LIMIT_EXCEEDED'|'SQL_INVALID_PARAMETER_VALUE'|'QUERY_TIMEOUT'|'SQL_NUMERIC_OVERFLOW'|'UNRESOLVABLE_HOST'|'UNROUTABLE_HOST'|'SQL_EXCEPTION'|'S3_FILE_INACCESSIBLE'|'IOT_FILE_NOT_FOUND'|'IOT_DATA_SET_FILE_EMPTY'|'INVALID_DATA_SOURCE_CONFIG'|'DATA_SOURCE_AUTH_FAILED'|'DATA_SOURCE_CONNECTION_FAILED'|'FAILURE_TO_PROCESS_JSON_FILE'|'INTERNAL_SERVICE_ERROR'|'REFRESH_SUPPRESSED_BY_EDIT'|'PERMISSION_NOT_FOUND'|'ELASTICSEARCH_CURSOR_NOT_ENABLED'|'CURSOR_NOT_ENABLED'|'DUPLICATE_COLUMN_NAMES_FOUND', 'Message': 'string' }, 'RowInfo': { 'RowsIngested': 123, 'RowsDropped': 123, 'TotalRowsInDataset': 123 }, 'QueueInfo': { 'WaitingOnIngestion': 'string', 'QueuedIngestion': 'string' }, 'CreatedTime': datetime(2015, 1, 1), 'IngestionTimeInSeconds': 123, 'IngestionSizeInBytes': 123, 'RequestSource': 'MANUAL'|'SCHEDULED', 'RequestType': 'INITIAL_INGESTION'|'EDIT'|'INCREMENTAL_REFRESH'|'FULL_REFRESH' }, ], 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **Ingestions** *(list) --* A list of the ingestions. * *(dict) --* Information about the SPICE ingestion for a dataset. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the resource. * **IngestionId** *(string) --* Ingestion ID. * **IngestionStatus** *(string) --* Ingestion status. * **ErrorInfo** *(dict) --* Error information for this ingestion. * **Type** *(string) --* Error type. * **Message** *(string) --* Error message. * **RowInfo** *(dict) --* Information about rows for a data set SPICE ingestion. * **RowsIngested** *(integer) --* The number of rows that were ingested. * **RowsDropped** *(integer) --* The number of rows that were not ingested. * **TotalRowsInDataset** *(integer) --* The total number of rows in the dataset. * **QueueInfo** *(dict) --* Information about a queued dataset SPICE ingestion. * **WaitingOnIngestion** *(string) --* The ID of the queued ingestion. * **QueuedIngestion** *(string) --* The ID of the ongoing ingestion. The queued ingestion is waiting for the ongoing ingestion to complete. * **CreatedTime** *(datetime) --* The time that this ingestion started. * **IngestionTimeInSeconds** *(integer) --* The time that this ingestion took, measured in seconds. * **IngestionSizeInBytes** *(integer) --* The size of the data ingested, in bytes. * **RequestSource** *(string) --* Event source for this ingestion. * **RequestType** *(string) --* Type of this ingestion. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. QuickSight / Paginator / ListAssetBundleImportJobs ListAssetBundleImportJobs ************************* class QuickSight.Paginator.ListAssetBundleImportJobs paginator = client.get_paginator('list_asset_bundle_import_jobs') paginate(**kwargs) Creates an iterator that will paginate through responses from "QuickSight.Client.list_asset_bundle_import_jobs()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( AwsAccountId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that the import jobs were executed in. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'AssetBundleImportJobSummaryList': [ { 'JobStatus': 'QUEUED_FOR_IMMEDIATE_EXECUTION'|'IN_PROGRESS'|'SUCCESSFUL'|'FAILED'|'FAILED_ROLLBACK_IN_PROGRESS'|'FAILED_ROLLBACK_COMPLETED'|'FAILED_ROLLBACK_ERROR', 'Arn': 'string', 'CreatedTime': datetime(2015, 1, 1), 'AssetBundleImportJobId': 'string', 'FailureAction': 'DO_NOTHING'|'ROLLBACK' }, ], 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **AssetBundleImportJobSummaryList** *(list) --* A list of import job summaries. * *(dict) --* A summary of the import job that includes details of the requested job's configuration and its current status. * **JobStatus** *(string) --* The current status of the import job. * **Arn** *(string) --* The ARN of the import job. * **CreatedTime** *(datetime) --* The time that the import job was created. * **AssetBundleImportJobId** *(string) --* The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job. * **FailureAction** *(string) --* The failure action for the import job. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the response. QuickSight / Paginator / ListGroupMemberships ListGroupMemberships ******************** class QuickSight.Paginator.ListGroupMemberships paginator = client.get_paginator('list_group_memberships') paginate(**kwargs) Creates an iterator that will paginate through responses from "QuickSight.Client.list_group_memberships()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( GroupName='string', AwsAccountId='string', Namespace='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **GroupName** (*string*) -- **[REQUIRED]** The name of the group that you want to see a membership list of. * **AwsAccountId** (*string*) -- **[REQUIRED]** 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** (*string*) -- **[REQUIRED]** The namespace of the group that you want a list of users from. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'GroupMemberList': [ { 'Arn': 'string', 'MemberName': 'string' }, ], 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **GroupMemberList** *(list) --* The list of the members of the group. * *(dict) --* A member of an Amazon QuickSight group. Currently, group members must be users. Groups can't be members of another group. . * **Arn** *(string) --* The Amazon Resource Name (ARN) for the group member (user). * **MemberName** *(string) --* The name of the group member (user). * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. QuickSight / Paginator / ListNamespaces ListNamespaces ************** class QuickSight.Paginator.ListNamespaces paginator = client.get_paginator('list_namespaces') paginate(**kwargs) Creates an iterator that will paginate through responses from "QuickSight.Client.list_namespaces()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( AwsAccountId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID for the Amazon Web Services account that contains the Amazon QuickSight namespaces that you want to list. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Namespaces': [ { 'Name': 'string', 'Arn': 'string', 'CapacityRegion': 'string', 'CreationStatus': 'CREATED'|'CREATING'|'DELETING'|'RETRYABLE_FAILURE'|'NON_RETRYABLE_FAILURE', 'IdentityStore': 'QUICKSIGHT', 'NamespaceError': { 'Type': 'PERMISSION_DENIED'|'INTERNAL_SERVICE_ERROR', 'Message': 'string' }, 'IamIdentityCenterApplicationArn': 'string', 'IamIdentityCenterInstanceArn': 'string' }, ], 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **Namespaces** *(list) --* 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. * *(dict) --* The error type. * **Name** *(string) --* The name of the error. * **Arn** *(string) --* The namespace ARN. * **CapacityRegion** *(string) --* The namespace Amazon Web Services Region. * **CreationStatus** *(string) --* The creation status of a namespace that is not yet completely created. * **IdentityStore** *(string) --* The identity store used for the namespace. * **NamespaceError** *(dict) --* An error that occurred when the namespace was created. * **Type** *(string) --* The error type. * **Message** *(string) --* The message for the error. * **IamIdentityCenterApplicationArn** *(string) --* The Amazon Resource Name (ARN) for the IAM Identity Center application. * **IamIdentityCenterInstanceArn** *(string) --* The Amazon Resource Name (ARN) for the IAM Identity Center instance. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. QuickSight / Paginator / ListDashboards ListDashboards ************** class QuickSight.Paginator.ListDashboards paginator = client.get_paginator('list_dashboards') paginate(**kwargs) Creates an iterator that will paginate through responses from "QuickSight.Client.list_dashboards()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( AwsAccountId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the dashboards that you're listing. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'DashboardSummaryList': [ { 'Arn': 'string', 'DashboardId': 'string', 'Name': 'string', 'CreatedTime': datetime(2015, 1, 1), 'LastUpdatedTime': datetime(2015, 1, 1), 'PublishedVersionNumber': 123, 'LastPublishedTime': datetime(2015, 1, 1) }, ], 'Status': 123, 'RequestId': 'string' } **Response Structure** * *(dict) --* * **DashboardSummaryList** *(list) --* A structure that contains all of the dashboards in your Amazon Web Services account. This structure provides basic information about the dashboards. * *(dict) --* Dashboard summary. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the resource. * **DashboardId** *(string) --* Dashboard ID. * **Name** *(string) --* A display name for the dashboard. * **CreatedTime** *(datetime) --* The time that this dashboard was created. * **LastUpdatedTime** *(datetime) --* The last time that this dashboard was updated. * **PublishedVersionNumber** *(integer) --* Published version number. * **LastPublishedTime** *(datetime) --* The last time that this dashboard was published. * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. QuickSight / Paginator / ListUserGroups ListUserGroups ************** class QuickSight.Paginator.ListUserGroups paginator = client.get_paginator('list_user_groups') paginate(**kwargs) Creates an iterator that will paginate through responses from "QuickSight.Client.list_user_groups()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( UserName='string', AwsAccountId='string', Namespace='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **UserName** (*string*) -- **[REQUIRED]** The Amazon QuickSight user name that you want to list group memberships for. * **AwsAccountId** (*string*) -- **[REQUIRED]** 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** (*string*) -- **[REQUIRED]** The namespace. Currently, you should set this to "default". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'GroupList': [ { 'Arn': 'string', 'GroupName': 'string', 'Description': 'string', 'PrincipalId': 'string' }, ], 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **GroupList** *(list) --* The list of groups the user is a member of. * *(dict) --* A *group* in Amazon QuickSight consists of a set of users. You can use groups to make it easier to manage access and security. * **Arn** *(string) --* The Amazon Resource Name (ARN) for the group. * **GroupName** *(string) --* The name of the group. * **Description** *(string) --* The group description. * **PrincipalId** *(string) --* The principal ID of the group. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. QuickSight / Paginator / ListCustomPermissions ListCustomPermissions ********************* class QuickSight.Paginator.ListCustomPermissions paginator = client.get_paginator('list_custom_permissions') paginate(**kwargs) Creates an iterator that will paginate through responses from "QuickSight.Client.list_custom_permissions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( AwsAccountId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the custom permissions profiles that you want to list. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Status': 123, 'CustomPermissionsList': [ { 'Arn': 'string', 'CustomPermissionsName': 'string', 'Capabilities': { 'ExportToCsv': 'DENY', 'ExportToExcel': 'DENY', 'ExportToPdf': 'DENY', 'PrintReports': 'DENY', 'CreateAndUpdateThemes': 'DENY', 'AddOrRunAnomalyDetectionForAnalyses': 'DENY', 'ShareAnalyses': 'DENY', 'CreateAndUpdateDatasets': 'DENY', 'ShareDatasets': 'DENY', 'SubscribeDashboardEmailReports': 'DENY', 'CreateAndUpdateDashboardEmailReports': 'DENY', 'ShareDashboards': 'DENY', 'CreateAndUpdateThresholdAlerts': 'DENY', 'RenameSharedFolders': 'DENY', 'CreateSharedFolders': 'DENY', 'CreateAndUpdateDataSources': 'DENY', 'ShareDataSources': 'DENY', 'ViewAccountSPICECapacity': 'DENY', 'CreateSPICEDataset': 'DENY', 'ExportToPdfInScheduledReports': 'DENY', 'ExportToCsvInScheduledReports': 'DENY', 'ExportToExcelInScheduledReports': 'DENY', 'IncludeContentInScheduledReportsEmail': 'DENY' } }, ], 'RequestId': 'string' } **Response Structure** * *(dict) --* * **Status** *(integer) --* The HTTP status of the request. * **CustomPermissionsList** *(list) --* A list of custom permissions profiles. * *(dict) --* The custom permissions profile. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the custom permissions profile. * **CustomPermissionsName** *(string) --* The name of the custom permissions profile. * **Capabilities** *(dict) --* A set of actions in the custom permissions profile. * **ExportToCsv** *(string) --* The ability to export to CSV files from the UI. * **ExportToExcel** *(string) --* The ability to export to Excel files from the UI. * **ExportToPdf** *(string) --* The ability to export to PDF files from the UI. * **PrintReports** *(string) --* The ability to print reports. * **CreateAndUpdateThemes** *(string) --* The ability to export to Create and Update themes. * **AddOrRunAnomalyDetectionForAnalyses** *(string) --* The ability to add or run anomaly detection. * **ShareAnalyses** *(string) --* The ability to share analyses. * **CreateAndUpdateDatasets** *(string) --* The ability to create and update datasets. * **ShareDatasets** *(string) --* The ability to share datasets. * **SubscribeDashboardEmailReports** *(string) --* The ability to subscribe to email reports. * **CreateAndUpdateDashboardEmailReports** *(string) --* The ability to create and update email reports. * **ShareDashboards** *(string) --* The ability to share dashboards. * **CreateAndUpdateThresholdAlerts** *(string) --* The ability to create and update threshold alerts. * **RenameSharedFolders** *(string) --* The ability to rename shared folders. * **CreateSharedFolders** *(string) --* The ability to create shared folders. * **CreateAndUpdateDataSources** *(string) --* The ability to create and update data sources. * **ShareDataSources** *(string) --* The ability to share data sources. * **ViewAccountSPICECapacity** *(string) --* The ability to view account SPICE capacity. * **CreateSPICEDataset** *(string) --* The ability to create a SPICE dataset. * **ExportToPdfInScheduledReports** *(string) --* The ability to export to PDF files in scheduled email reports. * **ExportToCsvInScheduledReports** *(string) --* The ability to export to CSV files in scheduled email reports. * **ExportToExcelInScheduledReports** *(string) --* The ability to export to Excel files in scheduled email reports. * **IncludeContentInScheduledReportsEmail** *(string) --* The ability to include content in scheduled email reports. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. QuickSight / Paginator / ListThemes ListThemes ********** class QuickSight.Paginator.ListThemes paginator = client.get_paginator('list_themes') paginate(**kwargs) Creates an iterator that will paginate through responses from "QuickSight.Client.list_themes()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( AwsAccountId='string', Type='QUICKSIGHT'|'CUSTOM'|'ALL', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the themes that you're listing. * **Type** (*string*) -- The type of themes that you want to list. Valid options include the following: * "ALL (default)"- Display all existing themes. * "CUSTOM" - Display only the themes created by people using Amazon QuickSight. * "QUICKSIGHT" - Display only the starting themes defined by Amazon QuickSight. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'ThemeSummaryList': [ { 'Arn': 'string', 'Name': 'string', 'ThemeId': 'string', 'LatestVersionNumber': 123, 'CreatedTime': datetime(2015, 1, 1), 'LastUpdatedTime': datetime(2015, 1, 1) }, ], 'Status': 123, 'RequestId': 'string' } **Response Structure** * *(dict) --* * **ThemeSummaryList** *(list) --* Information about the themes in the list. * *(dict) --* The theme summary. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the resource. * **Name** *(string) --* the display name for the theme. * **ThemeId** *(string) --* The ID of the theme. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. * **LatestVersionNumber** *(integer) --* The latest version number for the theme. * **CreatedTime** *(datetime) --* The date and time that this theme was created. * **LastUpdatedTime** *(datetime) --* The last date and time that this theme was updated. * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. QuickSight / Paginator / SearchTopics SearchTopics ************ class QuickSight.Paginator.SearchTopics paginator = client.get_paginator('search_topics') paginate(**kwargs) Creates an iterator that will paginate through responses from "QuickSight.Client.search_topics()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( AwsAccountId='string', Filters=[ { 'Operator': 'StringEquals'|'StringLike', 'Name': 'QUICKSIGHT_USER'|'QUICKSIGHT_VIEWER_OR_OWNER'|'DIRECT_QUICKSIGHT_VIEWER_OR_OWNER'|'QUICKSIGHT_OWNER'|'DIRECT_QUICKSIGHT_OWNER'|'DIRECT_QUICKSIGHT_SOLE_OWNER'|'TOPIC_NAME', 'Value': 'string' }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the topic that you want to find. * **Filters** (*list*) -- **[REQUIRED]** The filters that you want to use to search for the topic. * *(dict) --* The filter that is used to search for a topic. * **Operator** *(string) --* **[REQUIRED]** The operator like equals or like. * **Name** *(string) --* **[REQUIRED]** The name of the topic search filter. * **Value** *(string) --* **[REQUIRED]** The value of the topic search filter. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'TopicSummaryList': [ { 'Arn': 'string', 'TopicId': 'string', 'Name': 'string', 'UserExperienceVersion': 'LEGACY'|'NEW_READER_EXPERIENCE' }, ], 'Status': 123, 'RequestId': 'string' } **Response Structure** * *(dict) --* * **TopicSummaryList** *(list) --* A list of topic summaries that is returned by the search topic request. * *(dict) --* A topic summary. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the topic. * **TopicId** *(string) --* The ID for the topic. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. * **Name** *(string) --* The name of the topic. * **UserExperienceVersion** *(string) --* The user experience version of the topic. * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. QuickSight / Paginator / DescribeFolderResolvedPermissions DescribeFolderResolvedPermissions ********************************* class QuickSight.Paginator.DescribeFolderResolvedPermissions paginator = client.get_paginator('describe_folder_resolved_permissions') paginate(**kwargs) Creates an iterator that will paginate through responses from "QuickSight.Client.describe_folder_resolved_permissions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( AwsAccountId='string', FolderId='string', Namespace='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID for the Amazon Web Services account that contains the folder. * **FolderId** (*string*) -- **[REQUIRED]** The ID of the folder. * **Namespace** (*string*) -- The namespace of the folder whose permissions you want described. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Status': 123, 'FolderId': 'string', 'Arn': 'string', 'Permissions': [ { 'Principal': 'string', 'Actions': [ 'string', ] }, ], 'RequestId': 'string', } **Response Structure** * *(dict) --* * **Status** *(integer) --* The HTTP status of the request. * **FolderId** *(string) --* The ID of the folder. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the folder. * **Permissions** *(list) --* Information about the permissions for the folder. * *(dict) --* Permission for the resource. * **Principal** *(string) --* The Amazon Resource Name (ARN) of the principal. This can be one of the following: * The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.) * The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.) * The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.) * **Actions** *(list) --* The IAM action to grant or revoke permissions on. * *(string) --* * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. QuickSight / Paginator / ListAssetBundleExportJobs ListAssetBundleExportJobs ************************* class QuickSight.Paginator.ListAssetBundleExportJobs paginator = client.get_paginator('list_asset_bundle_export_jobs') paginate(**kwargs) Creates an iterator that will paginate through responses from "QuickSight.Client.list_asset_bundle_export_jobs()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( AwsAccountId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that the export jobs were executed in. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'AssetBundleExportJobSummaryList': [ { 'JobStatus': 'QUEUED_FOR_IMMEDIATE_EXECUTION'|'IN_PROGRESS'|'SUCCESSFUL'|'FAILED', 'Arn': 'string', 'CreatedTime': datetime(2015, 1, 1), 'AssetBundleExportJobId': 'string', 'IncludeAllDependencies': True|False, 'ExportFormat': 'CLOUDFORMATION_JSON'|'QUICKSIGHT_JSON', 'IncludePermissions': True|False, 'IncludeTags': True|False }, ], 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **AssetBundleExportJobSummaryList** *(list) --* A list of export job summaries. * *(dict) --* A summary of the export job that includes details of the job's configuration and its current status. * **JobStatus** *(string) --* The current status of the export job. * **Arn** *(string) --* The ARN of the export job. * **CreatedTime** *(datetime) --* The time that the export job was created. * **AssetBundleExportJobId** *(string) --* The ID of the export job. * **IncludeAllDependencies** *(boolean) --* The flag that determines the inclusion of resource dependencies in the returned asset bundle. * **ExportFormat** *(string) --* The format for the export job. * **IncludePermissions** *(boolean) --* The flag that determines the inclusion of permissions associated with each resource ARN. * **IncludeTags** *(boolean) --* The flag that determines the inclusion of tags associated with each resource ARN. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. QuickSight / Paginator / ListFoldersForResource ListFoldersForResource ********************** class QuickSight.Paginator.ListFoldersForResource paginator = client.get_paginator('list_folders_for_resource') paginate(**kwargs) Creates an iterator that will paginate through responses from "QuickSight.Client.list_folders_for_resource()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( AwsAccountId='string', ResourceArn='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID for the Amazon Web Services account that contains the resource. * **ResourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) the resource whose folders you need to list. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Status': 123, 'Folders': [ 'string', ], 'RequestId': 'string' } **Response Structure** * *(dict) --* * **Status** *(integer) --* The HTTP status of the request. * **Folders** *(list) --* A list that contains the Amazon Resource Names (ARNs) of all folders that the resource is a member of. * *(string) --* * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. QuickSight / Paginator / SearchDataSources SearchDataSources ***************** class QuickSight.Paginator.SearchDataSources paginator = client.get_paginator('search_data_sources') paginate(**kwargs) Creates an iterator that will paginate through responses from "QuickSight.Client.search_data_sources()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( AwsAccountId='string', Filters=[ { 'Operator': 'StringEquals'|'StringLike', 'Name': 'DIRECT_QUICKSIGHT_VIEWER_OR_OWNER'|'DIRECT_QUICKSIGHT_OWNER'|'DIRECT_QUICKSIGHT_SOLE_OWNER'|'DATASOURCE_NAME', 'Value': 'string' }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The Amazon Web Services account ID. * **Filters** (*list*) -- **[REQUIRED]** The filters to apply to the search. * *(dict) --* A filter that you apply when searching for data sources. * **Operator** *(string) --* **[REQUIRED]** The comparison operator that you want to use as a filter, for example ""Operator": "StringEquals"". Valid values are ""StringEquals"" and ""StringLike"". If you set the operator value to ""StringEquals"", you need to provide an ownership related filter in the ""NAME"" field and the arn of the user or group whose data sources you want to search in the ""Value"" field. For example, ""Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us- east-1:1:user/default/UserName1"". If you set the value to ""StringLike"", you need to provide the name of the data sources you are searching for. For example, ""Name":"DATASOURCE_NAME", "Operator": "StringLike", "Value": "Test"". The ""StringLike"" operator only supports the "NAME" value "DATASOURCE_NAME". * **Name** *(string) --* **[REQUIRED]** The name of the value that you want to use as a filter, for example, ""Name": "DIRECT_QUICKSIGHT_OWNER"". Valid values are defined as follows: * "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER": Provide an ARN of a user or group, and any data sources with that ARN listed as one of the owners or viewers of the data sources are returned. Implicit permissions from folders or groups are not considered. * "DIRECT_QUICKSIGHT_OWNER": Provide an ARN of a user or group, and any data sources with that ARN listed as one of the owners if the data source are returned. Implicit permissions from folders or groups are not considered. * "DIRECT_QUICKSIGHT_SOLE_OWNER": Provide an ARN of a user or group, and any data sources with that ARN listed as the only owner of the data source are returned. Implicit permissions from folders or groups are not considered. * "DATASOURCE_NAME": Any data sources whose names have a substring match to the provided value are returned. * **Value** *(string) --* **[REQUIRED]** The value of the named item, for example "DIRECT_QUICKSIGHT_OWNER", that you want to use as a filter, for example, ""Value": "arn:aws:quicksight:us- east-1:1:user/default/UserName1"". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'DataSourceSummaries': [ { 'Arn': 'string', 'DataSourceId': 'string', 'Name': 'string', 'Type': 'ADOBE_ANALYTICS'|'AMAZON_ELASTICSEARCH'|'ATHENA'|'AURORA'|'AURORA_POSTGRESQL'|'AWS_IOT_ANALYTICS'|'GITHUB'|'JIRA'|'MARIADB'|'MYSQL'|'ORACLE'|'POSTGRESQL'|'PRESTO'|'REDSHIFT'|'S3'|'SALESFORCE'|'SERVICENOW'|'SNOWFLAKE'|'SPARK'|'SQLSERVER'|'TERADATA'|'TWITTER'|'TIMESTREAM'|'AMAZON_OPENSEARCH'|'EXASOL'|'DATABRICKS'|'STARBURST'|'TRINO'|'BIGQUERY', 'CreatedTime': datetime(2015, 1, 1), 'LastUpdatedTime': datetime(2015, 1, 1) }, ], 'Status': 123, 'RequestId': 'string' } **Response Structure** * *(dict) --* * **DataSourceSummaries** *(list) --* A "DataSourceSummaries" object that returns a summary of a data source. * *(dict) --* A "DataSourceSummary" object that returns a summary of a data source. * **Arn** *(string) --* The arn of the datasource. * **DataSourceId** *(string) --* The unique ID of the data source. * **Name** *(string) --* The name of the data source. * **Type** *(string) --* The type of the data source. * **CreatedTime** *(datetime) --* The date and time that the data source was created. This value is expressed in MM-DD-YYYY HH:MM:SS format. * **LastUpdatedTime** *(datetime) --* The date and time the data source was last updated. This value is expressed in MM-DD-YYYY HH:MM:SS format. * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. QuickSight / Paginator / ListThemeVersions ListThemeVersions ***************** class QuickSight.Paginator.ListThemeVersions paginator = client.get_paginator('list_theme_versions') paginate(**kwargs) Creates an iterator that will paginate through responses from "QuickSight.Client.list_theme_versions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( AwsAccountId='string', ThemeId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the themes that you're listing. * **ThemeId** (*string*) -- **[REQUIRED]** The ID for the theme. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'ThemeVersionSummaryList': [ { 'VersionNumber': 123, 'Arn': 'string', 'Description': 'string', 'CreatedTime': datetime(2015, 1, 1), 'Status': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED' }, ], 'Status': 123, 'RequestId': 'string' } **Response Structure** * *(dict) --* * **ThemeVersionSummaryList** *(list) --* A structure containing a list of all the versions of the specified theme. * *(dict) --* The theme version. * **VersionNumber** *(integer) --* The version number of the theme version. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the theme version. * **Description** *(string) --* The description of the theme version. * **CreatedTime** *(datetime) --* The date and time that this theme version was created. * **Status** *(string) --* The status of the theme version. * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. QuickSight / Paginator / ListFolders ListFolders *********** class QuickSight.Paginator.ListFolders paginator = client.get_paginator('list_folders') paginate(**kwargs) Creates an iterator that will paginate through responses from "QuickSight.Client.list_folders()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( AwsAccountId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID for the Amazon Web Services account that contains the folder. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Status': 123, 'FolderSummaryList': [ { 'Arn': 'string', 'FolderId': 'string', 'Name': 'string', 'FolderType': 'SHARED'|'RESTRICTED', 'CreatedTime': datetime(2015, 1, 1), 'LastUpdatedTime': datetime(2015, 1, 1), 'SharingModel': 'ACCOUNT'|'NAMESPACE' }, ], 'RequestId': 'string' } **Response Structure** * *(dict) --* * **Status** *(integer) --* The HTTP status of the request. * **FolderSummaryList** *(list) --* A structure that contains all of the folders in the Amazon Web Services account. This structure provides basic information about the folders. * *(dict) --* A summary of information about an existing Amazon QuickSight folder. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the folder. * **FolderId** *(string) --* The ID of the folder. * **Name** *(string) --* The display name of the folder. * **FolderType** *(string) --* The type of folder. * **CreatedTime** *(datetime) --* The time that the folder was created. * **LastUpdatedTime** *(datetime) --* The time that the folder was last updated. * **SharingModel** *(string) --* The sharing scope of the folder. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. QuickSight / Paginator / ListUsers ListUsers ********* class QuickSight.Paginator.ListUsers paginator = client.get_paginator('list_users') paginate(**kwargs) Creates an iterator that will paginate through responses from "QuickSight.Client.list_users()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( AwsAccountId='string', Namespace='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** 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** (*string*) -- **[REQUIRED]** The namespace. Currently, you should set this to "default". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'UserList': [ { 'Arn': 'string', 'UserName': 'string', 'Email': 'string', 'Role': 'ADMIN'|'AUTHOR'|'READER'|'RESTRICTED_AUTHOR'|'RESTRICTED_READER'|'ADMIN_PRO'|'AUTHOR_PRO'|'READER_PRO', 'IdentityType': 'IAM'|'QUICKSIGHT'|'IAM_IDENTITY_CENTER', 'Active': True|False, 'PrincipalId': 'string', 'CustomPermissionsName': 'string', 'ExternalLoginFederationProviderType': 'string', 'ExternalLoginFederationProviderUrl': 'string', 'ExternalLoginId': 'string' }, ], 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **UserList** *(list) --* The list of users. * *(dict) --* A registered user of Amazon QuickSight. * **Arn** *(string) --* The Amazon Resource Name (ARN) for the user. * **UserName** *(string) --* The user's user name. This value is required if you are registering a user that will be managed in Amazon QuickSight. In the output, the value for "UserName" is "N/A" when the value for "IdentityType" is "IAM" and the corresponding IAM user is deleted. * **Email** *(string) --* The user's email address. * **Role** *(string) --* The Amazon QuickSight role for the user. The user role can be one of the following:. * "READER": A user who has read-only access to dashboards. * "AUTHOR": A user who can create data sources, datasets, analyses, and dashboards. * "ADMIN": A user who is an author, who can also manage Amazon Amazon QuickSight settings. * "READER_PRO": Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Amazon QuickSight, can build stories with Amazon Q, and can generate executive summaries from dashboards. * "AUTHOR_PRO": Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&A, and generate executive summaries from dashboards. * "ADMIN_PRO": Admin Pros are Author Pros who can also manage Amazon QuickSight administrative settings. Admin Pro users are billed at Author Pro pricing. * "RESTRICTED_READER": This role isn't currently available for use. * "RESTRICTED_AUTHOR": This role isn't currently available for use. * **IdentityType** *(string) --* The type of identity authentication used by the user. * **Active** *(boolean) --* The active status of user. When you create an Amazon QuickSight user that's not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a password. * **PrincipalId** *(string) --* The principal ID of the user. * **CustomPermissionsName** *(string) --* The custom permissions profile associated with this user. * **ExternalLoginFederationProviderType** *(string) --* The type of supported external login provider that provides identity to let the user federate into Amazon QuickSight with an associated IAM role. The type can be one of the following. * "COGNITO": Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. * "CUSTOM_OIDC": Custom OpenID Connect (OIDC) provider. * **ExternalLoginFederationProviderUrl** *(string) --* The URL of the external login provider. * **ExternalLoginId** *(string) --* The identity ID for the user in the external login provider. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. QuickSight / Paginator / ListIAMPolicyAssignmentsForUser ListIAMPolicyAssignmentsForUser ******************************* class QuickSight.Paginator.ListIAMPolicyAssignmentsForUser paginator = client.get_paginator('list_iam_policy_assignments_for_user') paginate(**kwargs) Creates an iterator that will paginate through responses from "QuickSight.Client.list_iam_policy_assignments_for_user()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( AwsAccountId='string', UserName='string', Namespace='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the assignments. * **UserName** (*string*) -- **[REQUIRED]** The name of the user. * **Namespace** (*string*) -- **[REQUIRED]** The namespace of the assignment. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'ActiveAssignments': [ { 'AssignmentName': 'string', 'PolicyArn': 'string' }, ], 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **ActiveAssignments** *(list) --* The active assignments for this user. * *(dict) --* The active Identity and Access Management (IAM) policy assignment. * **AssignmentName** *(string) --* A name for the IAM policy assignment. * **PolicyArn** *(string) --* The Amazon Resource Name (ARN) of the resource. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. QuickSight / Paginator / ListDataSources ListDataSources *************** class QuickSight.Paginator.ListDataSources paginator = client.get_paginator('list_data_sources') paginate(**kwargs) Creates an iterator that will paginate through responses from "QuickSight.Client.list_data_sources()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( AwsAccountId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The Amazon Web Services account ID. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'DataSources': [ { 'Arn': 'string', 'DataSourceId': 'string', 'Name': 'string', 'Type': 'ADOBE_ANALYTICS'|'AMAZON_ELASTICSEARCH'|'ATHENA'|'AURORA'|'AURORA_POSTGRESQL'|'AWS_IOT_ANALYTICS'|'GITHUB'|'JIRA'|'MARIADB'|'MYSQL'|'ORACLE'|'POSTGRESQL'|'PRESTO'|'REDSHIFT'|'S3'|'SALESFORCE'|'SERVICENOW'|'SNOWFLAKE'|'SPARK'|'SQLSERVER'|'TERADATA'|'TWITTER'|'TIMESTREAM'|'AMAZON_OPENSEARCH'|'EXASOL'|'DATABRICKS'|'STARBURST'|'TRINO'|'BIGQUERY', 'Status': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED', 'CreatedTime': datetime(2015, 1, 1), 'LastUpdatedTime': datetime(2015, 1, 1), 'DataSourceParameters': { 'AmazonElasticsearchParameters': { 'Domain': 'string' }, 'AthenaParameters': { 'WorkGroup': 'string', 'RoleArn': 'string', 'IdentityCenterConfiguration': { 'EnableIdentityPropagation': True|False } }, 'AuroraParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'AuroraPostgreSqlParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'AwsIotAnalyticsParameters': { 'DataSetName': 'string' }, 'JiraParameters': { 'SiteBaseUrl': 'string' }, 'MariaDbParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'MySqlParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'OracleParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string', 'UseServiceName': True|False }, 'PostgreSqlParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'PrestoParameters': { 'Host': 'string', 'Port': 123, 'Catalog': 'string' }, 'RdsParameters': { 'InstanceId': 'string', 'Database': 'string' }, 'RedshiftParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string', 'ClusterId': 'string', 'IAMParameters': { 'RoleArn': 'string', 'DatabaseUser': 'string', 'DatabaseGroups': [ 'string', ], 'AutoCreateDatabaseUser': True|False }, 'IdentityCenterConfiguration': { 'EnableIdentityPropagation': True|False } }, 'S3Parameters': { 'ManifestFileLocation': { 'Bucket': 'string', 'Key': 'string' }, 'RoleArn': 'string' }, 'ServiceNowParameters': { 'SiteBaseUrl': 'string' }, 'SnowflakeParameters': { 'Host': 'string', 'Database': 'string', 'Warehouse': 'string', 'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509', 'DatabaseAccessControlRole': 'string', 'OAuthParameters': { 'TokenProviderUrl': 'string', 'OAuthScope': 'string', 'IdentityProviderVpcConnectionProperties': { 'VpcConnectionArn': 'string' }, 'IdentityProviderResourceUri': 'string' } }, 'SparkParameters': { 'Host': 'string', 'Port': 123 }, 'SqlServerParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'TeradataParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'TwitterParameters': { 'Query': 'string', 'MaxRows': 123 }, 'AmazonOpenSearchParameters': { 'Domain': 'string' }, 'ExasolParameters': { 'Host': 'string', 'Port': 123 }, 'DatabricksParameters': { 'Host': 'string', 'Port': 123, 'SqlEndpointPath': 'string' }, 'StarburstParameters': { 'Host': 'string', 'Port': 123, 'Catalog': 'string', 'ProductType': 'GALAXY'|'ENTERPRISE', 'DatabaseAccessControlRole': 'string', 'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509', 'OAuthParameters': { 'TokenProviderUrl': 'string', 'OAuthScope': 'string', 'IdentityProviderVpcConnectionProperties': { 'VpcConnectionArn': 'string' }, 'IdentityProviderResourceUri': 'string' } }, 'TrinoParameters': { 'Host': 'string', 'Port': 123, 'Catalog': 'string' }, 'BigQueryParameters': { 'ProjectId': 'string', 'DataSetRegion': 'string' }, 'ImpalaParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string', 'SqlEndpointPath': 'string' } }, 'AlternateDataSourceParameters': [ { 'AmazonElasticsearchParameters': { 'Domain': 'string' }, 'AthenaParameters': { 'WorkGroup': 'string', 'RoleArn': 'string', 'IdentityCenterConfiguration': { 'EnableIdentityPropagation': True|False } }, 'AuroraParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'AuroraPostgreSqlParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'AwsIotAnalyticsParameters': { 'DataSetName': 'string' }, 'JiraParameters': { 'SiteBaseUrl': 'string' }, 'MariaDbParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'MySqlParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'OracleParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string', 'UseServiceName': True|False }, 'PostgreSqlParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'PrestoParameters': { 'Host': 'string', 'Port': 123, 'Catalog': 'string' }, 'RdsParameters': { 'InstanceId': 'string', 'Database': 'string' }, 'RedshiftParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string', 'ClusterId': 'string', 'IAMParameters': { 'RoleArn': 'string', 'DatabaseUser': 'string', 'DatabaseGroups': [ 'string', ], 'AutoCreateDatabaseUser': True|False }, 'IdentityCenterConfiguration': { 'EnableIdentityPropagation': True|False } }, 'S3Parameters': { 'ManifestFileLocation': { 'Bucket': 'string', 'Key': 'string' }, 'RoleArn': 'string' }, 'ServiceNowParameters': { 'SiteBaseUrl': 'string' }, 'SnowflakeParameters': { 'Host': 'string', 'Database': 'string', 'Warehouse': 'string', 'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509', 'DatabaseAccessControlRole': 'string', 'OAuthParameters': { 'TokenProviderUrl': 'string', 'OAuthScope': 'string', 'IdentityProviderVpcConnectionProperties': { 'VpcConnectionArn': 'string' }, 'IdentityProviderResourceUri': 'string' } }, 'SparkParameters': { 'Host': 'string', 'Port': 123 }, 'SqlServerParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'TeradataParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'TwitterParameters': { 'Query': 'string', 'MaxRows': 123 }, 'AmazonOpenSearchParameters': { 'Domain': 'string' }, 'ExasolParameters': { 'Host': 'string', 'Port': 123 }, 'DatabricksParameters': { 'Host': 'string', 'Port': 123, 'SqlEndpointPath': 'string' }, 'StarburstParameters': { 'Host': 'string', 'Port': 123, 'Catalog': 'string', 'ProductType': 'GALAXY'|'ENTERPRISE', 'DatabaseAccessControlRole': 'string', 'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509', 'OAuthParameters': { 'TokenProviderUrl': 'string', 'OAuthScope': 'string', 'IdentityProviderVpcConnectionProperties': { 'VpcConnectionArn': 'string' }, 'IdentityProviderResourceUri': 'string' } }, 'TrinoParameters': { 'Host': 'string', 'Port': 123, 'Catalog': 'string' }, 'BigQueryParameters': { 'ProjectId': 'string', 'DataSetRegion': 'string' }, 'ImpalaParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string', 'SqlEndpointPath': 'string' } }, ], 'VpcConnectionProperties': { 'VpcConnectionArn': 'string' }, 'SslProperties': { 'DisableSsl': True|False }, 'ErrorInfo': { 'Type': 'ACCESS_DENIED'|'COPY_SOURCE_NOT_FOUND'|'TIMEOUT'|'ENGINE_VERSION_NOT_SUPPORTED'|'UNKNOWN_HOST'|'GENERIC_SQL_FAILURE'|'CONFLICT'|'UNKNOWN', 'Message': 'string' }, 'SecretArn': 'string' }, ], 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **DataSources** *(list) --* A list of data sources. * *(dict) --* The structure of a data source. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the data source. * **DataSourceId** *(string) --* The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. * **Name** *(string) --* A display name for the data source. * **Type** *(string) --* The type of the data source. This type indicates which database engine the data source connects to. * **Status** *(string) --* The HTTP status of the request. * **CreatedTime** *(datetime) --* The time that this data source was created. * **LastUpdatedTime** *(datetime) --* The last time that this data source was updated. * **DataSourceParameters** *(dict) --* The parameters that Amazon QuickSight uses to connect to your underlying source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null. * **AmazonElasticsearchParameters** *(dict) --* The parameters for OpenSearch. * **Domain** *(string) --* The OpenSearch domain. * **AthenaParameters** *(dict) --* The parameters for Amazon Athena. * **WorkGroup** *(string) --* The workgroup that Amazon Athena uses. * **RoleArn** *(string) --* Use the "RoleArn" structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account- wide role. The administrator can then use "RoleArn" to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active. * **IdentityCenterConfiguration** *(dict) --* An optional parameter that configures IAM Identity Center authentication to grant Amazon QuickSight access to your workgroup. This parameter can only be specified if your Amazon QuickSight account is configured with IAM Identity Center. * **EnableIdentityPropagation** *(boolean) --* A Boolean option that controls whether Trusted Identity Propagation should be used. * **AuroraParameters** *(dict) --* The parameters for Amazon Aurora MySQL. * **Host** *(string) --* Host. * **Port** *(integer) --* Port. * **Database** *(string) --* Database. * **AuroraPostgreSqlParameters** *(dict) --* The parameters for Amazon Aurora. * **Host** *(string) --* The Amazon Aurora PostgreSQL-Compatible host to connect to. * **Port** *(integer) --* The port that Amazon Aurora PostgreSQL is listening on. * **Database** *(string) --* The Amazon Aurora PostgreSQL database to connect to. * **AwsIotAnalyticsParameters** *(dict) --* The parameters for IoT Analytics. * **DataSetName** *(string) --* Dataset name. * **JiraParameters** *(dict) --* The parameters for Jira. * **SiteBaseUrl** *(string) --* The base URL of the Jira site. * **MariaDbParameters** *(dict) --* The parameters for MariaDB. * **Host** *(string) --* Host. * **Port** *(integer) --* Port. * **Database** *(string) --* Database. * **MySqlParameters** *(dict) --* The parameters for MySQL. * **Host** *(string) --* Host. * **Port** *(integer) --* Port. * **Database** *(string) --* Database. * **OracleParameters** *(dict) --* The parameters for Oracle. * **Host** *(string) --* An Oracle host. * **Port** *(integer) --* The port. * **Database** *(string) --* The database. * **UseServiceName** *(boolean) --* A Boolean value that indicates whether the "Database" uses a service name or an SID. If this value is left blank, the default value is "SID". If this value is set to "false", the value is "SID". * **PostgreSqlParameters** *(dict) --* The parameters for PostgreSQL. * **Host** *(string) --* Host. * **Port** *(integer) --* Port. * **Database** *(string) --* Database. * **PrestoParameters** *(dict) --* The parameters for Presto. * **Host** *(string) --* Host. * **Port** *(integer) --* Port. * **Catalog** *(string) --* Catalog. * **RdsParameters** *(dict) --* The parameters for Amazon RDS. * **InstanceId** *(string) --* Instance ID. * **Database** *(string) --* Database. * **RedshiftParameters** *(dict) --* The parameters for Amazon Redshift. * **Host** *(string) --* Host. This field can be blank if "ClusterId" is provided. * **Port** *(integer) --* Port. This field can be blank if the "ClusterId" is provided. * **Database** *(string) --* Database. * **ClusterId** *(string) --* Cluster ID. This field can be blank if the "Host" and "Port" are provided. * **IAMParameters** *(dict) --* An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials. * **RoleArn** *(string) --* Use the "RoleArn" structure to allow Amazon QuickSight to call "redshift:GetClusterCredentials" on your cluster. The calling principal must have "iam:PassRole" access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role. * **DatabaseUser** *(string) --* The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of "AutoCreateDatabaseUser" to "True" to create a new user with PUBLIC permissions. * **DatabaseGroups** *(list) --* A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the "DatabaseUser". If you choose to include this parameter, the "RoleArn" must grant access to "redshift:JoinGroup". * *(string) --* * **AutoCreateDatabaseUser** *(boolean) --* Automatically creates a database user. If your database doesn't have a "DatabaseUser", set this parameter to "True". If there is no "DatabaseUser", Amazon QuickSight can't connect to your cluster. The "RoleArn" that you use for this operation must grant access to "redshift:CreateClusterUser" to successfully create the user. * **IdentityCenterConfiguration** *(dict) --* An optional parameter that configures IAM Identity Center authentication to grant Amazon QuickSight access to your cluster. This parameter can only be specified if your Amazon QuickSight account is configured with IAM Identity Center. * **EnableIdentityPropagation** *(boolean) --* A Boolean option that controls whether Trusted Identity Propagation should be used. * **S3Parameters** *(dict) --* The parameters for S3. * **ManifestFileLocation** *(dict) --* Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight. * **Bucket** *(string) --* Amazon S3 bucket. * **Key** *(string) --* Amazon S3 key that identifies an object. * **RoleArn** *(string) --* Use the "RoleArn" structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use "RoleArn" to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active. * **ServiceNowParameters** *(dict) --* The parameters for ServiceNow. * **SiteBaseUrl** *(string) --* URL of the base site. * **SnowflakeParameters** *(dict) --* The parameters for Snowflake. * **Host** *(string) --* Host. * **Database** *(string) --* Database. * **Warehouse** *(string) --* Warehouse. * **AuthenticationType** *(string) --* The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types. * **DatabaseAccessControlRole** *(string) --* The database access control role. * **OAuthParameters** *(dict) --* An object that contains information needed to create a data source connection between an Amazon QuickSight account and Snowflake. * **TokenProviderUrl** *(string) --* The token endpoint URL of the identity provider. * **OAuthScope** *(string) --* The OAuth scope. * **IdentityProviderVpcConnectionProperties** *(dict) --* VPC connection properties. * **VpcConnectionArn** *(string) --* The Amazon Resource Name (ARN) for the VPC connection. * **IdentityProviderResourceUri** *(string) --* The resource uri of the identity provider. * **SparkParameters** *(dict) --* The parameters for Spark. * **Host** *(string) --* Host. * **Port** *(integer) --* Port. * **SqlServerParameters** *(dict) --* The parameters for SQL Server. * **Host** *(string) --* Host. * **Port** *(integer) --* Port. * **Database** *(string) --* Database. * **TeradataParameters** *(dict) --* The parameters for Teradata. * **Host** *(string) --* Host. * **Port** *(integer) --* Port. * **Database** *(string) --* Database. * **TwitterParameters** *(dict) --* The parameters for Twitter. * **Query** *(string) --* Twitter query string. * **MaxRows** *(integer) --* Maximum number of rows to query Twitter. * **AmazonOpenSearchParameters** *(dict) --* The parameters for OpenSearch. * **Domain** *(string) --* The OpenSearch domain. * **ExasolParameters** *(dict) --* The parameters for Exasol. * **Host** *(string) --* The hostname or IP address of the Exasol data source. * **Port** *(integer) --* The port for the Exasol data source. * **DatabricksParameters** *(dict) --* The parameters that are required to connect to a Databricks data source. * **Host** *(string) --* The host name of the Databricks data source. * **Port** *(integer) --* The port for the Databricks data source. * **SqlEndpointPath** *(string) --* The HTTP path of the Databricks data source. * **StarburstParameters** *(dict) --* The parameters that are required to connect to a Starburst data source. * **Host** *(string) --* The host name of the Starburst data source. * **Port** *(integer) --* The port for the Starburst data source. * **Catalog** *(string) --* The catalog name for the Starburst data source. * **ProductType** *(string) --* The product type for the Starburst data source. * **DatabaseAccessControlRole** *(string) --* The database access control role. * **AuthenticationType** *(string) --* The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types. * **OAuthParameters** *(dict) --* An object that contains information needed to create a data source connection between an Amazon QuickSight account and Starburst. * **TokenProviderUrl** *(string) --* The token endpoint URL of the identity provider. * **OAuthScope** *(string) --* The OAuth scope. * **IdentityProviderVpcConnectionProperties** *(dict) --* VPC connection properties. * **VpcConnectionArn** *(string) --* The Amazon Resource Name (ARN) for the VPC connection. * **IdentityProviderResourceUri** *(string) --* The resource uri of the identity provider. * **TrinoParameters** *(dict) --* The parameters that are required to connect to a Trino data source. * **Host** *(string) --* The host name of the Trino data source. * **Port** *(integer) --* The port for the Trino data source. * **Catalog** *(string) --* The catalog name for the Trino data source. * **BigQueryParameters** *(dict) --* The parameters that are required to connect to a Google BigQuery data source. * **ProjectId** *(string) --* The Google Cloud Platform project ID where your datasource was created. * **DataSetRegion** *(string) --* The storage location where you create a Google BigQuery data source. * **ImpalaParameters** *(dict) --* The parameters for Impala. * **Host** *(string) --* The host name of the Impala data source. * **Port** *(integer) --* The port of the Impala data source. * **Database** *(string) --* The database of the Impala data source. * **SqlEndpointPath** *(string) --* The HTTP path of the Impala data source. * **AlternateDataSourceParameters** *(list) --* A set of alternate data source parameters that you want to share for the credentials stored with this data source. The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the "DataSourceParameters" structure that's in the request with the structures in the "AlternateDataSourceParameters" allow list. If the structures are an exact match, the request is allowed to use the credentials from this existing data source. If the "AlternateDataSourceParameters" list is null, the "Credentials" originally used with this "DataSourceParameters" are automatically allowed. * *(dict) --* The parameters that Amazon QuickSight uses to connect to your underlying data source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null. * **AmazonElasticsearchParameters** *(dict) --* The parameters for OpenSearch. * **Domain** *(string) --* The OpenSearch domain. * **AthenaParameters** *(dict) --* The parameters for Amazon Athena. * **WorkGroup** *(string) --* The workgroup that Amazon Athena uses. * **RoleArn** *(string) --* Use the "RoleArn" structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use "RoleArn" to bypass the account- wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active. * **IdentityCenterConfiguration** *(dict) --* An optional parameter that configures IAM Identity Center authentication to grant Amazon QuickSight access to your workgroup. This parameter can only be specified if your Amazon QuickSight account is configured with IAM Identity Center. * **EnableIdentityPropagation** *(boolean) --* A Boolean option that controls whether Trusted Identity Propagation should be used. * **AuroraParameters** *(dict) --* The parameters for Amazon Aurora MySQL. * **Host** *(string) --* Host. * **Port** *(integer) --* Port. * **Database** *(string) --* Database. * **AuroraPostgreSqlParameters** *(dict) --* The parameters for Amazon Aurora. * **Host** *(string) --* The Amazon Aurora PostgreSQL-Compatible host to connect to. * **Port** *(integer) --* The port that Amazon Aurora PostgreSQL is listening on. * **Database** *(string) --* The Amazon Aurora PostgreSQL database to connect to. * **AwsIotAnalyticsParameters** *(dict) --* The parameters for IoT Analytics. * **DataSetName** *(string) --* Dataset name. * **JiraParameters** *(dict) --* The parameters for Jira. * **SiteBaseUrl** *(string) --* The base URL of the Jira site. * **MariaDbParameters** *(dict) --* The parameters for MariaDB. * **Host** *(string) --* Host. * **Port** *(integer) --* Port. * **Database** *(string) --* Database. * **MySqlParameters** *(dict) --* The parameters for MySQL. * **Host** *(string) --* Host. * **Port** *(integer) --* Port. * **Database** *(string) --* Database. * **OracleParameters** *(dict) --* The parameters for Oracle. * **Host** *(string) --* An Oracle host. * **Port** *(integer) --* The port. * **Database** *(string) --* The database. * **UseServiceName** *(boolean) --* A Boolean value that indicates whether the "Database" uses a service name or an SID. If this value is left blank, the default value is "SID". If this value is set to "false", the value is "SID". * **PostgreSqlParameters** *(dict) --* The parameters for PostgreSQL. * **Host** *(string) --* Host. * **Port** *(integer) --* Port. * **Database** *(string) --* Database. * **PrestoParameters** *(dict) --* The parameters for Presto. * **Host** *(string) --* Host. * **Port** *(integer) --* Port. * **Catalog** *(string) --* Catalog. * **RdsParameters** *(dict) --* The parameters for Amazon RDS. * **InstanceId** *(string) --* Instance ID. * **Database** *(string) --* Database. * **RedshiftParameters** *(dict) --* The parameters for Amazon Redshift. * **Host** *(string) --* Host. This field can be blank if "ClusterId" is provided. * **Port** *(integer) --* Port. This field can be blank if the "ClusterId" is provided. * **Database** *(string) --* Database. * **ClusterId** *(string) --* Cluster ID. This field can be blank if the "Host" and "Port" are provided. * **IAMParameters** *(dict) --* An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials. * **RoleArn** *(string) --* Use the "RoleArn" structure to allow Amazon QuickSight to call "redshift:GetClusterCredentials" on your cluster. The calling principal must have "iam:PassRole" access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role. * **DatabaseUser** *(string) --* The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of "AutoCreateDatabaseUser" to "True" to create a new user with PUBLIC permissions. * **DatabaseGroups** *(list) --* A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the "DatabaseUser". If you choose to include this parameter, the "RoleArn" must grant access to "redshift:JoinGroup". * *(string) --* * **AutoCreateDatabaseUser** *(boolean) --* Automatically creates a database user. If your database doesn't have a "DatabaseUser", set this parameter to "True". If there is no "DatabaseUser", Amazon QuickSight can't connect to your cluster. The "RoleArn" that you use for this operation must grant access to "redshift:CreateClusterUser" to successfully create the user. * **IdentityCenterConfiguration** *(dict) --* An optional parameter that configures IAM Identity Center authentication to grant Amazon QuickSight access to your cluster. This parameter can only be specified if your Amazon QuickSight account is configured with IAM Identity Center. * **EnableIdentityPropagation** *(boolean) --* A Boolean option that controls whether Trusted Identity Propagation should be used. * **S3Parameters** *(dict) --* The parameters for S3. * **ManifestFileLocation** *(dict) --* Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight. * **Bucket** *(string) --* Amazon S3 bucket. * **Key** *(string) --* Amazon S3 key that identifies an object. * **RoleArn** *(string) --* Use the "RoleArn" structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use "RoleArn" to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active. * **ServiceNowParameters** *(dict) --* The parameters for ServiceNow. * **SiteBaseUrl** *(string) --* URL of the base site. * **SnowflakeParameters** *(dict) --* The parameters for Snowflake. * **Host** *(string) --* Host. * **Database** *(string) --* Database. * **Warehouse** *(string) --* Warehouse. * **AuthenticationType** *(string) --* The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types. * **DatabaseAccessControlRole** *(string) --* The database access control role. * **OAuthParameters** *(dict) --* An object that contains information needed to create a data source connection between an Amazon QuickSight account and Snowflake. * **TokenProviderUrl** *(string) --* The token endpoint URL of the identity provider. * **OAuthScope** *(string) --* The OAuth scope. * **IdentityProviderVpcConnectionProperties** *(dict) --* VPC connection properties. * **VpcConnectionArn** *(string) --* The Amazon Resource Name (ARN) for the VPC connection. * **IdentityProviderResourceUri** *(string) --* The resource uri of the identity provider. * **SparkParameters** *(dict) --* The parameters for Spark. * **Host** *(string) --* Host. * **Port** *(integer) --* Port. * **SqlServerParameters** *(dict) --* The parameters for SQL Server. * **Host** *(string) --* Host. * **Port** *(integer) --* Port. * **Database** *(string) --* Database. * **TeradataParameters** *(dict) --* The parameters for Teradata. * **Host** *(string) --* Host. * **Port** *(integer) --* Port. * **Database** *(string) --* Database. * **TwitterParameters** *(dict) --* The parameters for Twitter. * **Query** *(string) --* Twitter query string. * **MaxRows** *(integer) --* Maximum number of rows to query Twitter. * **AmazonOpenSearchParameters** *(dict) --* The parameters for OpenSearch. * **Domain** *(string) --* The OpenSearch domain. * **ExasolParameters** *(dict) --* The parameters for Exasol. * **Host** *(string) --* The hostname or IP address of the Exasol data source. * **Port** *(integer) --* The port for the Exasol data source. * **DatabricksParameters** *(dict) --* The parameters that are required to connect to a Databricks data source. * **Host** *(string) --* The host name of the Databricks data source. * **Port** *(integer) --* The port for the Databricks data source. * **SqlEndpointPath** *(string) --* The HTTP path of the Databricks data source. * **StarburstParameters** *(dict) --* The parameters that are required to connect to a Starburst data source. * **Host** *(string) --* The host name of the Starburst data source. * **Port** *(integer) --* The port for the Starburst data source. * **Catalog** *(string) --* The catalog name for the Starburst data source. * **ProductType** *(string) --* The product type for the Starburst data source. * **DatabaseAccessControlRole** *(string) --* The database access control role. * **AuthenticationType** *(string) --* The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types. * **OAuthParameters** *(dict) --* An object that contains information needed to create a data source connection between an Amazon QuickSight account and Starburst. * **TokenProviderUrl** *(string) --* The token endpoint URL of the identity provider. * **OAuthScope** *(string) --* The OAuth scope. * **IdentityProviderVpcConnectionProperties** *(dict) --* VPC connection properties. * **VpcConnectionArn** *(string) --* The Amazon Resource Name (ARN) for the VPC connection. * **IdentityProviderResourceUri** *(string) --* The resource uri of the identity provider. * **TrinoParameters** *(dict) --* The parameters that are required to connect to a Trino data source. * **Host** *(string) --* The host name of the Trino data source. * **Port** *(integer) --* The port for the Trino data source. * **Catalog** *(string) --* The catalog name for the Trino data source. * **BigQueryParameters** *(dict) --* The parameters that are required to connect to a Google BigQuery data source. * **ProjectId** *(string) --* The Google Cloud Platform project ID where your datasource was created. * **DataSetRegion** *(string) --* The storage location where you create a Google BigQuery data source. * **ImpalaParameters** *(dict) --* The parameters for Impala. * **Host** *(string) --* The host name of the Impala data source. * **Port** *(integer) --* The port of the Impala data source. * **Database** *(string) --* The database of the Impala data source. * **SqlEndpointPath** *(string) --* The HTTP path of the Impala data source. * **VpcConnectionProperties** *(dict) --* The VPC connection information. You need to use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source. * **VpcConnectionArn** *(string) --* The Amazon Resource Name (ARN) for the VPC connection. * **SslProperties** *(dict) --* Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source. * **DisableSsl** *(boolean) --* A Boolean option to control whether SSL should be disabled. * **ErrorInfo** *(dict) --* Error information from the last update or the creation of the data source. * **Type** *(string) --* Error type. * **Message** *(string) --* Error message. * **SecretArn** *(string) --* The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. QuickSight / Paginator / SearchAnalyses SearchAnalyses ************** class QuickSight.Paginator.SearchAnalyses paginator = client.get_paginator('search_analyses') paginate(**kwargs) Creates an iterator that will paginate through responses from "QuickSight.Client.search_analyses()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( AwsAccountId='string', Filters=[ { 'Operator': 'StringEquals'|'StringLike', 'Name': 'QUICKSIGHT_USER'|'QUICKSIGHT_VIEWER_OR_OWNER'|'DIRECT_QUICKSIGHT_VIEWER_OR_OWNER'|'QUICKSIGHT_OWNER'|'DIRECT_QUICKSIGHT_OWNER'|'DIRECT_QUICKSIGHT_SOLE_OWNER'|'ANALYSIS_NAME', 'Value': 'string' }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the analyses that you're searching for. * **Filters** (*list*) -- **[REQUIRED]** The structure for the search filters that you want to apply to your search. * *(dict) --* A filter that you apply when searching for one or more analyses. * **Operator** *(string) --* The comparison operator that you want to use as a filter, for example ""Operator": "StringEquals"". Valid values are ""StringEquals"" and ""StringLike"". If you set the operator value to ""StringEquals"", you need to provide an ownership related filter in the ""NAME"" field and the arn of the user or group whose folders you want to search in the ""Value"" field. For example, ""Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us- east-1:1:user/default/UserName1"". If you set the value to ""StringLike"", you need to provide the name of the folders you are searching for. For example, ""Name":"ANALYSIS_NAME", "Operator": "StringLike", "Value": "Test"". The ""StringLike"" operator only supports the "NAME" value "ANALYSIS_NAME". * **Name** *(string) --* The name of the value that you want to use as a filter, for example ""Name": "QUICKSIGHT_OWNER"". Valid values are defined as follows: * "QUICKSIGHT_VIEWER_OR_OWNER": Provide an ARN of a user or group, and any analyses with that ARN listed as one of the analysis' owners or viewers are returned. Implicit permissions from folders or groups are considered. * "QUICKSIGHT_OWNER": Provide an ARN of a user or group, and any analyses with that ARN listed as one of the owners of the analyses are returned. Implicit permissions from folders or groups are considered. * "DIRECT_QUICKSIGHT_SOLE_OWNER": Provide an ARN of a user or group, and any analyses with that ARN listed as the only owner of the analysis are returned. Implicit permissions from folders or groups are not considered. * "DIRECT_QUICKSIGHT_OWNER": Provide an ARN of a user or group, and any analyses with that ARN listed as one of the owners of the analyses are returned. Implicit permissions from folders or groups are not considered. * "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER": Provide an ARN of a user or group, and any analyses with that ARN listed as one of the owners or viewers of the analyses are returned. Implicit permissions from folders or groups are not considered. * "ANALYSIS_NAME": Any analyses whose names have a substring match to this value will be returned. * **Value** *(string) --* The value of the named item, in this case "QUICKSIGHT_USER", that you want to use as a filter, for example ""Value"". An example is ""arn:aws:quicksight:us- east-1:1:user/default/UserName1"". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'AnalysisSummaryList': [ { 'Arn': 'string', 'AnalysisId': 'string', 'Name': 'string', 'Status': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED', 'CreatedTime': datetime(2015, 1, 1), 'LastUpdatedTime': datetime(2015, 1, 1) }, ], 'Status': 123, 'RequestId': 'string' } **Response Structure** * *(dict) --* * **AnalysisSummaryList** *(list) --* Metadata describing the analyses that you searched for. * *(dict) --* The summary metadata that describes an analysis. * **Arn** *(string) --* The Amazon Resource Name (ARN) for the analysis. * **AnalysisId** *(string) --* The ID of the analysis. This ID displays in the URL. * **Name** *(string) --* The name of the analysis. This name is displayed in the Amazon QuickSight console. * **Status** *(string) --* The last known status for the analysis. * **CreatedTime** *(datetime) --* The time that the analysis was created. * **LastUpdatedTime** *(datetime) --* The time that the analysis was last updated. * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. QuickSight / Paginator / ListIAMPolicyAssignments ListIAMPolicyAssignments ************************ class QuickSight.Paginator.ListIAMPolicyAssignments paginator = client.get_paginator('list_iam_policy_assignments') paginate(**kwargs) Creates an iterator that will paginate through responses from "QuickSight.Client.list_iam_policy_assignments()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( AwsAccountId='string', AssignmentStatus='ENABLED'|'DRAFT'|'DISABLED', Namespace='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains these IAM policy assignments. * **AssignmentStatus** (*string*) -- The status of the assignments. * **Namespace** (*string*) -- **[REQUIRED]** The namespace for the assignments. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'IAMPolicyAssignments': [ { 'AssignmentName': 'string', 'AssignmentStatus': 'ENABLED'|'DRAFT'|'DISABLED' }, ], 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **IAMPolicyAssignments** *(list) --* Information describing the IAM policy assignments. * *(dict) --* IAM policy assignment summary. * **AssignmentName** *(string) --* Assignment name. * **AssignmentStatus** *(string) --* Assignment status. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. QuickSight / Paginator / ListDashboardVersions ListDashboardVersions ********************* class QuickSight.Paginator.ListDashboardVersions paginator = client.get_paginator('list_dashboard_versions') paginate(**kwargs) Creates an iterator that will paginate through responses from "QuickSight.Client.list_dashboard_versions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( AwsAccountId='string', DashboardId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the dashboard that you're listing versions for. * **DashboardId** (*string*) -- **[REQUIRED]** The ID for the dashboard. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'DashboardVersionSummaryList': [ { 'Arn': 'string', 'CreatedTime': datetime(2015, 1, 1), 'VersionNumber': 123, 'Status': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED', 'SourceEntityArn': 'string', 'Description': 'string' }, ], 'Status': 123, 'RequestId': 'string' } **Response Structure** * *(dict) --* * **DashboardVersionSummaryList** *(list) --* A structure that contains information about each version of the dashboard. * *(dict) --* Dashboard version summary. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the resource. * **CreatedTime** *(datetime) --* The time that this dashboard version was created. * **VersionNumber** *(integer) --* Version number. * **Status** *(string) --* The HTTP status of the request. * **SourceEntityArn** *(string) --* Source entity ARN. * **Description** *(string) --* Description. * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. QuickSight / Paginator / ListTemplateAliases ListTemplateAliases ******************* class QuickSight.Paginator.ListTemplateAliases paginator = client.get_paginator('list_template_aliases') paginate(**kwargs) Creates an iterator that will paginate through responses from "QuickSight.Client.list_template_aliases()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( AwsAccountId='string', TemplateId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the template aliases that you're listing. * **TemplateId** (*string*) -- **[REQUIRED]** The ID for the template. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'TemplateAliasList': [ { 'AliasName': 'string', 'Arn': 'string', 'TemplateVersionNumber': 123 }, ], 'Status': 123, 'RequestId': 'string', } **Response Structure** * *(dict) --* * **TemplateAliasList** *(list) --* A structure containing the list of the template's aliases. * *(dict) --* The template alias. * **AliasName** *(string) --* The display name of the template alias. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the template alias. * **TemplateVersionNumber** *(integer) --* The version number of the template alias. * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. QuickSight / Paginator / ListFolderMembers ListFolderMembers ***************** class QuickSight.Paginator.ListFolderMembers paginator = client.get_paginator('list_folder_members') paginate(**kwargs) Creates an iterator that will paginate through responses from "QuickSight.Client.list_folder_members()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( AwsAccountId='string', FolderId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID for the Amazon Web Services account that contains the folder. * **FolderId** (*string*) -- **[REQUIRED]** The ID of the folder. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Status': 123, 'FolderMemberList': [ { 'MemberId': 'string', 'MemberArn': 'string' }, ], 'RequestId': 'string' } **Response Structure** * *(dict) --* * **Status** *(integer) --* The HTTP status of the request. * **FolderMemberList** *(list) --* A structure that contains all of the folder members (dashboards, analyses, and datasets) in the folder. * *(dict) --* An object that consists of a member Amazon Resource Name (ARN) and a member ID. * **MemberId** *(string) --* The ID of the member. * **MemberArn** *(string) --* The Amazon Resource Name (ARN) of the member. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. QuickSight / Paginator / SearchDataSets SearchDataSets ************** class QuickSight.Paginator.SearchDataSets paginator = client.get_paginator('search_data_sets') paginate(**kwargs) Creates an iterator that will paginate through responses from "QuickSight.Client.search_data_sets()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( AwsAccountId='string', Filters=[ { 'Operator': 'StringEquals'|'StringLike', 'Name': 'QUICKSIGHT_VIEWER_OR_OWNER'|'QUICKSIGHT_OWNER'|'DIRECT_QUICKSIGHT_VIEWER_OR_OWNER'|'DIRECT_QUICKSIGHT_OWNER'|'DIRECT_QUICKSIGHT_SOLE_OWNER'|'DATASET_NAME', 'Value': 'string' }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The Amazon Web Services account ID. * **Filters** (*list*) -- **[REQUIRED]** The filters to apply to the search. * *(dict) --* A filter that you apply when searching for datasets. * **Operator** *(string) --* **[REQUIRED]** The comparison operator that you want to use as a filter, for example ""Operator": "StringEquals"". Valid values are ""StringEquals"" and ""StringLike"". If you set the operator value to ""StringEquals"", you need to provide an ownership related filter in the ""NAME"" field and the arn of the user or group whose datasets you want to search in the ""Value"" field. For example, ""Name":"QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east- 1:1:user/default/UserName1"". If you set the value to ""StringLike"", you need to provide the name of the datasets you are searching for. For example, ""Name":"DATASET_NAME", "Operator": "StringLike", "Value": "Test"". The ""StringLike"" operator only supports the "NAME" value "DATASET_NAME". * **Name** *(string) --* **[REQUIRED]** The name of the value that you want to use as a filter, for example, ""Name": "QUICKSIGHT_OWNER"". Valid values are defined as follows: * "QUICKSIGHT_VIEWER_OR_OWNER": Provide an ARN of a user or group, and any datasets with that ARN listed as one of the dataset owners or viewers are returned. Implicit permissions from folders or groups are considered. * "QUICKSIGHT_OWNER": Provide an ARN of a user or group, and any datasets with that ARN listed as one of the owners of the dataset are returned. Implicit permissions from folders or groups are considered. * "DIRECT_QUICKSIGHT_SOLE_OWNER": Provide an ARN of a user or group, and any datasets with that ARN listed as the only owner of the dataset are returned. Implicit permissions from folders or groups are not considered. * "DIRECT_QUICKSIGHT_OWNER": Provide an ARN of a user or group, and any datasets with that ARN listed as one of the owners if the dataset are returned. Implicit permissions from folders or groups are not considered. * "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER": Provide an ARN of a user or group, and any datasets with that ARN listed as one of the owners or viewers of the dataset are returned. Implicit permissions from folders or groups are not considered. * "DATASET_NAME": Any datasets whose names have a substring match to this value will be returned. * **Value** *(string) --* **[REQUIRED]** The value of the named item, in this case "QUICKSIGHT_OWNER", that you want to use as a filter, for example, ""Value": "arn:aws:quicksight:us- east-1:1:user/default/UserName1"". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'DataSetSummaries': [ { 'Arn': 'string', 'DataSetId': 'string', 'Name': 'string', 'CreatedTime': datetime(2015, 1, 1), 'LastUpdatedTime': datetime(2015, 1, 1), 'ImportMode': 'SPICE'|'DIRECT_QUERY', 'RowLevelPermissionDataSet': { 'Namespace': 'string', 'Arn': 'string', 'PermissionPolicy': 'GRANT_ACCESS'|'DENY_ACCESS', 'FormatVersion': 'VERSION_1'|'VERSION_2', 'Status': 'ENABLED'|'DISABLED' }, 'RowLevelPermissionTagConfigurationApplied': True|False, 'ColumnLevelPermissionRulesApplied': True|False, 'UseAs': 'RLS_RULES' }, ], 'Status': 123, 'RequestId': 'string' } **Response Structure** * *(dict) --* * **DataSetSummaries** *(list) --* A "DataSetSummaries" object that returns a summary of a dataset. * *(dict) --* Dataset summary. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the dataset. * **DataSetId** *(string) --* The ID of the dataset. * **Name** *(string) --* A display name for the dataset. * **CreatedTime** *(datetime) --* The time that this dataset was created. * **LastUpdatedTime** *(datetime) --* The last time that this dataset was updated. * **ImportMode** *(string) --* A value that indicates whether you want to import the data into SPICE. * **RowLevelPermissionDataSet** *(dict) --* The row-level security configuration for the dataset. * **Namespace** *(string) --* The namespace associated with the dataset that contains permissions for RLS. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS. * **PermissionPolicy** *(string) --* The type of permissions to use when interpreting the permissions for RLS. "DENY_ACCESS" is included for backward compatibility only. * **FormatVersion** *(string) --* The user or group rules associated with the dataset that contains permissions for RLS. By default, "FormatVersion" is "VERSION_1". When "FormatVersion" is "VERSION_1", "UserName" and "GroupName" are required. When "FormatVersion" is "VERSION_2", "UserARN" and "GroupARN" are required, and "Namespace" must not exist. * **Status** *(string) --* The status of the row-level security permission dataset. If enabled, the status is "ENABLED". If disabled, the status is "DISABLED". * **RowLevelPermissionTagConfigurationApplied** *(boolean) --* Whether or not the row level permission tags are applied. * **ColumnLevelPermissionRulesApplied** *(boolean) --* A value that indicates if the dataset has column level permission configured. * **UseAs** *(string) --* The usage of the dataset. * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. QuickSight / Paginator / SearchGroups SearchGroups ************ class QuickSight.Paginator.SearchGroups paginator = client.get_paginator('search_groups') paginate(**kwargs) Creates an iterator that will paginate through responses from "QuickSight.Client.search_groups()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( AwsAccountId='string', Namespace='string', Filters=[ { 'Operator': 'StartsWith', 'Name': 'GROUP_NAME', 'Value': 'string' }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** 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** (*string*) -- **[REQUIRED]** The namespace that you want to search. * **Filters** (*list*) -- **[REQUIRED]** The structure for the search filters that you want to apply to your search. * *(dict) --* A "GroupSearchFilter" object that you want to apply to your search. * **Operator** *(string) --* **[REQUIRED]** The comparison operator that you want to use as a filter, for example ""Operator": "StartsWith"". Currently, the only supported operator is "StartsWith". * **Name** *(string) --* **[REQUIRED]** The name of the value that you want to use as a filter, for example ""Name": "GROUP_NAME"". Currently, the only supported name is "GROUP_NAME". * **Value** *(string) --* **[REQUIRED]** The value of the named item, in this case "GROUP_NAME", that you want to use as a filter. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'GroupList': [ { 'Arn': 'string', 'GroupName': 'string', 'Description': 'string', 'PrincipalId': 'string' }, ], 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **GroupList** *(list) --* A list of groups in a specified namespace that match the filters you set in your "SearchGroups" request. * *(dict) --* A *group* in Amazon QuickSight consists of a set of users. You can use groups to make it easier to manage access and security. * **Arn** *(string) --* The Amazon Resource Name (ARN) for the group. * **GroupName** *(string) --* The name of the group. * **Description** *(string) --* The group description. * **PrincipalId** *(string) --* The principal ID of the group. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. QuickSight / Paginator / ListRoleMemberships ListRoleMemberships ******************* class QuickSight.Paginator.ListRoleMemberships paginator = client.get_paginator('list_role_memberships') paginate(**kwargs) Creates an iterator that will paginate through responses from "QuickSight.Client.list_role_memberships()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( Role='ADMIN'|'AUTHOR'|'READER'|'ADMIN_PRO'|'AUTHOR_PRO'|'READER_PRO', AwsAccountId='string', Namespace='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **Role** (*string*) -- **[REQUIRED]** The name of the role. * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account. * **Namespace** (*string*) -- **[REQUIRED]** The namespace that includes the role. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'MembersList': [ 'string', ], 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **MembersList** *(list) --* The list of groups associated with a role * *(string) --* * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. QuickSight / Paginator / ListTemplateVersions ListTemplateVersions ******************** class QuickSight.Paginator.ListTemplateVersions paginator = client.get_paginator('list_template_versions') paginate(**kwargs) Creates an iterator that will paginate through responses from "QuickSight.Client.list_template_versions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( AwsAccountId='string', TemplateId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the templates that you're listing. * **TemplateId** (*string*) -- **[REQUIRED]** The ID for the template. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'TemplateVersionSummaryList': [ { 'Arn': 'string', 'VersionNumber': 123, 'CreatedTime': datetime(2015, 1, 1), 'Status': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED', 'Description': 'string' }, ], 'Status': 123, 'RequestId': 'string' } **Response Structure** * *(dict) --* * **TemplateVersionSummaryList** *(list) --* A structure containing a list of all the versions of the specified template. * *(dict) --* The template version. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the template version. * **VersionNumber** *(integer) --* The version number of the template version. * **CreatedTime** *(datetime) --* The time that this template version was created. * **Status** *(string) --* The status of the template version. * **Description** *(string) --* The description of the template version. * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. QuickSight / Paginator / ListGroups ListGroups ********** class QuickSight.Paginator.ListGroups paginator = client.get_paginator('list_groups') paginate(**kwargs) Creates an iterator that will paginate through responses from "QuickSight.Client.list_groups()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( AwsAccountId='string', Namespace='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** 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** (*string*) -- **[REQUIRED]** The namespace that you want a list of groups from. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'GroupList': [ { 'Arn': 'string', 'GroupName': 'string', 'Description': 'string', 'PrincipalId': 'string' }, ], 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **GroupList** *(list) --* The list of the groups. * *(dict) --* A *group* in Amazon QuickSight consists of a set of users. You can use groups to make it easier to manage access and security. * **Arn** *(string) --* The Amazon Resource Name (ARN) for the group. * **GroupName** *(string) --* The name of the group. * **Description** *(string) --* The group description. * **PrincipalId** *(string) --* The principal ID of the group. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. QuickSight / Paginator / ListDataSets ListDataSets ************ class QuickSight.Paginator.ListDataSets paginator = client.get_paginator('list_data_sets') paginate(**kwargs) Creates an iterator that will paginate through responses from "QuickSight.Client.list_data_sets()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( AwsAccountId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The Amazon Web Services account ID. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'DataSetSummaries': [ { 'Arn': 'string', 'DataSetId': 'string', 'Name': 'string', 'CreatedTime': datetime(2015, 1, 1), 'LastUpdatedTime': datetime(2015, 1, 1), 'ImportMode': 'SPICE'|'DIRECT_QUERY', 'RowLevelPermissionDataSet': { 'Namespace': 'string', 'Arn': 'string', 'PermissionPolicy': 'GRANT_ACCESS'|'DENY_ACCESS', 'FormatVersion': 'VERSION_1'|'VERSION_2', 'Status': 'ENABLED'|'DISABLED' }, 'RowLevelPermissionTagConfigurationApplied': True|False, 'ColumnLevelPermissionRulesApplied': True|False, 'UseAs': 'RLS_RULES' }, ], 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **DataSetSummaries** *(list) --* The list of dataset summaries. * *(dict) --* Dataset summary. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the dataset. * **DataSetId** *(string) --* The ID of the dataset. * **Name** *(string) --* A display name for the dataset. * **CreatedTime** *(datetime) --* The time that this dataset was created. * **LastUpdatedTime** *(datetime) --* The last time that this dataset was updated. * **ImportMode** *(string) --* A value that indicates whether you want to import the data into SPICE. * **RowLevelPermissionDataSet** *(dict) --* The row-level security configuration for the dataset. * **Namespace** *(string) --* The namespace associated with the dataset that contains permissions for RLS. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS. * **PermissionPolicy** *(string) --* The type of permissions to use when interpreting the permissions for RLS. "DENY_ACCESS" is included for backward compatibility only. * **FormatVersion** *(string) --* The user or group rules associated with the dataset that contains permissions for RLS. By default, "FormatVersion" is "VERSION_1". When "FormatVersion" is "VERSION_1", "UserName" and "GroupName" are required. When "FormatVersion" is "VERSION_2", "UserARN" and "GroupARN" are required, and "Namespace" must not exist. * **Status** *(string) --* The status of the row-level security permission dataset. If enabled, the status is "ENABLED". If disabled, the status is "DISABLED". * **RowLevelPermissionTagConfigurationApplied** *(boolean) --* Whether or not the row level permission tags are applied. * **ColumnLevelPermissionRulesApplied** *(boolean) --* A value that indicates if the dataset has column level permission configured. * **UseAs** *(string) --* The usage of the dataset. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. QuickSight / Paginator / SearchDashboards SearchDashboards **************** class QuickSight.Paginator.SearchDashboards paginator = client.get_paginator('search_dashboards') paginate(**kwargs) Creates an iterator that will paginate through responses from "QuickSight.Client.search_dashboards()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( AwsAccountId='string', Filters=[ { 'Operator': 'StringEquals'|'StringLike', 'Name': 'QUICKSIGHT_USER'|'QUICKSIGHT_VIEWER_OR_OWNER'|'DIRECT_QUICKSIGHT_VIEWER_OR_OWNER'|'QUICKSIGHT_OWNER'|'DIRECT_QUICKSIGHT_OWNER'|'DIRECT_QUICKSIGHT_SOLE_OWNER'|'DASHBOARD_NAME', 'Value': 'string' }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the user whose dashboards you're searching for. * **Filters** (*list*) -- **[REQUIRED]** 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" } ]" * *(dict) --* A filter that you apply when searching for dashboards. * **Operator** *(string) --* **[REQUIRED]** The comparison operator that you want to use as a filter, for example ""Operator": "StringEquals"". Valid values are ""StringEquals"" and ""StringLike"". If you set the operator value to ""StringEquals"", you need to provide an ownership related filter in the ""NAME"" field and the arn of the user or group whose folders you want to search in the ""Value"" field. For example, ""Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us- east-1:1:user/default/UserName1"". If you set the value to ""StringLike"", you need to provide the name of the folders you are searching for. For example, ""Name":"DASHBOARD_NAME", "Operator": "StringLike", "Value": "Test"". The ""StringLike"" operator only supports the "NAME" value "DASHBOARD_NAME". * **Name** *(string) --* The name of the value that you want to use as a filter, for example, ""Name": "QUICKSIGHT_OWNER"". Valid values are defined as follows: * "QUICKSIGHT_VIEWER_OR_OWNER": Provide an ARN of a user or group, and any dashboards with that ARN listed as one of the dashboards's owners or viewers are returned. Implicit permissions from folders or groups are considered. * "QUICKSIGHT_OWNER": Provide an ARN of a user or group, and any dashboards with that ARN listed as one of the owners of the dashboards are returned. Implicit permissions from folders or groups are considered. * "DIRECT_QUICKSIGHT_SOLE_OWNER": Provide an ARN of a user or group, and any dashboards with that ARN listed as the only owner of the dashboard are returned. Implicit permissions from folders or groups are not considered. * "DIRECT_QUICKSIGHT_OWNER": Provide an ARN of a user or group, and any dashboards with that ARN listed as one of the owners of the dashboards are returned. Implicit permissions from folders or groups are not considered. * "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER": Provide an ARN of a user or group, and any dashboards with that ARN listed as one of the owners or viewers of the dashboards are returned. Implicit permissions from folders or groups are not considered. * "DASHBOARD_NAME": Any dashboards whose names have a substring match to this value will be returned. * **Value** *(string) --* The value of the named item, in this case "QUICKSIGHT_USER", that you want to use as a filter, for example, ""Value": "arn:aws:quicksight:us- east-1:1:user/default/UserName1"". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'DashboardSummaryList': [ { 'Arn': 'string', 'DashboardId': 'string', 'Name': 'string', 'CreatedTime': datetime(2015, 1, 1), 'LastUpdatedTime': datetime(2015, 1, 1), 'PublishedVersionNumber': 123, 'LastPublishedTime': datetime(2015, 1, 1) }, ], 'Status': 123, 'RequestId': 'string' } **Response Structure** * *(dict) --* * **DashboardSummaryList** *(list) --* The list of dashboards owned by the user specified in "Filters" in your request. * *(dict) --* Dashboard summary. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the resource. * **DashboardId** *(string) --* Dashboard ID. * **Name** *(string) --* A display name for the dashboard. * **CreatedTime** *(datetime) --* The time that this dashboard was created. * **LastUpdatedTime** *(datetime) --* The last time that this dashboard was updated. * **PublishedVersionNumber** *(integer) --* Published version number. * **LastPublishedTime** *(datetime) --* The last time that this dashboard was published. * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. QuickSight / Paginator / ListAnalyses ListAnalyses ************ class QuickSight.Paginator.ListAnalyses paginator = client.get_paginator('list_analyses') paginate(**kwargs) Creates an iterator that will paginate through responses from "QuickSight.Client.list_analyses()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( AwsAccountId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the analyses. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'AnalysisSummaryList': [ { 'Arn': 'string', 'AnalysisId': 'string', 'Name': 'string', 'Status': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED', 'CreatedTime': datetime(2015, 1, 1), 'LastUpdatedTime': datetime(2015, 1, 1) }, ], 'Status': 123, 'RequestId': 'string' } **Response Structure** * *(dict) --* * **AnalysisSummaryList** *(list) --* Metadata describing each of the analyses that are listed. * *(dict) --* The summary metadata that describes an analysis. * **Arn** *(string) --* The Amazon Resource Name (ARN) for the analysis. * **AnalysisId** *(string) --* The ID of the analysis. This ID displays in the URL. * **Name** *(string) --* The name of the analysis. This name is displayed in the Amazon QuickSight console. * **Status** *(string) --* The last known status for the analysis. * **CreatedTime** *(datetime) --* The time that the analysis was created. * **LastUpdatedTime** *(datetime) --* The time that the analysis was last updated. * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. QuickSight / Paginator / SearchFolders SearchFolders ************* class QuickSight.Paginator.SearchFolders paginator = client.get_paginator('search_folders') paginate(**kwargs) Creates an iterator that will paginate through responses from "QuickSight.Client.search_folders()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( AwsAccountId='string', Filters=[ { 'Operator': 'StringEquals'|'StringLike', 'Name': 'PARENT_FOLDER_ARN'|'DIRECT_QUICKSIGHT_OWNER'|'DIRECT_QUICKSIGHT_SOLE_OWNER'|'DIRECT_QUICKSIGHT_VIEWER_OR_OWNER'|'QUICKSIGHT_OWNER'|'QUICKSIGHT_VIEWER_OR_OWNER'|'FOLDER_NAME', 'Value': 'string' }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID for the Amazon Web Services account that contains the folder. * **Filters** (*list*) -- **[REQUIRED]** 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" } ]". * *(dict) --* A filter to use to search an Amazon QuickSight folder. * **Operator** *(string) --* The comparison operator that you want to use as a filter, for example ""Operator": "StringEquals"". Valid values are ""StringEquals"" and ""StringLike"". If you set the operator value to ""StringEquals"", you need to provide an ownership related filter in the ""NAME"" field and the arn of the user or group whose folders you want to search in the ""Value"" field. For example, ""Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us- east-1:1:user/default/UserName1"". If you set the value to ""StringLike"", you need to provide the name of the folders you are searching for. For example, ""Name":"FOLDER_NAME", "Operator": "StringLike", "Value": "Test"". The ""StringLike"" operator only supports the "NAME" value "FOLDER_NAME". * **Name** *(string) --* The name of a value that you want to use in the filter. For example, ""Name": "QUICKSIGHT_OWNER"". Valid values are defined as follows: * "QUICKSIGHT_VIEWER_OR_OWNER": Provide an ARN of a user or group, and any folders with that ARN listed as one of the folder's owners or viewers are returned. Implicit permissions from folders or groups are considered. * "QUICKSIGHT_OWNER": Provide an ARN of a user or group, and any folders with that ARN listed as one of the owners of the folders are returned. Implicit permissions from folders or groups are considered. * "DIRECT_QUICKSIGHT_SOLE_OWNER": Provide an ARN of a user or group, and any folders with that ARN listed as the only owner of the folder are returned. Implicit permissions from folders or groups are not considered. * "DIRECT_QUICKSIGHT_OWNER": Provide an ARN of a user or group, and any folders with that ARN listed as one of the owners of the folders are returned. Implicit permissions from folders or groups are not considered. * "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER": Provide an ARN of a user or group, and any folders with that ARN listed as one of the owners or viewers of the folders are returned. Implicit permissions from folders or groups are not considered. * "FOLDER_NAME": Any folders whose names have a substring match to this value will be returned. * "PARENT_FOLDER_ARN": Provide an ARN of a folder, and any folders that are directly under that parent folder are returned. If you choose to use this option and leave the value blank, all root-level folders in the account are returned. * **Value** *(string) --* The value of the named item (in this example, "PARENT_FOLDER_ARN"), that you want to use as a filter. For example, ""Value": "arn:aws:quicksight:us- east-1:1:folder/folderId"". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Status': 123, 'FolderSummaryList': [ { 'Arn': 'string', 'FolderId': 'string', 'Name': 'string', 'FolderType': 'SHARED'|'RESTRICTED', 'CreatedTime': datetime(2015, 1, 1), 'LastUpdatedTime': datetime(2015, 1, 1), 'SharingModel': 'ACCOUNT'|'NAMESPACE' }, ], 'RequestId': 'string' } **Response Structure** * *(dict) --* * **Status** *(integer) --* The HTTP status of the request. * **FolderSummaryList** *(list) --* A structure that contains all of the folders in the Amazon Web Services account. This structure provides basic information about the folders. * *(dict) --* A summary of information about an existing Amazon QuickSight folder. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the folder. * **FolderId** *(string) --* The ID of the folder. * **Name** *(string) --* The display name of the folder. * **FolderType** *(string) --* The type of folder. * **CreatedTime** *(datetime) --* The time that the folder was created. * **LastUpdatedTime** *(datetime) --* The time that the folder was last updated. * **SharingModel** *(string) --* The sharing scope of the folder. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. QuickSight / Client / list_folder_members list_folder_members ******************* QuickSight.Client.list_folder_members(**kwargs) List all assets ( "DASHBOARD", "ANALYSIS", and "DATASET") in a folder. See also: AWS API Documentation **Request Syntax** response = client.list_folder_members( AwsAccountId='string', FolderId='string', NextToken='string', MaxResults=123 ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID for the Amazon Web Services account that contains the folder. * **FolderId** (*string*) -- **[REQUIRED]** The ID of the folder. * **NextToken** (*string*) -- The token for the next set of results, or null if there are no more results. * **MaxResults** (*integer*) -- The maximum number of results to be returned per request. Return type: dict Returns: **Response Syntax** { 'Status': 123, 'FolderMemberList': [ { 'MemberId': 'string', 'MemberArn': 'string' }, ], 'NextToken': 'string', 'RequestId': 'string' } **Response Structure** * *(dict) --* * **Status** *(integer) --* The HTTP status of the request. * **FolderMemberList** *(list) --* A structure that contains all of the folder members (dashboards, analyses, and datasets) in the folder. * *(dict) --* An object that consists of a member Amazon Resource Name (ARN) and a member ID. * **MemberId** *(string) --* The ID of the member. * **MemberArn** *(string) --* The Amazon Resource Name (ARN) of the member. * **NextToken** *(string) --* The token for the next set of results, or null if there are no more results. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InvalidNextTokenException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / update_account_customization update_account_customization **************************** QuickSight.Client.update_account_customization(**kwargs) Updates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, the only customization that you can use is a theme. You can use customizations for your Amazon Web Services account or, if you specify a namespace, for a Amazon QuickSight namespace instead. Customizations that apply to a namespace override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the "DescribeAccountCustomization" API operation. See also: AWS API Documentation **Request Syntax** response = client.update_account_customization( AwsAccountId='string', Namespace='string', AccountCustomization={ 'DefaultTheme': 'string', 'DefaultEmailCustomizationTemplate': 'string' } ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID for the Amazon Web Services account that you want to update Amazon QuickSight customizations for. * **Namespace** (*string*) -- The namespace that you want to update Amazon QuickSight customizations for. * **AccountCustomization** (*dict*) -- **[REQUIRED]** The Amazon QuickSight customizations you're updating in the current Amazon Web Services Region. * **DefaultTheme** *(string) --* The default theme for this Amazon QuickSight subscription. * **DefaultEmailCustomizationTemplate** *(string) --* The default email customization template. Return type: dict Returns: **Response Syntax** { 'Arn': 'string', 'AwsAccountId': 'string', 'Namespace': 'string', 'AccountCustomization': { 'DefaultTheme': 'string', 'DefaultEmailCustomizationTemplate': 'string' }, 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **Arn** *(string) --* The Amazon Resource Name (ARN) for the updated customization for this Amazon Web Services account. * **AwsAccountId** *(string) --* The ID for the Amazon Web Services account that you want to update Amazon QuickSight customizations for. * **Namespace** *(string) --* The namespace associated with the customization that you're updating. * **AccountCustomization** *(dict) --* The Amazon QuickSight customizations you're updating in the current Amazon Web Services Region. * **DefaultTheme** *(string) --* The default theme for this Amazon QuickSight subscription. * **DefaultEmailCustomizationTemplate** *(string) --* The default email customization template. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InternalFailureException" * "QuickSight.Client.exceptions.ResourceUnavailableException" QuickSight / Client / update_topic_refresh_schedule update_topic_refresh_schedule ***************************** QuickSight.Client.update_topic_refresh_schedule(**kwargs) Updates a topic refresh schedule. See also: AWS API Documentation **Request Syntax** response = client.update_topic_refresh_schedule( AwsAccountId='string', TopicId='string', DatasetId='string', RefreshSchedule={ 'IsEnabled': True|False, 'BasedOnSpiceSchedule': True|False, 'StartingAt': datetime(2015, 1, 1), 'Timezone': 'string', 'RepeatAt': 'string', 'TopicScheduleType': 'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY' } ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the topic whose refresh schedule you want to update. * **TopicId** (*string*) -- **[REQUIRED]** The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. * **DatasetId** (*string*) -- **[REQUIRED]** The ID of the dataset. * **RefreshSchedule** (*dict*) -- **[REQUIRED]** The definition of a refresh schedule. * **IsEnabled** *(boolean) --* **[REQUIRED]** A Boolean value that controls whether to schedule is enabled. * **BasedOnSpiceSchedule** *(boolean) --* **[REQUIRED]** A Boolean value that controls whether to schedule runs at the same schedule that is specified in SPICE dataset. * **StartingAt** *(datetime) --* The starting date and time for the refresh schedule. * **Timezone** *(string) --* The timezone that you want the refresh schedule to use. * **RepeatAt** *(string) --* The time of day when the refresh should run, for example, Monday-Sunday. * **TopicScheduleType** *(string) --* The type of refresh schedule. Valid values for this structure are "HOURLY", "DAILY", "WEEKLY", and "MONTHLY". Return type: dict Returns: **Response Syntax** { 'TopicId': 'string', 'TopicArn': 'string', 'DatasetArn': 'string', 'Status': 123, 'RequestId': 'string' } **Response Structure** * *(dict) --* * **TopicId** *(string) --* The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. * **TopicArn** *(string) --* The Amazon Resource Name (ARN) of the topic. * **DatasetArn** *(string) --* The Amazon Resource Name (ARN) of the dataset. * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.LimitExceededException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ResourceExistsException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / create_custom_permissions create_custom_permissions ************************* QuickSight.Client.create_custom_permissions(**kwargs) Creates a custom permissions profile. See also: AWS API Documentation **Request Syntax** response = client.create_custom_permissions( AwsAccountId='string', CustomPermissionsName='string', Capabilities={ 'ExportToCsv': 'DENY', 'ExportToExcel': 'DENY', 'ExportToPdf': 'DENY', 'PrintReports': 'DENY', 'CreateAndUpdateThemes': 'DENY', 'AddOrRunAnomalyDetectionForAnalyses': 'DENY', 'ShareAnalyses': 'DENY', 'CreateAndUpdateDatasets': 'DENY', 'ShareDatasets': 'DENY', 'SubscribeDashboardEmailReports': 'DENY', 'CreateAndUpdateDashboardEmailReports': 'DENY', 'ShareDashboards': 'DENY', 'CreateAndUpdateThresholdAlerts': 'DENY', 'RenameSharedFolders': 'DENY', 'CreateSharedFolders': 'DENY', 'CreateAndUpdateDataSources': 'DENY', 'ShareDataSources': 'DENY', 'ViewAccountSPICECapacity': 'DENY', 'CreateSPICEDataset': 'DENY', 'ExportToPdfInScheduledReports': 'DENY', 'ExportToCsvInScheduledReports': 'DENY', 'ExportToExcelInScheduledReports': 'DENY', 'IncludeContentInScheduledReportsEmail': 'DENY' }, Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that you want to create the custom permissions profile in. * **CustomPermissionsName** (*string*) -- **[REQUIRED]** The name of the custom permissions profile that you want to create. * **Capabilities** (*dict*) -- A set of actions to include in the custom permissions profile. * **ExportToCsv** *(string) --* The ability to export to CSV files from the UI. * **ExportToExcel** *(string) --* The ability to export to Excel files from the UI. * **ExportToPdf** *(string) --* The ability to export to PDF files from the UI. * **PrintReports** *(string) --* The ability to print reports. * **CreateAndUpdateThemes** *(string) --* The ability to export to Create and Update themes. * **AddOrRunAnomalyDetectionForAnalyses** *(string) --* The ability to add or run anomaly detection. * **ShareAnalyses** *(string) --* The ability to share analyses. * **CreateAndUpdateDatasets** *(string) --* The ability to create and update datasets. * **ShareDatasets** *(string) --* The ability to share datasets. * **SubscribeDashboardEmailReports** *(string) --* The ability to subscribe to email reports. * **CreateAndUpdateDashboardEmailReports** *(string) --* The ability to create and update email reports. * **ShareDashboards** *(string) --* The ability to share dashboards. * **CreateAndUpdateThresholdAlerts** *(string) --* The ability to create and update threshold alerts. * **RenameSharedFolders** *(string) --* The ability to rename shared folders. * **CreateSharedFolders** *(string) --* The ability to create shared folders. * **CreateAndUpdateDataSources** *(string) --* The ability to create and update data sources. * **ShareDataSources** *(string) --* The ability to share data sources. * **ViewAccountSPICECapacity** *(string) --* The ability to view account SPICE capacity. * **CreateSPICEDataset** *(string) --* The ability to create a SPICE dataset. * **ExportToPdfInScheduledReports** *(string) --* The ability to export to PDF files in scheduled email reports. * **ExportToCsvInScheduledReports** *(string) --* The ability to export to CSV files in scheduled email reports. * **ExportToExcelInScheduledReports** *(string) --* The ability to export to Excel files in scheduled email reports. * **IncludeContentInScheduledReportsEmail** *(string) --* The ability to include content in scheduled email reports. * **Tags** (*list*) -- The tags to associate with the custom permissions profile. * *(dict) --* The key or keys of the key-value pairs for the resource tag or tags assigned to the resource. * **Key** *(string) --* **[REQUIRED]** Tag key. * **Value** *(string) --* **[REQUIRED]** Tag value. Return type: dict Returns: **Response Syntax** { 'Status': 123, 'Arn': 'string', 'RequestId': 'string' } **Response Structure** * *(dict) --* * **Status** *(integer) --* The HTTP status of the request. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the custom permissions profile. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ResourceExistsException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.PreconditionNotMetException" * "QuickSight.Client.exceptions.LimitExceededException" * "QuickSight.Client.exceptions.InternalFailureException" * "QuickSight.Client.exceptions.ResourceUnavailableException" QuickSight / Client / get_paginator get_paginator ************* QuickSight.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. QuickSight / Client / describe_analysis_definition describe_analysis_definition **************************** QuickSight.Client.describe_analysis_definition(**kwargs) Provides a detailed description of the definition of an analysis. Note: If you do not need to know details about the content of an Analysis, for instance if you are trying to check the status of a recently created or updated Analysis, use the DescribeAnalysis instead. See also: AWS API Documentation **Request Syntax** response = client.describe_analysis_definition( AwsAccountId='string', AnalysisId='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** 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. * **AnalysisId** (*string*) -- **[REQUIRED]** The ID of the analysis that you're describing. The ID is part of the URL of the analysis. Return type: dict Returns: **Response Syntax** # This section is too large to render. # Please see the AWS API Documentation linked below. AWS API Documentation **Response Structure** # This section is too large to render. # Please see the AWS API Documentation linked below. AWS API Documentation **Exceptions** * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.ResourceExistsException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / delete_template delete_template *************** QuickSight.Client.delete_template(**kwargs) Deletes a template. See also: AWS API Documentation **Request Syntax** response = client.delete_template( AwsAccountId='string', TemplateId='string', VersionNumber=123 ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the template that you're deleting. * **TemplateId** (*string*) -- **[REQUIRED]** An ID for the template you want to delete. * **VersionNumber** (*integer*) -- 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. Return type: dict Returns: **Response Syntax** { 'RequestId': 'string', 'Arn': 'string', 'TemplateId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the resource. * **TemplateId** *(string) --* An ID for the template. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.LimitExceededException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / update_brand update_brand ************ QuickSight.Client.update_brand(**kwargs) Updates a brand. See also: AWS API Documentation **Request Syntax** response = client.update_brand( AwsAccountId='string', BrandId='string', BrandDefinition={ 'BrandName': 'string', 'Description': 'string', 'ApplicationTheme': { 'BrandColorPalette': { 'Primary': { 'Foreground': 'string', 'Background': 'string' }, 'Secondary': { 'Foreground': 'string', 'Background': 'string' }, 'Accent': { 'Foreground': 'string', 'Background': 'string' }, 'Measure': { 'Foreground': 'string', 'Background': 'string' }, 'Dimension': { 'Foreground': 'string', 'Background': 'string' }, 'Success': { 'Foreground': 'string', 'Background': 'string' }, 'Info': { 'Foreground': 'string', 'Background': 'string' }, 'Warning': { 'Foreground': 'string', 'Background': 'string' }, 'Danger': { 'Foreground': 'string', 'Background': 'string' } }, 'BrandElementStyle': { 'NavbarStyle': { 'GlobalNavbar': { 'Foreground': 'string', 'Background': 'string' }, 'ContextualNavbar': { 'Foreground': 'string', 'Background': 'string' } } } }, 'LogoConfiguration': { 'AltText': 'string', 'LogoSet': { 'Primary': { 'Original': { 'Source': { 'PublicUrl': 'string', 'S3Uri': 'string' } } }, 'Favicon': { 'Original': { 'Source': { 'PublicUrl': 'string', 'S3Uri': 'string' } } } } } } ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that owns the brand. * **BrandId** (*string*) -- **[REQUIRED]** The ID of the Amazon QuickSight brand. * **BrandDefinition** (*dict*) -- The definition of the brand. * **BrandName** *(string) --* **[REQUIRED]** The name of the brand. * **Description** *(string) --* The description of the brand. * **ApplicationTheme** *(dict) --* The application theme of the brand. * **BrandColorPalette** *(dict) --* The color palette. * **Primary** *(dict) --* The primary color. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **Secondary** *(dict) --* The secondary color. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **Accent** *(dict) --* The color that is used for accent elements. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **Measure** *(dict) --* The color that is used for measure elements. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **Dimension** *(dict) --* The color that is used for dimension elements. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **Success** *(dict) --* The color that is used for success elements. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **Info** *(dict) --* The color that is used for info elements. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **Warning** *(dict) --* The color that is used for warning elements. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **Danger** *(dict) --* The color that is used for danger elements. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **BrandElementStyle** *(dict) --* The element style. * **NavbarStyle** *(dict) --* The navigation bar style. * **GlobalNavbar** *(dict) --* The global navigation bar style. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **ContextualNavbar** *(dict) --* The contextual navigation bar style. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **LogoConfiguration** *(dict) --* The logo configuration of the brand. * **AltText** *(string) --* **[REQUIRED]** The alt text for the logo. * **LogoSet** *(dict) --* **[REQUIRED]** A set of configured logos. * **Primary** *(dict) --* **[REQUIRED]** The primary logo. * **Original** *(dict) --* **[REQUIRED]** The original image. * **Source** *(dict) --* The source of the image. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "PublicUrl", "S3Uri". * **PublicUrl** *(string) --* The public URL that points to the source image. * **S3Uri** *(string) --* The Amazon S3 URI that points to the source image. * **Favicon** *(dict) --* The favicon logo. * **Original** *(dict) --* **[REQUIRED]** The original image. * **Source** *(dict) --* The source of the image. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "PublicUrl", "S3Uri". * **PublicUrl** *(string) --* The public URL that points to the source image. * **S3Uri** *(string) --* The Amazon S3 URI that points to the source image. Return type: dict Returns: **Response Syntax** { 'RequestId': 'string', 'BrandDetail': { 'BrandId': 'string', 'Arn': 'string', 'BrandStatus': 'CREATE_IN_PROGRESS'|'CREATE_SUCCEEDED'|'CREATE_FAILED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED', 'CreatedTime': datetime(2015, 1, 1), 'LastUpdatedTime': datetime(2015, 1, 1), 'VersionId': 'string', 'VersionStatus': 'CREATE_IN_PROGRESS'|'CREATE_SUCCEEDED'|'CREATE_FAILED', 'Errors': [ 'string', ], 'Logo': { 'AltText': 'string', 'LogoSet': { 'Primary': { 'Original': { 'Source': { 'PublicUrl': 'string', 'S3Uri': 'string' }, 'GeneratedImageUrl': 'string' }, 'Height64': { 'Source': { 'PublicUrl': 'string', 'S3Uri': 'string' }, 'GeneratedImageUrl': 'string' }, 'Height32': { 'Source': { 'PublicUrl': 'string', 'S3Uri': 'string' }, 'GeneratedImageUrl': 'string' } }, 'Favicon': { 'Original': { 'Source': { 'PublicUrl': 'string', 'S3Uri': 'string' }, 'GeneratedImageUrl': 'string' }, 'Height64': { 'Source': { 'PublicUrl': 'string', 'S3Uri': 'string' }, 'GeneratedImageUrl': 'string' }, 'Height32': { 'Source': { 'PublicUrl': 'string', 'S3Uri': 'string' }, 'GeneratedImageUrl': 'string' } } } } }, 'BrandDefinition': { 'BrandName': 'string', 'Description': 'string', 'ApplicationTheme': { 'BrandColorPalette': { 'Primary': { 'Foreground': 'string', 'Background': 'string' }, 'Secondary': { 'Foreground': 'string', 'Background': 'string' }, 'Accent': { 'Foreground': 'string', 'Background': 'string' }, 'Measure': { 'Foreground': 'string', 'Background': 'string' }, 'Dimension': { 'Foreground': 'string', 'Background': 'string' }, 'Success': { 'Foreground': 'string', 'Background': 'string' }, 'Info': { 'Foreground': 'string', 'Background': 'string' }, 'Warning': { 'Foreground': 'string', 'Background': 'string' }, 'Danger': { 'Foreground': 'string', 'Background': 'string' } }, 'BrandElementStyle': { 'NavbarStyle': { 'GlobalNavbar': { 'Foreground': 'string', 'Background': 'string' }, 'ContextualNavbar': { 'Foreground': 'string', 'Background': 'string' } } } }, 'LogoConfiguration': { 'AltText': 'string', 'LogoSet': { 'Primary': { 'Original': { 'Source': { 'PublicUrl': 'string', 'S3Uri': 'string' } } }, 'Favicon': { 'Original': { 'Source': { 'PublicUrl': 'string', 'S3Uri': 'string' } } } } } } } **Response Structure** * *(dict) --* * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **BrandDetail** *(dict) --* The details of the brand. * **BrandId** *(string) --* The ID of the Amazon QuickSight brand. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the brand. * **BrandStatus** *(string) --* The status of the brand. * **CreatedTime** *(datetime) --* The time that the brand was created. * **LastUpdatedTime** *(datetime) --* The last time the brand was updated. * **VersionId** *(string) --* The ID of the version. * **VersionStatus** *(string) --* The status of the version. * **Errors** *(list) --* A list of errors that occurred during the most recent brand operation. * *(string) --* * **Logo** *(dict) --* The logo details. * **AltText** *(string) --* The alt text for the logo. * **LogoSet** *(dict) --* A set of configured logos. * **Primary** *(dict) --* The primary logo. * **Original** *(dict) --* The original image. * **Source** *(dict) --* The source of the logo image. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "PublicUrl", "S3Uri". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **PublicUrl** *(string) --* The public URL that points to the source image. * **S3Uri** *(string) --* The Amazon S3 URI that points to the source image. * **GeneratedImageUrl** *(string) --* The URL that points to the generated logo image. * **Height64** *(dict) --* The image with the height set to 64 pixels. * **Source** *(dict) --* The source of the logo image. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "PublicUrl", "S3Uri". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **PublicUrl** *(string) --* The public URL that points to the source image. * **S3Uri** *(string) --* The Amazon S3 URI that points to the source image. * **GeneratedImageUrl** *(string) --* The URL that points to the generated logo image. * **Height32** *(dict) --* The image with the height set to 32 pixels. * **Source** *(dict) --* The source of the logo image. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "PublicUrl", "S3Uri". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **PublicUrl** *(string) --* The public URL that points to the source image. * **S3Uri** *(string) --* The Amazon S3 URI that points to the source image. * **GeneratedImageUrl** *(string) --* The URL that points to the generated logo image. * **Favicon** *(dict) --* The favicon logo. * **Original** *(dict) --* The original image. * **Source** *(dict) --* The source of the logo image. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "PublicUrl", "S3Uri". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **PublicUrl** *(string) --* The public URL that points to the source image. * **S3Uri** *(string) --* The Amazon S3 URI that points to the source image. * **GeneratedImageUrl** *(string) --* The URL that points to the generated logo image. * **Height64** *(dict) --* The image with the height set to 64 pixels. * **Source** *(dict) --* The source of the logo image. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "PublicUrl", "S3Uri". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **PublicUrl** *(string) --* The public URL that points to the source image. * **S3Uri** *(string) --* The Amazon S3 URI that points to the source image. * **GeneratedImageUrl** *(string) --* The URL that points to the generated logo image. * **Height32** *(dict) --* The image with the height set to 32 pixels. * **Source** *(dict) --* The source of the logo image. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "PublicUrl", "S3Uri". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **PublicUrl** *(string) --* The public URL that points to the source image. * **S3Uri** *(string) --* The Amazon S3 URI that points to the source image. * **GeneratedImageUrl** *(string) --* The URL that points to the generated logo image. * **BrandDefinition** *(dict) --* The definition of the brand. * **BrandName** *(string) --* The name of the brand. * **Description** *(string) --* The description of the brand. * **ApplicationTheme** *(dict) --* The application theme of the brand. * **BrandColorPalette** *(dict) --* The color palette. * **Primary** *(dict) --* The primary color. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **Secondary** *(dict) --* The secondary color. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **Accent** *(dict) --* The color that is used for accent elements. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **Measure** *(dict) --* The color that is used for measure elements. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **Dimension** *(dict) --* The color that is used for dimension elements. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **Success** *(dict) --* The color that is used for success elements. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **Info** *(dict) --* The color that is used for info elements. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **Warning** *(dict) --* The color that is used for warning elements. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **Danger** *(dict) --* The color that is used for danger elements. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **BrandElementStyle** *(dict) --* The element style. * **NavbarStyle** *(dict) --* The navigation bar style. * **GlobalNavbar** *(dict) --* The global navigation bar style. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **ContextualNavbar** *(dict) --* The contextual navigation bar style. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **LogoConfiguration** *(dict) --* The logo configuration of the brand. * **AltText** *(string) --* The alt text for the logo. * **LogoSet** *(dict) --* A set of configured logos. * **Primary** *(dict) --* The primary logo. * **Original** *(dict) --* The original image. * **Source** *(dict) --* The source of the image. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "PublicUrl", "S3Uri". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **PublicUrl** *(string) --* The public URL that points to the source image. * **S3Uri** *(string) --* The Amazon S3 URI that points to the source image. * **Favicon** *(dict) --* The favicon logo. * **Original** *(dict) --* The original image. * **Source** *(dict) --* The source of the image. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "PublicUrl", "S3Uri". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **PublicUrl** *(string) --* The public URL that points to the source image. * **S3Uri** *(string) --* The Amazon S3 URI that points to the source image. **Exceptions** * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InvalidRequestException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InternalServerException" QuickSight / Client / describe_dashboard_definition describe_dashboard_definition ***************************** QuickSight.Client.describe_dashboard_definition(**kwargs) Provides a detailed description of the definition of a dashboard. Note: If you do not need to know details about the content of a dashboard, for instance if you are trying to check the status of a recently created or updated dashboard, use the DescribeDashboard instead. See also: AWS API Documentation **Request Syntax** response = client.describe_dashboard_definition( AwsAccountId='string', DashboardId='string', VersionNumber=123, AliasName='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the dashboard that you're describing. * **DashboardId** (*string*) -- **[REQUIRED]** The ID for the dashboard. * **VersionNumber** (*integer*) -- The version number for the dashboard. If a version number isn't passed, the latest published dashboard version is described. * **AliasName** (*string*) -- The alias name. Return type: dict Returns: **Response Syntax** # This section is too large to render. # Please see the AWS API Documentation linked below. AWS API Documentation **Response Structure** # This section is too large to render. # Please see the AWS API Documentation linked below. AWS API Documentation **Exceptions** * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.ResourceExistsException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / list_custom_permissions list_custom_permissions *********************** QuickSight.Client.list_custom_permissions(**kwargs) Returns a list of all the custom permissions profiles. See also: AWS API Documentation **Request Syntax** response = client.list_custom_permissions( AwsAccountId='string', MaxResults=123, NextToken='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the custom permissions profiles that you want to list. * **MaxResults** (*integer*) -- The maximum number of results to return. * **NextToken** (*string*) -- The token for the next set of results, or null if there are no more results. Return type: dict Returns: **Response Syntax** { 'Status': 123, 'CustomPermissionsList': [ { 'Arn': 'string', 'CustomPermissionsName': 'string', 'Capabilities': { 'ExportToCsv': 'DENY', 'ExportToExcel': 'DENY', 'ExportToPdf': 'DENY', 'PrintReports': 'DENY', 'CreateAndUpdateThemes': 'DENY', 'AddOrRunAnomalyDetectionForAnalyses': 'DENY', 'ShareAnalyses': 'DENY', 'CreateAndUpdateDatasets': 'DENY', 'ShareDatasets': 'DENY', 'SubscribeDashboardEmailReports': 'DENY', 'CreateAndUpdateDashboardEmailReports': 'DENY', 'ShareDashboards': 'DENY', 'CreateAndUpdateThresholdAlerts': 'DENY', 'RenameSharedFolders': 'DENY', 'CreateSharedFolders': 'DENY', 'CreateAndUpdateDataSources': 'DENY', 'ShareDataSources': 'DENY', 'ViewAccountSPICECapacity': 'DENY', 'CreateSPICEDataset': 'DENY', 'ExportToPdfInScheduledReports': 'DENY', 'ExportToCsvInScheduledReports': 'DENY', 'ExportToExcelInScheduledReports': 'DENY', 'IncludeContentInScheduledReportsEmail': 'DENY' } }, ], 'NextToken': 'string', 'RequestId': 'string' } **Response Structure** * *(dict) --* * **Status** *(integer) --* The HTTP status of the request. * **CustomPermissionsList** *(list) --* A list of custom permissions profiles. * *(dict) --* The custom permissions profile. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the custom permissions profile. * **CustomPermissionsName** *(string) --* The name of the custom permissions profile. * **Capabilities** *(dict) --* A set of actions in the custom permissions profile. * **ExportToCsv** *(string) --* The ability to export to CSV files from the UI. * **ExportToExcel** *(string) --* The ability to export to Excel files from the UI. * **ExportToPdf** *(string) --* The ability to export to PDF files from the UI. * **PrintReports** *(string) --* The ability to print reports. * **CreateAndUpdateThemes** *(string) --* The ability to export to Create and Update themes. * **AddOrRunAnomalyDetectionForAnalyses** *(string) --* The ability to add or run anomaly detection. * **ShareAnalyses** *(string) --* The ability to share analyses. * **CreateAndUpdateDatasets** *(string) --* The ability to create and update datasets. * **ShareDatasets** *(string) --* The ability to share datasets. * **SubscribeDashboardEmailReports** *(string) --* The ability to subscribe to email reports. * **CreateAndUpdateDashboardEmailReports** *(string) --* The ability to create and update email reports. * **ShareDashboards** *(string) --* The ability to share dashboards. * **CreateAndUpdateThresholdAlerts** *(string) --* The ability to create and update threshold alerts. * **RenameSharedFolders** *(string) --* The ability to rename shared folders. * **CreateSharedFolders** *(string) --* The ability to create shared folders. * **CreateAndUpdateDataSources** *(string) --* The ability to create and update data sources. * **ShareDataSources** *(string) --* The ability to share data sources. * **ViewAccountSPICECapacity** *(string) --* The ability to view account SPICE capacity. * **CreateSPICEDataset** *(string) --* The ability to create a SPICE dataset. * **ExportToPdfInScheduledReports** *(string) --* The ability to export to PDF files in scheduled email reports. * **ExportToCsvInScheduledReports** *(string) --* The ability to export to CSV files in scheduled email reports. * **ExportToExcelInScheduledReports** *(string) --* The ability to export to Excel files in scheduled email reports. * **IncludeContentInScheduledReportsEmail** *(string) --* The ability to include content in scheduled email reports. * **NextToken** *(string) --* The token for the next set of results, or null if there are no more results. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.PreconditionNotMetException" * "QuickSight.Client.exceptions.InternalFailureException" * "QuickSight.Client.exceptions.ResourceUnavailableException" QuickSight / Client / list_dashboards list_dashboards *************** QuickSight.Client.list_dashboards(**kwargs) Lists dashboards in an Amazon Web Services account. See also: AWS API Documentation **Request Syntax** response = client.list_dashboards( AwsAccountId='string', NextToken='string', MaxResults=123 ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the dashboards that you're listing. * **NextToken** (*string*) -- The token for the next set of results, or null if there are no more results. * **MaxResults** (*integer*) -- The maximum number of results to be returned per request. Return type: dict Returns: **Response Syntax** { 'DashboardSummaryList': [ { 'Arn': 'string', 'DashboardId': 'string', 'Name': 'string', 'CreatedTime': datetime(2015, 1, 1), 'LastUpdatedTime': datetime(2015, 1, 1), 'PublishedVersionNumber': 123, 'LastPublishedTime': datetime(2015, 1, 1) }, ], 'NextToken': 'string', 'Status': 123, 'RequestId': 'string' } **Response Structure** * *(dict) --* * **DashboardSummaryList** *(list) --* A structure that contains all of the dashboards in your Amazon Web Services account. This structure provides basic information about the dashboards. * *(dict) --* Dashboard summary. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the resource. * **DashboardId** *(string) --* Dashboard ID. * **Name** *(string) --* A display name for the dashboard. * **CreatedTime** *(datetime) --* The time that this dashboard was created. * **LastUpdatedTime** *(datetime) --* The last time that this dashboard was updated. * **PublishedVersionNumber** *(integer) --* Published version number. * **LastPublishedTime** *(datetime) --* The last time that this dashboard was published. * **NextToken** *(string) --* The token for the next set of results, or null if there are no more results. * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InvalidNextTokenException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / describe_brand_assignment describe_brand_assignment ************************* QuickSight.Client.describe_brand_assignment(**kwargs) Describes a brand assignment. See also: AWS API Documentation **Request Syntax** response = client.describe_brand_assignment( AwsAccountId='string' ) Parameters: **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that owns the brand assignment. Return type: dict Returns: **Response Syntax** { 'RequestId': 'string', 'BrandArn': 'string' } **Response Structure** * *(dict) --* * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **BrandArn** *(string) --* The Amazon Resource Name (ARN) of the brand. **Exceptions** * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InvalidRequestException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InternalServerException" QuickSight / Client / describe_account_settings describe_account_settings ************************* QuickSight.Client.describe_account_settings(**kwargs) Describes the settings that were used when your Amazon QuickSight subscription was first created in this Amazon Web Services account. See also: AWS API Documentation **Request Syntax** response = client.describe_account_settings( AwsAccountId='string' ) Parameters: **AwsAccountId** (*string*) -- **[REQUIRED]** The ID for the Amazon Web Services account that contains the settings that you want to list. Return type: dict Returns: **Response Syntax** { 'AccountSettings': { 'AccountName': 'string', 'Edition': 'STANDARD'|'ENTERPRISE'|'ENTERPRISE_AND_Q', 'DefaultNamespace': 'string', 'NotificationEmail': 'string', 'PublicSharingEnabled': True|False, 'TerminationProtectionEnabled': True|False }, 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **AccountSettings** *(dict) --* 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. * **AccountName** *(string) --* The "account name" you provided for the Amazon QuickSight subscription in your Amazon Web Services account. You create this name when you sign up for Amazon QuickSight. It is unique in all of Amazon Web Services and it appears only when users sign in. * **Edition** *(string) --* The edition of Amazon QuickSight that you're currently subscribed to: Enterprise edition or Standard edition. * **DefaultNamespace** *(string) --* The default Amazon QuickSight namespace for your Amazon Web Services account. * **NotificationEmail** *(string) --* The main notification email for your Amazon QuickSight subscription. * **PublicSharingEnabled** *(boolean) --* A Boolean value that indicates whether public sharing is turned on for an Amazon QuickSight account. For more information about turning on public sharing, see UpdatePublicSharingSettings. * **TerminationProtectionEnabled** *(boolean) --* A boolean value that determines whether or not an Amazon QuickSight account can be deleted. A "True" value doesn't allow the account to be deleted and results in an error message if a user tries to make a "DeleteAccountSubsctiption" request. A "False" value will allow the ccount to be deleted. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InternalFailureException" * "QuickSight.Client.exceptions.ResourceUnavailableException" QuickSight / Client / update_quick_sight_q_search_configuration update_quick_sight_q_search_configuration ***************************************** QuickSight.Client.update_quick_sight_q_search_configuration(**kwargs) Updates the state of a Amazon QuickSight Q Search configuration. See also: AWS API Documentation **Request Syntax** response = client.update_quick_sight_q_search_configuration( AwsAccountId='string', QSearchStatus='ENABLED'|'DISABLED' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the Amazon QuickSight Q Search configuration that you want to update. * **QSearchStatus** (*string*) -- **[REQUIRED]** The status of the Amazon QuickSight Q Search configuration that the user wants to update. Return type: dict Returns: **Response Syntax** { 'QSearchStatus': 'ENABLED'|'DISABLED', 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **QSearchStatus** *(string) --* The status of the Amazon QuickSight Q Search configuration. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / list_folders list_folders ************ QuickSight.Client.list_folders(**kwargs) Lists all folders in an account. See also: AWS API Documentation **Request Syntax** response = client.list_folders( AwsAccountId='string', NextToken='string', MaxResults=123 ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID for the Amazon Web Services account that contains the folder. * **NextToken** (*string*) -- The token for the next set of results, or null if there are no more results. * **MaxResults** (*integer*) -- The maximum number of results to be returned per request. Return type: dict Returns: **Response Syntax** { 'Status': 123, 'FolderSummaryList': [ { 'Arn': 'string', 'FolderId': 'string', 'Name': 'string', 'FolderType': 'SHARED'|'RESTRICTED', 'CreatedTime': datetime(2015, 1, 1), 'LastUpdatedTime': datetime(2015, 1, 1), 'SharingModel': 'ACCOUNT'|'NAMESPACE' }, ], 'NextToken': 'string', 'RequestId': 'string' } **Response Structure** * *(dict) --* * **Status** *(integer) --* The HTTP status of the request. * **FolderSummaryList** *(list) --* A structure that contains all of the folders in the Amazon Web Services account. This structure provides basic information about the folders. * *(dict) --* A summary of information about an existing Amazon QuickSight folder. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the folder. * **FolderId** *(string) --* The ID of the folder. * **Name** *(string) --* The display name of the folder. * **FolderType** *(string) --* The type of folder. * **CreatedTime** *(datetime) --* The time that the folder was created. * **LastUpdatedTime** *(datetime) --* The time that the folder was last updated. * **SharingModel** *(string) --* The sharing scope of the folder. * **NextToken** *(string) --* The token for the next set of results, or null if there are no more results. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InvalidNextTokenException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / update_dashboard update_dashboard **************** QuickSight.Client.update_dashboard(**kwargs) Updates a dashboard in an Amazon Web Services account. Note: Updating a Dashboard creates a new dashboard version but does not immediately publish the new version. You can update the published version of a dashboard by using the "UpdateDashboardPublishedVersion" API operation. See also: AWS API Documentation **Request Syntax** # This section is too large to render. # Please see the AWS API Documentation linked below. AWS API Documentation **Parameters** # This section is too large to render. # Please see the AWS API Documentation linked below. AWS API Documentation Return type: dict Returns: **Response Syntax** { 'Arn': 'string', 'VersionArn': 'string', 'DashboardId': 'string', 'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED', 'Status': 123, 'RequestId': 'string' } **Response Structure** * *(dict) --* * **Arn** *(string) --* The Amazon Resource Name (ARN) of the resource. * **VersionArn** *(string) --* The ARN of the dashboard, including the version number. * **DashboardId** *(string) --* The ID for the dashboard. * **CreationStatus** *(string) --* The creation status of the request. * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.LimitExceededException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / update_role_custom_permission update_role_custom_permission ***************************** QuickSight.Client.update_role_custom_permission(**kwargs) Updates the custom permissions that are associated with a role. See also: AWS API Documentation **Request Syntax** response = client.update_role_custom_permission( CustomPermissionsName='string', Role='ADMIN'|'AUTHOR'|'READER'|'ADMIN_PRO'|'AUTHOR_PRO'|'READER_PRO', AwsAccountId='string', Namespace='string' ) Parameters: * **CustomPermissionsName** (*string*) -- **[REQUIRED]** The name of the custom permission that you want to update the role with. * **Role** (*string*) -- **[REQUIRED]** The name of role tht you want to update. * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account. * **Namespace** (*string*) -- **[REQUIRED]** The namespace that contains the role that you want to update. Return type: dict Returns: **Response Syntax** { 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.PreconditionNotMetException" * "QuickSight.Client.exceptions.InternalFailureException" * "QuickSight.Client.exceptions.ResourceUnavailableException" QuickSight / Client / update_dashboard_links update_dashboard_links ********************** QuickSight.Client.update_dashboard_links(**kwargs) Updates the linked analyses on a dashboard. See also: AWS API Documentation **Request Syntax** response = client.update_dashboard_links( AwsAccountId='string', DashboardId='string', LinkEntities=[ 'string', ] ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the dashboard whose links you want to update. * **DashboardId** (*string*) -- **[REQUIRED]** The ID for the dashboard. * **LinkEntities** (*list*) -- **[REQUIRED]** list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard. * *(string) --* Return type: dict Returns: **Response Syntax** { 'RequestId': 'string', 'Status': 123, 'DashboardArn': 'string', 'LinkEntities': [ 'string', ] } **Response Structure** * *(dict) --* * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. * **DashboardArn** *(string) --* The Amazon Resource Name (ARN) of the dashboard. * **LinkEntities** *(list) --* A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard. * *(string) --* **Exceptions** * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / restore_analysis restore_analysis **************** QuickSight.Client.restore_analysis(**kwargs) Restores an analysis. See also: AWS API Documentation **Request Syntax** response = client.restore_analysis( AwsAccountId='string', AnalysisId='string', RestoreToFolders=True|False ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the analysis. * **AnalysisId** (*string*) -- **[REQUIRED]** The ID of the analysis that you're restoring. * **RestoreToFolders** (*boolean*) -- A boolean value that determines if the analysis will be restored to folders that it previously resided in. A "True" value restores analysis back to all folders that it previously resided in. A "False" value restores the analysis but does not restore the analysis back to all previously resided folders. Restoring a restricted analysis requires this parameter to be set to "True". Return type: dict Returns: **Response Syntax** { 'Status': 123, 'Arn': 'string', 'AnalysisId': 'string', 'RequestId': 'string', 'RestorationFailedFolderArns': [ 'string', ] } **Response Structure** * *(dict) --* * **Status** *(integer) --* The HTTP status of the request. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the analysis that you're restoring. * **AnalysisId** *(string) --* The ID of the analysis that you're restoring. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **RestorationFailedFolderArns** *(list) --* A list of folder arns thatthe analysis failed to be restored to. * *(string) --* **Exceptions** * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.LimitExceededException" * "QuickSight.Client.exceptions.PreconditionNotMetException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / update_data_source_permissions update_data_source_permissions ****************************** QuickSight.Client.update_data_source_permissions(**kwargs) Updates the permissions to a data source. See also: AWS API Documentation **Request Syntax** response = client.update_data_source_permissions( AwsAccountId='string', DataSourceId='string', GrantPermissions=[ { 'Principal': 'string', 'Actions': [ 'string', ] }, ], RevokePermissions=[ { 'Principal': 'string', 'Actions': [ 'string', ] }, ] ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The Amazon Web Services account ID. * **DataSourceId** (*string*) -- **[REQUIRED]** The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. * **GrantPermissions** (*list*) -- A list of resource permissions that you want to grant on the data source. * *(dict) --* Permission for the resource. * **Principal** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the principal. This can be one of the following: * The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.) * The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.) * The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.) * **Actions** *(list) --* **[REQUIRED]** The IAM action to grant or revoke permissions on. * *(string) --* * **RevokePermissions** (*list*) -- A list of resource permissions that you want to revoke on the data source. * *(dict) --* Permission for the resource. * **Principal** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the principal. This can be one of the following: * The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.) * The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.) * The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.) * **Actions** *(list) --* **[REQUIRED]** The IAM action to grant or revoke permissions on. * *(string) --* Return type: dict Returns: **Response Syntax** { 'DataSourceArn': 'string', 'DataSourceId': 'string', 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **DataSourceArn** *(string) --* The Amazon Resource Name (ARN) of the data source. * **DataSourceId** *(string) --* The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / register_user register_user ************* QuickSight.Client.register_user(**kwargs) Creates an Amazon QuickSight user whose identity is associated with the Identity and Access Management (IAM) identity or role specified in the request. When you register a new user from the Amazon QuickSight API, Amazon QuickSight generates a registration URL. The user accesses this registration URL to create their account. Amazon QuickSight doesn't send a registration email to users who are registered from the Amazon QuickSight API. If you want new users to receive a registration email, then add those users in the Amazon QuickSight console. For more information on registering a new user in the Amazon QuickSight console, see Inviting users to access Amazon QuickSight. See also: AWS API Documentation **Request Syntax** response = client.register_user( IdentityType='IAM'|'QUICKSIGHT'|'IAM_IDENTITY_CENTER', Email='string', UserRole='ADMIN'|'AUTHOR'|'READER'|'RESTRICTED_AUTHOR'|'RESTRICTED_READER'|'ADMIN_PRO'|'AUTHOR_PRO'|'READER_PRO', IamArn='string', SessionName='string', AwsAccountId='string', Namespace='string', UserName='string', CustomPermissionsName='string', ExternalLoginFederationProviderType='string', CustomFederationProviderUrl='string', ExternalLoginId='string', Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **IdentityType** (*string*) -- **[REQUIRED]** The identity type that your Amazon QuickSight account uses to manage the identity of users. * **Email** (*string*) -- **[REQUIRED]** The email address of the user that you want to register. * **UserRole** (*string*) -- **[REQUIRED]** The Amazon QuickSight role for the user. The user role can be one of the following: * "READER": A user who has read-only access to dashboards. * "AUTHOR": A user who can create data sources, datasets, analyses, and dashboards. * "ADMIN": A user who is an author, who can also manage Amazon QuickSight settings. * "READER_PRO": Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Amazon QuickSight, can build stories with Amazon Q, and can generate executive summaries from dashboards. * "AUTHOR_PRO": Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&A, and generate executive summaries from dashboards. * "ADMIN_PRO": Admin Pros are Author Pros who can also manage Amazon QuickSight administrative settings. Admin Pro users are billed at Author Pro pricing. * "RESTRICTED_READER": This role isn't currently available for use. * "RESTRICTED_AUTHOR": This role isn't currently available for use. * **IamArn** (*string*) -- The ARN of the IAM user or role that you are registering with Amazon QuickSight. * **SessionName** (*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.* * **AwsAccountId** (*string*) -- **[REQUIRED]** 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** (*string*) -- **[REQUIRED]** The namespace. Currently, you should set this to "default". * **UserName** (*string*) -- The Amazon QuickSight user name that you want to create for the user you are registering. * **CustomPermissionsName** (*string*) -- (Enterprise edition only) The name of the custom permissions profile that you want to assign to this user. Customized permissions allows you to control a user's access by restricting access the following operations: * Create and update data sources * Create and update datasets * Create and update email reports * Subscribe to email reports To add custom permissions to an existing user, use "UpdateUser" instead. A set of custom permissions includes any combination of these restrictions. Currently, you need to create the profile names for custom permission sets by using the Amazon QuickSight console. Then, you use the "RegisterUser" API operation to assign the named set of permissions to a Amazon QuickSight user. Amazon QuickSight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning Amazon QuickSight users to one of the default security cohorts in Amazon QuickSight (admin, author, reader, admin pro, author pro, reader pro). This feature is available only to Amazon QuickSight Enterprise edition subscriptions. * **ExternalLoginFederationProviderType** (*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. * **CustomFederationProviderUrl** (*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". * **ExternalLoginId** (*string*) -- The identity ID for a user in the external login provider. * **Tags** (*list*) -- The tags to associate with the user. * *(dict) --* The key or keys of the key-value pairs for the resource tag or tags assigned to the resource. * **Key** *(string) --* **[REQUIRED]** Tag key. * **Value** *(string) --* **[REQUIRED]** Tag value. Return type: dict Returns: **Response Syntax** { 'User': { 'Arn': 'string', 'UserName': 'string', 'Email': 'string', 'Role': 'ADMIN'|'AUTHOR'|'READER'|'RESTRICTED_AUTHOR'|'RESTRICTED_READER'|'ADMIN_PRO'|'AUTHOR_PRO'|'READER_PRO', 'IdentityType': 'IAM'|'QUICKSIGHT'|'IAM_IDENTITY_CENTER', 'Active': True|False, 'PrincipalId': 'string', 'CustomPermissionsName': 'string', 'ExternalLoginFederationProviderType': 'string', 'ExternalLoginFederationProviderUrl': 'string', 'ExternalLoginId': 'string' }, 'UserInvitationUrl': 'string', 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **User** *(dict) --* The user's user name. * **Arn** *(string) --* The Amazon Resource Name (ARN) for the user. * **UserName** *(string) --* The user's user name. This value is required if you are registering a user that will be managed in Amazon QuickSight. In the output, the value for "UserName" is "N/A" when the value for "IdentityType" is "IAM" and the corresponding IAM user is deleted. * **Email** *(string) --* The user's email address. * **Role** *(string) --* The Amazon QuickSight role for the user. The user role can be one of the following:. * "READER": A user who has read-only access to dashboards. * "AUTHOR": A user who can create data sources, datasets, analyses, and dashboards. * "ADMIN": A user who is an author, who can also manage Amazon Amazon QuickSight settings. * "READER_PRO": Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Amazon QuickSight, can build stories with Amazon Q, and can generate executive summaries from dashboards. * "AUTHOR_PRO": Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&A, and generate executive summaries from dashboards. * "ADMIN_PRO": Admin Pros are Author Pros who can also manage Amazon QuickSight administrative settings. Admin Pro users are billed at Author Pro pricing. * "RESTRICTED_READER": This role isn't currently available for use. * "RESTRICTED_AUTHOR": This role isn't currently available for use. * **IdentityType** *(string) --* The type of identity authentication used by the user. * **Active** *(boolean) --* The active status of user. When you create an Amazon QuickSight user that's not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a password. * **PrincipalId** *(string) --* The principal ID of the user. * **CustomPermissionsName** *(string) --* The custom permissions profile associated with this user. * **ExternalLoginFederationProviderType** *(string) --* The type of supported external login provider that provides identity to let the user federate into Amazon QuickSight with an associated IAM role. The type can be one of the following. * "COGNITO": Amazon Cognito. The provider URL is cognito- identity.amazonaws.com. * "CUSTOM_OIDC": Custom OpenID Connect (OIDC) provider. * **ExternalLoginFederationProviderUrl** *(string) --* The URL of the external login provider. * **ExternalLoginId** *(string) --* The identity ID for the user in the external login provider. * **UserInvitationUrl** *(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". * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.LimitExceededException" * "QuickSight.Client.exceptions.ResourceExistsException" * "QuickSight.Client.exceptions.PreconditionNotMetException" * "QuickSight.Client.exceptions.InternalFailureException" * "QuickSight.Client.exceptions.ResourceUnavailableException" QuickSight / Client / search_data_sets search_data_sets **************** QuickSight.Client.search_data_sets(**kwargs) Use the "SearchDataSets" operation to search for datasets that belong to an account. See also: AWS API Documentation **Request Syntax** response = client.search_data_sets( AwsAccountId='string', Filters=[ { 'Operator': 'StringEquals'|'StringLike', 'Name': 'QUICKSIGHT_VIEWER_OR_OWNER'|'QUICKSIGHT_OWNER'|'DIRECT_QUICKSIGHT_VIEWER_OR_OWNER'|'DIRECT_QUICKSIGHT_OWNER'|'DIRECT_QUICKSIGHT_SOLE_OWNER'|'DATASET_NAME', 'Value': 'string' }, ], NextToken='string', MaxResults=123 ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The Amazon Web Services account ID. * **Filters** (*list*) -- **[REQUIRED]** The filters to apply to the search. * *(dict) --* A filter that you apply when searching for datasets. * **Operator** *(string) --* **[REQUIRED]** The comparison operator that you want to use as a filter, for example ""Operator": "StringEquals"". Valid values are ""StringEquals"" and ""StringLike"". If you set the operator value to ""StringEquals"", you need to provide an ownership related filter in the ""NAME"" field and the arn of the user or group whose datasets you want to search in the ""Value"" field. For example, ""Name":"QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east- 1:1:user/default/UserName1"". If you set the value to ""StringLike"", you need to provide the name of the datasets you are searching for. For example, ""Name":"DATASET_NAME", "Operator": "StringLike", "Value": "Test"". The ""StringLike"" operator only supports the "NAME" value "DATASET_NAME". * **Name** *(string) --* **[REQUIRED]** The name of the value that you want to use as a filter, for example, ""Name": "QUICKSIGHT_OWNER"". Valid values are defined as follows: * "QUICKSIGHT_VIEWER_OR_OWNER": Provide an ARN of a user or group, and any datasets with that ARN listed as one of the dataset owners or viewers are returned. Implicit permissions from folders or groups are considered. * "QUICKSIGHT_OWNER": Provide an ARN of a user or group, and any datasets with that ARN listed as one of the owners of the dataset are returned. Implicit permissions from folders or groups are considered. * "DIRECT_QUICKSIGHT_SOLE_OWNER": Provide an ARN of a user or group, and any datasets with that ARN listed as the only owner of the dataset are returned. Implicit permissions from folders or groups are not considered. * "DIRECT_QUICKSIGHT_OWNER": Provide an ARN of a user or group, and any datasets with that ARN listed as one of the owners if the dataset are returned. Implicit permissions from folders or groups are not considered. * "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER": Provide an ARN of a user or group, and any datasets with that ARN listed as one of the owners or viewers of the dataset are returned. Implicit permissions from folders or groups are not considered. * "DATASET_NAME": Any datasets whose names have a substring match to this value will be returned. * **Value** *(string) --* **[REQUIRED]** The value of the named item, in this case "QUICKSIGHT_OWNER", that you want to use as a filter, for example, ""Value": "arn:aws:quicksight:us- east-1:1:user/default/UserName1"". * **NextToken** (*string*) -- A pagination token that can be used in a subsequent request. * **MaxResults** (*integer*) -- The maximum number of results to be returned per request. Return type: dict Returns: **Response Syntax** { 'DataSetSummaries': [ { 'Arn': 'string', 'DataSetId': 'string', 'Name': 'string', 'CreatedTime': datetime(2015, 1, 1), 'LastUpdatedTime': datetime(2015, 1, 1), 'ImportMode': 'SPICE'|'DIRECT_QUERY', 'RowLevelPermissionDataSet': { 'Namespace': 'string', 'Arn': 'string', 'PermissionPolicy': 'GRANT_ACCESS'|'DENY_ACCESS', 'FormatVersion': 'VERSION_1'|'VERSION_2', 'Status': 'ENABLED'|'DISABLED' }, 'RowLevelPermissionTagConfigurationApplied': True|False, 'ColumnLevelPermissionRulesApplied': True|False, 'UseAs': 'RLS_RULES' }, ], 'NextToken': 'string', 'Status': 123, 'RequestId': 'string' } **Response Structure** * *(dict) --* * **DataSetSummaries** *(list) --* A "DataSetSummaries" object that returns a summary of a dataset. * *(dict) --* Dataset summary. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the dataset. * **DataSetId** *(string) --* The ID of the dataset. * **Name** *(string) --* A display name for the dataset. * **CreatedTime** *(datetime) --* The time that this dataset was created. * **LastUpdatedTime** *(datetime) --* The last time that this dataset was updated. * **ImportMode** *(string) --* A value that indicates whether you want to import the data into SPICE. * **RowLevelPermissionDataSet** *(dict) --* The row-level security configuration for the dataset. * **Namespace** *(string) --* The namespace associated with the dataset that contains permissions for RLS. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS. * **PermissionPolicy** *(string) --* The type of permissions to use when interpreting the permissions for RLS. "DENY_ACCESS" is included for backward compatibility only. * **FormatVersion** *(string) --* The user or group rules associated with the dataset that contains permissions for RLS. By default, "FormatVersion" is "VERSION_1". When "FormatVersion" is "VERSION_1", "UserName" and "GroupName" are required. When "FormatVersion" is "VERSION_2", "UserARN" and "GroupARN" are required, and "Namespace" must not exist. * **Status** *(string) --* The status of the row-level security permission dataset. If enabled, the status is "ENABLED". If disabled, the status is "DISABLED". * **RowLevelPermissionTagConfigurationApplied** *(boolean) --* Whether or not the row level permission tags are applied. * **ColumnLevelPermissionRulesApplied** *(boolean) --* A value that indicates if the dataset has column level permission configured. * **UseAs** *(string) --* The usage of the dataset. * **NextToken** *(string) --* A pagination token that can be used in a subsequent request. * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidNextTokenException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / delete_analysis delete_analysis *************** QuickSight.Client.delete_analysis(**kwargs) Deletes an analysis from Amazon QuickSight. You can optionally include a recovery window during which you can restore the analysis. If you don't specify a recovery window value, the operation defaults to 30 days. Amazon QuickSight attaches a "DeletionTime" stamp to the response that specifies the end of the recovery window. At the end of the recovery window, Amazon QuickSight deletes the analysis permanently. At any time before recovery window ends, you can use the "RestoreAnalysis" API operation to remove the "DeletionTime" stamp and cancel the deletion of the analysis. The analysis remains visible in the API until it's deleted, so you can describe it but you can't make a template from it. An analysis that's scheduled for deletion isn't accessible in the Amazon QuickSight console. To access it in the console, restore it. Deleting an analysis doesn't delete the dashboards that you publish from it. See also: AWS API Documentation **Request Syntax** response = client.delete_analysis( AwsAccountId='string', AnalysisId='string', RecoveryWindowInDays=123, ForceDeleteWithoutRecovery=True|False ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account where you want to delete an analysis. * **AnalysisId** (*string*) -- **[REQUIRED]** The ID of the analysis that you're deleting. * **RecoveryWindowInDays** (*integer*) -- 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. * **ForceDeleteWithoutRecovery** (*boolean*) -- 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. Return type: dict Returns: **Response Syntax** { 'Status': 123, 'Arn': 'string', 'AnalysisId': 'string', 'DeletionTime': datetime(2015, 1, 1), 'RequestId': 'string' } **Response Structure** * *(dict) --* * **Status** *(integer) --* The HTTP status of the request. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the deleted analysis. * **AnalysisId** *(string) --* The ID of the deleted analysis. * **DeletionTime** *(datetime) --* The date and time that the analysis is scheduled to be deleted. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / update_key_registration update_key_registration *********************** QuickSight.Client.update_key_registration(**kwargs) Updates a customer managed key in a Amazon QuickSight account. See also: AWS API Documentation **Request Syntax** response = client.update_key_registration( AwsAccountId='string', KeyRegistration=[ { 'KeyArn': 'string', 'DefaultKey': True|False }, ] ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the customer managed key registration that you want to update. * **KeyRegistration** (*list*) -- **[REQUIRED]** A list of "RegisteredCustomerManagedKey" objects to be updated to the Amazon QuickSight account. * *(dict) --* A customer managed key structure that contains the information listed below: * "KeyArn" - The ARN of a KMS key that is registered to a Amazon QuickSight account for encryption and decryption use. * "DefaultKey" - Indicates whether the current key is set as the default key for encryption and decryption use. * **KeyArn** *(string) --* The ARN of the KMS key that is registered to a Amazon QuickSight account for encryption and decryption use. * **DefaultKey** *(boolean) --* Indicates whether a "RegisteredCustomerManagedKey" is set as the default key for encryption and decryption use. Return type: dict Returns: **Response Syntax** { 'FailedKeyRegistration': [ { 'KeyArn': 'string', 'Message': 'string', 'StatusCode': 123, 'SenderFault': True|False }, ], 'SuccessfulKeyRegistration': [ { 'KeyArn': 'string', 'StatusCode': 123 }, ], 'RequestId': 'string' } **Response Structure** * *(dict) --* * **FailedKeyRegistration** *(list) --* A list of all customer managed key registrations that failed to update. * *(dict) --* An entry that appears when a "KeyRegistration" update to Amazon QuickSight fails. * **KeyArn** *(string) --* The ARN of the KMS key that failed to update. * **Message** *(string) --* A message that provides information about why a "FailedKeyRegistrationEntry" error occurred. * **StatusCode** *(integer) --* The HTTP status of a "FailedKeyRegistrationEntry" error. * **SenderFault** *(boolean) --* A boolean that indicates whether a "FailedKeyRegistrationEntry" resulted from user error. If the value of this property is "True", the error was caused by user error. If the value of this property is "False", the error occurred on the backend. If your job continues fail and with a "False" "SenderFault" value, contact Amazon Web ServicesSupport. * **SuccessfulKeyRegistration** *(list) --* A list of all customer managed key registrations that were successfully updated. * *(dict) --* A success entry that occurs when a "KeyRegistration" job is successfully applied to the Amazon QuickSight account. * **KeyArn** *(string) --* The ARN of the KMS key that is associated with the "SuccessfulKeyRegistrationEntry" entry. * **StatusCode** *(integer) --* The HTTP status of a "SuccessfulKeyRegistrationEntry" entry. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / update_application_with_token_exchange_grant update_application_with_token_exchange_grant ******************************************** QuickSight.Client.update_application_with_token_exchange_grant(**kwargs) Updates an Amazon QuickSight application with a token exchange grant. This operation only supports Amazon QuickSight applications that are registered with IAM Identity Center. See also: AWS API Documentation **Request Syntax** response = client.update_application_with_token_exchange_grant( AwsAccountId='string', Namespace='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account to be updated with a token exchange grant. * **Namespace** (*string*) -- **[REQUIRED]** The namespace of the Amazon QuickSight application. Return type: dict Returns: **Response Syntax** { 'Status': 123, 'RequestId': 'string' } **Response Structure** * *(dict) --* * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InvalidRequestException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.LimitExceededException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / describe_theme describe_theme ************** QuickSight.Client.describe_theme(**kwargs) Describes a theme. See also: AWS API Documentation **Request Syntax** response = client.describe_theme( AwsAccountId='string', ThemeId='string', VersionNumber=123, AliasName='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the theme that you're describing. * **ThemeId** (*string*) -- **[REQUIRED]** The ID for the theme. * **VersionNumber** (*integer*) -- The version number for the version to describe. If a "VersionNumber" parameter value isn't provided, the latest version of the theme is described. * **AliasName** (*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. Return type: dict Returns: **Response Syntax** { 'Theme': { 'Arn': 'string', 'Name': 'string', 'ThemeId': 'string', 'Version': { 'VersionNumber': 123, 'Arn': 'string', 'Description': 'string', 'BaseThemeId': 'string', 'CreatedTime': datetime(2015, 1, 1), 'Configuration': { 'DataColorPalette': { 'Colors': [ 'string', ], 'MinMaxGradient': [ 'string', ], 'EmptyFillColor': 'string' }, 'UIColorPalette': { 'PrimaryForeground': 'string', 'PrimaryBackground': 'string', 'SecondaryForeground': 'string', 'SecondaryBackground': 'string', 'Accent': 'string', 'AccentForeground': 'string', 'Danger': 'string', 'DangerForeground': 'string', 'Warning': 'string', 'WarningForeground': 'string', 'Success': 'string', 'SuccessForeground': 'string', 'Dimension': 'string', 'DimensionForeground': 'string', 'Measure': 'string', 'MeasureForeground': 'string' }, 'Sheet': { 'Tile': { 'Border': { 'Show': True|False } }, 'TileLayout': { 'Gutter': { 'Show': True|False }, 'Margin': { 'Show': True|False } } }, 'Typography': { 'FontFamilies': [ { 'FontFamily': 'string' }, ] } }, 'Errors': [ { 'Type': 'INTERNAL_FAILURE', 'Message': 'string' }, ], 'Status': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED' }, 'CreatedTime': datetime(2015, 1, 1), 'LastUpdatedTime': datetime(2015, 1, 1), 'Type': 'QUICKSIGHT'|'CUSTOM'|'ALL' }, 'Status': 123, 'RequestId': 'string' } **Response Structure** * *(dict) --* * **Theme** *(dict) --* The information about the theme that you are describing. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the theme. * **Name** *(string) --* The name that the user gives to the theme. * **ThemeId** *(string) --* The identifier that the user gives to the theme. * **Version** *(dict) --* A version of a theme. * **VersionNumber** *(integer) --* The version number of the theme. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the resource. * **Description** *(string) --* The description of the theme. * **BaseThemeId** *(string) --* The Amazon QuickSight-defined ID of the theme that a custom theme inherits from. All themes initially inherit from a default Amazon QuickSight theme. * **CreatedTime** *(datetime) --* The date and time that this theme version was created. * **Configuration** *(dict) --* The theme configuration, which contains all the theme display properties. * **DataColorPalette** *(dict) --* Color properties that apply to chart data colors. * **Colors** *(list) --* The hexadecimal codes for the colors. * *(string) --* * **MinMaxGradient** *(list) --* The minimum and maximum hexadecimal codes that describe a color gradient. * *(string) --* * **EmptyFillColor** *(string) --* The hexadecimal code of a color that applies to charts where a lack of data is highlighted. * **UIColorPalette** *(dict) --* Color properties that apply to the UI and to charts, excluding the colors that apply to data. * **PrimaryForeground** *(string) --* The color of text and other foreground elements that appear over the primary background regions, such as grid lines, borders, table banding, icons, and so on. * **PrimaryBackground** *(string) --* The background color that applies to visuals and other high emphasis UI. * **SecondaryForeground** *(string) --* The foreground color that applies to any sheet title, sheet control text, or UI that appears over the secondary background. * **SecondaryBackground** *(string) --* The background color that applies to the sheet background and sheet controls. * **Accent** *(string) --* This color is that applies to selected states and buttons. * **AccentForeground** *(string) --* The foreground color that applies to any text or other elements that appear over the accent color. * **Danger** *(string) --* The color that applies to error messages. * **DangerForeground** *(string) --* The foreground color that applies to any text or other elements that appear over the error color. * **Warning** *(string) --* This color that applies to warning and informational messages. * **WarningForeground** *(string) --* The foreground color that applies to any text or other elements that appear over the warning color. * **Success** *(string) --* The color that applies to success messages, for example the check mark for a successful download. * **SuccessForeground** *(string) --* The foreground color that applies to any text or other elements that appear over the success color. * **Dimension** *(string) --* The color that applies to the names of fields that are identified as dimensions. * **DimensionForeground** *(string) --* The foreground color that applies to any text or other elements that appear over the dimension color. * **Measure** *(string) --* The color that applies to the names of fields that are identified as measures. * **MeasureForeground** *(string) --* The foreground color that applies to any text or other elements that appear over the measure color. * **Sheet** *(dict) --* Display options related to sheets. * **Tile** *(dict) --* The display options for tiles. * **Border** *(dict) --* The border around a tile. * **Show** *(boolean) --* The option to enable display of borders for visuals. * **TileLayout** *(dict) --* The layout options for tiles. * **Gutter** *(dict) --* The gutter settings that apply between tiles. * **Show** *(boolean) --* This Boolean value controls whether to display a gutter space between sheet tiles. * **Margin** *(dict) --* The margin settings that apply around the outside edge of sheets. * **Show** *(boolean) --* This Boolean value controls whether to display sheet margins. * **Typography** *(dict) --* Determines the typography options. * **FontFamilies** *(list) --* Determines the list of font families. * *(dict) --* Determines the font settings. * **FontFamily** *(string) --* Determines the font family settings. * **Errors** *(list) --* Errors associated with the theme. * *(dict) --* Theme error. * **Type** *(string) --* The type of error. * **Message** *(string) --* The error message. * **Status** *(string) --* The status of the theme version. * **CreatedTime** *(datetime) --* The date and time that the theme was created. * **LastUpdatedTime** *(datetime) --* The date and time that the theme was last updated. * **Type** *(string) --* The type of theme, based on how it was created. Valid values include: "QUICKSIGHT" and "CUSTOM". * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceExistsException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / get_dashboard_embed_url get_dashboard_embed_url *********************** QuickSight.Client.get_dashboard_embed_url(**kwargs) Generates a temporary session URL and authorization code(bearer token) that you can use to embed an Amazon QuickSight read-only dashboard in your website or application. Before you use this command, make sure that you have configured the dashboards and permissions. Currently, you can use "GetDashboardEmbedURL" only from the server, not from the user's browser. The following rules apply to the generated URL: * They must be used together. * They can be used one time only. * They are valid for 5 minutes after you run this command. * You are charged only when the URL is used or there is interaction with Amazon QuickSight. * The resulting user session is valid for 15 minutes (default) up to 10 hours (maximum). You can use the optional "SessionLifetimeInMinutes" parameter to customize session duration. For more information, see Embedding Analytics Using GetDashboardEmbedUrl in the *Amazon QuickSight User Guide*. For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal. See also: AWS API Documentation **Request Syntax** response = client.get_dashboard_embed_url( AwsAccountId='string', DashboardId='string', IdentityType='IAM'|'QUICKSIGHT'|'ANONYMOUS', SessionLifetimeInMinutes=123, UndoRedoDisabled=True|False, ResetDisabled=True|False, StatePersistenceEnabled=True|False, UserArn='string', Namespace='string', AdditionalDashboardIds=[ 'string', ] ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID for the Amazon Web Services account that contains the dashboard that you're embedding. * **DashboardId** (*string*) -- **[REQUIRED]** The ID for the dashboard, also added to the Identity and Access Management (IAM) policy. * **IdentityType** (*string*) -- **[REQUIRED]** The authentication method that the user uses to sign in. * **SessionLifetimeInMinutes** (*integer*) -- How many minutes the session is valid. The session lifetime must be 15-600 minutes. * **UndoRedoDisabled** (*boolean*) -- Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables the undo/redo button. * **ResetDisabled** (*boolean*) -- Remove the reset button on the embedded dashboard. The default is FALSE, which enables the reset button. * **StatePersistenceEnabled** (*boolean*) -- 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". * **UserArn** (*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** (*string*) -- The Amazon QuickSight namespace that contains the dashboard IDs in this request. If you're not using a custom namespace, set "Namespace = default". * **AdditionalDashboardIds** (*list*) -- A list of one or more dashboard IDs that you want anonymous users to have tempporary access to. Currently, the "IdentityType" parameter must be set to "ANONYMOUS" because other identity types authenticate as Amazon QuickSight or IAM users. For example, if you set " "--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS"", the session can access all three dashboards. * *(string) --* Return type: dict Returns: **Response Syntax** { 'EmbedUrl': 'string', 'Status': 123, 'RequestId': 'string' } **Response Structure** * *(dict) --* Output returned from the "GetDashboardEmbedUrl" operation. * **EmbedUrl** *(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** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceExistsException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.DomainNotWhitelistedException" * "QuickSight.Client.exceptions.QuickSightUserNotFoundException" * "QuickSight.Client.exceptions.IdentityTypeNotSupportedException" * "QuickSight.Client.exceptions.SessionLifetimeInMinutesInvalidExc eption" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.UnsupportedPricingPlanException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / can_paginate can_paginate ************ QuickSight.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Returns: "True" if the operation can be paginated, "False" otherwise. QuickSight / Client / describe_custom_permissions describe_custom_permissions *************************** QuickSight.Client.describe_custom_permissions(**kwargs) Describes a custom permissions profile. See also: AWS API Documentation **Request Syntax** response = client.describe_custom_permissions( AwsAccountId='string', CustomPermissionsName='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the custom permissions profile that you want described. * **CustomPermissionsName** (*string*) -- **[REQUIRED]** The name of the custom permissions profile to describe. Return type: dict Returns: **Response Syntax** { 'Status': 123, 'CustomPermissions': { 'Arn': 'string', 'CustomPermissionsName': 'string', 'Capabilities': { 'ExportToCsv': 'DENY', 'ExportToExcel': 'DENY', 'ExportToPdf': 'DENY', 'PrintReports': 'DENY', 'CreateAndUpdateThemes': 'DENY', 'AddOrRunAnomalyDetectionForAnalyses': 'DENY', 'ShareAnalyses': 'DENY', 'CreateAndUpdateDatasets': 'DENY', 'ShareDatasets': 'DENY', 'SubscribeDashboardEmailReports': 'DENY', 'CreateAndUpdateDashboardEmailReports': 'DENY', 'ShareDashboards': 'DENY', 'CreateAndUpdateThresholdAlerts': 'DENY', 'RenameSharedFolders': 'DENY', 'CreateSharedFolders': 'DENY', 'CreateAndUpdateDataSources': 'DENY', 'ShareDataSources': 'DENY', 'ViewAccountSPICECapacity': 'DENY', 'CreateSPICEDataset': 'DENY', 'ExportToPdfInScheduledReports': 'DENY', 'ExportToCsvInScheduledReports': 'DENY', 'ExportToExcelInScheduledReports': 'DENY', 'IncludeContentInScheduledReportsEmail': 'DENY' } }, 'RequestId': 'string' } **Response Structure** * *(dict) --* * **Status** *(integer) --* The HTTP status of the request. * **CustomPermissions** *(dict) --* The custom permissions profile. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the custom permissions profile. * **CustomPermissionsName** *(string) --* The name of the custom permissions profile. * **Capabilities** *(dict) --* A set of actions in the custom permissions profile. * **ExportToCsv** *(string) --* The ability to export to CSV files from the UI. * **ExportToExcel** *(string) --* The ability to export to Excel files from the UI. * **ExportToPdf** *(string) --* The ability to export to PDF files from the UI. * **PrintReports** *(string) --* The ability to print reports. * **CreateAndUpdateThemes** *(string) --* The ability to export to Create and Update themes. * **AddOrRunAnomalyDetectionForAnalyses** *(string) --* The ability to add or run anomaly detection. * **ShareAnalyses** *(string) --* The ability to share analyses. * **CreateAndUpdateDatasets** *(string) --* The ability to create and update datasets. * **ShareDatasets** *(string) --* The ability to share datasets. * **SubscribeDashboardEmailReports** *(string) --* The ability to subscribe to email reports. * **CreateAndUpdateDashboardEmailReports** *(string) --* The ability to create and update email reports. * **ShareDashboards** *(string) --* The ability to share dashboards. * **CreateAndUpdateThresholdAlerts** *(string) --* The ability to create and update threshold alerts. * **RenameSharedFolders** *(string) --* The ability to rename shared folders. * **CreateSharedFolders** *(string) --* The ability to create shared folders. * **CreateAndUpdateDataSources** *(string) --* The ability to create and update data sources. * **ShareDataSources** *(string) --* The ability to share data sources. * **ViewAccountSPICECapacity** *(string) --* The ability to view account SPICE capacity. * **CreateSPICEDataset** *(string) --* The ability to create a SPICE dataset. * **ExportToPdfInScheduledReports** *(string) --* The ability to export to PDF files in scheduled email reports. * **ExportToCsvInScheduledReports** *(string) --* The ability to export to CSV files in scheduled email reports. * **ExportToExcelInScheduledReports** *(string) --* The ability to export to Excel files in scheduled email reports. * **IncludeContentInScheduledReportsEmail** *(string) --* The ability to include content in scheduled email reports. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.PreconditionNotMetException" * "QuickSight.Client.exceptions.InternalFailureException" * "QuickSight.Client.exceptions.ResourceUnavailableException" QuickSight / Client / delete_data_set_refresh_properties delete_data_set_refresh_properties ********************************** QuickSight.Client.delete_data_set_refresh_properties(**kwargs) Deletes the dataset refresh properties of the dataset. See also: AWS API Documentation **Request Syntax** response = client.delete_data_set_refresh_properties( AwsAccountId='string', DataSetId='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The Amazon Web Services account ID. * **DataSetId** (*string*) -- **[REQUIRED]** The ID of the dataset. Return type: dict Returns: **Response Syntax** { 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.LimitExceededException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / delete_brand_assignment delete_brand_assignment *********************** QuickSight.Client.delete_brand_assignment(**kwargs) Deletes a brand assignment. See also: AWS API Documentation **Request Syntax** response = client.delete_brand_assignment( AwsAccountId='string' ) Parameters: **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that owns the brand assignment. Return type: dict Returns: **Response Syntax** { 'RequestId': 'string' } **Response Structure** * *(dict) --* * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InvalidRequestException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InternalServerException" QuickSight / Client / search_analyses search_analyses *************** QuickSight.Client.search_analyses(**kwargs) Searches for analyses that belong to the user specified in the filter. Note: This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. See also: AWS API Documentation **Request Syntax** response = client.search_analyses( AwsAccountId='string', Filters=[ { 'Operator': 'StringEquals'|'StringLike', 'Name': 'QUICKSIGHT_USER'|'QUICKSIGHT_VIEWER_OR_OWNER'|'DIRECT_QUICKSIGHT_VIEWER_OR_OWNER'|'QUICKSIGHT_OWNER'|'DIRECT_QUICKSIGHT_OWNER'|'DIRECT_QUICKSIGHT_SOLE_OWNER'|'ANALYSIS_NAME', 'Value': 'string' }, ], NextToken='string', MaxResults=123 ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the analyses that you're searching for. * **Filters** (*list*) -- **[REQUIRED]** The structure for the search filters that you want to apply to your search. * *(dict) --* A filter that you apply when searching for one or more analyses. * **Operator** *(string) --* The comparison operator that you want to use as a filter, for example ""Operator": "StringEquals"". Valid values are ""StringEquals"" and ""StringLike"". If you set the operator value to ""StringEquals"", you need to provide an ownership related filter in the ""NAME"" field and the arn of the user or group whose folders you want to search in the ""Value"" field. For example, ""Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us- east-1:1:user/default/UserName1"". If you set the value to ""StringLike"", you need to provide the name of the folders you are searching for. For example, ""Name":"ANALYSIS_NAME", "Operator": "StringLike", "Value": "Test"". The ""StringLike"" operator only supports the "NAME" value "ANALYSIS_NAME". * **Name** *(string) --* The name of the value that you want to use as a filter, for example ""Name": "QUICKSIGHT_OWNER"". Valid values are defined as follows: * "QUICKSIGHT_VIEWER_OR_OWNER": Provide an ARN of a user or group, and any analyses with that ARN listed as one of the analysis' owners or viewers are returned. Implicit permissions from folders or groups are considered. * "QUICKSIGHT_OWNER": Provide an ARN of a user or group, and any analyses with that ARN listed as one of the owners of the analyses are returned. Implicit permissions from folders or groups are considered. * "DIRECT_QUICKSIGHT_SOLE_OWNER": Provide an ARN of a user or group, and any analyses with that ARN listed as the only owner of the analysis are returned. Implicit permissions from folders or groups are not considered. * "DIRECT_QUICKSIGHT_OWNER": Provide an ARN of a user or group, and any analyses with that ARN listed as one of the owners of the analyses are returned. Implicit permissions from folders or groups are not considered. * "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER": Provide an ARN of a user or group, and any analyses with that ARN listed as one of the owners or viewers of the analyses are returned. Implicit permissions from folders or groups are not considered. * "ANALYSIS_NAME": Any analyses whose names have a substring match to this value will be returned. * **Value** *(string) --* The value of the named item, in this case "QUICKSIGHT_USER", that you want to use as a filter, for example ""Value"". An example is ""arn:aws:quicksight:us- east-1:1:user/default/UserName1"". * **NextToken** (*string*) -- A pagination token that can be used in a subsequent request. * **MaxResults** (*integer*) -- The maximum number of results to return. Return type: dict Returns: **Response Syntax** { 'AnalysisSummaryList': [ { 'Arn': 'string', 'AnalysisId': 'string', 'Name': 'string', 'Status': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED', 'CreatedTime': datetime(2015, 1, 1), 'LastUpdatedTime': datetime(2015, 1, 1) }, ], 'NextToken': 'string', 'Status': 123, 'RequestId': 'string' } **Response Structure** * *(dict) --* * **AnalysisSummaryList** *(list) --* Metadata describing the analyses that you searched for. * *(dict) --* The summary metadata that describes an analysis. * **Arn** *(string) --* The Amazon Resource Name (ARN) for the analysis. * **AnalysisId** *(string) --* The ID of the analysis. This ID displays in the URL. * **Name** *(string) --* The name of the analysis. This name is displayed in the Amazon QuickSight console. * **Status** *(string) --* The last known status for the analysis. * **CreatedTime** *(datetime) --* The time that the analysis was created. * **LastUpdatedTime** *(datetime) --* The time that the analysis was last updated. * **NextToken** *(string) --* A pagination token that can be used in a subsequent request. * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.InvalidNextTokenException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / delete_default_q_business_application delete_default_q_business_application ************************************* QuickSight.Client.delete_default_q_business_application(**kwargs) Deletes a linked Amazon Q Business application from an Amazon QuickSight account See also: AWS API Documentation **Request Syntax** response = client.delete_default_q_business_application( AwsAccountId='string', Namespace='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon QuickSight account that you want to disconnect from a Amazon Q Business application. * **Namespace** (*string*) -- The Amazon QuickSight namespace that you want to delete a linked Amazon Q Business application from. If this field is left blank, the Amazon Q Business application is deleted from the default namespace. Currently, the default namespace is the only valid value for this parameter. Return type: dict Returns: **Response Syntax** { 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / list_namespaces list_namespaces *************** QuickSight.Client.list_namespaces(**kwargs) Lists the namespaces for the specified Amazon Web Services account. This operation doesn't list deleted namespaces. See also: AWS API Documentation **Request Syntax** response = client.list_namespaces( AwsAccountId='string', NextToken='string', MaxResults=123 ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID for the Amazon Web Services account that contains the Amazon QuickSight namespaces that you want to list. * **NextToken** (*string*) -- A unique pagination token that can be used in a subsequent request. You will receive a pagination token in the response body of a previous "ListNameSpaces" API call if there is more data that can be returned. To receive the data, make another "ListNamespaces" API call with the returned token to retrieve the next page of data. Each token is valid for 24 hours. If you try to make a "ListNamespaces" API call with an expired token, you will receive a "HTTP 400 InvalidNextTokenException" error. * **MaxResults** (*integer*) -- The maximum number of results to return. Return type: dict Returns: **Response Syntax** { 'Namespaces': [ { 'Name': 'string', 'Arn': 'string', 'CapacityRegion': 'string', 'CreationStatus': 'CREATED'|'CREATING'|'DELETING'|'RETRYABLE_FAILURE'|'NON_RETRYABLE_FAILURE', 'IdentityStore': 'QUICKSIGHT', 'NamespaceError': { 'Type': 'PERMISSION_DENIED'|'INTERNAL_SERVICE_ERROR', 'Message': 'string' }, 'IamIdentityCenterApplicationArn': 'string', 'IamIdentityCenterInstanceArn': 'string' }, ], 'NextToken': 'string', 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **Namespaces** *(list) --* 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. * *(dict) --* The error type. * **Name** *(string) --* The name of the error. * **Arn** *(string) --* The namespace ARN. * **CapacityRegion** *(string) --* The namespace Amazon Web Services Region. * **CreationStatus** *(string) --* The creation status of a namespace that is not yet completely created. * **IdentityStore** *(string) --* The identity store used for the namespace. * **NamespaceError** *(dict) --* An error that occurred when the namespace was created. * **Type** *(string) --* The error type. * **Message** *(string) --* The message for the error. * **IamIdentityCenterApplicationArn** *(string) --* The Amazon Resource Name (ARN) for the IAM Identity Center application. * **IamIdentityCenterInstanceArn** *(string) --* The Amazon Resource Name (ARN) for the IAM Identity Center instance. * **NextToken** *(string) --* A unique pagination token that can be used in a subsequent request. Receiving "NextToken" in your response inticates that there is more data that can be returned. To receive the data, make another "ListNamespaces" API call with the returned token to retrieve the next page of data. Each token is valid for 24 hours. If you try to make a "ListNamespaces" API call with an expired token, you will receive a "HTTP 400 InvalidNextTokenException" error. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InvalidNextTokenException" * "QuickSight.Client.exceptions.PreconditionNotMetException" * "QuickSight.Client.exceptions.InternalFailureException" * "QuickSight.Client.exceptions.ResourceUnavailableException" QuickSight / Client / describe_data_source describe_data_source ******************** QuickSight.Client.describe_data_source(**kwargs) Describes a data source. See also: AWS API Documentation **Request Syntax** response = client.describe_data_source( AwsAccountId='string', DataSourceId='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The Amazon Web Services account ID. * **DataSourceId** (*string*) -- **[REQUIRED]** The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. Return type: dict Returns: **Response Syntax** { 'DataSource': { 'Arn': 'string', 'DataSourceId': 'string', 'Name': 'string', 'Type': 'ADOBE_ANALYTICS'|'AMAZON_ELASTICSEARCH'|'ATHENA'|'AURORA'|'AURORA_POSTGRESQL'|'AWS_IOT_ANALYTICS'|'GITHUB'|'JIRA'|'MARIADB'|'MYSQL'|'ORACLE'|'POSTGRESQL'|'PRESTO'|'REDSHIFT'|'S3'|'SALESFORCE'|'SERVICENOW'|'SNOWFLAKE'|'SPARK'|'SQLSERVER'|'TERADATA'|'TWITTER'|'TIMESTREAM'|'AMAZON_OPENSEARCH'|'EXASOL'|'DATABRICKS'|'STARBURST'|'TRINO'|'BIGQUERY', 'Status': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED', 'CreatedTime': datetime(2015, 1, 1), 'LastUpdatedTime': datetime(2015, 1, 1), 'DataSourceParameters': { 'AmazonElasticsearchParameters': { 'Domain': 'string' }, 'AthenaParameters': { 'WorkGroup': 'string', 'RoleArn': 'string', 'IdentityCenterConfiguration': { 'EnableIdentityPropagation': True|False } }, 'AuroraParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'AuroraPostgreSqlParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'AwsIotAnalyticsParameters': { 'DataSetName': 'string' }, 'JiraParameters': { 'SiteBaseUrl': 'string' }, 'MariaDbParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'MySqlParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'OracleParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string', 'UseServiceName': True|False }, 'PostgreSqlParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'PrestoParameters': { 'Host': 'string', 'Port': 123, 'Catalog': 'string' }, 'RdsParameters': { 'InstanceId': 'string', 'Database': 'string' }, 'RedshiftParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string', 'ClusterId': 'string', 'IAMParameters': { 'RoleArn': 'string', 'DatabaseUser': 'string', 'DatabaseGroups': [ 'string', ], 'AutoCreateDatabaseUser': True|False }, 'IdentityCenterConfiguration': { 'EnableIdentityPropagation': True|False } }, 'S3Parameters': { 'ManifestFileLocation': { 'Bucket': 'string', 'Key': 'string' }, 'RoleArn': 'string' }, 'ServiceNowParameters': { 'SiteBaseUrl': 'string' }, 'SnowflakeParameters': { 'Host': 'string', 'Database': 'string', 'Warehouse': 'string', 'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509', 'DatabaseAccessControlRole': 'string', 'OAuthParameters': { 'TokenProviderUrl': 'string', 'OAuthScope': 'string', 'IdentityProviderVpcConnectionProperties': { 'VpcConnectionArn': 'string' }, 'IdentityProviderResourceUri': 'string' } }, 'SparkParameters': { 'Host': 'string', 'Port': 123 }, 'SqlServerParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'TeradataParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'TwitterParameters': { 'Query': 'string', 'MaxRows': 123 }, 'AmazonOpenSearchParameters': { 'Domain': 'string' }, 'ExasolParameters': { 'Host': 'string', 'Port': 123 }, 'DatabricksParameters': { 'Host': 'string', 'Port': 123, 'SqlEndpointPath': 'string' }, 'StarburstParameters': { 'Host': 'string', 'Port': 123, 'Catalog': 'string', 'ProductType': 'GALAXY'|'ENTERPRISE', 'DatabaseAccessControlRole': 'string', 'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509', 'OAuthParameters': { 'TokenProviderUrl': 'string', 'OAuthScope': 'string', 'IdentityProviderVpcConnectionProperties': { 'VpcConnectionArn': 'string' }, 'IdentityProviderResourceUri': 'string' } }, 'TrinoParameters': { 'Host': 'string', 'Port': 123, 'Catalog': 'string' }, 'BigQueryParameters': { 'ProjectId': 'string', 'DataSetRegion': 'string' }, 'ImpalaParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string', 'SqlEndpointPath': 'string' } }, 'AlternateDataSourceParameters': [ { 'AmazonElasticsearchParameters': { 'Domain': 'string' }, 'AthenaParameters': { 'WorkGroup': 'string', 'RoleArn': 'string', 'IdentityCenterConfiguration': { 'EnableIdentityPropagation': True|False } }, 'AuroraParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'AuroraPostgreSqlParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'AwsIotAnalyticsParameters': { 'DataSetName': 'string' }, 'JiraParameters': { 'SiteBaseUrl': 'string' }, 'MariaDbParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'MySqlParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'OracleParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string', 'UseServiceName': True|False }, 'PostgreSqlParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'PrestoParameters': { 'Host': 'string', 'Port': 123, 'Catalog': 'string' }, 'RdsParameters': { 'InstanceId': 'string', 'Database': 'string' }, 'RedshiftParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string', 'ClusterId': 'string', 'IAMParameters': { 'RoleArn': 'string', 'DatabaseUser': 'string', 'DatabaseGroups': [ 'string', ], 'AutoCreateDatabaseUser': True|False }, 'IdentityCenterConfiguration': { 'EnableIdentityPropagation': True|False } }, 'S3Parameters': { 'ManifestFileLocation': { 'Bucket': 'string', 'Key': 'string' }, 'RoleArn': 'string' }, 'ServiceNowParameters': { 'SiteBaseUrl': 'string' }, 'SnowflakeParameters': { 'Host': 'string', 'Database': 'string', 'Warehouse': 'string', 'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509', 'DatabaseAccessControlRole': 'string', 'OAuthParameters': { 'TokenProviderUrl': 'string', 'OAuthScope': 'string', 'IdentityProviderVpcConnectionProperties': { 'VpcConnectionArn': 'string' }, 'IdentityProviderResourceUri': 'string' } }, 'SparkParameters': { 'Host': 'string', 'Port': 123 }, 'SqlServerParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'TeradataParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'TwitterParameters': { 'Query': 'string', 'MaxRows': 123 }, 'AmazonOpenSearchParameters': { 'Domain': 'string' }, 'ExasolParameters': { 'Host': 'string', 'Port': 123 }, 'DatabricksParameters': { 'Host': 'string', 'Port': 123, 'SqlEndpointPath': 'string' }, 'StarburstParameters': { 'Host': 'string', 'Port': 123, 'Catalog': 'string', 'ProductType': 'GALAXY'|'ENTERPRISE', 'DatabaseAccessControlRole': 'string', 'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509', 'OAuthParameters': { 'TokenProviderUrl': 'string', 'OAuthScope': 'string', 'IdentityProviderVpcConnectionProperties': { 'VpcConnectionArn': 'string' }, 'IdentityProviderResourceUri': 'string' } }, 'TrinoParameters': { 'Host': 'string', 'Port': 123, 'Catalog': 'string' }, 'BigQueryParameters': { 'ProjectId': 'string', 'DataSetRegion': 'string' }, 'ImpalaParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string', 'SqlEndpointPath': 'string' } }, ], 'VpcConnectionProperties': { 'VpcConnectionArn': 'string' }, 'SslProperties': { 'DisableSsl': True|False }, 'ErrorInfo': { 'Type': 'ACCESS_DENIED'|'COPY_SOURCE_NOT_FOUND'|'TIMEOUT'|'ENGINE_VERSION_NOT_SUPPORTED'|'UNKNOWN_HOST'|'GENERIC_SQL_FAILURE'|'CONFLICT'|'UNKNOWN', 'Message': 'string' }, 'SecretArn': 'string' }, 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **DataSource** *(dict) --* The information on the data source. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the data source. * **DataSourceId** *(string) --* The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. * **Name** *(string) --* A display name for the data source. * **Type** *(string) --* The type of the data source. This type indicates which database engine the data source connects to. * **Status** *(string) --* The HTTP status of the request. * **CreatedTime** *(datetime) --* The time that this data source was created. * **LastUpdatedTime** *(datetime) --* The last time that this data source was updated. * **DataSourceParameters** *(dict) --* The parameters that Amazon QuickSight uses to connect to your underlying source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null. * **AmazonElasticsearchParameters** *(dict) --* The parameters for OpenSearch. * **Domain** *(string) --* The OpenSearch domain. * **AthenaParameters** *(dict) --* The parameters for Amazon Athena. * **WorkGroup** *(string) --* The workgroup that Amazon Athena uses. * **RoleArn** *(string) --* Use the "RoleArn" structure to override an account- wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use "RoleArn" to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active. * **IdentityCenterConfiguration** *(dict) --* An optional parameter that configures IAM Identity Center authentication to grant Amazon QuickSight access to your workgroup. This parameter can only be specified if your Amazon QuickSight account is configured with IAM Identity Center. * **EnableIdentityPropagation** *(boolean) --* A Boolean option that controls whether Trusted Identity Propagation should be used. * **AuroraParameters** *(dict) --* The parameters for Amazon Aurora MySQL. * **Host** *(string) --* Host. * **Port** *(integer) --* Port. * **Database** *(string) --* Database. * **AuroraPostgreSqlParameters** *(dict) --* The parameters for Amazon Aurora. * **Host** *(string) --* The Amazon Aurora PostgreSQL-Compatible host to connect to. * **Port** *(integer) --* The port that Amazon Aurora PostgreSQL is listening on. * **Database** *(string) --* The Amazon Aurora PostgreSQL database to connect to. * **AwsIotAnalyticsParameters** *(dict) --* The parameters for IoT Analytics. * **DataSetName** *(string) --* Dataset name. * **JiraParameters** *(dict) --* The parameters for Jira. * **SiteBaseUrl** *(string) --* The base URL of the Jira site. * **MariaDbParameters** *(dict) --* The parameters for MariaDB. * **Host** *(string) --* Host. * **Port** *(integer) --* Port. * **Database** *(string) --* Database. * **MySqlParameters** *(dict) --* The parameters for MySQL. * **Host** *(string) --* Host. * **Port** *(integer) --* Port. * **Database** *(string) --* Database. * **OracleParameters** *(dict) --* The parameters for Oracle. * **Host** *(string) --* An Oracle host. * **Port** *(integer) --* The port. * **Database** *(string) --* The database. * **UseServiceName** *(boolean) --* A Boolean value that indicates whether the "Database" uses a service name or an SID. If this value is left blank, the default value is "SID". If this value is set to "false", the value is "SID". * **PostgreSqlParameters** *(dict) --* The parameters for PostgreSQL. * **Host** *(string) --* Host. * **Port** *(integer) --* Port. * **Database** *(string) --* Database. * **PrestoParameters** *(dict) --* The parameters for Presto. * **Host** *(string) --* Host. * **Port** *(integer) --* Port. * **Catalog** *(string) --* Catalog. * **RdsParameters** *(dict) --* The parameters for Amazon RDS. * **InstanceId** *(string) --* Instance ID. * **Database** *(string) --* Database. * **RedshiftParameters** *(dict) --* The parameters for Amazon Redshift. * **Host** *(string) --* Host. This field can be blank if "ClusterId" is provided. * **Port** *(integer) --* Port. This field can be blank if the "ClusterId" is provided. * **Database** *(string) --* Database. * **ClusterId** *(string) --* Cluster ID. This field can be blank if the "Host" and "Port" are provided. * **IAMParameters** *(dict) --* An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials. * **RoleArn** *(string) --* Use the "RoleArn" structure to allow Amazon QuickSight to call "redshift:GetClusterCredentials" on your cluster. The calling principal must have "iam:PassRole" access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role. * **DatabaseUser** *(string) --* The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of "AutoCreateDatabaseUser" to "True" to create a new user with PUBLIC permissions. * **DatabaseGroups** *(list) --* A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the "DatabaseUser". If you choose to include this parameter, the "RoleArn" must grant access to "redshift:JoinGroup". * *(string) --* * **AutoCreateDatabaseUser** *(boolean) --* Automatically creates a database user. If your database doesn't have a "DatabaseUser", set this parameter to "True". If there is no "DatabaseUser", Amazon QuickSight can't connect to your cluster. The "RoleArn" that you use for this operation must grant access to "redshift:CreateClusterUser" to successfully create the user. * **IdentityCenterConfiguration** *(dict) --* An optional parameter that configures IAM Identity Center authentication to grant Amazon QuickSight access to your cluster. This parameter can only be specified if your Amazon QuickSight account is configured with IAM Identity Center. * **EnableIdentityPropagation** *(boolean) --* A Boolean option that controls whether Trusted Identity Propagation should be used. * **S3Parameters** *(dict) --* The parameters for S3. * **ManifestFileLocation** *(dict) --* Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight. * **Bucket** *(string) --* Amazon S3 bucket. * **Key** *(string) --* Amazon S3 key that identifies an object. * **RoleArn** *(string) --* Use the "RoleArn" structure to override an account- wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use "RoleArn" to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account- wide role forbidding S3 access is still active. * **ServiceNowParameters** *(dict) --* The parameters for ServiceNow. * **SiteBaseUrl** *(string) --* URL of the base site. * **SnowflakeParameters** *(dict) --* The parameters for Snowflake. * **Host** *(string) --* Host. * **Database** *(string) --* Database. * **Warehouse** *(string) --* Warehouse. * **AuthenticationType** *(string) --* The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types. * **DatabaseAccessControlRole** *(string) --* The database access control role. * **OAuthParameters** *(dict) --* An object that contains information needed to create a data source connection between an Amazon QuickSight account and Snowflake. * **TokenProviderUrl** *(string) --* The token endpoint URL of the identity provider. * **OAuthScope** *(string) --* The OAuth scope. * **IdentityProviderVpcConnectionProperties** *(dict) --* VPC connection properties. * **VpcConnectionArn** *(string) --* The Amazon Resource Name (ARN) for the VPC connection. * **IdentityProviderResourceUri** *(string) --* The resource uri of the identity provider. * **SparkParameters** *(dict) --* The parameters for Spark. * **Host** *(string) --* Host. * **Port** *(integer) --* Port. * **SqlServerParameters** *(dict) --* The parameters for SQL Server. * **Host** *(string) --* Host. * **Port** *(integer) --* Port. * **Database** *(string) --* Database. * **TeradataParameters** *(dict) --* The parameters for Teradata. * **Host** *(string) --* Host. * **Port** *(integer) --* Port. * **Database** *(string) --* Database. * **TwitterParameters** *(dict) --* The parameters for Twitter. * **Query** *(string) --* Twitter query string. * **MaxRows** *(integer) --* Maximum number of rows to query Twitter. * **AmazonOpenSearchParameters** *(dict) --* The parameters for OpenSearch. * **Domain** *(string) --* The OpenSearch domain. * **ExasolParameters** *(dict) --* The parameters for Exasol. * **Host** *(string) --* The hostname or IP address of the Exasol data source. * **Port** *(integer) --* The port for the Exasol data source. * **DatabricksParameters** *(dict) --* The parameters that are required to connect to a Databricks data source. * **Host** *(string) --* The host name of the Databricks data source. * **Port** *(integer) --* The port for the Databricks data source. * **SqlEndpointPath** *(string) --* The HTTP path of the Databricks data source. * **StarburstParameters** *(dict) --* The parameters that are required to connect to a Starburst data source. * **Host** *(string) --* The host name of the Starburst data source. * **Port** *(integer) --* The port for the Starburst data source. * **Catalog** *(string) --* The catalog name for the Starburst data source. * **ProductType** *(string) --* The product type for the Starburst data source. * **DatabaseAccessControlRole** *(string) --* The database access control role. * **AuthenticationType** *(string) --* The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types. * **OAuthParameters** *(dict) --* An object that contains information needed to create a data source connection between an Amazon QuickSight account and Starburst. * **TokenProviderUrl** *(string) --* The token endpoint URL of the identity provider. * **OAuthScope** *(string) --* The OAuth scope. * **IdentityProviderVpcConnectionProperties** *(dict) --* VPC connection properties. * **VpcConnectionArn** *(string) --* The Amazon Resource Name (ARN) for the VPC connection. * **IdentityProviderResourceUri** *(string) --* The resource uri of the identity provider. * **TrinoParameters** *(dict) --* The parameters that are required to connect to a Trino data source. * **Host** *(string) --* The host name of the Trino data source. * **Port** *(integer) --* The port for the Trino data source. * **Catalog** *(string) --* The catalog name for the Trino data source. * **BigQueryParameters** *(dict) --* The parameters that are required to connect to a Google BigQuery data source. * **ProjectId** *(string) --* The Google Cloud Platform project ID where your datasource was created. * **DataSetRegion** *(string) --* The storage location where you create a Google BigQuery data source. * **ImpalaParameters** *(dict) --* The parameters for Impala. * **Host** *(string) --* The host name of the Impala data source. * **Port** *(integer) --* The port of the Impala data source. * **Database** *(string) --* The database of the Impala data source. * **SqlEndpointPath** *(string) --* The HTTP path of the Impala data source. * **AlternateDataSourceParameters** *(list) --* A set of alternate data source parameters that you want to share for the credentials stored with this data source. The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the "DataSourceParameters" structure that's in the request with the structures in the "AlternateDataSourceParameters" allow list. If the structures are an exact match, the request is allowed to use the credentials from this existing data source. If the "AlternateDataSourceParameters" list is null, the "Credentials" originally used with this "DataSourceParameters" are automatically allowed. * *(dict) --* The parameters that Amazon QuickSight uses to connect to your underlying data source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null. * **AmazonElasticsearchParameters** *(dict) --* The parameters for OpenSearch. * **Domain** *(string) --* The OpenSearch domain. * **AthenaParameters** *(dict) --* The parameters for Amazon Athena. * **WorkGroup** *(string) --* The workgroup that Amazon Athena uses. * **RoleArn** *(string) --* Use the "RoleArn" structure to override an account- wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use "RoleArn" to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active. * **IdentityCenterConfiguration** *(dict) --* An optional parameter that configures IAM Identity Center authentication to grant Amazon QuickSight access to your workgroup. This parameter can only be specified if your Amazon QuickSight account is configured with IAM Identity Center. * **EnableIdentityPropagation** *(boolean) --* A Boolean option that controls whether Trusted Identity Propagation should be used. * **AuroraParameters** *(dict) --* The parameters for Amazon Aurora MySQL. * **Host** *(string) --* Host. * **Port** *(integer) --* Port. * **Database** *(string) --* Database. * **AuroraPostgreSqlParameters** *(dict) --* The parameters for Amazon Aurora. * **Host** *(string) --* The Amazon Aurora PostgreSQL-Compatible host to connect to. * **Port** *(integer) --* The port that Amazon Aurora PostgreSQL is listening on. * **Database** *(string) --* The Amazon Aurora PostgreSQL database to connect to. * **AwsIotAnalyticsParameters** *(dict) --* The parameters for IoT Analytics. * **DataSetName** *(string) --* Dataset name. * **JiraParameters** *(dict) --* The parameters for Jira. * **SiteBaseUrl** *(string) --* The base URL of the Jira site. * **MariaDbParameters** *(dict) --* The parameters for MariaDB. * **Host** *(string) --* Host. * **Port** *(integer) --* Port. * **Database** *(string) --* Database. * **MySqlParameters** *(dict) --* The parameters for MySQL. * **Host** *(string) --* Host. * **Port** *(integer) --* Port. * **Database** *(string) --* Database. * **OracleParameters** *(dict) --* The parameters for Oracle. * **Host** *(string) --* An Oracle host. * **Port** *(integer) --* The port. * **Database** *(string) --* The database. * **UseServiceName** *(boolean) --* A Boolean value that indicates whether the "Database" uses a service name or an SID. If this value is left blank, the default value is "SID". If this value is set to "false", the value is "SID". * **PostgreSqlParameters** *(dict) --* The parameters for PostgreSQL. * **Host** *(string) --* Host. * **Port** *(integer) --* Port. * **Database** *(string) --* Database. * **PrestoParameters** *(dict) --* The parameters for Presto. * **Host** *(string) --* Host. * **Port** *(integer) --* Port. * **Catalog** *(string) --* Catalog. * **RdsParameters** *(dict) --* The parameters for Amazon RDS. * **InstanceId** *(string) --* Instance ID. * **Database** *(string) --* Database. * **RedshiftParameters** *(dict) --* The parameters for Amazon Redshift. * **Host** *(string) --* Host. This field can be blank if "ClusterId" is provided. * **Port** *(integer) --* Port. This field can be blank if the "ClusterId" is provided. * **Database** *(string) --* Database. * **ClusterId** *(string) --* Cluster ID. This field can be blank if the "Host" and "Port" are provided. * **IAMParameters** *(dict) --* An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials. * **RoleArn** *(string) --* Use the "RoleArn" structure to allow Amazon QuickSight to call "redshift:GetClusterCredentials" on your cluster. The calling principal must have "iam:PassRole" access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role. * **DatabaseUser** *(string) --* The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of "AutoCreateDatabaseUser" to "True" to create a new user with PUBLIC permissions. * **DatabaseGroups** *(list) --* A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the "DatabaseUser". If you choose to include this parameter, the "RoleArn" must grant access to "redshift:JoinGroup". * *(string) --* * **AutoCreateDatabaseUser** *(boolean) --* Automatically creates a database user. If your database doesn't have a "DatabaseUser", set this parameter to "True". If there is no "DatabaseUser", Amazon QuickSight can't connect to your cluster. The "RoleArn" that you use for this operation must grant access to "redshift:CreateClusterUser" to successfully create the user. * **IdentityCenterConfiguration** *(dict) --* An optional parameter that configures IAM Identity Center authentication to grant Amazon QuickSight access to your cluster. This parameter can only be specified if your Amazon QuickSight account is configured with IAM Identity Center. * **EnableIdentityPropagation** *(boolean) --* A Boolean option that controls whether Trusted Identity Propagation should be used. * **S3Parameters** *(dict) --* The parameters for S3. * **ManifestFileLocation** *(dict) --* Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight. * **Bucket** *(string) --* Amazon S3 bucket. * **Key** *(string) --* Amazon S3 key that identifies an object. * **RoleArn** *(string) --* Use the "RoleArn" structure to override an account- wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use "RoleArn" to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active. * **ServiceNowParameters** *(dict) --* The parameters for ServiceNow. * **SiteBaseUrl** *(string) --* URL of the base site. * **SnowflakeParameters** *(dict) --* The parameters for Snowflake. * **Host** *(string) --* Host. * **Database** *(string) --* Database. * **Warehouse** *(string) --* Warehouse. * **AuthenticationType** *(string) --* The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types. * **DatabaseAccessControlRole** *(string) --* The database access control role. * **OAuthParameters** *(dict) --* An object that contains information needed to create a data source connection between an Amazon QuickSight account and Snowflake. * **TokenProviderUrl** *(string) --* The token endpoint URL of the identity provider. * **OAuthScope** *(string) --* The OAuth scope. * **IdentityProviderVpcConnectionProperties** *(dict) --* VPC connection properties. * **VpcConnectionArn** *(string) --* The Amazon Resource Name (ARN) for the VPC connection. * **IdentityProviderResourceUri** *(string) --* The resource uri of the identity provider. * **SparkParameters** *(dict) --* The parameters for Spark. * **Host** *(string) --* Host. * **Port** *(integer) --* Port. * **SqlServerParameters** *(dict) --* The parameters for SQL Server. * **Host** *(string) --* Host. * **Port** *(integer) --* Port. * **Database** *(string) --* Database. * **TeradataParameters** *(dict) --* The parameters for Teradata. * **Host** *(string) --* Host. * **Port** *(integer) --* Port. * **Database** *(string) --* Database. * **TwitterParameters** *(dict) --* The parameters for Twitter. * **Query** *(string) --* Twitter query string. * **MaxRows** *(integer) --* Maximum number of rows to query Twitter. * **AmazonOpenSearchParameters** *(dict) --* The parameters for OpenSearch. * **Domain** *(string) --* The OpenSearch domain. * **ExasolParameters** *(dict) --* The parameters for Exasol. * **Host** *(string) --* The hostname or IP address of the Exasol data source. * **Port** *(integer) --* The port for the Exasol data source. * **DatabricksParameters** *(dict) --* The parameters that are required to connect to a Databricks data source. * **Host** *(string) --* The host name of the Databricks data source. * **Port** *(integer) --* The port for the Databricks data source. * **SqlEndpointPath** *(string) --* The HTTP path of the Databricks data source. * **StarburstParameters** *(dict) --* The parameters that are required to connect to a Starburst data source. * **Host** *(string) --* The host name of the Starburst data source. * **Port** *(integer) --* The port for the Starburst data source. * **Catalog** *(string) --* The catalog name for the Starburst data source. * **ProductType** *(string) --* The product type for the Starburst data source. * **DatabaseAccessControlRole** *(string) --* The database access control role. * **AuthenticationType** *(string) --* The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types. * **OAuthParameters** *(dict) --* An object that contains information needed to create a data source connection between an Amazon QuickSight account and Starburst. * **TokenProviderUrl** *(string) --* The token endpoint URL of the identity provider. * **OAuthScope** *(string) --* The OAuth scope. * **IdentityProviderVpcConnectionProperties** *(dict) --* VPC connection properties. * **VpcConnectionArn** *(string) --* The Amazon Resource Name (ARN) for the VPC connection. * **IdentityProviderResourceUri** *(string) --* The resource uri of the identity provider. * **TrinoParameters** *(dict) --* The parameters that are required to connect to a Trino data source. * **Host** *(string) --* The host name of the Trino data source. * **Port** *(integer) --* The port for the Trino data source. * **Catalog** *(string) --* The catalog name for the Trino data source. * **BigQueryParameters** *(dict) --* The parameters that are required to connect to a Google BigQuery data source. * **ProjectId** *(string) --* The Google Cloud Platform project ID where your datasource was created. * **DataSetRegion** *(string) --* The storage location where you create a Google BigQuery data source. * **ImpalaParameters** *(dict) --* The parameters for Impala. * **Host** *(string) --* The host name of the Impala data source. * **Port** *(integer) --* The port of the Impala data source. * **Database** *(string) --* The database of the Impala data source. * **SqlEndpointPath** *(string) --* The HTTP path of the Impala data source. * **VpcConnectionProperties** *(dict) --* The VPC connection information. You need to use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source. * **VpcConnectionArn** *(string) --* The Amazon Resource Name (ARN) for the VPC connection. * **SslProperties** *(dict) --* Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source. * **DisableSsl** *(boolean) --* A Boolean option to control whether SSL should be disabled. * **ErrorInfo** *(dict) --* Error information from the last update or the creation of the data source. * **Type** *(string) --* Error type. * **Message** *(string) --* Error message. * **SecretArn** *(string) --* The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / list_group_memberships list_group_memberships ********************** QuickSight.Client.list_group_memberships(**kwargs) Lists member users in a group. See also: AWS API Documentation **Request Syntax** response = client.list_group_memberships( GroupName='string', NextToken='string', MaxResults=123, AwsAccountId='string', Namespace='string' ) Parameters: * **GroupName** (*string*) -- **[REQUIRED]** The name of the group that you want to see a membership list of. * **NextToken** (*string*) -- A pagination token that can be used in a subsequent request. * **MaxResults** (*integer*) -- The maximum number of results to return from this request. * **AwsAccountId** (*string*) -- **[REQUIRED]** 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** (*string*) -- **[REQUIRED]** The namespace of the group that you want a list of users from. Return type: dict Returns: **Response Syntax** { 'GroupMemberList': [ { 'Arn': 'string', 'MemberName': 'string' }, ], 'NextToken': 'string', 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **GroupMemberList** *(list) --* The list of the members of the group. * *(dict) --* A member of an Amazon QuickSight group. Currently, group members must be users. Groups can't be members of another group. . * **Arn** *(string) --* The Amazon Resource Name (ARN) for the group member (user). * **MemberName** *(string) --* The name of the group member (user). * **NextToken** *(string) --* A pagination token that can be used in a subsequent request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InvalidNextTokenException" * "QuickSight.Client.exceptions.PreconditionNotMetException" * "QuickSight.Client.exceptions.InternalFailureException" * "QuickSight.Client.exceptions.ResourceUnavailableException" QuickSight / Client / describe_dashboard_snapshot_job_result describe_dashboard_snapshot_job_result ************************************** QuickSight.Client.describe_dashboard_snapshot_job_result(**kwargs) Describes the result of an existing snapshot job that has finished running. A finished snapshot job will return a "COMPLETED" or "FAILED" status when you poll the job with a "DescribeDashboardSnapshotJob" API call. If the job has not finished running, this operation returns a message that says "Dashboard Snapshot Job with id has not reached a terminal state.". See also: AWS API Documentation **Request Syntax** response = client.describe_dashboard_snapshot_job_result( AwsAccountId='string', DashboardId='string', SnapshotJobId='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that the dashboard snapshot job is executed in. * **DashboardId** (*string*) -- **[REQUIRED]** The ID of the dashboard that you have started a snapshot job for. * **SnapshotJobId** (*string*) -- **[REQUIRED]** The ID of the job to be described. The job ID is set when you start a new job with a "StartDashboardSnapshotJob" API call. Return type: dict Returns: **Response Syntax** { 'Arn': 'string', 'JobStatus': 'QUEUED'|'RUNNING'|'COMPLETED'|'FAILED', 'CreatedTime': datetime(2015, 1, 1), 'LastUpdatedTime': datetime(2015, 1, 1), 'Result': { 'AnonymousUsers': [ { 'FileGroups': [ { 'Files': [ { 'SheetSelections': [ { 'SheetId': 'string', 'SelectionScope': 'ALL_VISUALS'|'SELECTED_VISUALS', 'VisualIds': [ 'string', ] }, ], 'FormatType': 'CSV'|'PDF'|'EXCEL' }, ], 'S3Results': [ { 'S3DestinationConfiguration': { 'BucketConfiguration': { 'BucketName': 'string', 'BucketPrefix': 'string', 'BucketRegion': 'string' } }, 'S3Uri': 'string', 'ErrorInfo': [ { 'ErrorMessage': 'string', 'ErrorType': 'string' }, ] }, ] }, ] }, ] }, 'ErrorInfo': { 'ErrorMessage': 'string', 'ErrorType': 'string' }, 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **Arn** *(string) --* The Amazon Resource Name (ARN) for the snapshot job. The job ARN is generated when you start a new job with a "StartDashboardSnapshotJob" API call. * **JobStatus** *(string) --* Indicates the status of a job after it has reached a terminal state. A finished snapshot job will retuen a "COMPLETED" or "FAILED" status. * **CreatedTime** *(datetime) --* The time that a snapshot job was created. * **LastUpdatedTime** *(datetime) --* The time that a snapshot job status was last updated. * **Result** *(dict) --* The result of the snapshot job. Jobs that have successfully completed will return the S3Uri where they are located. Jobs that have failedwill return information on the error that caused the job to fail. * **AnonymousUsers** *(list) --* A list of "AnonymousUserSnapshotJobResult" objects that contain information on anonymous users and their user configurations. This data provided by you when you make a "StartDashboardSnapshotJob" API call. * *(dict) --* A structure that contains the file groups that are requested for the artifact generation in a "StartDashboardSnapshotJob" API call. * **FileGroups** *(list) --* A list of "SnapshotJobResultFileGroup" objects that contain information on the files that are requested during a "StartDashboardSnapshotJob" API call. If the job succeeds, these objects contain the location where the snapshot artifacts are stored. If the job fails, the objects contain information about the error that caused the job to fail. * *(dict) --* A structure that contains information on the generated snapshot file groups. * **Files** *(list) --* A list of "SnapshotFile" objects. * *(dict) --* A structure that contains the information for the snapshot that you want to generate. This information is provided by you when you start a new snapshot job. * **SheetSelections** *(list) --* A list of "SnapshotFileSheetSelection" objects that contain information on the dashboard sheet that is exported. These objects provide information about the snapshot artifacts that are generated during the job. This structure can hold a maximum of 5 CSV configurations, 5 Excel configurations, or 1 configuration for PDF. * *(dict) --* A structure that contains information that identifies the snapshot that needs to be generated. * **SheetId** *(string) --* The sheet ID of the dashboard to generate the snapshot artifact from. This value is required for CSV, Excel, and PDF format types. * **SelectionScope** *(string) --* The selection scope of the visuals on a sheet of a dashboard that you are generating a snapthot of. You can choose one of the following options. * "ALL_VISUALS" - Selects all visuals that are on the sheet. This value is required if the snapshot is a PDF. * "SELECTED_VISUALS" - Select the visual that you want to add to the snapshot. This value is required if the snapshot is a CSV or Excel workbook. * **VisualIds** *(list) --* A structure that lists the IDs of the visuals in the selected sheet. Supported visual types are table, pivot table visuals. This value is required if you are generating a CSV or Excel workbook. This value supports a maximum of 1 visual ID for CSV and 5 visual IDs across up to 5 sheet selections for Excel. If you are generating an Excel workbook, the order of the visual IDs provided in this structure determines the order of the worksheets in the Excel file. * *(string) --* * **FormatType** *(string) --* The format of the snapshot file to be generated. You can choose between "CSV", "Excel", or "PDF". * **S3Results** *(list) --* A list of "SnapshotJobS3Result" objects. * *(dict) --* The Amazon S3 result from the snapshot job. The result includes the "DestinationConfiguration" and the Amazon S3 Uri. If an error occured during the job, the result returns information on the error. * **S3DestinationConfiguration** *(dict) --* A list of Amazon S3 bucket configurations that are provided when you make a "StartDashboardSnapshotJob" API call. * **BucketConfiguration** *(dict) --* A structure that contains details about the Amazon S3 bucket that the generated dashboard snapshot is saved in. * **BucketName** *(string) --* The name of an existing Amazon S3 bucket where the generated snapshot artifacts are sent. * **BucketPrefix** *(string) --* The prefix of the Amazon S3 bucket that the generated snapshots are stored in. * **BucketRegion** *(string) --* The region that the Amazon S3 bucket is located in. The bucket must be located in the same region that the "StartDashboardSnapshotJob" API call is made. * **S3Uri** *(string) --* The Amazon S3 Uri. * **ErrorInfo** *(list) --* An array of error records that describe any failures that occur while the dashboard snapshot job runs. * *(dict) --* Information on the error that caused the snapshot job to fail. * **ErrorMessage** *(string) --* The error message. * **ErrorType** *(string) --* The error type. * **ErrorInfo** *(dict) --* Displays information for the error that caused a job to fail. * **ErrorMessage** *(string) --* The error message. * **ErrorType** *(string) --* The error type. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.PreconditionNotMetException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / update_data_set_permissions update_data_set_permissions *************************** QuickSight.Client.update_data_set_permissions(**kwargs) Updates the permissions on a dataset. The permissions resource is "arn:aws:quicksight:region:aws-account- id:dataset/data-set-id". See also: AWS API Documentation **Request Syntax** response = client.update_data_set_permissions( AwsAccountId='string', DataSetId='string', GrantPermissions=[ { 'Principal': 'string', 'Actions': [ 'string', ] }, ], RevokePermissions=[ { 'Principal': 'string', 'Actions': [ 'string', ] }, ] ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The Amazon Web Services account ID. * **DataSetId** (*string*) -- **[REQUIRED]** 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. * **GrantPermissions** (*list*) -- The resource permissions that you want to grant to the dataset. * *(dict) --* Permission for the resource. * **Principal** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the principal. This can be one of the following: * The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.) * The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.) * The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.) * **Actions** *(list) --* **[REQUIRED]** The IAM action to grant or revoke permissions on. * *(string) --* * **RevokePermissions** (*list*) -- The resource permissions that you want to revoke from the dataset. * *(dict) --* Permission for the resource. * **Principal** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the principal. This can be one of the following: * The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.) * The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.) * The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.) * **Actions** *(list) --* **[REQUIRED]** The IAM action to grant or revoke permissions on. * *(string) --* Return type: dict Returns: **Response Syntax** { 'DataSetArn': 'string', 'DataSetId': 'string', 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **DataSetArn** *(string) --* The Amazon Resource Name (ARN) of the dataset. * **DataSetId** *(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. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / update_theme_permissions update_theme_permissions ************************ QuickSight.Client.update_theme_permissions(**kwargs) Updates the resource permissions for a theme. Permissions apply to the action to grant or revoke permissions on, for example ""quicksight:DescribeTheme"". Theme permissions apply in groupings. Valid groupings include the following for the three levels of permissions, which are user, owner, or no permissions: * User * ""quicksight:DescribeTheme"" * ""quicksight:DescribeThemeAlias"" * ""quicksight:ListThemeAliases"" * ""quicksight:ListThemeVersions"" * Owner * ""quicksight:DescribeTheme"" * ""quicksight:DescribeThemeAlias"" * ""quicksight:ListThemeAliases"" * ""quicksight:ListThemeVersions"" * ""quicksight:DeleteTheme"" * ""quicksight:UpdateTheme"" * ""quicksight:CreateThemeAlias"" * ""quicksight:DeleteThemeAlias"" * ""quicksight:UpdateThemeAlias"" * ""quicksight:UpdateThemePermissions"" * ""quicksight:DescribeThemePermissions"" * To specify no permissions, omit the permissions list. See also: AWS API Documentation **Request Syntax** response = client.update_theme_permissions( AwsAccountId='string', ThemeId='string', GrantPermissions=[ { 'Principal': 'string', 'Actions': [ 'string', ] }, ], RevokePermissions=[ { 'Principal': 'string', 'Actions': [ 'string', ] }, ] ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the theme. * **ThemeId** (*string*) -- **[REQUIRED]** The ID for the theme. * **GrantPermissions** (*list*) -- A list of resource permissions to be granted for the theme. * *(dict) --* Permission for the resource. * **Principal** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the principal. This can be one of the following: * The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.) * The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.) * The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.) * **Actions** *(list) --* **[REQUIRED]** The IAM action to grant or revoke permissions on. * *(string) --* * **RevokePermissions** (*list*) -- A list of resource permissions to be revoked from the theme. * *(dict) --* Permission for the resource. * **Principal** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the principal. This can be one of the following: * The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.) * The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.) * The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.) * **Actions** *(list) --* **[REQUIRED]** The IAM action to grant or revoke permissions on. * *(string) --* Return type: dict Returns: **Response Syntax** { 'ThemeId': 'string', 'ThemeArn': 'string', 'Permissions': [ { 'Principal': 'string', 'Actions': [ 'string', ] }, ], 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **ThemeId** *(string) --* The ID for the theme. * **ThemeArn** *(string) --* The Amazon Resource Name (ARN) of the theme. * **Permissions** *(list) --* The resulting list of resource permissions for the theme. * *(dict) --* Permission for the resource. * **Principal** *(string) --* The Amazon Resource Name (ARN) of the principal. This can be one of the following: * The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.) * The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.) * The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.) * **Actions** *(list) --* The IAM action to grant or revoke permissions on. * *(string) --* * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.LimitExceededException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / create_template_alias create_template_alias ********************* QuickSight.Client.create_template_alias(**kwargs) Creates a template alias for a template. See also: AWS API Documentation **Request Syntax** response = client.create_template_alias( AwsAccountId='string', TemplateId='string', AliasName='string', TemplateVersionNumber=123 ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the template that you creating an alias for. * **TemplateId** (*string*) -- **[REQUIRED]** An ID for the template. * **AliasName** (*string*) -- **[REQUIRED]** 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. * **TemplateVersionNumber** (*integer*) -- **[REQUIRED]** The version number of the template. Return type: dict Returns: **Response Syntax** { 'TemplateAlias': { 'AliasName': 'string', 'Arn': 'string', 'TemplateVersionNumber': 123 }, 'Status': 123, 'RequestId': 'string' } **Response Structure** * *(dict) --* * **TemplateAlias** *(dict) --* Information about the template alias. * **AliasName** *(string) --* The display name of the template alias. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the template alias. * **TemplateVersionNumber** *(integer) --* The version number of the template alias. * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.ResourceExistsException" * "QuickSight.Client.exceptions.LimitExceededException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / list_topics list_topics *********** QuickSight.Client.list_topics(**kwargs) Lists all of the topics within an account. See also: AWS API Documentation **Request Syntax** response = client.list_topics( AwsAccountId='string', NextToken='string', MaxResults=123 ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the topics that you want to list. * **NextToken** (*string*) -- The token for the next set of results, or null if there are no more results. * **MaxResults** (*integer*) -- The maximum number of results to be returned per request. Return type: dict Returns: **Response Syntax** { 'TopicsSummaries': [ { 'Arn': 'string', 'TopicId': 'string', 'Name': 'string', 'UserExperienceVersion': 'LEGACY'|'NEW_READER_EXPERIENCE' }, ], 'NextToken': 'string', 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **TopicsSummaries** *(list) --* A list of topic summaries. * *(dict) --* A topic summary. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the topic. * **TopicId** *(string) --* The ID for the topic. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. * **Name** *(string) --* The name of the topic. * **UserExperienceVersion** *(string) --* The user experience version of the topic. * **NextToken** *(string) --* The token for the next set of results, or null if there are no more results. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InvalidNextTokenException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / describe_template_permissions describe_template_permissions ***************************** QuickSight.Client.describe_template_permissions(**kwargs) Describes read and write permissions on a template. See also: AWS API Documentation **Request Syntax** response = client.describe_template_permissions( AwsAccountId='string', TemplateId='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the template that you're describing. * **TemplateId** (*string*) -- **[REQUIRED]** The ID for the template. Return type: dict Returns: **Response Syntax** { 'TemplateId': 'string', 'TemplateArn': 'string', 'Permissions': [ { 'Principal': 'string', 'Actions': [ 'string', ] }, ], 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **TemplateId** *(string) --* The ID for the template. * **TemplateArn** *(string) --* The Amazon Resource Name (ARN) of the template. * **Permissions** *(list) --* A list of resource permissions to be set on the template. * *(dict) --* Permission for the resource. * **Principal** *(string) --* The Amazon Resource Name (ARN) of the principal. This can be one of the following: * The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.) * The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.) * The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.) * **Actions** *(list) --* The IAM action to grant or revoke permissions on. * *(string) --* * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / delete_account_customization delete_account_customization **************************** QuickSight.Client.delete_account_customization(**kwargs) Deletes all Amazon QuickSight customizations in this Amazon Web Services Region for the specified Amazon Web Services account and Amazon QuickSight namespace. See also: AWS API Documentation **Request Syntax** response = client.delete_account_customization( AwsAccountId='string', Namespace='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID for the Amazon Web Services account that you want to delete Amazon QuickSight customizations from in this Amazon Web Services Region. * **Namespace** (*string*) -- The Amazon QuickSight namespace that you're deleting the customizations from. Return type: dict Returns: **Response Syntax** { 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.LimitExceededException" * "QuickSight.Client.exceptions.PreconditionNotMetException" * "QuickSight.Client.exceptions.InternalFailureException" * "QuickSight.Client.exceptions.ResourceUnavailableException" QuickSight / Client / delete_identity_propagation_config delete_identity_propagation_config ********************************** QuickSight.Client.delete_identity_propagation_config(**kwargs) Deletes all access scopes and authorized targets that are associated with a service from the Amazon QuickSight IAM Identity Center application. This operation is only supported for Amazon QuickSight accounts that use IAM Identity Center. See also: AWS API Documentation **Request Syntax** response = client.delete_identity_propagation_config( AwsAccountId='string', Service='REDSHIFT'|'QBUSINESS'|'ATHENA' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that you want to delete an identity propagation configuration from. * **Service** (*string*) -- **[REQUIRED]** The name of the Amazon Web Services service that you want to delete the associated access scopes and authorized targets from. Return type: dict Returns: **Response Syntax** { 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / delete_template_alias delete_template_alias ********************* QuickSight.Client.delete_template_alias(**kwargs) Deletes the item that the specified template alias points to. If you provide a specific alias, you delete the version of the template that the alias points to. See also: AWS API Documentation **Request Syntax** response = client.delete_template_alias( AwsAccountId='string', TemplateId='string', AliasName='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the item to delete. * **TemplateId** (*string*) -- **[REQUIRED]** The ID for the template that the specified alias is for. * **AliasName** (*string*) -- **[REQUIRED]** 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. Return type: dict Returns: **Response Syntax** { 'Status': 123, 'TemplateId': 'string', 'AliasName': 'string', 'Arn': 'string', 'RequestId': 'string' } **Response Structure** * *(dict) --* * **Status** *(integer) --* The HTTP status of the request. * **TemplateId** *(string) --* An ID for the template associated with the deletion. * **AliasName** *(string) --* The name for the template alias. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the template you want to delete. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / delete_data_source delete_data_source ****************** QuickSight.Client.delete_data_source(**kwargs) Deletes the data source permanently. This operation breaks all the datasets that reference the deleted data source. See also: AWS API Documentation **Request Syntax** response = client.delete_data_source( AwsAccountId='string', DataSourceId='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The Amazon Web Services account ID. * **DataSourceId** (*string*) -- **[REQUIRED]** The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. Return type: dict Returns: **Response Syntax** { 'Arn': 'string', 'DataSourceId': 'string', 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **Arn** *(string) --* The Amazon Resource Name (ARN) of the data source that you deleted. * **DataSourceId** *(string) --* The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / update_user update_user *********** QuickSight.Client.update_user(**kwargs) Updates an Amazon QuickSight user. See also: AWS API Documentation **Request Syntax** response = client.update_user( UserName='string', AwsAccountId='string', Namespace='string', Email='string', Role='ADMIN'|'AUTHOR'|'READER'|'RESTRICTED_AUTHOR'|'RESTRICTED_READER'|'ADMIN_PRO'|'AUTHOR_PRO'|'READER_PRO', CustomPermissionsName='string', UnapplyCustomPermissions=True|False, ExternalLoginFederationProviderType='string', CustomFederationProviderUrl='string', ExternalLoginId='string' ) Parameters: * **UserName** (*string*) -- **[REQUIRED]** The Amazon QuickSight user name that you want to update. * **AwsAccountId** (*string*) -- **[REQUIRED]** 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** (*string*) -- **[REQUIRED]** The namespace. Currently, you should set this to "default". * **Email** (*string*) -- **[REQUIRED]** The email address of the user that you want to update. * **Role** (*string*) -- **[REQUIRED]** The Amazon QuickSight role of the user. The role can be one of the following default security cohorts: * "READER": A user who has read-only access to dashboards. * "AUTHOR": A user who can create data sources, datasets, analyses, and dashboards. * "ADMIN": A user who is an author, who can also manage Amazon QuickSight settings. * "READER_PRO": Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Amazon QuickSight, can build stories with Amazon Q, and can generate executive summaries from dashboards. * "AUTHOR_PRO": Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&A, and generate executive summaries from dashboards. * "ADMIN_PRO": Admin Pros are Author Pros who can also manage Amazon QuickSight administrative settings. Admin Pro users are billed at Author Pro pricing. The name of the Amazon QuickSight role is invisible to the user except for the console screens dealing with permissions. * **CustomPermissionsName** (*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. * **UnapplyCustomPermissions** (*boolean*) -- 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. * **ExternalLoginFederationProviderType** (*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. * **CustomFederationProviderUrl** (*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". * **ExternalLoginId** (*string*) -- The identity ID for a user in the external login provider. Return type: dict Returns: **Response Syntax** { 'User': { 'Arn': 'string', 'UserName': 'string', 'Email': 'string', 'Role': 'ADMIN'|'AUTHOR'|'READER'|'RESTRICTED_AUTHOR'|'RESTRICTED_READER'|'ADMIN_PRO'|'AUTHOR_PRO'|'READER_PRO', 'IdentityType': 'IAM'|'QUICKSIGHT'|'IAM_IDENTITY_CENTER', 'Active': True|False, 'PrincipalId': 'string', 'CustomPermissionsName': 'string', 'ExternalLoginFederationProviderType': 'string', 'ExternalLoginFederationProviderUrl': 'string', 'ExternalLoginId': 'string' }, 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **User** *(dict) --* The Amazon QuickSight user. * **Arn** *(string) --* The Amazon Resource Name (ARN) for the user. * **UserName** *(string) --* The user's user name. This value is required if you are registering a user that will be managed in Amazon QuickSight. In the output, the value for "UserName" is "N/A" when the value for "IdentityType" is "IAM" and the corresponding IAM user is deleted. * **Email** *(string) --* The user's email address. * **Role** *(string) --* The Amazon QuickSight role for the user. The user role can be one of the following:. * "READER": A user who has read-only access to dashboards. * "AUTHOR": A user who can create data sources, datasets, analyses, and dashboards. * "ADMIN": A user who is an author, who can also manage Amazon Amazon QuickSight settings. * "READER_PRO": Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Amazon QuickSight, can build stories with Amazon Q, and can generate executive summaries from dashboards. * "AUTHOR_PRO": Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&A, and generate executive summaries from dashboards. * "ADMIN_PRO": Admin Pros are Author Pros who can also manage Amazon QuickSight administrative settings. Admin Pro users are billed at Author Pro pricing. * "RESTRICTED_READER": This role isn't currently available for use. * "RESTRICTED_AUTHOR": This role isn't currently available for use. * **IdentityType** *(string) --* The type of identity authentication used by the user. * **Active** *(boolean) --* The active status of user. When you create an Amazon QuickSight user that's not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a password. * **PrincipalId** *(string) --* The principal ID of the user. * **CustomPermissionsName** *(string) --* The custom permissions profile associated with this user. * **ExternalLoginFederationProviderType** *(string) --* The type of supported external login provider that provides identity to let the user federate into Amazon QuickSight with an associated IAM role. The type can be one of the following. * "COGNITO": Amazon Cognito. The provider URL is cognito- identity.amazonaws.com. * "CUSTOM_OIDC": Custom OpenID Connect (OIDC) provider. * **ExternalLoginFederationProviderUrl** *(string) --* The URL of the external login provider. * **ExternalLoginId** *(string) --* The identity ID for the user in the external login provider. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.PreconditionNotMetException" * "QuickSight.Client.exceptions.InternalFailureException" * "QuickSight.Client.exceptions.ResourceUnavailableException" QuickSight / Client / search_groups search_groups ************* QuickSight.Client.search_groups(**kwargs) Use the "SearchGroups" operation to search groups in a specified Amazon QuickSight namespace using the supplied filters. See also: AWS API Documentation **Request Syntax** response = client.search_groups( AwsAccountId='string', NextToken='string', MaxResults=123, Namespace='string', Filters=[ { 'Operator': 'StartsWith', 'Name': 'GROUP_NAME', 'Value': 'string' }, ] ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** 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. * **NextToken** (*string*) -- A pagination token that can be used in a subsequent request. * **MaxResults** (*integer*) -- The maximum number of results to return from this request. * **Namespace** (*string*) -- **[REQUIRED]** The namespace that you want to search. * **Filters** (*list*) -- **[REQUIRED]** The structure for the search filters that you want to apply to your search. * *(dict) --* A "GroupSearchFilter" object that you want to apply to your search. * **Operator** *(string) --* **[REQUIRED]** The comparison operator that you want to use as a filter, for example ""Operator": "StartsWith"". Currently, the only supported operator is "StartsWith". * **Name** *(string) --* **[REQUIRED]** The name of the value that you want to use as a filter, for example ""Name": "GROUP_NAME"". Currently, the only supported name is "GROUP_NAME". * **Value** *(string) --* **[REQUIRED]** The value of the named item, in this case "GROUP_NAME", that you want to use as a filter. Return type: dict Returns: **Response Syntax** { 'GroupList': [ { 'Arn': 'string', 'GroupName': 'string', 'Description': 'string', 'PrincipalId': 'string' }, ], 'NextToken': 'string', 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **GroupList** *(list) --* A list of groups in a specified namespace that match the filters you set in your "SearchGroups" request. * *(dict) --* A *group* in Amazon QuickSight consists of a set of users. You can use groups to make it easier to manage access and security. * **Arn** *(string) --* The Amazon Resource Name (ARN) for the group. * **GroupName** *(string) --* The name of the group. * **Description** *(string) --* The group description. * **PrincipalId** *(string) --* The principal ID of the group. * **NextToken** *(string) --* A pagination token that can be used in a subsequent request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InvalidNextTokenException" * "QuickSight.Client.exceptions.PreconditionNotMetException" * "QuickSight.Client.exceptions.InternalFailureException" * "QuickSight.Client.exceptions.ResourceUnavailableException" QuickSight / Client / list_ingestions list_ingestions *************** QuickSight.Client.list_ingestions(**kwargs) Lists the history of SPICE ingestions for a dataset. Limited to 5 TPS per user and 25 TPS per account. See also: AWS API Documentation **Request Syntax** response = client.list_ingestions( DataSetId='string', NextToken='string', AwsAccountId='string', MaxResults=123 ) Parameters: * **DataSetId** (*string*) -- **[REQUIRED]** The ID of the dataset used in the ingestion. * **NextToken** (*string*) -- The token for the next set of results, or null if there are no more results. * **AwsAccountId** (*string*) -- **[REQUIRED]** The Amazon Web Services account ID. * **MaxResults** (*integer*) -- The maximum number of results to be returned per request. Return type: dict Returns: **Response Syntax** { 'Ingestions': [ { 'Arn': 'string', 'IngestionId': 'string', 'IngestionStatus': 'INITIALIZED'|'QUEUED'|'RUNNING'|'FAILED'|'COMPLETED'|'CANCELLED', 'ErrorInfo': { 'Type': 'FAILURE_TO_ASSUME_ROLE'|'INGESTION_SUPERSEDED'|'INGESTION_CANCELED'|'DATA_SET_DELETED'|'DATA_SET_NOT_SPICE'|'S3_UPLOADED_FILE_DELETED'|'S3_MANIFEST_ERROR'|'DATA_TOLERANCE_EXCEPTION'|'SPICE_TABLE_NOT_FOUND'|'DATA_SET_SIZE_LIMIT_EXCEEDED'|'ROW_SIZE_LIMIT_EXCEEDED'|'ACCOUNT_CAPACITY_LIMIT_EXCEEDED'|'CUSTOMER_ERROR'|'DATA_SOURCE_NOT_FOUND'|'IAM_ROLE_NOT_AVAILABLE'|'CONNECTION_FAILURE'|'SQL_TABLE_NOT_FOUND'|'PERMISSION_DENIED'|'SSL_CERTIFICATE_VALIDATION_FAILURE'|'OAUTH_TOKEN_FAILURE'|'SOURCE_API_LIMIT_EXCEEDED_FAILURE'|'PASSWORD_AUTHENTICATION_FAILURE'|'SQL_SCHEMA_MISMATCH_ERROR'|'INVALID_DATE_FORMAT'|'INVALID_DATAPREP_SYNTAX'|'SOURCE_RESOURCE_LIMIT_EXCEEDED'|'SQL_INVALID_PARAMETER_VALUE'|'QUERY_TIMEOUT'|'SQL_NUMERIC_OVERFLOW'|'UNRESOLVABLE_HOST'|'UNROUTABLE_HOST'|'SQL_EXCEPTION'|'S3_FILE_INACCESSIBLE'|'IOT_FILE_NOT_FOUND'|'IOT_DATA_SET_FILE_EMPTY'|'INVALID_DATA_SOURCE_CONFIG'|'DATA_SOURCE_AUTH_FAILED'|'DATA_SOURCE_CONNECTION_FAILED'|'FAILURE_TO_PROCESS_JSON_FILE'|'INTERNAL_SERVICE_ERROR'|'REFRESH_SUPPRESSED_BY_EDIT'|'PERMISSION_NOT_FOUND'|'ELASTICSEARCH_CURSOR_NOT_ENABLED'|'CURSOR_NOT_ENABLED'|'DUPLICATE_COLUMN_NAMES_FOUND', 'Message': 'string' }, 'RowInfo': { 'RowsIngested': 123, 'RowsDropped': 123, 'TotalRowsInDataset': 123 }, 'QueueInfo': { 'WaitingOnIngestion': 'string', 'QueuedIngestion': 'string' }, 'CreatedTime': datetime(2015, 1, 1), 'IngestionTimeInSeconds': 123, 'IngestionSizeInBytes': 123, 'RequestSource': 'MANUAL'|'SCHEDULED', 'RequestType': 'INITIAL_INGESTION'|'EDIT'|'INCREMENTAL_REFRESH'|'FULL_REFRESH' }, ], 'NextToken': 'string', 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **Ingestions** *(list) --* A list of the ingestions. * *(dict) --* Information about the SPICE ingestion for a dataset. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the resource. * **IngestionId** *(string) --* Ingestion ID. * **IngestionStatus** *(string) --* Ingestion status. * **ErrorInfo** *(dict) --* Error information for this ingestion. * **Type** *(string) --* Error type. * **Message** *(string) --* Error message. * **RowInfo** *(dict) --* Information about rows for a data set SPICE ingestion. * **RowsIngested** *(integer) --* The number of rows that were ingested. * **RowsDropped** *(integer) --* The number of rows that were not ingested. * **TotalRowsInDataset** *(integer) --* The total number of rows in the dataset. * **QueueInfo** *(dict) --* Information about a queued dataset SPICE ingestion. * **WaitingOnIngestion** *(string) --* The ID of the queued ingestion. * **QueuedIngestion** *(string) --* The ID of the ongoing ingestion. The queued ingestion is waiting for the ongoing ingestion to complete. * **CreatedTime** *(datetime) --* The time that this ingestion started. * **IngestionTimeInSeconds** *(integer) --* The time that this ingestion took, measured in seconds. * **IngestionSizeInBytes** *(integer) --* The size of the data ingested, in bytes. * **RequestSource** *(string) --* Event source for this ingestion. * **RequestType** *(string) --* Type of this ingestion. * **NextToken** *(string) --* The token for the next set of results, or null if there are no more results. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.ResourceExistsException" * "QuickSight.Client.exceptions.InvalidNextTokenException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / describe_folder_permissions describe_folder_permissions *************************** QuickSight.Client.describe_folder_permissions(**kwargs) Describes permissions for a folder. See also: AWS API Documentation **Request Syntax** response = client.describe_folder_permissions( AwsAccountId='string', FolderId='string', Namespace='string', MaxResults=123, NextToken='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID for the Amazon Web Services account that contains the folder. * **FolderId** (*string*) -- **[REQUIRED]** The ID of the folder. * **Namespace** (*string*) -- The namespace of the folder whose permissions you want described. * **MaxResults** (*integer*) -- The maximum number of results to be returned per request. * **NextToken** (*string*) -- A pagination token for the next set of results. Return type: dict Returns: **Response Syntax** { 'Status': 123, 'FolderId': 'string', 'Arn': 'string', 'Permissions': [ { 'Principal': 'string', 'Actions': [ 'string', ] }, ], 'RequestId': 'string', 'NextToken': 'string' } **Response Structure** * *(dict) --* * **Status** *(integer) --* The HTTP status of the request. * **FolderId** *(string) --* The ID of the folder. * **Arn** *(string) --* The Amazon Resource Name (ARN) for the folder. * **Permissions** *(list) --* Information about the permissions on the folder. * *(dict) --* Permission for the resource. * **Principal** *(string) --* The Amazon Resource Name (ARN) of the principal. This can be one of the following: * The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.) * The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.) * The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.) * **Actions** *(list) --* The IAM action to grant or revoke permissions on. * *(string) --* * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **NextToken** *(string) --* The pagination token for the next set of results, or null if there are no more results. **Exceptions** * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InvalidNextTokenException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / cancel_ingestion cancel_ingestion **************** QuickSight.Client.cancel_ingestion(**kwargs) Cancels an ongoing ingestion of data into SPICE. See also: AWS API Documentation **Request Syntax** response = client.cancel_ingestion( AwsAccountId='string', DataSetId='string', IngestionId='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The Amazon Web Services account ID. * **DataSetId** (*string*) -- **[REQUIRED]** The ID of the dataset used in the ingestion. * **IngestionId** (*string*) -- **[REQUIRED]** An ID for the ingestion. Return type: dict Returns: **Response Syntax** { 'Arn': 'string', 'IngestionId': 'string', 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **Arn** *(string) --* The Amazon Resource Name (ARN) for the data ingestion. * **IngestionId** *(string) --* An ID for the ingestion. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.ResourceExistsException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / create_data_source create_data_source ****************** QuickSight.Client.create_data_source(**kwargs) Creates a data source. See also: AWS API Documentation **Request Syntax** response = client.create_data_source( AwsAccountId='string', DataSourceId='string', Name='string', Type='ADOBE_ANALYTICS'|'AMAZON_ELASTICSEARCH'|'ATHENA'|'AURORA'|'AURORA_POSTGRESQL'|'AWS_IOT_ANALYTICS'|'GITHUB'|'JIRA'|'MARIADB'|'MYSQL'|'ORACLE'|'POSTGRESQL'|'PRESTO'|'REDSHIFT'|'S3'|'SALESFORCE'|'SERVICENOW'|'SNOWFLAKE'|'SPARK'|'SQLSERVER'|'TERADATA'|'TWITTER'|'TIMESTREAM'|'AMAZON_OPENSEARCH'|'EXASOL'|'DATABRICKS'|'STARBURST'|'TRINO'|'BIGQUERY', DataSourceParameters={ 'AmazonElasticsearchParameters': { 'Domain': 'string' }, 'AthenaParameters': { 'WorkGroup': 'string', 'RoleArn': 'string', 'IdentityCenterConfiguration': { 'EnableIdentityPropagation': True|False } }, 'AuroraParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'AuroraPostgreSqlParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'AwsIotAnalyticsParameters': { 'DataSetName': 'string' }, 'JiraParameters': { 'SiteBaseUrl': 'string' }, 'MariaDbParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'MySqlParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'OracleParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string', 'UseServiceName': True|False }, 'PostgreSqlParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'PrestoParameters': { 'Host': 'string', 'Port': 123, 'Catalog': 'string' }, 'RdsParameters': { 'InstanceId': 'string', 'Database': 'string' }, 'RedshiftParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string', 'ClusterId': 'string', 'IAMParameters': { 'RoleArn': 'string', 'DatabaseUser': 'string', 'DatabaseGroups': [ 'string', ], 'AutoCreateDatabaseUser': True|False }, 'IdentityCenterConfiguration': { 'EnableIdentityPropagation': True|False } }, 'S3Parameters': { 'ManifestFileLocation': { 'Bucket': 'string', 'Key': 'string' }, 'RoleArn': 'string' }, 'ServiceNowParameters': { 'SiteBaseUrl': 'string' }, 'SnowflakeParameters': { 'Host': 'string', 'Database': 'string', 'Warehouse': 'string', 'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509', 'DatabaseAccessControlRole': 'string', 'OAuthParameters': { 'TokenProviderUrl': 'string', 'OAuthScope': 'string', 'IdentityProviderVpcConnectionProperties': { 'VpcConnectionArn': 'string' }, 'IdentityProviderResourceUri': 'string' } }, 'SparkParameters': { 'Host': 'string', 'Port': 123 }, 'SqlServerParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'TeradataParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'TwitterParameters': { 'Query': 'string', 'MaxRows': 123 }, 'AmazonOpenSearchParameters': { 'Domain': 'string' }, 'ExasolParameters': { 'Host': 'string', 'Port': 123 }, 'DatabricksParameters': { 'Host': 'string', 'Port': 123, 'SqlEndpointPath': 'string' }, 'StarburstParameters': { 'Host': 'string', 'Port': 123, 'Catalog': 'string', 'ProductType': 'GALAXY'|'ENTERPRISE', 'DatabaseAccessControlRole': 'string', 'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509', 'OAuthParameters': { 'TokenProviderUrl': 'string', 'OAuthScope': 'string', 'IdentityProviderVpcConnectionProperties': { 'VpcConnectionArn': 'string' }, 'IdentityProviderResourceUri': 'string' } }, 'TrinoParameters': { 'Host': 'string', 'Port': 123, 'Catalog': 'string' }, 'BigQueryParameters': { 'ProjectId': 'string', 'DataSetRegion': 'string' }, 'ImpalaParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string', 'SqlEndpointPath': 'string' } }, Credentials={ 'CredentialPair': { 'Username': 'string', 'Password': 'string', 'AlternateDataSourceParameters': [ { 'AmazonElasticsearchParameters': { 'Domain': 'string' }, 'AthenaParameters': { 'WorkGroup': 'string', 'RoleArn': 'string', 'IdentityCenterConfiguration': { 'EnableIdentityPropagation': True|False } }, 'AuroraParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'AuroraPostgreSqlParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'AwsIotAnalyticsParameters': { 'DataSetName': 'string' }, 'JiraParameters': { 'SiteBaseUrl': 'string' }, 'MariaDbParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'MySqlParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'OracleParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string', 'UseServiceName': True|False }, 'PostgreSqlParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'PrestoParameters': { 'Host': 'string', 'Port': 123, 'Catalog': 'string' }, 'RdsParameters': { 'InstanceId': 'string', 'Database': 'string' }, 'RedshiftParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string', 'ClusterId': 'string', 'IAMParameters': { 'RoleArn': 'string', 'DatabaseUser': 'string', 'DatabaseGroups': [ 'string', ], 'AutoCreateDatabaseUser': True|False }, 'IdentityCenterConfiguration': { 'EnableIdentityPropagation': True|False } }, 'S3Parameters': { 'ManifestFileLocation': { 'Bucket': 'string', 'Key': 'string' }, 'RoleArn': 'string' }, 'ServiceNowParameters': { 'SiteBaseUrl': 'string' }, 'SnowflakeParameters': { 'Host': 'string', 'Database': 'string', 'Warehouse': 'string', 'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509', 'DatabaseAccessControlRole': 'string', 'OAuthParameters': { 'TokenProviderUrl': 'string', 'OAuthScope': 'string', 'IdentityProviderVpcConnectionProperties': { 'VpcConnectionArn': 'string' }, 'IdentityProviderResourceUri': 'string' } }, 'SparkParameters': { 'Host': 'string', 'Port': 123 }, 'SqlServerParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'TeradataParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'TwitterParameters': { 'Query': 'string', 'MaxRows': 123 }, 'AmazonOpenSearchParameters': { 'Domain': 'string' }, 'ExasolParameters': { 'Host': 'string', 'Port': 123 }, 'DatabricksParameters': { 'Host': 'string', 'Port': 123, 'SqlEndpointPath': 'string' }, 'StarburstParameters': { 'Host': 'string', 'Port': 123, 'Catalog': 'string', 'ProductType': 'GALAXY'|'ENTERPRISE', 'DatabaseAccessControlRole': 'string', 'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509', 'OAuthParameters': { 'TokenProviderUrl': 'string', 'OAuthScope': 'string', 'IdentityProviderVpcConnectionProperties': { 'VpcConnectionArn': 'string' }, 'IdentityProviderResourceUri': 'string' } }, 'TrinoParameters': { 'Host': 'string', 'Port': 123, 'Catalog': 'string' }, 'BigQueryParameters': { 'ProjectId': 'string', 'DataSetRegion': 'string' }, 'ImpalaParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string', 'SqlEndpointPath': 'string' } }, ] }, 'CopySourceArn': 'string', 'SecretArn': 'string' }, Permissions=[ { 'Principal': 'string', 'Actions': [ 'string', ] }, ], VpcConnectionProperties={ 'VpcConnectionArn': 'string' }, SslProperties={ 'DisableSsl': True|False }, Tags=[ { 'Key': 'string', 'Value': 'string' }, ], FolderArns=[ 'string', ] ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The Amazon Web Services account ID. * **DataSourceId** (*string*) -- **[REQUIRED]** An ID for the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. * **Name** (*string*) -- **[REQUIRED]** A display name for the data source. * **Type** (*string*) -- **[REQUIRED]** The type of the data source. To return a list of all data sources, use "ListDataSources". Use "AMAZON_ELASTICSEARCH" for Amazon OpenSearch Service. * **DataSourceParameters** (*dict*) -- The parameters that Amazon QuickSight uses to connect to your underlying source. * **AmazonElasticsearchParameters** *(dict) --* The parameters for OpenSearch. * **Domain** *(string) --* **[REQUIRED]** The OpenSearch domain. * **AthenaParameters** *(dict) --* The parameters for Amazon Athena. * **WorkGroup** *(string) --* The workgroup that Amazon Athena uses. * **RoleArn** *(string) --* Use the "RoleArn" structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use "RoleArn" to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active. * **IdentityCenterConfiguration** *(dict) --* An optional parameter that configures IAM Identity Center authentication to grant Amazon QuickSight access to your workgroup. This parameter can only be specified if your Amazon QuickSight account is configured with IAM Identity Center. * **EnableIdentityPropagation** *(boolean) --* A Boolean option that controls whether Trusted Identity Propagation should be used. * **AuroraParameters** *(dict) --* The parameters for Amazon Aurora MySQL. * **Host** *(string) --* **[REQUIRED]** Host. * **Port** *(integer) --* **[REQUIRED]** Port. * **Database** *(string) --* **[REQUIRED]** Database. * **AuroraPostgreSqlParameters** *(dict) --* The parameters for Amazon Aurora. * **Host** *(string) --* **[REQUIRED]** The Amazon Aurora PostgreSQL-Compatible host to connect to. * **Port** *(integer) --* **[REQUIRED]** The port that Amazon Aurora PostgreSQL is listening on. * **Database** *(string) --* **[REQUIRED]** The Amazon Aurora PostgreSQL database to connect to. * **AwsIotAnalyticsParameters** *(dict) --* The parameters for IoT Analytics. * **DataSetName** *(string) --* **[REQUIRED]** Dataset name. * **JiraParameters** *(dict) --* The parameters for Jira. * **SiteBaseUrl** *(string) --* **[REQUIRED]** The base URL of the Jira site. * **MariaDbParameters** *(dict) --* The parameters for MariaDB. * **Host** *(string) --* **[REQUIRED]** Host. * **Port** *(integer) --* **[REQUIRED]** Port. * **Database** *(string) --* **[REQUIRED]** Database. * **MySqlParameters** *(dict) --* The parameters for MySQL. * **Host** *(string) --* **[REQUIRED]** Host. * **Port** *(integer) --* **[REQUIRED]** Port. * **Database** *(string) --* **[REQUIRED]** Database. * **OracleParameters** *(dict) --* The parameters for Oracle. * **Host** *(string) --* **[REQUIRED]** An Oracle host. * **Port** *(integer) --* **[REQUIRED]** The port. * **Database** *(string) --* **[REQUIRED]** The database. * **UseServiceName** *(boolean) --* A Boolean value that indicates whether the "Database" uses a service name or an SID. If this value is left blank, the default value is "SID". If this value is set to "false", the value is "SID". * **PostgreSqlParameters** *(dict) --* The parameters for PostgreSQL. * **Host** *(string) --* **[REQUIRED]** Host. * **Port** *(integer) --* **[REQUIRED]** Port. * **Database** *(string) --* **[REQUIRED]** Database. * **PrestoParameters** *(dict) --* The parameters for Presto. * **Host** *(string) --* **[REQUIRED]** Host. * **Port** *(integer) --* **[REQUIRED]** Port. * **Catalog** *(string) --* **[REQUIRED]** Catalog. * **RdsParameters** *(dict) --* The parameters for Amazon RDS. * **InstanceId** *(string) --* **[REQUIRED]** Instance ID. * **Database** *(string) --* **[REQUIRED]** Database. * **RedshiftParameters** *(dict) --* The parameters for Amazon Redshift. * **Host** *(string) --* Host. This field can be blank if "ClusterId" is provided. * **Port** *(integer) --* Port. This field can be blank if the "ClusterId" is provided. * **Database** *(string) --* **[REQUIRED]** Database. * **ClusterId** *(string) --* Cluster ID. This field can be blank if the "Host" and "Port" are provided. * **IAMParameters** *(dict) --* An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials. * **RoleArn** *(string) --* **[REQUIRED]** Use the "RoleArn" structure to allow Amazon QuickSight to call "redshift:GetClusterCredentials" on your cluster. The calling principal must have "iam:PassRole" access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role. * **DatabaseUser** *(string) --* The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of "AutoCreateDatabaseUser" to "True" to create a new user with PUBLIC permissions. * **DatabaseGroups** *(list) --* A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the "DatabaseUser". If you choose to include this parameter, the "RoleArn" must grant access to "redshift:JoinGroup". * *(string) --* * **AutoCreateDatabaseUser** *(boolean) --* Automatically creates a database user. If your database doesn't have a "DatabaseUser", set this parameter to "True". If there is no "DatabaseUser", Amazon QuickSight can't connect to your cluster. The "RoleArn" that you use for this operation must grant access to "redshift:CreateClusterUser" to successfully create the user. * **IdentityCenterConfiguration** *(dict) --* An optional parameter that configures IAM Identity Center authentication to grant Amazon QuickSight access to your cluster. This parameter can only be specified if your Amazon QuickSight account is configured with IAM Identity Center. * **EnableIdentityPropagation** *(boolean) --* A Boolean option that controls whether Trusted Identity Propagation should be used. * **S3Parameters** *(dict) --* The parameters for S3. * **ManifestFileLocation** *(dict) --* **[REQUIRED]** Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight. * **Bucket** *(string) --* **[REQUIRED]** Amazon S3 bucket. * **Key** *(string) --* **[REQUIRED]** Amazon S3 key that identifies an object. * **RoleArn** *(string) --* Use the "RoleArn" structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use "RoleArn" to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active. * **ServiceNowParameters** *(dict) --* The parameters for ServiceNow. * **SiteBaseUrl** *(string) --* **[REQUIRED]** URL of the base site. * **SnowflakeParameters** *(dict) --* The parameters for Snowflake. * **Host** *(string) --* **[REQUIRED]** Host. * **Database** *(string) --* **[REQUIRED]** Database. * **Warehouse** *(string) --* **[REQUIRED]** Warehouse. * **AuthenticationType** *(string) --* The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types. * **DatabaseAccessControlRole** *(string) --* The database access control role. * **OAuthParameters** *(dict) --* An object that contains information needed to create a data source connection between an Amazon QuickSight account and Snowflake. * **TokenProviderUrl** *(string) --* **[REQUIRED]** The token endpoint URL of the identity provider. * **OAuthScope** *(string) --* The OAuth scope. * **IdentityProviderVpcConnectionProperties** *(dict) --* VPC connection properties. * **VpcConnectionArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) for the VPC connection. * **IdentityProviderResourceUri** *(string) --* The resource uri of the identity provider. * **SparkParameters** *(dict) --* The parameters for Spark. * **Host** *(string) --* **[REQUIRED]** Host. * **Port** *(integer) --* **[REQUIRED]** Port. * **SqlServerParameters** *(dict) --* The parameters for SQL Server. * **Host** *(string) --* **[REQUIRED]** Host. * **Port** *(integer) --* **[REQUIRED]** Port. * **Database** *(string) --* **[REQUIRED]** Database. * **TeradataParameters** *(dict) --* The parameters for Teradata. * **Host** *(string) --* **[REQUIRED]** Host. * **Port** *(integer) --* **[REQUIRED]** Port. * **Database** *(string) --* **[REQUIRED]** Database. * **TwitterParameters** *(dict) --* The parameters for Twitter. * **Query** *(string) --* **[REQUIRED]** Twitter query string. * **MaxRows** *(integer) --* **[REQUIRED]** Maximum number of rows to query Twitter. * **AmazonOpenSearchParameters** *(dict) --* The parameters for OpenSearch. * **Domain** *(string) --* **[REQUIRED]** The OpenSearch domain. * **ExasolParameters** *(dict) --* The parameters for Exasol. * **Host** *(string) --* **[REQUIRED]** The hostname or IP address of the Exasol data source. * **Port** *(integer) --* **[REQUIRED]** The port for the Exasol data source. * **DatabricksParameters** *(dict) --* The parameters that are required to connect to a Databricks data source. * **Host** *(string) --* **[REQUIRED]** The host name of the Databricks data source. * **Port** *(integer) --* **[REQUIRED]** The port for the Databricks data source. * **SqlEndpointPath** *(string) --* **[REQUIRED]** The HTTP path of the Databricks data source. * **StarburstParameters** *(dict) --* The parameters that are required to connect to a Starburst data source. * **Host** *(string) --* **[REQUIRED]** The host name of the Starburst data source. * **Port** *(integer) --* **[REQUIRED]** The port for the Starburst data source. * **Catalog** *(string) --* **[REQUIRED]** The catalog name for the Starburst data source. * **ProductType** *(string) --* The product type for the Starburst data source. * **DatabaseAccessControlRole** *(string) --* The database access control role. * **AuthenticationType** *(string) --* The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types. * **OAuthParameters** *(dict) --* An object that contains information needed to create a data source connection between an Amazon QuickSight account and Starburst. * **TokenProviderUrl** *(string) --* **[REQUIRED]** The token endpoint URL of the identity provider. * **OAuthScope** *(string) --* The OAuth scope. * **IdentityProviderVpcConnectionProperties** *(dict) --* VPC connection properties. * **VpcConnectionArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) for the VPC connection. * **IdentityProviderResourceUri** *(string) --* The resource uri of the identity provider. * **TrinoParameters** *(dict) --* The parameters that are required to connect to a Trino data source. * **Host** *(string) --* **[REQUIRED]** The host name of the Trino data source. * **Port** *(integer) --* **[REQUIRED]** The port for the Trino data source. * **Catalog** *(string) --* **[REQUIRED]** The catalog name for the Trino data source. * **BigQueryParameters** *(dict) --* The parameters that are required to connect to a Google BigQuery data source. * **ProjectId** *(string) --* **[REQUIRED]** The Google Cloud Platform project ID where your datasource was created. * **DataSetRegion** *(string) --* The storage location where you create a Google BigQuery data source. * **ImpalaParameters** *(dict) --* The parameters for Impala. * **Host** *(string) --* **[REQUIRED]** The host name of the Impala data source. * **Port** *(integer) --* **[REQUIRED]** The port of the Impala data source. * **Database** *(string) --* The database of the Impala data source. * **SqlEndpointPath** *(string) --* **[REQUIRED]** The HTTP path of the Impala data source. * **Credentials** (*dict*) -- The credentials Amazon QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported. * **CredentialPair** *(dict) --* Credential pair. For more information, see >>``<>``<<. * **Username** *(string) --* **[REQUIRED]** User name. * **Password** *(string) --* **[REQUIRED]** Password. * **AlternateDataSourceParameters** *(list) --* A set of alternate data source parameters that you want to share for these credentials. The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the "DataSourceParameters" structure that's in the request with the structures in the "AlternateDataSourceParameters" allow list. If the structures are an exact match, the request is allowed to use the new data source with the existing credentials. If the "AlternateDataSourceParameters" list is null, the "DataSourceParameters" originally used with these "Credentials" is automatically allowed. * *(dict) --* The parameters that Amazon QuickSight uses to connect to your underlying data source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null. * **AmazonElasticsearchParameters** *(dict) --* The parameters for OpenSearch. * **Domain** *(string) --* **[REQUIRED]** The OpenSearch domain. * **AthenaParameters** *(dict) --* The parameters for Amazon Athena. * **WorkGroup** *(string) --* The workgroup that Amazon Athena uses. * **RoleArn** *(string) --* Use the "RoleArn" structure to override an account- wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use "RoleArn" to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active. * **IdentityCenterConfiguration** *(dict) --* An optional parameter that configures IAM Identity Center authentication to grant Amazon QuickSight access to your workgroup. This parameter can only be specified if your Amazon QuickSight account is configured with IAM Identity Center. * **EnableIdentityPropagation** *(boolean) --* A Boolean option that controls whether Trusted Identity Propagation should be used. * **AuroraParameters** *(dict) --* The parameters for Amazon Aurora MySQL. * **Host** *(string) --* **[REQUIRED]** Host. * **Port** *(integer) --* **[REQUIRED]** Port. * **Database** *(string) --* **[REQUIRED]** Database. * **AuroraPostgreSqlParameters** *(dict) --* The parameters for Amazon Aurora. * **Host** *(string) --* **[REQUIRED]** The Amazon Aurora PostgreSQL-Compatible host to connect to. * **Port** *(integer) --* **[REQUIRED]** The port that Amazon Aurora PostgreSQL is listening on. * **Database** *(string) --* **[REQUIRED]** The Amazon Aurora PostgreSQL database to connect to. * **AwsIotAnalyticsParameters** *(dict) --* The parameters for IoT Analytics. * **DataSetName** *(string) --* **[REQUIRED]** Dataset name. * **JiraParameters** *(dict) --* The parameters for Jira. * **SiteBaseUrl** *(string) --* **[REQUIRED]** The base URL of the Jira site. * **MariaDbParameters** *(dict) --* The parameters for MariaDB. * **Host** *(string) --* **[REQUIRED]** Host. * **Port** *(integer) --* **[REQUIRED]** Port. * **Database** *(string) --* **[REQUIRED]** Database. * **MySqlParameters** *(dict) --* The parameters for MySQL. * **Host** *(string) --* **[REQUIRED]** Host. * **Port** *(integer) --* **[REQUIRED]** Port. * **Database** *(string) --* **[REQUIRED]** Database. * **OracleParameters** *(dict) --* The parameters for Oracle. * **Host** *(string) --* **[REQUIRED]** An Oracle host. * **Port** *(integer) --* **[REQUIRED]** The port. * **Database** *(string) --* **[REQUIRED]** The database. * **UseServiceName** *(boolean) --* A Boolean value that indicates whether the "Database" uses a service name or an SID. If this value is left blank, the default value is "SID". If this value is set to "false", the value is "SID". * **PostgreSqlParameters** *(dict) --* The parameters for PostgreSQL. * **Host** *(string) --* **[REQUIRED]** Host. * **Port** *(integer) --* **[REQUIRED]** Port. * **Database** *(string) --* **[REQUIRED]** Database. * **PrestoParameters** *(dict) --* The parameters for Presto. * **Host** *(string) --* **[REQUIRED]** Host. * **Port** *(integer) --* **[REQUIRED]** Port. * **Catalog** *(string) --* **[REQUIRED]** Catalog. * **RdsParameters** *(dict) --* The parameters for Amazon RDS. * **InstanceId** *(string) --* **[REQUIRED]** Instance ID. * **Database** *(string) --* **[REQUIRED]** Database. * **RedshiftParameters** *(dict) --* The parameters for Amazon Redshift. * **Host** *(string) --* Host. This field can be blank if "ClusterId" is provided. * **Port** *(integer) --* Port. This field can be blank if the "ClusterId" is provided. * **Database** *(string) --* **[REQUIRED]** Database. * **ClusterId** *(string) --* Cluster ID. This field can be blank if the "Host" and "Port" are provided. * **IAMParameters** *(dict) --* An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials. * **RoleArn** *(string) --* **[REQUIRED]** Use the "RoleArn" structure to allow Amazon QuickSight to call "redshift:GetClusterCredentials" on your cluster. The calling principal must have "iam:PassRole" access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role. * **DatabaseUser** *(string) --* The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of "AutoCreateDatabaseUser" to "True" to create a new user with PUBLIC permissions. * **DatabaseGroups** *(list) --* A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the "DatabaseUser". If you choose to include this parameter, the "RoleArn" must grant access to "redshift:JoinGroup". * *(string) --* * **AutoCreateDatabaseUser** *(boolean) --* Automatically creates a database user. If your database doesn't have a "DatabaseUser", set this parameter to "True". If there is no "DatabaseUser", Amazon QuickSight can't connect to your cluster. The "RoleArn" that you use for this operation must grant access to "redshift:CreateClusterUser" to successfully create the user. * **IdentityCenterConfiguration** *(dict) --* An optional parameter that configures IAM Identity Center authentication to grant Amazon QuickSight access to your cluster. This parameter can only be specified if your Amazon QuickSight account is configured with IAM Identity Center. * **EnableIdentityPropagation** *(boolean) --* A Boolean option that controls whether Trusted Identity Propagation should be used. * **S3Parameters** *(dict) --* The parameters for S3. * **ManifestFileLocation** *(dict) --* **[REQUIRED]** Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight. * **Bucket** *(string) --* **[REQUIRED]** Amazon S3 bucket. * **Key** *(string) --* **[REQUIRED]** Amazon S3 key that identifies an object. * **RoleArn** *(string) --* Use the "RoleArn" structure to override an account- wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use "RoleArn" to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active. * **ServiceNowParameters** *(dict) --* The parameters for ServiceNow. * **SiteBaseUrl** *(string) --* **[REQUIRED]** URL of the base site. * **SnowflakeParameters** *(dict) --* The parameters for Snowflake. * **Host** *(string) --* **[REQUIRED]** Host. * **Database** *(string) --* **[REQUIRED]** Database. * **Warehouse** *(string) --* **[REQUIRED]** Warehouse. * **AuthenticationType** *(string) --* The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types. * **DatabaseAccessControlRole** *(string) --* The database access control role. * **OAuthParameters** *(dict) --* An object that contains information needed to create a data source connection between an Amazon QuickSight account and Snowflake. * **TokenProviderUrl** *(string) --* **[REQUIRED]** The token endpoint URL of the identity provider. * **OAuthScope** *(string) --* The OAuth scope. * **IdentityProviderVpcConnectionProperties** *(dict) --* VPC connection properties. * **VpcConnectionArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) for the VPC connection. * **IdentityProviderResourceUri** *(string) --* The resource uri of the identity provider. * **SparkParameters** *(dict) --* The parameters for Spark. * **Host** *(string) --* **[REQUIRED]** Host. * **Port** *(integer) --* **[REQUIRED]** Port. * **SqlServerParameters** *(dict) --* The parameters for SQL Server. * **Host** *(string) --* **[REQUIRED]** Host. * **Port** *(integer) --* **[REQUIRED]** Port. * **Database** *(string) --* **[REQUIRED]** Database. * **TeradataParameters** *(dict) --* The parameters for Teradata. * **Host** *(string) --* **[REQUIRED]** Host. * **Port** *(integer) --* **[REQUIRED]** Port. * **Database** *(string) --* **[REQUIRED]** Database. * **TwitterParameters** *(dict) --* The parameters for Twitter. * **Query** *(string) --* **[REQUIRED]** Twitter query string. * **MaxRows** *(integer) --* **[REQUIRED]** Maximum number of rows to query Twitter. * **AmazonOpenSearchParameters** *(dict) --* The parameters for OpenSearch. * **Domain** *(string) --* **[REQUIRED]** The OpenSearch domain. * **ExasolParameters** *(dict) --* The parameters for Exasol. * **Host** *(string) --* **[REQUIRED]** The hostname or IP address of the Exasol data source. * **Port** *(integer) --* **[REQUIRED]** The port for the Exasol data source. * **DatabricksParameters** *(dict) --* The parameters that are required to connect to a Databricks data source. * **Host** *(string) --* **[REQUIRED]** The host name of the Databricks data source. * **Port** *(integer) --* **[REQUIRED]** The port for the Databricks data source. * **SqlEndpointPath** *(string) --* **[REQUIRED]** The HTTP path of the Databricks data source. * **StarburstParameters** *(dict) --* The parameters that are required to connect to a Starburst data source. * **Host** *(string) --* **[REQUIRED]** The host name of the Starburst data source. * **Port** *(integer) --* **[REQUIRED]** The port for the Starburst data source. * **Catalog** *(string) --* **[REQUIRED]** The catalog name for the Starburst data source. * **ProductType** *(string) --* The product type for the Starburst data source. * **DatabaseAccessControlRole** *(string) --* The database access control role. * **AuthenticationType** *(string) --* The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types. * **OAuthParameters** *(dict) --* An object that contains information needed to create a data source connection between an Amazon QuickSight account and Starburst. * **TokenProviderUrl** *(string) --* **[REQUIRED]** The token endpoint URL of the identity provider. * **OAuthScope** *(string) --* The OAuth scope. * **IdentityProviderVpcConnectionProperties** *(dict) --* VPC connection properties. * **VpcConnectionArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) for the VPC connection. * **IdentityProviderResourceUri** *(string) --* The resource uri of the identity provider. * **TrinoParameters** *(dict) --* The parameters that are required to connect to a Trino data source. * **Host** *(string) --* **[REQUIRED]** The host name of the Trino data source. * **Port** *(integer) --* **[REQUIRED]** The port for the Trino data source. * **Catalog** *(string) --* **[REQUIRED]** The catalog name for the Trino data source. * **BigQueryParameters** *(dict) --* The parameters that are required to connect to a Google BigQuery data source. * **ProjectId** *(string) --* **[REQUIRED]** The Google Cloud Platform project ID where your datasource was created. * **DataSetRegion** *(string) --* The storage location where you create a Google BigQuery data source. * **ImpalaParameters** *(dict) --* The parameters for Impala. * **Host** *(string) --* **[REQUIRED]** The host name of the Impala data source. * **Port** *(integer) --* **[REQUIRED]** The port of the Impala data source. * **Database** *(string) --* The database of the Impala data source. * **SqlEndpointPath** *(string) --* **[REQUIRED]** The HTTP path of the Impala data source. * **CopySourceArn** *(string) --* The Amazon Resource Name (ARN) of a data source that has the credential pair that you want to use. When "CopySourceArn" is not null, the credential pair from the data source in the ARN is used as the credentials for the "DataSourceCredentials" structure. * **SecretArn** *(string) --* The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager. * **Permissions** (*list*) -- A list of resource permissions on the data source. * *(dict) --* Permission for the resource. * **Principal** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the principal. This can be one of the following: * The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.) * The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.) * The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.) * **Actions** *(list) --* **[REQUIRED]** The IAM action to grant or revoke permissions on. * *(string) --* * **VpcConnectionProperties** (*dict*) -- Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source. * **VpcConnectionArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) for the VPC connection. * **SslProperties** (*dict*) -- Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source. * **DisableSsl** *(boolean) --* A Boolean option to control whether SSL should be disabled. * **Tags** (*list*) -- Contains a map of the key-value pairs for the resource tag or tags assigned to the data source. * *(dict) --* The key or keys of the key-value pairs for the resource tag or tags assigned to the resource. * **Key** *(string) --* **[REQUIRED]** Tag key. * **Value** *(string) --* **[REQUIRED]** Tag value. * **FolderArns** (*list*) -- When you create the data source, Amazon QuickSight adds the data source to these folders. * *(string) --* Return type: dict Returns: **Response Syntax** { 'Arn': 'string', 'DataSourceId': 'string', 'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED', 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **Arn** *(string) --* The Amazon Resource Name (ARN) of the data source. * **DataSourceId** *(string) --* The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. * **CreationStatus** *(string) --* The status of creating the data source. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.LimitExceededException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ResourceExistsException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.CustomerManagedKeyUnavailableExcep tion" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / delete_namespace delete_namespace **************** QuickSight.Client.delete_namespace(**kwargs) Deletes a namespace and the users and groups that are associated with the namespace. This is an asynchronous process. Assets including dashboards, analyses, datasets and data sources are not deleted. To delete these assets, you use the API operations for the relevant asset. See also: AWS API Documentation **Request Syntax** response = client.delete_namespace( AwsAccountId='string', Namespace='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID for the Amazon Web Services account that you want to delete the Amazon QuickSight namespace from. * **Namespace** (*string*) -- **[REQUIRED]** The namespace that you want to delete. Return type: dict Returns: **Response Syntax** { 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.PreconditionNotMetException" * "QuickSight.Client.exceptions.InternalFailureException" * "QuickSight.Client.exceptions.ResourceUnavailableException" QuickSight / Client / update_topic update_topic ************ QuickSight.Client.update_topic(**kwargs) Updates a topic. See also: AWS API Documentation **Request Syntax** response = client.update_topic( AwsAccountId='string', TopicId='string', Topic={ 'Name': 'string', 'Description': 'string', 'UserExperienceVersion': 'LEGACY'|'NEW_READER_EXPERIENCE', 'DataSets': [ { 'DatasetArn': 'string', 'DatasetName': 'string', 'DatasetDescription': 'string', 'DataAggregation': { 'DatasetRowDateGranularity': 'SECOND'|'MINUTE'|'HOUR'|'DAY'|'WEEK'|'MONTH'|'QUARTER'|'YEAR', 'DefaultDateColumnName': 'string' }, 'Filters': [ { 'FilterDescription': 'string', 'FilterClass': 'ENFORCED_VALUE_FILTER'|'CONDITIONAL_VALUE_FILTER'|'NAMED_VALUE_FILTER', 'FilterName': 'string', 'FilterSynonyms': [ 'string', ], 'OperandFieldName': 'string', 'FilterType': 'CATEGORY_FILTER'|'NUMERIC_EQUALITY_FILTER'|'NUMERIC_RANGE_FILTER'|'DATE_RANGE_FILTER'|'RELATIVE_DATE_FILTER', 'CategoryFilter': { 'CategoryFilterFunction': 'EXACT'|'CONTAINS', 'CategoryFilterType': 'CUSTOM_FILTER'|'CUSTOM_FILTER_LIST'|'FILTER_LIST', 'Constant': { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'SingularConstant': 'string', 'CollectiveConstant': { 'ValueList': [ 'string', ] } }, 'Inverse': True|False }, 'NumericEqualityFilter': { 'Constant': { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'SingularConstant': 'string' }, 'Aggregation': 'NO_AGGREGATION'|'SUM'|'AVERAGE'|'COUNT'|'DISTINCT_COUNT'|'MAX'|'MEDIAN'|'MIN'|'STDEV'|'STDEVP'|'VAR'|'VARP' }, 'NumericRangeFilter': { 'Inclusive': True|False, 'Constant': { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'RangeConstant': { 'Minimum': 'string', 'Maximum': 'string' } }, 'Aggregation': 'NO_AGGREGATION'|'SUM'|'AVERAGE'|'COUNT'|'DISTINCT_COUNT'|'MAX'|'MEDIAN'|'MIN'|'STDEV'|'STDEVP'|'VAR'|'VARP' }, 'DateRangeFilter': { 'Inclusive': True|False, 'Constant': { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'RangeConstant': { 'Minimum': 'string', 'Maximum': 'string' } } }, 'RelativeDateFilter': { 'TimeGranularity': 'SECOND'|'MINUTE'|'HOUR'|'DAY'|'WEEK'|'MONTH'|'QUARTER'|'YEAR', 'RelativeDateFilterFunction': 'PREVIOUS'|'THIS'|'LAST'|'NEXT'|'NOW', 'Constant': { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'SingularConstant': 'string' } } }, ], 'Columns': [ { 'ColumnName': 'string', 'ColumnFriendlyName': 'string', 'ColumnDescription': 'string', 'ColumnSynonyms': [ 'string', ], 'ColumnDataRole': 'DIMENSION'|'MEASURE', 'Aggregation': 'SUM'|'MAX'|'MIN'|'COUNT'|'DISTINCT_COUNT'|'AVERAGE'|'MEDIAN'|'STDEV'|'STDEVP'|'VAR'|'VARP', 'IsIncludedInTopic': True|False, 'DisableIndexing': True|False, 'ComparativeOrder': { 'UseOrdering': 'GREATER_IS_BETTER'|'LESSER_IS_BETTER'|'SPECIFIED', 'SpecifedOrder': [ 'string', ], 'TreatUndefinedSpecifiedValues': 'LEAST'|'MOST' }, 'SemanticType': { 'TypeName': 'string', 'SubTypeName': 'string', 'TypeParameters': { 'string': 'string' }, 'TruthyCellValue': 'string', 'TruthyCellValueSynonyms': [ 'string', ], 'FalseyCellValue': 'string', 'FalseyCellValueSynonyms': [ 'string', ] }, 'TimeGranularity': 'SECOND'|'MINUTE'|'HOUR'|'DAY'|'WEEK'|'MONTH'|'QUARTER'|'YEAR', 'AllowedAggregations': [ 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX'|'MEDIAN'|'SUM'|'AVERAGE'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE', ], 'NotAllowedAggregations': [ 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX'|'MEDIAN'|'SUM'|'AVERAGE'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE', ], 'DefaultFormatting': { 'DisplayFormat': 'AUTO'|'PERCENT'|'CURRENCY'|'NUMBER'|'DATE'|'STRING', 'DisplayFormatOptions': { 'UseBlankCellFormat': True|False, 'BlankCellFormat': 'string', 'DateFormat': 'string', 'DecimalSeparator': 'COMMA'|'DOT', 'GroupingSeparator': 'string', 'UseGrouping': True|False, 'FractionDigits': 123, 'Prefix': 'string', 'Suffix': 'string', 'UnitScaler': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS'|'LAKHS'|'CRORES', 'NegativeFormat': { 'Prefix': 'string', 'Suffix': 'string' }, 'CurrencySymbol': 'string' } }, 'NeverAggregateInFilter': True|False, 'CellValueSynonyms': [ { 'CellValue': 'string', 'Synonyms': [ 'string', ] }, ], 'NonAdditive': True|False }, ], 'CalculatedFields': [ { 'CalculatedFieldName': 'string', 'CalculatedFieldDescription': 'string', 'Expression': 'string', 'CalculatedFieldSynonyms': [ 'string', ], 'IsIncludedInTopic': True|False, 'DisableIndexing': True|False, 'ColumnDataRole': 'DIMENSION'|'MEASURE', 'TimeGranularity': 'SECOND'|'MINUTE'|'HOUR'|'DAY'|'WEEK'|'MONTH'|'QUARTER'|'YEAR', 'DefaultFormatting': { 'DisplayFormat': 'AUTO'|'PERCENT'|'CURRENCY'|'NUMBER'|'DATE'|'STRING', 'DisplayFormatOptions': { 'UseBlankCellFormat': True|False, 'BlankCellFormat': 'string', 'DateFormat': 'string', 'DecimalSeparator': 'COMMA'|'DOT', 'GroupingSeparator': 'string', 'UseGrouping': True|False, 'FractionDigits': 123, 'Prefix': 'string', 'Suffix': 'string', 'UnitScaler': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS'|'LAKHS'|'CRORES', 'NegativeFormat': { 'Prefix': 'string', 'Suffix': 'string' }, 'CurrencySymbol': 'string' } }, 'Aggregation': 'SUM'|'MAX'|'MIN'|'COUNT'|'DISTINCT_COUNT'|'AVERAGE'|'MEDIAN'|'STDEV'|'STDEVP'|'VAR'|'VARP', 'ComparativeOrder': { 'UseOrdering': 'GREATER_IS_BETTER'|'LESSER_IS_BETTER'|'SPECIFIED', 'SpecifedOrder': [ 'string', ], 'TreatUndefinedSpecifiedValues': 'LEAST'|'MOST' }, 'SemanticType': { 'TypeName': 'string', 'SubTypeName': 'string', 'TypeParameters': { 'string': 'string' }, 'TruthyCellValue': 'string', 'TruthyCellValueSynonyms': [ 'string', ], 'FalseyCellValue': 'string', 'FalseyCellValueSynonyms': [ 'string', ] }, 'AllowedAggregations': [ 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX'|'MEDIAN'|'SUM'|'AVERAGE'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE', ], 'NotAllowedAggregations': [ 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX'|'MEDIAN'|'SUM'|'AVERAGE'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE', ], 'NeverAggregateInFilter': True|False, 'CellValueSynonyms': [ { 'CellValue': 'string', 'Synonyms': [ 'string', ] }, ], 'NonAdditive': True|False }, ], 'NamedEntities': [ { 'EntityName': 'string', 'EntityDescription': 'string', 'EntitySynonyms': [ 'string', ], 'SemanticEntityType': { 'TypeName': 'string', 'SubTypeName': 'string', 'TypeParameters': { 'string': 'string' } }, 'Definition': [ { 'FieldName': 'string', 'PropertyName': 'string', 'PropertyRole': 'PRIMARY'|'ID', 'PropertyUsage': 'INHERIT'|'DIMENSION'|'MEASURE', 'Metric': { 'Aggregation': 'SUM'|'MIN'|'MAX'|'COUNT'|'AVERAGE'|'DISTINCT_COUNT'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE'|'MEDIAN'|'CUSTOM', 'AggregationFunctionParameters': { 'string': 'string' } } }, ] }, ] }, ], 'ConfigOptions': { 'QBusinessInsightsEnabled': True|False } }, CustomInstructions={ 'CustomInstructionsString': 'string' } ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the topic that you want to update. * **TopicId** (*string*) -- **[REQUIRED]** The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. * **Topic** (*dict*) -- **[REQUIRED]** The definition of the topic that you want to update. * **Name** *(string) --* The name of the topic. * **Description** *(string) --* The description of the topic. * **UserExperienceVersion** *(string) --* The user experience version of a topic. * **DataSets** *(list) --* The data sets that the topic is associated with. * *(dict) --* A structure that represents a dataset. * **DatasetArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the dataset. * **DatasetName** *(string) --* The name of the dataset. * **DatasetDescription** *(string) --* The description of the dataset. * **DataAggregation** *(dict) --* The definition of a data aggregation. * **DatasetRowDateGranularity** *(string) --* The level of time precision that is used to aggregate "DateTime" values. * **DefaultDateColumnName** *(string) --* The column name for the default date. * **Filters** *(list) --* The list of filter definitions. * *(dict) --* A structure that represents a filter used to select items for a topic. * **FilterDescription** *(string) --* A description of the filter used to select items for a topic. * **FilterClass** *(string) --* The class of the filter. Valid values for this structure are "ENFORCED_VALUE_FILTER", "CONDITIONAL_VALUE_FILTER", and "NAMED_VALUE_FILTER". * **FilterName** *(string) --* **[REQUIRED]** The name of the filter. * **FilterSynonyms** *(list) --* The other names or aliases for the filter. * *(string) --* * **OperandFieldName** *(string) --* **[REQUIRED]** The name of the field that the filter operates on. * **FilterType** *(string) --* The type of the filter. Valid values for this structure are "CATEGORY_FILTER", "NUMERIC_EQUALITY_FILTER", "NUMERIC_RANGE_FILTER", "DATE_RANGE_FILTER", and "RELATIVE_DATE_FILTER". * **CategoryFilter** *(dict) --* The category filter that is associated with this filter. * **CategoryFilterFunction** *(string) --* The category filter function. Valid values for this structure are "EXACT" and "CONTAINS". * **CategoryFilterType** *(string) --* The category filter type. This element is used to specify whether a filter is a simple category filter or an inverse category filter. * **Constant** *(dict) --* The constant used in a category filter. * **ConstantType** *(string) --* The type of category filter constant. This element is used to specify whether a constant is a singular or collective. Valid values are "SINGULAR" and "COLLECTIVE". * **SingularConstant** *(string) --* A singular constant used in a category filter. This element is used to specify a single value for the constant. * **CollectiveConstant** *(dict) --* A collective constant used in a category filter. This element is used to specify a list of values for the constant. * **ValueList** *(list) --* A list of values for the collective constant. * *(string) --* * **Inverse** *(boolean) --* A Boolean value that indicates if the filter is inverse. * **NumericEqualityFilter** *(dict) --* The numeric equality filter. * **Constant** *(dict) --* The constant used in a numeric equality filter. * **ConstantType** *(string) --* The type of the singular filter constant. Valid values for this structure are "SINGULAR". * **SingularConstant** *(string) --* The value of the singular filter constant. * **Aggregation** *(string) --* An aggregation function that specifies how to calculate the value of a numeric field for a topic. Valid values for this structure are "NO_AGGREGATION", "SUM", "AVERAGE", "COUNT", "DISTINCT_COUNT", "MAX", "MEDIAN", "MIN", "STDEV", "STDEVP", "VAR", and "VARP". * **NumericRangeFilter** *(dict) --* The numeric range filter. * **Inclusive** *(boolean) --* A Boolean value that indicates whether the endpoints of the numeric range are included in the filter. If set to true, topics whose numeric field value is equal to the endpoint values will be included in the filter. If set to false, topics whose numeric field value is equal to the endpoint values will be excluded from the filter. * **Constant** *(dict) --* The constant used in a numeric range filter. * **ConstantType** *(string) --* The data type of the constant value that is used in a range filter. Valid values for this structure are "RANGE". * **RangeConstant** *(dict) --* The value of the constant that is used to specify the endpoints of a range filter. * **Minimum** *(string) --* The minimum value for a range constant. * **Maximum** *(string) --* The maximum value for a range constant. * **Aggregation** *(string) --* An aggregation function that specifies how to calculate the value of a numeric field for a topic, Valid values for this structure are "NO_AGGREGATION", "SUM", "AVERAGE", "COUNT", "DISTINCT_COUNT", "MAX", "MEDIAN", "MIN", "STDEV", "STDEVP", "VAR", and "VARP". * **DateRangeFilter** *(dict) --* The date range filter. * **Inclusive** *(boolean) --* A Boolean value that indicates whether the date range filter should include the boundary values. If set to true, the filter includes the start and end dates. If set to false, the filter excludes them. * **Constant** *(dict) --* The constant used in a date range filter. * **ConstantType** *(string) --* The data type of the constant value that is used in a range filter. Valid values for this structure are "RANGE". * **RangeConstant** *(dict) --* The value of the constant that is used to specify the endpoints of a range filter. * **Minimum** *(string) --* The minimum value for a range constant. * **Maximum** *(string) --* The maximum value for a range constant. * **RelativeDateFilter** *(dict) --* The relative date filter. * **TimeGranularity** *(string) --* The level of time precision that is used to aggregate "DateTime" values. * **RelativeDateFilterFunction** *(string) --* The function to be used in a relative date filter to determine the range of dates to include in the results. Valid values for this structure are "BEFORE", "AFTER", and "BETWEEN". * **Constant** *(dict) --* The constant used in a relative date filter. * **ConstantType** *(string) --* The type of the singular filter constant. Valid values for this structure are "SINGULAR". * **SingularConstant** *(string) --* The value of the singular filter constant. * **Columns** *(list) --* The list of column definitions. * *(dict) --* Represents a column in a dataset. * **ColumnName** *(string) --* **[REQUIRED]** The name of the column. * **ColumnFriendlyName** *(string) --* A user-friendly name for the column. * **ColumnDescription** *(string) --* A description of the column and its contents. * **ColumnSynonyms** *(list) --* The other names or aliases for the column. * *(string) --* * **ColumnDataRole** *(string) --* The role of the column in the data. Valid values are "DIMENSION" and "MEASURE". * **Aggregation** *(string) --* The type of aggregation that is performed on the column data when it's queried. * **IsIncludedInTopic** *(boolean) --* A Boolean value that indicates whether the column is included in the query results. * **DisableIndexing** *(boolean) --* A Boolean value that indicates whether the column shows in the autocomplete functionality. * **ComparativeOrder** *(dict) --* The order in which data is displayed for the column when it's used in a comparative context. * **UseOrdering** *(string) --* The ordering type for a column. Valid values for this structure are "GREATER_IS_BETTER", "LESSER_IS_BETTER" and "SPECIFIED". * **SpecifedOrder** *(list) --* The list of columns to be used in the ordering. * *(string) --* * **TreatUndefinedSpecifiedValues** *(string) --* The treat of undefined specified values. Valid values for this structure are "LEAST" and "MOST". * **SemanticType** *(dict) --* The semantic type of data contained in the column. * **TypeName** *(string) --* The semantic type name. * **SubTypeName** *(string) --* The semantic type sub type name. * **TypeParameters** *(dict) --* The semantic type parameters. * *(string) --* * *(string) --* * **TruthyCellValue** *(string) --* The semantic type truthy cell value. * **TruthyCellValueSynonyms** *(list) --* The other names or aliases for the true cell value. * *(string) --* * **FalseyCellValue** *(string) --* The semantic type falsey cell value. * **FalseyCellValueSynonyms** *(list) --* The other names or aliases for the false cell value. * *(string) --* * **TimeGranularity** *(string) --* The level of time precision that is used to aggregate "DateTime" values. * **AllowedAggregations** *(list) --* The list of aggregation types that are allowed for the column. Valid values for this structure are "COUNT", "DISTINCT_COUNT", "MIN", "MAX", "MEDIAN", "SUM", "AVERAGE", "STDEV", "STDEVP", "VAR", "VARP", and "PERCENTILE". * *(string) --* * **NotAllowedAggregations** *(list) --* The list of aggregation types that are not allowed for the column. Valid values for this structure are "COUNT", "DISTINCT_COUNT", "MIN", "MAX", "MEDIAN", "SUM", "AVERAGE", "STDEV", "STDEVP", "VAR", "VARP", and "PERCENTILE". * *(string) --* * **DefaultFormatting** *(dict) --* The default formatting used for values in the column. * **DisplayFormat** *(string) --* The display format. Valid values for this structure are "AUTO", "PERCENT", "CURRENCY", "NUMBER", "DATE", and "STRING". * **DisplayFormatOptions** *(dict) --* The additional options for display formatting. * **UseBlankCellFormat** *(boolean) --* A Boolean value that indicates whether to use blank cell format. * **BlankCellFormat** *(string) --* Determines the blank cell format. * **DateFormat** *(string) --* Determines the "DateTime" format. * **DecimalSeparator** *(string) --* Determines the decimal separator. * **GroupingSeparator** *(string) --* Determines the grouping separator. * **UseGrouping** *(boolean) --* A Boolean value that indicates whether to use grouping. * **FractionDigits** *(integer) --* Determines the number of fraction digits. * **Prefix** *(string) --* The prefix value for a display format. * **Suffix** *(string) --* The suffix value for a display format. * **UnitScaler** *(string) --* The unit scaler. Valid values for this structure are: "NONE", "AUTO", "THOUSANDS", "MILLIONS", "BILLIONS", and "TRILLIONS". * **NegativeFormat** *(dict) --* The negative format. * **Prefix** *(string) --* The prefix for a negative format. * **Suffix** *(string) --* The suffix for a negative format. * **CurrencySymbol** *(string) --* The currency symbol, such as "USD". * **NeverAggregateInFilter** *(boolean) --* A Boolean value that indicates whether to aggregate the column data when it's used in a filter context. * **CellValueSynonyms** *(list) --* The other names or aliases for the column cell value. * *(dict) --* A structure that represents the cell value synonym. * **CellValue** *(string) --* The cell value. * **Synonyms** *(list) --* Other names or aliases for the cell value. * *(string) --* * **NonAdditive** *(boolean) --* The non additive value for the column. * **CalculatedFields** *(list) --* The list of calculated field definitions. * *(dict) --* A structure that represents a calculated field. * **CalculatedFieldName** *(string) --* **[REQUIRED]** The calculated field name. * **CalculatedFieldDescription** *(string) --* The calculated field description. * **Expression** *(string) --* **[REQUIRED]** The calculated field expression. * **CalculatedFieldSynonyms** *(list) --* The other names or aliases for the calculated field. * *(string) --* * **IsIncludedInTopic** *(boolean) --* A boolean value that indicates if a calculated field is included in the topic. * **DisableIndexing** *(boolean) --* A Boolean value that indicates if a calculated field is visible in the autocomplete. * **ColumnDataRole** *(string) --* The column data role for a calculated field. Valid values for this structure are "DIMENSION" and "MEASURE". * **TimeGranularity** *(string) --* The level of time precision that is used to aggregate "DateTime" values. * **DefaultFormatting** *(dict) --* The default formatting definition. * **DisplayFormat** *(string) --* The display format. Valid values for this structure are "AUTO", "PERCENT", "CURRENCY", "NUMBER", "DATE", and "STRING". * **DisplayFormatOptions** *(dict) --* The additional options for display formatting. * **UseBlankCellFormat** *(boolean) --* A Boolean value that indicates whether to use blank cell format. * **BlankCellFormat** *(string) --* Determines the blank cell format. * **DateFormat** *(string) --* Determines the "DateTime" format. * **DecimalSeparator** *(string) --* Determines the decimal separator. * **GroupingSeparator** *(string) --* Determines the grouping separator. * **UseGrouping** *(boolean) --* A Boolean value that indicates whether to use grouping. * **FractionDigits** *(integer) --* Determines the number of fraction digits. * **Prefix** *(string) --* The prefix value for a display format. * **Suffix** *(string) --* The suffix value for a display format. * **UnitScaler** *(string) --* The unit scaler. Valid values for this structure are: "NONE", "AUTO", "THOUSANDS", "MILLIONS", "BILLIONS", and "TRILLIONS". * **NegativeFormat** *(dict) --* The negative format. * **Prefix** *(string) --* The prefix for a negative format. * **Suffix** *(string) --* The suffix for a negative format. * **CurrencySymbol** *(string) --* The currency symbol, such as "USD". * **Aggregation** *(string) --* The default aggregation. Valid values for this structure are "SUM", "MAX", "MIN", "COUNT", "DISTINCT_COUNT", and "AVERAGE". * **ComparativeOrder** *(dict) --* The order in which data is displayed for the calculated field when it's used in a comparative context. * **UseOrdering** *(string) --* The ordering type for a column. Valid values for this structure are "GREATER_IS_BETTER", "LESSER_IS_BETTER" and "SPECIFIED". * **SpecifedOrder** *(list) --* The list of columns to be used in the ordering. * *(string) --* * **TreatUndefinedSpecifiedValues** *(string) --* The treat of undefined specified values. Valid values for this structure are "LEAST" and "MOST". * **SemanticType** *(dict) --* The semantic type. * **TypeName** *(string) --* The semantic type name. * **SubTypeName** *(string) --* The semantic type sub type name. * **TypeParameters** *(dict) --* The semantic type parameters. * *(string) --* * *(string) --* * **TruthyCellValue** *(string) --* The semantic type truthy cell value. * **TruthyCellValueSynonyms** *(list) --* The other names or aliases for the true cell value. * *(string) --* * **FalseyCellValue** *(string) --* The semantic type falsey cell value. * **FalseyCellValueSynonyms** *(list) --* The other names or aliases for the false cell value. * *(string) --* * **AllowedAggregations** *(list) --* The list of aggregation types that are allowed for the calculated field. Valid values for this structure are "COUNT", "DISTINCT_COUNT", "MIN", "MAX", "MEDIAN", "SUM", "AVERAGE", "STDEV", "STDEVP", "VAR", "VARP", and "PERCENTILE". * *(string) --* * **NotAllowedAggregations** *(list) --* The list of aggregation types that are not allowed for the calculated field. Valid values for this structure are "COUNT", "DISTINCT_COUNT", "MIN", "MAX", "MEDIAN", "SUM", "AVERAGE", "STDEV", "STDEVP", "VAR", "VARP", and "PERCENTILE". * *(string) --* * **NeverAggregateInFilter** *(boolean) --* A Boolean value that indicates whether to never aggregate calculated field in filters. * **CellValueSynonyms** *(list) --* The other names or aliases for the calculated field cell value. * *(dict) --* A structure that represents the cell value synonym. * **CellValue** *(string) --* The cell value. * **Synonyms** *(list) --* Other names or aliases for the cell value. * *(string) --* * **NonAdditive** *(boolean) --* The non additive for the table style target. * **NamedEntities** *(list) --* The list of named entities definitions. * *(dict) --* A structure that represents a named entity. * **EntityName** *(string) --* **[REQUIRED]** The name of the named entity. * **EntityDescription** *(string) --* The description of the named entity. * **EntitySynonyms** *(list) --* The other names or aliases for the named entity. * *(string) --* * **SemanticEntityType** *(dict) --* The type of named entity that a topic represents. * **TypeName** *(string) --* The semantic entity type name. * **SubTypeName** *(string) --* The semantic entity sub type name. * **TypeParameters** *(dict) --* The semantic entity type parameters. * *(string) --* * *(string) --* * **Definition** *(list) --* The definition of a named entity. * *(dict) --* A structure that represents a named entity. * **FieldName** *(string) --* The name of the entity. * **PropertyName** *(string) --* The property name to be used for the named entity. * **PropertyRole** *(string) --* The property role. Valid values for this structure are "PRIMARY" and "ID". * **PropertyUsage** *(string) --* The property usage. Valid values for this structure are "INHERIT", "DIMENSION", and "MEASURE". * **Metric** *(dict) --* The definition of a metric. * **Aggregation** *(string) --* The aggregation of a named entity. Valid values for this structure are "SUM", "MIN", "MAX", "COUNT", "AVERAGE", "DISTINCT_COUNT", "STDEV", "STDEVP", "VAR", "VARP", "PERCENTILE", "MEDIAN", and "CUSTOM". * **AggregationFunctionParameters** *(dict) --* The additional parameters for an aggregation function. * *(string) --* * *(string) --* * **ConfigOptions** *(dict) --* Configuration options for a "Topic". * **QBusinessInsightsEnabled** *(boolean) --* Enables Amazon Q Business Insights for a "Topic". * **CustomInstructions** (*dict*) -- Custom instructions for the topic. * **CustomInstructionsString** *(string) --* **[REQUIRED]** A text field for providing additional guidance or context for response generation. Return type: dict Returns: **Response Syntax** { 'TopicId': 'string', 'Arn': 'string', 'RefreshArn': 'string', 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **TopicId** *(string) --* The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the topic. * **RefreshArn** *(string) --* The Amazon Resource Name (ARN) of the topic refresh. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.LimitExceededException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ResourceExistsException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / delete_theme delete_theme ************ QuickSight.Client.delete_theme(**kwargs) Deletes a theme. See also: AWS API Documentation **Request Syntax** response = client.delete_theme( AwsAccountId='string', ThemeId='string', VersionNumber=123 ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the theme that you're deleting. * **ThemeId** (*string*) -- **[REQUIRED]** An ID for the theme that you want to delete. * **VersionNumber** (*integer*) -- 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. Return type: dict Returns: **Response Syntax** { 'Arn': 'string', 'RequestId': 'string', 'Status': 123, 'ThemeId': 'string' } **Response Structure** * *(dict) --* * **Arn** *(string) --* The Amazon Resource Name (ARN) of the resource. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. * **ThemeId** *(string) --* An ID for the theme. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / update_user_custom_permission update_user_custom_permission ***************************** QuickSight.Client.update_user_custom_permission(**kwargs) Updates a custom permissions profile for a user. See also: AWS API Documentation **Request Syntax** response = client.update_user_custom_permission( UserName='string', AwsAccountId='string', Namespace='string', CustomPermissionsName='string' ) Parameters: * **UserName** (*string*) -- **[REQUIRED]** The username of the user that you want to update custom permissions for. * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the custom permission configuration that you want to update. * **Namespace** (*string*) -- **[REQUIRED]** The namespace that the user belongs to. * **CustomPermissionsName** (*string*) -- **[REQUIRED]** The name of the custom permissions that you want to update. Return type: dict Returns: **Response Syntax** { 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.PreconditionNotMetException" * "QuickSight.Client.exceptions.InternalFailureException" * "QuickSight.Client.exceptions.ResourceUnavailableException" QuickSight / Client / describe_data_set_permissions describe_data_set_permissions ***************************** QuickSight.Client.describe_data_set_permissions(**kwargs) Describes the permissions on a dataset. The permissions resource is "arn:aws:quicksight:region:aws-account- id:dataset/data-set-id". See also: AWS API Documentation **Request Syntax** response = client.describe_data_set_permissions( AwsAccountId='string', DataSetId='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The Amazon Web Services account ID. * **DataSetId** (*string*) -- **[REQUIRED]** 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. Return type: dict Returns: **Response Syntax** { 'DataSetArn': 'string', 'DataSetId': 'string', 'Permissions': [ { 'Principal': 'string', 'Actions': [ 'string', ] }, ], 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **DataSetArn** *(string) --* The Amazon Resource Name (ARN) of the dataset. * **DataSetId** *(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** *(list) --* A list of resource permissions on the dataset. * *(dict) --* Permission for the resource. * **Principal** *(string) --* The Amazon Resource Name (ARN) of the principal. This can be one of the following: * The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.) * The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.) * The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.) * **Actions** *(list) --* The IAM action to grant or revoke permissions on. * *(string) --* * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / create_namespace create_namespace **************** QuickSight.Client.create_namespace(**kwargs) (Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight. A namespace allows you to isolate the Amazon QuickSight users and groups that are registered for that namespace. Users that access the namespace can share assets only with other users or groups in the same namespace. They can't see users and groups in other namespaces. You can create a namespace after your Amazon Web Services account is subscribed to Amazon QuickSight. The namespace must be unique within the Amazon Web Services account. By default, there is a limit of 100 namespaces per Amazon Web Services account. To increase your limit, create a ticket with Amazon Web ServicesSupport. See also: AWS API Documentation **Request Syntax** response = client.create_namespace( AwsAccountId='string', Namespace='string', IdentityStore='QUICKSIGHT', Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID for the Amazon Web Services account that you want to create the Amazon QuickSight namespace in. * **Namespace** (*string*) -- **[REQUIRED]** The name that you want to use to describe the new namespace. * **IdentityStore** (*string*) -- **[REQUIRED]** Specifies the type of your user identity directory. Currently, this supports users with an identity type of "QUICKSIGHT". * **Tags** (*list*) -- The tags that you want to associate with the namespace that you're creating. * *(dict) --* The key or keys of the key-value pairs for the resource tag or tags assigned to the resource. * **Key** *(string) --* **[REQUIRED]** Tag key. * **Value** *(string) --* **[REQUIRED]** Tag value. Return type: dict Returns: **Response Syntax** { 'Arn': 'string', 'Name': 'string', 'CapacityRegion': 'string', 'CreationStatus': 'CREATED'|'CREATING'|'DELETING'|'RETRYABLE_FAILURE'|'NON_RETRYABLE_FAILURE', 'IdentityStore': 'QUICKSIGHT', 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **Arn** *(string) --* The ARN of the Amazon QuickSight namespace you created. * **Name** *(string) --* The name of the new namespace that you created. * **CapacityRegion** *(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. * **CreationStatus** *(string) --* The status of the creation of the namespace. This is an asynchronous process. A status of "CREATED" means that your namespace is ready to use. If an error occurs, it indicates if the process is "retryable" or "non-retryable". In the case of a non-retryable error, refer to the error message for follow-up tasks. * **IdentityStore** *(string) --* Specifies the type of your user identity directory. Currently, this supports users with an identity type of "QUICKSIGHT". * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.LimitExceededException" * "QuickSight.Client.exceptions.ResourceExistsException" * "QuickSight.Client.exceptions.PreconditionNotMetException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.InternalFailureException" * "QuickSight.Client.exceptions.ResourceUnavailableException" QuickSight / Client / update_data_source update_data_source ****************** QuickSight.Client.update_data_source(**kwargs) Updates a data source. See also: AWS API Documentation **Request Syntax** response = client.update_data_source( AwsAccountId='string', DataSourceId='string', Name='string', DataSourceParameters={ 'AmazonElasticsearchParameters': { 'Domain': 'string' }, 'AthenaParameters': { 'WorkGroup': 'string', 'RoleArn': 'string', 'IdentityCenterConfiguration': { 'EnableIdentityPropagation': True|False } }, 'AuroraParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'AuroraPostgreSqlParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'AwsIotAnalyticsParameters': { 'DataSetName': 'string' }, 'JiraParameters': { 'SiteBaseUrl': 'string' }, 'MariaDbParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'MySqlParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'OracleParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string', 'UseServiceName': True|False }, 'PostgreSqlParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'PrestoParameters': { 'Host': 'string', 'Port': 123, 'Catalog': 'string' }, 'RdsParameters': { 'InstanceId': 'string', 'Database': 'string' }, 'RedshiftParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string', 'ClusterId': 'string', 'IAMParameters': { 'RoleArn': 'string', 'DatabaseUser': 'string', 'DatabaseGroups': [ 'string', ], 'AutoCreateDatabaseUser': True|False }, 'IdentityCenterConfiguration': { 'EnableIdentityPropagation': True|False } }, 'S3Parameters': { 'ManifestFileLocation': { 'Bucket': 'string', 'Key': 'string' }, 'RoleArn': 'string' }, 'ServiceNowParameters': { 'SiteBaseUrl': 'string' }, 'SnowflakeParameters': { 'Host': 'string', 'Database': 'string', 'Warehouse': 'string', 'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509', 'DatabaseAccessControlRole': 'string', 'OAuthParameters': { 'TokenProviderUrl': 'string', 'OAuthScope': 'string', 'IdentityProviderVpcConnectionProperties': { 'VpcConnectionArn': 'string' }, 'IdentityProviderResourceUri': 'string' } }, 'SparkParameters': { 'Host': 'string', 'Port': 123 }, 'SqlServerParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'TeradataParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'TwitterParameters': { 'Query': 'string', 'MaxRows': 123 }, 'AmazonOpenSearchParameters': { 'Domain': 'string' }, 'ExasolParameters': { 'Host': 'string', 'Port': 123 }, 'DatabricksParameters': { 'Host': 'string', 'Port': 123, 'SqlEndpointPath': 'string' }, 'StarburstParameters': { 'Host': 'string', 'Port': 123, 'Catalog': 'string', 'ProductType': 'GALAXY'|'ENTERPRISE', 'DatabaseAccessControlRole': 'string', 'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509', 'OAuthParameters': { 'TokenProviderUrl': 'string', 'OAuthScope': 'string', 'IdentityProviderVpcConnectionProperties': { 'VpcConnectionArn': 'string' }, 'IdentityProviderResourceUri': 'string' } }, 'TrinoParameters': { 'Host': 'string', 'Port': 123, 'Catalog': 'string' }, 'BigQueryParameters': { 'ProjectId': 'string', 'DataSetRegion': 'string' }, 'ImpalaParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string', 'SqlEndpointPath': 'string' } }, Credentials={ 'CredentialPair': { 'Username': 'string', 'Password': 'string', 'AlternateDataSourceParameters': [ { 'AmazonElasticsearchParameters': { 'Domain': 'string' }, 'AthenaParameters': { 'WorkGroup': 'string', 'RoleArn': 'string', 'IdentityCenterConfiguration': { 'EnableIdentityPropagation': True|False } }, 'AuroraParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'AuroraPostgreSqlParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'AwsIotAnalyticsParameters': { 'DataSetName': 'string' }, 'JiraParameters': { 'SiteBaseUrl': 'string' }, 'MariaDbParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'MySqlParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'OracleParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string', 'UseServiceName': True|False }, 'PostgreSqlParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'PrestoParameters': { 'Host': 'string', 'Port': 123, 'Catalog': 'string' }, 'RdsParameters': { 'InstanceId': 'string', 'Database': 'string' }, 'RedshiftParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string', 'ClusterId': 'string', 'IAMParameters': { 'RoleArn': 'string', 'DatabaseUser': 'string', 'DatabaseGroups': [ 'string', ], 'AutoCreateDatabaseUser': True|False }, 'IdentityCenterConfiguration': { 'EnableIdentityPropagation': True|False } }, 'S3Parameters': { 'ManifestFileLocation': { 'Bucket': 'string', 'Key': 'string' }, 'RoleArn': 'string' }, 'ServiceNowParameters': { 'SiteBaseUrl': 'string' }, 'SnowflakeParameters': { 'Host': 'string', 'Database': 'string', 'Warehouse': 'string', 'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509', 'DatabaseAccessControlRole': 'string', 'OAuthParameters': { 'TokenProviderUrl': 'string', 'OAuthScope': 'string', 'IdentityProviderVpcConnectionProperties': { 'VpcConnectionArn': 'string' }, 'IdentityProviderResourceUri': 'string' } }, 'SparkParameters': { 'Host': 'string', 'Port': 123 }, 'SqlServerParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'TeradataParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'TwitterParameters': { 'Query': 'string', 'MaxRows': 123 }, 'AmazonOpenSearchParameters': { 'Domain': 'string' }, 'ExasolParameters': { 'Host': 'string', 'Port': 123 }, 'DatabricksParameters': { 'Host': 'string', 'Port': 123, 'SqlEndpointPath': 'string' }, 'StarburstParameters': { 'Host': 'string', 'Port': 123, 'Catalog': 'string', 'ProductType': 'GALAXY'|'ENTERPRISE', 'DatabaseAccessControlRole': 'string', 'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509', 'OAuthParameters': { 'TokenProviderUrl': 'string', 'OAuthScope': 'string', 'IdentityProviderVpcConnectionProperties': { 'VpcConnectionArn': 'string' }, 'IdentityProviderResourceUri': 'string' } }, 'TrinoParameters': { 'Host': 'string', 'Port': 123, 'Catalog': 'string' }, 'BigQueryParameters': { 'ProjectId': 'string', 'DataSetRegion': 'string' }, 'ImpalaParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string', 'SqlEndpointPath': 'string' } }, ] }, 'CopySourceArn': 'string', 'SecretArn': 'string' }, VpcConnectionProperties={ 'VpcConnectionArn': 'string' }, SslProperties={ 'DisableSsl': True|False } ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The Amazon Web Services account ID. * **DataSourceId** (*string*) -- **[REQUIRED]** The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. * **Name** (*string*) -- **[REQUIRED]** A display name for the data source. * **DataSourceParameters** (*dict*) -- The parameters that Amazon QuickSight uses to connect to your underlying source. * **AmazonElasticsearchParameters** *(dict) --* The parameters for OpenSearch. * **Domain** *(string) --* **[REQUIRED]** The OpenSearch domain. * **AthenaParameters** *(dict) --* The parameters for Amazon Athena. * **WorkGroup** *(string) --* The workgroup that Amazon Athena uses. * **RoleArn** *(string) --* Use the "RoleArn" structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use "RoleArn" to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active. * **IdentityCenterConfiguration** *(dict) --* An optional parameter that configures IAM Identity Center authentication to grant Amazon QuickSight access to your workgroup. This parameter can only be specified if your Amazon QuickSight account is configured with IAM Identity Center. * **EnableIdentityPropagation** *(boolean) --* A Boolean option that controls whether Trusted Identity Propagation should be used. * **AuroraParameters** *(dict) --* The parameters for Amazon Aurora MySQL. * **Host** *(string) --* **[REQUIRED]** Host. * **Port** *(integer) --* **[REQUIRED]** Port. * **Database** *(string) --* **[REQUIRED]** Database. * **AuroraPostgreSqlParameters** *(dict) --* The parameters for Amazon Aurora. * **Host** *(string) --* **[REQUIRED]** The Amazon Aurora PostgreSQL-Compatible host to connect to. * **Port** *(integer) --* **[REQUIRED]** The port that Amazon Aurora PostgreSQL is listening on. * **Database** *(string) --* **[REQUIRED]** The Amazon Aurora PostgreSQL database to connect to. * **AwsIotAnalyticsParameters** *(dict) --* The parameters for IoT Analytics. * **DataSetName** *(string) --* **[REQUIRED]** Dataset name. * **JiraParameters** *(dict) --* The parameters for Jira. * **SiteBaseUrl** *(string) --* **[REQUIRED]** The base URL of the Jira site. * **MariaDbParameters** *(dict) --* The parameters for MariaDB. * **Host** *(string) --* **[REQUIRED]** Host. * **Port** *(integer) --* **[REQUIRED]** Port. * **Database** *(string) --* **[REQUIRED]** Database. * **MySqlParameters** *(dict) --* The parameters for MySQL. * **Host** *(string) --* **[REQUIRED]** Host. * **Port** *(integer) --* **[REQUIRED]** Port. * **Database** *(string) --* **[REQUIRED]** Database. * **OracleParameters** *(dict) --* The parameters for Oracle. * **Host** *(string) --* **[REQUIRED]** An Oracle host. * **Port** *(integer) --* **[REQUIRED]** The port. * **Database** *(string) --* **[REQUIRED]** The database. * **UseServiceName** *(boolean) --* A Boolean value that indicates whether the "Database" uses a service name or an SID. If this value is left blank, the default value is "SID". If this value is set to "false", the value is "SID". * **PostgreSqlParameters** *(dict) --* The parameters for PostgreSQL. * **Host** *(string) --* **[REQUIRED]** Host. * **Port** *(integer) --* **[REQUIRED]** Port. * **Database** *(string) --* **[REQUIRED]** Database. * **PrestoParameters** *(dict) --* The parameters for Presto. * **Host** *(string) --* **[REQUIRED]** Host. * **Port** *(integer) --* **[REQUIRED]** Port. * **Catalog** *(string) --* **[REQUIRED]** Catalog. * **RdsParameters** *(dict) --* The parameters for Amazon RDS. * **InstanceId** *(string) --* **[REQUIRED]** Instance ID. * **Database** *(string) --* **[REQUIRED]** Database. * **RedshiftParameters** *(dict) --* The parameters for Amazon Redshift. * **Host** *(string) --* Host. This field can be blank if "ClusterId" is provided. * **Port** *(integer) --* Port. This field can be blank if the "ClusterId" is provided. * **Database** *(string) --* **[REQUIRED]** Database. * **ClusterId** *(string) --* Cluster ID. This field can be blank if the "Host" and "Port" are provided. * **IAMParameters** *(dict) --* An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials. * **RoleArn** *(string) --* **[REQUIRED]** Use the "RoleArn" structure to allow Amazon QuickSight to call "redshift:GetClusterCredentials" on your cluster. The calling principal must have "iam:PassRole" access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role. * **DatabaseUser** *(string) --* The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of "AutoCreateDatabaseUser" to "True" to create a new user with PUBLIC permissions. * **DatabaseGroups** *(list) --* A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the "DatabaseUser". If you choose to include this parameter, the "RoleArn" must grant access to "redshift:JoinGroup". * *(string) --* * **AutoCreateDatabaseUser** *(boolean) --* Automatically creates a database user. If your database doesn't have a "DatabaseUser", set this parameter to "True". If there is no "DatabaseUser", Amazon QuickSight can't connect to your cluster. The "RoleArn" that you use for this operation must grant access to "redshift:CreateClusterUser" to successfully create the user. * **IdentityCenterConfiguration** *(dict) --* An optional parameter that configures IAM Identity Center authentication to grant Amazon QuickSight access to your cluster. This parameter can only be specified if your Amazon QuickSight account is configured with IAM Identity Center. * **EnableIdentityPropagation** *(boolean) --* A Boolean option that controls whether Trusted Identity Propagation should be used. * **S3Parameters** *(dict) --* The parameters for S3. * **ManifestFileLocation** *(dict) --* **[REQUIRED]** Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight. * **Bucket** *(string) --* **[REQUIRED]** Amazon S3 bucket. * **Key** *(string) --* **[REQUIRED]** Amazon S3 key that identifies an object. * **RoleArn** *(string) --* Use the "RoleArn" structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use "RoleArn" to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active. * **ServiceNowParameters** *(dict) --* The parameters for ServiceNow. * **SiteBaseUrl** *(string) --* **[REQUIRED]** URL of the base site. * **SnowflakeParameters** *(dict) --* The parameters for Snowflake. * **Host** *(string) --* **[REQUIRED]** Host. * **Database** *(string) --* **[REQUIRED]** Database. * **Warehouse** *(string) --* **[REQUIRED]** Warehouse. * **AuthenticationType** *(string) --* The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types. * **DatabaseAccessControlRole** *(string) --* The database access control role. * **OAuthParameters** *(dict) --* An object that contains information needed to create a data source connection between an Amazon QuickSight account and Snowflake. * **TokenProviderUrl** *(string) --* **[REQUIRED]** The token endpoint URL of the identity provider. * **OAuthScope** *(string) --* The OAuth scope. * **IdentityProviderVpcConnectionProperties** *(dict) --* VPC connection properties. * **VpcConnectionArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) for the VPC connection. * **IdentityProviderResourceUri** *(string) --* The resource uri of the identity provider. * **SparkParameters** *(dict) --* The parameters for Spark. * **Host** *(string) --* **[REQUIRED]** Host. * **Port** *(integer) --* **[REQUIRED]** Port. * **SqlServerParameters** *(dict) --* The parameters for SQL Server. * **Host** *(string) --* **[REQUIRED]** Host. * **Port** *(integer) --* **[REQUIRED]** Port. * **Database** *(string) --* **[REQUIRED]** Database. * **TeradataParameters** *(dict) --* The parameters for Teradata. * **Host** *(string) --* **[REQUIRED]** Host. * **Port** *(integer) --* **[REQUIRED]** Port. * **Database** *(string) --* **[REQUIRED]** Database. * **TwitterParameters** *(dict) --* The parameters for Twitter. * **Query** *(string) --* **[REQUIRED]** Twitter query string. * **MaxRows** *(integer) --* **[REQUIRED]** Maximum number of rows to query Twitter. * **AmazonOpenSearchParameters** *(dict) --* The parameters for OpenSearch. * **Domain** *(string) --* **[REQUIRED]** The OpenSearch domain. * **ExasolParameters** *(dict) --* The parameters for Exasol. * **Host** *(string) --* **[REQUIRED]** The hostname or IP address of the Exasol data source. * **Port** *(integer) --* **[REQUIRED]** The port for the Exasol data source. * **DatabricksParameters** *(dict) --* The parameters that are required to connect to a Databricks data source. * **Host** *(string) --* **[REQUIRED]** The host name of the Databricks data source. * **Port** *(integer) --* **[REQUIRED]** The port for the Databricks data source. * **SqlEndpointPath** *(string) --* **[REQUIRED]** The HTTP path of the Databricks data source. * **StarburstParameters** *(dict) --* The parameters that are required to connect to a Starburst data source. * **Host** *(string) --* **[REQUIRED]** The host name of the Starburst data source. * **Port** *(integer) --* **[REQUIRED]** The port for the Starburst data source. * **Catalog** *(string) --* **[REQUIRED]** The catalog name for the Starburst data source. * **ProductType** *(string) --* The product type for the Starburst data source. * **DatabaseAccessControlRole** *(string) --* The database access control role. * **AuthenticationType** *(string) --* The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types. * **OAuthParameters** *(dict) --* An object that contains information needed to create a data source connection between an Amazon QuickSight account and Starburst. * **TokenProviderUrl** *(string) --* **[REQUIRED]** The token endpoint URL of the identity provider. * **OAuthScope** *(string) --* The OAuth scope. * **IdentityProviderVpcConnectionProperties** *(dict) --* VPC connection properties. * **VpcConnectionArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) for the VPC connection. * **IdentityProviderResourceUri** *(string) --* The resource uri of the identity provider. * **TrinoParameters** *(dict) --* The parameters that are required to connect to a Trino data source. * **Host** *(string) --* **[REQUIRED]** The host name of the Trino data source. * **Port** *(integer) --* **[REQUIRED]** The port for the Trino data source. * **Catalog** *(string) --* **[REQUIRED]** The catalog name for the Trino data source. * **BigQueryParameters** *(dict) --* The parameters that are required to connect to a Google BigQuery data source. * **ProjectId** *(string) --* **[REQUIRED]** The Google Cloud Platform project ID where your datasource was created. * **DataSetRegion** *(string) --* The storage location where you create a Google BigQuery data source. * **ImpalaParameters** *(dict) --* The parameters for Impala. * **Host** *(string) --* **[REQUIRED]** The host name of the Impala data source. * **Port** *(integer) --* **[REQUIRED]** The port of the Impala data source. * **Database** *(string) --* The database of the Impala data source. * **SqlEndpointPath** *(string) --* **[REQUIRED]** The HTTP path of the Impala data source. * **Credentials** (*dict*) -- The credentials that Amazon QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported. * **CredentialPair** *(dict) --* Credential pair. For more information, see >>``<>``<<. * **Username** *(string) --* **[REQUIRED]** User name. * **Password** *(string) --* **[REQUIRED]** Password. * **AlternateDataSourceParameters** *(list) --* A set of alternate data source parameters that you want to share for these credentials. The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the "DataSourceParameters" structure that's in the request with the structures in the "AlternateDataSourceParameters" allow list. If the structures are an exact match, the request is allowed to use the new data source with the existing credentials. If the "AlternateDataSourceParameters" list is null, the "DataSourceParameters" originally used with these "Credentials" is automatically allowed. * *(dict) --* The parameters that Amazon QuickSight uses to connect to your underlying data source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null. * **AmazonElasticsearchParameters** *(dict) --* The parameters for OpenSearch. * **Domain** *(string) --* **[REQUIRED]** The OpenSearch domain. * **AthenaParameters** *(dict) --* The parameters for Amazon Athena. * **WorkGroup** *(string) --* The workgroup that Amazon Athena uses. * **RoleArn** *(string) --* Use the "RoleArn" structure to override an account- wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use "RoleArn" to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active. * **IdentityCenterConfiguration** *(dict) --* An optional parameter that configures IAM Identity Center authentication to grant Amazon QuickSight access to your workgroup. This parameter can only be specified if your Amazon QuickSight account is configured with IAM Identity Center. * **EnableIdentityPropagation** *(boolean) --* A Boolean option that controls whether Trusted Identity Propagation should be used. * **AuroraParameters** *(dict) --* The parameters for Amazon Aurora MySQL. * **Host** *(string) --* **[REQUIRED]** Host. * **Port** *(integer) --* **[REQUIRED]** Port. * **Database** *(string) --* **[REQUIRED]** Database. * **AuroraPostgreSqlParameters** *(dict) --* The parameters for Amazon Aurora. * **Host** *(string) --* **[REQUIRED]** The Amazon Aurora PostgreSQL-Compatible host to connect to. * **Port** *(integer) --* **[REQUIRED]** The port that Amazon Aurora PostgreSQL is listening on. * **Database** *(string) --* **[REQUIRED]** The Amazon Aurora PostgreSQL database to connect to. * **AwsIotAnalyticsParameters** *(dict) --* The parameters for IoT Analytics. * **DataSetName** *(string) --* **[REQUIRED]** Dataset name. * **JiraParameters** *(dict) --* The parameters for Jira. * **SiteBaseUrl** *(string) --* **[REQUIRED]** The base URL of the Jira site. * **MariaDbParameters** *(dict) --* The parameters for MariaDB. * **Host** *(string) --* **[REQUIRED]** Host. * **Port** *(integer) --* **[REQUIRED]** Port. * **Database** *(string) --* **[REQUIRED]** Database. * **MySqlParameters** *(dict) --* The parameters for MySQL. * **Host** *(string) --* **[REQUIRED]** Host. * **Port** *(integer) --* **[REQUIRED]** Port. * **Database** *(string) --* **[REQUIRED]** Database. * **OracleParameters** *(dict) --* The parameters for Oracle. * **Host** *(string) --* **[REQUIRED]** An Oracle host. * **Port** *(integer) --* **[REQUIRED]** The port. * **Database** *(string) --* **[REQUIRED]** The database. * **UseServiceName** *(boolean) --* A Boolean value that indicates whether the "Database" uses a service name or an SID. If this value is left blank, the default value is "SID". If this value is set to "false", the value is "SID". * **PostgreSqlParameters** *(dict) --* The parameters for PostgreSQL. * **Host** *(string) --* **[REQUIRED]** Host. * **Port** *(integer) --* **[REQUIRED]** Port. * **Database** *(string) --* **[REQUIRED]** Database. * **PrestoParameters** *(dict) --* The parameters for Presto. * **Host** *(string) --* **[REQUIRED]** Host. * **Port** *(integer) --* **[REQUIRED]** Port. * **Catalog** *(string) --* **[REQUIRED]** Catalog. * **RdsParameters** *(dict) --* The parameters for Amazon RDS. * **InstanceId** *(string) --* **[REQUIRED]** Instance ID. * **Database** *(string) --* **[REQUIRED]** Database. * **RedshiftParameters** *(dict) --* The parameters for Amazon Redshift. * **Host** *(string) --* Host. This field can be blank if "ClusterId" is provided. * **Port** *(integer) --* Port. This field can be blank if the "ClusterId" is provided. * **Database** *(string) --* **[REQUIRED]** Database. * **ClusterId** *(string) --* Cluster ID. This field can be blank if the "Host" and "Port" are provided. * **IAMParameters** *(dict) --* An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials. * **RoleArn** *(string) --* **[REQUIRED]** Use the "RoleArn" structure to allow Amazon QuickSight to call "redshift:GetClusterCredentials" on your cluster. The calling principal must have "iam:PassRole" access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role. * **DatabaseUser** *(string) --* The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of "AutoCreateDatabaseUser" to "True" to create a new user with PUBLIC permissions. * **DatabaseGroups** *(list) --* A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the "DatabaseUser". If you choose to include this parameter, the "RoleArn" must grant access to "redshift:JoinGroup". * *(string) --* * **AutoCreateDatabaseUser** *(boolean) --* Automatically creates a database user. If your database doesn't have a "DatabaseUser", set this parameter to "True". If there is no "DatabaseUser", Amazon QuickSight can't connect to your cluster. The "RoleArn" that you use for this operation must grant access to "redshift:CreateClusterUser" to successfully create the user. * **IdentityCenterConfiguration** *(dict) --* An optional parameter that configures IAM Identity Center authentication to grant Amazon QuickSight access to your cluster. This parameter can only be specified if your Amazon QuickSight account is configured with IAM Identity Center. * **EnableIdentityPropagation** *(boolean) --* A Boolean option that controls whether Trusted Identity Propagation should be used. * **S3Parameters** *(dict) --* The parameters for S3. * **ManifestFileLocation** *(dict) --* **[REQUIRED]** Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight. * **Bucket** *(string) --* **[REQUIRED]** Amazon S3 bucket. * **Key** *(string) --* **[REQUIRED]** Amazon S3 key that identifies an object. * **RoleArn** *(string) --* Use the "RoleArn" structure to override an account- wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use "RoleArn" to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active. * **ServiceNowParameters** *(dict) --* The parameters for ServiceNow. * **SiteBaseUrl** *(string) --* **[REQUIRED]** URL of the base site. * **SnowflakeParameters** *(dict) --* The parameters for Snowflake. * **Host** *(string) --* **[REQUIRED]** Host. * **Database** *(string) --* **[REQUIRED]** Database. * **Warehouse** *(string) --* **[REQUIRED]** Warehouse. * **AuthenticationType** *(string) --* The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types. * **DatabaseAccessControlRole** *(string) --* The database access control role. * **OAuthParameters** *(dict) --* An object that contains information needed to create a data source connection between an Amazon QuickSight account and Snowflake. * **TokenProviderUrl** *(string) --* **[REQUIRED]** The token endpoint URL of the identity provider. * **OAuthScope** *(string) --* The OAuth scope. * **IdentityProviderVpcConnectionProperties** *(dict) --* VPC connection properties. * **VpcConnectionArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) for the VPC connection. * **IdentityProviderResourceUri** *(string) --* The resource uri of the identity provider. * **SparkParameters** *(dict) --* The parameters for Spark. * **Host** *(string) --* **[REQUIRED]** Host. * **Port** *(integer) --* **[REQUIRED]** Port. * **SqlServerParameters** *(dict) --* The parameters for SQL Server. * **Host** *(string) --* **[REQUIRED]** Host. * **Port** *(integer) --* **[REQUIRED]** Port. * **Database** *(string) --* **[REQUIRED]** Database. * **TeradataParameters** *(dict) --* The parameters for Teradata. * **Host** *(string) --* **[REQUIRED]** Host. * **Port** *(integer) --* **[REQUIRED]** Port. * **Database** *(string) --* **[REQUIRED]** Database. * **TwitterParameters** *(dict) --* The parameters for Twitter. * **Query** *(string) --* **[REQUIRED]** Twitter query string. * **MaxRows** *(integer) --* **[REQUIRED]** Maximum number of rows to query Twitter. * **AmazonOpenSearchParameters** *(dict) --* The parameters for OpenSearch. * **Domain** *(string) --* **[REQUIRED]** The OpenSearch domain. * **ExasolParameters** *(dict) --* The parameters for Exasol. * **Host** *(string) --* **[REQUIRED]** The hostname or IP address of the Exasol data source. * **Port** *(integer) --* **[REQUIRED]** The port for the Exasol data source. * **DatabricksParameters** *(dict) --* The parameters that are required to connect to a Databricks data source. * **Host** *(string) --* **[REQUIRED]** The host name of the Databricks data source. * **Port** *(integer) --* **[REQUIRED]** The port for the Databricks data source. * **SqlEndpointPath** *(string) --* **[REQUIRED]** The HTTP path of the Databricks data source. * **StarburstParameters** *(dict) --* The parameters that are required to connect to a Starburst data source. * **Host** *(string) --* **[REQUIRED]** The host name of the Starburst data source. * **Port** *(integer) --* **[REQUIRED]** The port for the Starburst data source. * **Catalog** *(string) --* **[REQUIRED]** The catalog name for the Starburst data source. * **ProductType** *(string) --* The product type for the Starburst data source. * **DatabaseAccessControlRole** *(string) --* The database access control role. * **AuthenticationType** *(string) --* The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types. * **OAuthParameters** *(dict) --* An object that contains information needed to create a data source connection between an Amazon QuickSight account and Starburst. * **TokenProviderUrl** *(string) --* **[REQUIRED]** The token endpoint URL of the identity provider. * **OAuthScope** *(string) --* The OAuth scope. * **IdentityProviderVpcConnectionProperties** *(dict) --* VPC connection properties. * **VpcConnectionArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) for the VPC connection. * **IdentityProviderResourceUri** *(string) --* The resource uri of the identity provider. * **TrinoParameters** *(dict) --* The parameters that are required to connect to a Trino data source. * **Host** *(string) --* **[REQUIRED]** The host name of the Trino data source. * **Port** *(integer) --* **[REQUIRED]** The port for the Trino data source. * **Catalog** *(string) --* **[REQUIRED]** The catalog name for the Trino data source. * **BigQueryParameters** *(dict) --* The parameters that are required to connect to a Google BigQuery data source. * **ProjectId** *(string) --* **[REQUIRED]** The Google Cloud Platform project ID where your datasource was created. * **DataSetRegion** *(string) --* The storage location where you create a Google BigQuery data source. * **ImpalaParameters** *(dict) --* The parameters for Impala. * **Host** *(string) --* **[REQUIRED]** The host name of the Impala data source. * **Port** *(integer) --* **[REQUIRED]** The port of the Impala data source. * **Database** *(string) --* The database of the Impala data source. * **SqlEndpointPath** *(string) --* **[REQUIRED]** The HTTP path of the Impala data source. * **CopySourceArn** *(string) --* The Amazon Resource Name (ARN) of a data source that has the credential pair that you want to use. When "CopySourceArn" is not null, the credential pair from the data source in the ARN is used as the credentials for the "DataSourceCredentials" structure. * **SecretArn** *(string) --* The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager. * **VpcConnectionProperties** (*dict*) -- Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source. * **VpcConnectionArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) for the VPC connection. * **SslProperties** (*dict*) -- Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source. * **DisableSsl** *(boolean) --* A Boolean option to control whether SSL should be disabled. Return type: dict Returns: **Response Syntax** { 'Arn': 'string', 'DataSourceId': 'string', 'UpdateStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED', 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **Arn** *(string) --* The Amazon Resource Name (ARN) of the data source. * **DataSourceId** *(string) --* The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. * **UpdateStatus** *(string) --* The update status of the data source's last update. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.CustomerManagedKeyUnavailableExcep tion" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / describe_key_registration describe_key_registration ************************* QuickSight.Client.describe_key_registration(**kwargs) Describes all customer managed key registrations in a Amazon QuickSight account. See also: AWS API Documentation **Request Syntax** response = client.describe_key_registration( AwsAccountId='string', DefaultKeyOnly=True|False ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the customer managed key registration that you want to describe. * **DefaultKeyOnly** (*boolean*) -- Determines whether the request returns the default key only. Return type: dict Returns: **Response Syntax** { 'AwsAccountId': 'string', 'KeyRegistration': [ { 'KeyArn': 'string', 'DefaultKey': True|False }, ], 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **AwsAccountId** *(string) --* The ID of the Amazon Web Services account that contains the customer managed key registration specified in the request. * **KeyRegistration** *(list) --* A list of "RegisteredCustomerManagedKey" objects in a Amazon QuickSight account. * *(dict) --* A customer managed key structure that contains the information listed below: * "KeyArn" - The ARN of a KMS key that is registered to a Amazon QuickSight account for encryption and decryption use. * "DefaultKey" - Indicates whether the current key is set as the default key for encryption and decryption use. * **KeyArn** *(string) --* The ARN of the KMS key that is registered to a Amazon QuickSight account for encryption and decryption use. * **DefaultKey** *(boolean) --* Indicates whether a "RegisteredCustomerManagedKey" is set as the default key for encryption and decryption use. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / delete_group delete_group ************ QuickSight.Client.delete_group(**kwargs) Removes a user group from Amazon QuickSight. See also: AWS API Documentation **Request Syntax** response = client.delete_group( GroupName='string', AwsAccountId='string', Namespace='string' ) Parameters: * **GroupName** (*string*) -- **[REQUIRED]** The name of the group that you want to delete. * **AwsAccountId** (*string*) -- **[REQUIRED]** 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** (*string*) -- **[REQUIRED]** The namespace of the group that you want to delete. Return type: dict Returns: **Response Syntax** { 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.PreconditionNotMetException" * "QuickSight.Client.exceptions.InternalFailureException" * "QuickSight.Client.exceptions.ResourceUnavailableException" QuickSight / Client / create_account_customization create_account_customization **************************** QuickSight.Client.create_account_customization(**kwargs) Creates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, you can add a custom default theme by using the "CreateAccountCustomization" or "UpdateAccountCustomization" API operation. To further customize Amazon QuickSight by removing Amazon QuickSight sample assets and videos for all new users, see Customizing Amazon QuickSight in the *Amazon QuickSight User Guide.* You can create customizations for your Amazon Web Services account or, if you specify a namespace, for a QuickSight namespace instead. Customizations that apply to a namespace always override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the "DescribeAccountCustomization" API operation. Before you use the "CreateAccountCustomization" API operation to add a theme as the namespace default, make sure that you first share the theme with the namespace. If you don't share it with the namespace, the theme isn't visible to your users even if you make it the default theme. To check if the theme is shared, view the current permissions by using the "DescribeThemePermissions" API operation. To share the theme, grant permissions by using the "UpdateThemePermissions" API operation. See also: AWS API Documentation **Request Syntax** response = client.create_account_customization( AwsAccountId='string', Namespace='string', AccountCustomization={ 'DefaultTheme': 'string', 'DefaultEmailCustomizationTemplate': 'string' }, Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID for the Amazon Web Services account that you want to customize Amazon QuickSight for. * **Namespace** (*string*) -- The Amazon QuickSight namespace that you want to add customizations to. * **AccountCustomization** (*dict*) -- **[REQUIRED]** 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:th eme/bdb844d0-0fe9-4d9d-b520-0fe602d93639" }". * **DefaultTheme** *(string) --* The default theme for this Amazon QuickSight subscription. * **DefaultEmailCustomizationTemplate** *(string) --* The default email customization template. * **Tags** (*list*) -- A list of the tags that you want to attach to this resource. * *(dict) --* The key or keys of the key-value pairs for the resource tag or tags assigned to the resource. * **Key** *(string) --* **[REQUIRED]** Tag key. * **Value** *(string) --* **[REQUIRED]** Tag value. Return type: dict Returns: **Response Syntax** { 'Arn': 'string', 'AwsAccountId': 'string', 'Namespace': 'string', 'AccountCustomization': { 'DefaultTheme': 'string', 'DefaultEmailCustomizationTemplate': 'string' }, 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **Arn** *(string) --* The Amazon Resource Name (ARN) for the customization that you created for this Amazon Web Services account. * **AwsAccountId** *(string) --* The ID for the Amazon Web Services account that you want to customize Amazon QuickSight for. * **Namespace** *(string) --* The namespace associated with the customization you're creating. * **AccountCustomization** *(dict) --* The Amazon QuickSight customizations you're adding in the current Amazon Web Services Region. * **DefaultTheme** *(string) --* The default theme for this Amazon QuickSight subscription. * **DefaultEmailCustomizationTemplate** *(string) --* The default email customization template. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceExistsException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InternalFailureException" * "QuickSight.Client.exceptions.ResourceUnavailableException" QuickSight / Client / update_brand_assignment update_brand_assignment *********************** QuickSight.Client.update_brand_assignment(**kwargs) Updates a brand assignment. See also: AWS API Documentation **Request Syntax** response = client.update_brand_assignment( AwsAccountId='string', BrandArn='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that owns the brand assignment. * **BrandArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the brand. Return type: dict Returns: **Response Syntax** { 'RequestId': 'string', 'BrandArn': 'string' } **Response Structure** * *(dict) --* * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **BrandArn** *(string) --* The Amazon Resource Name (ARN) of the brand. **Exceptions** * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InvalidRequestException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InternalServerException" QuickSight / Client / update_template_permissions update_template_permissions *************************** QuickSight.Client.update_template_permissions(**kwargs) Updates the resource permissions for a template. See also: AWS API Documentation **Request Syntax** response = client.update_template_permissions( AwsAccountId='string', TemplateId='string', GrantPermissions=[ { 'Principal': 'string', 'Actions': [ 'string', ] }, ], RevokePermissions=[ { 'Principal': 'string', 'Actions': [ 'string', ] }, ] ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the template. * **TemplateId** (*string*) -- **[REQUIRED]** The ID for the template. * **GrantPermissions** (*list*) -- A list of resource permissions to be granted on the template. * *(dict) --* Permission for the resource. * **Principal** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the principal. This can be one of the following: * The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.) * The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.) * The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.) * **Actions** *(list) --* **[REQUIRED]** The IAM action to grant or revoke permissions on. * *(string) --* * **RevokePermissions** (*list*) -- A list of resource permissions to be revoked from the template. * *(dict) --* Permission for the resource. * **Principal** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the principal. This can be one of the following: * The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.) * The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.) * The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.) * **Actions** *(list) --* **[REQUIRED]** The IAM action to grant or revoke permissions on. * *(string) --* Return type: dict Returns: **Response Syntax** { 'TemplateId': 'string', 'TemplateArn': 'string', 'Permissions': [ { 'Principal': 'string', 'Actions': [ 'string', ] }, ], 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **TemplateId** *(string) --* The ID for the template. * **TemplateArn** *(string) --* The Amazon Resource Name (ARN) of the template. * **Permissions** *(list) --* A list of resource permissions to be set on the template. * *(dict) --* Permission for the resource. * **Principal** *(string) --* The Amazon Resource Name (ARN) of the principal. This can be one of the following: * The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.) * The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.) * The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.) * **Actions** *(list) --* The IAM action to grant or revoke permissions on. * *(string) --* * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.LimitExceededException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / update_account_settings update_account_settings *********************** QuickSight.Client.update_account_settings(**kwargs) Updates the Amazon QuickSight settings in your Amazon Web Services account. See also: AWS API Documentation **Request Syntax** response = client.update_account_settings( AwsAccountId='string', DefaultNamespace='string', NotificationEmail='string', TerminationProtectionEnabled=True|False ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID for the Amazon Web Services account that contains the Amazon QuickSight settings that you want to list. * **DefaultNamespace** (*string*) -- **[REQUIRED]** The default namespace for this Amazon Web Services account. Currently, the default is "default". IAM users that register for the first time with Amazon QuickSight provide an email address that becomes associated with the default namespace. * **NotificationEmail** (*string*) -- The email address that you want Amazon QuickSight to send notifications to regarding your Amazon Web Services account or Amazon QuickSight subscription. * **TerminationProtectionEnabled** (*boolean*) -- A boolean value that determines whether or not an Amazon QuickSight account can be deleted. A "True" value doesn't allow the account to be deleted and results in an error message if a user tries to make a "DeleteAccountSubscription" request. A "False" value will allow the account to be deleted. Return type: dict Returns: **Response Syntax** { 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InternalFailureException" * "QuickSight.Client.exceptions.ResourceUnavailableException" QuickSight / Client / create_topic create_topic ************ QuickSight.Client.create_topic(**kwargs) Creates a new Q topic. See also: AWS API Documentation **Request Syntax** response = client.create_topic( AwsAccountId='string', TopicId='string', Topic={ 'Name': 'string', 'Description': 'string', 'UserExperienceVersion': 'LEGACY'|'NEW_READER_EXPERIENCE', 'DataSets': [ { 'DatasetArn': 'string', 'DatasetName': 'string', 'DatasetDescription': 'string', 'DataAggregation': { 'DatasetRowDateGranularity': 'SECOND'|'MINUTE'|'HOUR'|'DAY'|'WEEK'|'MONTH'|'QUARTER'|'YEAR', 'DefaultDateColumnName': 'string' }, 'Filters': [ { 'FilterDescription': 'string', 'FilterClass': 'ENFORCED_VALUE_FILTER'|'CONDITIONAL_VALUE_FILTER'|'NAMED_VALUE_FILTER', 'FilterName': 'string', 'FilterSynonyms': [ 'string', ], 'OperandFieldName': 'string', 'FilterType': 'CATEGORY_FILTER'|'NUMERIC_EQUALITY_FILTER'|'NUMERIC_RANGE_FILTER'|'DATE_RANGE_FILTER'|'RELATIVE_DATE_FILTER', 'CategoryFilter': { 'CategoryFilterFunction': 'EXACT'|'CONTAINS', 'CategoryFilterType': 'CUSTOM_FILTER'|'CUSTOM_FILTER_LIST'|'FILTER_LIST', 'Constant': { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'SingularConstant': 'string', 'CollectiveConstant': { 'ValueList': [ 'string', ] } }, 'Inverse': True|False }, 'NumericEqualityFilter': { 'Constant': { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'SingularConstant': 'string' }, 'Aggregation': 'NO_AGGREGATION'|'SUM'|'AVERAGE'|'COUNT'|'DISTINCT_COUNT'|'MAX'|'MEDIAN'|'MIN'|'STDEV'|'STDEVP'|'VAR'|'VARP' }, 'NumericRangeFilter': { 'Inclusive': True|False, 'Constant': { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'RangeConstant': { 'Minimum': 'string', 'Maximum': 'string' } }, 'Aggregation': 'NO_AGGREGATION'|'SUM'|'AVERAGE'|'COUNT'|'DISTINCT_COUNT'|'MAX'|'MEDIAN'|'MIN'|'STDEV'|'STDEVP'|'VAR'|'VARP' }, 'DateRangeFilter': { 'Inclusive': True|False, 'Constant': { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'RangeConstant': { 'Minimum': 'string', 'Maximum': 'string' } } }, 'RelativeDateFilter': { 'TimeGranularity': 'SECOND'|'MINUTE'|'HOUR'|'DAY'|'WEEK'|'MONTH'|'QUARTER'|'YEAR', 'RelativeDateFilterFunction': 'PREVIOUS'|'THIS'|'LAST'|'NEXT'|'NOW', 'Constant': { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'SingularConstant': 'string' } } }, ], 'Columns': [ { 'ColumnName': 'string', 'ColumnFriendlyName': 'string', 'ColumnDescription': 'string', 'ColumnSynonyms': [ 'string', ], 'ColumnDataRole': 'DIMENSION'|'MEASURE', 'Aggregation': 'SUM'|'MAX'|'MIN'|'COUNT'|'DISTINCT_COUNT'|'AVERAGE'|'MEDIAN'|'STDEV'|'STDEVP'|'VAR'|'VARP', 'IsIncludedInTopic': True|False, 'DisableIndexing': True|False, 'ComparativeOrder': { 'UseOrdering': 'GREATER_IS_BETTER'|'LESSER_IS_BETTER'|'SPECIFIED', 'SpecifedOrder': [ 'string', ], 'TreatUndefinedSpecifiedValues': 'LEAST'|'MOST' }, 'SemanticType': { 'TypeName': 'string', 'SubTypeName': 'string', 'TypeParameters': { 'string': 'string' }, 'TruthyCellValue': 'string', 'TruthyCellValueSynonyms': [ 'string', ], 'FalseyCellValue': 'string', 'FalseyCellValueSynonyms': [ 'string', ] }, 'TimeGranularity': 'SECOND'|'MINUTE'|'HOUR'|'DAY'|'WEEK'|'MONTH'|'QUARTER'|'YEAR', 'AllowedAggregations': [ 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX'|'MEDIAN'|'SUM'|'AVERAGE'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE', ], 'NotAllowedAggregations': [ 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX'|'MEDIAN'|'SUM'|'AVERAGE'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE', ], 'DefaultFormatting': { 'DisplayFormat': 'AUTO'|'PERCENT'|'CURRENCY'|'NUMBER'|'DATE'|'STRING', 'DisplayFormatOptions': { 'UseBlankCellFormat': True|False, 'BlankCellFormat': 'string', 'DateFormat': 'string', 'DecimalSeparator': 'COMMA'|'DOT', 'GroupingSeparator': 'string', 'UseGrouping': True|False, 'FractionDigits': 123, 'Prefix': 'string', 'Suffix': 'string', 'UnitScaler': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS'|'LAKHS'|'CRORES', 'NegativeFormat': { 'Prefix': 'string', 'Suffix': 'string' }, 'CurrencySymbol': 'string' } }, 'NeverAggregateInFilter': True|False, 'CellValueSynonyms': [ { 'CellValue': 'string', 'Synonyms': [ 'string', ] }, ], 'NonAdditive': True|False }, ], 'CalculatedFields': [ { 'CalculatedFieldName': 'string', 'CalculatedFieldDescription': 'string', 'Expression': 'string', 'CalculatedFieldSynonyms': [ 'string', ], 'IsIncludedInTopic': True|False, 'DisableIndexing': True|False, 'ColumnDataRole': 'DIMENSION'|'MEASURE', 'TimeGranularity': 'SECOND'|'MINUTE'|'HOUR'|'DAY'|'WEEK'|'MONTH'|'QUARTER'|'YEAR', 'DefaultFormatting': { 'DisplayFormat': 'AUTO'|'PERCENT'|'CURRENCY'|'NUMBER'|'DATE'|'STRING', 'DisplayFormatOptions': { 'UseBlankCellFormat': True|False, 'BlankCellFormat': 'string', 'DateFormat': 'string', 'DecimalSeparator': 'COMMA'|'DOT', 'GroupingSeparator': 'string', 'UseGrouping': True|False, 'FractionDigits': 123, 'Prefix': 'string', 'Suffix': 'string', 'UnitScaler': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS'|'LAKHS'|'CRORES', 'NegativeFormat': { 'Prefix': 'string', 'Suffix': 'string' }, 'CurrencySymbol': 'string' } }, 'Aggregation': 'SUM'|'MAX'|'MIN'|'COUNT'|'DISTINCT_COUNT'|'AVERAGE'|'MEDIAN'|'STDEV'|'STDEVP'|'VAR'|'VARP', 'ComparativeOrder': { 'UseOrdering': 'GREATER_IS_BETTER'|'LESSER_IS_BETTER'|'SPECIFIED', 'SpecifedOrder': [ 'string', ], 'TreatUndefinedSpecifiedValues': 'LEAST'|'MOST' }, 'SemanticType': { 'TypeName': 'string', 'SubTypeName': 'string', 'TypeParameters': { 'string': 'string' }, 'TruthyCellValue': 'string', 'TruthyCellValueSynonyms': [ 'string', ], 'FalseyCellValue': 'string', 'FalseyCellValueSynonyms': [ 'string', ] }, 'AllowedAggregations': [ 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX'|'MEDIAN'|'SUM'|'AVERAGE'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE', ], 'NotAllowedAggregations': [ 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX'|'MEDIAN'|'SUM'|'AVERAGE'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE', ], 'NeverAggregateInFilter': True|False, 'CellValueSynonyms': [ { 'CellValue': 'string', 'Synonyms': [ 'string', ] }, ], 'NonAdditive': True|False }, ], 'NamedEntities': [ { 'EntityName': 'string', 'EntityDescription': 'string', 'EntitySynonyms': [ 'string', ], 'SemanticEntityType': { 'TypeName': 'string', 'SubTypeName': 'string', 'TypeParameters': { 'string': 'string' } }, 'Definition': [ { 'FieldName': 'string', 'PropertyName': 'string', 'PropertyRole': 'PRIMARY'|'ID', 'PropertyUsage': 'INHERIT'|'DIMENSION'|'MEASURE', 'Metric': { 'Aggregation': 'SUM'|'MIN'|'MAX'|'COUNT'|'AVERAGE'|'DISTINCT_COUNT'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE'|'MEDIAN'|'CUSTOM', 'AggregationFunctionParameters': { 'string': 'string' } } }, ] }, ] }, ], 'ConfigOptions': { 'QBusinessInsightsEnabled': True|False } }, Tags=[ { 'Key': 'string', 'Value': 'string' }, ], FolderArns=[ 'string', ], CustomInstructions={ 'CustomInstructionsString': 'string' } ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that you want to create a topic in. * **TopicId** (*string*) -- **[REQUIRED]** The ID for the topic that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. * **Topic** (*dict*) -- **[REQUIRED]** The definition of a topic to create. * **Name** *(string) --* The name of the topic. * **Description** *(string) --* The description of the topic. * **UserExperienceVersion** *(string) --* The user experience version of a topic. * **DataSets** *(list) --* The data sets that the topic is associated with. * *(dict) --* A structure that represents a dataset. * **DatasetArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the dataset. * **DatasetName** *(string) --* The name of the dataset. * **DatasetDescription** *(string) --* The description of the dataset. * **DataAggregation** *(dict) --* The definition of a data aggregation. * **DatasetRowDateGranularity** *(string) --* The level of time precision that is used to aggregate "DateTime" values. * **DefaultDateColumnName** *(string) --* The column name for the default date. * **Filters** *(list) --* The list of filter definitions. * *(dict) --* A structure that represents a filter used to select items for a topic. * **FilterDescription** *(string) --* A description of the filter used to select items for a topic. * **FilterClass** *(string) --* The class of the filter. Valid values for this structure are "ENFORCED_VALUE_FILTER", "CONDITIONAL_VALUE_FILTER", and "NAMED_VALUE_FILTER". * **FilterName** *(string) --* **[REQUIRED]** The name of the filter. * **FilterSynonyms** *(list) --* The other names or aliases for the filter. * *(string) --* * **OperandFieldName** *(string) --* **[REQUIRED]** The name of the field that the filter operates on. * **FilterType** *(string) --* The type of the filter. Valid values for this structure are "CATEGORY_FILTER", "NUMERIC_EQUALITY_FILTER", "NUMERIC_RANGE_FILTER", "DATE_RANGE_FILTER", and "RELATIVE_DATE_FILTER". * **CategoryFilter** *(dict) --* The category filter that is associated with this filter. * **CategoryFilterFunction** *(string) --* The category filter function. Valid values for this structure are "EXACT" and "CONTAINS". * **CategoryFilterType** *(string) --* The category filter type. This element is used to specify whether a filter is a simple category filter or an inverse category filter. * **Constant** *(dict) --* The constant used in a category filter. * **ConstantType** *(string) --* The type of category filter constant. This element is used to specify whether a constant is a singular or collective. Valid values are "SINGULAR" and "COLLECTIVE". * **SingularConstant** *(string) --* A singular constant used in a category filter. This element is used to specify a single value for the constant. * **CollectiveConstant** *(dict) --* A collective constant used in a category filter. This element is used to specify a list of values for the constant. * **ValueList** *(list) --* A list of values for the collective constant. * *(string) --* * **Inverse** *(boolean) --* A Boolean value that indicates if the filter is inverse. * **NumericEqualityFilter** *(dict) --* The numeric equality filter. * **Constant** *(dict) --* The constant used in a numeric equality filter. * **ConstantType** *(string) --* The type of the singular filter constant. Valid values for this structure are "SINGULAR". * **SingularConstant** *(string) --* The value of the singular filter constant. * **Aggregation** *(string) --* An aggregation function that specifies how to calculate the value of a numeric field for a topic. Valid values for this structure are "NO_AGGREGATION", "SUM", "AVERAGE", "COUNT", "DISTINCT_COUNT", "MAX", "MEDIAN", "MIN", "STDEV", "STDEVP", "VAR", and "VARP". * **NumericRangeFilter** *(dict) --* The numeric range filter. * **Inclusive** *(boolean) --* A Boolean value that indicates whether the endpoints of the numeric range are included in the filter. If set to true, topics whose numeric field value is equal to the endpoint values will be included in the filter. If set to false, topics whose numeric field value is equal to the endpoint values will be excluded from the filter. * **Constant** *(dict) --* The constant used in a numeric range filter. * **ConstantType** *(string) --* The data type of the constant value that is used in a range filter. Valid values for this structure are "RANGE". * **RangeConstant** *(dict) --* The value of the constant that is used to specify the endpoints of a range filter. * **Minimum** *(string) --* The minimum value for a range constant. * **Maximum** *(string) --* The maximum value for a range constant. * **Aggregation** *(string) --* An aggregation function that specifies how to calculate the value of a numeric field for a topic, Valid values for this structure are "NO_AGGREGATION", "SUM", "AVERAGE", "COUNT", "DISTINCT_COUNT", "MAX", "MEDIAN", "MIN", "STDEV", "STDEVP", "VAR", and "VARP". * **DateRangeFilter** *(dict) --* The date range filter. * **Inclusive** *(boolean) --* A Boolean value that indicates whether the date range filter should include the boundary values. If set to true, the filter includes the start and end dates. If set to false, the filter excludes them. * **Constant** *(dict) --* The constant used in a date range filter. * **ConstantType** *(string) --* The data type of the constant value that is used in a range filter. Valid values for this structure are "RANGE". * **RangeConstant** *(dict) --* The value of the constant that is used to specify the endpoints of a range filter. * **Minimum** *(string) --* The minimum value for a range constant. * **Maximum** *(string) --* The maximum value for a range constant. * **RelativeDateFilter** *(dict) --* The relative date filter. * **TimeGranularity** *(string) --* The level of time precision that is used to aggregate "DateTime" values. * **RelativeDateFilterFunction** *(string) --* The function to be used in a relative date filter to determine the range of dates to include in the results. Valid values for this structure are "BEFORE", "AFTER", and "BETWEEN". * **Constant** *(dict) --* The constant used in a relative date filter. * **ConstantType** *(string) --* The type of the singular filter constant. Valid values for this structure are "SINGULAR". * **SingularConstant** *(string) --* The value of the singular filter constant. * **Columns** *(list) --* The list of column definitions. * *(dict) --* Represents a column in a dataset. * **ColumnName** *(string) --* **[REQUIRED]** The name of the column. * **ColumnFriendlyName** *(string) --* A user-friendly name for the column. * **ColumnDescription** *(string) --* A description of the column and its contents. * **ColumnSynonyms** *(list) --* The other names or aliases for the column. * *(string) --* * **ColumnDataRole** *(string) --* The role of the column in the data. Valid values are "DIMENSION" and "MEASURE". * **Aggregation** *(string) --* The type of aggregation that is performed on the column data when it's queried. * **IsIncludedInTopic** *(boolean) --* A Boolean value that indicates whether the column is included in the query results. * **DisableIndexing** *(boolean) --* A Boolean value that indicates whether the column shows in the autocomplete functionality. * **ComparativeOrder** *(dict) --* The order in which data is displayed for the column when it's used in a comparative context. * **UseOrdering** *(string) --* The ordering type for a column. Valid values for this structure are "GREATER_IS_BETTER", "LESSER_IS_BETTER" and "SPECIFIED". * **SpecifedOrder** *(list) --* The list of columns to be used in the ordering. * *(string) --* * **TreatUndefinedSpecifiedValues** *(string) --* The treat of undefined specified values. Valid values for this structure are "LEAST" and "MOST". * **SemanticType** *(dict) --* The semantic type of data contained in the column. * **TypeName** *(string) --* The semantic type name. * **SubTypeName** *(string) --* The semantic type sub type name. * **TypeParameters** *(dict) --* The semantic type parameters. * *(string) --* * *(string) --* * **TruthyCellValue** *(string) --* The semantic type truthy cell value. * **TruthyCellValueSynonyms** *(list) --* The other names or aliases for the true cell value. * *(string) --* * **FalseyCellValue** *(string) --* The semantic type falsey cell value. * **FalseyCellValueSynonyms** *(list) --* The other names or aliases for the false cell value. * *(string) --* * **TimeGranularity** *(string) --* The level of time precision that is used to aggregate "DateTime" values. * **AllowedAggregations** *(list) --* The list of aggregation types that are allowed for the column. Valid values for this structure are "COUNT", "DISTINCT_COUNT", "MIN", "MAX", "MEDIAN", "SUM", "AVERAGE", "STDEV", "STDEVP", "VAR", "VARP", and "PERCENTILE". * *(string) --* * **NotAllowedAggregations** *(list) --* The list of aggregation types that are not allowed for the column. Valid values for this structure are "COUNT", "DISTINCT_COUNT", "MIN", "MAX", "MEDIAN", "SUM", "AVERAGE", "STDEV", "STDEVP", "VAR", "VARP", and "PERCENTILE". * *(string) --* * **DefaultFormatting** *(dict) --* The default formatting used for values in the column. * **DisplayFormat** *(string) --* The display format. Valid values for this structure are "AUTO", "PERCENT", "CURRENCY", "NUMBER", "DATE", and "STRING". * **DisplayFormatOptions** *(dict) --* The additional options for display formatting. * **UseBlankCellFormat** *(boolean) --* A Boolean value that indicates whether to use blank cell format. * **BlankCellFormat** *(string) --* Determines the blank cell format. * **DateFormat** *(string) --* Determines the "DateTime" format. * **DecimalSeparator** *(string) --* Determines the decimal separator. * **GroupingSeparator** *(string) --* Determines the grouping separator. * **UseGrouping** *(boolean) --* A Boolean value that indicates whether to use grouping. * **FractionDigits** *(integer) --* Determines the number of fraction digits. * **Prefix** *(string) --* The prefix value for a display format. * **Suffix** *(string) --* The suffix value for a display format. * **UnitScaler** *(string) --* The unit scaler. Valid values for this structure are: "NONE", "AUTO", "THOUSANDS", "MILLIONS", "BILLIONS", and "TRILLIONS". * **NegativeFormat** *(dict) --* The negative format. * **Prefix** *(string) --* The prefix for a negative format. * **Suffix** *(string) --* The suffix for a negative format. * **CurrencySymbol** *(string) --* The currency symbol, such as "USD". * **NeverAggregateInFilter** *(boolean) --* A Boolean value that indicates whether to aggregate the column data when it's used in a filter context. * **CellValueSynonyms** *(list) --* The other names or aliases for the column cell value. * *(dict) --* A structure that represents the cell value synonym. * **CellValue** *(string) --* The cell value. * **Synonyms** *(list) --* Other names or aliases for the cell value. * *(string) --* * **NonAdditive** *(boolean) --* The non additive value for the column. * **CalculatedFields** *(list) --* The list of calculated field definitions. * *(dict) --* A structure that represents a calculated field. * **CalculatedFieldName** *(string) --* **[REQUIRED]** The calculated field name. * **CalculatedFieldDescription** *(string) --* The calculated field description. * **Expression** *(string) --* **[REQUIRED]** The calculated field expression. * **CalculatedFieldSynonyms** *(list) --* The other names or aliases for the calculated field. * *(string) --* * **IsIncludedInTopic** *(boolean) --* A boolean value that indicates if a calculated field is included in the topic. * **DisableIndexing** *(boolean) --* A Boolean value that indicates if a calculated field is visible in the autocomplete. * **ColumnDataRole** *(string) --* The column data role for a calculated field. Valid values for this structure are "DIMENSION" and "MEASURE". * **TimeGranularity** *(string) --* The level of time precision that is used to aggregate "DateTime" values. * **DefaultFormatting** *(dict) --* The default formatting definition. * **DisplayFormat** *(string) --* The display format. Valid values for this structure are "AUTO", "PERCENT", "CURRENCY", "NUMBER", "DATE", and "STRING". * **DisplayFormatOptions** *(dict) --* The additional options for display formatting. * **UseBlankCellFormat** *(boolean) --* A Boolean value that indicates whether to use blank cell format. * **BlankCellFormat** *(string) --* Determines the blank cell format. * **DateFormat** *(string) --* Determines the "DateTime" format. * **DecimalSeparator** *(string) --* Determines the decimal separator. * **GroupingSeparator** *(string) --* Determines the grouping separator. * **UseGrouping** *(boolean) --* A Boolean value that indicates whether to use grouping. * **FractionDigits** *(integer) --* Determines the number of fraction digits. * **Prefix** *(string) --* The prefix value for a display format. * **Suffix** *(string) --* The suffix value for a display format. * **UnitScaler** *(string) --* The unit scaler. Valid values for this structure are: "NONE", "AUTO", "THOUSANDS", "MILLIONS", "BILLIONS", and "TRILLIONS". * **NegativeFormat** *(dict) --* The negative format. * **Prefix** *(string) --* The prefix for a negative format. * **Suffix** *(string) --* The suffix for a negative format. * **CurrencySymbol** *(string) --* The currency symbol, such as "USD". * **Aggregation** *(string) --* The default aggregation. Valid values for this structure are "SUM", "MAX", "MIN", "COUNT", "DISTINCT_COUNT", and "AVERAGE". * **ComparativeOrder** *(dict) --* The order in which data is displayed for the calculated field when it's used in a comparative context. * **UseOrdering** *(string) --* The ordering type for a column. Valid values for this structure are "GREATER_IS_BETTER", "LESSER_IS_BETTER" and "SPECIFIED". * **SpecifedOrder** *(list) --* The list of columns to be used in the ordering. * *(string) --* * **TreatUndefinedSpecifiedValues** *(string) --* The treat of undefined specified values. Valid values for this structure are "LEAST" and "MOST". * **SemanticType** *(dict) --* The semantic type. * **TypeName** *(string) --* The semantic type name. * **SubTypeName** *(string) --* The semantic type sub type name. * **TypeParameters** *(dict) --* The semantic type parameters. * *(string) --* * *(string) --* * **TruthyCellValue** *(string) --* The semantic type truthy cell value. * **TruthyCellValueSynonyms** *(list) --* The other names or aliases for the true cell value. * *(string) --* * **FalseyCellValue** *(string) --* The semantic type falsey cell value. * **FalseyCellValueSynonyms** *(list) --* The other names or aliases for the false cell value. * *(string) --* * **AllowedAggregations** *(list) --* The list of aggregation types that are allowed for the calculated field. Valid values for this structure are "COUNT", "DISTINCT_COUNT", "MIN", "MAX", "MEDIAN", "SUM", "AVERAGE", "STDEV", "STDEVP", "VAR", "VARP", and "PERCENTILE". * *(string) --* * **NotAllowedAggregations** *(list) --* The list of aggregation types that are not allowed for the calculated field. Valid values for this structure are "COUNT", "DISTINCT_COUNT", "MIN", "MAX", "MEDIAN", "SUM", "AVERAGE", "STDEV", "STDEVP", "VAR", "VARP", and "PERCENTILE". * *(string) --* * **NeverAggregateInFilter** *(boolean) --* A Boolean value that indicates whether to never aggregate calculated field in filters. * **CellValueSynonyms** *(list) --* The other names or aliases for the calculated field cell value. * *(dict) --* A structure that represents the cell value synonym. * **CellValue** *(string) --* The cell value. * **Synonyms** *(list) --* Other names or aliases for the cell value. * *(string) --* * **NonAdditive** *(boolean) --* The non additive for the table style target. * **NamedEntities** *(list) --* The list of named entities definitions. * *(dict) --* A structure that represents a named entity. * **EntityName** *(string) --* **[REQUIRED]** The name of the named entity. * **EntityDescription** *(string) --* The description of the named entity. * **EntitySynonyms** *(list) --* The other names or aliases for the named entity. * *(string) --* * **SemanticEntityType** *(dict) --* The type of named entity that a topic represents. * **TypeName** *(string) --* The semantic entity type name. * **SubTypeName** *(string) --* The semantic entity sub type name. * **TypeParameters** *(dict) --* The semantic entity type parameters. * *(string) --* * *(string) --* * **Definition** *(list) --* The definition of a named entity. * *(dict) --* A structure that represents a named entity. * **FieldName** *(string) --* The name of the entity. * **PropertyName** *(string) --* The property name to be used for the named entity. * **PropertyRole** *(string) --* The property role. Valid values for this structure are "PRIMARY" and "ID". * **PropertyUsage** *(string) --* The property usage. Valid values for this structure are "INHERIT", "DIMENSION", and "MEASURE". * **Metric** *(dict) --* The definition of a metric. * **Aggregation** *(string) --* The aggregation of a named entity. Valid values for this structure are "SUM", "MIN", "MAX", "COUNT", "AVERAGE", "DISTINCT_COUNT", "STDEV", "STDEVP", "VAR", "VARP", "PERCENTILE", "MEDIAN", and "CUSTOM". * **AggregationFunctionParameters** *(dict) --* The additional parameters for an aggregation function. * *(string) --* * *(string) --* * **ConfigOptions** *(dict) --* Configuration options for a "Topic". * **QBusinessInsightsEnabled** *(boolean) --* Enables Amazon Q Business Insights for a "Topic". * **Tags** (*list*) -- Contains a map of the key-value pairs for the resource tag or tags that are assigned to the dataset. * *(dict) --* The key or keys of the key-value pairs for the resource tag or tags assigned to the resource. * **Key** *(string) --* **[REQUIRED]** Tag key. * **Value** *(string) --* **[REQUIRED]** Tag value. * **FolderArns** (*list*) -- The Folder ARN of the folder that you want the topic to reside in. * *(string) --* * **CustomInstructions** (*dict*) -- Custom instructions for the topic. * **CustomInstructionsString** *(string) --* **[REQUIRED]** A text field for providing additional guidance or context for response generation. Return type: dict Returns: **Response Syntax** { 'Arn': 'string', 'TopicId': 'string', 'RefreshArn': 'string', 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **Arn** *(string) --* The Amazon Resource Name (ARN) of the topic. * **TopicId** *(string) --* The ID for the topic that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. * **RefreshArn** *(string) --* The Amazon Resource Name (ARN) of the topic refresh. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.LimitExceededException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ResourceExistsException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / list_themes list_themes *********** QuickSight.Client.list_themes(**kwargs) Lists all the themes in the current Amazon Web Services account. See also: AWS API Documentation **Request Syntax** response = client.list_themes( AwsAccountId='string', NextToken='string', MaxResults=123, Type='QUICKSIGHT'|'CUSTOM'|'ALL' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the themes that you're listing. * **NextToken** (*string*) -- The token for the next set of results, or null if there are no more results. * **MaxResults** (*integer*) -- The maximum number of results to be returned per request. * **Type** (*string*) -- The type of themes that you want to list. Valid options include the following: * "ALL (default)"- Display all existing themes. * "CUSTOM" - Display only the themes created by people using Amazon QuickSight. * "QUICKSIGHT" - Display only the starting themes defined by Amazon QuickSight. Return type: dict Returns: **Response Syntax** { 'ThemeSummaryList': [ { 'Arn': 'string', 'Name': 'string', 'ThemeId': 'string', 'LatestVersionNumber': 123, 'CreatedTime': datetime(2015, 1, 1), 'LastUpdatedTime': datetime(2015, 1, 1) }, ], 'NextToken': 'string', 'Status': 123, 'RequestId': 'string' } **Response Structure** * *(dict) --* * **ThemeSummaryList** *(list) --* Information about the themes in the list. * *(dict) --* The theme summary. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the resource. * **Name** *(string) --* the display name for the theme. * **ThemeId** *(string) --* The ID of the theme. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. * **LatestVersionNumber** *(integer) --* The latest version number for the theme. * **CreatedTime** *(datetime) --* The date and time that this theme was created. * **LastUpdatedTime** *(datetime) --* The last date and time that this theme was updated. * **NextToken** *(string) --* The token for the next set of results, or null if there are no more results. * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.InvalidNextTokenException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / list_asset_bundle_import_jobs list_asset_bundle_import_jobs ***************************** QuickSight.Client.list_asset_bundle_import_jobs(**kwargs) Lists all asset bundle import jobs that have taken place in the last 14 days. Jobs created more than 14 days ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs, "ListAssetBundleImportJobs" only returns the most recent job that uses the repeated job ID. See also: AWS API Documentation **Request Syntax** response = client.list_asset_bundle_import_jobs( AwsAccountId='string', NextToken='string', MaxResults=123 ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that the import jobs were executed in. * **NextToken** (*string*) -- The token for the next set of results, or null if there are no more results. * **MaxResults** (*integer*) -- The maximum number of results to be returned per request. Return type: dict Returns: **Response Syntax** { 'AssetBundleImportJobSummaryList': [ { 'JobStatus': 'QUEUED_FOR_IMMEDIATE_EXECUTION'|'IN_PROGRESS'|'SUCCESSFUL'|'FAILED'|'FAILED_ROLLBACK_IN_PROGRESS'|'FAILED_ROLLBACK_COMPLETED'|'FAILED_ROLLBACK_ERROR', 'Arn': 'string', 'CreatedTime': datetime(2015, 1, 1), 'AssetBundleImportJobId': 'string', 'FailureAction': 'DO_NOTHING'|'ROLLBACK' }, ], 'NextToken': 'string', 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **AssetBundleImportJobSummaryList** *(list) --* A list of import job summaries. * *(dict) --* A summary of the import job that includes details of the requested job's configuration and its current status. * **JobStatus** *(string) --* The current status of the import job. * **Arn** *(string) --* The ARN of the import job. * **CreatedTime** *(datetime) --* The time that the import job was created. * **AssetBundleImportJobId** *(string) --* The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job. * **FailureAction** *(string) --* The failure action for the import job. * **NextToken** *(string) --* The token for the next set of results, or null if there are no more results. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the response. **Exceptions** * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidNextTokenException" * "QuickSight.Client.exceptions.ResourceNotFoundException" QuickSight / Client / describe_brand_published_version describe_brand_published_version ******************************** QuickSight.Client.describe_brand_published_version(**kwargs) Describes the published version of the brand. See also: AWS API Documentation **Request Syntax** response = client.describe_brand_published_version( AwsAccountId='string', BrandId='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that owns the brand. * **BrandId** (*string*) -- **[REQUIRED]** The ID of the Amazon QuickSight brand. Return type: dict Returns: **Response Syntax** { 'RequestId': 'string', 'BrandDetail': { 'BrandId': 'string', 'Arn': 'string', 'BrandStatus': 'CREATE_IN_PROGRESS'|'CREATE_SUCCEEDED'|'CREATE_FAILED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED', 'CreatedTime': datetime(2015, 1, 1), 'LastUpdatedTime': datetime(2015, 1, 1), 'VersionId': 'string', 'VersionStatus': 'CREATE_IN_PROGRESS'|'CREATE_SUCCEEDED'|'CREATE_FAILED', 'Errors': [ 'string', ], 'Logo': { 'AltText': 'string', 'LogoSet': { 'Primary': { 'Original': { 'Source': { 'PublicUrl': 'string', 'S3Uri': 'string' }, 'GeneratedImageUrl': 'string' }, 'Height64': { 'Source': { 'PublicUrl': 'string', 'S3Uri': 'string' }, 'GeneratedImageUrl': 'string' }, 'Height32': { 'Source': { 'PublicUrl': 'string', 'S3Uri': 'string' }, 'GeneratedImageUrl': 'string' } }, 'Favicon': { 'Original': { 'Source': { 'PublicUrl': 'string', 'S3Uri': 'string' }, 'GeneratedImageUrl': 'string' }, 'Height64': { 'Source': { 'PublicUrl': 'string', 'S3Uri': 'string' }, 'GeneratedImageUrl': 'string' }, 'Height32': { 'Source': { 'PublicUrl': 'string', 'S3Uri': 'string' }, 'GeneratedImageUrl': 'string' } } } } }, 'BrandDefinition': { 'BrandName': 'string', 'Description': 'string', 'ApplicationTheme': { 'BrandColorPalette': { 'Primary': { 'Foreground': 'string', 'Background': 'string' }, 'Secondary': { 'Foreground': 'string', 'Background': 'string' }, 'Accent': { 'Foreground': 'string', 'Background': 'string' }, 'Measure': { 'Foreground': 'string', 'Background': 'string' }, 'Dimension': { 'Foreground': 'string', 'Background': 'string' }, 'Success': { 'Foreground': 'string', 'Background': 'string' }, 'Info': { 'Foreground': 'string', 'Background': 'string' }, 'Warning': { 'Foreground': 'string', 'Background': 'string' }, 'Danger': { 'Foreground': 'string', 'Background': 'string' } }, 'BrandElementStyle': { 'NavbarStyle': { 'GlobalNavbar': { 'Foreground': 'string', 'Background': 'string' }, 'ContextualNavbar': { 'Foreground': 'string', 'Background': 'string' } } } }, 'LogoConfiguration': { 'AltText': 'string', 'LogoSet': { 'Primary': { 'Original': { 'Source': { 'PublicUrl': 'string', 'S3Uri': 'string' } } }, 'Favicon': { 'Original': { 'Source': { 'PublicUrl': 'string', 'S3Uri': 'string' } } } } } } } **Response Structure** * *(dict) --* * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **BrandDetail** *(dict) --* The details of the brand. * **BrandId** *(string) --* The ID of the Amazon QuickSight brand. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the brand. * **BrandStatus** *(string) --* The status of the brand. * **CreatedTime** *(datetime) --* The time that the brand was created. * **LastUpdatedTime** *(datetime) --* The last time the brand was updated. * **VersionId** *(string) --* The ID of the version. * **VersionStatus** *(string) --* The status of the version. * **Errors** *(list) --* A list of errors that occurred during the most recent brand operation. * *(string) --* * **Logo** *(dict) --* The logo details. * **AltText** *(string) --* The alt text for the logo. * **LogoSet** *(dict) --* A set of configured logos. * **Primary** *(dict) --* The primary logo. * **Original** *(dict) --* The original image. * **Source** *(dict) --* The source of the logo image. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "PublicUrl", "S3Uri". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **PublicUrl** *(string) --* The public URL that points to the source image. * **S3Uri** *(string) --* The Amazon S3 URI that points to the source image. * **GeneratedImageUrl** *(string) --* The URL that points to the generated logo image. * **Height64** *(dict) --* The image with the height set to 64 pixels. * **Source** *(dict) --* The source of the logo image. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "PublicUrl", "S3Uri". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **PublicUrl** *(string) --* The public URL that points to the source image. * **S3Uri** *(string) --* The Amazon S3 URI that points to the source image. * **GeneratedImageUrl** *(string) --* The URL that points to the generated logo image. * **Height32** *(dict) --* The image with the height set to 32 pixels. * **Source** *(dict) --* The source of the logo image. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "PublicUrl", "S3Uri". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **PublicUrl** *(string) --* The public URL that points to the source image. * **S3Uri** *(string) --* The Amazon S3 URI that points to the source image. * **GeneratedImageUrl** *(string) --* The URL that points to the generated logo image. * **Favicon** *(dict) --* The favicon logo. * **Original** *(dict) --* The original image. * **Source** *(dict) --* The source of the logo image. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "PublicUrl", "S3Uri". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **PublicUrl** *(string) --* The public URL that points to the source image. * **S3Uri** *(string) --* The Amazon S3 URI that points to the source image. * **GeneratedImageUrl** *(string) --* The URL that points to the generated logo image. * **Height64** *(dict) --* The image with the height set to 64 pixels. * **Source** *(dict) --* The source of the logo image. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "PublicUrl", "S3Uri". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **PublicUrl** *(string) --* The public URL that points to the source image. * **S3Uri** *(string) --* The Amazon S3 URI that points to the source image. * **GeneratedImageUrl** *(string) --* The URL that points to the generated logo image. * **Height32** *(dict) --* The image with the height set to 32 pixels. * **Source** *(dict) --* The source of the logo image. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "PublicUrl", "S3Uri". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **PublicUrl** *(string) --* The public URL that points to the source image. * **S3Uri** *(string) --* The Amazon S3 URI that points to the source image. * **GeneratedImageUrl** *(string) --* The URL that points to the generated logo image. * **BrandDefinition** *(dict) --* The definition of the brand. * **BrandName** *(string) --* The name of the brand. * **Description** *(string) --* The description of the brand. * **ApplicationTheme** *(dict) --* The application theme of the brand. * **BrandColorPalette** *(dict) --* The color palette. * **Primary** *(dict) --* The primary color. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **Secondary** *(dict) --* The secondary color. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **Accent** *(dict) --* The color that is used for accent elements. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **Measure** *(dict) --* The color that is used for measure elements. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **Dimension** *(dict) --* The color that is used for dimension elements. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **Success** *(dict) --* The color that is used for success elements. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **Info** *(dict) --* The color that is used for info elements. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **Warning** *(dict) --* The color that is used for warning elements. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **Danger** *(dict) --* The color that is used for danger elements. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **BrandElementStyle** *(dict) --* The element style. * **NavbarStyle** *(dict) --* The navigation bar style. * **GlobalNavbar** *(dict) --* The global navigation bar style. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **ContextualNavbar** *(dict) --* The contextual navigation bar style. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **LogoConfiguration** *(dict) --* The logo configuration of the brand. * **AltText** *(string) --* The alt text for the logo. * **LogoSet** *(dict) --* A set of configured logos. * **Primary** *(dict) --* The primary logo. * **Original** *(dict) --* The original image. * **Source** *(dict) --* The source of the image. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "PublicUrl", "S3Uri". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **PublicUrl** *(string) --* The public URL that points to the source image. * **S3Uri** *(string) --* The Amazon S3 URI that points to the source image. * **Favicon** *(dict) --* The favicon logo. * **Original** *(dict) --* The original image. * **Source** *(dict) --* The source of the image. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "PublicUrl", "S3Uri". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **PublicUrl** *(string) --* The public URL that points to the source image. * **S3Uri** *(string) --* The Amazon S3 URI that points to the source image. **Exceptions** * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InvalidRequestException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InternalServerException" QuickSight / Client / list_tags_for_resource list_tags_for_resource ********************** QuickSight.Client.list_tags_for_resource(**kwargs) Lists the tags assigned to a resource. See also: AWS API Documentation **Request Syntax** response = client.list_tags_for_resource( ResourceArn='string' ) Parameters: **ResourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the resource that you want a list of tags for. Return type: dict Returns: **Response Syntax** { 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **Tags** *(list) --* Contains a map of the key-value pairs for the resource tag or tags assigned to the resource. * *(dict) --* The key or keys of the key-value pairs for the resource tag or tags assigned to the resource. * **Key** *(string) --* Tag key. * **Value** *(string) --* Tag value. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / describe_group describe_group ************** QuickSight.Client.describe_group(**kwargs) Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN). See also: AWS API Documentation **Request Syntax** response = client.describe_group( GroupName='string', AwsAccountId='string', Namespace='string' ) Parameters: * **GroupName** (*string*) -- **[REQUIRED]** The name of the group that you want to describe. * **AwsAccountId** (*string*) -- **[REQUIRED]** 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** (*string*) -- **[REQUIRED]** The namespace of the group that you want described. Return type: dict Returns: **Response Syntax** { 'Group': { 'Arn': 'string', 'GroupName': 'string', 'Description': 'string', 'PrincipalId': 'string' }, 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **Group** *(dict) --* The name of the group. * **Arn** *(string) --* The Amazon Resource Name (ARN) for the group. * **GroupName** *(string) --* The name of the group. * **Description** *(string) --* The group description. * **PrincipalId** *(string) --* The principal ID of the group. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.PreconditionNotMetException" * "QuickSight.Client.exceptions.InternalFailureException" * "QuickSight.Client.exceptions.ResourceUnavailableException" QuickSight / Client / describe_iam_policy_assignment describe_iam_policy_assignment ****************************** QuickSight.Client.describe_iam_policy_assignment(**kwargs) Describes an existing IAM policy assignment, as specified by the assignment name. See also: AWS API Documentation **Request Syntax** response = client.describe_iam_policy_assignment( AwsAccountId='string', AssignmentName='string', Namespace='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the assignment that you want to describe. * **AssignmentName** (*string*) -- **[REQUIRED]** The name of the assignment, also called a rule. * **Namespace** (*string*) -- **[REQUIRED]** The namespace that contains the assignment. Return type: dict Returns: **Response Syntax** { 'IAMPolicyAssignment': { 'AwsAccountId': 'string', 'AssignmentId': 'string', 'AssignmentName': 'string', 'PolicyArn': 'string', 'Identities': { 'string': [ 'string', ] }, 'AssignmentStatus': 'ENABLED'|'DRAFT'|'DISABLED' }, 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **IAMPolicyAssignment** *(dict) --* Information describing the IAM policy assignment. * **AwsAccountId** *(string) --* The Amazon Web Services account ID. * **AssignmentId** *(string) --* Assignment ID. * **AssignmentName** *(string) --* Assignment name. * **PolicyArn** *(string) --* The Amazon Resource Name (ARN) for the IAM policy. * **Identities** *(dict) --* Identities. * *(string) --* * *(list) --* * *(string) --* * **AssignmentStatus** *(string) --* Assignment status. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InvalidNextTokenException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / list_template_aliases list_template_aliases ********************* QuickSight.Client.list_template_aliases(**kwargs) Lists all the aliases of a template. See also: AWS API Documentation **Request Syntax** response = client.list_template_aliases( AwsAccountId='string', TemplateId='string', NextToken='string', MaxResults=123 ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the template aliases that you're listing. * **TemplateId** (*string*) -- **[REQUIRED]** The ID for the template. * **NextToken** (*string*) -- The token for the next set of results, or null if there are no more results. * **MaxResults** (*integer*) -- The maximum number of results to be returned per request. Return type: dict Returns: **Response Syntax** { 'TemplateAliasList': [ { 'AliasName': 'string', 'Arn': 'string', 'TemplateVersionNumber': 123 }, ], 'Status': 123, 'RequestId': 'string', 'NextToken': 'string' } **Response Structure** * *(dict) --* * **TemplateAliasList** *(list) --* A structure containing the list of the template's aliases. * *(dict) --* The template alias. * **AliasName** *(string) --* The display name of the template alias. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the template alias. * **TemplateVersionNumber** *(integer) --* The version number of the template alias. * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **NextToken** *(string) --* The token for the next set of results, or null if there are no more results. **Exceptions** * "QuickSight.Client.exceptions.InvalidNextTokenException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / delete_data_set delete_data_set *************** QuickSight.Client.delete_data_set(**kwargs) Deletes a dataset. See also: AWS API Documentation **Request Syntax** response = client.delete_data_set( AwsAccountId='string', DataSetId='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The Amazon Web Services account ID. * **DataSetId** (*string*) -- **[REQUIRED]** 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. Return type: dict Returns: **Response Syntax** { 'Arn': 'string', 'DataSetId': 'string', 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **Arn** *(string) --* The Amazon Resource Name (ARN) of the dataset. * **DataSetId** *(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. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / create_folder_membership create_folder_membership ************************ QuickSight.Client.create_folder_membership(**kwargs) Adds an asset, such as a dashboard, analysis, or dataset into a folder. See also: AWS API Documentation **Request Syntax** response = client.create_folder_membership( AwsAccountId='string', FolderId='string', MemberId='string', MemberType='DASHBOARD'|'ANALYSIS'|'DATASET'|'DATASOURCE'|'TOPIC' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID for the Amazon Web Services account that contains the folder. * **FolderId** (*string*) -- **[REQUIRED]** The ID of the folder. * **MemberId** (*string*) -- **[REQUIRED]** The ID of the asset that you want to add to the folder. * **MemberType** (*string*) -- **[REQUIRED]** The member type of the asset that you want to add to a folder. Return type: dict Returns: **Response Syntax** { 'Status': 123, 'FolderMember': { 'MemberId': 'string', 'MemberType': 'DASHBOARD'|'ANALYSIS'|'DATASET'|'DATASOURCE'|'TOPIC' }, 'RequestId': 'string' } **Response Structure** * *(dict) --* * **Status** *(integer) --* The HTTP status of the request. * **FolderMember** *(dict) --* Information about the member in the folder. * **MemberId** *(string) --* The ID of an asset in the folder. * **MemberType** *(string) --* The type of asset that it is. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ResourceExistsException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.LimitExceededException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / describe_template_alias describe_template_alias *********************** QuickSight.Client.describe_template_alias(**kwargs) Describes the template alias for a template. See also: AWS API Documentation **Request Syntax** response = client.describe_template_alias( AwsAccountId='string', TemplateId='string', AliasName='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the template alias that you're describing. * **TemplateId** (*string*) -- **[REQUIRED]** The ID for the template. * **AliasName** (*string*) -- **[REQUIRED]** 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. Return type: dict Returns: **Response Syntax** { 'TemplateAlias': { 'AliasName': 'string', 'Arn': 'string', 'TemplateVersionNumber': 123 }, 'Status': 123, 'RequestId': 'string' } **Response Structure** * *(dict) --* * **TemplateAlias** *(dict) --* Information about the template alias. * **AliasName** *(string) --* The display name of the template alias. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the template alias. * **TemplateVersionNumber** *(integer) --* The version number of the template alias. * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / generate_embed_url_for_registered_user generate_embed_url_for_registered_user ************************************** QuickSight.Client.generate_embed_url_for_registered_user(**kwargs) Generates an embed URL that you can use to embed an Amazon QuickSight experience in your website. This action can be used for any type of user registered in an Amazon QuickSight account. Before you use this action, make sure that you have configured the relevant Amazon QuickSight resource and permissions. The following rules apply to the generated URL: * It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again. * The URL validity period should not be confused with the actual session lifetime that can be customized using the "SessionLifetimeInMinutes" parameter. The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours. * You are charged only when the URL is used or there is interaction with Amazon QuickSight. For more information, see Embedded Analytics in the *Amazon QuickSight User Guide*. For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal. See also: AWS API Documentation **Request Syntax** response = client.generate_embed_url_for_registered_user( AwsAccountId='string', SessionLifetimeInMinutes=123, UserArn='string', ExperienceConfiguration={ 'Dashboard': { 'InitialDashboardId': 'string', 'FeatureConfigurations': { 'StatePersistence': { 'Enabled': True|False }, 'SharedView': { 'Enabled': True|False }, 'Bookmarks': { 'Enabled': True|False }, 'AmazonQInQuickSight': { 'ExecutiveSummary': { 'Enabled': True|False } }, 'Schedules': { 'Enabled': True|False }, 'RecentSnapshots': { 'Enabled': True|False }, 'ThresholdAlerts': { 'Enabled': True|False } } }, 'QuickSightConsole': { 'InitialPath': 'string', 'FeatureConfigurations': { 'StatePersistence': { 'Enabled': True|False }, 'SharedView': { 'Enabled': True|False }, 'AmazonQInQuickSight': { 'DataQnA': { 'Enabled': True|False }, 'GenerativeAuthoring': { 'Enabled': True|False }, 'ExecutiveSummary': { 'Enabled': True|False }, 'DataStories': { 'Enabled': True|False } }, 'Schedules': { 'Enabled': True|False }, 'RecentSnapshots': { 'Enabled': True|False }, 'ThresholdAlerts': { 'Enabled': True|False } } }, 'QSearchBar': { 'InitialTopicId': 'string' }, 'DashboardVisual': { 'InitialDashboardVisualId': { 'DashboardId': 'string', 'SheetId': 'string', 'VisualId': 'string' } }, 'GenerativeQnA': { 'InitialTopicId': 'string' } }, AllowedDomains=[ 'string', ] ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID for the Amazon Web Services account that contains the dashboard that you're embedding. * **SessionLifetimeInMinutes** (*integer*) -- How many minutes the session is valid. The session lifetime must be in [15-600] minutes range. * **UserArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name for the registered user. * **ExperienceConfiguration** (*dict*) -- **[REQUIRED]** The experience that you want to embed. For registered users, you can embed Amazon QuickSight dashboards, Amazon QuickSight visuals, the Amazon QuickSight Q search bar, the Amazon QuickSight Generative Q&A experience, or the entire Amazon QuickSight console. * **Dashboard** *(dict) --* The configuration details for providing a dashboard embedding experience. * **InitialDashboardId** *(string) --* **[REQUIRED]** The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this dashboard if the user has permissions to view it. If the user does not have permission to view this dashboard, they see a permissions error message. * **FeatureConfigurations** *(dict) --* The feature configurations of an embbedded Amazon QuickSight dashboard. * **StatePersistence** *(dict) --* The state persistence settings of an embedded dashboard. * **Enabled** *(boolean) --* **[REQUIRED]** Determines if a Amazon QuickSight dashboard's state persistence settings are turned on or off. * **SharedView** *(dict) --* The shared view settings of an embedded dashboard. * **Enabled** *(boolean) --* **[REQUIRED]** The shared view settings of an embedded dashboard. * **Bookmarks** *(dict) --* The bookmarks configuration for an embedded dashboard in Amazon QuickSight. * **Enabled** *(boolean) --* **[REQUIRED]** A Boolean value that determines whether a user can bookmark an embedded dashboard. * **AmazonQInQuickSight** *(dict) --* The Amazon Q configurations of an embedded Amazon QuickSight dashboard. * **ExecutiveSummary** *(dict) --* A generated executive summary of an embedded Amazon QuickSight dashboard. * **Enabled** *(boolean) --* **[REQUIRED]** The executive summary settings of an embedded Amazon QuickSight console or dashboard. * **Schedules** *(dict) --* The schedules configuration for an embedded Amazon QuickSight dashboard. * **Enabled** *(boolean) --* **[REQUIRED]** The schedules configuration for an embedded Amazon QuickSight dashboard. * **RecentSnapshots** *(dict) --* The recent snapshots configuration for an Amazon QuickSight embedded dashboard * **Enabled** *(boolean) --* **[REQUIRED]** The recent snapshots configuration for an embedded Amazon QuickSight dashboard. * **ThresholdAlerts** *(dict) --* The threshold alerts configuration for an Amazon QuickSight embedded dashboard. * **Enabled** *(boolean) --* **[REQUIRED]** The threshold alerts configuration for an embedded Amazon QuickSight dashboard. * **QuickSightConsole** *(dict) --* The configuration details for providing each Amazon QuickSight console embedding experience. This can be used along with custom permissions to restrict access to certain features. For more information, see Customizing Access to the Amazon QuickSight Console in the *Amazon QuickSight User Guide*. Use "GenerateEmbedUrlForRegisteredUser" where you want to provide an authoring portal that allows users to create data sources, datasets, analyses, and dashboards. The users who accesses an embedded Amazon QuickSight console needs to belong to the author or admin security cohort. If you want to restrict permissions to some of these features, add a custom permissions profile to the user with the "UpdateUser" API operation. Use the "RegisterUser" API operation to add a new user with a custom permission profile attached. For more information, see the following sections in the *Amazon QuickSight User Guide*: * Embedding the Full Functionality of the Amazon QuickSight Console for Authenticated Users * Customizing Access to the Amazon QuickSight Console For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal. * **InitialPath** *(string) --* The initial URL path for the Amazon QuickSight console. "InitialPath" is required. The entry point URL is constrained to the following paths: * "/start" * "/start/analyses" * "/start/dashboards" * "/start/favorites" * "/dashboards/DashboardId". *DashboardId* is the actual ID key from the Amazon QuickSight console URL of the dashboard. * "/analyses/AnalysisId". *AnalysisId* is the actual ID key from the Amazon QuickSight console URL of the analysis. * **FeatureConfigurations** *(dict) --* The embedding configuration of an embedded Amazon QuickSight console. * **StatePersistence** *(dict) --* The state persistence configurations of an embedded Amazon QuickSight console. * **Enabled** *(boolean) --* **[REQUIRED]** Determines if a Amazon QuickSight dashboard's state persistence settings are turned on or off. * **SharedView** *(dict) --* The shared view settings of an embedded dashboard. * **Enabled** *(boolean) --* **[REQUIRED]** The shared view settings of an embedded dashboard. * **AmazonQInQuickSight** *(dict) --* The Amazon Q configurations of an embedded Amazon QuickSight console. * **DataQnA** *(dict) --* Adds generative Q&A capabilitiees to an embedded Amazon QuickSight console. * **Enabled** *(boolean) --* **[REQUIRED]** The generative Q&A settings of an embedded Amazon QuickSight console. * **GenerativeAuthoring** *(dict) --* Adds the generative BI authoring experience to an embedded Amazon QuickSight console. * **Enabled** *(boolean) --* **[REQUIRED]** The generative BI authoring settings of an embedded Amazon QuickSight console. * **ExecutiveSummary** *(dict) --* Adds the executive summaries feature to an embedded Amazon QuickSight console. * **Enabled** *(boolean) --* **[REQUIRED]** The executive summary settings of an embedded Amazon QuickSight console or dashboard. * **DataStories** *(dict) --* Adds the data stories feature to an embedded Amazon QuickSight console. * **Enabled** *(boolean) --* **[REQUIRED]** The data story settings of an embedded Amazon QuickSight console. * **Schedules** *(dict) --* The schedules configuration for an embedded Amazon QuickSight dashboard. * **Enabled** *(boolean) --* **[REQUIRED]** The schedules configuration for an embedded Amazon QuickSight dashboard. * **RecentSnapshots** *(dict) --* The recent snapshots configuration for an embedded Amazon QuickSight dashboard. * **Enabled** *(boolean) --* **[REQUIRED]** The recent snapshots configuration for an embedded Amazon QuickSight dashboard. * **ThresholdAlerts** *(dict) --* The threshold alerts configuration for an embedded Amazon QuickSight dashboard. * **Enabled** *(boolean) --* **[REQUIRED]** The threshold alerts configuration for an embedded Amazon QuickSight dashboard. * **QSearchBar** *(dict) --* The configuration details for embedding the Q search bar. For more information about embedding the Q search bar, see Embedding Overview in the *Amazon QuickSight User Guide*. * **InitialTopicId** *(string) --* The ID of the legacy Q topic that you want to use as the starting topic in the Q search bar. To locate the topic ID of the topic that you want to use, open the Amazon QuickSight console, navigate to the **Topics** pane, and choose thre topic that you want to use. The "TopicID" is located in the URL of the topic that opens. When you select an initial topic, you can specify whether or not readers are allowed to select other topics from the list of available topics. If you don't specify an initial topic or if you specify a new reader experience topic, a list of all shared legacy topics is shown in the Q bar. * **DashboardVisual** *(dict) --* The type of embedding experience. In this case, Amazon QuickSight visuals. * **InitialDashboardVisualId** *(dict) --* **[REQUIRED]** The visual ID for the visual that you want the user to embed. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this visual. The Amazon Resource Name (ARN) of the dashboard that the visual belongs to must be included in the "AuthorizedResourceArns" parameter. Otherwise, the request will fail with "InvalidParameterValueException". * **DashboardId** *(string) --* **[REQUIRED]** The ID of the dashboard that has the visual that you want to embed. The "DashboardId" can be found in the "IDs for developers" section of the "Embed visual" pane of the visual's on-visual menu of the Amazon QuickSight console. You can also get the "DashboardId" with a "ListDashboards" API operation. * **SheetId** *(string) --* **[REQUIRED]** The ID of the sheet that the has visual that you want to embed. The "SheetId" can be found in the "IDs for developers" section of the "Embed visual" pane of the visual's on-visual menu of the Amazon QuickSight console. * **VisualId** *(string) --* **[REQUIRED]** The ID of the visual that you want to embed. The "VisualID" can be found in the "IDs for developers" section of the "Embed visual" pane of the visual's on- visual menu of the Amazon QuickSight console. * **GenerativeQnA** *(dict) --* The configuration details for embedding the Generative Q&A experience. For more information about embedding the Generative Q&A experience, see Embedding Overview in the *Amazon QuickSight User Guide*. * **InitialTopicId** *(string) --* The ID of the new Q reader experience topic that you want to make the starting topic in the Generative Q&A experience. You can find a topic ID by navigating to the Topics pane in the Amazon QuickSight application and opening a topic. The ID is in the URL for the topic that you open. If you don't specify an initial topic or you specify a legacy topic, a list of all shared new reader experience topics is shown in the Generative Q&A experience for your readers. When you select an initial new reader experience topic, you can specify whether or not readers are allowed to select other new reader experience topics from the available ones in the list. * **AllowedDomains** (*list*) -- The domains that you want to add to the allow list for access to the generated URL that is then embedded. This optional parameter overrides the static domains that are configured in the Manage QuickSight menu in the Amazon QuickSight console. Instead, it allows only the domains that you include in this parameter. You can list up to three domains or subdomains in each API call. To include all subdomains under a specific domain to the allow list, use "*". For example, "https://*.sapp.amazon.com" includes all subdomains under "https://sapp.amazon.com". * *(string) --* Return type: dict Returns: **Response Syntax** { 'EmbedUrl': 'string', 'Status': 123, 'RequestId': 'string' } **Response Structure** * *(dict) --* * **EmbedUrl** *(string) --* The embed URL for the Amazon QuickSight dashboard, visual, Q search bar, Generative Q&A experience, or console. * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.QuickSightUserNotFoundException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.SessionLifetimeInMinutesInvalidExc eption" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.UnsupportedPricingPlanException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / delete_custom_permissions delete_custom_permissions ************************* QuickSight.Client.delete_custom_permissions(**kwargs) Deletes a custom permissions profile. See also: AWS API Documentation **Request Syntax** response = client.delete_custom_permissions( AwsAccountId='string', CustomPermissionsName='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the custom permissions profile that you want to delete. * **CustomPermissionsName** (*string*) -- **[REQUIRED]** The name of the custom permissions profile that you want to delete. Return type: dict Returns: **Response Syntax** { 'Status': 123, 'Arn': 'string', 'RequestId': 'string' } **Response Structure** * *(dict) --* * **Status** *(integer) --* The HTTP status of the request. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the custom permissions profile. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ResourceExistsException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.PreconditionNotMetException" * "QuickSight.Client.exceptions.InternalFailureException" * "QuickSight.Client.exceptions.ResourceUnavailableException" QuickSight / Client / untag_resource untag_resource ************** QuickSight.Client.untag_resource(**kwargs) Removes a tag or tags from a resource. See also: AWS API Documentation **Request Syntax** response = client.untag_resource( ResourceArn='string', TagKeys=[ 'string', ] ) Parameters: * **ResourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the resource that you want to untag. * **TagKeys** (*list*) -- **[REQUIRED]** The keys of the key-value pairs for the resource tag or tags assigned to the resource. * *(string) --* Return type: dict Returns: **Response Syntax** { 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / describe_dashboard_permissions describe_dashboard_permissions ****************************** QuickSight.Client.describe_dashboard_permissions(**kwargs) Describes read and write permissions for a dashboard. See also: AWS API Documentation **Request Syntax** response = client.describe_dashboard_permissions( AwsAccountId='string', DashboardId='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the dashboard that you're describing permissions for. * **DashboardId** (*string*) -- **[REQUIRED]** The ID for the dashboard, also added to the IAM policy. Return type: dict Returns: **Response Syntax** { 'DashboardId': 'string', 'DashboardArn': 'string', 'Permissions': [ { 'Principal': 'string', 'Actions': [ 'string', ] }, ], 'Status': 123, 'RequestId': 'string', 'LinkSharingConfiguration': { 'Permissions': [ { 'Principal': 'string', 'Actions': [ 'string', ] }, ] } } **Response Structure** * *(dict) --* * **DashboardId** *(string) --* The ID for the dashboard. * **DashboardArn** *(string) --* The Amazon Resource Name (ARN) of the dashboard. * **Permissions** *(list) --* A structure that contains the permissions for the dashboard. * *(dict) --* Permission for the resource. * **Principal** *(string) --* The Amazon Resource Name (ARN) of the principal. This can be one of the following: * The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.) * The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.) * The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.) * **Actions** *(list) --* The IAM action to grant or revoke permissions on. * *(string) --* * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **LinkSharingConfiguration** *(dict) --* 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. * **Permissions** *(list) --* A structure that contains the permissions of a shareable link. * *(dict) --* Permission for the resource. * **Principal** *(string) --* The Amazon Resource Name (ARN) of the principal. This can be one of the following: * The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.) * The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.) * The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.) * **Actions** *(list) --* The IAM action to grant or revoke permissions on. * *(string) --* **Exceptions** * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / list_data_sources list_data_sources ***************** QuickSight.Client.list_data_sources(**kwargs) Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account. See also: AWS API Documentation **Request Syntax** response = client.list_data_sources( AwsAccountId='string', NextToken='string', MaxResults=123 ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The Amazon Web Services account ID. * **NextToken** (*string*) -- The token for the next set of results, or null if there are no more results. * **MaxResults** (*integer*) -- The maximum number of results to be returned per request. Return type: dict Returns: **Response Syntax** { 'DataSources': [ { 'Arn': 'string', 'DataSourceId': 'string', 'Name': 'string', 'Type': 'ADOBE_ANALYTICS'|'AMAZON_ELASTICSEARCH'|'ATHENA'|'AURORA'|'AURORA_POSTGRESQL'|'AWS_IOT_ANALYTICS'|'GITHUB'|'JIRA'|'MARIADB'|'MYSQL'|'ORACLE'|'POSTGRESQL'|'PRESTO'|'REDSHIFT'|'S3'|'SALESFORCE'|'SERVICENOW'|'SNOWFLAKE'|'SPARK'|'SQLSERVER'|'TERADATA'|'TWITTER'|'TIMESTREAM'|'AMAZON_OPENSEARCH'|'EXASOL'|'DATABRICKS'|'STARBURST'|'TRINO'|'BIGQUERY', 'Status': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED', 'CreatedTime': datetime(2015, 1, 1), 'LastUpdatedTime': datetime(2015, 1, 1), 'DataSourceParameters': { 'AmazonElasticsearchParameters': { 'Domain': 'string' }, 'AthenaParameters': { 'WorkGroup': 'string', 'RoleArn': 'string', 'IdentityCenterConfiguration': { 'EnableIdentityPropagation': True|False } }, 'AuroraParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'AuroraPostgreSqlParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'AwsIotAnalyticsParameters': { 'DataSetName': 'string' }, 'JiraParameters': { 'SiteBaseUrl': 'string' }, 'MariaDbParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'MySqlParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'OracleParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string', 'UseServiceName': True|False }, 'PostgreSqlParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'PrestoParameters': { 'Host': 'string', 'Port': 123, 'Catalog': 'string' }, 'RdsParameters': { 'InstanceId': 'string', 'Database': 'string' }, 'RedshiftParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string', 'ClusterId': 'string', 'IAMParameters': { 'RoleArn': 'string', 'DatabaseUser': 'string', 'DatabaseGroups': [ 'string', ], 'AutoCreateDatabaseUser': True|False }, 'IdentityCenterConfiguration': { 'EnableIdentityPropagation': True|False } }, 'S3Parameters': { 'ManifestFileLocation': { 'Bucket': 'string', 'Key': 'string' }, 'RoleArn': 'string' }, 'ServiceNowParameters': { 'SiteBaseUrl': 'string' }, 'SnowflakeParameters': { 'Host': 'string', 'Database': 'string', 'Warehouse': 'string', 'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509', 'DatabaseAccessControlRole': 'string', 'OAuthParameters': { 'TokenProviderUrl': 'string', 'OAuthScope': 'string', 'IdentityProviderVpcConnectionProperties': { 'VpcConnectionArn': 'string' }, 'IdentityProviderResourceUri': 'string' } }, 'SparkParameters': { 'Host': 'string', 'Port': 123 }, 'SqlServerParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'TeradataParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'TwitterParameters': { 'Query': 'string', 'MaxRows': 123 }, 'AmazonOpenSearchParameters': { 'Domain': 'string' }, 'ExasolParameters': { 'Host': 'string', 'Port': 123 }, 'DatabricksParameters': { 'Host': 'string', 'Port': 123, 'SqlEndpointPath': 'string' }, 'StarburstParameters': { 'Host': 'string', 'Port': 123, 'Catalog': 'string', 'ProductType': 'GALAXY'|'ENTERPRISE', 'DatabaseAccessControlRole': 'string', 'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509', 'OAuthParameters': { 'TokenProviderUrl': 'string', 'OAuthScope': 'string', 'IdentityProviderVpcConnectionProperties': { 'VpcConnectionArn': 'string' }, 'IdentityProviderResourceUri': 'string' } }, 'TrinoParameters': { 'Host': 'string', 'Port': 123, 'Catalog': 'string' }, 'BigQueryParameters': { 'ProjectId': 'string', 'DataSetRegion': 'string' }, 'ImpalaParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string', 'SqlEndpointPath': 'string' } }, 'AlternateDataSourceParameters': [ { 'AmazonElasticsearchParameters': { 'Domain': 'string' }, 'AthenaParameters': { 'WorkGroup': 'string', 'RoleArn': 'string', 'IdentityCenterConfiguration': { 'EnableIdentityPropagation': True|False } }, 'AuroraParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'AuroraPostgreSqlParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'AwsIotAnalyticsParameters': { 'DataSetName': 'string' }, 'JiraParameters': { 'SiteBaseUrl': 'string' }, 'MariaDbParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'MySqlParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'OracleParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string', 'UseServiceName': True|False }, 'PostgreSqlParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'PrestoParameters': { 'Host': 'string', 'Port': 123, 'Catalog': 'string' }, 'RdsParameters': { 'InstanceId': 'string', 'Database': 'string' }, 'RedshiftParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string', 'ClusterId': 'string', 'IAMParameters': { 'RoleArn': 'string', 'DatabaseUser': 'string', 'DatabaseGroups': [ 'string', ], 'AutoCreateDatabaseUser': True|False }, 'IdentityCenterConfiguration': { 'EnableIdentityPropagation': True|False } }, 'S3Parameters': { 'ManifestFileLocation': { 'Bucket': 'string', 'Key': 'string' }, 'RoleArn': 'string' }, 'ServiceNowParameters': { 'SiteBaseUrl': 'string' }, 'SnowflakeParameters': { 'Host': 'string', 'Database': 'string', 'Warehouse': 'string', 'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509', 'DatabaseAccessControlRole': 'string', 'OAuthParameters': { 'TokenProviderUrl': 'string', 'OAuthScope': 'string', 'IdentityProviderVpcConnectionProperties': { 'VpcConnectionArn': 'string' }, 'IdentityProviderResourceUri': 'string' } }, 'SparkParameters': { 'Host': 'string', 'Port': 123 }, 'SqlServerParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'TeradataParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'TwitterParameters': { 'Query': 'string', 'MaxRows': 123 }, 'AmazonOpenSearchParameters': { 'Domain': 'string' }, 'ExasolParameters': { 'Host': 'string', 'Port': 123 }, 'DatabricksParameters': { 'Host': 'string', 'Port': 123, 'SqlEndpointPath': 'string' }, 'StarburstParameters': { 'Host': 'string', 'Port': 123, 'Catalog': 'string', 'ProductType': 'GALAXY'|'ENTERPRISE', 'DatabaseAccessControlRole': 'string', 'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509', 'OAuthParameters': { 'TokenProviderUrl': 'string', 'OAuthScope': 'string', 'IdentityProviderVpcConnectionProperties': { 'VpcConnectionArn': 'string' }, 'IdentityProviderResourceUri': 'string' } }, 'TrinoParameters': { 'Host': 'string', 'Port': 123, 'Catalog': 'string' }, 'BigQueryParameters': { 'ProjectId': 'string', 'DataSetRegion': 'string' }, 'ImpalaParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string', 'SqlEndpointPath': 'string' } }, ], 'VpcConnectionProperties': { 'VpcConnectionArn': 'string' }, 'SslProperties': { 'DisableSsl': True|False }, 'ErrorInfo': { 'Type': 'ACCESS_DENIED'|'COPY_SOURCE_NOT_FOUND'|'TIMEOUT'|'ENGINE_VERSION_NOT_SUPPORTED'|'UNKNOWN_HOST'|'GENERIC_SQL_FAILURE'|'CONFLICT'|'UNKNOWN', 'Message': 'string' }, 'SecretArn': 'string' }, ], 'NextToken': 'string', 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **DataSources** *(list) --* A list of data sources. * *(dict) --* The structure of a data source. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the data source. * **DataSourceId** *(string) --* The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. * **Name** *(string) --* A display name for the data source. * **Type** *(string) --* The type of the data source. This type indicates which database engine the data source connects to. * **Status** *(string) --* The HTTP status of the request. * **CreatedTime** *(datetime) --* The time that this data source was created. * **LastUpdatedTime** *(datetime) --* The last time that this data source was updated. * **DataSourceParameters** *(dict) --* The parameters that Amazon QuickSight uses to connect to your underlying source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null. * **AmazonElasticsearchParameters** *(dict) --* The parameters for OpenSearch. * **Domain** *(string) --* The OpenSearch domain. * **AthenaParameters** *(dict) --* The parameters for Amazon Athena. * **WorkGroup** *(string) --* The workgroup that Amazon Athena uses. * **RoleArn** *(string) --* Use the "RoleArn" structure to override an account- wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use "RoleArn" to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active. * **IdentityCenterConfiguration** *(dict) --* An optional parameter that configures IAM Identity Center authentication to grant Amazon QuickSight access to your workgroup. This parameter can only be specified if your Amazon QuickSight account is configured with IAM Identity Center. * **EnableIdentityPropagation** *(boolean) --* A Boolean option that controls whether Trusted Identity Propagation should be used. * **AuroraParameters** *(dict) --* The parameters for Amazon Aurora MySQL. * **Host** *(string) --* Host. * **Port** *(integer) --* Port. * **Database** *(string) --* Database. * **AuroraPostgreSqlParameters** *(dict) --* The parameters for Amazon Aurora. * **Host** *(string) --* The Amazon Aurora PostgreSQL-Compatible host to connect to. * **Port** *(integer) --* The port that Amazon Aurora PostgreSQL is listening on. * **Database** *(string) --* The Amazon Aurora PostgreSQL database to connect to. * **AwsIotAnalyticsParameters** *(dict) --* The parameters for IoT Analytics. * **DataSetName** *(string) --* Dataset name. * **JiraParameters** *(dict) --* The parameters for Jira. * **SiteBaseUrl** *(string) --* The base URL of the Jira site. * **MariaDbParameters** *(dict) --* The parameters for MariaDB. * **Host** *(string) --* Host. * **Port** *(integer) --* Port. * **Database** *(string) --* Database. * **MySqlParameters** *(dict) --* The parameters for MySQL. * **Host** *(string) --* Host. * **Port** *(integer) --* Port. * **Database** *(string) --* Database. * **OracleParameters** *(dict) --* The parameters for Oracle. * **Host** *(string) --* An Oracle host. * **Port** *(integer) --* The port. * **Database** *(string) --* The database. * **UseServiceName** *(boolean) --* A Boolean value that indicates whether the "Database" uses a service name or an SID. If this value is left blank, the default value is "SID". If this value is set to "false", the value is "SID". * **PostgreSqlParameters** *(dict) --* The parameters for PostgreSQL. * **Host** *(string) --* Host. * **Port** *(integer) --* Port. * **Database** *(string) --* Database. * **PrestoParameters** *(dict) --* The parameters for Presto. * **Host** *(string) --* Host. * **Port** *(integer) --* Port. * **Catalog** *(string) --* Catalog. * **RdsParameters** *(dict) --* The parameters for Amazon RDS. * **InstanceId** *(string) --* Instance ID. * **Database** *(string) --* Database. * **RedshiftParameters** *(dict) --* The parameters for Amazon Redshift. * **Host** *(string) --* Host. This field can be blank if "ClusterId" is provided. * **Port** *(integer) --* Port. This field can be blank if the "ClusterId" is provided. * **Database** *(string) --* Database. * **ClusterId** *(string) --* Cluster ID. This field can be blank if the "Host" and "Port" are provided. * **IAMParameters** *(dict) --* An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials. * **RoleArn** *(string) --* Use the "RoleArn" structure to allow Amazon QuickSight to call "redshift:GetClusterCredentials" on your cluster. The calling principal must have "iam:PassRole" access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role. * **DatabaseUser** *(string) --* The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of "AutoCreateDatabaseUser" to "True" to create a new user with PUBLIC permissions. * **DatabaseGroups** *(list) --* A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the "DatabaseUser". If you choose to include this parameter, the "RoleArn" must grant access to "redshift:JoinGroup". * *(string) --* * **AutoCreateDatabaseUser** *(boolean) --* Automatically creates a database user. If your database doesn't have a "DatabaseUser", set this parameter to "True". If there is no "DatabaseUser", Amazon QuickSight can't connect to your cluster. The "RoleArn" that you use for this operation must grant access to "redshift:CreateClusterUser" to successfully create the user. * **IdentityCenterConfiguration** *(dict) --* An optional parameter that configures IAM Identity Center authentication to grant Amazon QuickSight access to your cluster. This parameter can only be specified if your Amazon QuickSight account is configured with IAM Identity Center. * **EnableIdentityPropagation** *(boolean) --* A Boolean option that controls whether Trusted Identity Propagation should be used. * **S3Parameters** *(dict) --* The parameters for S3. * **ManifestFileLocation** *(dict) --* Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight. * **Bucket** *(string) --* Amazon S3 bucket. * **Key** *(string) --* Amazon S3 key that identifies an object. * **RoleArn** *(string) --* Use the "RoleArn" structure to override an account- wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use "RoleArn" to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active. * **ServiceNowParameters** *(dict) --* The parameters for ServiceNow. * **SiteBaseUrl** *(string) --* URL of the base site. * **SnowflakeParameters** *(dict) --* The parameters for Snowflake. * **Host** *(string) --* Host. * **Database** *(string) --* Database. * **Warehouse** *(string) --* Warehouse. * **AuthenticationType** *(string) --* The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types. * **DatabaseAccessControlRole** *(string) --* The database access control role. * **OAuthParameters** *(dict) --* An object that contains information needed to create a data source connection between an Amazon QuickSight account and Snowflake. * **TokenProviderUrl** *(string) --* The token endpoint URL of the identity provider. * **OAuthScope** *(string) --* The OAuth scope. * **IdentityProviderVpcConnectionProperties** *(dict) --* VPC connection properties. * **VpcConnectionArn** *(string) --* The Amazon Resource Name (ARN) for the VPC connection. * **IdentityProviderResourceUri** *(string) --* The resource uri of the identity provider. * **SparkParameters** *(dict) --* The parameters for Spark. * **Host** *(string) --* Host. * **Port** *(integer) --* Port. * **SqlServerParameters** *(dict) --* The parameters for SQL Server. * **Host** *(string) --* Host. * **Port** *(integer) --* Port. * **Database** *(string) --* Database. * **TeradataParameters** *(dict) --* The parameters for Teradata. * **Host** *(string) --* Host. * **Port** *(integer) --* Port. * **Database** *(string) --* Database. * **TwitterParameters** *(dict) --* The parameters for Twitter. * **Query** *(string) --* Twitter query string. * **MaxRows** *(integer) --* Maximum number of rows to query Twitter. * **AmazonOpenSearchParameters** *(dict) --* The parameters for OpenSearch. * **Domain** *(string) --* The OpenSearch domain. * **ExasolParameters** *(dict) --* The parameters for Exasol. * **Host** *(string) --* The hostname or IP address of the Exasol data source. * **Port** *(integer) --* The port for the Exasol data source. * **DatabricksParameters** *(dict) --* The parameters that are required to connect to a Databricks data source. * **Host** *(string) --* The host name of the Databricks data source. * **Port** *(integer) --* The port for the Databricks data source. * **SqlEndpointPath** *(string) --* The HTTP path of the Databricks data source. * **StarburstParameters** *(dict) --* The parameters that are required to connect to a Starburst data source. * **Host** *(string) --* The host name of the Starburst data source. * **Port** *(integer) --* The port for the Starburst data source. * **Catalog** *(string) --* The catalog name for the Starburst data source. * **ProductType** *(string) --* The product type for the Starburst data source. * **DatabaseAccessControlRole** *(string) --* The database access control role. * **AuthenticationType** *(string) --* The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types. * **OAuthParameters** *(dict) --* An object that contains information needed to create a data source connection between an Amazon QuickSight account and Starburst. * **TokenProviderUrl** *(string) --* The token endpoint URL of the identity provider. * **OAuthScope** *(string) --* The OAuth scope. * **IdentityProviderVpcConnectionProperties** *(dict) --* VPC connection properties. * **VpcConnectionArn** *(string) --* The Amazon Resource Name (ARN) for the VPC connection. * **IdentityProviderResourceUri** *(string) --* The resource uri of the identity provider. * **TrinoParameters** *(dict) --* The parameters that are required to connect to a Trino data source. * **Host** *(string) --* The host name of the Trino data source. * **Port** *(integer) --* The port for the Trino data source. * **Catalog** *(string) --* The catalog name for the Trino data source. * **BigQueryParameters** *(dict) --* The parameters that are required to connect to a Google BigQuery data source. * **ProjectId** *(string) --* The Google Cloud Platform project ID where your datasource was created. * **DataSetRegion** *(string) --* The storage location where you create a Google BigQuery data source. * **ImpalaParameters** *(dict) --* The parameters for Impala. * **Host** *(string) --* The host name of the Impala data source. * **Port** *(integer) --* The port of the Impala data source. * **Database** *(string) --* The database of the Impala data source. * **SqlEndpointPath** *(string) --* The HTTP path of the Impala data source. * **AlternateDataSourceParameters** *(list) --* A set of alternate data source parameters that you want to share for the credentials stored with this data source. The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the "DataSourceParameters" structure that's in the request with the structures in the "AlternateDataSourceParameters" allow list. If the structures are an exact match, the request is allowed to use the credentials from this existing data source. If the "AlternateDataSourceParameters" list is null, the "Credentials" originally used with this "DataSourceParameters" are automatically allowed. * *(dict) --* The parameters that Amazon QuickSight uses to connect to your underlying data source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null. * **AmazonElasticsearchParameters** *(dict) --* The parameters for OpenSearch. * **Domain** *(string) --* The OpenSearch domain. * **AthenaParameters** *(dict) --* The parameters for Amazon Athena. * **WorkGroup** *(string) --* The workgroup that Amazon Athena uses. * **RoleArn** *(string) --* Use the "RoleArn" structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account- wide role. The administrator can then use "RoleArn" to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active. * **IdentityCenterConfiguration** *(dict) --* An optional parameter that configures IAM Identity Center authentication to grant Amazon QuickSight access to your workgroup. This parameter can only be specified if your Amazon QuickSight account is configured with IAM Identity Center. * **EnableIdentityPropagation** *(boolean) --* A Boolean option that controls whether Trusted Identity Propagation should be used. * **AuroraParameters** *(dict) --* The parameters for Amazon Aurora MySQL. * **Host** *(string) --* Host. * **Port** *(integer) --* Port. * **Database** *(string) --* Database. * **AuroraPostgreSqlParameters** *(dict) --* The parameters for Amazon Aurora. * **Host** *(string) --* The Amazon Aurora PostgreSQL-Compatible host to connect to. * **Port** *(integer) --* The port that Amazon Aurora PostgreSQL is listening on. * **Database** *(string) --* The Amazon Aurora PostgreSQL database to connect to. * **AwsIotAnalyticsParameters** *(dict) --* The parameters for IoT Analytics. * **DataSetName** *(string) --* Dataset name. * **JiraParameters** *(dict) --* The parameters for Jira. * **SiteBaseUrl** *(string) --* The base URL of the Jira site. * **MariaDbParameters** *(dict) --* The parameters for MariaDB. * **Host** *(string) --* Host. * **Port** *(integer) --* Port. * **Database** *(string) --* Database. * **MySqlParameters** *(dict) --* The parameters for MySQL. * **Host** *(string) --* Host. * **Port** *(integer) --* Port. * **Database** *(string) --* Database. * **OracleParameters** *(dict) --* The parameters for Oracle. * **Host** *(string) --* An Oracle host. * **Port** *(integer) --* The port. * **Database** *(string) --* The database. * **UseServiceName** *(boolean) --* A Boolean value that indicates whether the "Database" uses a service name or an SID. If this value is left blank, the default value is "SID". If this value is set to "false", the value is "SID". * **PostgreSqlParameters** *(dict) --* The parameters for PostgreSQL. * **Host** *(string) --* Host. * **Port** *(integer) --* Port. * **Database** *(string) --* Database. * **PrestoParameters** *(dict) --* The parameters for Presto. * **Host** *(string) --* Host. * **Port** *(integer) --* Port. * **Catalog** *(string) --* Catalog. * **RdsParameters** *(dict) --* The parameters for Amazon RDS. * **InstanceId** *(string) --* Instance ID. * **Database** *(string) --* Database. * **RedshiftParameters** *(dict) --* The parameters for Amazon Redshift. * **Host** *(string) --* Host. This field can be blank if "ClusterId" is provided. * **Port** *(integer) --* Port. This field can be blank if the "ClusterId" is provided. * **Database** *(string) --* Database. * **ClusterId** *(string) --* Cluster ID. This field can be blank if the "Host" and "Port" are provided. * **IAMParameters** *(dict) --* An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials. * **RoleArn** *(string) --* Use the "RoleArn" structure to allow Amazon QuickSight to call "redshift:GetClusterCredentials" on your cluster. The calling principal must have "iam:PassRole" access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role. * **DatabaseUser** *(string) --* The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of "AutoCreateDatabaseUser" to "True" to create a new user with PUBLIC permissions. * **DatabaseGroups** *(list) --* A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the "DatabaseUser". If you choose to include this parameter, the "RoleArn" must grant access to "redshift:JoinGroup". * *(string) --* * **AutoCreateDatabaseUser** *(boolean) --* Automatically creates a database user. If your database doesn't have a "DatabaseUser", set this parameter to "True". If there is no "DatabaseUser", Amazon QuickSight can't connect to your cluster. The "RoleArn" that you use for this operation must grant access to "redshift:CreateClusterUser" to successfully create the user. * **IdentityCenterConfiguration** *(dict) --* An optional parameter that configures IAM Identity Center authentication to grant Amazon QuickSight access to your cluster. This parameter can only be specified if your Amazon QuickSight account is configured with IAM Identity Center. * **EnableIdentityPropagation** *(boolean) --* A Boolean option that controls whether Trusted Identity Propagation should be used. * **S3Parameters** *(dict) --* The parameters for S3. * **ManifestFileLocation** *(dict) --* Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight. * **Bucket** *(string) --* Amazon S3 bucket. * **Key** *(string) --* Amazon S3 key that identifies an object. * **RoleArn** *(string) --* Use the "RoleArn" structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use "RoleArn" to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active. * **ServiceNowParameters** *(dict) --* The parameters for ServiceNow. * **SiteBaseUrl** *(string) --* URL of the base site. * **SnowflakeParameters** *(dict) --* The parameters for Snowflake. * **Host** *(string) --* Host. * **Database** *(string) --* Database. * **Warehouse** *(string) --* Warehouse. * **AuthenticationType** *(string) --* The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types. * **DatabaseAccessControlRole** *(string) --* The database access control role. * **OAuthParameters** *(dict) --* An object that contains information needed to create a data source connection between an Amazon QuickSight account and Snowflake. * **TokenProviderUrl** *(string) --* The token endpoint URL of the identity provider. * **OAuthScope** *(string) --* The OAuth scope. * **IdentityProviderVpcConnectionProperties** *(dict) --* VPC connection properties. * **VpcConnectionArn** *(string) --* The Amazon Resource Name (ARN) for the VPC connection. * **IdentityProviderResourceUri** *(string) --* The resource uri of the identity provider. * **SparkParameters** *(dict) --* The parameters for Spark. * **Host** *(string) --* Host. * **Port** *(integer) --* Port. * **SqlServerParameters** *(dict) --* The parameters for SQL Server. * **Host** *(string) --* Host. * **Port** *(integer) --* Port. * **Database** *(string) --* Database. * **TeradataParameters** *(dict) --* The parameters for Teradata. * **Host** *(string) --* Host. * **Port** *(integer) --* Port. * **Database** *(string) --* Database. * **TwitterParameters** *(dict) --* The parameters for Twitter. * **Query** *(string) --* Twitter query string. * **MaxRows** *(integer) --* Maximum number of rows to query Twitter. * **AmazonOpenSearchParameters** *(dict) --* The parameters for OpenSearch. * **Domain** *(string) --* The OpenSearch domain. * **ExasolParameters** *(dict) --* The parameters for Exasol. * **Host** *(string) --* The hostname or IP address of the Exasol data source. * **Port** *(integer) --* The port for the Exasol data source. * **DatabricksParameters** *(dict) --* The parameters that are required to connect to a Databricks data source. * **Host** *(string) --* The host name of the Databricks data source. * **Port** *(integer) --* The port for the Databricks data source. * **SqlEndpointPath** *(string) --* The HTTP path of the Databricks data source. * **StarburstParameters** *(dict) --* The parameters that are required to connect to a Starburst data source. * **Host** *(string) --* The host name of the Starburst data source. * **Port** *(integer) --* The port for the Starburst data source. * **Catalog** *(string) --* The catalog name for the Starburst data source. * **ProductType** *(string) --* The product type for the Starburst data source. * **DatabaseAccessControlRole** *(string) --* The database access control role. * **AuthenticationType** *(string) --* The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types. * **OAuthParameters** *(dict) --* An object that contains information needed to create a data source connection between an Amazon QuickSight account and Starburst. * **TokenProviderUrl** *(string) --* The token endpoint URL of the identity provider. * **OAuthScope** *(string) --* The OAuth scope. * **IdentityProviderVpcConnectionProperties** *(dict) --* VPC connection properties. * **VpcConnectionArn** *(string) --* The Amazon Resource Name (ARN) for the VPC connection. * **IdentityProviderResourceUri** *(string) --* The resource uri of the identity provider. * **TrinoParameters** *(dict) --* The parameters that are required to connect to a Trino data source. * **Host** *(string) --* The host name of the Trino data source. * **Port** *(integer) --* The port for the Trino data source. * **Catalog** *(string) --* The catalog name for the Trino data source. * **BigQueryParameters** *(dict) --* The parameters that are required to connect to a Google BigQuery data source. * **ProjectId** *(string) --* The Google Cloud Platform project ID where your datasource was created. * **DataSetRegion** *(string) --* The storage location where you create a Google BigQuery data source. * **ImpalaParameters** *(dict) --* The parameters for Impala. * **Host** *(string) --* The host name of the Impala data source. * **Port** *(integer) --* The port of the Impala data source. * **Database** *(string) --* The database of the Impala data source. * **SqlEndpointPath** *(string) --* The HTTP path of the Impala data source. * **VpcConnectionProperties** *(dict) --* The VPC connection information. You need to use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source. * **VpcConnectionArn** *(string) --* The Amazon Resource Name (ARN) for the VPC connection. * **SslProperties** *(dict) --* Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source. * **DisableSsl** *(boolean) --* A Boolean option to control whether SSL should be disabled. * **ErrorInfo** *(dict) --* Error information from the last update or the creation of the data source. * **Type** *(string) --* Error type. * **Message** *(string) --* Error message. * **SecretArn** *(string) --* The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager. * **NextToken** *(string) --* The token for the next set of results, or null if there are no more results. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InvalidNextTokenException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / list_brands list_brands *********** QuickSight.Client.list_brands(**kwargs) Lists all brands in an Amazon QuickSight account. See also: AWS API Documentation **Request Syntax** response = client.list_brands( AwsAccountId='string', MaxResults=123, NextToken='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that owns the brands that you want to list. * **MaxResults** (*integer*) -- The maximum number of results to be returned in a single request. * **NextToken** (*string*) -- The token for the next set of results, or null if there are no more results. Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'Brands': [ { 'Arn': 'string', 'BrandId': 'string', 'BrandName': 'string', 'Description': 'string', 'BrandStatus': 'CREATE_IN_PROGRESS'|'CREATE_SUCCEEDED'|'CREATE_FAILED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED', 'CreatedTime': datetime(2015, 1, 1), 'LastUpdatedTime': datetime(2015, 1, 1) }, ] } **Response Structure** * *(dict) --* * **NextToken** *(string) --* The token for the next set of results, or null if there are no more results. * **Brands** *(list) --* A list of all brands in your Amazon Web Services account. This structure provides basic information about each brand. * *(dict) --* A summary of the brand. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the brand. * **BrandId** *(string) --* The ID of the Amazon QuickSight brand. * **BrandName** *(string) --* The name of the brand. * **Description** *(string) --* The description of the brand. * **BrandStatus** *(string) --* The status of the brand. * **CreatedTime** *(datetime) --* The time that the brand was created. * **LastUpdatedTime** *(datetime) --* The time when the brand was last updated. **Exceptions** * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InvalidRequestException" * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InternalServerException" QuickSight / Client / update_ip_restriction update_ip_restriction ********************* QuickSight.Client.update_ip_restriction(**kwargs) Updates the content and status of IP rules. Traffic from a source is allowed when the source satisfies either the "IpRestrictionRule", "VpcIdRestrictionRule", or "VpcEndpointIdRestrictionRule". To use this operation, you must provide the entire map of rules. You can use the "DescribeIpRestriction" operation to get the current rule map. See also: AWS API Documentation **Request Syntax** response = client.update_ip_restriction( AwsAccountId='string', IpRestrictionRuleMap={ 'string': 'string' }, VpcIdRestrictionRuleMap={ 'string': 'string' }, VpcEndpointIdRestrictionRuleMap={ 'string': 'string' }, Enabled=True|False ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the IP rules. * **IpRestrictionRuleMap** (*dict*) -- A map that describes the updated IP rules with CIDR ranges and descriptions. * *(string) --* * *(string) --* * **VpcIdRestrictionRuleMap** (*dict*) -- A map of VPC IDs and their corresponding rules. When you configure this parameter, traffic from all VPC endpoints that are present in the specified VPC is allowed. * *(string) --* * *(string) --* * **VpcEndpointIdRestrictionRuleMap** (*dict*) -- A map of allowed VPC endpoint IDs and their corresponding rule descriptions. * *(string) --* * *(string) --* * **Enabled** (*boolean*) -- A value that specifies whether IP rules are turned on. Return type: dict Returns: **Response Syntax** { 'AwsAccountId': 'string', 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **AwsAccountId** *(string) --* The ID of the Amazon Web Services account that contains the IP rules. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.LimitExceededException" * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / update_folder_permissions update_folder_permissions ************************* QuickSight.Client.update_folder_permissions(**kwargs) Updates permissions of a folder. See also: AWS API Documentation **Request Syntax** response = client.update_folder_permissions( AwsAccountId='string', FolderId='string', GrantPermissions=[ { 'Principal': 'string', 'Actions': [ 'string', ] }, ], RevokePermissions=[ { 'Principal': 'string', 'Actions': [ 'string', ] }, ] ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID for the Amazon Web Services account that contains the folder to update. * **FolderId** (*string*) -- **[REQUIRED]** The ID of the folder. * **GrantPermissions** (*list*) -- The permissions that you want to grant on a resource. Namespace ARNs are not supported "Principal" values for folder permissions. * *(dict) --* Permission for the resource. * **Principal** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the principal. This can be one of the following: * The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.) * The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.) * The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.) * **Actions** *(list) --* **[REQUIRED]** The IAM action to grant or revoke permissions on. * *(string) --* * **RevokePermissions** (*list*) -- The permissions that you want to revoke from a resource. Namespace ARNs are not supported "Principal" values for folder permissions. * *(dict) --* Permission for the resource. * **Principal** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the principal. This can be one of the following: * The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.) * The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.) * The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.) * **Actions** *(list) --* **[REQUIRED]** The IAM action to grant or revoke permissions on. * *(string) --* Return type: dict Returns: **Response Syntax** { 'Status': 123, 'Arn': 'string', 'FolderId': 'string', 'Permissions': [ { 'Principal': 'string', 'Actions': [ 'string', ] }, ], 'RequestId': 'string' } **Response Structure** * *(dict) --* * **Status** *(integer) --* The HTTP status of the request. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the folder. * **FolderId** *(string) --* The ID of the folder. * **Permissions** *(list) --* Information about the permissions for the folder. * *(dict) --* Permission for the resource. * **Principal** *(string) --* The Amazon Resource Name (ARN) of the principal. This can be one of the following: * The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.) * The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.) * The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.) * **Actions** *(list) --* The IAM action to grant or revoke permissions on. * *(string) --* * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.LimitExceededException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / get_waiter get_waiter ********** QuickSight.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" QuickSight / Client / update_vpc_connection update_vpc_connection ********************* QuickSight.Client.update_vpc_connection(**kwargs) Updates a VPC connection. See also: AWS API Documentation **Request Syntax** response = client.update_vpc_connection( AwsAccountId='string', VPCConnectionId='string', Name='string', SubnetIds=[ 'string', ], SecurityGroupIds=[ 'string', ], DnsResolvers=[ 'string', ], RoleArn='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The Amazon Web Services account ID of the account that contains the VPC connection that you want to update. * **VPCConnectionId** (*string*) -- **[REQUIRED]** The ID of the VPC connection that you're updating. This ID is a unique identifier for each Amazon Web Services Region in an Amazon Web Services account. * **Name** (*string*) -- **[REQUIRED]** The display name for the VPC connection. * **SubnetIds** (*list*) -- **[REQUIRED]** A list of subnet IDs for the VPC connection. * *(string) --* * **SecurityGroupIds** (*list*) -- **[REQUIRED]** A list of security group IDs for the VPC connection. * *(string) --* * **DnsResolvers** (*list*) -- A list of IP addresses of DNS resolver endpoints for the VPC connection. * *(string) --* * **RoleArn** (*string*) -- **[REQUIRED]** An IAM role associated with the VPC connection. Return type: dict Returns: **Response Syntax** { 'Arn': 'string', 'VPCConnectionId': 'string', 'UpdateStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETION_IN_PROGRESS'|'DELETION_FAILED'|'DELETED', 'AvailabilityStatus': 'AVAILABLE'|'UNAVAILABLE'|'PARTIALLY_AVAILABLE', 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **Arn** *(string) --* The Amazon Resource Name (ARN) of the VPC connection. * **VPCConnectionId** *(string) --* The ID of the VPC connection that you are updating. This ID is a unique identifier for each Amazon Web Services Region in anAmazon Web Services account. * **UpdateStatus** *(string) --* The update status of the VPC connection's last update. * **AvailabilityStatus** *(string) --* The availability status of the VPC connection. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.LimitExceededException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / describe_q_personalization_configuration describe_q_personalization_configuration **************************************** QuickSight.Client.describe_q_personalization_configuration(**kwargs) Describes a personalization configuration. See also: AWS API Documentation **Request Syntax** response = client.describe_q_personalization_configuration( AwsAccountId='string' ) Parameters: **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the personalization configuration that the user wants described. Return type: dict Returns: **Response Syntax** { 'PersonalizationMode': 'ENABLED'|'DISABLED', 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **PersonalizationMode** *(string) --* A value that indicates whether personalization is enabled or not. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / update_custom_permissions update_custom_permissions ************************* QuickSight.Client.update_custom_permissions(**kwargs) Updates a custom permissions profile. See also: AWS API Documentation **Request Syntax** response = client.update_custom_permissions( AwsAccountId='string', CustomPermissionsName='string', Capabilities={ 'ExportToCsv': 'DENY', 'ExportToExcel': 'DENY', 'ExportToPdf': 'DENY', 'PrintReports': 'DENY', 'CreateAndUpdateThemes': 'DENY', 'AddOrRunAnomalyDetectionForAnalyses': 'DENY', 'ShareAnalyses': 'DENY', 'CreateAndUpdateDatasets': 'DENY', 'ShareDatasets': 'DENY', 'SubscribeDashboardEmailReports': 'DENY', 'CreateAndUpdateDashboardEmailReports': 'DENY', 'ShareDashboards': 'DENY', 'CreateAndUpdateThresholdAlerts': 'DENY', 'RenameSharedFolders': 'DENY', 'CreateSharedFolders': 'DENY', 'CreateAndUpdateDataSources': 'DENY', 'ShareDataSources': 'DENY', 'ViewAccountSPICECapacity': 'DENY', 'CreateSPICEDataset': 'DENY', 'ExportToPdfInScheduledReports': 'DENY', 'ExportToCsvInScheduledReports': 'DENY', 'ExportToExcelInScheduledReports': 'DENY', 'IncludeContentInScheduledReportsEmail': 'DENY' } ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the custom permissions profile that you want to update. * **CustomPermissionsName** (*string*) -- **[REQUIRED]** The name of the custom permissions profile that you want to update. * **Capabilities** (*dict*) -- A set of actions to include in the custom permissions profile. * **ExportToCsv** *(string) --* The ability to export to CSV files from the UI. * **ExportToExcel** *(string) --* The ability to export to Excel files from the UI. * **ExportToPdf** *(string) --* The ability to export to PDF files from the UI. * **PrintReports** *(string) --* The ability to print reports. * **CreateAndUpdateThemes** *(string) --* The ability to export to Create and Update themes. * **AddOrRunAnomalyDetectionForAnalyses** *(string) --* The ability to add or run anomaly detection. * **ShareAnalyses** *(string) --* The ability to share analyses. * **CreateAndUpdateDatasets** *(string) --* The ability to create and update datasets. * **ShareDatasets** *(string) --* The ability to share datasets. * **SubscribeDashboardEmailReports** *(string) --* The ability to subscribe to email reports. * **CreateAndUpdateDashboardEmailReports** *(string) --* The ability to create and update email reports. * **ShareDashboards** *(string) --* The ability to share dashboards. * **CreateAndUpdateThresholdAlerts** *(string) --* The ability to create and update threshold alerts. * **RenameSharedFolders** *(string) --* The ability to rename shared folders. * **CreateSharedFolders** *(string) --* The ability to create shared folders. * **CreateAndUpdateDataSources** *(string) --* The ability to create and update data sources. * **ShareDataSources** *(string) --* The ability to share data sources. * **ViewAccountSPICECapacity** *(string) --* The ability to view account SPICE capacity. * **CreateSPICEDataset** *(string) --* The ability to create a SPICE dataset. * **ExportToPdfInScheduledReports** *(string) --* The ability to export to PDF files in scheduled email reports. * **ExportToCsvInScheduledReports** *(string) --* The ability to export to CSV files in scheduled email reports. * **ExportToExcelInScheduledReports** *(string) --* The ability to export to Excel files in scheduled email reports. * **IncludeContentInScheduledReportsEmail** *(string) --* The ability to include content in scheduled email reports. Return type: dict Returns: **Response Syntax** { 'Status': 123, 'Arn': 'string', 'RequestId': 'string' } **Response Structure** * *(dict) --* * **Status** *(integer) --* The HTTP status of the request. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the custom permissions profile. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.PreconditionNotMetException" * "QuickSight.Client.exceptions.InternalFailureException" * "QuickSight.Client.exceptions.ResourceUnavailableException" QuickSight / Client / update_topic_permissions update_topic_permissions ************************ QuickSight.Client.update_topic_permissions(**kwargs) Updates the permissions of a topic. See also: AWS API Documentation **Request Syntax** response = client.update_topic_permissions( AwsAccountId='string', TopicId='string', GrantPermissions=[ { 'Principal': 'string', 'Actions': [ 'string', ] }, ], RevokePermissions=[ { 'Principal': 'string', 'Actions': [ 'string', ] }, ] ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the topic that you want to update the permissions for. * **TopicId** (*string*) -- **[REQUIRED]** The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. * **GrantPermissions** (*list*) -- The resource permissions that you want to grant to the topic. * *(dict) --* Permission for the resource. * **Principal** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the principal. This can be one of the following: * The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.) * The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.) * The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.) * **Actions** *(list) --* **[REQUIRED]** The IAM action to grant or revoke permissions on. * *(string) --* * **RevokePermissions** (*list*) -- The resource permissions that you want to revoke from the topic. * *(dict) --* Permission for the resource. * **Principal** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the principal. This can be one of the following: * The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.) * The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.) * The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.) * **Actions** *(list) --* **[REQUIRED]** The IAM action to grant or revoke permissions on. * *(string) --* Return type: dict Returns: **Response Syntax** { 'TopicId': 'string', 'TopicArn': 'string', 'Permissions': [ { 'Principal': 'string', 'Actions': [ 'string', ] }, ], 'Status': 123, 'RequestId': 'string' } **Response Structure** * *(dict) --* * **TopicId** *(string) --* The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. * **TopicArn** *(string) --* The Amazon Resource Name (ARN) of the topic. * **Permissions** *(list) --* A list of resource permissions on the topic. * *(dict) --* Permission for the resource. * **Principal** *(string) --* The Amazon Resource Name (ARN) of the principal. This can be one of the following: * The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.) * The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.) * The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.) * **Actions** *(list) --* The IAM action to grant or revoke permissions on. * *(string) --* * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.LimitExceededException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / describe_dashboard describe_dashboard ****************** QuickSight.Client.describe_dashboard(**kwargs) Provides a summary for a dashboard. See also: AWS API Documentation **Request Syntax** response = client.describe_dashboard( AwsAccountId='string', DashboardId='string', VersionNumber=123, AliasName='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the dashboard that you're describing. * **DashboardId** (*string*) -- **[REQUIRED]** The ID for the dashboard. * **VersionNumber** (*integer*) -- The version number for the dashboard. If a version number isn't passed, the latest published dashboard version is described. * **AliasName** (*string*) -- The alias name. Return type: dict Returns: **Response Syntax** { 'Dashboard': { 'DashboardId': 'string', 'Arn': 'string', 'Name': 'string', 'Version': { 'CreatedTime': datetime(2015, 1, 1), 'Errors': [ { 'Type': 'ACCESS_DENIED'|'SOURCE_NOT_FOUND'|'DATA_SET_NOT_FOUND'|'INTERNAL_FAILURE'|'PARAMETER_VALUE_INCOMPATIBLE'|'PARAMETER_TYPE_INVALID'|'PARAMETER_NOT_FOUND'|'COLUMN_TYPE_MISMATCH'|'COLUMN_GEOGRAPHIC_ROLE_MISMATCH'|'COLUMN_REPLACEMENT_MISSING', 'Message': 'string', 'ViolatedEntities': [ { 'Path': 'string' }, ] }, ], 'VersionNumber': 123, 'Status': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED', 'Arn': 'string', 'SourceEntityArn': 'string', 'DataSetArns': [ 'string', ], 'Description': 'string', 'ThemeArn': 'string', 'Sheets': [ { 'SheetId': 'string', 'Name': 'string', 'Images': [ { 'SheetImageId': 'string', 'Source': { 'SheetImageStaticFileSource': { 'StaticFileId': 'string' } }, 'Scaling': { 'ScalingType': 'SCALE_TO_WIDTH'|'SCALE_TO_HEIGHT'|'SCALE_TO_CONTAINER'|'SCALE_NONE' }, 'Tooltip': { 'TooltipText': { 'PlainText': 'string' }, 'Visibility': 'HIDDEN'|'VISIBLE' }, 'ImageContentAltText': 'string', 'Interactions': { 'ImageMenuOption': { 'AvailabilityStatus': 'ENABLED'|'DISABLED' } }, 'Actions': [ { 'CustomActionId': 'string', 'Name': 'string', 'Status': 'ENABLED'|'DISABLED', 'Trigger': 'CLICK'|'MENU', 'ActionOperations': [ { 'NavigationOperation': { 'LocalNavigationConfiguration': { 'TargetSheetId': 'string' } }, 'URLOperation': { 'URLTemplate': 'string', 'URLTarget': 'NEW_TAB'|'NEW_WINDOW'|'SAME_TAB' }, 'SetParametersOperation': { 'ParameterValueConfigurations': [ { 'DestinationParameterName': 'string', 'Value': { 'CustomValuesConfiguration': { 'IncludeNullValue': True|False, 'CustomValues': { 'StringValues': [ 'string', ], 'IntegerValues': [ 123, ], 'DecimalValues': [ 123.0, ], 'DateTimeValues': [ datetime(2015, 1, 1), ] } }, 'SelectAllValueOptions': 'ALL_VALUES', 'SourceParameterName': 'string', 'SourceField': 'string', 'SourceColumn': { 'DataSetIdentifier': 'string', 'ColumnName': 'string' } } }, ] } }, ] }, ] }, ] }, ] }, 'CreatedTime': datetime(2015, 1, 1), 'LastPublishedTime': datetime(2015, 1, 1), 'LastUpdatedTime': datetime(2015, 1, 1), 'LinkEntities': [ 'string', ] }, 'Status': 123, 'RequestId': 'string' } **Response Structure** * *(dict) --* * **Dashboard** *(dict) --* Information about the dashboard. * **DashboardId** *(string) --* Dashboard ID. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the resource. * **Name** *(string) --* A display name for the dashboard. * **Version** *(dict) --* Version. * **CreatedTime** *(datetime) --* The time that this dashboard version was created. * **Errors** *(list) --* Errors associated with this dashboard version. * *(dict) --* Dashboard error. * **Type** *(string) --* Type. * **Message** *(string) --* Message. * **ViolatedEntities** *(list) --* Lists the violated entities that caused the dashboard error. * *(dict) --* An object, structure, or sub-structure of an analysis, template, or dashboard. * **Path** *(string) --* The hierarchical path of the entity within the analysis, template, or dashboard definition tree. * **VersionNumber** *(integer) --* Version number for this version of the dashboard. * **Status** *(string) --* The HTTP status of the request. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the resource. * **SourceEntityArn** *(string) --* Source entity ARN. * **DataSetArns** *(list) --* The Amazon Resource Numbers (ARNs) for the datasets that are associated with this version of the dashboard. * *(string) --* * **Description** *(string) --* Description. * **ThemeArn** *(string) --* The ARN of the theme associated with a version of the dashboard. * **Sheets** *(list) --* A list of the associated sheets with the unique identifier and name of each sheet. * *(dict) --* A *sheet*, which is an object that contains a set of visuals that are viewed together on one page in Amazon QuickSight. Every analysis and dashboard contains at least one sheet. Each sheet contains at least one visualization widget, for example a chart, pivot table, or narrative insight. Sheets can be associated with other components, such as controls, filters, and so on. * **SheetId** *(string) --* The unique identifier associated with a sheet. * **Name** *(string) --* The name of a sheet. This name is displayed on the sheet's tab in the Amazon QuickSight console. * **Images** *(list) --* A list of images on a sheet. * *(dict) --* An image that is located on a sheet. * **SheetImageId** *(string) --* The ID of the sheet image. * **Source** *(dict) --* The source of the image. * **SheetImageStaticFileSource** *(dict) --* The source of the static file that contains the image. * **StaticFileId** *(string) --* The ID of the static file that contains the image. * **Scaling** *(dict) --* Determines how the image is scaled. * **ScalingType** *(string) --* The scaling option to use when fitting the image inside the container. Valid values are defined as follows: * "SCALE_TO_WIDTH": The image takes up the entire width of the container. The image aspect ratio is preserved. * "SCALE_TO_HEIGHT": The image takes up the entire height of the container. The image aspect ratio is preserved. * "SCALE_TO_CONTAINER": The image takes up the entire width and height of the container. The image aspect ratio is not preserved. * "SCALE_NONE": The image is displayed in its original size and is not scaled to the container. * **Tooltip** *(dict) --* The tooltip to be shown when hovering over the image. * **TooltipText** *(dict) --* The text that appears in the tooltip. * **PlainText** *(string) --* The plain text format. * **Visibility** *(string) --* The visibility of the tooltip. * **ImageContentAltText** *(string) --* The alt text for the image. * **Interactions** *(dict) --* The general image interactions setup for an image. * **ImageMenuOption** *(dict) --* The menu options for the image. * **AvailabilityStatus** *(string) --* The availability status of the image menu. If the value of this property is set to "ENABLED", dashboard readers can interact with the image menu. * **Actions** *(list) --* A list of custom actions that are configured for an image. * *(dict) --* A custom action defined on an image. * **CustomActionId** *(string) --* The ID of the custom action. * **Name** *(string) --* The name of the custom action. * **Status** *(string) --* The status of the custom action. * **Trigger** *(string) --* The trigger of the "VisualCustomAction". Valid values are defined as follows: * "CLICK": Initiates a custom action by a left pointer click on a data point. * "MENU": Initiates a custom action by right pointer click from the menu. * **ActionOperations** *(list) --* A list of "ImageCustomActionOperations". This is a union type structure. For this structure to be valid, only one of the attributes can be defined. * *(dict) --* The operation that is defined by the custom action. This is a union type structure. For this structure to be valid, only one of the attributes can be defined. * **NavigationOperation** *(dict) --* The navigation operation that navigates between different sheets in the same analysis. This is a union type structure. For this structure to be valid, only one of the attributes can be defined. * **LocalNavigationConfiguration** *(dict) --* The configuration that chooses the navigation target. * **TargetSheetId** *(string) --* The sheet that is targeted for navigation in the same analysis. * **URLOperation** *(dict) --* The URL operation that opens a link to another webpage. * **URLTemplate** *(string) --* THe URL link of the "CustomActionURLOperation". * **URLTarget** *(string) --* The target of the "CustomActionURLOperation". Valid values are defined as follows: * "NEW_TAB": Opens the target URL in a new browser tab. * "NEW_WINDOW": Opens the target URL in a new browser window. * "SAME_TAB": Opens the target URL in the same browser tab. * **SetParametersOperation** *(dict) --* The set parameter operation that sets parameters in custom action. * **ParameterValueConfigurations** *(list) --* The parameter that determines the value configuration. * *(dict) --* The configuration of adding parameters in action. * **DestinationParameterName** *(string) --* The destination parameter name of the "SetParameterValueConfiguration". * **Value** *(dict) --* The configuration of destination parameter values. This is a union type structure. For this structure to be valid, only one of the attributes can be defined. * **CustomValuesConfiguration** *(dict) --* The configuration of custom values for destination parameter in "DestinationParameterValueCo nfiguration". * **IncludeNullValue** *(boolean) --* Includes the null value in custom action parameter values. * **CustomValues** *(dict) --* The customized parameter values. This is a union type structure. For this structure to be valid, only one of the attributes can be defined. * **StringValues** *(list) --* A list of string-type parameter values. * *(string) --* * **IntegerValues** *(list) --* A list of integer-type parameter values. * *(integer) --* * **DecimalValues** *(list) --* A list of decimal-type parameter values. * *(float) --* * **DateTimeValues** *(list) --* A list of datetime-type parameter values. * *(datetime) --* * **SelectAllValueOptions** *(string) --* The configuration that selects all options. * **SourceParameterName** *(string) --* The source parameter name of the destination parameter. * **SourceField** *(string) --* The source field ID of the destination parameter. * **SourceColumn** *(dict) --* A column of a data set. * **DataSetIdentifier** *(string) --* The data set that the column belongs to. * **ColumnName** *(string) --* The name of the column. * **CreatedTime** *(datetime) --* The time that this dashboard was created. * **LastPublishedTime** *(datetime) --* The last time that this dashboard was published. * **LastUpdatedTime** *(datetime) --* The last time that this dashboard was updated. * **LinkEntities** *(list) --* A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard. * *(string) --* * **Status** *(integer) --* The HTTP status of this request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / describe_ingestion describe_ingestion ****************** QuickSight.Client.describe_ingestion(**kwargs) Describes a SPICE ingestion. See also: AWS API Documentation **Request Syntax** response = client.describe_ingestion( AwsAccountId='string', DataSetId='string', IngestionId='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The Amazon Web Services account ID. * **DataSetId** (*string*) -- **[REQUIRED]** The ID of the dataset used in the ingestion. * **IngestionId** (*string*) -- **[REQUIRED]** An ID for the ingestion. Return type: dict Returns: **Response Syntax** { 'Ingestion': { 'Arn': 'string', 'IngestionId': 'string', 'IngestionStatus': 'INITIALIZED'|'QUEUED'|'RUNNING'|'FAILED'|'COMPLETED'|'CANCELLED', 'ErrorInfo': { 'Type': 'FAILURE_TO_ASSUME_ROLE'|'INGESTION_SUPERSEDED'|'INGESTION_CANCELED'|'DATA_SET_DELETED'|'DATA_SET_NOT_SPICE'|'S3_UPLOADED_FILE_DELETED'|'S3_MANIFEST_ERROR'|'DATA_TOLERANCE_EXCEPTION'|'SPICE_TABLE_NOT_FOUND'|'DATA_SET_SIZE_LIMIT_EXCEEDED'|'ROW_SIZE_LIMIT_EXCEEDED'|'ACCOUNT_CAPACITY_LIMIT_EXCEEDED'|'CUSTOMER_ERROR'|'DATA_SOURCE_NOT_FOUND'|'IAM_ROLE_NOT_AVAILABLE'|'CONNECTION_FAILURE'|'SQL_TABLE_NOT_FOUND'|'PERMISSION_DENIED'|'SSL_CERTIFICATE_VALIDATION_FAILURE'|'OAUTH_TOKEN_FAILURE'|'SOURCE_API_LIMIT_EXCEEDED_FAILURE'|'PASSWORD_AUTHENTICATION_FAILURE'|'SQL_SCHEMA_MISMATCH_ERROR'|'INVALID_DATE_FORMAT'|'INVALID_DATAPREP_SYNTAX'|'SOURCE_RESOURCE_LIMIT_EXCEEDED'|'SQL_INVALID_PARAMETER_VALUE'|'QUERY_TIMEOUT'|'SQL_NUMERIC_OVERFLOW'|'UNRESOLVABLE_HOST'|'UNROUTABLE_HOST'|'SQL_EXCEPTION'|'S3_FILE_INACCESSIBLE'|'IOT_FILE_NOT_FOUND'|'IOT_DATA_SET_FILE_EMPTY'|'INVALID_DATA_SOURCE_CONFIG'|'DATA_SOURCE_AUTH_FAILED'|'DATA_SOURCE_CONNECTION_FAILED'|'FAILURE_TO_PROCESS_JSON_FILE'|'INTERNAL_SERVICE_ERROR'|'REFRESH_SUPPRESSED_BY_EDIT'|'PERMISSION_NOT_FOUND'|'ELASTICSEARCH_CURSOR_NOT_ENABLED'|'CURSOR_NOT_ENABLED'|'DUPLICATE_COLUMN_NAMES_FOUND', 'Message': 'string' }, 'RowInfo': { 'RowsIngested': 123, 'RowsDropped': 123, 'TotalRowsInDataset': 123 }, 'QueueInfo': { 'WaitingOnIngestion': 'string', 'QueuedIngestion': 'string' }, 'CreatedTime': datetime(2015, 1, 1), 'IngestionTimeInSeconds': 123, 'IngestionSizeInBytes': 123, 'RequestSource': 'MANUAL'|'SCHEDULED', 'RequestType': 'INITIAL_INGESTION'|'EDIT'|'INCREMENTAL_REFRESH'|'FULL_REFRESH' }, 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **Ingestion** *(dict) --* Information about the ingestion. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the resource. * **IngestionId** *(string) --* Ingestion ID. * **IngestionStatus** *(string) --* Ingestion status. * **ErrorInfo** *(dict) --* Error information for this ingestion. * **Type** *(string) --* Error type. * **Message** *(string) --* Error message. * **RowInfo** *(dict) --* Information about rows for a data set SPICE ingestion. * **RowsIngested** *(integer) --* The number of rows that were ingested. * **RowsDropped** *(integer) --* The number of rows that were not ingested. * **TotalRowsInDataset** *(integer) --* The total number of rows in the dataset. * **QueueInfo** *(dict) --* Information about a queued dataset SPICE ingestion. * **WaitingOnIngestion** *(string) --* The ID of the queued ingestion. * **QueuedIngestion** *(string) --* The ID of the ongoing ingestion. The queued ingestion is waiting for the ongoing ingestion to complete. * **CreatedTime** *(datetime) --* The time that this ingestion started. * **IngestionTimeInSeconds** *(integer) --* The time that this ingestion took, measured in seconds. * **IngestionSizeInBytes** *(integer) --* The size of the data ingested, in bytes. * **RequestSource** *(string) --* Event source for this ingestion. * **RequestType** *(string) --* Type of this ingestion. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.ResourceExistsException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / generate_embed_url_for_registered_user_with_identity generate_embed_url_for_registered_user_with_identity **************************************************** QuickSight.Client.generate_embed_url_for_registered_user_with_identity(**kwargs) Generates an embed URL that you can use to embed an Amazon QuickSight experience in your website. This action can be used for any type of user that is registered in an Amazon QuickSight account that uses IAM Identity Center for authentication. This API requires identity-enhanced IAM Role sessions for the authenticated user that the API call is being made for. This API uses trusted identity propagation to ensure that an end user is authenticated and receives the embed URL that is specific to that user. The IAM Identity Center application that the user has logged into needs to have trusted Identity Propagation enabled for Amazon QuickSight with the scope value set to "quicksight:read". Before you use this action, make sure that you have configured the relevant Amazon QuickSight resource and permissions. See also: AWS API Documentation **Request Syntax** response = client.generate_embed_url_for_registered_user_with_identity( AwsAccountId='string', SessionLifetimeInMinutes=123, ExperienceConfiguration={ 'Dashboard': { 'InitialDashboardId': 'string', 'FeatureConfigurations': { 'StatePersistence': { 'Enabled': True|False }, 'SharedView': { 'Enabled': True|False }, 'Bookmarks': { 'Enabled': True|False }, 'AmazonQInQuickSight': { 'ExecutiveSummary': { 'Enabled': True|False } }, 'Schedules': { 'Enabled': True|False }, 'RecentSnapshots': { 'Enabled': True|False }, 'ThresholdAlerts': { 'Enabled': True|False } } }, 'QuickSightConsole': { 'InitialPath': 'string', 'FeatureConfigurations': { 'StatePersistence': { 'Enabled': True|False }, 'SharedView': { 'Enabled': True|False }, 'AmazonQInQuickSight': { 'DataQnA': { 'Enabled': True|False }, 'GenerativeAuthoring': { 'Enabled': True|False }, 'ExecutiveSummary': { 'Enabled': True|False }, 'DataStories': { 'Enabled': True|False } }, 'Schedules': { 'Enabled': True|False }, 'RecentSnapshots': { 'Enabled': True|False }, 'ThresholdAlerts': { 'Enabled': True|False } } }, 'QSearchBar': { 'InitialTopicId': 'string' }, 'DashboardVisual': { 'InitialDashboardVisualId': { 'DashboardId': 'string', 'SheetId': 'string', 'VisualId': 'string' } }, 'GenerativeQnA': { 'InitialTopicId': 'string' } }, AllowedDomains=[ 'string', ] ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services registered user. * **SessionLifetimeInMinutes** (*integer*) -- The validity of the session in minutes. * **ExperienceConfiguration** (*dict*) -- **[REQUIRED]** The type of experience you want to embed. For registered users, you can embed Amazon QuickSight dashboards or the Amazon QuickSight console. Note: Exactly one of the experience configurations is required. You can choose "Dashboard" or "QuickSightConsole". You cannot choose more than one experience configuration. * **Dashboard** *(dict) --* The configuration details for providing a dashboard embedding experience. * **InitialDashboardId** *(string) --* **[REQUIRED]** The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this dashboard if the user has permissions to view it. If the user does not have permission to view this dashboard, they see a permissions error message. * **FeatureConfigurations** *(dict) --* The feature configurations of an embbedded Amazon QuickSight dashboard. * **StatePersistence** *(dict) --* The state persistence settings of an embedded dashboard. * **Enabled** *(boolean) --* **[REQUIRED]** Determines if a Amazon QuickSight dashboard's state persistence settings are turned on or off. * **SharedView** *(dict) --* The shared view settings of an embedded dashboard. * **Enabled** *(boolean) --* **[REQUIRED]** The shared view settings of an embedded dashboard. * **Bookmarks** *(dict) --* The bookmarks configuration for an embedded dashboard in Amazon QuickSight. * **Enabled** *(boolean) --* **[REQUIRED]** A Boolean value that determines whether a user can bookmark an embedded dashboard. * **AmazonQInQuickSight** *(dict) --* The Amazon Q configurations of an embedded Amazon QuickSight dashboard. * **ExecutiveSummary** *(dict) --* A generated executive summary of an embedded Amazon QuickSight dashboard. * **Enabled** *(boolean) --* **[REQUIRED]** The executive summary settings of an embedded Amazon QuickSight console or dashboard. * **Schedules** *(dict) --* The schedules configuration for an embedded Amazon QuickSight dashboard. * **Enabled** *(boolean) --* **[REQUIRED]** The schedules configuration for an embedded Amazon QuickSight dashboard. * **RecentSnapshots** *(dict) --* The recent snapshots configuration for an Amazon QuickSight embedded dashboard * **Enabled** *(boolean) --* **[REQUIRED]** The recent snapshots configuration for an embedded Amazon QuickSight dashboard. * **ThresholdAlerts** *(dict) --* The threshold alerts configuration for an Amazon QuickSight embedded dashboard. * **Enabled** *(boolean) --* **[REQUIRED]** The threshold alerts configuration for an embedded Amazon QuickSight dashboard. * **QuickSightConsole** *(dict) --* The configuration details for providing each Amazon QuickSight console embedding experience. This can be used along with custom permissions to restrict access to certain features. For more information, see Customizing Access to the Amazon QuickSight Console in the *Amazon QuickSight User Guide*. Use "GenerateEmbedUrlForRegisteredUser" where you want to provide an authoring portal that allows users to create data sources, datasets, analyses, and dashboards. The users who accesses an embedded Amazon QuickSight console needs to belong to the author or admin security cohort. If you want to restrict permissions to some of these features, add a custom permissions profile to the user with the "UpdateUser" API operation. Use the "RegisterUser" API operation to add a new user with a custom permission profile attached. For more information, see the following sections in the *Amazon QuickSight User Guide*: * Embedding the Full Functionality of the Amazon QuickSight Console for Authenticated Users * Customizing Access to the Amazon QuickSight Console For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal. * **InitialPath** *(string) --* The initial URL path for the Amazon QuickSight console. "InitialPath" is required. The entry point URL is constrained to the following paths: * "/start" * "/start/analyses" * "/start/dashboards" * "/start/favorites" * "/dashboards/DashboardId". *DashboardId* is the actual ID key from the Amazon QuickSight console URL of the dashboard. * "/analyses/AnalysisId". *AnalysisId* is the actual ID key from the Amazon QuickSight console URL of the analysis. * **FeatureConfigurations** *(dict) --* The embedding configuration of an embedded Amazon QuickSight console. * **StatePersistence** *(dict) --* The state persistence configurations of an embedded Amazon QuickSight console. * **Enabled** *(boolean) --* **[REQUIRED]** Determines if a Amazon QuickSight dashboard's state persistence settings are turned on or off. * **SharedView** *(dict) --* The shared view settings of an embedded dashboard. * **Enabled** *(boolean) --* **[REQUIRED]** The shared view settings of an embedded dashboard. * **AmazonQInQuickSight** *(dict) --* The Amazon Q configurations of an embedded Amazon QuickSight console. * **DataQnA** *(dict) --* Adds generative Q&A capabilitiees to an embedded Amazon QuickSight console. * **Enabled** *(boolean) --* **[REQUIRED]** The generative Q&A settings of an embedded Amazon QuickSight console. * **GenerativeAuthoring** *(dict) --* Adds the generative BI authoring experience to an embedded Amazon QuickSight console. * **Enabled** *(boolean) --* **[REQUIRED]** The generative BI authoring settings of an embedded Amazon QuickSight console. * **ExecutiveSummary** *(dict) --* Adds the executive summaries feature to an embedded Amazon QuickSight console. * **Enabled** *(boolean) --* **[REQUIRED]** The executive summary settings of an embedded Amazon QuickSight console or dashboard. * **DataStories** *(dict) --* Adds the data stories feature to an embedded Amazon QuickSight console. * **Enabled** *(boolean) --* **[REQUIRED]** The data story settings of an embedded Amazon QuickSight console. * **Schedules** *(dict) --* The schedules configuration for an embedded Amazon QuickSight dashboard. * **Enabled** *(boolean) --* **[REQUIRED]** The schedules configuration for an embedded Amazon QuickSight dashboard. * **RecentSnapshots** *(dict) --* The recent snapshots configuration for an embedded Amazon QuickSight dashboard. * **Enabled** *(boolean) --* **[REQUIRED]** The recent snapshots configuration for an embedded Amazon QuickSight dashboard. * **ThresholdAlerts** *(dict) --* The threshold alerts configuration for an embedded Amazon QuickSight dashboard. * **Enabled** *(boolean) --* **[REQUIRED]** The threshold alerts configuration for an embedded Amazon QuickSight dashboard. * **QSearchBar** *(dict) --* The configuration details for embedding the Q search bar. For more information about embedding the Q search bar, see Embedding Overview in the *Amazon QuickSight User Guide*. * **InitialTopicId** *(string) --* The ID of the legacy Q topic that you want to use as the starting topic in the Q search bar. To locate the topic ID of the topic that you want to use, open the Amazon QuickSight console, navigate to the **Topics** pane, and choose thre topic that you want to use. The "TopicID" is located in the URL of the topic that opens. When you select an initial topic, you can specify whether or not readers are allowed to select other topics from the list of available topics. If you don't specify an initial topic or if you specify a new reader experience topic, a list of all shared legacy topics is shown in the Q bar. * **DashboardVisual** *(dict) --* The type of embedding experience. In this case, Amazon QuickSight visuals. * **InitialDashboardVisualId** *(dict) --* **[REQUIRED]** The visual ID for the visual that you want the user to embed. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this visual. The Amazon Resource Name (ARN) of the dashboard that the visual belongs to must be included in the "AuthorizedResourceArns" parameter. Otherwise, the request will fail with "InvalidParameterValueException". * **DashboardId** *(string) --* **[REQUIRED]** The ID of the dashboard that has the visual that you want to embed. The "DashboardId" can be found in the "IDs for developers" section of the "Embed visual" pane of the visual's on-visual menu of the Amazon QuickSight console. You can also get the "DashboardId" with a "ListDashboards" API operation. * **SheetId** *(string) --* **[REQUIRED]** The ID of the sheet that the has visual that you want to embed. The "SheetId" can be found in the "IDs for developers" section of the "Embed visual" pane of the visual's on-visual menu of the Amazon QuickSight console. * **VisualId** *(string) --* **[REQUIRED]** The ID of the visual that you want to embed. The "VisualID" can be found in the "IDs for developers" section of the "Embed visual" pane of the visual's on- visual menu of the Amazon QuickSight console. * **GenerativeQnA** *(dict) --* The configuration details for embedding the Generative Q&A experience. For more information about embedding the Generative Q&A experience, see Embedding Overview in the *Amazon QuickSight User Guide*. * **InitialTopicId** *(string) --* The ID of the new Q reader experience topic that you want to make the starting topic in the Generative Q&A experience. You can find a topic ID by navigating to the Topics pane in the Amazon QuickSight application and opening a topic. The ID is in the URL for the topic that you open. If you don't specify an initial topic or you specify a legacy topic, a list of all shared new reader experience topics is shown in the Generative Q&A experience for your readers. When you select an initial new reader experience topic, you can specify whether or not readers are allowed to select other new reader experience topics from the available ones in the list. * **AllowedDomains** (*list*) -- A list of domains to be allowed to generate the embed URL. * *(string) --* Return type: dict Returns: **Response Syntax** { 'EmbedUrl': 'string', 'Status': 123, 'RequestId': 'string' } **Response Structure** * *(dict) --* * **EmbedUrl** *(string) --* The generated embed URL for the registered user. * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.QuickSightUserNotFoundException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.SessionLifetimeInMinutesInvalidExc eption" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.UnsupportedPricingPlanException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / list_users list_users ********** QuickSight.Client.list_users(**kwargs) Returns a list of all of the Amazon QuickSight users belonging to this account. See also: AWS API Documentation **Request Syntax** response = client.list_users( AwsAccountId='string', NextToken='string', MaxResults=123, Namespace='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** 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. * **NextToken** (*string*) -- A pagination token that can be used in a subsequent request. * **MaxResults** (*integer*) -- The maximum number of results to return from this request. * **Namespace** (*string*) -- **[REQUIRED]** The namespace. Currently, you should set this to "default". Return type: dict Returns: **Response Syntax** { 'UserList': [ { 'Arn': 'string', 'UserName': 'string', 'Email': 'string', 'Role': 'ADMIN'|'AUTHOR'|'READER'|'RESTRICTED_AUTHOR'|'RESTRICTED_READER'|'ADMIN_PRO'|'AUTHOR_PRO'|'READER_PRO', 'IdentityType': 'IAM'|'QUICKSIGHT'|'IAM_IDENTITY_CENTER', 'Active': True|False, 'PrincipalId': 'string', 'CustomPermissionsName': 'string', 'ExternalLoginFederationProviderType': 'string', 'ExternalLoginFederationProviderUrl': 'string', 'ExternalLoginId': 'string' }, ], 'NextToken': 'string', 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **UserList** *(list) --* The list of users. * *(dict) --* A registered user of Amazon QuickSight. * **Arn** *(string) --* The Amazon Resource Name (ARN) for the user. * **UserName** *(string) --* The user's user name. This value is required if you are registering a user that will be managed in Amazon QuickSight. In the output, the value for "UserName" is "N/A" when the value for "IdentityType" is "IAM" and the corresponding IAM user is deleted. * **Email** *(string) --* The user's email address. * **Role** *(string) --* The Amazon QuickSight role for the user. The user role can be one of the following:. * "READER": A user who has read-only access to dashboards. * "AUTHOR": A user who can create data sources, datasets, analyses, and dashboards. * "ADMIN": A user who is an author, who can also manage Amazon Amazon QuickSight settings. * "READER_PRO": Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Amazon QuickSight, can build stories with Amazon Q, and can generate executive summaries from dashboards. * "AUTHOR_PRO": Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&A, and generate executive summaries from dashboards. * "ADMIN_PRO": Admin Pros are Author Pros who can also manage Amazon QuickSight administrative settings. Admin Pro users are billed at Author Pro pricing. * "RESTRICTED_READER": This role isn't currently available for use. * "RESTRICTED_AUTHOR": This role isn't currently available for use. * **IdentityType** *(string) --* The type of identity authentication used by the user. * **Active** *(boolean) --* The active status of user. When you create an Amazon QuickSight user that's not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a password. * **PrincipalId** *(string) --* The principal ID of the user. * **CustomPermissionsName** *(string) --* The custom permissions profile associated with this user. * **ExternalLoginFederationProviderType** *(string) --* The type of supported external login provider that provides identity to let the user federate into Amazon QuickSight with an associated IAM role. The type can be one of the following. * "COGNITO": Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. * "CUSTOM_OIDC": Custom OpenID Connect (OIDC) provider. * **ExternalLoginFederationProviderUrl** *(string) --* The URL of the external login provider. * **ExternalLoginId** *(string) --* The identity ID for the user in the external login provider. * **NextToken** *(string) --* A pagination token that can be used in a subsequent request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InvalidNextTokenException" * "QuickSight.Client.exceptions.PreconditionNotMetException" * "QuickSight.Client.exceptions.InternalFailureException" * "QuickSight.Client.exceptions.ResourceUnavailableException" QuickSight / Client / delete_user delete_user *********** QuickSight.Client.delete_user(**kwargs) Deletes the Amazon QuickSight user that is associated with the identity of the IAM user or role that's making the call. The IAM user isn't deleted as a result of this call. See also: AWS API Documentation **Request Syntax** response = client.delete_user( UserName='string', AwsAccountId='string', Namespace='string' ) Parameters: * **UserName** (*string*) -- **[REQUIRED]** The name of the user that you want to delete. * **AwsAccountId** (*string*) -- **[REQUIRED]** 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** (*string*) -- **[REQUIRED]** The namespace. Currently, you should set this to "default". Return type: dict Returns: **Response Syntax** { 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.PreconditionNotMetException" * "QuickSight.Client.exceptions.InternalFailureException" * "QuickSight.Client.exceptions.ResourceUnavailableException" QuickSight / Client / search_folders search_folders ************** QuickSight.Client.search_folders(**kwargs) Searches the subfolders in a folder. See also: AWS API Documentation **Request Syntax** response = client.search_folders( AwsAccountId='string', Filters=[ { 'Operator': 'StringEquals'|'StringLike', 'Name': 'PARENT_FOLDER_ARN'|'DIRECT_QUICKSIGHT_OWNER'|'DIRECT_QUICKSIGHT_SOLE_OWNER'|'DIRECT_QUICKSIGHT_VIEWER_OR_OWNER'|'QUICKSIGHT_OWNER'|'QUICKSIGHT_VIEWER_OR_OWNER'|'FOLDER_NAME', 'Value': 'string' }, ], NextToken='string', MaxResults=123 ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID for the Amazon Web Services account that contains the folder. * **Filters** (*list*) -- **[REQUIRED]** 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" } ]". * *(dict) --* A filter to use to search an Amazon QuickSight folder. * **Operator** *(string) --* The comparison operator that you want to use as a filter, for example ""Operator": "StringEquals"". Valid values are ""StringEquals"" and ""StringLike"". If you set the operator value to ""StringEquals"", you need to provide an ownership related filter in the ""NAME"" field and the arn of the user or group whose folders you want to search in the ""Value"" field. For example, ""Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us- east-1:1:user/default/UserName1"". If you set the value to ""StringLike"", you need to provide the name of the folders you are searching for. For example, ""Name":"FOLDER_NAME", "Operator": "StringLike", "Value": "Test"". The ""StringLike"" operator only supports the "NAME" value "FOLDER_NAME". * **Name** *(string) --* The name of a value that you want to use in the filter. For example, ""Name": "QUICKSIGHT_OWNER"". Valid values are defined as follows: * "QUICKSIGHT_VIEWER_OR_OWNER": Provide an ARN of a user or group, and any folders with that ARN listed as one of the folder's owners or viewers are returned. Implicit permissions from folders or groups are considered. * "QUICKSIGHT_OWNER": Provide an ARN of a user or group, and any folders with that ARN listed as one of the owners of the folders are returned. Implicit permissions from folders or groups are considered. * "DIRECT_QUICKSIGHT_SOLE_OWNER": Provide an ARN of a user or group, and any folders with that ARN listed as the only owner of the folder are returned. Implicit permissions from folders or groups are not considered. * "DIRECT_QUICKSIGHT_OWNER": Provide an ARN of a user or group, and any folders with that ARN listed as one of the owners of the folders are returned. Implicit permissions from folders or groups are not considered. * "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER": Provide an ARN of a user or group, and any folders with that ARN listed as one of the owners or viewers of the folders are returned. Implicit permissions from folders or groups are not considered. * "FOLDER_NAME": Any folders whose names have a substring match to this value will be returned. * "PARENT_FOLDER_ARN": Provide an ARN of a folder, and any folders that are directly under that parent folder are returned. If you choose to use this option and leave the value blank, all root-level folders in the account are returned. * **Value** *(string) --* The value of the named item (in this example, "PARENT_FOLDER_ARN"), that you want to use as a filter. For example, ""Value": "arn:aws:quicksight:us- east-1:1:folder/folderId"". * **NextToken** (*string*) -- The token for the next set of results, or null if there are no more results. * **MaxResults** (*integer*) -- The maximum number of results to be returned per request. Return type: dict Returns: **Response Syntax** { 'Status': 123, 'FolderSummaryList': [ { 'Arn': 'string', 'FolderId': 'string', 'Name': 'string', 'FolderType': 'SHARED'|'RESTRICTED', 'CreatedTime': datetime(2015, 1, 1), 'LastUpdatedTime': datetime(2015, 1, 1), 'SharingModel': 'ACCOUNT'|'NAMESPACE' }, ], 'NextToken': 'string', 'RequestId': 'string' } **Response Structure** * *(dict) --* * **Status** *(integer) --* The HTTP status of the request. * **FolderSummaryList** *(list) --* A structure that contains all of the folders in the Amazon Web Services account. This structure provides basic information about the folders. * *(dict) --* A summary of information about an existing Amazon QuickSight folder. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the folder. * **FolderId** *(string) --* The ID of the folder. * **Name** *(string) --* The display name of the folder. * **FolderType** *(string) --* The type of folder. * **CreatedTime** *(datetime) --* The time that the folder was created. * **LastUpdatedTime** *(datetime) --* The time that the folder was last updated. * **SharingModel** *(string) --* The sharing scope of the folder. * **NextToken** *(string) --* The token for the next set of results, or null if there are no more results. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InvalidNextTokenException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.InvalidRequestException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / create_brand create_brand ************ QuickSight.Client.create_brand(**kwargs) Creates an Amazon QuickSight brand. See also: AWS API Documentation **Request Syntax** response = client.create_brand( AwsAccountId='string', BrandId='string', BrandDefinition={ 'BrandName': 'string', 'Description': 'string', 'ApplicationTheme': { 'BrandColorPalette': { 'Primary': { 'Foreground': 'string', 'Background': 'string' }, 'Secondary': { 'Foreground': 'string', 'Background': 'string' }, 'Accent': { 'Foreground': 'string', 'Background': 'string' }, 'Measure': { 'Foreground': 'string', 'Background': 'string' }, 'Dimension': { 'Foreground': 'string', 'Background': 'string' }, 'Success': { 'Foreground': 'string', 'Background': 'string' }, 'Info': { 'Foreground': 'string', 'Background': 'string' }, 'Warning': { 'Foreground': 'string', 'Background': 'string' }, 'Danger': { 'Foreground': 'string', 'Background': 'string' } }, 'BrandElementStyle': { 'NavbarStyle': { 'GlobalNavbar': { 'Foreground': 'string', 'Background': 'string' }, 'ContextualNavbar': { 'Foreground': 'string', 'Background': 'string' } } } }, 'LogoConfiguration': { 'AltText': 'string', 'LogoSet': { 'Primary': { 'Original': { 'Source': { 'PublicUrl': 'string', 'S3Uri': 'string' } } }, 'Favicon': { 'Original': { 'Source': { 'PublicUrl': 'string', 'S3Uri': 'string' } } } } } }, Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that owns the brand. * **BrandId** (*string*) -- **[REQUIRED]** The ID of the Amazon QuickSight brand. * **BrandDefinition** (*dict*) -- The definition of the brand. * **BrandName** *(string) --* **[REQUIRED]** The name of the brand. * **Description** *(string) --* The description of the brand. * **ApplicationTheme** *(dict) --* The application theme of the brand. * **BrandColorPalette** *(dict) --* The color palette. * **Primary** *(dict) --* The primary color. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **Secondary** *(dict) --* The secondary color. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **Accent** *(dict) --* The color that is used for accent elements. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **Measure** *(dict) --* The color that is used for measure elements. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **Dimension** *(dict) --* The color that is used for dimension elements. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **Success** *(dict) --* The color that is used for success elements. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **Info** *(dict) --* The color that is used for info elements. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **Warning** *(dict) --* The color that is used for warning elements. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **Danger** *(dict) --* The color that is used for danger elements. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **BrandElementStyle** *(dict) --* The element style. * **NavbarStyle** *(dict) --* The navigation bar style. * **GlobalNavbar** *(dict) --* The global navigation bar style. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **ContextualNavbar** *(dict) --* The contextual navigation bar style. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **LogoConfiguration** *(dict) --* The logo configuration of the brand. * **AltText** *(string) --* **[REQUIRED]** The alt text for the logo. * **LogoSet** *(dict) --* **[REQUIRED]** A set of configured logos. * **Primary** *(dict) --* **[REQUIRED]** The primary logo. * **Original** *(dict) --* **[REQUIRED]** The original image. * **Source** *(dict) --* The source of the image. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "PublicUrl", "S3Uri". * **PublicUrl** *(string) --* The public URL that points to the source image. * **S3Uri** *(string) --* The Amazon S3 URI that points to the source image. * **Favicon** *(dict) --* The favicon logo. * **Original** *(dict) --* **[REQUIRED]** The original image. * **Source** *(dict) --* The source of the image. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "PublicUrl", "S3Uri". * **PublicUrl** *(string) --* The public URL that points to the source image. * **S3Uri** *(string) --* The Amazon S3 URI that points to the source image. * **Tags** (*list*) -- A map of the key-value pairs that are assigned to the brand. * *(dict) --* The key or keys of the key-value pairs for the resource tag or tags assigned to the resource. * **Key** *(string) --* **[REQUIRED]** Tag key. * **Value** *(string) --* **[REQUIRED]** Tag value. Return type: dict Returns: **Response Syntax** { 'RequestId': 'string', 'BrandDetail': { 'BrandId': 'string', 'Arn': 'string', 'BrandStatus': 'CREATE_IN_PROGRESS'|'CREATE_SUCCEEDED'|'CREATE_FAILED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED', 'CreatedTime': datetime(2015, 1, 1), 'LastUpdatedTime': datetime(2015, 1, 1), 'VersionId': 'string', 'VersionStatus': 'CREATE_IN_PROGRESS'|'CREATE_SUCCEEDED'|'CREATE_FAILED', 'Errors': [ 'string', ], 'Logo': { 'AltText': 'string', 'LogoSet': { 'Primary': { 'Original': { 'Source': { 'PublicUrl': 'string', 'S3Uri': 'string' }, 'GeneratedImageUrl': 'string' }, 'Height64': { 'Source': { 'PublicUrl': 'string', 'S3Uri': 'string' }, 'GeneratedImageUrl': 'string' }, 'Height32': { 'Source': { 'PublicUrl': 'string', 'S3Uri': 'string' }, 'GeneratedImageUrl': 'string' } }, 'Favicon': { 'Original': { 'Source': { 'PublicUrl': 'string', 'S3Uri': 'string' }, 'GeneratedImageUrl': 'string' }, 'Height64': { 'Source': { 'PublicUrl': 'string', 'S3Uri': 'string' }, 'GeneratedImageUrl': 'string' }, 'Height32': { 'Source': { 'PublicUrl': 'string', 'S3Uri': 'string' }, 'GeneratedImageUrl': 'string' } } } } }, 'BrandDefinition': { 'BrandName': 'string', 'Description': 'string', 'ApplicationTheme': { 'BrandColorPalette': { 'Primary': { 'Foreground': 'string', 'Background': 'string' }, 'Secondary': { 'Foreground': 'string', 'Background': 'string' }, 'Accent': { 'Foreground': 'string', 'Background': 'string' }, 'Measure': { 'Foreground': 'string', 'Background': 'string' }, 'Dimension': { 'Foreground': 'string', 'Background': 'string' }, 'Success': { 'Foreground': 'string', 'Background': 'string' }, 'Info': { 'Foreground': 'string', 'Background': 'string' }, 'Warning': { 'Foreground': 'string', 'Background': 'string' }, 'Danger': { 'Foreground': 'string', 'Background': 'string' } }, 'BrandElementStyle': { 'NavbarStyle': { 'GlobalNavbar': { 'Foreground': 'string', 'Background': 'string' }, 'ContextualNavbar': { 'Foreground': 'string', 'Background': 'string' } } } }, 'LogoConfiguration': { 'AltText': 'string', 'LogoSet': { 'Primary': { 'Original': { 'Source': { 'PublicUrl': 'string', 'S3Uri': 'string' } } }, 'Favicon': { 'Original': { 'Source': { 'PublicUrl': 'string', 'S3Uri': 'string' } } } } } } } **Response Structure** * *(dict) --* * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **BrandDetail** *(dict) --* The details of the brand. * **BrandId** *(string) --* The ID of the Amazon QuickSight brand. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the brand. * **BrandStatus** *(string) --* The status of the brand. * **CreatedTime** *(datetime) --* The time that the brand was created. * **LastUpdatedTime** *(datetime) --* The last time the brand was updated. * **VersionId** *(string) --* The ID of the version. * **VersionStatus** *(string) --* The status of the version. * **Errors** *(list) --* A list of errors that occurred during the most recent brand operation. * *(string) --* * **Logo** *(dict) --* The logo details. * **AltText** *(string) --* The alt text for the logo. * **LogoSet** *(dict) --* A set of configured logos. * **Primary** *(dict) --* The primary logo. * **Original** *(dict) --* The original image. * **Source** *(dict) --* The source of the logo image. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "PublicUrl", "S3Uri". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **PublicUrl** *(string) --* The public URL that points to the source image. * **S3Uri** *(string) --* The Amazon S3 URI that points to the source image. * **GeneratedImageUrl** *(string) --* The URL that points to the generated logo image. * **Height64** *(dict) --* The image with the height set to 64 pixels. * **Source** *(dict) --* The source of the logo image. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "PublicUrl", "S3Uri". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **PublicUrl** *(string) --* The public URL that points to the source image. * **S3Uri** *(string) --* The Amazon S3 URI that points to the source image. * **GeneratedImageUrl** *(string) --* The URL that points to the generated logo image. * **Height32** *(dict) --* The image with the height set to 32 pixels. * **Source** *(dict) --* The source of the logo image. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "PublicUrl", "S3Uri". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **PublicUrl** *(string) --* The public URL that points to the source image. * **S3Uri** *(string) --* The Amazon S3 URI that points to the source image. * **GeneratedImageUrl** *(string) --* The URL that points to the generated logo image. * **Favicon** *(dict) --* The favicon logo. * **Original** *(dict) --* The original image. * **Source** *(dict) --* The source of the logo image. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "PublicUrl", "S3Uri". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **PublicUrl** *(string) --* The public URL that points to the source image. * **S3Uri** *(string) --* The Amazon S3 URI that points to the source image. * **GeneratedImageUrl** *(string) --* The URL that points to the generated logo image. * **Height64** *(dict) --* The image with the height set to 64 pixels. * **Source** *(dict) --* The source of the logo image. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "PublicUrl", "S3Uri". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **PublicUrl** *(string) --* The public URL that points to the source image. * **S3Uri** *(string) --* The Amazon S3 URI that points to the source image. * **GeneratedImageUrl** *(string) --* The URL that points to the generated logo image. * **Height32** *(dict) --* The image with the height set to 32 pixels. * **Source** *(dict) --* The source of the logo image. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "PublicUrl", "S3Uri". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **PublicUrl** *(string) --* The public URL that points to the source image. * **S3Uri** *(string) --* The Amazon S3 URI that points to the source image. * **GeneratedImageUrl** *(string) --* The URL that points to the generated logo image. * **BrandDefinition** *(dict) --* The definition of the brand. * **BrandName** *(string) --* The name of the brand. * **Description** *(string) --* The description of the brand. * **ApplicationTheme** *(dict) --* The application theme of the brand. * **BrandColorPalette** *(dict) --* The color palette. * **Primary** *(dict) --* The primary color. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **Secondary** *(dict) --* The secondary color. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **Accent** *(dict) --* The color that is used for accent elements. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **Measure** *(dict) --* The color that is used for measure elements. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **Dimension** *(dict) --* The color that is used for dimension elements. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **Success** *(dict) --* The color that is used for success elements. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **Info** *(dict) --* The color that is used for info elements. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **Warning** *(dict) --* The color that is used for warning elements. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **Danger** *(dict) --* The color that is used for danger elements. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **BrandElementStyle** *(dict) --* The element style. * **NavbarStyle** *(dict) --* The navigation bar style. * **GlobalNavbar** *(dict) --* The global navigation bar style. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **ContextualNavbar** *(dict) --* The contextual navigation bar style. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **LogoConfiguration** *(dict) --* The logo configuration of the brand. * **AltText** *(string) --* The alt text for the logo. * **LogoSet** *(dict) --* A set of configured logos. * **Primary** *(dict) --* The primary logo. * **Original** *(dict) --* The original image. * **Source** *(dict) --* The source of the image. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "PublicUrl", "S3Uri". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **PublicUrl** *(string) --* The public URL that points to the source image. * **S3Uri** *(string) --* The Amazon S3 URI that points to the source image. * **Favicon** *(dict) --* The favicon logo. * **Original** *(dict) --* The original image. * **Source** *(dict) --* The source of the image. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "PublicUrl", "S3Uri". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **PublicUrl** *(string) --* The public URL that points to the source image. * **S3Uri** *(string) --* The Amazon S3 URI that points to the source image. **Exceptions** * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InvalidRequestException" * "QuickSight.Client.exceptions.LimitExceededException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InternalServerException" QuickSight / Client / delete_theme_alias delete_theme_alias ****************** QuickSight.Client.delete_theme_alias(**kwargs) Deletes the version of the theme that the specified theme alias points to. If you provide a specific alias, you delete the version of the theme that the alias points to. See also: AWS API Documentation **Request Syntax** response = client.delete_theme_alias( AwsAccountId='string', ThemeId='string', AliasName='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the theme alias to delete. * **ThemeId** (*string*) -- **[REQUIRED]** The ID for the theme that the specified alias is for. * **AliasName** (*string*) -- **[REQUIRED]** The unique name for the theme alias to delete. Return type: dict Returns: **Response Syntax** { 'AliasName': 'string', 'Arn': 'string', 'RequestId': 'string', 'Status': 123, 'ThemeId': 'string' } **Response Structure** * *(dict) --* * **AliasName** *(string) --* The name for the theme alias. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the theme resource using the deleted alias. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. * **ThemeId** *(string) --* An ID for the theme associated with the deletion. **Exceptions** * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / generate_embed_url_for_anonymous_user generate_embed_url_for_anonymous_user ************************************* QuickSight.Client.generate_embed_url_for_anonymous_user(**kwargs) Generates an embed URL that you can use to embed an Amazon QuickSight dashboard or visual in your website, without having to register any reader users. Before you use this action, make sure that you have configured the dashboards and permissions. The following rules apply to the generated URL: * It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again. * The URL validity period should not be confused with the actual session lifetime that can be customized using the "SessionLifetimeInMinutes" parameter. The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours. * You are charged only when the URL is used or there is interaction with Amazon QuickSight. For more information, see Embedded Analytics in the *Amazon QuickSight User Guide*. For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal. See also: AWS API Documentation **Request Syntax** response = client.generate_embed_url_for_anonymous_user( AwsAccountId='string', SessionLifetimeInMinutes=123, Namespace='string', SessionTags=[ { 'Key': 'string', 'Value': 'string' }, ], AuthorizedResourceArns=[ 'string', ], ExperienceConfiguration={ 'Dashboard': { 'InitialDashboardId': 'string', 'EnabledFeatures': [ 'SHARED_VIEW', ], 'DisabledFeatures': [ 'SHARED_VIEW', ], 'FeatureConfigurations': { 'SharedView': { 'Enabled': True|False } } }, 'DashboardVisual': { 'InitialDashboardVisualId': { 'DashboardId': 'string', 'SheetId': 'string', 'VisualId': 'string' } }, 'QSearchBar': { 'InitialTopicId': 'string' }, 'GenerativeQnA': { 'InitialTopicId': 'string' } }, AllowedDomains=[ 'string', ] ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID for the Amazon Web Services account that contains the dashboard that you're embedding. * **SessionLifetimeInMinutes** (*integer*) -- How many minutes the session is valid. The session lifetime must be in [15-600] minutes range. * **Namespace** (*string*) -- **[REQUIRED]** 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". * **SessionTags** (*list*) -- 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 >>`<`__in the *Amazon QuickSight User Guide*. * *(dict) --* The key-value pair used for the row-level security tags feature. * **Key** *(string) --* **[REQUIRED]** The key for the tag. * **Value** *(string) --* **[REQUIRED]** The value that you want to assign the tag. * **AuthorizedResourceArns** (*list*) -- **[REQUIRED]** The Amazon Resource Names (ARNs) for the Amazon QuickSight resources that the user is authorized to access during the lifetime of the session. If you choose "Dashboard" embedding experience, pass the list of dashboard ARNs in the account that you want the user to be able to view. If you want to make changes to the theme of your embedded content, pass a list of theme ARNs that the anonymous users need access to. Currently, you can pass up to 25 theme ARNs in each API call. * *(string) --* * **ExperienceConfiguration** (*dict*) -- **[REQUIRED]** The configuration of the experience that you are embedding. * **Dashboard** *(dict) --* The type of embedding experience. In this case, Amazon QuickSight dashboards. * **InitialDashboardId** *(string) --* **[REQUIRED]** The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this dashboard. The Amazon Resource Name (ARN) of this dashboard must be included in the "AuthorizedResourceArns" parameter. Otherwise, the request will fail with "InvalidParameterValueException". * **EnabledFeatures** *(list) --* A list of all enabled features of a specified anonymous dashboard. * *(string) --* * **DisabledFeatures** *(list) --* A list of all disabled features of a specified anonymous dashboard. * *(string) --* * **FeatureConfigurations** *(dict) --* The feature configuration for an embedded dashboard. * **SharedView** *(dict) --* The shared view settings of an embedded dashboard. * **Enabled** *(boolean) --* **[REQUIRED]** The shared view settings of an embedded dashboard. * **DashboardVisual** *(dict) --* The type of embedding experience. In this case, Amazon QuickSight visuals. * **InitialDashboardVisualId** *(dict) --* **[REQUIRED]** The visual ID for the visual that you want the user to see. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this visual. The Amazon Resource Name (ARN) of the dashboard that the visual belongs to must be included in the "AuthorizedResourceArns" parameter. Otherwise, the request will fail with "InvalidParameterValueException". * **DashboardId** *(string) --* **[REQUIRED]** The ID of the dashboard that has the visual that you want to embed. The "DashboardId" can be found in the "IDs for developers" section of the "Embed visual" pane of the visual's on-visual menu of the Amazon QuickSight console. You can also get the "DashboardId" with a "ListDashboards" API operation. * **SheetId** *(string) --* **[REQUIRED]** The ID of the sheet that the has visual that you want to embed. The "SheetId" can be found in the "IDs for developers" section of the "Embed visual" pane of the visual's on-visual menu of the Amazon QuickSight console. * **VisualId** *(string) --* **[REQUIRED]** The ID of the visual that you want to embed. The "VisualID" can be found in the "IDs for developers" section of the "Embed visual" pane of the visual's on- visual menu of the Amazon QuickSight console. * **QSearchBar** *(dict) --* The Q search bar that you want to use for anonymous user embedding. * **InitialTopicId** *(string) --* **[REQUIRED]** The Amazon QuickSight Q topic ID of the legacy topic that you want the anonymous user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders the Q search bar with this legacy topic pre-selected. The Amazon Resource Name (ARN) of this Q legacy topic must be included in the "AuthorizedResourceArns" parameter. Otherwise, the request fails with an "InvalidParameterValueException" error. * **GenerativeQnA** *(dict) --* The Generative Q&A experience that you want to use for anonymous user embedding. * **InitialTopicId** *(string) --* **[REQUIRED]** The Amazon QuickSight Q topic ID of the new reader experience topic that you want the anonymous user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders the Generative Q&A experience with this new reader experience topic pre selected. The Amazon Resource Name (ARN) of this Q new reader experience topic must be included in the "AuthorizedResourceArns" parameter. Otherwise, the request fails with an "InvalidParameterValueException" error. * **AllowedDomains** (*list*) -- The domains that you want to add to the allow list for access to the generated URL that is then embedded. This optional parameter overrides the static domains that are configured in the Manage QuickSight menu in the Amazon QuickSight console. Instead, it allows only the domains that you include in this parameter. You can list up to three domains or subdomains in each API call. To include all subdomains under a specific domain to the allow list, use "*". For example, "https://*.sapp.amazon.com" includes all subdomains under "https://sapp.amazon.com". * *(string) --* Return type: dict Returns: **Response Syntax** { 'EmbedUrl': 'string', 'Status': 123, 'RequestId': 'string', 'AnonymousUserArn': 'string' } **Response Structure** * *(dict) --* * **EmbedUrl** *(string) --* The embed URL for the dashboard. * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **AnonymousUserArn** *(string) --* The Amazon Resource Name (ARN) to use for the anonymous Amazon QuickSight user. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.SessionLifetimeInMinutesInvalidExc eption" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.UnsupportedPricingPlanException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / create_analysis create_analysis *************** QuickSight.Client.create_analysis(**kwargs) Creates an analysis in Amazon QuickSight. Analyses can be created either from a template or from an "AnalysisDefinition". See also: AWS API Documentation **Request Syntax** # This section is too large to render. # Please see the AWS API Documentation linked below. AWS API Documentation **Parameters** # This section is too large to render. # Please see the AWS API Documentation linked below. AWS API Documentation Return type: dict Returns: **Response Syntax** { 'Arn': 'string', 'AnalysisId': 'string', 'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED', 'Status': 123, 'RequestId': 'string' } **Response Structure** * *(dict) --* * **Arn** *(string) --* The ARN for the analysis. * **AnalysisId** *(string) --* The ID of the analysis. * **CreationStatus** *(string) --* The status of the creation of the analysis. * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.ResourceExistsException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.LimitExceededException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / create_theme_alias create_theme_alias ****************** QuickSight.Client.create_theme_alias(**kwargs) Creates a theme alias for a theme. See also: AWS API Documentation **Request Syntax** response = client.create_theme_alias( AwsAccountId='string', ThemeId='string', AliasName='string', ThemeVersionNumber=123 ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the theme for the new theme alias. * **ThemeId** (*string*) -- **[REQUIRED]** An ID for the theme alias. * **AliasName** (*string*) -- **[REQUIRED]** 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. * **ThemeVersionNumber** (*integer*) -- **[REQUIRED]** The version number of the theme. Return type: dict Returns: **Response Syntax** { 'ThemeAlias': { 'Arn': 'string', 'AliasName': 'string', 'ThemeVersionNumber': 123 }, 'Status': 123, 'RequestId': 'string' } **Response Structure** * *(dict) --* * **ThemeAlias** *(dict) --* Information about the theme alias. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the theme alias. * **AliasName** *(string) --* The display name of the theme alias. * **ThemeVersionNumber** *(integer) --* The version number of the theme alias. * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.LimitExceededException" * "QuickSight.Client.exceptions.ResourceExistsException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / start_asset_bundle_export_job start_asset_bundle_export_job ***************************** QuickSight.Client.start_asset_bundle_export_job(**kwargs) Starts an Asset Bundle export job. An Asset Bundle export job exports specified Amazon QuickSight assets. You can also choose to export any asset dependencies in the same job. Export jobs run asynchronously and can be polled with a "DescribeAssetBundleExportJob" API call. When a job is successfully completed, a download URL that contains the exported assets is returned. The URL is valid for 5 minutes and can be refreshed with a "DescribeAssetBundleExportJob" API call. Each Amazon QuickSight account can run up to 5 export jobs concurrently. The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported. See also: AWS API Documentation **Request Syntax** response = client.start_asset_bundle_export_job( AwsAccountId='string', AssetBundleExportJobId='string', ResourceArns=[ 'string', ], IncludeAllDependencies=True|False, ExportFormat='CLOUDFORMATION_JSON'|'QUICKSIGHT_JSON', CloudFormationOverridePropertyConfiguration={ 'ResourceIdOverrideConfiguration': { 'PrefixForAllResources': True|False }, 'VPCConnections': [ { 'Arn': 'string', 'Properties': [ 'Name'|'DnsResolvers'|'RoleArn', ] }, ], 'RefreshSchedules': [ { 'Arn': 'string', 'Properties': [ 'StartAfterDateTime', ] }, ], 'DataSources': [ { 'Arn': 'string', 'Properties': [ 'Name'|'DisableSsl'|'SecretArn'|'Username'|'Password'|'Domain'|'WorkGroup'|'Host'|'Port'|'Database'|'DataSetName'|'Catalog'|'InstanceId'|'ClusterId'|'ManifestFileLocation'|'Warehouse'|'RoleArn'|'ProductType', ] }, ], 'DataSets': [ { 'Arn': 'string', 'Properties': [ 'Name'|'RefreshFailureEmailAlertStatus', ] }, ], 'Themes': [ { 'Arn': 'string', 'Properties': [ 'Name', ] }, ], 'Analyses': [ { 'Arn': 'string', 'Properties': [ 'Name', ] }, ], 'Dashboards': [ { 'Arn': 'string', 'Properties': [ 'Name', ] }, ], 'Folders': [ { 'Arn': 'string', 'Properties': [ 'Name'|'ParentFolderArn', ] }, ] }, IncludePermissions=True|False, IncludeTags=True|False, ValidationStrategy={ 'StrictModeForAllResources': True|False }, IncludeFolderMemberships=True|False, IncludeFolderMembers='RECURSE'|'ONE_LEVEL'|'NONE' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account to export assets from. * **AssetBundleExportJobId** (*string*) -- **[REQUIRED]** The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job. * **ResourceArns** (*list*) -- **[REQUIRED]** An array of resource ARNs to export. The following resources are supported. * "Analysis" * "Dashboard" * "DataSet" * "DataSource" * "RefreshSchedule" * "Theme" * "VPCConnection" The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported. * *(string) --* * **IncludeAllDependencies** (*boolean*) -- A Boolean that determines whether all dependencies of each resource ARN are recursively exported with the job. For example, say you provided a Dashboard ARN to the "ResourceArns" parameter. If you set "IncludeAllDependencies" to "TRUE", any theme, dataset, and data source resource that is a dependency of the dashboard is also exported. * **ExportFormat** (*string*) -- **[REQUIRED]** The export data format. * **CloudFormationOverridePropertyConfiguration** (*dict*) -- An optional collection of structures that generate CloudFormation parameters to override the existing resource property values when the resource is exported to a new CloudFormation template. Use this field if the "ExportFormat" field of a "StartAssetBundleExportJobRequest" API call is set to "CLOUDFORMATION_JSON". * **ResourceIdOverrideConfiguration** *(dict) --* An optional list of structures that control how resource IDs are parameterized in the returned CloudFormation template. * **PrefixForAllResources** *(boolean) --* An option to request a CloudFormation variable for a prefix to be prepended to each resource's ID before import. The prefix is only added to the asset IDs and does not change the name of the asset. * **VPCConnections** *(list) --* An optional list of structures that control how "VPCConnection" resources are parameterized in the returned CloudFormation template. * *(dict) --* Controls how a specific "VPCConnection" resource is parameterized in the outputted CloudFormation template. * **Arn** *(string) --* **[REQUIRED]** The ARN of the specific "VPCConnection" resource whose override properties are configured in this structure. * **Properties** *(list) --* **[REQUIRED]** A list of "VPCConnection" resource properties to generate variables for in the returned CloudFormation template. * *(string) --* * **RefreshSchedules** *(list) --* An optional list of structures that control how "RefreshSchedule" resources are parameterized in the returned CloudFormation template. * *(dict) --* Controls how a specific "RefreshSchedule" resource is parameterized in the returned CloudFormation template. * **Arn** *(string) --* **[REQUIRED]** The ARN of the specific "RefreshSchedule" resource whose override properties are configured in this structure. * **Properties** *(list) --* **[REQUIRED]** A list of "RefreshSchedule" resource properties to generate variables for in the returned CloudFormation template. * *(string) --* * **DataSources** *(list) --* An optional list of structures that control how "DataSource" resources are parameterized in the returned CloudFormation template. * *(dict) --* Controls how a specific "DataSource" resource is parameterized in the returned CloudFormation template. * **Arn** *(string) --* **[REQUIRED]** The ARN of the specific "DataSource" resource whose override properties are configured in this structure. * **Properties** *(list) --* **[REQUIRED]** A list of "DataSource" resource properties to generate variables for in the returned CloudFormation template. * *(string) --* * **DataSets** *(list) --* An optional list of structures that control how "DataSet" resources are parameterized in the returned CloudFormation template. * *(dict) --* Controls how a specific "DataSet" resource is parameterized in the returned CloudFormation template. * **Arn** *(string) --* **[REQUIRED]** The ARN of the specific "DataSet" resource whose override properties are configured in this structure. * **Properties** *(list) --* **[REQUIRED]** A list of "DataSet" resource properties to generate variables for in the returned CloudFormation template. * *(string) --* * **Themes** *(list) --* An optional list of structures that control how "Theme" resources are parameterized in the returned CloudFormation template. * *(dict) --* Controls how a specific "Theme" resource is parameterized in the returned CloudFormation template. * **Arn** *(string) --* **[REQUIRED]** The ARN of the specific "Theme" resource whose override properties are configured in this structure. * **Properties** *(list) --* **[REQUIRED]** A list of "Theme" resource properties to generate variables for in the returned CloudFormation template. * *(string) --* * **Analyses** *(list) --* An optional list of structures that control how "Analysis" resources are parameterized in the returned CloudFormation template. * *(dict) --* Controls how a specific "Analysis" resource is parameterized in the returned CloudFormation template. * **Arn** *(string) --* **[REQUIRED]** The ARN of the specific "Analysis" resource whose override properties are configured in this structure. * **Properties** *(list) --* **[REQUIRED]** A list of "Analysis" resource properties to generate variables for in the returned CloudFormation template. * *(string) --* * **Dashboards** *(list) --* An optional list of structures that control how "Dashboard" resources are parameterized in the returned CloudFormation template. * *(dict) --* Controls how a specific "Dashboard" resource is parameterized in the returned CloudFormation template. * **Arn** *(string) --* **[REQUIRED]** The ARN of the specific "Dashboard" resource whose override properties are configured in this structure. * **Properties** *(list) --* **[REQUIRED]** A list of "Dashboard" resource properties to generate variables for in the returned CloudFormation template. * *(string) --* * **Folders** *(list) --* An optional list of structures that controls how "Folder" resources are parameterized in the returned CloudFormation template. * *(dict) --* Controls how a specific "Folder" resource is parameterized in the returned CloudFormation template. * **Arn** *(string) --* **[REQUIRED]** The ARN of the specific "Folder" resource whose override properties are configured in this structure. * **Properties** *(list) --* **[REQUIRED]** A list of "Folder" resource properties to generate variables for in the returned CloudFormation template. * *(string) --* * **IncludePermissions** (*boolean*) -- A Boolean that determines whether all permissions for each resource ARN are exported with the job. If you set "IncludePermissions" to "TRUE", any permissions associated with each resource are exported. * **IncludeTags** (*boolean*) -- A Boolean that determines whether all tags for each resource ARN are exported with the job. If you set "IncludeTags" to "TRUE", any tags associated with each resource are exported. * **ValidationStrategy** (*dict*) -- An optional parameter that determines which validation strategy to use for the export job. If "StrictModeForAllResources" is set to "TRUE", strict validation for every error is enforced. If it is set to "FALSE", validation is skipped for specific UI errors that are shown as warnings. The default value for "StrictModeForAllResources" is "FALSE". * **StrictModeForAllResources** *(boolean) --* A Boolean value that indicates whether to export resources under strict or lenient mode. * **IncludeFolderMemberships** (*boolean*) -- A Boolean that determines if the exported asset carries over information about the folders that the asset is a member of. * **IncludeFolderMembers** (*string*) -- A setting that indicates whether you want to include folder assets. You can also use this setting to recusrsively include all subfolders of an exported folder. Return type: dict Returns: **Response Syntax** { 'Arn': 'string', 'AssetBundleExportJobId': 'string', 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **Arn** *(string) --* The Amazon Resource Name (ARN) for the export job. * **AssetBundleExportJobId** *(string) --* The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job. * **RequestId** *(string) --* The Amazon Web Services response ID for this operation. * **Status** *(integer) --* The HTTP status of the response. **Exceptions** * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.LimitExceededException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.ResourceNotFoundException" QuickSight / Client / update_public_sharing_settings update_public_sharing_settings ****************************** QuickSight.Client.update_public_sharing_settings(**kwargs) Use the "UpdatePublicSharingSettings" operation to turn on or turn off the public sharing settings of an Amazon QuickSight dashboard. To use this operation, turn on session capacity pricing for your Amazon QuickSight account. Before you can turn on public sharing on your account, make sure to give public sharing permissions to an administrative user in the Identity and Access Management (IAM) console. For more information on using IAM with Amazon QuickSight, see Using Amazon QuickSight with IAM in the *Amazon QuickSight User Guide*. See also: AWS API Documentation **Request Syntax** response = client.update_public_sharing_settings( AwsAccountId='string', PublicSharingEnabled=True|False ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The Amazon Web Services account ID associated with your Amazon QuickSight subscription. * **PublicSharingEnabled** (*boolean*) -- A Boolean value that indicates whether public sharing is turned on for an Amazon QuickSight account. Return type: dict Returns: **Response Syntax** { 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.UnsupportedPricingPlanException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / put_data_set_refresh_properties put_data_set_refresh_properties ******************************* QuickSight.Client.put_data_set_refresh_properties(**kwargs) Creates or updates the dataset refresh properties for the dataset. See also: AWS API Documentation **Request Syntax** response = client.put_data_set_refresh_properties( AwsAccountId='string', DataSetId='string', DataSetRefreshProperties={ 'RefreshConfiguration': { 'IncrementalRefresh': { 'LookbackWindow': { 'ColumnName': 'string', 'Size': 123, 'SizeUnit': 'HOUR'|'DAY'|'WEEK' } } }, 'FailureConfiguration': { 'EmailAlert': { 'AlertStatus': 'ENABLED'|'DISABLED' } } } ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The Amazon Web Services account ID. * **DataSetId** (*string*) -- **[REQUIRED]** The ID of the dataset. * **DataSetRefreshProperties** (*dict*) -- **[REQUIRED]** The dataset refresh properties. * **RefreshConfiguration** *(dict) --* The refresh configuration for a dataset. * **IncrementalRefresh** *(dict) --* **[REQUIRED]** The incremental refresh for the dataset. * **LookbackWindow** *(dict) --* **[REQUIRED]** The lookback window setup for an incremental refresh configuration. * **ColumnName** *(string) --* **[REQUIRED]** The name of the lookback window column. * **Size** *(integer) --* **[REQUIRED]** The lookback window column size. * **SizeUnit** *(string) --* **[REQUIRED]** The size unit that is used for the lookback window column. Valid values for this structure are "HOUR", "DAY", and "WEEK". * **FailureConfiguration** *(dict) --* The failure configuration for a dataset. * **EmailAlert** *(dict) --* The email alert configuration for a dataset refresh failure. * **AlertStatus** *(string) --* The status value that determines if email alerts are sent. Return type: dict Returns: **Response Syntax** { 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.LimitExceededException" * "QuickSight.Client.exceptions.PreconditionNotMetException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / delete_dashboard delete_dashboard **************** QuickSight.Client.delete_dashboard(**kwargs) Deletes a dashboard. See also: AWS API Documentation **Request Syntax** response = client.delete_dashboard( AwsAccountId='string', DashboardId='string', VersionNumber=123 ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the dashboard that you're deleting. * **DashboardId** (*string*) -- **[REQUIRED]** The ID for the dashboard. * **VersionNumber** (*integer*) -- The version number of the dashboard. If the version number property is provided, only the specified version of the dashboard is deleted. Return type: dict Returns: **Response Syntax** { 'Status': 123, 'Arn': 'string', 'DashboardId': 'string', 'RequestId': 'string' } **Response Structure** * *(dict) --* * **Status** *(integer) --* The HTTP status of the request. * **Arn** *(string) --* The Secure Socket Layer (SSL) properties that apply for the resource. * **DashboardId** *(string) --* The ID of the dashboard. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / update_refresh_schedule update_refresh_schedule *********************** QuickSight.Client.update_refresh_schedule(**kwargs) Updates a refresh schedule for a dataset. See also: AWS API Documentation **Request Syntax** response = client.update_refresh_schedule( DataSetId='string', AwsAccountId='string', Schedule={ 'ScheduleId': 'string', 'ScheduleFrequency': { 'Interval': 'MINUTE15'|'MINUTE30'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY', 'RefreshOnDay': { 'DayOfWeek': 'SUNDAY'|'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY', 'DayOfMonth': 'string' }, 'Timezone': 'string', 'TimeOfTheDay': 'string' }, 'StartAfterDateTime': datetime(2015, 1, 1), 'RefreshType': 'INCREMENTAL_REFRESH'|'FULL_REFRESH', 'Arn': 'string' } ) Parameters: * **DataSetId** (*string*) -- **[REQUIRED]** The ID of the dataset. * **AwsAccountId** (*string*) -- **[REQUIRED]** The Amazon Web Services account ID. * **Schedule** (*dict*) -- **[REQUIRED]** The refresh schedule. * **ScheduleId** *(string) --* **[REQUIRED]** An identifier for the refresh schedule. * **ScheduleFrequency** *(dict) --* **[REQUIRED]** The frequency for the refresh schedule. * **Interval** *(string) --* **[REQUIRED]** The interval between scheduled refreshes. Valid values are as follows: * "MINUTE15": The dataset refreshes every 15 minutes. This value is only supported for incremental refreshes. This interval can only be used for one schedule per dataset. * "MINUTE30":The dataset refreshes every 30 minutes. This value is only supported for incremental refreshes. This interval can only be used for one schedule per dataset. * "HOURLY": The dataset refreshes every hour. This interval can only be used for one schedule per dataset. * "DAILY": The dataset refreshes every day. * "WEEKLY": The dataset refreshes every week. * "MONTHLY": The dataset refreshes every month. * **RefreshOnDay** *(dict) --* The day of the week that you want to schedule the refresh on. This value is required for weekly and monthly refresh intervals. * **DayOfWeek** *(string) --* The day of the week that you want to schedule a refresh on. * **DayOfMonth** *(string) --* The day of the month that you want to schedule refresh on. * **Timezone** *(string) --* The timezone that you want the refresh schedule to use. The timezone ID must match a corresponding ID found on "java.util.time.getAvailableIDs()". * **TimeOfTheDay** *(string) --* The time of day that you want the datset to refresh. This value is expressed in HH:MM format. This field is not required for schedules that refresh hourly. * **StartAfterDateTime** *(datetime) --* Time after which the refresh schedule can be started, expressed in "YYYY-MM-DDTHH:MM:SS" format. * **RefreshType** *(string) --* **[REQUIRED]** The type of refresh that a datset undergoes. Valid values are as follows: * "FULL_REFRESH": A complete refresh of a dataset. * "INCREMENTAL_REFRESH": A partial refresh of some rows of a dataset, based on the time window specified. For more information on full and incremental refreshes, see Refreshing SPICE data in the *Amazon QuickSight User Guide*. * **Arn** *(string) --* The Amazon Resource Name (ARN) for the refresh schedule. Return type: dict Returns: **Response Syntax** { 'Status': 123, 'RequestId': 'string', 'ScheduleId': 'string', 'Arn': 'string' } **Response Structure** * *(dict) --* * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **ScheduleId** *(string) --* The ID of the refresh schedule. * **Arn** *(string) --* The Amazon Resource Name (ARN) for the refresh schedule. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.LimitExceededException" * "QuickSight.Client.exceptions.PreconditionNotMetException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / create_refresh_schedule create_refresh_schedule *********************** QuickSight.Client.create_refresh_schedule(**kwargs) Creates a refresh schedule for a dataset. You can create up to 5 different schedules for a single dataset. See also: AWS API Documentation **Request Syntax** response = client.create_refresh_schedule( DataSetId='string', AwsAccountId='string', Schedule={ 'ScheduleId': 'string', 'ScheduleFrequency': { 'Interval': 'MINUTE15'|'MINUTE30'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY', 'RefreshOnDay': { 'DayOfWeek': 'SUNDAY'|'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY', 'DayOfMonth': 'string' }, 'Timezone': 'string', 'TimeOfTheDay': 'string' }, 'StartAfterDateTime': datetime(2015, 1, 1), 'RefreshType': 'INCREMENTAL_REFRESH'|'FULL_REFRESH', 'Arn': 'string' } ) Parameters: * **DataSetId** (*string*) -- **[REQUIRED]** The ID of the dataset. * **AwsAccountId** (*string*) -- **[REQUIRED]** The Amazon Web Services account ID. * **Schedule** (*dict*) -- **[REQUIRED]** The refresh schedule. * **ScheduleId** *(string) --* **[REQUIRED]** An identifier for the refresh schedule. * **ScheduleFrequency** *(dict) --* **[REQUIRED]** The frequency for the refresh schedule. * **Interval** *(string) --* **[REQUIRED]** The interval between scheduled refreshes. Valid values are as follows: * "MINUTE15": The dataset refreshes every 15 minutes. This value is only supported for incremental refreshes. This interval can only be used for one schedule per dataset. * "MINUTE30":The dataset refreshes every 30 minutes. This value is only supported for incremental refreshes. This interval can only be used for one schedule per dataset. * "HOURLY": The dataset refreshes every hour. This interval can only be used for one schedule per dataset. * "DAILY": The dataset refreshes every day. * "WEEKLY": The dataset refreshes every week. * "MONTHLY": The dataset refreshes every month. * **RefreshOnDay** *(dict) --* The day of the week that you want to schedule the refresh on. This value is required for weekly and monthly refresh intervals. * **DayOfWeek** *(string) --* The day of the week that you want to schedule a refresh on. * **DayOfMonth** *(string) --* The day of the month that you want to schedule refresh on. * **Timezone** *(string) --* The timezone that you want the refresh schedule to use. The timezone ID must match a corresponding ID found on "java.util.time.getAvailableIDs()". * **TimeOfTheDay** *(string) --* The time of day that you want the datset to refresh. This value is expressed in HH:MM format. This field is not required for schedules that refresh hourly. * **StartAfterDateTime** *(datetime) --* Time after which the refresh schedule can be started, expressed in "YYYY-MM-DDTHH:MM:SS" format. * **RefreshType** *(string) --* **[REQUIRED]** The type of refresh that a datset undergoes. Valid values are as follows: * "FULL_REFRESH": A complete refresh of a dataset. * "INCREMENTAL_REFRESH": A partial refresh of some rows of a dataset, based on the time window specified. For more information on full and incremental refreshes, see Refreshing SPICE data in the *Amazon QuickSight User Guide*. * **Arn** *(string) --* The Amazon Resource Name (ARN) for the refresh schedule. Return type: dict Returns: **Response Syntax** { 'Status': 123, 'RequestId': 'string', 'ScheduleId': 'string', 'Arn': 'string' } **Response Structure** * *(dict) --* * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **ScheduleId** *(string) --* The ID of the refresh schedule. * **Arn** *(string) --* The Amazon Resource Name (ARN) for the refresh schedule. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.LimitExceededException" * "QuickSight.Client.exceptions.ResourceExistsException" * "QuickSight.Client.exceptions.PreconditionNotMetException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / update_iam_policy_assignment update_iam_policy_assignment **************************** QuickSight.Client.update_iam_policy_assignment(**kwargs) Updates an existing IAM policy assignment. This operation updates only the optional parameter or parameters that are specified in the request. This overwrites all of the users included in "Identities". See also: AWS API Documentation **Request Syntax** response = client.update_iam_policy_assignment( AwsAccountId='string', AssignmentName='string', Namespace='string', AssignmentStatus='ENABLED'|'DRAFT'|'DISABLED', PolicyArn='string', Identities={ 'string': [ 'string', ] } ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the IAM policy assignment. * **AssignmentName** (*string*) -- **[REQUIRED]** The name of the assignment, also called a rule. The name must be unique within the Amazon Web Services account. * **Namespace** (*string*) -- **[REQUIRED]** The namespace of the assignment. * **AssignmentStatus** (*string*) -- The status of the assignment. Possible values are as follows: * "ENABLED" - Anything specified in this assignment is used when creating the data source. * "DISABLED" - This assignment isn't used when creating the data source. * "DRAFT" - This assignment is an unfinished draft and isn't used when creating the data source. * **PolicyArn** (*string*) -- The ARN for the IAM policy to apply to the Amazon QuickSight users and groups specified in this assignment. * **Identities** (*dict*) -- The Amazon QuickSight users, groups, or both that you want to assign the policy to. * *(string) --* * *(list) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'AssignmentName': 'string', 'AssignmentId': 'string', 'PolicyArn': 'string', 'Identities': { 'string': [ 'string', ] }, 'AssignmentStatus': 'ENABLED'|'DRAFT'|'DISABLED', 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **AssignmentName** *(string) --* The name of the assignment or rule. * **AssignmentId** *(string) --* The ID of the assignment. * **PolicyArn** *(string) --* The ARN for the IAM policy applied to the Amazon QuickSight users and groups specified in this assignment. * **Identities** *(dict) --* The Amazon QuickSight users, groups, or both that the IAM policy is assigned to. * *(string) --* * *(list) --* * *(string) --* * **AssignmentStatus** *(string) --* The status of the assignment. Possible values are as follows: * "ENABLED" - Anything specified in this assignment is used when creating the data source. * "DISABLED" - This assignment isn't used when creating the data source. * "DRAFT" - This assignment is an unfinished draft and isn't used when creating the data source. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceExistsException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.ConcurrentUpdatingException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / describe_topic_refresh_schedule describe_topic_refresh_schedule ******************************* QuickSight.Client.describe_topic_refresh_schedule(**kwargs) Deletes a topic refresh schedule. See also: AWS API Documentation **Request Syntax** response = client.describe_topic_refresh_schedule( AwsAccountId='string', TopicId='string', DatasetId='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The Amazon Web Services account ID. * **TopicId** (*string*) -- **[REQUIRED]** The ID of the topic that contains the refresh schedule that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. * **DatasetId** (*string*) -- **[REQUIRED]** The ID of the dataset. Return type: dict Returns: **Response Syntax** { 'TopicId': 'string', 'TopicArn': 'string', 'DatasetArn': 'string', 'RefreshSchedule': { 'IsEnabled': True|False, 'BasedOnSpiceSchedule': True|False, 'StartingAt': datetime(2015, 1, 1), 'Timezone': 'string', 'RepeatAt': 'string', 'TopicScheduleType': 'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY' }, 'Status': 123, 'RequestId': 'string' } **Response Structure** * *(dict) --* * **TopicId** *(string) --* The ID of the topic that contains the refresh schedule that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. * **TopicArn** *(string) --* The Amazon Resource Name (ARN) of the topic. * **DatasetArn** *(string) --* The Amazon Resource Name (ARN) of the dataset. * **RefreshSchedule** *(dict) --* The definition of a refresh schedule. * **IsEnabled** *(boolean) --* A Boolean value that controls whether to schedule is enabled. * **BasedOnSpiceSchedule** *(boolean) --* A Boolean value that controls whether to schedule runs at the same schedule that is specified in SPICE dataset. * **StartingAt** *(datetime) --* The starting date and time for the refresh schedule. * **Timezone** *(string) --* The timezone that you want the refresh schedule to use. * **RepeatAt** *(string) --* The time of day when the refresh should run, for example, Monday-Sunday. * **TopicScheduleType** *(string) --* The type of refresh schedule. Valid values for this structure are "HOURLY", "DAILY", "WEEKLY", and "MONTHLY". * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.LimitExceededException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ResourceExistsException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / describe_brand describe_brand ************** QuickSight.Client.describe_brand(**kwargs) Describes a brand. See also: AWS API Documentation **Request Syntax** response = client.describe_brand( AwsAccountId='string', BrandId='string', VersionId='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that owns the brand. * **BrandId** (*string*) -- **[REQUIRED]** The ID of the Amazon QuickSight brand. * **VersionId** (*string*) -- The ID of the specific version. The default value is the latest version. Return type: dict Returns: **Response Syntax** { 'RequestId': 'string', 'BrandDetail': { 'BrandId': 'string', 'Arn': 'string', 'BrandStatus': 'CREATE_IN_PROGRESS'|'CREATE_SUCCEEDED'|'CREATE_FAILED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED', 'CreatedTime': datetime(2015, 1, 1), 'LastUpdatedTime': datetime(2015, 1, 1), 'VersionId': 'string', 'VersionStatus': 'CREATE_IN_PROGRESS'|'CREATE_SUCCEEDED'|'CREATE_FAILED', 'Errors': [ 'string', ], 'Logo': { 'AltText': 'string', 'LogoSet': { 'Primary': { 'Original': { 'Source': { 'PublicUrl': 'string', 'S3Uri': 'string' }, 'GeneratedImageUrl': 'string' }, 'Height64': { 'Source': { 'PublicUrl': 'string', 'S3Uri': 'string' }, 'GeneratedImageUrl': 'string' }, 'Height32': { 'Source': { 'PublicUrl': 'string', 'S3Uri': 'string' }, 'GeneratedImageUrl': 'string' } }, 'Favicon': { 'Original': { 'Source': { 'PublicUrl': 'string', 'S3Uri': 'string' }, 'GeneratedImageUrl': 'string' }, 'Height64': { 'Source': { 'PublicUrl': 'string', 'S3Uri': 'string' }, 'GeneratedImageUrl': 'string' }, 'Height32': { 'Source': { 'PublicUrl': 'string', 'S3Uri': 'string' }, 'GeneratedImageUrl': 'string' } } } } }, 'BrandDefinition': { 'BrandName': 'string', 'Description': 'string', 'ApplicationTheme': { 'BrandColorPalette': { 'Primary': { 'Foreground': 'string', 'Background': 'string' }, 'Secondary': { 'Foreground': 'string', 'Background': 'string' }, 'Accent': { 'Foreground': 'string', 'Background': 'string' }, 'Measure': { 'Foreground': 'string', 'Background': 'string' }, 'Dimension': { 'Foreground': 'string', 'Background': 'string' }, 'Success': { 'Foreground': 'string', 'Background': 'string' }, 'Info': { 'Foreground': 'string', 'Background': 'string' }, 'Warning': { 'Foreground': 'string', 'Background': 'string' }, 'Danger': { 'Foreground': 'string', 'Background': 'string' } }, 'BrandElementStyle': { 'NavbarStyle': { 'GlobalNavbar': { 'Foreground': 'string', 'Background': 'string' }, 'ContextualNavbar': { 'Foreground': 'string', 'Background': 'string' } } } }, 'LogoConfiguration': { 'AltText': 'string', 'LogoSet': { 'Primary': { 'Original': { 'Source': { 'PublicUrl': 'string', 'S3Uri': 'string' } } }, 'Favicon': { 'Original': { 'Source': { 'PublicUrl': 'string', 'S3Uri': 'string' } } } } } } } **Response Structure** * *(dict) --* * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **BrandDetail** *(dict) --* The details of the brand. * **BrandId** *(string) --* The ID of the Amazon QuickSight brand. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the brand. * **BrandStatus** *(string) --* The status of the brand. * **CreatedTime** *(datetime) --* The time that the brand was created. * **LastUpdatedTime** *(datetime) --* The last time the brand was updated. * **VersionId** *(string) --* The ID of the version. * **VersionStatus** *(string) --* The status of the version. * **Errors** *(list) --* A list of errors that occurred during the most recent brand operation. * *(string) --* * **Logo** *(dict) --* The logo details. * **AltText** *(string) --* The alt text for the logo. * **LogoSet** *(dict) --* A set of configured logos. * **Primary** *(dict) --* The primary logo. * **Original** *(dict) --* The original image. * **Source** *(dict) --* The source of the logo image. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "PublicUrl", "S3Uri". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **PublicUrl** *(string) --* The public URL that points to the source image. * **S3Uri** *(string) --* The Amazon S3 URI that points to the source image. * **GeneratedImageUrl** *(string) --* The URL that points to the generated logo image. * **Height64** *(dict) --* The image with the height set to 64 pixels. * **Source** *(dict) --* The source of the logo image. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "PublicUrl", "S3Uri". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **PublicUrl** *(string) --* The public URL that points to the source image. * **S3Uri** *(string) --* The Amazon S3 URI that points to the source image. * **GeneratedImageUrl** *(string) --* The URL that points to the generated logo image. * **Height32** *(dict) --* The image with the height set to 32 pixels. * **Source** *(dict) --* The source of the logo image. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "PublicUrl", "S3Uri". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **PublicUrl** *(string) --* The public URL that points to the source image. * **S3Uri** *(string) --* The Amazon S3 URI that points to the source image. * **GeneratedImageUrl** *(string) --* The URL that points to the generated logo image. * **Favicon** *(dict) --* The favicon logo. * **Original** *(dict) --* The original image. * **Source** *(dict) --* The source of the logo image. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "PublicUrl", "S3Uri". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **PublicUrl** *(string) --* The public URL that points to the source image. * **S3Uri** *(string) --* The Amazon S3 URI that points to the source image. * **GeneratedImageUrl** *(string) --* The URL that points to the generated logo image. * **Height64** *(dict) --* The image with the height set to 64 pixels. * **Source** *(dict) --* The source of the logo image. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "PublicUrl", "S3Uri". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **PublicUrl** *(string) --* The public URL that points to the source image. * **S3Uri** *(string) --* The Amazon S3 URI that points to the source image. * **GeneratedImageUrl** *(string) --* The URL that points to the generated logo image. * **Height32** *(dict) --* The image with the height set to 32 pixels. * **Source** *(dict) --* The source of the logo image. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "PublicUrl", "S3Uri". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **PublicUrl** *(string) --* The public URL that points to the source image. * **S3Uri** *(string) --* The Amazon S3 URI that points to the source image. * **GeneratedImageUrl** *(string) --* The URL that points to the generated logo image. * **BrandDefinition** *(dict) --* The definition of the brand. * **BrandName** *(string) --* The name of the brand. * **Description** *(string) --* The description of the brand. * **ApplicationTheme** *(dict) --* The application theme of the brand. * **BrandColorPalette** *(dict) --* The color palette. * **Primary** *(dict) --* The primary color. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **Secondary** *(dict) --* The secondary color. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **Accent** *(dict) --* The color that is used for accent elements. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **Measure** *(dict) --* The color that is used for measure elements. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **Dimension** *(dict) --* The color that is used for dimension elements. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **Success** *(dict) --* The color that is used for success elements. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **Info** *(dict) --* The color that is used for info elements. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **Warning** *(dict) --* The color that is used for warning elements. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **Danger** *(dict) --* The color that is used for danger elements. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **BrandElementStyle** *(dict) --* The element style. * **NavbarStyle** *(dict) --* The navigation bar style. * **GlobalNavbar** *(dict) --* The global navigation bar style. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **ContextualNavbar** *(dict) --* The contextual navigation bar style. * **Foreground** *(string) --* The foreground color. * **Background** *(string) --* The background color. * **LogoConfiguration** *(dict) --* The logo configuration of the brand. * **AltText** *(string) --* The alt text for the logo. * **LogoSet** *(dict) --* A set of configured logos. * **Primary** *(dict) --* The primary logo. * **Original** *(dict) --* The original image. * **Source** *(dict) --* The source of the image. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "PublicUrl", "S3Uri". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **PublicUrl** *(string) --* The public URL that points to the source image. * **S3Uri** *(string) --* The Amazon S3 URI that points to the source image. * **Favicon** *(dict) --* The favicon logo. * **Original** *(dict) --* The original image. * **Source** *(dict) --* The source of the image. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "PublicUrl", "S3Uri". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **PublicUrl** *(string) --* The public URL that points to the source image. * **S3Uri** *(string) --* The Amazon S3 URI that points to the source image. **Exceptions** * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InvalidRequestException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InternalServerException" QuickSight / Client / list_identity_propagation_configs list_identity_propagation_configs ********************************* QuickSight.Client.list_identity_propagation_configs(**kwargs) Lists all services and authorized targets that the Amazon QuickSight IAM Identity Center application can access. This operation is only supported for Amazon QuickSight accounts that use IAM Identity Center. See also: AWS API Documentation **Request Syntax** response = client.list_identity_propagation_configs( AwsAccountId='string', MaxResults=123, NextToken='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contain the identity propagation configurations of. * **MaxResults** (*integer*) -- The maximum number of results to be returned. * **NextToken** (*string*) -- The token for the next set of results, or null if there are no more results. Return type: dict Returns: **Response Syntax** { 'Services': [ { 'Service': 'REDSHIFT'|'QBUSINESS'|'ATHENA', 'AuthorizedTargets': [ 'string', ] }, ], 'NextToken': 'string', 'Status': 123, 'RequestId': 'string' } **Response Structure** * *(dict) --* * **Services** *(list) --* A list of services and their authorized targets that the Amazon QuickSight IAM Identity Center application can access. * *(dict) --* The authorized targets that are associated with a service. * **Service** *(string) --* The name of the Amazon Web Services service. * **AuthorizedTargets** *(list) --* Aist of authorized targets that are represented by IAM Identity Center application ARNs. * *(string) --* * **NextToken** *(string) --* The token for the next set of results, or null if there are no more results. * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / search_data_sources search_data_sources ******************* QuickSight.Client.search_data_sources(**kwargs) Use the "SearchDataSources" operation to search for data sources that belong to an account. See also: AWS API Documentation **Request Syntax** response = client.search_data_sources( AwsAccountId='string', Filters=[ { 'Operator': 'StringEquals'|'StringLike', 'Name': 'DIRECT_QUICKSIGHT_VIEWER_OR_OWNER'|'DIRECT_QUICKSIGHT_OWNER'|'DIRECT_QUICKSIGHT_SOLE_OWNER'|'DATASOURCE_NAME', 'Value': 'string' }, ], NextToken='string', MaxResults=123 ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The Amazon Web Services account ID. * **Filters** (*list*) -- **[REQUIRED]** The filters to apply to the search. * *(dict) --* A filter that you apply when searching for data sources. * **Operator** *(string) --* **[REQUIRED]** The comparison operator that you want to use as a filter, for example ""Operator": "StringEquals"". Valid values are ""StringEquals"" and ""StringLike"". If you set the operator value to ""StringEquals"", you need to provide an ownership related filter in the ""NAME"" field and the arn of the user or group whose data sources you want to search in the ""Value"" field. For example, ""Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us- east-1:1:user/default/UserName1"". If you set the value to ""StringLike"", you need to provide the name of the data sources you are searching for. For example, ""Name":"DATASOURCE_NAME", "Operator": "StringLike", "Value": "Test"". The ""StringLike"" operator only supports the "NAME" value "DATASOURCE_NAME". * **Name** *(string) --* **[REQUIRED]** The name of the value that you want to use as a filter, for example, ""Name": "DIRECT_QUICKSIGHT_OWNER"". Valid values are defined as follows: * "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER": Provide an ARN of a user or group, and any data sources with that ARN listed as one of the owners or viewers of the data sources are returned. Implicit permissions from folders or groups are not considered. * "DIRECT_QUICKSIGHT_OWNER": Provide an ARN of a user or group, and any data sources with that ARN listed as one of the owners if the data source are returned. Implicit permissions from folders or groups are not considered. * "DIRECT_QUICKSIGHT_SOLE_OWNER": Provide an ARN of a user or group, and any data sources with that ARN listed as the only owner of the data source are returned. Implicit permissions from folders or groups are not considered. * "DATASOURCE_NAME": Any data sources whose names have a substring match to the provided value are returned. * **Value** *(string) --* **[REQUIRED]** The value of the named item, for example "DIRECT_QUICKSIGHT_OWNER", that you want to use as a filter, for example, ""Value": "arn:aws:quicksight:us- east-1:1:user/default/UserName1"". * **NextToken** (*string*) -- A pagination token that can be used in a subsequent request. * **MaxResults** (*integer*) -- The maximum number of results to be returned per request. Return type: dict Returns: **Response Syntax** { 'DataSourceSummaries': [ { 'Arn': 'string', 'DataSourceId': 'string', 'Name': 'string', 'Type': 'ADOBE_ANALYTICS'|'AMAZON_ELASTICSEARCH'|'ATHENA'|'AURORA'|'AURORA_POSTGRESQL'|'AWS_IOT_ANALYTICS'|'GITHUB'|'JIRA'|'MARIADB'|'MYSQL'|'ORACLE'|'POSTGRESQL'|'PRESTO'|'REDSHIFT'|'S3'|'SALESFORCE'|'SERVICENOW'|'SNOWFLAKE'|'SPARK'|'SQLSERVER'|'TERADATA'|'TWITTER'|'TIMESTREAM'|'AMAZON_OPENSEARCH'|'EXASOL'|'DATABRICKS'|'STARBURST'|'TRINO'|'BIGQUERY', 'CreatedTime': datetime(2015, 1, 1), 'LastUpdatedTime': datetime(2015, 1, 1) }, ], 'NextToken': 'string', 'Status': 123, 'RequestId': 'string' } **Response Structure** * *(dict) --* * **DataSourceSummaries** *(list) --* A "DataSourceSummaries" object that returns a summary of a data source. * *(dict) --* A "DataSourceSummary" object that returns a summary of a data source. * **Arn** *(string) --* The arn of the datasource. * **DataSourceId** *(string) --* The unique ID of the data source. * **Name** *(string) --* The name of the data source. * **Type** *(string) --* The type of the data source. * **CreatedTime** *(datetime) --* The date and time that the data source was created. This value is expressed in MM-DD-YYYY HH:MM:SS format. * **LastUpdatedTime** *(datetime) --* The date and time the data source was last updated. This value is expressed in MM-DD-YYYY HH:MM:SS format. * **NextToken** *(string) --* A pagination token that can be used in a subsequent request. * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidNextTokenException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / describe_ip_restriction describe_ip_restriction *********************** QuickSight.Client.describe_ip_restriction(**kwargs) Provides a summary and status of IP rules. See also: AWS API Documentation **Request Syntax** response = client.describe_ip_restriction( AwsAccountId='string' ) Parameters: **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the IP rules. Return type: dict Returns: **Response Syntax** { 'AwsAccountId': 'string', 'IpRestrictionRuleMap': { 'string': 'string' }, 'VpcIdRestrictionRuleMap': { 'string': 'string' }, 'VpcEndpointIdRestrictionRuleMap': { 'string': 'string' }, 'Enabled': True|False, 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **AwsAccountId** *(string) --* The ID of the Amazon Web Services account that contains the IP rules. * **IpRestrictionRuleMap** *(dict) --* A map that describes the IP rules with CIDR range and description. * *(string) --* * *(string) --* * **VpcIdRestrictionRuleMap** *(dict) --* A map of allowed VPC IDs and their rule descriptions. * *(string) --* * *(string) --* * **VpcEndpointIdRestrictionRuleMap** *(dict) --* A map of allowed VPC endpoint IDs and their rule descriptions. * *(string) --* * *(string) --* * **Enabled** *(boolean) --* A value that specifies whether IP rules are turned on. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / describe_asset_bundle_import_job describe_asset_bundle_import_job ******************************** QuickSight.Client.describe_asset_bundle_import_job(**kwargs) Describes an existing import job. Poll job descriptions after starting a job to know when it has succeeded or failed. Job descriptions are available for 14 days after job starts. See also: AWS API Documentation **Request Syntax** response = client.describe_asset_bundle_import_job( AwsAccountId='string', AssetBundleImportJobId='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account the import job was executed in. * **AssetBundleImportJobId** (*string*) -- **[REQUIRED]** The ID of the job. The job ID is set when you start a new job with a "StartAssetBundleImportJob" API call. Return type: dict Returns: **Response Syntax** { 'JobStatus': 'QUEUED_FOR_IMMEDIATE_EXECUTION'|'IN_PROGRESS'|'SUCCESSFUL'|'FAILED'|'FAILED_ROLLBACK_IN_PROGRESS'|'FAILED_ROLLBACK_COMPLETED'|'FAILED_ROLLBACK_ERROR', 'Errors': [ { 'Arn': 'string', 'Type': 'string', 'Message': 'string' }, ], 'RollbackErrors': [ { 'Arn': 'string', 'Type': 'string', 'Message': 'string' }, ], 'Arn': 'string', 'CreatedTime': datetime(2015, 1, 1), 'AssetBundleImportJobId': 'string', 'AwsAccountId': 'string', 'AssetBundleImportSource': { 'Body': 'string', 'S3Uri': 'string' }, 'OverrideParameters': { 'ResourceIdOverrideConfiguration': { 'PrefixForAllResources': 'string' }, 'VPCConnections': [ { 'VPCConnectionId': 'string', 'Name': 'string', 'SubnetIds': [ 'string', ], 'SecurityGroupIds': [ 'string', ], 'DnsResolvers': [ 'string', ], 'RoleArn': 'string' }, ], 'RefreshSchedules': [ { 'DataSetId': 'string', 'ScheduleId': 'string', 'StartAfterDateTime': datetime(2015, 1, 1) }, ], 'DataSources': [ { 'DataSourceId': 'string', 'Name': 'string', 'DataSourceParameters': { 'AmazonElasticsearchParameters': { 'Domain': 'string' }, 'AthenaParameters': { 'WorkGroup': 'string', 'RoleArn': 'string', 'IdentityCenterConfiguration': { 'EnableIdentityPropagation': True|False } }, 'AuroraParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'AuroraPostgreSqlParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'AwsIotAnalyticsParameters': { 'DataSetName': 'string' }, 'JiraParameters': { 'SiteBaseUrl': 'string' }, 'MariaDbParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'MySqlParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'OracleParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string', 'UseServiceName': True|False }, 'PostgreSqlParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'PrestoParameters': { 'Host': 'string', 'Port': 123, 'Catalog': 'string' }, 'RdsParameters': { 'InstanceId': 'string', 'Database': 'string' }, 'RedshiftParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string', 'ClusterId': 'string', 'IAMParameters': { 'RoleArn': 'string', 'DatabaseUser': 'string', 'DatabaseGroups': [ 'string', ], 'AutoCreateDatabaseUser': True|False }, 'IdentityCenterConfiguration': { 'EnableIdentityPropagation': True|False } }, 'S3Parameters': { 'ManifestFileLocation': { 'Bucket': 'string', 'Key': 'string' }, 'RoleArn': 'string' }, 'ServiceNowParameters': { 'SiteBaseUrl': 'string' }, 'SnowflakeParameters': { 'Host': 'string', 'Database': 'string', 'Warehouse': 'string', 'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509', 'DatabaseAccessControlRole': 'string', 'OAuthParameters': { 'TokenProviderUrl': 'string', 'OAuthScope': 'string', 'IdentityProviderVpcConnectionProperties': { 'VpcConnectionArn': 'string' }, 'IdentityProviderResourceUri': 'string' } }, 'SparkParameters': { 'Host': 'string', 'Port': 123 }, 'SqlServerParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'TeradataParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'TwitterParameters': { 'Query': 'string', 'MaxRows': 123 }, 'AmazonOpenSearchParameters': { 'Domain': 'string' }, 'ExasolParameters': { 'Host': 'string', 'Port': 123 }, 'DatabricksParameters': { 'Host': 'string', 'Port': 123, 'SqlEndpointPath': 'string' }, 'StarburstParameters': { 'Host': 'string', 'Port': 123, 'Catalog': 'string', 'ProductType': 'GALAXY'|'ENTERPRISE', 'DatabaseAccessControlRole': 'string', 'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509', 'OAuthParameters': { 'TokenProviderUrl': 'string', 'OAuthScope': 'string', 'IdentityProviderVpcConnectionProperties': { 'VpcConnectionArn': 'string' }, 'IdentityProviderResourceUri': 'string' } }, 'TrinoParameters': { 'Host': 'string', 'Port': 123, 'Catalog': 'string' }, 'BigQueryParameters': { 'ProjectId': 'string', 'DataSetRegion': 'string' }, 'ImpalaParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string', 'SqlEndpointPath': 'string' } }, 'VpcConnectionProperties': { 'VpcConnectionArn': 'string' }, 'SslProperties': { 'DisableSsl': True|False }, 'Credentials': { 'CredentialPair': { 'Username': 'string', 'Password': 'string' }, 'SecretArn': 'string' } }, ], 'DataSets': [ { 'DataSetId': 'string', 'Name': 'string', 'DataSetRefreshProperties': { 'RefreshConfiguration': { 'IncrementalRefresh': { 'LookbackWindow': { 'ColumnName': 'string', 'Size': 123, 'SizeUnit': 'HOUR'|'DAY'|'WEEK' } } }, 'FailureConfiguration': { 'EmailAlert': { 'AlertStatus': 'ENABLED'|'DISABLED' } } } }, ], 'Themes': [ { 'ThemeId': 'string', 'Name': 'string' }, ], 'Analyses': [ { 'AnalysisId': 'string', 'Name': 'string' }, ], 'Dashboards': [ { 'DashboardId': 'string', 'Name': 'string' }, ], 'Folders': [ { 'FolderId': 'string', 'Name': 'string', 'ParentFolderArn': 'string' }, ] }, 'FailureAction': 'DO_NOTHING'|'ROLLBACK', 'RequestId': 'string', 'Status': 123, 'OverridePermissions': { 'DataSources': [ { 'DataSourceIds': [ 'string', ], 'Permissions': { 'Principals': [ 'string', ], 'Actions': [ 'string', ] } }, ], 'DataSets': [ { 'DataSetIds': [ 'string', ], 'Permissions': { 'Principals': [ 'string', ], 'Actions': [ 'string', ] } }, ], 'Themes': [ { 'ThemeIds': [ 'string', ], 'Permissions': { 'Principals': [ 'string', ], 'Actions': [ 'string', ] } }, ], 'Analyses': [ { 'AnalysisIds': [ 'string', ], 'Permissions': { 'Principals': [ 'string', ], 'Actions': [ 'string', ] } }, ], 'Dashboards': [ { 'DashboardIds': [ 'string', ], 'Permissions': { 'Principals': [ 'string', ], 'Actions': [ 'string', ] }, 'LinkSharingConfiguration': { 'Permissions': { 'Principals': [ 'string', ], 'Actions': [ 'string', ] } } }, ], 'Folders': [ { 'FolderIds': [ 'string', ], 'Permissions': { 'Principals': [ 'string', ], 'Actions': [ 'string', ] } }, ] }, 'OverrideTags': { 'VPCConnections': [ { 'VPCConnectionIds': [ 'string', ], 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], 'DataSources': [ { 'DataSourceIds': [ 'string', ], 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], 'DataSets': [ { 'DataSetIds': [ 'string', ], 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], 'Themes': [ { 'ThemeIds': [ 'string', ], 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], 'Analyses': [ { 'AnalysisIds': [ 'string', ], 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], 'Dashboards': [ { 'DashboardIds': [ 'string', ], 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], 'Folders': [ { 'FolderIds': [ 'string', ], 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ] }, 'OverrideValidationStrategy': { 'StrictModeForAllResources': True|False }, 'Warnings': [ { 'Arn': 'string', 'Message': 'string' }, ] } **Response Structure** * *(dict) --* * **JobStatus** *(string) --* Indicates the status of a job through its queuing and execution. Poll the "DescribeAssetBundleImport" API until "JobStatus" returns one of the following values: * "SUCCESSFUL" * "FAILED" * "FAILED_ROLLBACK_COMPLETED" * "FAILED_ROLLBACK_ERROR" * **Errors** *(list) --* An array of error records that describes any failures that occurred during the export job processing. Error records accumulate while the job is still running. The complete set of error records is available after the job has completed and failed. * *(dict) --* Describes an error that occurred within an Asset Bundle import execution. * **Arn** *(string) --* The ARN of the resource whose processing caused an error. * **Type** *(string) --* The specific error type or the error that occurred. * **Message** *(string) --* A description of the error. * **RollbackErrors** *(list) --* An array of error records that describes any failures that occurred while an import job was attempting a rollback. Error records accumulate while the job is still running. The complete set of error records is available after the job has completed and failed. * *(dict) --* Describes an error that occurred within an Asset Bundle import execution. * **Arn** *(string) --* The ARN of the resource whose processing caused an error. * **Type** *(string) --* The specific error type or the error that occurred. * **Message** *(string) --* A description of the error. * **Arn** *(string) --* The Amazon Resource Name (ARN) for the import job. * **CreatedTime** *(datetime) --* The time that the import job was created. * **AssetBundleImportJobId** *(string) --* The ID of the job. The job ID is set when you start a new job with a "StartAssetBundleImportJob" API call. * **AwsAccountId** *(string) --* The ID of the Amazon Web Services account the import job was executed in. * **AssetBundleImportSource** *(dict) --* The source of the asset bundle zip file that contains the data that is imported by the job. * **Body** *(string) --* An HTTPS download URL for the provided asset bundle that you optionally provided at the start of the import job. This URL is valid for five minutes after issuance. Call "DescribeAssetBundleExportJob" again for a fresh URL if needed. The downloaded asset bundle is a ".qs" zip file. * **S3Uri** *(string) --* The Amazon S3 URI that you provided at the start of the import job. * **OverrideParameters** *(dict) --* Optional overrides that are applied to the resource configuration before import. * **ResourceIdOverrideConfiguration** *(dict) --* An optional structure that configures resource ID overrides to be applied within the import job. * **PrefixForAllResources** *(string) --* An option to request a CloudFormation variable for a prefix to be prepended to each resource's ID before import. The prefix is only added to the asset IDs and does not change the name of the asset. * **VPCConnections** *(list) --* A list of overrides for any "VPCConnection" resources that are present in the asset bundle that is imported. * *(dict) --* The override parameters for a single VPC connection that is imported. * **VPCConnectionId** *(string) --* The ID of the VPC Connection to apply overrides to. * **Name** *(string) --* A new name for the VPC connection. * **SubnetIds** *(list) --* A list of new subnet IDs for the VPC connection you are importing. This field is required if you are importing the VPC connection from another Amazon Web Services account or Region. * *(string) --* * **SecurityGroupIds** *(list) --* A new security group ID for the VPC connection you are importing. This field is required if you are importing the VPC connection from another Amazon Web Services account or Region. * *(string) --* * **DnsResolvers** *(list) --* An optional override of DNS resolvers to be used by the VPC connection. * *(string) --* * **RoleArn** *(string) --* An optional override of the role ARN to be used by the VPC connection. * **RefreshSchedules** *(list) --* A list of overrides for any "RefreshSchedule" resources that are present in the asset bundle that is imported. * *(dict) --* A list of overrides for a specific "RefreshsSchedule" resource that is present in the asset bundle that is imported. * **DataSetId** *(string) --* A partial identifier for the specific "RefreshSchedule" resource that is being overridden. This structure is used together with the "ScheduleID" structure. * **ScheduleId** *(string) --* A partial identifier for the specific "RefreshSchedule" resource being overridden. This structure is used together with the "DataSetId" structure. * **StartAfterDateTime** *(datetime) --* An override for the "StartAfterDateTime" of a "RefreshSchedule". Make sure that the "StartAfterDateTime" is set to a time that takes place in the future. * **DataSources** *(list) --* A list of overrides for any "DataSource" resources that are present in the asset bundle that is imported. * *(dict) --* The override parameters for a single data source that is being imported. * **DataSourceId** *(string) --* The ID of the data source to apply overrides to. * **Name** *(string) --* A new name for the data source. * **DataSourceParameters** *(dict) --* The parameters that Amazon QuickSight uses to connect to your underlying data source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null. * **AmazonElasticsearchParameters** *(dict) --* The parameters for OpenSearch. * **Domain** *(string) --* The OpenSearch domain. * **AthenaParameters** *(dict) --* The parameters for Amazon Athena. * **WorkGroup** *(string) --* The workgroup that Amazon Athena uses. * **RoleArn** *(string) --* Use the "RoleArn" structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account- wide role. The administrator can then use "RoleArn" to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active. * **IdentityCenterConfiguration** *(dict) --* An optional parameter that configures IAM Identity Center authentication to grant Amazon QuickSight access to your workgroup. This parameter can only be specified if your Amazon QuickSight account is configured with IAM Identity Center. * **EnableIdentityPropagation** *(boolean) --* A Boolean option that controls whether Trusted Identity Propagation should be used. * **AuroraParameters** *(dict) --* The parameters for Amazon Aurora MySQL. * **Host** *(string) --* Host. * **Port** *(integer) --* Port. * **Database** *(string) --* Database. * **AuroraPostgreSqlParameters** *(dict) --* The parameters for Amazon Aurora. * **Host** *(string) --* The Amazon Aurora PostgreSQL-Compatible host to connect to. * **Port** *(integer) --* The port that Amazon Aurora PostgreSQL is listening on. * **Database** *(string) --* The Amazon Aurora PostgreSQL database to connect to. * **AwsIotAnalyticsParameters** *(dict) --* The parameters for IoT Analytics. * **DataSetName** *(string) --* Dataset name. * **JiraParameters** *(dict) --* The parameters for Jira. * **SiteBaseUrl** *(string) --* The base URL of the Jira site. * **MariaDbParameters** *(dict) --* The parameters for MariaDB. * **Host** *(string) --* Host. * **Port** *(integer) --* Port. * **Database** *(string) --* Database. * **MySqlParameters** *(dict) --* The parameters for MySQL. * **Host** *(string) --* Host. * **Port** *(integer) --* Port. * **Database** *(string) --* Database. * **OracleParameters** *(dict) --* The parameters for Oracle. * **Host** *(string) --* An Oracle host. * **Port** *(integer) --* The port. * **Database** *(string) --* The database. * **UseServiceName** *(boolean) --* A Boolean value that indicates whether the "Database" uses a service name or an SID. If this value is left blank, the default value is "SID". If this value is set to "false", the value is "SID". * **PostgreSqlParameters** *(dict) --* The parameters for PostgreSQL. * **Host** *(string) --* Host. * **Port** *(integer) --* Port. * **Database** *(string) --* Database. * **PrestoParameters** *(dict) --* The parameters for Presto. * **Host** *(string) --* Host. * **Port** *(integer) --* Port. * **Catalog** *(string) --* Catalog. * **RdsParameters** *(dict) --* The parameters for Amazon RDS. * **InstanceId** *(string) --* Instance ID. * **Database** *(string) --* Database. * **RedshiftParameters** *(dict) --* The parameters for Amazon Redshift. * **Host** *(string) --* Host. This field can be blank if "ClusterId" is provided. * **Port** *(integer) --* Port. This field can be blank if the "ClusterId" is provided. * **Database** *(string) --* Database. * **ClusterId** *(string) --* Cluster ID. This field can be blank if the "Host" and "Port" are provided. * **IAMParameters** *(dict) --* An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials. * **RoleArn** *(string) --* Use the "RoleArn" structure to allow Amazon QuickSight to call "redshift:GetClusterCredentials" on your cluster. The calling principal must have "iam:PassRole" access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role. * **DatabaseUser** *(string) --* The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of "AutoCreateDatabaseUser" to "True" to create a new user with PUBLIC permissions. * **DatabaseGroups** *(list) --* A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the "DatabaseUser". If you choose to include this parameter, the "RoleArn" must grant access to "redshift:JoinGroup". * *(string) --* * **AutoCreateDatabaseUser** *(boolean) --* Automatically creates a database user. If your database doesn't have a "DatabaseUser", set this parameter to "True". If there is no "DatabaseUser", Amazon QuickSight can't connect to your cluster. The "RoleArn" that you use for this operation must grant access to "redshift:CreateClusterUser" to successfully create the user. * **IdentityCenterConfiguration** *(dict) --* An optional parameter that configures IAM Identity Center authentication to grant Amazon QuickSight access to your cluster. This parameter can only be specified if your Amazon QuickSight account is configured with IAM Identity Center. * **EnableIdentityPropagation** *(boolean) --* A Boolean option that controls whether Trusted Identity Propagation should be used. * **S3Parameters** *(dict) --* The parameters for S3. * **ManifestFileLocation** *(dict) --* Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight. * **Bucket** *(string) --* Amazon S3 bucket. * **Key** *(string) --* Amazon S3 key that identifies an object. * **RoleArn** *(string) --* Use the "RoleArn" structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use "RoleArn" to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active. * **ServiceNowParameters** *(dict) --* The parameters for ServiceNow. * **SiteBaseUrl** *(string) --* URL of the base site. * **SnowflakeParameters** *(dict) --* The parameters for Snowflake. * **Host** *(string) --* Host. * **Database** *(string) --* Database. * **Warehouse** *(string) --* Warehouse. * **AuthenticationType** *(string) --* The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types. * **DatabaseAccessControlRole** *(string) --* The database access control role. * **OAuthParameters** *(dict) --* An object that contains information needed to create a data source connection between an Amazon QuickSight account and Snowflake. * **TokenProviderUrl** *(string) --* The token endpoint URL of the identity provider. * **OAuthScope** *(string) --* The OAuth scope. * **IdentityProviderVpcConnectionProperties** *(dict) --* VPC connection properties. * **VpcConnectionArn** *(string) --* The Amazon Resource Name (ARN) for the VPC connection. * **IdentityProviderResourceUri** *(string) --* The resource uri of the identity provider. * **SparkParameters** *(dict) --* The parameters for Spark. * **Host** *(string) --* Host. * **Port** *(integer) --* Port. * **SqlServerParameters** *(dict) --* The parameters for SQL Server. * **Host** *(string) --* Host. * **Port** *(integer) --* Port. * **Database** *(string) --* Database. * **TeradataParameters** *(dict) --* The parameters for Teradata. * **Host** *(string) --* Host. * **Port** *(integer) --* Port. * **Database** *(string) --* Database. * **TwitterParameters** *(dict) --* The parameters for Twitter. * **Query** *(string) --* Twitter query string. * **MaxRows** *(integer) --* Maximum number of rows to query Twitter. * **AmazonOpenSearchParameters** *(dict) --* The parameters for OpenSearch. * **Domain** *(string) --* The OpenSearch domain. * **ExasolParameters** *(dict) --* The parameters for Exasol. * **Host** *(string) --* The hostname or IP address of the Exasol data source. * **Port** *(integer) --* The port for the Exasol data source. * **DatabricksParameters** *(dict) --* The parameters that are required to connect to a Databricks data source. * **Host** *(string) --* The host name of the Databricks data source. * **Port** *(integer) --* The port for the Databricks data source. * **SqlEndpointPath** *(string) --* The HTTP path of the Databricks data source. * **StarburstParameters** *(dict) --* The parameters that are required to connect to a Starburst data source. * **Host** *(string) --* The host name of the Starburst data source. * **Port** *(integer) --* The port for the Starburst data source. * **Catalog** *(string) --* The catalog name for the Starburst data source. * **ProductType** *(string) --* The product type for the Starburst data source. * **DatabaseAccessControlRole** *(string) --* The database access control role. * **AuthenticationType** *(string) --* The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types. * **OAuthParameters** *(dict) --* An object that contains information needed to create a data source connection between an Amazon QuickSight account and Starburst. * **TokenProviderUrl** *(string) --* The token endpoint URL of the identity provider. * **OAuthScope** *(string) --* The OAuth scope. * **IdentityProviderVpcConnectionProperties** *(dict) --* VPC connection properties. * **VpcConnectionArn** *(string) --* The Amazon Resource Name (ARN) for the VPC connection. * **IdentityProviderResourceUri** *(string) --* The resource uri of the identity provider. * **TrinoParameters** *(dict) --* The parameters that are required to connect to a Trino data source. * **Host** *(string) --* The host name of the Trino data source. * **Port** *(integer) --* The port for the Trino data source. * **Catalog** *(string) --* The catalog name for the Trino data source. * **BigQueryParameters** *(dict) --* The parameters that are required to connect to a Google BigQuery data source. * **ProjectId** *(string) --* The Google Cloud Platform project ID where your datasource was created. * **DataSetRegion** *(string) --* The storage location where you create a Google BigQuery data source. * **ImpalaParameters** *(dict) --* The parameters for Impala. * **Host** *(string) --* The host name of the Impala data source. * **Port** *(integer) --* The port of the Impala data source. * **Database** *(string) --* The database of the Impala data source. * **SqlEndpointPath** *(string) --* The HTTP path of the Impala data source. * **VpcConnectionProperties** *(dict) --* VPC connection properties. * **VpcConnectionArn** *(string) --* The Amazon Resource Name (ARN) for the VPC connection. * **SslProperties** *(dict) --* Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying data source. * **DisableSsl** *(boolean) --* A Boolean option to control whether SSL should be disabled. * **Credentials** *(dict) --* An optional structure that provides the credentials to be used to create the imported data source. * **CredentialPair** *(dict) --* A username and password credential pair to be used to create the imported data source. Keep this field blank if you are using a Secrets Manager secret to provide credentials. * **Username** *(string) --* The username for the data source connection. * **Password** *(string) --* The password for the data source connection. * **SecretArn** *(string) --* The ARN of the Secrets Manager secret that's used to create the imported data source. Keep this field blank, unless you are using a secret in place of a credential pair. * **DataSets** *(list) --* A list of overrides for any "DataSet" resources that are present in the asset bundle that is imported. * *(dict) --* The override parameters for a single dataset that is being imported. * **DataSetId** *(string) --* The ID of the dataset to apply overrides to. * **Name** *(string) --* A new name for the dataset. * **DataSetRefreshProperties** *(dict) --* The refresh properties of a dataset. * **RefreshConfiguration** *(dict) --* The refresh configuration for a dataset. * **IncrementalRefresh** *(dict) --* The incremental refresh for the dataset. * **LookbackWindow** *(dict) --* The lookback window setup for an incremental refresh configuration. * **ColumnName** *(string) --* The name of the lookback window column. * **Size** *(integer) --* The lookback window column size. * **SizeUnit** *(string) --* The size unit that is used for the lookback window column. Valid values for this structure are "HOUR", "DAY", and "WEEK". * **FailureConfiguration** *(dict) --* The failure configuration for a dataset. * **EmailAlert** *(dict) --* The email alert configuration for a dataset refresh failure. * **AlertStatus** *(string) --* The status value that determines if email alerts are sent. * **Themes** *(list) --* A list of overrides for any "Theme" resources that are present in the asset bundle that is imported. * *(dict) --* The override parameters for a single theme that is imported. * **ThemeId** *(string) --* The ID of the theme to apply overrides to. * **Name** *(string) --* A new name for the theme. * **Analyses** *(list) --* A list of overrides for any "Analysis" resources that are present in the asset bundle that is imported. * *(dict) --* The override parameters for a single analysis that is being imported. * **AnalysisId** *(string) --* The ID of the analysis that you ant to apply overrides to. * **Name** *(string) --* A new name for the analysis. * **Dashboards** *(list) --* A list of overrides for any "Dashboard" resources that are present in the asset bundle that is imported. * *(dict) --* The override parameters for a single dashboard that is being imported. * **DashboardId** *(string) --* The ID of the dashboard that you want to apply overrides to. * **Name** *(string) --* A new name for the dashboard. * **Folders** *(list) --* A list of overrides for any "Folder" resources that are present in the asset bundle that is imported. * *(dict) --* The override parameters for a single folder that is being imported. * **FolderId** *(string) --* The ID of the folder that you want to apply overrides to. * **Name** *(string) --* A new name for the folder. * **ParentFolderArn** *(string) --* A new parent folder arn. This change can only be applied if the import creates a brand new folder. Existing folders cannot be moved. * **FailureAction** *(string) --* The failure action for the import job. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the response. * **OverridePermissions** *(dict) --* Optional permission overrides that are applied to the resource configuration before import. * **DataSources** *(list) --* A list of permissions overrides for any "DataSource" resources that are present in the asset bundle that is imported. * *(dict) --* An object that contains a list of permissions to be applied to a list of data source IDs. * **DataSourceIds** *(list) --* A list of data source IDs that you want to apply overrides to. You can use "*" to override all data sources in this asset bundle. * *(string) --* * **Permissions** *(dict) --* A list of permissions for the data source that you want to apply overrides to. * **Principals** *(list) --* A list of principals to grant permissions on. * *(string) --* * **Actions** *(list) --* A list of IAM actions to grant permissions on. * *(string) --* * **DataSets** *(list) --* A list of permissions overrides for any "DataSet" resources that are present in the asset bundle that is imported. * *(dict) --* An object that contains a list of permissions to be applied to a list of dataset IDs. * **DataSetIds** *(list) --* A list of dataset IDs that you want to apply overrides to. You can use "*" to override all datasets in this asset bundle. * *(string) --* * **Permissions** *(dict) --* A list of permissions for the datasets that you want to apply overrides to. * **Principals** *(list) --* A list of principals to grant permissions on. * *(string) --* * **Actions** *(list) --* A list of IAM actions to grant permissions on. * *(string) --* * **Themes** *(list) --* A list of permissions overrides for any "Theme" resources that are present in the asset bundle that is imported. * *(dict) --* An object that contains a list of permissions to be applied to a list of theme IDs. * **ThemeIds** *(list) --* A list of theme IDs that you want to apply overrides to. You can use "*" to override all themes in this asset bundle. * *(string) --* * **Permissions** *(dict) --* A list of permissions for the themes that you want to apply overrides to. * **Principals** *(list) --* A list of principals to grant permissions on. * *(string) --* * **Actions** *(list) --* A list of IAM actions to grant permissions on. * *(string) --* * **Analyses** *(list) --* A list of permissions overrides for any "Analysis" resources that are present in the asset bundle that is imported. * *(dict) --* An object that contains a list of permissions to be applied to a list of analysis IDs. * **AnalysisIds** *(list) --* A list of analysis IDs that you want to apply overrides to. You can use "*" to override all analyses in this asset bundle. * *(string) --* * **Permissions** *(dict) --* A list of permissions for the analyses that you want to apply overrides to. * **Principals** *(list) --* A list of principals to grant permissions on. * *(string) --* * **Actions** *(list) --* A list of IAM actions to grant permissions on. * *(string) --* * **Dashboards** *(list) --* A list of permissions overrides for any "Dashboard" resources that are present in the asset bundle that is imported. * *(dict) --* An object that contains a list of permissions to be applied to a list of dashboard IDs. * **DashboardIds** *(list) --* A list of dashboard IDs that you want to apply overrides to. You can use "*" to override all dashboards in this asset bundle. * *(string) --* * **Permissions** *(dict) --* A list of permissions for the dashboards that you want to apply overrides to. * **Principals** *(list) --* A list of principals to grant permissions on. * *(string) --* * **Actions** *(list) --* A list of IAM actions to grant permissions on. * *(string) --* * **LinkSharingConfiguration** *(dict) --* A structure that contains the link sharing configurations that you want to apply overrides to. * **Permissions** *(dict) --* A list of link sharing permissions for the dashboards that you want to apply overrides to. * **Principals** *(list) --* A list of principals to grant permissions on. * *(string) --* * **Actions** *(list) --* A list of IAM actions to grant permissions on. * *(string) --* * **Folders** *(list) --* A list of permissions for the folders that you want to apply overrides to. * *(dict) --* An object that contains a list of permissions to be applied to a list of folder IDs. * **FolderIds** *(list) --* A list of folder IDs that you want to apply overrides to. You can use "*" to override all folders in this asset bundle. * *(string) --* * **Permissions** *(dict) --* A structure that contains the permissions for the resource that you want to override in an asset bundle import job. * **Principals** *(list) --* A list of principals to grant permissions on. * *(string) --* * **Actions** *(list) --* A list of IAM actions to grant permissions on. * *(string) --* * **OverrideTags** *(dict) --* Optional tag overrides that are applied to the resource configuration before import. * **VPCConnections** *(list) --* A list of tag overrides for any "VPCConnection" resources that are present in the asset bundle that is imported. * *(dict) --* An object that contains a list of tags to be assigned to a list of VPC connection IDs. * **VPCConnectionIds** *(list) --* A list of VPC connection IDs that you want to apply overrides to. You can use "*" to override all VPC connections in this asset bundle. * *(string) --* * **Tags** *(list) --* A list of tags for the VPC connections that you want to apply overrides to. * *(dict) --* The key or keys of the key-value pairs for the resource tag or tags assigned to the resource. * **Key** *(string) --* Tag key. * **Value** *(string) --* Tag value. * **DataSources** *(list) --* A list of tag overrides for any "DataSource" resources that are present in the asset bundle that is imported. * *(dict) --* An object that contains a list of tags to be assigned to a list of data source IDs. * **DataSourceIds** *(list) --* A list of data source IDs that you want to apply overrides to. You can use "*" to override all data sources in this asset bundle. * *(string) --* * **Tags** *(list) --* A list of tags for the data source that you want to apply overrides to. * *(dict) --* The key or keys of the key-value pairs for the resource tag or tags assigned to the resource. * **Key** *(string) --* Tag key. * **Value** *(string) --* Tag value. * **DataSets** *(list) --* A list of tag overrides for any "DataSet" resources that are present in the asset bundle that is imported. * *(dict) --* An object that contains a list of tags to be assigned to a list of dataset IDs. * **DataSetIds** *(list) --* A list of dataset IDs that you want to apply overrides to. You can use "*" to override all datasets in this asset bundle. * *(string) --* * **Tags** *(list) --* A list of tags for the datasets that you want to apply overrides to. * *(dict) --* The key or keys of the key-value pairs for the resource tag or tags assigned to the resource. * **Key** *(string) --* Tag key. * **Value** *(string) --* Tag value. * **Themes** *(list) --* A list of tag overrides for any "Theme" resources that are present in the asset bundle that is imported. * *(dict) --* An object that contains a list of tags to be assigned to a list of theme IDs. * **ThemeIds** *(list) --* A list of theme IDs that you want to apply overrides to. You can use "*" to override all themes in this asset bundle. * *(string) --* * **Tags** *(list) --* A list of tags for the themes that you want to apply overrides to. * *(dict) --* The key or keys of the key-value pairs for the resource tag or tags assigned to the resource. * **Key** *(string) --* Tag key. * **Value** *(string) --* Tag value. * **Analyses** *(list) --* A list of tag overrides for any "Analysis" resources that are present in the asset bundle that is imported. * *(dict) --* An object that contains a list of tags to be assigned to a list of analysis IDs. * **AnalysisIds** *(list) --* A list of analysis IDs that you want to apply overrides to. You can use "*" to override all analyses in this asset bundle. * *(string) --* * **Tags** *(list) --* A list of tags for the analyses that you want to apply overrides to. * *(dict) --* The key or keys of the key-value pairs for the resource tag or tags assigned to the resource. * **Key** *(string) --* Tag key. * **Value** *(string) --* Tag value. * **Dashboards** *(list) --* A list of tag overrides for any "Dashboard" resources that are present in the asset bundle that is imported. * *(dict) --* An object that contains a list of tags to be assigned to a list of dashboard IDs. * **DashboardIds** *(list) --* A list of dashboard IDs that you want to apply overrides to. You can use "*" to override all dashboards in this asset bundle. * *(string) --* * **Tags** *(list) --* A list of tags for the dashboards that you want to apply overrides to. * *(dict) --* The key or keys of the key-value pairs for the resource tag or tags assigned to the resource. * **Key** *(string) --* Tag key. * **Value** *(string) --* Tag value. * **Folders** *(list) --* A list of tag overrides for any "Folder" resources that are present in the asset bundle that is imported. * *(dict) --* An object that contains a list of tags to be assigned to a list of folder IDs. * **FolderIds** *(list) --* A list of folder IDs that you want to apply overrides to. You can use "*" to override all folders in this asset bundle. * *(string) --* * **Tags** *(list) --* A list of tags for the folders that you want to apply overrides to. * *(dict) --* The key or keys of the key-value pairs for the resource tag or tags assigned to the resource. * **Key** *(string) --* Tag key. * **Value** *(string) --* Tag value. * **OverrideValidationStrategy** *(dict) --* An optional validation strategy override for all analyses and dashboards to be applied to the resource configuration before import. * **StrictModeForAllResources** *(boolean) --* A Boolean value that indicates whether to import all analyses and dashboards under strict or lenient mode. * **Warnings** *(list) --* An array of warning records that describe all permitted errors that are encountered during the import job. * *(dict) --* Describes a warning that occurred during an Asset Bundle import job. * **Arn** *(string) --* The ARN of the resource that the warning occurred for. * **Message** *(string) --* A description of the warning that occurred during an Asset Bundle import job. **Exceptions** * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.ResourceNotFoundException" QuickSight / Client / describe_folder_resolved_permissions describe_folder_resolved_permissions ************************************ QuickSight.Client.describe_folder_resolved_permissions(**kwargs) Describes the folder resolved permissions. Permissions consists of both folder direct permissions and the inherited permissions from the ancestor folders. See also: AWS API Documentation **Request Syntax** response = client.describe_folder_resolved_permissions( AwsAccountId='string', FolderId='string', Namespace='string', MaxResults=123, NextToken='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID for the Amazon Web Services account that contains the folder. * **FolderId** (*string*) -- **[REQUIRED]** The ID of the folder. * **Namespace** (*string*) -- The namespace of the folder whose permissions you want described. * **MaxResults** (*integer*) -- The maximum number of results to be returned per request. * **NextToken** (*string*) -- A pagination token for the next set of results. Return type: dict Returns: **Response Syntax** { 'Status': 123, 'FolderId': 'string', 'Arn': 'string', 'Permissions': [ { 'Principal': 'string', 'Actions': [ 'string', ] }, ], 'RequestId': 'string', 'NextToken': 'string' } **Response Structure** * *(dict) --* * **Status** *(integer) --* The HTTP status of the request. * **FolderId** *(string) --* The ID of the folder. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the folder. * **Permissions** *(list) --* Information about the permissions for the folder. * *(dict) --* Permission for the resource. * **Principal** *(string) --* The Amazon Resource Name (ARN) of the principal. This can be one of the following: * The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.) * The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.) * The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.) * **Actions** *(list) --* The IAM action to grant or revoke permissions on. * *(string) --* * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **NextToken** *(string) --* A pagination token for the next set of results, or null if there are no more results. **Exceptions** * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InvalidNextTokenException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / describe_topic_refresh describe_topic_refresh ********************** QuickSight.Client.describe_topic_refresh(**kwargs) Describes the status of a topic refresh. See also: AWS API Documentation **Request Syntax** response = client.describe_topic_refresh( AwsAccountId='string', TopicId='string', RefreshId='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the topic whose refresh you want to describe. * **TopicId** (*string*) -- **[REQUIRED]** The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. * **RefreshId** (*string*) -- **[REQUIRED]** The ID of the refresh, which is performed when the topic is created or updated. Return type: dict Returns: **Response Syntax** { 'RefreshDetails': { 'RefreshArn': 'string', 'RefreshId': 'string', 'RefreshStatus': 'INITIALIZED'|'RUNNING'|'FAILED'|'COMPLETED'|'CANCELLED' }, 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **RefreshDetails** *(dict) --* Details of the refresh, which is performed when the topic is created or updated. * **RefreshArn** *(string) --* The Amazon Resource Name (ARN) of the topic refresh. * **RefreshId** *(string) --* The ID of the refresh, which occurs as a result of topic creation or topic update. * **RefreshStatus** *(string) --* The status of the refresh job that indicates whether the job is still running, completed successfully, or failed. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / list_asset_bundle_export_jobs list_asset_bundle_export_jobs ***************************** QuickSight.Client.list_asset_bundle_export_jobs(**kwargs) Lists all asset bundle export jobs that have been taken place in the last 14 days. Jobs created more than 14 days ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs, "ListAssetBundleExportJobs" only returns the most recent job that uses the repeated job ID. See also: AWS API Documentation **Request Syntax** response = client.list_asset_bundle_export_jobs( AwsAccountId='string', NextToken='string', MaxResults=123 ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that the export jobs were executed in. * **NextToken** (*string*) -- The token for the next set of results, or null if there are no more results. * **MaxResults** (*integer*) -- The maximum number of results to be returned per request. Return type: dict Returns: **Response Syntax** { 'AssetBundleExportJobSummaryList': [ { 'JobStatus': 'QUEUED_FOR_IMMEDIATE_EXECUTION'|'IN_PROGRESS'|'SUCCESSFUL'|'FAILED', 'Arn': 'string', 'CreatedTime': datetime(2015, 1, 1), 'AssetBundleExportJobId': 'string', 'IncludeAllDependencies': True|False, 'ExportFormat': 'CLOUDFORMATION_JSON'|'QUICKSIGHT_JSON', 'IncludePermissions': True|False, 'IncludeTags': True|False }, ], 'NextToken': 'string', 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **AssetBundleExportJobSummaryList** *(list) --* A list of export job summaries. * *(dict) --* A summary of the export job that includes details of the job's configuration and its current status. * **JobStatus** *(string) --* The current status of the export job. * **Arn** *(string) --* The ARN of the export job. * **CreatedTime** *(datetime) --* The time that the export job was created. * **AssetBundleExportJobId** *(string) --* The ID of the export job. * **IncludeAllDependencies** *(boolean) --* The flag that determines the inclusion of resource dependencies in the returned asset bundle. * **ExportFormat** *(string) --* The format for the export job. * **IncludePermissions** *(boolean) --* The flag that determines the inclusion of permissions associated with each resource ARN. * **IncludeTags** *(boolean) --* The flag that determines the inclusion of tags associated with each resource ARN. * **NextToken** *(string) --* The token for the next set of results, or null if there are no more results. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidNextTokenException" * "QuickSight.Client.exceptions.ResourceNotFoundException" QuickSight / Client / delete_brand delete_brand ************ QuickSight.Client.delete_brand(**kwargs) Deletes an Amazon QuickSight brand. See also: AWS API Documentation **Request Syntax** response = client.delete_brand( AwsAccountId='string', BrandId='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that owns the brand. * **BrandId** (*string*) -- **[REQUIRED]** The ID of the Amazon QuickSight brand. Return type: dict Returns: **Response Syntax** { 'RequestId': 'string' } **Response Structure** * *(dict) --* * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InvalidRequestException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InternalServerException" QuickSight / Client / describe_theme_alias describe_theme_alias ******************** QuickSight.Client.describe_theme_alias(**kwargs) Describes the alias for a theme. See also: AWS API Documentation **Request Syntax** response = client.describe_theme_alias( AwsAccountId='string', ThemeId='string', AliasName='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the theme alias that you're describing. * **ThemeId** (*string*) -- **[REQUIRED]** The ID for the theme. * **AliasName** (*string*) -- **[REQUIRED]** The name of the theme alias that you want to describe. Return type: dict Returns: **Response Syntax** { 'ThemeAlias': { 'Arn': 'string', 'AliasName': 'string', 'ThemeVersionNumber': 123 }, 'Status': 123, 'RequestId': 'string' } **Response Structure** * *(dict) --* * **ThemeAlias** *(dict) --* Information about the theme alias. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the theme alias. * **AliasName** *(string) --* The display name of the theme alias. * **ThemeVersionNumber** *(integer) --* The version number of the theme alias. * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / batch_create_topic_reviewed_answer batch_create_topic_reviewed_answer ********************************** QuickSight.Client.batch_create_topic_reviewed_answer(**kwargs) Creates new reviewed answers for a Q Topic. See also: AWS API Documentation **Request Syntax** response = client.batch_create_topic_reviewed_answer( AwsAccountId='string', TopicId='string', Answers=[ { 'AnswerId': 'string', 'DatasetArn': 'string', 'Question': 'string', 'Mir': { 'Metrics': [ { 'MetricId': { 'Identity': 'string' }, 'Function': { 'Aggregation': 'SUM'|'MIN'|'MAX'|'COUNT'|'AVERAGE'|'DISTINCT_COUNT'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE'|'MEDIAN'|'PTD_SUM'|'PTD_MIN'|'PTD_MAX'|'PTD_COUNT'|'PTD_DISTINCT_COUNT'|'PTD_AVERAGE'|'COLUMN'|'CUSTOM', 'AggregationFunctionParameters': { 'string': 'string' }, 'Period': 'SECOND'|'MINUTE'|'HOUR'|'DAY'|'WEEK'|'MONTH'|'QUARTER'|'YEAR', 'PeriodField': 'string' }, 'Operands': [ { 'Identity': 'string' }, ], 'ComparisonMethod': { 'Type': 'DIFF'|'PERC_DIFF'|'DIFF_AS_PERC'|'POP_CURRENT_DIFF_AS_PERC'|'POP_CURRENT_DIFF'|'POP_OVERTIME_DIFF_AS_PERC'|'POP_OVERTIME_DIFF'|'PERCENT_OF_TOTAL'|'RUNNING_SUM'|'MOVING_AVERAGE', 'Period': 'SECOND'|'MINUTE'|'HOUR'|'DAY'|'WEEK'|'MONTH'|'QUARTER'|'YEAR', 'WindowSize': 123 }, 'Expression': 'string', 'CalculatedFieldReferences': [ { 'Identity': 'string' }, ], 'DisplayFormat': 'AUTO'|'PERCENT'|'CURRENCY'|'NUMBER'|'DATE'|'STRING', 'DisplayFormatOptions': { 'UseBlankCellFormat': True|False, 'BlankCellFormat': 'string', 'DateFormat': 'string', 'DecimalSeparator': 'COMMA'|'DOT', 'GroupingSeparator': 'string', 'UseGrouping': True|False, 'FractionDigits': 123, 'Prefix': 'string', 'Suffix': 'string', 'UnitScaler': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS'|'LAKHS'|'CRORES', 'NegativeFormat': { 'Prefix': 'string', 'Suffix': 'string' }, 'CurrencySymbol': 'string' }, 'NamedEntity': { 'NamedEntityName': 'string' } }, ], 'GroupByList': [ { 'FieldName': { 'Identity': 'string' }, 'TimeGranularity': 'SECOND'|'MINUTE'|'HOUR'|'DAY'|'WEEK'|'MONTH'|'QUARTER'|'YEAR', 'Sort': { 'Operand': { 'Identity': 'string' }, 'SortDirection': 'ASCENDING'|'DESCENDING' }, 'DisplayFormat': 'AUTO'|'PERCENT'|'CURRENCY'|'NUMBER'|'DATE'|'STRING', 'DisplayFormatOptions': { 'UseBlankCellFormat': True|False, 'BlankCellFormat': 'string', 'DateFormat': 'string', 'DecimalSeparator': 'COMMA'|'DOT', 'GroupingSeparator': 'string', 'UseGrouping': True|False, 'FractionDigits': 123, 'Prefix': 'string', 'Suffix': 'string', 'UnitScaler': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS'|'LAKHS'|'CRORES', 'NegativeFormat': { 'Prefix': 'string', 'Suffix': 'string' }, 'CurrencySymbol': 'string' }, 'NamedEntity': { 'NamedEntityName': 'string' } }, ], 'Filters': [ [ { 'FilterType': 'CATEGORY_FILTER'|'NUMERIC_EQUALITY_FILTER'|'NUMERIC_RANGE_FILTER'|'DATE_RANGE_FILTER'|'RELATIVE_DATE_FILTER'|'TOP_BOTTOM_FILTER'|'EQUALS'|'RANK_LIMIT_FILTER'|'ACCEPT_ALL_FILTER', 'FilterClass': 'ENFORCED_VALUE_FILTER'|'CONDITIONAL_VALUE_FILTER'|'NAMED_VALUE_FILTER', 'OperandField': { 'Identity': 'string' }, 'Function': 'CONTAINS'|'EXACT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS_STRING'|'PREVIOUS'|'THIS'|'LAST'|'NEXT'|'NOW', 'Constant': { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string', 'Minimum': 'string', 'Maximum': 'string', 'ValueList': [ { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string' }, ] }, 'Inverse': True|False, 'NullFilter': 'ALL_VALUES'|'NON_NULLS_ONLY'|'NULLS_ONLY', 'Aggregation': 'SUM'|'MIN'|'MAX'|'COUNT'|'AVERAGE'|'DISTINCT_COUNT'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE'|'MEDIAN'|'PTD_SUM'|'PTD_MIN'|'PTD_MAX'|'PTD_COUNT'|'PTD_DISTINCT_COUNT'|'PTD_AVERAGE'|'COLUMN'|'CUSTOM', 'AggregationFunctionParameters': { 'string': 'string' }, 'AggregationPartitionBy': [ { 'FieldName': 'string', 'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND' }, ], 'Range': { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string', 'Minimum': 'string', 'Maximum': 'string', 'ValueList': [ { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string' }, ] }, 'Inclusive': True|False, 'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND', 'LastNextOffset': { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string', 'Minimum': 'string', 'Maximum': 'string', 'ValueList': [ { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string' }, ] }, 'AggMetrics': [ { 'MetricOperand': { 'Identity': 'string' }, 'Function': 'SUM'|'MIN'|'MAX'|'COUNT'|'AVERAGE'|'DISTINCT_COUNT'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE'|'MEDIAN'|'PTD_SUM'|'PTD_MIN'|'PTD_MAX'|'PTD_COUNT'|'PTD_DISTINCT_COUNT'|'PTD_AVERAGE'|'COLUMN'|'CUSTOM', 'SortDirection': 'ASCENDING'|'DESCENDING' }, ], 'TopBottomLimit': { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string', 'Minimum': 'string', 'Maximum': 'string', 'ValueList': [ { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string' }, ] }, 'SortDirection': 'ASCENDING'|'DESCENDING', 'Anchor': { 'AnchorType': 'TODAY', 'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND', 'Offset': 123 } }, ], ], 'Sort': { 'Operand': { 'Identity': 'string' }, 'SortDirection': 'ASCENDING'|'DESCENDING' }, 'ContributionAnalysis': { 'Factors': [ { 'FieldName': 'string' }, ], 'TimeRanges': { 'StartRange': { 'FilterType': 'CATEGORY_FILTER'|'NUMERIC_EQUALITY_FILTER'|'NUMERIC_RANGE_FILTER'|'DATE_RANGE_FILTER'|'RELATIVE_DATE_FILTER'|'TOP_BOTTOM_FILTER'|'EQUALS'|'RANK_LIMIT_FILTER'|'ACCEPT_ALL_FILTER', 'FilterClass': 'ENFORCED_VALUE_FILTER'|'CONDITIONAL_VALUE_FILTER'|'NAMED_VALUE_FILTER', 'OperandField': { 'Identity': 'string' }, 'Function': 'CONTAINS'|'EXACT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS_STRING'|'PREVIOUS'|'THIS'|'LAST'|'NEXT'|'NOW', 'Constant': { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string', 'Minimum': 'string', 'Maximum': 'string', 'ValueList': [ { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string' }, ] }, 'Inverse': True|False, 'NullFilter': 'ALL_VALUES'|'NON_NULLS_ONLY'|'NULLS_ONLY', 'Aggregation': 'SUM'|'MIN'|'MAX'|'COUNT'|'AVERAGE'|'DISTINCT_COUNT'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE'|'MEDIAN'|'PTD_SUM'|'PTD_MIN'|'PTD_MAX'|'PTD_COUNT'|'PTD_DISTINCT_COUNT'|'PTD_AVERAGE'|'COLUMN'|'CUSTOM', 'AggregationFunctionParameters': { 'string': 'string' }, 'AggregationPartitionBy': [ { 'FieldName': 'string', 'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND' }, ], 'Range': { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string', 'Minimum': 'string', 'Maximum': 'string', 'ValueList': [ { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string' }, ] }, 'Inclusive': True|False, 'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND', 'LastNextOffset': { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string', 'Minimum': 'string', 'Maximum': 'string', 'ValueList': [ { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string' }, ] }, 'AggMetrics': [ { 'MetricOperand': { 'Identity': 'string' }, 'Function': 'SUM'|'MIN'|'MAX'|'COUNT'|'AVERAGE'|'DISTINCT_COUNT'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE'|'MEDIAN'|'PTD_SUM'|'PTD_MIN'|'PTD_MAX'|'PTD_COUNT'|'PTD_DISTINCT_COUNT'|'PTD_AVERAGE'|'COLUMN'|'CUSTOM', 'SortDirection': 'ASCENDING'|'DESCENDING' }, ], 'TopBottomLimit': { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string', 'Minimum': 'string', 'Maximum': 'string', 'ValueList': [ { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string' }, ] }, 'SortDirection': 'ASCENDING'|'DESCENDING', 'Anchor': { 'AnchorType': 'TODAY', 'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND', 'Offset': 123 } }, 'EndRange': { 'FilterType': 'CATEGORY_FILTER'|'NUMERIC_EQUALITY_FILTER'|'NUMERIC_RANGE_FILTER'|'DATE_RANGE_FILTER'|'RELATIVE_DATE_FILTER'|'TOP_BOTTOM_FILTER'|'EQUALS'|'RANK_LIMIT_FILTER'|'ACCEPT_ALL_FILTER', 'FilterClass': 'ENFORCED_VALUE_FILTER'|'CONDITIONAL_VALUE_FILTER'|'NAMED_VALUE_FILTER', 'OperandField': { 'Identity': 'string' }, 'Function': 'CONTAINS'|'EXACT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS_STRING'|'PREVIOUS'|'THIS'|'LAST'|'NEXT'|'NOW', 'Constant': { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string', 'Minimum': 'string', 'Maximum': 'string', 'ValueList': [ { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string' }, ] }, 'Inverse': True|False, 'NullFilter': 'ALL_VALUES'|'NON_NULLS_ONLY'|'NULLS_ONLY', 'Aggregation': 'SUM'|'MIN'|'MAX'|'COUNT'|'AVERAGE'|'DISTINCT_COUNT'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE'|'MEDIAN'|'PTD_SUM'|'PTD_MIN'|'PTD_MAX'|'PTD_COUNT'|'PTD_DISTINCT_COUNT'|'PTD_AVERAGE'|'COLUMN'|'CUSTOM', 'AggregationFunctionParameters': { 'string': 'string' }, 'AggregationPartitionBy': [ { 'FieldName': 'string', 'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND' }, ], 'Range': { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string', 'Minimum': 'string', 'Maximum': 'string', 'ValueList': [ { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string' }, ] }, 'Inclusive': True|False, 'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND', 'LastNextOffset': { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string', 'Minimum': 'string', 'Maximum': 'string', 'ValueList': [ { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string' }, ] }, 'AggMetrics': [ { 'MetricOperand': { 'Identity': 'string' }, 'Function': 'SUM'|'MIN'|'MAX'|'COUNT'|'AVERAGE'|'DISTINCT_COUNT'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE'|'MEDIAN'|'PTD_SUM'|'PTD_MIN'|'PTD_MAX'|'PTD_COUNT'|'PTD_DISTINCT_COUNT'|'PTD_AVERAGE'|'COLUMN'|'CUSTOM', 'SortDirection': 'ASCENDING'|'DESCENDING' }, ], 'TopBottomLimit': { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string', 'Minimum': 'string', 'Maximum': 'string', 'ValueList': [ { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string' }, ] }, 'SortDirection': 'ASCENDING'|'DESCENDING', 'Anchor': { 'AnchorType': 'TODAY', 'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND', 'Offset': 123 } } }, 'Direction': 'INCREASE'|'DECREASE'|'NEUTRAL', 'SortType': 'ABSOLUTE_DIFFERENCE'|'CONTRIBUTION_PERCENTAGE'|'DEVIATION_FROM_EXPECTED'|'PERCENTAGE_DIFFERENCE' }, 'Visual': { 'type': 'string' } }, 'PrimaryVisual': { 'VisualId': 'string', 'Role': 'PRIMARY'|'COMPLIMENTARY'|'MULTI_INTENT'|'FALLBACK'|'FRAGMENT', 'Ir': { 'Metrics': [ { 'MetricId': { 'Identity': 'string' }, 'Function': { 'Aggregation': 'SUM'|'MIN'|'MAX'|'COUNT'|'AVERAGE'|'DISTINCT_COUNT'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE'|'MEDIAN'|'PTD_SUM'|'PTD_MIN'|'PTD_MAX'|'PTD_COUNT'|'PTD_DISTINCT_COUNT'|'PTD_AVERAGE'|'COLUMN'|'CUSTOM', 'AggregationFunctionParameters': { 'string': 'string' }, 'Period': 'SECOND'|'MINUTE'|'HOUR'|'DAY'|'WEEK'|'MONTH'|'QUARTER'|'YEAR', 'PeriodField': 'string' }, 'Operands': [ { 'Identity': 'string' }, ], 'ComparisonMethod': { 'Type': 'DIFF'|'PERC_DIFF'|'DIFF_AS_PERC'|'POP_CURRENT_DIFF_AS_PERC'|'POP_CURRENT_DIFF'|'POP_OVERTIME_DIFF_AS_PERC'|'POP_OVERTIME_DIFF'|'PERCENT_OF_TOTAL'|'RUNNING_SUM'|'MOVING_AVERAGE', 'Period': 'SECOND'|'MINUTE'|'HOUR'|'DAY'|'WEEK'|'MONTH'|'QUARTER'|'YEAR', 'WindowSize': 123 }, 'Expression': 'string', 'CalculatedFieldReferences': [ { 'Identity': 'string' }, ], 'DisplayFormat': 'AUTO'|'PERCENT'|'CURRENCY'|'NUMBER'|'DATE'|'STRING', 'DisplayFormatOptions': { 'UseBlankCellFormat': True|False, 'BlankCellFormat': 'string', 'DateFormat': 'string', 'DecimalSeparator': 'COMMA'|'DOT', 'GroupingSeparator': 'string', 'UseGrouping': True|False, 'FractionDigits': 123, 'Prefix': 'string', 'Suffix': 'string', 'UnitScaler': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS'|'LAKHS'|'CRORES', 'NegativeFormat': { 'Prefix': 'string', 'Suffix': 'string' }, 'CurrencySymbol': 'string' }, 'NamedEntity': { 'NamedEntityName': 'string' } }, ], 'GroupByList': [ { 'FieldName': { 'Identity': 'string' }, 'TimeGranularity': 'SECOND'|'MINUTE'|'HOUR'|'DAY'|'WEEK'|'MONTH'|'QUARTER'|'YEAR', 'Sort': { 'Operand': { 'Identity': 'string' }, 'SortDirection': 'ASCENDING'|'DESCENDING' }, 'DisplayFormat': 'AUTO'|'PERCENT'|'CURRENCY'|'NUMBER'|'DATE'|'STRING', 'DisplayFormatOptions': { 'UseBlankCellFormat': True|False, 'BlankCellFormat': 'string', 'DateFormat': 'string', 'DecimalSeparator': 'COMMA'|'DOT', 'GroupingSeparator': 'string', 'UseGrouping': True|False, 'FractionDigits': 123, 'Prefix': 'string', 'Suffix': 'string', 'UnitScaler': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS'|'LAKHS'|'CRORES', 'NegativeFormat': { 'Prefix': 'string', 'Suffix': 'string' }, 'CurrencySymbol': 'string' }, 'NamedEntity': { 'NamedEntityName': 'string' } }, ], 'Filters': [ [ { 'FilterType': 'CATEGORY_FILTER'|'NUMERIC_EQUALITY_FILTER'|'NUMERIC_RANGE_FILTER'|'DATE_RANGE_FILTER'|'RELATIVE_DATE_FILTER'|'TOP_BOTTOM_FILTER'|'EQUALS'|'RANK_LIMIT_FILTER'|'ACCEPT_ALL_FILTER', 'FilterClass': 'ENFORCED_VALUE_FILTER'|'CONDITIONAL_VALUE_FILTER'|'NAMED_VALUE_FILTER', 'OperandField': { 'Identity': 'string' }, 'Function': 'CONTAINS'|'EXACT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS_STRING'|'PREVIOUS'|'THIS'|'LAST'|'NEXT'|'NOW', 'Constant': { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string', 'Minimum': 'string', 'Maximum': 'string', 'ValueList': [ { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string' }, ] }, 'Inverse': True|False, 'NullFilter': 'ALL_VALUES'|'NON_NULLS_ONLY'|'NULLS_ONLY', 'Aggregation': 'SUM'|'MIN'|'MAX'|'COUNT'|'AVERAGE'|'DISTINCT_COUNT'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE'|'MEDIAN'|'PTD_SUM'|'PTD_MIN'|'PTD_MAX'|'PTD_COUNT'|'PTD_DISTINCT_COUNT'|'PTD_AVERAGE'|'COLUMN'|'CUSTOM', 'AggregationFunctionParameters': { 'string': 'string' }, 'AggregationPartitionBy': [ { 'FieldName': 'string', 'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND' }, ], 'Range': { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string', 'Minimum': 'string', 'Maximum': 'string', 'ValueList': [ { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string' }, ] }, 'Inclusive': True|False, 'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND', 'LastNextOffset': { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string', 'Minimum': 'string', 'Maximum': 'string', 'ValueList': [ { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string' }, ] }, 'AggMetrics': [ { 'MetricOperand': { 'Identity': 'string' }, 'Function': 'SUM'|'MIN'|'MAX'|'COUNT'|'AVERAGE'|'DISTINCT_COUNT'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE'|'MEDIAN'|'PTD_SUM'|'PTD_MIN'|'PTD_MAX'|'PTD_COUNT'|'PTD_DISTINCT_COUNT'|'PTD_AVERAGE'|'COLUMN'|'CUSTOM', 'SortDirection': 'ASCENDING'|'DESCENDING' }, ], 'TopBottomLimit': { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string', 'Minimum': 'string', 'Maximum': 'string', 'ValueList': [ { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string' }, ] }, 'SortDirection': 'ASCENDING'|'DESCENDING', 'Anchor': { 'AnchorType': 'TODAY', 'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND', 'Offset': 123 } }, ], ], 'Sort': { 'Operand': { 'Identity': 'string' }, 'SortDirection': 'ASCENDING'|'DESCENDING' }, 'ContributionAnalysis': { 'Factors': [ { 'FieldName': 'string' }, ], 'TimeRanges': { 'StartRange': { 'FilterType': 'CATEGORY_FILTER'|'NUMERIC_EQUALITY_FILTER'|'NUMERIC_RANGE_FILTER'|'DATE_RANGE_FILTER'|'RELATIVE_DATE_FILTER'|'TOP_BOTTOM_FILTER'|'EQUALS'|'RANK_LIMIT_FILTER'|'ACCEPT_ALL_FILTER', 'FilterClass': 'ENFORCED_VALUE_FILTER'|'CONDITIONAL_VALUE_FILTER'|'NAMED_VALUE_FILTER', 'OperandField': { 'Identity': 'string' }, 'Function': 'CONTAINS'|'EXACT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS_STRING'|'PREVIOUS'|'THIS'|'LAST'|'NEXT'|'NOW', 'Constant': { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string', 'Minimum': 'string', 'Maximum': 'string', 'ValueList': [ { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string' }, ] }, 'Inverse': True|False, 'NullFilter': 'ALL_VALUES'|'NON_NULLS_ONLY'|'NULLS_ONLY', 'Aggregation': 'SUM'|'MIN'|'MAX'|'COUNT'|'AVERAGE'|'DISTINCT_COUNT'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE'|'MEDIAN'|'PTD_SUM'|'PTD_MIN'|'PTD_MAX'|'PTD_COUNT'|'PTD_DISTINCT_COUNT'|'PTD_AVERAGE'|'COLUMN'|'CUSTOM', 'AggregationFunctionParameters': { 'string': 'string' }, 'AggregationPartitionBy': [ { 'FieldName': 'string', 'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND' }, ], 'Range': { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string', 'Minimum': 'string', 'Maximum': 'string', 'ValueList': [ { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string' }, ] }, 'Inclusive': True|False, 'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND', 'LastNextOffset': { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string', 'Minimum': 'string', 'Maximum': 'string', 'ValueList': [ { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string' }, ] }, 'AggMetrics': [ { 'MetricOperand': { 'Identity': 'string' }, 'Function': 'SUM'|'MIN'|'MAX'|'COUNT'|'AVERAGE'|'DISTINCT_COUNT'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE'|'MEDIAN'|'PTD_SUM'|'PTD_MIN'|'PTD_MAX'|'PTD_COUNT'|'PTD_DISTINCT_COUNT'|'PTD_AVERAGE'|'COLUMN'|'CUSTOM', 'SortDirection': 'ASCENDING'|'DESCENDING' }, ], 'TopBottomLimit': { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string', 'Minimum': 'string', 'Maximum': 'string', 'ValueList': [ { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string' }, ] }, 'SortDirection': 'ASCENDING'|'DESCENDING', 'Anchor': { 'AnchorType': 'TODAY', 'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND', 'Offset': 123 } }, 'EndRange': { 'FilterType': 'CATEGORY_FILTER'|'NUMERIC_EQUALITY_FILTER'|'NUMERIC_RANGE_FILTER'|'DATE_RANGE_FILTER'|'RELATIVE_DATE_FILTER'|'TOP_BOTTOM_FILTER'|'EQUALS'|'RANK_LIMIT_FILTER'|'ACCEPT_ALL_FILTER', 'FilterClass': 'ENFORCED_VALUE_FILTER'|'CONDITIONAL_VALUE_FILTER'|'NAMED_VALUE_FILTER', 'OperandField': { 'Identity': 'string' }, 'Function': 'CONTAINS'|'EXACT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS_STRING'|'PREVIOUS'|'THIS'|'LAST'|'NEXT'|'NOW', 'Constant': { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string', 'Minimum': 'string', 'Maximum': 'string', 'ValueList': [ { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string' }, ] }, 'Inverse': True|False, 'NullFilter': 'ALL_VALUES'|'NON_NULLS_ONLY'|'NULLS_ONLY', 'Aggregation': 'SUM'|'MIN'|'MAX'|'COUNT'|'AVERAGE'|'DISTINCT_COUNT'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE'|'MEDIAN'|'PTD_SUM'|'PTD_MIN'|'PTD_MAX'|'PTD_COUNT'|'PTD_DISTINCT_COUNT'|'PTD_AVERAGE'|'COLUMN'|'CUSTOM', 'AggregationFunctionParameters': { 'string': 'string' }, 'AggregationPartitionBy': [ { 'FieldName': 'string', 'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND' }, ], 'Range': { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string', 'Minimum': 'string', 'Maximum': 'string', 'ValueList': [ { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string' }, ] }, 'Inclusive': True|False, 'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND', 'LastNextOffset': { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string', 'Minimum': 'string', 'Maximum': 'string', 'ValueList': [ { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string' }, ] }, 'AggMetrics': [ { 'MetricOperand': { 'Identity': 'string' }, 'Function': 'SUM'|'MIN'|'MAX'|'COUNT'|'AVERAGE'|'DISTINCT_COUNT'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE'|'MEDIAN'|'PTD_SUM'|'PTD_MIN'|'PTD_MAX'|'PTD_COUNT'|'PTD_DISTINCT_COUNT'|'PTD_AVERAGE'|'COLUMN'|'CUSTOM', 'SortDirection': 'ASCENDING'|'DESCENDING' }, ], 'TopBottomLimit': { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string', 'Minimum': 'string', 'Maximum': 'string', 'ValueList': [ { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string' }, ] }, 'SortDirection': 'ASCENDING'|'DESCENDING', 'Anchor': { 'AnchorType': 'TODAY', 'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND', 'Offset': 123 } } }, 'Direction': 'INCREASE'|'DECREASE'|'NEUTRAL', 'SortType': 'ABSOLUTE_DIFFERENCE'|'CONTRIBUTION_PERCENTAGE'|'DEVIATION_FROM_EXPECTED'|'PERCENTAGE_DIFFERENCE' }, 'Visual': { 'type': 'string' } }, 'SupportingVisuals': [ {'... recursive ...'}, ] }, 'Template': { 'TemplateType': 'string', 'Slots': [ { 'SlotId': 'string', 'VisualId': 'string' }, ] } }, ] ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that you want to create a reviewed answer in. * **TopicId** (*string*) -- **[REQUIRED]** The ID for the topic reviewed answer that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. * **Answers** (*list*) -- **[REQUIRED]** The definition of the Answers to be created. * *(dict) --* The definition for a "CreateTopicReviewedAnswer". * **AnswerId** *(string) --* **[REQUIRED]** The answer ID for the "CreateTopicReviewedAnswer". * **DatasetArn** *(string) --* **[REQUIRED]** The Dataset arn for the "CreateTopicReviewedAnswer". * **Question** *(string) --* **[REQUIRED]** The Question to be created. * **Mir** *(dict) --* The Mir for the "CreateTopicReviewedAnswer". * **Metrics** *(list) --* The metrics for the "TopicIR". * *(dict) --* The definition for a "TopicIRMetric". * **MetricId** *(dict) --* The metric ID for the "TopicIRMetric". * **Identity** *(string) --* **[REQUIRED]** The identity of the identifier. * **Function** *(dict) --* The function for the "TopicIRMetric". * **Aggregation** *(string) --* The aggregation of an Agg function. * **AggregationFunctionParameters** *(dict) --* The aggregation parameters for an Agg function. * *(string) --* * *(string) --* * **Period** *(string) --* The period of an Agg function. * **PeriodField** *(string) --* The period field for an Agg function. * **Operands** *(list) --* The operands for the "TopicIRMetric". * *(dict) --* The definition for the identifier. * **Identity** *(string) --* **[REQUIRED]** The identity of the identifier. * **ComparisonMethod** *(dict) --* The comparison method for the "TopicIRMetric". * **Type** *(string) --* The type for the "TopicIRComparisonMethod". * **Period** *(string) --* The period for the "TopicIRComparisonMethod". * **WindowSize** *(integer) --* The window size for the "TopicIRComparisonMethod". * **Expression** *(string) --* The expression for the "TopicIRMetric". * **CalculatedFieldReferences** *(list) --* The calculated field references for the "TopicIRMetric". * *(dict) --* The definition for the identifier. * **Identity** *(string) --* **[REQUIRED]** The identity of the identifier. * **DisplayFormat** *(string) --* The display format for the "TopicIRMetric". * **DisplayFormatOptions** *(dict) --* A structure that represents additional options for display formatting. * **UseBlankCellFormat** *(boolean) --* A Boolean value that indicates whether to use blank cell format. * **BlankCellFormat** *(string) --* Determines the blank cell format. * **DateFormat** *(string) --* Determines the "DateTime" format. * **DecimalSeparator** *(string) --* Determines the decimal separator. * **GroupingSeparator** *(string) --* Determines the grouping separator. * **UseGrouping** *(boolean) --* A Boolean value that indicates whether to use grouping. * **FractionDigits** *(integer) --* Determines the number of fraction digits. * **Prefix** *(string) --* The prefix value for a display format. * **Suffix** *(string) --* The suffix value for a display format. * **UnitScaler** *(string) --* The unit scaler. Valid values for this structure are: "NONE", "AUTO", "THOUSANDS", "MILLIONS", "BILLIONS", and "TRILLIONS". * **NegativeFormat** *(dict) --* The negative format. * **Prefix** *(string) --* The prefix for a negative format. * **Suffix** *(string) --* The suffix for a negative format. * **CurrencySymbol** *(string) --* The currency symbol, such as "USD". * **NamedEntity** *(dict) --* The named entity for the "TopicIRMetric". * **NamedEntityName** *(string) --* The "NamedEntityName" for the "NamedEntityRef". * **GroupByList** *(list) --* The GroupBy list for the "TopicIR". * *(dict) --* The definition for a "TopicIRGroupBy". * **FieldName** *(dict) --* The field name for the "TopicIRGroupBy". * **Identity** *(string) --* **[REQUIRED]** The identity of the identifier. * **TimeGranularity** *(string) --* The time granularity for the "TopicIRGroupBy". * **Sort** *(dict) --* The sort for the "TopicIRGroupBy". * **Operand** *(dict) --* The operand for a "TopicSortClause". * **Identity** *(string) --* **[REQUIRED]** The identity of the identifier. * **SortDirection** *(string) --* The sort direction for the "TopicSortClause". * **DisplayFormat** *(string) --* The display format for the "TopicIRGroupBy". * **DisplayFormatOptions** *(dict) --* A structure that represents additional options for display formatting. * **UseBlankCellFormat** *(boolean) --* A Boolean value that indicates whether to use blank cell format. * **BlankCellFormat** *(string) --* Determines the blank cell format. * **DateFormat** *(string) --* Determines the "DateTime" format. * **DecimalSeparator** *(string) --* Determines the decimal separator. * **GroupingSeparator** *(string) --* Determines the grouping separator. * **UseGrouping** *(boolean) --* A Boolean value that indicates whether to use grouping. * **FractionDigits** *(integer) --* Determines the number of fraction digits. * **Prefix** *(string) --* The prefix value for a display format. * **Suffix** *(string) --* The suffix value for a display format. * **UnitScaler** *(string) --* The unit scaler. Valid values for this structure are: "NONE", "AUTO", "THOUSANDS", "MILLIONS", "BILLIONS", and "TRILLIONS". * **NegativeFormat** *(dict) --* The negative format. * **Prefix** *(string) --* The prefix for a negative format. * **Suffix** *(string) --* The suffix for a negative format. * **CurrencySymbol** *(string) --* The currency symbol, such as "USD". * **NamedEntity** *(dict) --* The named entity for the "TopicIRGroupBy". * **NamedEntityName** *(string) --* The "NamedEntityName" for the "NamedEntityRef". * **Filters** *(list) --* The filters for the "TopicIR". * *(list) --* * *(dict) --* The definition for a "TopicIRFilterOption". * **FilterType** *(string) --* The filter type for the "TopicIRFilterOption". * **FilterClass** *(string) --* The filter class for the "TopicIRFilterOption". * **OperandField** *(dict) --* The operand field for the "TopicIRFilterOption". * **Identity** *(string) --* **[REQUIRED]** The identity of the identifier. * **Function** *(string) --* The function for the "TopicIRFilterOption". * **Constant** *(dict) --* The constant for the "TopicIRFilterOption". * **ConstantType** *(string) --* The constant type of a "TopicConstantValue". * **Value** *(string) --* The value of the "TopicConstantValue". * **Minimum** *(string) --* The minimum for the "TopicConstantValue". * **Maximum** *(string) --* The maximum for the "TopicConstantValue". * **ValueList** *(list) --* The value list of the "TopicConstantValue". * *(dict) --* The definition for a "CollectiveConstantEntry". * **ConstantType** *(string) --* The "ConstantType" of a "CollectiveConstantEntry". * **Value** *(string) --* The value of a "CollectiveConstantEntry". * **Inverse** *(boolean) --* The inverse for the "TopicIRFilterOption". * **NullFilter** *(string) --* The null filter for the "TopicIRFilterOption". * **Aggregation** *(string) --* The aggregation for the "TopicIRFilterOption". * **AggregationFunctionParameters** *(dict) --* The aggregation function parameters for the "TopicIRFilterOption". * *(string) --* * *(string) --* * **AggregationPartitionBy** *(list) --* The "AggregationPartitionBy" for the "TopicIRFilterOption". * *(dict) --* The definition of an "AggregationPartitionBy". * **FieldName** *(string) --* The field Name for an "AggregationPartitionBy". * **TimeGranularity** *(string) --* The "TimeGranularity" for an "AggregationPartitionBy". * **Range** *(dict) --* The range for the "TopicIRFilterOption". * **ConstantType** *(string) --* The constant type of a "TopicConstantValue". * **Value** *(string) --* The value of the "TopicConstantValue". * **Minimum** *(string) --* The minimum for the "TopicConstantValue". * **Maximum** *(string) --* The maximum for the "TopicConstantValue". * **ValueList** *(list) --* The value list of the "TopicConstantValue". * *(dict) --* The definition for a "CollectiveConstantEntry". * **ConstantType** *(string) --* The "ConstantType" of a "CollectiveConstantEntry". * **Value** *(string) --* The value of a "CollectiveConstantEntry". * **Inclusive** *(boolean) --* The inclusive for the "TopicIRFilterOption". * **TimeGranularity** *(string) --* The time granularity for the "TopicIRFilterOption". * **LastNextOffset** *(dict) --* The last next offset for the "TopicIRFilterOption". * **ConstantType** *(string) --* The constant type of a "TopicConstantValue". * **Value** *(string) --* The value of the "TopicConstantValue". * **Minimum** *(string) --* The minimum for the "TopicConstantValue". * **Maximum** *(string) --* The maximum for the "TopicConstantValue". * **ValueList** *(list) --* The value list of the "TopicConstantValue". * *(dict) --* The definition for a "CollectiveConstantEntry". * **ConstantType** *(string) --* The "ConstantType" of a "CollectiveConstantEntry". * **Value** *(string) --* The value of a "CollectiveConstantEntry". * **AggMetrics** *(list) --* The agg metrics for the "TopicIRFilterOption". * *(dict) --* The definition for the "FilterAggMetrics". * **MetricOperand** *(dict) --* The metric operand of the "FilterAggMetrics". * **Identity** *(string) --* **[REQUIRED]** The identity of the identifier. * **Function** *(string) --* The function for the "FilterAggMetrics". * **SortDirection** *(string) --* The sort direction for "FilterAggMetrics". * **TopBottomLimit** *(dict) --* The "TopBottomLimit" for the "TopicIRFilterOption". * **ConstantType** *(string) --* The constant type of a "TopicConstantValue". * **Value** *(string) --* The value of the "TopicConstantValue". * **Minimum** *(string) --* The minimum for the "TopicConstantValue". * **Maximum** *(string) --* The maximum for the "TopicConstantValue". * **ValueList** *(list) --* The value list of the "TopicConstantValue". * *(dict) --* The definition for a "CollectiveConstantEntry". * **ConstantType** *(string) --* The "ConstantType" of a "CollectiveConstantEntry". * **Value** *(string) --* The value of a "CollectiveConstantEntry". * **SortDirection** *(string) --* The sort direction for the "TopicIRFilterOption". * **Anchor** *(dict) --* The anchor for the "TopicIRFilterOption". * **AnchorType** *(string) --* The "AnchorType" for the Anchor. * **TimeGranularity** *(string) --* The "TimeGranularity" of the Anchor. * **Offset** *(integer) --* The offset of the Anchor. * **Sort** *(dict) --* The sort for the "TopicIR". * **Operand** *(dict) --* The operand for a "TopicSortClause". * **Identity** *(string) --* **[REQUIRED]** The identity of the identifier. * **SortDirection** *(string) --* The sort direction for the "TopicSortClause". * **ContributionAnalysis** *(dict) --* The contribution analysis for the "TopicIR". * **Factors** *(list) --* The factors for a "TopicIRContributionAnalysis". * *(dict) --* The definition for the "ContributionAnalysisFactor". * **FieldName** *(string) --* The field name of the "ContributionAnalysisFactor". * **TimeRanges** *(dict) --* The time ranges for the "TopicIRContributionAnalysis". * **StartRange** *(dict) --* The start range for the "ContributionAnalysisTimeRanges". * **FilterType** *(string) --* The filter type for the "TopicIRFilterOption". * **FilterClass** *(string) --* The filter class for the "TopicIRFilterOption". * **OperandField** *(dict) --* The operand field for the "TopicIRFilterOption". * **Identity** *(string) --* **[REQUIRED]** The identity of the identifier. * **Function** *(string) --* The function for the "TopicIRFilterOption". * **Constant** *(dict) --* The constant for the "TopicIRFilterOption". * **ConstantType** *(string) --* The constant type of a "TopicConstantValue". * **Value** *(string) --* The value of the "TopicConstantValue". * **Minimum** *(string) --* The minimum for the "TopicConstantValue". * **Maximum** *(string) --* The maximum for the "TopicConstantValue". * **ValueList** *(list) --* The value list of the "TopicConstantValue". * *(dict) --* The definition for a "CollectiveConstantEntry". * **ConstantType** *(string) --* The "ConstantType" of a "CollectiveConstantEntry". * **Value** *(string) --* The value of a "CollectiveConstantEntry". * **Inverse** *(boolean) --* The inverse for the "TopicIRFilterOption". * **NullFilter** *(string) --* The null filter for the "TopicIRFilterOption". * **Aggregation** *(string) --* The aggregation for the "TopicIRFilterOption". * **AggregationFunctionParameters** *(dict) --* The aggregation function parameters for the "TopicIRFilterOption". * *(string) --* * *(string) --* * **AggregationPartitionBy** *(list) --* The "AggregationPartitionBy" for the "TopicIRFilterOption". * *(dict) --* The definition of an "AggregationPartitionBy". * **FieldName** *(string) --* The field Name for an "AggregationPartitionBy". * **TimeGranularity** *(string) --* The "TimeGranularity" for an "AggregationPartitionBy". * **Range** *(dict) --* The range for the "TopicIRFilterOption". * **ConstantType** *(string) --* The constant type of a "TopicConstantValue". * **Value** *(string) --* The value of the "TopicConstantValue". * **Minimum** *(string) --* The minimum for the "TopicConstantValue". * **Maximum** *(string) --* The maximum for the "TopicConstantValue". * **ValueList** *(list) --* The value list of the "TopicConstantValue". * *(dict) --* The definition for a "CollectiveConstantEntry". * **ConstantType** *(string) --* The "ConstantType" of a "CollectiveConstantEntry". * **Value** *(string) --* The value of a "CollectiveConstantEntry". * **Inclusive** *(boolean) --* The inclusive for the "TopicIRFilterOption". * **TimeGranularity** *(string) --* The time granularity for the "TopicIRFilterOption". * **LastNextOffset** *(dict) --* The last next offset for the "TopicIRFilterOption". * **ConstantType** *(string) --* The constant type of a "TopicConstantValue". * **Value** *(string) --* The value of the "TopicConstantValue". * **Minimum** *(string) --* The minimum for the "TopicConstantValue". * **Maximum** *(string) --* The maximum for the "TopicConstantValue". * **ValueList** *(list) --* The value list of the "TopicConstantValue". * *(dict) --* The definition for a "CollectiveConstantEntry". * **ConstantType** *(string) --* The "ConstantType" of a "CollectiveConstantEntry". * **Value** *(string) --* The value of a "CollectiveConstantEntry". * **AggMetrics** *(list) --* The agg metrics for the "TopicIRFilterOption". * *(dict) --* The definition for the "FilterAggMetrics". * **MetricOperand** *(dict) --* The metric operand of the "FilterAggMetrics". * **Identity** *(string) --* **[REQUIRED]** The identity of the identifier. * **Function** *(string) --* The function for the "FilterAggMetrics". * **SortDirection** *(string) --* The sort direction for "FilterAggMetrics". * **TopBottomLimit** *(dict) --* The "TopBottomLimit" for the "TopicIRFilterOption". * **ConstantType** *(string) --* The constant type of a "TopicConstantValue". * **Value** *(string) --* The value of the "TopicConstantValue". * **Minimum** *(string) --* The minimum for the "TopicConstantValue". * **Maximum** *(string) --* The maximum for the "TopicConstantValue". * **ValueList** *(list) --* The value list of the "TopicConstantValue". * *(dict) --* The definition for a "CollectiveConstantEntry". * **ConstantType** *(string) --* The "ConstantType" of a "CollectiveConstantEntry". * **Value** *(string) --* The value of a "CollectiveConstantEntry". * **SortDirection** *(string) --* The sort direction for the "TopicIRFilterOption". * **Anchor** *(dict) --* The anchor for the "TopicIRFilterOption". * **AnchorType** *(string) --* The "AnchorType" for the Anchor. * **TimeGranularity** *(string) --* The "TimeGranularity" of the Anchor. * **Offset** *(integer) --* The offset of the Anchor. * **EndRange** *(dict) --* The end range for the "ContributionAnalysisTimeRanges". * **FilterType** *(string) --* The filter type for the "TopicIRFilterOption". * **FilterClass** *(string) --* The filter class for the "TopicIRFilterOption". * **OperandField** *(dict) --* The operand field for the "TopicIRFilterOption". * **Identity** *(string) --* **[REQUIRED]** The identity of the identifier. * **Function** *(string) --* The function for the "TopicIRFilterOption". * **Constant** *(dict) --* The constant for the "TopicIRFilterOption". * **ConstantType** *(string) --* The constant type of a "TopicConstantValue". * **Value** *(string) --* The value of the "TopicConstantValue". * **Minimum** *(string) --* The minimum for the "TopicConstantValue". * **Maximum** *(string) --* The maximum for the "TopicConstantValue". * **ValueList** *(list) --* The value list of the "TopicConstantValue". * *(dict) --* The definition for a "CollectiveConstantEntry". * **ConstantType** *(string) --* The "ConstantType" of a "CollectiveConstantEntry". * **Value** *(string) --* The value of a "CollectiveConstantEntry". * **Inverse** *(boolean) --* The inverse for the "TopicIRFilterOption". * **NullFilter** *(string) --* The null filter for the "TopicIRFilterOption". * **Aggregation** *(string) --* The aggregation for the "TopicIRFilterOption". * **AggregationFunctionParameters** *(dict) --* The aggregation function parameters for the "TopicIRFilterOption". * *(string) --* * *(string) --* * **AggregationPartitionBy** *(list) --* The "AggregationPartitionBy" for the "TopicIRFilterOption". * *(dict) --* The definition of an "AggregationPartitionBy". * **FieldName** *(string) --* The field Name for an "AggregationPartitionBy". * **TimeGranularity** *(string) --* The "TimeGranularity" for an "AggregationPartitionBy". * **Range** *(dict) --* The range for the "TopicIRFilterOption". * **ConstantType** *(string) --* The constant type of a "TopicConstantValue". * **Value** *(string) --* The value of the "TopicConstantValue". * **Minimum** *(string) --* The minimum for the "TopicConstantValue". * **Maximum** *(string) --* The maximum for the "TopicConstantValue". * **ValueList** *(list) --* The value list of the "TopicConstantValue". * *(dict) --* The definition for a "CollectiveConstantEntry". * **ConstantType** *(string) --* The "ConstantType" of a "CollectiveConstantEntry". * **Value** *(string) --* The value of a "CollectiveConstantEntry". * **Inclusive** *(boolean) --* The inclusive for the "TopicIRFilterOption". * **TimeGranularity** *(string) --* The time granularity for the "TopicIRFilterOption". * **LastNextOffset** *(dict) --* The last next offset for the "TopicIRFilterOption". * **ConstantType** *(string) --* The constant type of a "TopicConstantValue". * **Value** *(string) --* The value of the "TopicConstantValue". * **Minimum** *(string) --* The minimum for the "TopicConstantValue". * **Maximum** *(string) --* The maximum for the "TopicConstantValue". * **ValueList** *(list) --* The value list of the "TopicConstantValue". * *(dict) --* The definition for a "CollectiveConstantEntry". * **ConstantType** *(string) --* The "ConstantType" of a "CollectiveConstantEntry". * **Value** *(string) --* The value of a "CollectiveConstantEntry". * **AggMetrics** *(list) --* The agg metrics for the "TopicIRFilterOption". * *(dict) --* The definition for the "FilterAggMetrics". * **MetricOperand** *(dict) --* The metric operand of the "FilterAggMetrics". * **Identity** *(string) --* **[REQUIRED]** The identity of the identifier. * **Function** *(string) --* The function for the "FilterAggMetrics". * **SortDirection** *(string) --* The sort direction for "FilterAggMetrics". * **TopBottomLimit** *(dict) --* The "TopBottomLimit" for the "TopicIRFilterOption". * **ConstantType** *(string) --* The constant type of a "TopicConstantValue". * **Value** *(string) --* The value of the "TopicConstantValue". * **Minimum** *(string) --* The minimum for the "TopicConstantValue". * **Maximum** *(string) --* The maximum for the "TopicConstantValue". * **ValueList** *(list) --* The value list of the "TopicConstantValue". * *(dict) --* The definition for a "CollectiveConstantEntry". * **ConstantType** *(string) --* The "ConstantType" of a "CollectiveConstantEntry". * **Value** *(string) --* The value of a "CollectiveConstantEntry". * **SortDirection** *(string) --* The sort direction for the "TopicIRFilterOption". * **Anchor** *(dict) --* The anchor for the "TopicIRFilterOption". * **AnchorType** *(string) --* The "AnchorType" for the Anchor. * **TimeGranularity** *(string) --* The "TimeGranularity" of the Anchor. * **Offset** *(integer) --* The offset of the Anchor. * **Direction** *(string) --* The direction for the "TopicIRContributionAnalysis". * **SortType** *(string) --* The sort type for the "TopicIRContributionAnalysis". * **Visual** *(dict) --* The visual for the "TopicIR". * **type** *(string) --* The type for a "VisualOptions". * **PrimaryVisual** *(dict) --* The "PrimaryVisual" for the "CreateTopicReviewedAnswer". * **VisualId** *(string) --* The visual ID for the "TopicVisual". * **Role** *(string) --* The role for the "TopicVisual". * **Ir** *(dict) --* The ir for the "TopicVisual". * **Metrics** *(list) --* The metrics for the "TopicIR". * *(dict) --* The definition for a "TopicIRMetric". * **MetricId** *(dict) --* The metric ID for the "TopicIRMetric". * **Identity** *(string) --* **[REQUIRED]** The identity of the identifier. * **Function** *(dict) --* The function for the "TopicIRMetric". * **Aggregation** *(string) --* The aggregation of an Agg function. * **AggregationFunctionParameters** *(dict) --* The aggregation parameters for an Agg function. * *(string) --* * *(string) --* * **Period** *(string) --* The period of an Agg function. * **PeriodField** *(string) --* The period field for an Agg function. * **Operands** *(list) --* The operands for the "TopicIRMetric". * *(dict) --* The definition for the identifier. * **Identity** *(string) --* **[REQUIRED]** The identity of the identifier. * **ComparisonMethod** *(dict) --* The comparison method for the "TopicIRMetric". * **Type** *(string) --* The type for the "TopicIRComparisonMethod". * **Period** *(string) --* The period for the "TopicIRComparisonMethod". * **WindowSize** *(integer) --* The window size for the "TopicIRComparisonMethod". * **Expression** *(string) --* The expression for the "TopicIRMetric". * **CalculatedFieldReferences** *(list) --* The calculated field references for the "TopicIRMetric". * *(dict) --* The definition for the identifier. * **Identity** *(string) --* **[REQUIRED]** The identity of the identifier. * **DisplayFormat** *(string) --* The display format for the "TopicIRMetric". * **DisplayFormatOptions** *(dict) --* A structure that represents additional options for display formatting. * **UseBlankCellFormat** *(boolean) --* A Boolean value that indicates whether to use blank cell format. * **BlankCellFormat** *(string) --* Determines the blank cell format. * **DateFormat** *(string) --* Determines the "DateTime" format. * **DecimalSeparator** *(string) --* Determines the decimal separator. * **GroupingSeparator** *(string) --* Determines the grouping separator. * **UseGrouping** *(boolean) --* A Boolean value that indicates whether to use grouping. * **FractionDigits** *(integer) --* Determines the number of fraction digits. * **Prefix** *(string) --* The prefix value for a display format. * **Suffix** *(string) --* The suffix value for a display format. * **UnitScaler** *(string) --* The unit scaler. Valid values for this structure are: "NONE", "AUTO", "THOUSANDS", "MILLIONS", "BILLIONS", and "TRILLIONS". * **NegativeFormat** *(dict) --* The negative format. * **Prefix** *(string) --* The prefix for a negative format. * **Suffix** *(string) --* The suffix for a negative format. * **CurrencySymbol** *(string) --* The currency symbol, such as "USD". * **NamedEntity** *(dict) --* The named entity for the "TopicIRMetric". * **NamedEntityName** *(string) --* The "NamedEntityName" for the "NamedEntityRef". * **GroupByList** *(list) --* The GroupBy list for the "TopicIR". * *(dict) --* The definition for a "TopicIRGroupBy". * **FieldName** *(dict) --* The field name for the "TopicIRGroupBy". * **Identity** *(string) --* **[REQUIRED]** The identity of the identifier. * **TimeGranularity** *(string) --* The time granularity for the "TopicIRGroupBy". * **Sort** *(dict) --* The sort for the "TopicIRGroupBy". * **Operand** *(dict) --* The operand for a "TopicSortClause". * **Identity** *(string) --* **[REQUIRED]** The identity of the identifier. * **SortDirection** *(string) --* The sort direction for the "TopicSortClause". * **DisplayFormat** *(string) --* The display format for the "TopicIRGroupBy". * **DisplayFormatOptions** *(dict) --* A structure that represents additional options for display formatting. * **UseBlankCellFormat** *(boolean) --* A Boolean value that indicates whether to use blank cell format. * **BlankCellFormat** *(string) --* Determines the blank cell format. * **DateFormat** *(string) --* Determines the "DateTime" format. * **DecimalSeparator** *(string) --* Determines the decimal separator. * **GroupingSeparator** *(string) --* Determines the grouping separator. * **UseGrouping** *(boolean) --* A Boolean value that indicates whether to use grouping. * **FractionDigits** *(integer) --* Determines the number of fraction digits. * **Prefix** *(string) --* The prefix value for a display format. * **Suffix** *(string) --* The suffix value for a display format. * **UnitScaler** *(string) --* The unit scaler. Valid values for this structure are: "NONE", "AUTO", "THOUSANDS", "MILLIONS", "BILLIONS", and "TRILLIONS". * **NegativeFormat** *(dict) --* The negative format. * **Prefix** *(string) --* The prefix for a negative format. * **Suffix** *(string) --* The suffix for a negative format. * **CurrencySymbol** *(string) --* The currency symbol, such as "USD". * **NamedEntity** *(dict) --* The named entity for the "TopicIRGroupBy". * **NamedEntityName** *(string) --* The "NamedEntityName" for the "NamedEntityRef". * **Filters** *(list) --* The filters for the "TopicIR". * *(list) --* * *(dict) --* The definition for a "TopicIRFilterOption". * **FilterType** *(string) --* The filter type for the "TopicIRFilterOption". * **FilterClass** *(string) --* The filter class for the "TopicIRFilterOption". * **OperandField** *(dict) --* The operand field for the "TopicIRFilterOption". * **Identity** *(string) --* **[REQUIRED]** The identity of the identifier. * **Function** *(string) --* The function for the "TopicIRFilterOption". * **Constant** *(dict) --* The constant for the "TopicIRFilterOption". * **ConstantType** *(string) --* The constant type of a "TopicConstantValue". * **Value** *(string) --* The value of the "TopicConstantValue". * **Minimum** *(string) --* The minimum for the "TopicConstantValue". * **Maximum** *(string) --* The maximum for the "TopicConstantValue". * **ValueList** *(list) --* The value list of the "TopicConstantValue". * *(dict) --* The definition for a "CollectiveConstantEntry". * **ConstantType** *(string) --* The "ConstantType" of a "CollectiveConstantEntry". * **Value** *(string) --* The value of a "CollectiveConstantEntry". * **Inverse** *(boolean) --* The inverse for the "TopicIRFilterOption". * **NullFilter** *(string) --* The null filter for the "TopicIRFilterOption". * **Aggregation** *(string) --* The aggregation for the "TopicIRFilterOption". * **AggregationFunctionParameters** *(dict) --* The aggregation function parameters for the "TopicIRFilterOption". * *(string) --* * *(string) --* * **AggregationPartitionBy** *(list) --* The "AggregationPartitionBy" for the "TopicIRFilterOption". * *(dict) --* The definition of an "AggregationPartitionBy". * **FieldName** *(string) --* The field Name for an "AggregationPartitionBy". * **TimeGranularity** *(string) --* The "TimeGranularity" for an "AggregationPartitionBy". * **Range** *(dict) --* The range for the "TopicIRFilterOption". * **ConstantType** *(string) --* The constant type of a "TopicConstantValue". * **Value** *(string) --* The value of the "TopicConstantValue". * **Minimum** *(string) --* The minimum for the "TopicConstantValue". * **Maximum** *(string) --* The maximum for the "TopicConstantValue". * **ValueList** *(list) --* The value list of the "TopicConstantValue". * *(dict) --* The definition for a "CollectiveConstantEntry". * **ConstantType** *(string) --* The "ConstantType" of a "CollectiveConstantEntry". * **Value** *(string) --* The value of a "CollectiveConstantEntry". * **Inclusive** *(boolean) --* The inclusive for the "TopicIRFilterOption". * **TimeGranularity** *(string) --* The time granularity for the "TopicIRFilterOption". * **LastNextOffset** *(dict) --* The last next offset for the "TopicIRFilterOption". * **ConstantType** *(string) --* The constant type of a "TopicConstantValue". * **Value** *(string) --* The value of the "TopicConstantValue". * **Minimum** *(string) --* The minimum for the "TopicConstantValue". * **Maximum** *(string) --* The maximum for the "TopicConstantValue". * **ValueList** *(list) --* The value list of the "TopicConstantValue". * *(dict) --* The definition for a "CollectiveConstantEntry". * **ConstantType** *(string) --* The "ConstantType" of a "CollectiveConstantEntry". * **Value** *(string) --* The value of a "CollectiveConstantEntry". * **AggMetrics** *(list) --* The agg metrics for the "TopicIRFilterOption". * *(dict) --* The definition for the "FilterAggMetrics". * **MetricOperand** *(dict) --* The metric operand of the "FilterAggMetrics". * **Identity** *(string) --* **[REQUIRED]** The identity of the identifier. * **Function** *(string) --* The function for the "FilterAggMetrics". * **SortDirection** *(string) --* The sort direction for "FilterAggMetrics". * **TopBottomLimit** *(dict) --* The "TopBottomLimit" for the "TopicIRFilterOption". * **ConstantType** *(string) --* The constant type of a "TopicConstantValue". * **Value** *(string) --* The value of the "TopicConstantValue". * **Minimum** *(string) --* The minimum for the "TopicConstantValue". * **Maximum** *(string) --* The maximum for the "TopicConstantValue". * **ValueList** *(list) --* The value list of the "TopicConstantValue". * *(dict) --* The definition for a "CollectiveConstantEntry". * **ConstantType** *(string) --* The "ConstantType" of a "CollectiveConstantEntry". * **Value** *(string) --* The value of a "CollectiveConstantEntry". * **SortDirection** *(string) --* The sort direction for the "TopicIRFilterOption". * **Anchor** *(dict) --* The anchor for the "TopicIRFilterOption". * **AnchorType** *(string) --* The "AnchorType" for the Anchor. * **TimeGranularity** *(string) --* The "TimeGranularity" of the Anchor. * **Offset** *(integer) --* The offset of the Anchor. * **Sort** *(dict) --* The sort for the "TopicIR". * **Operand** *(dict) --* The operand for a "TopicSortClause". * **Identity** *(string) --* **[REQUIRED]** The identity of the identifier. * **SortDirection** *(string) --* The sort direction for the "TopicSortClause". * **ContributionAnalysis** *(dict) --* The contribution analysis for the "TopicIR". * **Factors** *(list) --* The factors for a "TopicIRContributionAnalysis". * *(dict) --* The definition for the "ContributionAnalysisFactor". * **FieldName** *(string) --* The field name of the "ContributionAnalysisFactor". * **TimeRanges** *(dict) --* The time ranges for the "TopicIRContributionAnalysis". * **StartRange** *(dict) --* The start range for the "ContributionAnalysisTimeRanges". * **FilterType** *(string) --* The filter type for the "TopicIRFilterOption". * **FilterClass** *(string) --* The filter class for the "TopicIRFilterOption". * **OperandField** *(dict) --* The operand field for the "TopicIRFilterOption". * **Identity** *(string) --* **[REQUIRED]** The identity of the identifier. * **Function** *(string) --* The function for the "TopicIRFilterOption". * **Constant** *(dict) --* The constant for the "TopicIRFilterOption". * **ConstantType** *(string) --* The constant type of a "TopicConstantValue". * **Value** *(string) --* The value of the "TopicConstantValue". * **Minimum** *(string) --* The minimum for the "TopicConstantValue". * **Maximum** *(string) --* The maximum for the "TopicConstantValue". * **ValueList** *(list) --* The value list of the "TopicConstantValue". * *(dict) --* The definition for a "CollectiveConstantEntry". * **ConstantType** *(string) --* The "ConstantType" of a "CollectiveConstantEntry". * **Value** *(string) --* The value of a "CollectiveConstantEntry". * **Inverse** *(boolean) --* The inverse for the "TopicIRFilterOption". * **NullFilter** *(string) --* The null filter for the "TopicIRFilterOption". * **Aggregation** *(string) --* The aggregation for the "TopicIRFilterOption". * **AggregationFunctionParameters** *(dict) --* The aggregation function parameters for the "TopicIRFilterOption". * *(string) --* * *(string) --* * **AggregationPartitionBy** *(list) --* The "AggregationPartitionBy" for the "TopicIRFilterOption". * *(dict) --* The definition of an "AggregationPartitionBy". * **FieldName** *(string) --* The field Name for an "AggregationPartitionBy". * **TimeGranularity** *(string) --* The "TimeGranularity" for an "AggregationPartitionBy". * **Range** *(dict) --* The range for the "TopicIRFilterOption". * **ConstantType** *(string) --* The constant type of a "TopicConstantValue". * **Value** *(string) --* The value of the "TopicConstantValue". * **Minimum** *(string) --* The minimum for the "TopicConstantValue". * **Maximum** *(string) --* The maximum for the "TopicConstantValue". * **ValueList** *(list) --* The value list of the "TopicConstantValue". * *(dict) --* The definition for a "CollectiveConstantEntry". * **ConstantType** *(string) --* The "ConstantType" of a "CollectiveConstantEntry". * **Value** *(string) --* The value of a "CollectiveConstantEntry". * **Inclusive** *(boolean) --* The inclusive for the "TopicIRFilterOption". * **TimeGranularity** *(string) --* The time granularity for the "TopicIRFilterOption". * **LastNextOffset** *(dict) --* The last next offset for the "TopicIRFilterOption". * **ConstantType** *(string) --* The constant type of a "TopicConstantValue". * **Value** *(string) --* The value of the "TopicConstantValue". * **Minimum** *(string) --* The minimum for the "TopicConstantValue". * **Maximum** *(string) --* The maximum for the "TopicConstantValue". * **ValueList** *(list) --* The value list of the "TopicConstantValue". * *(dict) --* The definition for a "CollectiveConstantEntry". * **ConstantType** *(string) --* The "ConstantType" of a "CollectiveConstantEntry". * **Value** *(string) --* The value of a "CollectiveConstantEntry". * **AggMetrics** *(list) --* The agg metrics for the "TopicIRFilterOption". * *(dict) --* The definition for the "FilterAggMetrics". * **MetricOperand** *(dict) --* The metric operand of the "FilterAggMetrics". * **Identity** *(string) --* **[REQUIRED]** The identity of the identifier. * **Function** *(string) --* The function for the "FilterAggMetrics". * **SortDirection** *(string) --* The sort direction for "FilterAggMetrics". * **TopBottomLimit** *(dict) --* The "TopBottomLimit" for the "TopicIRFilterOption". * **ConstantType** *(string) --* The constant type of a "TopicConstantValue". * **Value** *(string) --* The value of the "TopicConstantValue". * **Minimum** *(string) --* The minimum for the "TopicConstantValue". * **Maximum** *(string) --* The maximum for the "TopicConstantValue". * **ValueList** *(list) --* The value list of the "TopicConstantValue". * *(dict) --* The definition for a "CollectiveConstantEntry". * **ConstantType** *(string) --* The "ConstantType" of a "CollectiveConstantEntry". * **Value** *(string) --* The value of a "CollectiveConstantEntry". * **SortDirection** *(string) --* The sort direction for the "TopicIRFilterOption". * **Anchor** *(dict) --* The anchor for the "TopicIRFilterOption". * **AnchorType** *(string) --* The "AnchorType" for the Anchor. * **TimeGranularity** *(string) --* The "TimeGranularity" of the Anchor. * **Offset** *(integer) --* The offset of the Anchor. * **EndRange** *(dict) --* The end range for the "ContributionAnalysisTimeRanges". * **FilterType** *(string) --* The filter type for the "TopicIRFilterOption". * **FilterClass** *(string) --* The filter class for the "TopicIRFilterOption". * **OperandField** *(dict) --* The operand field for the "TopicIRFilterOption". * **Identity** *(string) --* **[REQUIRED]** The identity of the identifier. * **Function** *(string) --* The function for the "TopicIRFilterOption". * **Constant** *(dict) --* The constant for the "TopicIRFilterOption". * **ConstantType** *(string) --* The constant type of a "TopicConstantValue". * **Value** *(string) --* The value of the "TopicConstantValue". * **Minimum** *(string) --* The minimum for the "TopicConstantValue". * **Maximum** *(string) --* The maximum for the "TopicConstantValue". * **ValueList** *(list) --* The value list of the "TopicConstantValue". * *(dict) --* The definition for a "CollectiveConstantEntry". * **ConstantType** *(string) --* The "ConstantType" of a "CollectiveConstantEntry". * **Value** *(string) --* The value of a "CollectiveConstantEntry". * **Inverse** *(boolean) --* The inverse for the "TopicIRFilterOption". * **NullFilter** *(string) --* The null filter for the "TopicIRFilterOption". * **Aggregation** *(string) --* The aggregation for the "TopicIRFilterOption". * **AggregationFunctionParameters** *(dict) --* The aggregation function parameters for the "TopicIRFilterOption". * *(string) --* * *(string) --* * **AggregationPartitionBy** *(list) --* The "AggregationPartitionBy" for the "TopicIRFilterOption". * *(dict) --* The definition of an "AggregationPartitionBy". * **FieldName** *(string) --* The field Name for an "AggregationPartitionBy". * **TimeGranularity** *(string) --* The "TimeGranularity" for an "AggregationPartitionBy". * **Range** *(dict) --* The range for the "TopicIRFilterOption". * **ConstantType** *(string) --* The constant type of a "TopicConstantValue". * **Value** *(string) --* The value of the "TopicConstantValue". * **Minimum** *(string) --* The minimum for the "TopicConstantValue". * **Maximum** *(string) --* The maximum for the "TopicConstantValue". * **ValueList** *(list) --* The value list of the "TopicConstantValue". * *(dict) --* The definition for a "CollectiveConstantEntry". * **ConstantType** *(string) --* The "ConstantType" of a "CollectiveConstantEntry". * **Value** *(string) --* The value of a "CollectiveConstantEntry". * **Inclusive** *(boolean) --* The inclusive for the "TopicIRFilterOption". * **TimeGranularity** *(string) --* The time granularity for the "TopicIRFilterOption". * **LastNextOffset** *(dict) --* The last next offset for the "TopicIRFilterOption". * **ConstantType** *(string) --* The constant type of a "TopicConstantValue". * **Value** *(string) --* The value of the "TopicConstantValue". * **Minimum** *(string) --* The minimum for the "TopicConstantValue". * **Maximum** *(string) --* The maximum for the "TopicConstantValue". * **ValueList** *(list) --* The value list of the "TopicConstantValue". * *(dict) --* The definition for a "CollectiveConstantEntry". * **ConstantType** *(string) --* The "ConstantType" of a "CollectiveConstantEntry". * **Value** *(string) --* The value of a "CollectiveConstantEntry". * **AggMetrics** *(list) --* The agg metrics for the "TopicIRFilterOption". * *(dict) --* The definition for the "FilterAggMetrics". * **MetricOperand** *(dict) --* The metric operand of the "FilterAggMetrics". * **Identity** *(string) --* **[REQUIRED]** The identity of the identifier. * **Function** *(string) --* The function for the "FilterAggMetrics". * **SortDirection** *(string) --* The sort direction for "FilterAggMetrics". * **TopBottomLimit** *(dict) --* The "TopBottomLimit" for the "TopicIRFilterOption". * **ConstantType** *(string) --* The constant type of a "TopicConstantValue". * **Value** *(string) --* The value of the "TopicConstantValue". * **Minimum** *(string) --* The minimum for the "TopicConstantValue". * **Maximum** *(string) --* The maximum for the "TopicConstantValue". * **ValueList** *(list) --* The value list of the "TopicConstantValue". * *(dict) --* The definition for a "CollectiveConstantEntry". * **ConstantType** *(string) --* The "ConstantType" of a "CollectiveConstantEntry". * **Value** *(string) --* The value of a "CollectiveConstantEntry". * **SortDirection** *(string) --* The sort direction for the "TopicIRFilterOption". * **Anchor** *(dict) --* The anchor for the "TopicIRFilterOption". * **AnchorType** *(string) --* The "AnchorType" for the Anchor. * **TimeGranularity** *(string) --* The "TimeGranularity" of the Anchor. * **Offset** *(integer) --* The offset of the Anchor. * **Direction** *(string) --* The direction for the "TopicIRContributionAnalysis". * **SortType** *(string) --* The sort type for the "TopicIRContributionAnalysis". * **Visual** *(dict) --* The visual for the "TopicIR". * **type** *(string) --* The type for a "VisualOptions". * **SupportingVisuals** *(list) --* The supporting visuals for the "TopicVisual". * *(dict) --* The definition for a "TopicVisual". * **Template** *(dict) --* The template for the "CreateTopicReviewedAnswer". * **TemplateType** *(string) --* The template type for the "TopicTemplate". * **Slots** *(list) --* The slots for the "TopicTemplate". * *(dict) --* The definition for the slot. * **SlotId** *(string) --* The slot ID of the slot. * **VisualId** *(string) --* The visual ID for the slot. Return type: dict Returns: **Response Syntax** { 'TopicId': 'string', 'TopicArn': 'string', 'SucceededAnswers': [ { 'AnswerId': 'string' }, ], 'InvalidAnswers': [ { 'AnswerId': 'string', 'Error': 'INTERNAL_ERROR'|'MISSING_ANSWER'|'DATASET_DOES_NOT_EXIST'|'INVALID_DATASET_ARN'|'DUPLICATED_ANSWER'|'INVALID_DATA'|'MISSING_REQUIRED_FIELDS' }, ], 'Status': 123, 'RequestId': 'string' } **Response Structure** * *(dict) --* * **TopicId** *(string) --* The ID for the topic reviewed answer that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. * **TopicArn** *(string) --* The Amazon Resource Name (ARN) of the topic. * **SucceededAnswers** *(list) --* The definition of Answers that are successfully created. * *(dict) --* The definition for a "SucceededTopicReviewedAnswer". * **AnswerId** *(string) --* The answer ID for the "SucceededTopicReviewedAnswer". * **InvalidAnswers** *(list) --* The definition of Answers that are invalid and not created. * *(dict) --* The definition for a "InvalidTopicReviewedAnswer". * **AnswerId** *(string) --* The answer ID for the "InvalidTopicReviewedAnswer". * **Error** *(string) --* The error that is returned for the "InvalidTopicReviewedAnswer". * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / create_group_membership create_group_membership *********************** QuickSight.Client.create_group_membership(**kwargs) Adds an Amazon QuickSight user to an Amazon QuickSight group. See also: AWS API Documentation **Request Syntax** response = client.create_group_membership( MemberName='string', GroupName='string', AwsAccountId='string', Namespace='string' ) Parameters: * **MemberName** (*string*) -- **[REQUIRED]** The name of the user that you want to add to the group membership. * **GroupName** (*string*) -- **[REQUIRED]** The name of the group that you want to add the user to. * **AwsAccountId** (*string*) -- **[REQUIRED]** 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** (*string*) -- **[REQUIRED]** The namespace that you want the user to be a part of. Return type: dict Returns: **Response Syntax** { 'GroupMember': { 'Arn': 'string', 'MemberName': 'string' }, 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **GroupMember** *(dict) --* The group member. * **Arn** *(string) --* The Amazon Resource Name (ARN) for the group member (user). * **MemberName** *(string) --* The name of the group member (user). * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.PreconditionNotMetException" * "QuickSight.Client.exceptions.InternalFailureException" * "QuickSight.Client.exceptions.ResourceUnavailableException" QuickSight / Client / describe_vpc_connection describe_vpc_connection *********************** QuickSight.Client.describe_vpc_connection(**kwargs) Describes a VPC connection. See also: AWS API Documentation **Request Syntax** response = client.describe_vpc_connection( AwsAccountId='string', VPCConnectionId='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The Amazon Web Services account ID of the account that contains the VPC connection that you want described. * **VPCConnectionId** (*string*) -- **[REQUIRED]** The ID of the VPC connection that you're creating. This ID is a unique identifier for each Amazon Web Services Region in an Amazon Web Services account. Return type: dict Returns: **Response Syntax** { 'VPCConnection': { 'VPCConnectionId': 'string', 'Arn': 'string', 'Name': 'string', 'VPCId': 'string', 'SecurityGroupIds': [ 'string', ], 'DnsResolvers': [ 'string', ], 'Status': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETION_IN_PROGRESS'|'DELETION_FAILED'|'DELETED', 'AvailabilityStatus': 'AVAILABLE'|'UNAVAILABLE'|'PARTIALLY_AVAILABLE', 'NetworkInterfaces': [ { 'SubnetId': 'string', 'AvailabilityZone': 'string', 'ErrorMessage': 'string', 'Status': 'CREATING'|'AVAILABLE'|'CREATION_FAILED'|'UPDATING'|'UPDATE_FAILED'|'DELETING'|'DELETED'|'DELETION_FAILED'|'DELETION_SCHEDULED'|'ATTACHMENT_FAILED_ROLLBACK_FAILED', 'NetworkInterfaceId': 'string' }, ], 'RoleArn': 'string', 'CreatedTime': datetime(2015, 1, 1), 'LastUpdatedTime': datetime(2015, 1, 1) }, 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **VPCConnection** *(dict) --* A response object that provides information for the specified VPC connection. * **VPCConnectionId** *(string) --* The ID of the VPC connection that you're creating. This ID is a unique identifier for each Amazon Web Services Region in an Amazon Web Services account. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the VPC connection. * **Name** *(string) --* The display name for the VPC connection. * **VPCId** *(string) --* The Amazon EC2 VPC ID associated with the VPC connection. * **SecurityGroupIds** *(list) --* The Amazon EC2 security group IDs associated with the VPC connection. * *(string) --* * **DnsResolvers** *(list) --* A list of IP addresses of DNS resolver endpoints for the VPC connection. * *(string) --* * **Status** *(string) --* The status of the VPC connection. * **AvailabilityStatus** *(string) --* The availability status of the VPC connection. * **NetworkInterfaces** *(list) --* A list of network interfaces. * *(dict) --* The structure that contains information about a network interface. * **SubnetId** *(string) --* The subnet ID associated with the network interface. * **AvailabilityZone** *(string) --* The availability zone that the network interface resides in. * **ErrorMessage** *(string) --* An error message. * **Status** *(string) --* The status of the network interface. * **NetworkInterfaceId** *(string) --* The network interface ID. * **RoleArn** *(string) --* The ARN of the IAM role associated with the VPC connection. * **CreatedTime** *(datetime) --* The time that the VPC connection was created. * **LastUpdatedTime** *(datetime) --* The time that the VPC connection was last updated. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / describe_quick_sight_q_search_configuration describe_quick_sight_q_search_configuration ******************************************* QuickSight.Client.describe_quick_sight_q_search_configuration(**kwargs) Describes the state of a Amazon QuickSight Q Search configuration. See also: AWS API Documentation **Request Syntax** response = client.describe_quick_sight_q_search_configuration( AwsAccountId='string' ) Parameters: **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the Amazon QuickSight Q Search configuration that the user wants described. Return type: dict Returns: **Response Syntax** { 'QSearchStatus': 'ENABLED'|'DISABLED', 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **QSearchStatus** *(string) --* The status of Amazon QuickSight Q Search configuration. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / create_template create_template *************** QuickSight.Client.create_template(**kwargs) Creates a template either from a "TemplateDefinition" or from an existing Amazon QuickSight analysis or template. You can use the resulting template to create additional dashboards, templates, or analyses. A *template* is an entity in Amazon QuickSight that encapsulates the metadata required to create an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template. See also: AWS API Documentation **Request Syntax** # This section is too large to render. # Please see the AWS API Documentation linked below. AWS API Documentation **Parameters** # This section is too large to render. # Please see the AWS API Documentation linked below. AWS API Documentation Return type: dict Returns: **Response Syntax** { 'Arn': 'string', 'VersionArn': 'string', 'TemplateId': 'string', 'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED', 'Status': 123, 'RequestId': 'string' } **Response Structure** * *(dict) --* * **Arn** *(string) --* The ARN for the template. * **VersionArn** *(string) --* The ARN for the template, including the version information of the first version. * **TemplateId** *(string) --* The ID of the template. * **CreationStatus** *(string) --* The template creation status. * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.ResourceExistsException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.LimitExceededException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / describe_folder describe_folder *************** QuickSight.Client.describe_folder(**kwargs) Describes a folder. See also: AWS API Documentation **Request Syntax** response = client.describe_folder( AwsAccountId='string', FolderId='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID for the Amazon Web Services account that contains the folder. * **FolderId** (*string*) -- **[REQUIRED]** The ID of the folder. Return type: dict Returns: **Response Syntax** { 'Status': 123, 'Folder': { 'FolderId': 'string', 'Arn': 'string', 'Name': 'string', 'FolderType': 'SHARED'|'RESTRICTED', 'FolderPath': [ 'string', ], 'CreatedTime': datetime(2015, 1, 1), 'LastUpdatedTime': datetime(2015, 1, 1), 'SharingModel': 'ACCOUNT'|'NAMESPACE' }, 'RequestId': 'string' } **Response Structure** * *(dict) --* * **Status** *(integer) --* The HTTP status of the request. * **Folder** *(dict) --* Information about the folder. * **FolderId** *(string) --* The ID of the folder. * **Arn** *(string) --* The Amazon Resource Name (ARN) for the folder. * **Name** *(string) --* A display name for the folder. * **FolderType** *(string) --* The type of folder it is. * **FolderPath** *(list) --* An array of ancestor ARN strings for the folder. * *(string) --* * **CreatedTime** *(datetime) --* The time that the folder was created. * **LastUpdatedTime** *(datetime) --* The time that the folder was last updated. * **SharingModel** *(string) --* The sharing scope of the folder. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / describe_data_set_refresh_properties describe_data_set_refresh_properties ************************************ QuickSight.Client.describe_data_set_refresh_properties(**kwargs) Describes the refresh properties of a dataset. See also: AWS API Documentation **Request Syntax** response = client.describe_data_set_refresh_properties( AwsAccountId='string', DataSetId='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The Amazon Web Services account ID. * **DataSetId** (*string*) -- **[REQUIRED]** The ID of the dataset. Return type: dict Returns: **Response Syntax** { 'RequestId': 'string', 'Status': 123, 'DataSetRefreshProperties': { 'RefreshConfiguration': { 'IncrementalRefresh': { 'LookbackWindow': { 'ColumnName': 'string', 'Size': 123, 'SizeUnit': 'HOUR'|'DAY'|'WEEK' } } }, 'FailureConfiguration': { 'EmailAlert': { 'AlertStatus': 'ENABLED'|'DISABLED' } } } } **Response Structure** * *(dict) --* * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. * **DataSetRefreshProperties** *(dict) --* The dataset refresh properties. * **RefreshConfiguration** *(dict) --* The refresh configuration for a dataset. * **IncrementalRefresh** *(dict) --* The incremental refresh for the dataset. * **LookbackWindow** *(dict) --* The lookback window setup for an incremental refresh configuration. * **ColumnName** *(string) --* The name of the lookback window column. * **Size** *(integer) --* The lookback window column size. * **SizeUnit** *(string) --* The size unit that is used for the lookback window column. Valid values for this structure are "HOUR", "DAY", and "WEEK". * **FailureConfiguration** *(dict) --* The failure configuration for a dataset. * **EmailAlert** *(dict) --* The email alert configuration for a dataset refresh failure. * **AlertStatus** *(string) --* The status value that determines if email alerts are sent. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.LimitExceededException" * "QuickSight.Client.exceptions.PreconditionNotMetException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / describe_role_custom_permission describe_role_custom_permission ******************************* QuickSight.Client.describe_role_custom_permission(**kwargs) Describes all custom permissions that are mapped to a role. See also: AWS API Documentation **Request Syntax** response = client.describe_role_custom_permission( Role='ADMIN'|'AUTHOR'|'READER'|'ADMIN_PRO'|'AUTHOR_PRO'|'READER_PRO', AwsAccountId='string', Namespace='string' ) Parameters: * **Role** (*string*) -- **[REQUIRED]** The name of the role whose permissions you want described. * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account. * **Namespace** (*string*) -- **[REQUIRED]** The namespace that contains the role. Return type: dict Returns: **Response Syntax** { 'CustomPermissionsName': 'string', 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **CustomPermissionsName** *(string) --* The name of the custom permission that is described. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.PreconditionNotMetException" * "QuickSight.Client.exceptions.InternalFailureException" * "QuickSight.Client.exceptions.ResourceUnavailableException" QuickSight / Client / describe_user describe_user ************* QuickSight.Client.describe_user(**kwargs) Returns information about a user, given the user name. See also: AWS API Documentation **Request Syntax** response = client.describe_user( UserName='string', AwsAccountId='string', Namespace='string' ) Parameters: * **UserName** (*string*) -- **[REQUIRED]** The name of the user that you want to describe. * **AwsAccountId** (*string*) -- **[REQUIRED]** 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** (*string*) -- **[REQUIRED]** The namespace. Currently, you should set this to "default". Return type: dict Returns: **Response Syntax** { 'User': { 'Arn': 'string', 'UserName': 'string', 'Email': 'string', 'Role': 'ADMIN'|'AUTHOR'|'READER'|'RESTRICTED_AUTHOR'|'RESTRICTED_READER'|'ADMIN_PRO'|'AUTHOR_PRO'|'READER_PRO', 'IdentityType': 'IAM'|'QUICKSIGHT'|'IAM_IDENTITY_CENTER', 'Active': True|False, 'PrincipalId': 'string', 'CustomPermissionsName': 'string', 'ExternalLoginFederationProviderType': 'string', 'ExternalLoginFederationProviderUrl': 'string', 'ExternalLoginId': 'string' }, 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **User** *(dict) --* The user name. * **Arn** *(string) --* The Amazon Resource Name (ARN) for the user. * **UserName** *(string) --* The user's user name. This value is required if you are registering a user that will be managed in Amazon QuickSight. In the output, the value for "UserName" is "N/A" when the value for "IdentityType" is "IAM" and the corresponding IAM user is deleted. * **Email** *(string) --* The user's email address. * **Role** *(string) --* The Amazon QuickSight role for the user. The user role can be one of the following:. * "READER": A user who has read-only access to dashboards. * "AUTHOR": A user who can create data sources, datasets, analyses, and dashboards. * "ADMIN": A user who is an author, who can also manage Amazon Amazon QuickSight settings. * "READER_PRO": Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Amazon QuickSight, can build stories with Amazon Q, and can generate executive summaries from dashboards. * "AUTHOR_PRO": Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&A, and generate executive summaries from dashboards. * "ADMIN_PRO": Admin Pros are Author Pros who can also manage Amazon QuickSight administrative settings. Admin Pro users are billed at Author Pro pricing. * "RESTRICTED_READER": This role isn't currently available for use. * "RESTRICTED_AUTHOR": This role isn't currently available for use. * **IdentityType** *(string) --* The type of identity authentication used by the user. * **Active** *(boolean) --* The active status of user. When you create an Amazon QuickSight user that's not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a password. * **PrincipalId** *(string) --* The principal ID of the user. * **CustomPermissionsName** *(string) --* The custom permissions profile associated with this user. * **ExternalLoginFederationProviderType** *(string) --* The type of supported external login provider that provides identity to let the user federate into Amazon QuickSight with an associated IAM role. The type can be one of the following. * "COGNITO": Amazon Cognito. The provider URL is cognito- identity.amazonaws.com. * "CUSTOM_OIDC": Custom OpenID Connect (OIDC) provider. * **ExternalLoginFederationProviderUrl** *(string) --* The URL of the external login provider. * **ExternalLoginId** *(string) --* The identity ID for the user in the external login provider. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.PreconditionNotMetException" * "QuickSight.Client.exceptions.InternalFailureException" * "QuickSight.Client.exceptions.ResourceUnavailableException" QuickSight / Client / describe_analysis describe_analysis ***************** QuickSight.Client.describe_analysis(**kwargs) Provides a summary of the metadata for an analysis. See also: AWS API Documentation **Request Syntax** response = client.describe_analysis( AwsAccountId='string', AnalysisId='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** 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. * **AnalysisId** (*string*) -- **[REQUIRED]** The ID of the analysis that you're describing. The ID is part of the URL of the analysis. Return type: dict Returns: **Response Syntax** { 'Analysis': { 'AnalysisId': 'string', 'Arn': 'string', 'Name': 'string', 'Status': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED', 'Errors': [ { 'Type': 'ACCESS_DENIED'|'SOURCE_NOT_FOUND'|'DATA_SET_NOT_FOUND'|'INTERNAL_FAILURE'|'PARAMETER_VALUE_INCOMPATIBLE'|'PARAMETER_TYPE_INVALID'|'PARAMETER_NOT_FOUND'|'COLUMN_TYPE_MISMATCH'|'COLUMN_GEOGRAPHIC_ROLE_MISMATCH'|'COLUMN_REPLACEMENT_MISSING', 'Message': 'string', 'ViolatedEntities': [ { 'Path': 'string' }, ] }, ], 'DataSetArns': [ 'string', ], 'ThemeArn': 'string', 'CreatedTime': datetime(2015, 1, 1), 'LastUpdatedTime': datetime(2015, 1, 1), 'Sheets': [ { 'SheetId': 'string', 'Name': 'string', 'Images': [ { 'SheetImageId': 'string', 'Source': { 'SheetImageStaticFileSource': { 'StaticFileId': 'string' } }, 'Scaling': { 'ScalingType': 'SCALE_TO_WIDTH'|'SCALE_TO_HEIGHT'|'SCALE_TO_CONTAINER'|'SCALE_NONE' }, 'Tooltip': { 'TooltipText': { 'PlainText': 'string' }, 'Visibility': 'HIDDEN'|'VISIBLE' }, 'ImageContentAltText': 'string', 'Interactions': { 'ImageMenuOption': { 'AvailabilityStatus': 'ENABLED'|'DISABLED' } }, 'Actions': [ { 'CustomActionId': 'string', 'Name': 'string', 'Status': 'ENABLED'|'DISABLED', 'Trigger': 'CLICK'|'MENU', 'ActionOperations': [ { 'NavigationOperation': { 'LocalNavigationConfiguration': { 'TargetSheetId': 'string' } }, 'URLOperation': { 'URLTemplate': 'string', 'URLTarget': 'NEW_TAB'|'NEW_WINDOW'|'SAME_TAB' }, 'SetParametersOperation': { 'ParameterValueConfigurations': [ { 'DestinationParameterName': 'string', 'Value': { 'CustomValuesConfiguration': { 'IncludeNullValue': True|False, 'CustomValues': { 'StringValues': [ 'string', ], 'IntegerValues': [ 123, ], 'DecimalValues': [ 123.0, ], 'DateTimeValues': [ datetime(2015, 1, 1), ] } }, 'SelectAllValueOptions': 'ALL_VALUES', 'SourceParameterName': 'string', 'SourceField': 'string', 'SourceColumn': { 'DataSetIdentifier': 'string', 'ColumnName': 'string' } } }, ] } }, ] }, ] }, ] }, ] }, 'Status': 123, 'RequestId': 'string' } **Response Structure** * *(dict) --* * **Analysis** *(dict) --* A metadata structure that contains summary information for the analysis that you're describing. * **AnalysisId** *(string) --* The ID of the analysis. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the analysis. * **Name** *(string) --* The descriptive name of the analysis. * **Status** *(string) --* Status associated with the analysis. * **Errors** *(list) --* Errors associated with the analysis. * *(dict) --* Analysis error. * **Type** *(string) --* The type of the analysis error. * **Message** *(string) --* The message associated with the analysis error. * **ViolatedEntities** *(list) --* Lists the violated entities that caused the analysis error * *(dict) --* An object, structure, or sub-structure of an analysis, template, or dashboard. * **Path** *(string) --* The hierarchical path of the entity within the analysis, template, or dashboard definition tree. * **DataSetArns** *(list) --* The ARNs of the datasets of the analysis. * *(string) --* * **ThemeArn** *(string) --* The ARN of the theme of the analysis. * **CreatedTime** *(datetime) --* The time that the analysis was created. * **LastUpdatedTime** *(datetime) --* The time that the analysis was last updated. * **Sheets** *(list) --* A list of the associated sheets with the unique identifier and name of each sheet. * *(dict) --* A *sheet*, which is an object that contains a set of visuals that are viewed together on one page in Amazon QuickSight. Every analysis and dashboard contains at least one sheet. Each sheet contains at least one visualization widget, for example a chart, pivot table, or narrative insight. Sheets can be associated with other components, such as controls, filters, and so on. * **SheetId** *(string) --* The unique identifier associated with a sheet. * **Name** *(string) --* The name of a sheet. This name is displayed on the sheet's tab in the Amazon QuickSight console. * **Images** *(list) --* A list of images on a sheet. * *(dict) --* An image that is located on a sheet. * **SheetImageId** *(string) --* The ID of the sheet image. * **Source** *(dict) --* The source of the image. * **SheetImageStaticFileSource** *(dict) --* The source of the static file that contains the image. * **StaticFileId** *(string) --* The ID of the static file that contains the image. * **Scaling** *(dict) --* Determines how the image is scaled. * **ScalingType** *(string) --* The scaling option to use when fitting the image inside the container. Valid values are defined as follows: * "SCALE_TO_WIDTH": The image takes up the entire width of the container. The image aspect ratio is preserved. * "SCALE_TO_HEIGHT": The image takes up the entire height of the container. The image aspect ratio is preserved. * "SCALE_TO_CONTAINER": The image takes up the entire width and height of the container. The image aspect ratio is not preserved. * "SCALE_NONE": The image is displayed in its original size and is not scaled to the container. * **Tooltip** *(dict) --* The tooltip to be shown when hovering over the image. * **TooltipText** *(dict) --* The text that appears in the tooltip. * **PlainText** *(string) --* The plain text format. * **Visibility** *(string) --* The visibility of the tooltip. * **ImageContentAltText** *(string) --* The alt text for the image. * **Interactions** *(dict) --* The general image interactions setup for an image. * **ImageMenuOption** *(dict) --* The menu options for the image. * **AvailabilityStatus** *(string) --* The availability status of the image menu. If the value of this property is set to "ENABLED", dashboard readers can interact with the image menu. * **Actions** *(list) --* A list of custom actions that are configured for an image. * *(dict) --* A custom action defined on an image. * **CustomActionId** *(string) --* The ID of the custom action. * **Name** *(string) --* The name of the custom action. * **Status** *(string) --* The status of the custom action. * **Trigger** *(string) --* The trigger of the "VisualCustomAction". Valid values are defined as follows: * "CLICK": Initiates a custom action by a left pointer click on a data point. * "MENU": Initiates a custom action by right pointer click from the menu. * **ActionOperations** *(list) --* A list of "ImageCustomActionOperations". This is a union type structure. For this structure to be valid, only one of the attributes can be defined. * *(dict) --* The operation that is defined by the custom action. This is a union type structure. For this structure to be valid, only one of the attributes can be defined. * **NavigationOperation** *(dict) --* The navigation operation that navigates between different sheets in the same analysis. This is a union type structure. For this structure to be valid, only one of the attributes can be defined. * **LocalNavigationConfiguration** *(dict) --* The configuration that chooses the navigation target. * **TargetSheetId** *(string) --* The sheet that is targeted for navigation in the same analysis. * **URLOperation** *(dict) --* The URL operation that opens a link to another webpage. * **URLTemplate** *(string) --* THe URL link of the "CustomActionURLOperation". * **URLTarget** *(string) --* The target of the "CustomActionURLOperation". Valid values are defined as follows: * "NEW_TAB": Opens the target URL in a new browser tab. * "NEW_WINDOW": Opens the target URL in a new browser window. * "SAME_TAB": Opens the target URL in the same browser tab. * **SetParametersOperation** *(dict) --* The set parameter operation that sets parameters in custom action. * **ParameterValueConfigurations** *(list) --* The parameter that determines the value configuration. * *(dict) --* The configuration of adding parameters in action. * **DestinationParameterName** *(string) --* The destination parameter name of the "SetParameterValueConfiguration". * **Value** *(dict) --* The configuration of destination parameter values. This is a union type structure. For this structure to be valid, only one of the attributes can be defined. * **CustomValuesConfiguration** *(dict) --* The configuration of custom values for destination parameter in "Des tinationParameterValueConfigurati on". * **IncludeNullValue** *(boolean) --* Includes the null value in custom action parameter values. * **CustomValues** *(dict) --* The customized parameter values. This is a union type structure. For this structure to be valid, only one of the attributes can be defined. * **StringValues** *(list) --* A list of string-type parameter values. * *(string) --* * **IntegerValues** *(list) --* A list of integer-type parameter values. * *(integer) --* * **DecimalValues** *(list) --* A list of decimal-type parameter values. * *(float) --* * **DateTimeValues** *(list) --* A list of datetime-type parameter values. * *(datetime) --* * **SelectAllValueOptions** *(string) --* The configuration that selects all options. * **SourceParameterName** *(string) --* The source parameter name of the destination parameter. * **SourceField** *(string) --* The source field ID of the destination parameter. * **SourceColumn** *(dict) --* A column of a data set. * **DataSetIdentifier** *(string) --* The data set that the column belongs to. * **ColumnName** *(string) --* The name of the column. * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / list_analyses list_analyses ************* QuickSight.Client.list_analyses(**kwargs) Lists Amazon QuickSight analyses that exist in the specified Amazon Web Services account. See also: AWS API Documentation **Request Syntax** response = client.list_analyses( AwsAccountId='string', NextToken='string', MaxResults=123 ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the analyses. * **NextToken** (*string*) -- A pagination token that can be used in a subsequent request. * **MaxResults** (*integer*) -- The maximum number of results to return. Return type: dict Returns: **Response Syntax** { 'AnalysisSummaryList': [ { 'Arn': 'string', 'AnalysisId': 'string', 'Name': 'string', 'Status': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED', 'CreatedTime': datetime(2015, 1, 1), 'LastUpdatedTime': datetime(2015, 1, 1) }, ], 'NextToken': 'string', 'Status': 123, 'RequestId': 'string' } **Response Structure** * *(dict) --* * **AnalysisSummaryList** *(list) --* Metadata describing each of the analyses that are listed. * *(dict) --* The summary metadata that describes an analysis. * **Arn** *(string) --* The Amazon Resource Name (ARN) for the analysis. * **AnalysisId** *(string) --* The ID of the analysis. This ID displays in the URL. * **Name** *(string) --* The name of the analysis. This name is displayed in the Amazon QuickSight console. * **Status** *(string) --* The last known status for the analysis. * **CreatedTime** *(datetime) --* The time that the analysis was created. * **LastUpdatedTime** *(datetime) --* The time that the analysis was last updated. * **NextToken** *(string) --* A pagination token that can be used in a subsequent request. * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InvalidNextTokenException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / delete_topic delete_topic ************ QuickSight.Client.delete_topic(**kwargs) Deletes a topic. See also: AWS API Documentation **Request Syntax** response = client.delete_topic( AwsAccountId='string', TopicId='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the topic that you want to delete. * **TopicId** (*string*) -- **[REQUIRED]** The ID of the topic that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. Return type: dict Returns: **Response Syntax** { 'Arn': 'string', 'TopicId': 'string', 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **Arn** *(string) --* The Amazon Resource Name (ARN) of the topic. * **TopicId** *(string) --* The ID of the topic that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / update_template_alias update_template_alias ********************* QuickSight.Client.update_template_alias(**kwargs) Updates the template alias of a template. See also: AWS API Documentation **Request Syntax** response = client.update_template_alias( AwsAccountId='string', TemplateId='string', AliasName='string', TemplateVersionNumber=123 ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the template alias that you're updating. * **TemplateId** (*string*) -- **[REQUIRED]** The ID for the template. * **AliasName** (*string*) -- **[REQUIRED]** 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. * **TemplateVersionNumber** (*integer*) -- **[REQUIRED]** The version number of the template. Return type: dict Returns: **Response Syntax** { 'TemplateAlias': { 'AliasName': 'string', 'Arn': 'string', 'TemplateVersionNumber': 123 }, 'Status': 123, 'RequestId': 'string' } **Response Structure** * *(dict) --* * **TemplateAlias** *(dict) --* The template alias. * **AliasName** *(string) --* The display name of the template alias. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the template alias. * **TemplateVersionNumber** *(integer) --* The version number of the template alias. * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / list_iam_policy_assignments list_iam_policy_assignments *************************** QuickSight.Client.list_iam_policy_assignments(**kwargs) Lists the IAM policy assignments in the current Amazon QuickSight account. See also: AWS API Documentation **Request Syntax** response = client.list_iam_policy_assignments( AwsAccountId='string', AssignmentStatus='ENABLED'|'DRAFT'|'DISABLED', Namespace='string', NextToken='string', MaxResults=123 ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains these IAM policy assignments. * **AssignmentStatus** (*string*) -- The status of the assignments. * **Namespace** (*string*) -- **[REQUIRED]** The namespace for the assignments. * **NextToken** (*string*) -- The token for the next set of results, or null if there are no more results. * **MaxResults** (*integer*) -- The maximum number of results to be returned per request. Return type: dict Returns: **Response Syntax** { 'IAMPolicyAssignments': [ { 'AssignmentName': 'string', 'AssignmentStatus': 'ENABLED'|'DRAFT'|'DISABLED' }, ], 'NextToken': 'string', 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **IAMPolicyAssignments** *(list) --* Information describing the IAM policy assignments. * *(dict) --* IAM policy assignment summary. * **AssignmentName** *(string) --* Assignment name. * **AssignmentStatus** *(string) --* Assignment status. * **NextToken** *(string) --* The token for the next set of results, or null if there are no more results. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InvalidNextTokenException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / update_default_q_business_application update_default_q_business_application ************************************* QuickSight.Client.update_default_q_business_application(**kwargs) Updates a Amazon Q Business application that is linked to a Amazon QuickSight account. See also: AWS API Documentation **Request Syntax** response = client.update_default_q_business_application( AwsAccountId='string', Namespace='string', ApplicationId='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon QuickSight account that is connected to the Amazon Q Business application that you want to update. * **Namespace** (*string*) -- The Amazon QuickSight namespace that contains the linked Amazon Q Business application. If this field is left blank, the default namespace is used. Currently, the default namespace is the only valid value for this parameter. * **ApplicationId** (*string*) -- **[REQUIRED]** The ID of the Amazon Q Business application that you want to update. Return type: dict Returns: **Response Syntax** { 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / update_theme update_theme ************ QuickSight.Client.update_theme(**kwargs) Updates a theme. See also: AWS API Documentation **Request Syntax** response = client.update_theme( AwsAccountId='string', ThemeId='string', Name='string', BaseThemeId='string', VersionDescription='string', Configuration={ 'DataColorPalette': { 'Colors': [ 'string', ], 'MinMaxGradient': [ 'string', ], 'EmptyFillColor': 'string' }, 'UIColorPalette': { 'PrimaryForeground': 'string', 'PrimaryBackground': 'string', 'SecondaryForeground': 'string', 'SecondaryBackground': 'string', 'Accent': 'string', 'AccentForeground': 'string', 'Danger': 'string', 'DangerForeground': 'string', 'Warning': 'string', 'WarningForeground': 'string', 'Success': 'string', 'SuccessForeground': 'string', 'Dimension': 'string', 'DimensionForeground': 'string', 'Measure': 'string', 'MeasureForeground': 'string' }, 'Sheet': { 'Tile': { 'Border': { 'Show': True|False } }, 'TileLayout': { 'Gutter': { 'Show': True|False }, 'Margin': { 'Show': True|False } } }, 'Typography': { 'FontFamilies': [ { 'FontFamily': 'string' }, ] } } ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the theme that you're updating. * **ThemeId** (*string*) -- **[REQUIRED]** The ID for the theme. * **Name** (*string*) -- The name for the theme. * **BaseThemeId** (*string*) -- **[REQUIRED]** The theme ID, defined by Amazon QuickSight, that a custom theme inherits from. All themes initially inherit from a default Amazon QuickSight theme. * **VersionDescription** (*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** (*dict*) -- The theme configuration, which contains the theme display properties. * **DataColorPalette** *(dict) --* Color properties that apply to chart data colors. * **Colors** *(list) --* The hexadecimal codes for the colors. * *(string) --* * **MinMaxGradient** *(list) --* The minimum and maximum hexadecimal codes that describe a color gradient. * *(string) --* * **EmptyFillColor** *(string) --* The hexadecimal code of a color that applies to charts where a lack of data is highlighted. * **UIColorPalette** *(dict) --* Color properties that apply to the UI and to charts, excluding the colors that apply to data. * **PrimaryForeground** *(string) --* The color of text and other foreground elements that appear over the primary background regions, such as grid lines, borders, table banding, icons, and so on. * **PrimaryBackground** *(string) --* The background color that applies to visuals and other high emphasis UI. * **SecondaryForeground** *(string) --* The foreground color that applies to any sheet title, sheet control text, or UI that appears over the secondary background. * **SecondaryBackground** *(string) --* The background color that applies to the sheet background and sheet controls. * **Accent** *(string) --* This color is that applies to selected states and buttons. * **AccentForeground** *(string) --* The foreground color that applies to any text or other elements that appear over the accent color. * **Danger** *(string) --* The color that applies to error messages. * **DangerForeground** *(string) --* The foreground color that applies to any text or other elements that appear over the error color. * **Warning** *(string) --* This color that applies to warning and informational messages. * **WarningForeground** *(string) --* The foreground color that applies to any text or other elements that appear over the warning color. * **Success** *(string) --* The color that applies to success messages, for example the check mark for a successful download. * **SuccessForeground** *(string) --* The foreground color that applies to any text or other elements that appear over the success color. * **Dimension** *(string) --* The color that applies to the names of fields that are identified as dimensions. * **DimensionForeground** *(string) --* The foreground color that applies to any text or other elements that appear over the dimension color. * **Measure** *(string) --* The color that applies to the names of fields that are identified as measures. * **MeasureForeground** *(string) --* The foreground color that applies to any text or other elements that appear over the measure color. * **Sheet** *(dict) --* Display options related to sheets. * **Tile** *(dict) --* The display options for tiles. * **Border** *(dict) --* The border around a tile. * **Show** *(boolean) --* The option to enable display of borders for visuals. * **TileLayout** *(dict) --* The layout options for tiles. * **Gutter** *(dict) --* The gutter settings that apply between tiles. * **Show** *(boolean) --* This Boolean value controls whether to display a gutter space between sheet tiles. * **Margin** *(dict) --* The margin settings that apply around the outside edge of sheets. * **Show** *(boolean) --* This Boolean value controls whether to display sheet margins. * **Typography** *(dict) --* Determines the typography options. * **FontFamilies** *(list) --* Determines the list of font families. * *(dict) --* Determines the font settings. * **FontFamily** *(string) --* Determines the font family settings. Return type: dict Returns: **Response Syntax** { 'ThemeId': 'string', 'Arn': 'string', 'VersionArn': 'string', 'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED', 'Status': 123, 'RequestId': 'string' } **Response Structure** * *(dict) --* * **ThemeId** *(string) --* The ID for the theme. * **Arn** *(string) --* The Amazon Resource Name (ARN) for the theme. * **VersionArn** *(string) --* The Amazon Resource Name (ARN) for the new version of the theme. * **CreationStatus** *(string) --* The creation status of the theme. * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.LimitExceededException" * "QuickSight.Client.exceptions.ResourceExistsException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / describe_template_definition describe_template_definition **************************** QuickSight.Client.describe_template_definition(**kwargs) Provides a detailed description of the definition of a template. Note: If you do not need to know details about the content of a template, for instance if you are trying to check the status of a recently created or updated template, use the DescribeTemplate instead. See also: AWS API Documentation **Request Syntax** response = client.describe_template_definition( AwsAccountId='string', TemplateId='string', VersionNumber=123, AliasName='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the template. You must be using the Amazon Web Services account that the template is in. * **TemplateId** (*string*) -- **[REQUIRED]** The ID of the template that you're describing. * **VersionNumber** (*integer*) -- The version number of the template. * **AliasName** (*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. Return type: dict Returns: **Response Syntax** # This section is too large to render. # Please see the AWS API Documentation linked below. AWS API Documentation **Response Structure** # This section is too large to render. # Please see the AWS API Documentation linked below. AWS API Documentation **Exceptions** * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.ResourceExistsException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / predict_qa_results predict_qa_results ****************** QuickSight.Client.predict_qa_results(**kwargs) Predicts existing visuals or generates new visuals to answer a given query. This API uses trusted identity propagation to ensure that an end user is authenticated and receives the embed URL that is specific to that user. The IAM Identity Center application that the user has logged into needs to have trusted Identity Propagation enabled for Amazon QuickSight with the scope value set to "quicksight:read". Before you use this action, make sure that you have configured the relevant Amazon QuickSight resource and permissions. We recommend enabling the "QSearchStatus" API to unlock the full potential of "PredictQnA". When "QSearchStatus" is enabled, it first checks the specified dashboard for any existing visuals that match the question. If no matching visuals are found, "PredictQnA" uses generative Q&A to provide an answer. To update the "QSearchStatus", see UpdateQuickSightQSearchConfiguration. See also: AWS API Documentation **Request Syntax** response = client.predict_qa_results( AwsAccountId='string', QueryText='string', IncludeQuickSightQIndex='INCLUDE'|'EXCLUDE', IncludeGeneratedAnswer='INCLUDE'|'EXCLUDE', MaxTopicsToConsider=123 ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that the user wants to execute Predict QA results in. * **QueryText** (*string*) -- **[REQUIRED]** The query text to be used to predict QA results. * **IncludeQuickSightQIndex** (*string*) -- Indicates whether Q indicies are included or excluded. * **IncludeGeneratedAnswer** (*string*) -- Indicates whether generated answers are included or excluded. * **MaxTopicsToConsider** (*integer*) -- The number of maximum topics to be considered to predict QA results. Return type: dict Returns: **Response Syntax** { 'PrimaryResult': { 'ResultType': 'DASHBOARD_VISUAL'|'GENERATED_ANSWER'|'NO_ANSWER', 'DashboardVisual': { 'DashboardId': 'string', 'DashboardName': 'string', 'SheetId': 'string', 'SheetName': 'string', 'VisualId': 'string', 'VisualTitle': 'string', 'VisualSubtitle': 'string', 'DashboardUrl': 'string' }, 'GeneratedAnswer': { 'QuestionText': 'string', 'AnswerStatus': 'ANSWER_GENERATED'|'ANSWER_RETRIEVED'|'ANSWER_DOWNGRADE', 'TopicId': 'string', 'TopicName': 'string', 'Restatement': 'string', 'QuestionId': 'string', 'AnswerId': 'string', 'QuestionUrl': 'string' } }, 'AdditionalResults': [ { 'ResultType': 'DASHBOARD_VISUAL'|'GENERATED_ANSWER'|'NO_ANSWER', 'DashboardVisual': { 'DashboardId': 'string', 'DashboardName': 'string', 'SheetId': 'string', 'SheetName': 'string', 'VisualId': 'string', 'VisualTitle': 'string', 'VisualSubtitle': 'string', 'DashboardUrl': 'string' }, 'GeneratedAnswer': { 'QuestionText': 'string', 'AnswerStatus': 'ANSWER_GENERATED'|'ANSWER_RETRIEVED'|'ANSWER_DOWNGRADE', 'TopicId': 'string', 'TopicName': 'string', 'Restatement': 'string', 'QuestionId': 'string', 'AnswerId': 'string', 'QuestionUrl': 'string' } }, ], 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **PrimaryResult** *(dict) --* The primary visual response. * **ResultType** *(string) --* The type of QA result. * **DashboardVisual** *(dict) --* The representation of a dashboard visual result. * **DashboardId** *(string) --* The ID of the dashboard. * **DashboardName** *(string) --* The name of the dashboard. * **SheetId** *(string) --* The ID of the sheet. * **SheetName** *(string) --* The name of the sheet. * **VisualId** *(string) --* The ID of the visual. * **VisualTitle** *(string) --* The title of the visual. * **VisualSubtitle** *(string) --* The subtitle of the visual. * **DashboardUrl** *(string) --* The URL of the dashboard. * **GeneratedAnswer** *(dict) --* The representation of a generated answer result. * **QuestionText** *(string) --* The question text. * **AnswerStatus** *(string) --* The answer status of the generated answer. * **TopicId** *(string) --* The ID of the topic. * **TopicName** *(string) --* The name of the topic. * **Restatement** *(string) --* The restatement for the answer. * **QuestionId** *(string) --* The ID of the question. * **AnswerId** *(string) --* The ID of the answer. * **QuestionUrl** *(string) --* The URL of the question. * **AdditionalResults** *(list) --* Additional visual responses. * *(dict) --* The QA result that is made from the "DashboardVisual" or "GeneratedAnswer". * **ResultType** *(string) --* The type of QA result. * **DashboardVisual** *(dict) --* The representation of a dashboard visual result. * **DashboardId** *(string) --* The ID of the dashboard. * **DashboardName** *(string) --* The name of the dashboard. * **SheetId** *(string) --* The ID of the sheet. * **SheetName** *(string) --* The name of the sheet. * **VisualId** *(string) --* The ID of the visual. * **VisualTitle** *(string) --* The title of the visual. * **VisualSubtitle** *(string) --* The subtitle of the visual. * **DashboardUrl** *(string) --* The URL of the dashboard. * **GeneratedAnswer** *(dict) --* The representation of a generated answer result. * **QuestionText** *(string) --* The question text. * **AnswerStatus** *(string) --* The answer status of the generated answer. * **TopicId** *(string) --* The ID of the topic. * **TopicName** *(string) --* The name of the topic. * **Restatement** *(string) --* The restatement for the answer. * **QuestionId** *(string) --* The ID of the question. * **AnswerId** *(string) --* The ID of the answer. * **QuestionUrl** *(string) --* The URL of the question. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / describe_topic_permissions describe_topic_permissions ************************** QuickSight.Client.describe_topic_permissions(**kwargs) Describes the permissions of a topic. See also: AWS API Documentation **Request Syntax** response = client.describe_topic_permissions( AwsAccountId='string', TopicId='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the topic that you want described. * **TopicId** (*string*) -- **[REQUIRED]** The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. Return type: dict Returns: **Response Syntax** { 'TopicId': 'string', 'TopicArn': 'string', 'Permissions': [ { 'Principal': 'string', 'Actions': [ 'string', ] }, ], 'Status': 123, 'RequestId': 'string' } **Response Structure** * *(dict) --* * **TopicId** *(string) --* The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. * **TopicArn** *(string) --* The Amazon Resource Name (ARN) of the topic. * **Permissions** *(list) --* A list of resource permissions that are configured to the topic. * *(dict) --* Permission for the resource. * **Principal** *(string) --* The Amazon Resource Name (ARN) of the principal. This can be one of the following: * The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.) * The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.) * The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.) * **Actions** *(list) --* The IAM action to grant or revoke permissions on. * *(string) --* * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / create_group create_group ************ QuickSight.Client.create_group(**kwargs) Use the "CreateGroup" operation to create a group in Amazon QuickSight. You can create up to 10,000 groups in a namespace. If you want to create more than 10,000 groups in a namespace, contact Amazon Web Services Support. The permissions resource is >>``<::group/default/ >>``<<. The response is a group object. See also: AWS API Documentation **Request Syntax** response = client.create_group( GroupName='string', Description='string', AwsAccountId='string', Namespace='string' ) Parameters: * **GroupName** (*string*) -- **[REQUIRED]** A name for the group that you want to create. * **Description** (*string*) -- A description for the group that you want to create. * **AwsAccountId** (*string*) -- **[REQUIRED]** 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** (*string*) -- **[REQUIRED]** The namespace that you want the group to be a part of. Return type: dict Returns: **Response Syntax** { 'Group': { 'Arn': 'string', 'GroupName': 'string', 'Description': 'string', 'PrincipalId': 'string' }, 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* The response object for this operation. * **Group** *(dict) --* The name of the group. * **Arn** *(string) --* The Amazon Resource Name (ARN) for the group. * **GroupName** *(string) --* The name of the group. * **Description** *(string) --* The group description. * **PrincipalId** *(string) --* The principal ID of the group. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceExistsException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.PreconditionNotMetException" * "QuickSight.Client.exceptions.LimitExceededException" * "QuickSight.Client.exceptions.InternalFailureException" * "QuickSight.Client.exceptions.ResourceUnavailableException" QuickSight / Client / update_analysis update_analysis *************** QuickSight.Client.update_analysis(**kwargs) Updates an analysis in Amazon QuickSight See also: AWS API Documentation **Request Syntax** # This section is too large to render. # Please see the AWS API Documentation linked below. AWS API Documentation **Parameters** # This section is too large to render. # Please see the AWS API Documentation linked below. AWS API Documentation Return type: dict Returns: **Response Syntax** { 'Arn': 'string', 'AnalysisId': 'string', 'UpdateStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED', 'Status': 123, 'RequestId': 'string' } **Response Structure** * *(dict) --* * **Arn** *(string) --* The ARN of the analysis that you're updating. * **AnalysisId** *(string) --* The ID of the analysis. * **UpdateStatus** *(string) --* The update status of the last update that was made to the analysis. * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.ResourceExistsException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / describe_asset_bundle_export_job describe_asset_bundle_export_job ******************************** QuickSight.Client.describe_asset_bundle_export_job(**kwargs) Describes an existing export job. Poll job descriptions after a job starts to know the status of the job. When a job succeeds, a URL is provided to download the exported assets' data from. Download URLs are valid for five minutes after they are generated. You can call the "DescribeAssetBundleExportJob" API for a new download URL as needed. Job descriptions are available for 14 days after the job starts. See also: AWS API Documentation **Request Syntax** response = client.describe_asset_bundle_export_job( AwsAccountId='string', AssetBundleExportJobId='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account the export job is executed in. * **AssetBundleExportJobId** (*string*) -- **[REQUIRED]** The ID of the job that you want described. The job ID is set when you start a new job with a "StartAssetBundleExportJob" API call. Return type: dict Returns: **Response Syntax** { 'JobStatus': 'QUEUED_FOR_IMMEDIATE_EXECUTION'|'IN_PROGRESS'|'SUCCESSFUL'|'FAILED', 'DownloadUrl': 'string', 'Errors': [ { 'Arn': 'string', 'Type': 'string', 'Message': 'string' }, ], 'Arn': 'string', 'CreatedTime': datetime(2015, 1, 1), 'AssetBundleExportJobId': 'string', 'AwsAccountId': 'string', 'ResourceArns': [ 'string', ], 'IncludeAllDependencies': True|False, 'ExportFormat': 'CLOUDFORMATION_JSON'|'QUICKSIGHT_JSON', 'CloudFormationOverridePropertyConfiguration': { 'ResourceIdOverrideConfiguration': { 'PrefixForAllResources': True|False }, 'VPCConnections': [ { 'Arn': 'string', 'Properties': [ 'Name'|'DnsResolvers'|'RoleArn', ] }, ], 'RefreshSchedules': [ { 'Arn': 'string', 'Properties': [ 'StartAfterDateTime', ] }, ], 'DataSources': [ { 'Arn': 'string', 'Properties': [ 'Name'|'DisableSsl'|'SecretArn'|'Username'|'Password'|'Domain'|'WorkGroup'|'Host'|'Port'|'Database'|'DataSetName'|'Catalog'|'InstanceId'|'ClusterId'|'ManifestFileLocation'|'Warehouse'|'RoleArn'|'ProductType', ] }, ], 'DataSets': [ { 'Arn': 'string', 'Properties': [ 'Name'|'RefreshFailureEmailAlertStatus', ] }, ], 'Themes': [ { 'Arn': 'string', 'Properties': [ 'Name', ] }, ], 'Analyses': [ { 'Arn': 'string', 'Properties': [ 'Name', ] }, ], 'Dashboards': [ { 'Arn': 'string', 'Properties': [ 'Name', ] }, ], 'Folders': [ { 'Arn': 'string', 'Properties': [ 'Name'|'ParentFolderArn', ] }, ] }, 'RequestId': 'string', 'Status': 123, 'IncludePermissions': True|False, 'IncludeTags': True|False, 'ValidationStrategy': { 'StrictModeForAllResources': True|False }, 'Warnings': [ { 'Arn': 'string', 'Message': 'string' }, ], 'IncludeFolderMemberships': True|False, 'IncludeFolderMembers': 'RECURSE'|'ONE_LEVEL'|'NONE' } **Response Structure** * *(dict) --* * **JobStatus** *(string) --* Indicates the status of a job through its queuing and execution. Poll this "DescribeAssetBundleExportApi" until "JobStatus" is either "SUCCESSFUL" or "FAILED". * **DownloadUrl** *(string) --* The URL to download the exported asset bundle data from. This URL is available only after the job has succeeded. This URL is valid for 5 minutes after issuance. Call "DescribeAssetBundleExportJob" again for a fresh URL if needed. The downloaded asset bundle is a zip file named "assetbundle-{jobId}.qs". The file has a ".qs" extension. This URL can't be used in a "StartAssetBundleImportJob" API call and should only be used for download purposes. * **Errors** *(list) --* An array of error records that describes any failures that occurred during the export job processing. Error records accumulate while the job runs. The complete set of error records is available after the job has completed and failed. * *(dict) --* Describes an error that occurred during an Asset Bundle export job. * **Arn** *(string) --* The ARN of the resource whose processing caused an error. * **Type** *(string) --* The specific error type of the error that occurred. * **Message** *(string) --* A description of the error. * **Arn** *(string) --* The Amazon Resource Name (ARN) for the export job. * **CreatedTime** *(datetime) --* The time that the export job was created. * **AssetBundleExportJobId** *(string) --* The ID of the job. The job ID is set when you start a new job with a "StartAssetBundleExportJob" API call. * **AwsAccountId** *(string) --* The ID of the Amazon Web Services account that the export job was executed in. * **ResourceArns** *(list) --* A list of resource ARNs that exported with the job. * *(string) --* * **IncludeAllDependencies** *(boolean) --* The include dependencies flag. * **ExportFormat** *(string) --* The format of the exported asset bundle. A "QUICKSIGHT_JSON" formatted file can be used to make a "StartAssetBundleImportJob" API call. A "CLOUDFORMATION_JSON" formatted file can be used in the CloudFormation console and with the CloudFormation APIs. * **CloudFormationOverridePropertyConfiguration** *(dict) --* The CloudFormation override property configuration for the export job. * **ResourceIdOverrideConfiguration** *(dict) --* An optional list of structures that control how resource IDs are parameterized in the returned CloudFormation template. * **PrefixForAllResources** *(boolean) --* An option to request a CloudFormation variable for a prefix to be prepended to each resource's ID before import. The prefix is only added to the asset IDs and does not change the name of the asset. * **VPCConnections** *(list) --* An optional list of structures that control how "VPCConnection" resources are parameterized in the returned CloudFormation template. * *(dict) --* Controls how a specific "VPCConnection" resource is parameterized in the outputted CloudFormation template. * **Arn** *(string) --* The ARN of the specific "VPCConnection" resource whose override properties are configured in this structure. * **Properties** *(list) --* A list of "VPCConnection" resource properties to generate variables for in the returned CloudFormation template. * *(string) --* * **RefreshSchedules** *(list) --* An optional list of structures that control how "RefreshSchedule" resources are parameterized in the returned CloudFormation template. * *(dict) --* Controls how a specific "RefreshSchedule" resource is parameterized in the returned CloudFormation template. * **Arn** *(string) --* The ARN of the specific "RefreshSchedule" resource whose override properties are configured in this structure. * **Properties** *(list) --* A list of "RefreshSchedule" resource properties to generate variables for in the returned CloudFormation template. * *(string) --* * **DataSources** *(list) --* An optional list of structures that control how "DataSource" resources are parameterized in the returned CloudFormation template. * *(dict) --* Controls how a specific "DataSource" resource is parameterized in the returned CloudFormation template. * **Arn** *(string) --* The ARN of the specific "DataSource" resource whose override properties are configured in this structure. * **Properties** *(list) --* A list of "DataSource" resource properties to generate variables for in the returned CloudFormation template. * *(string) --* * **DataSets** *(list) --* An optional list of structures that control how "DataSet" resources are parameterized in the returned CloudFormation template. * *(dict) --* Controls how a specific "DataSet" resource is parameterized in the returned CloudFormation template. * **Arn** *(string) --* The ARN of the specific "DataSet" resource whose override properties are configured in this structure. * **Properties** *(list) --* A list of "DataSet" resource properties to generate variables for in the returned CloudFormation template. * *(string) --* * **Themes** *(list) --* An optional list of structures that control how "Theme" resources are parameterized in the returned CloudFormation template. * *(dict) --* Controls how a specific "Theme" resource is parameterized in the returned CloudFormation template. * **Arn** *(string) --* The ARN of the specific "Theme" resource whose override properties are configured in this structure. * **Properties** *(list) --* A list of "Theme" resource properties to generate variables for in the returned CloudFormation template. * *(string) --* * **Analyses** *(list) --* An optional list of structures that control how "Analysis" resources are parameterized in the returned CloudFormation template. * *(dict) --* Controls how a specific "Analysis" resource is parameterized in the returned CloudFormation template. * **Arn** *(string) --* The ARN of the specific "Analysis" resource whose override properties are configured in this structure. * **Properties** *(list) --* A list of "Analysis" resource properties to generate variables for in the returned CloudFormation template. * *(string) --* * **Dashboards** *(list) --* An optional list of structures that control how "Dashboard" resources are parameterized in the returned CloudFormation template. * *(dict) --* Controls how a specific "Dashboard" resource is parameterized in the returned CloudFormation template. * **Arn** *(string) --* The ARN of the specific "Dashboard" resource whose override properties are configured in this structure. * **Properties** *(list) --* A list of "Dashboard" resource properties to generate variables for in the returned CloudFormation template. * *(string) --* * **Folders** *(list) --* An optional list of structures that controls how "Folder" resources are parameterized in the returned CloudFormation template. * *(dict) --* Controls how a specific "Folder" resource is parameterized in the returned CloudFormation template. * **Arn** *(string) --* The ARN of the specific "Folder" resource whose override properties are configured in this structure. * **Properties** *(list) --* A list of "Folder" resource properties to generate variables for in the returned CloudFormation template. * *(string) --* * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the response. * **IncludePermissions** *(boolean) --* The include permissions flag. * **IncludeTags** *(boolean) --* The include tags flag. * **ValidationStrategy** *(dict) --* The validation strategy that is used to export the analysis or dashboard. * **StrictModeForAllResources** *(boolean) --* A Boolean value that indicates whether to export resources under strict or lenient mode. * **Warnings** *(list) --* An array of warning records that describe the analysis or dashboard that is exported. This array includes UI errors that can be skipped during the validation process. This property only appears if "StrictModeForAllResources" in "ValidationStrategy" is set to "FALSE". * *(dict) --* Describes a warning that occurred during an Asset Bundle export job. * **Arn** *(string) --* The ARN of the resource whose processing caused a warning. * **Message** *(string) --* A description of the warning. * **IncludeFolderMemberships** *(boolean) --* The include folder memberships flag. * **IncludeFolderMembers** *(string) --* A setting that determines whether folder members are included. **Exceptions** * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.ResourceNotFoundException" QuickSight / Client / update_analysis_permissions update_analysis_permissions *************************** QuickSight.Client.update_analysis_permissions(**kwargs) Updates the read and write permissions for an analysis. See also: AWS API Documentation **Request Syntax** response = client.update_analysis_permissions( AwsAccountId='string', AnalysisId='string', GrantPermissions=[ { 'Principal': 'string', 'Actions': [ 'string', ] }, ], RevokePermissions=[ { 'Principal': 'string', 'Actions': [ 'string', ] }, ] ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** 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. * **AnalysisId** (*string*) -- **[REQUIRED]** The ID of the analysis whose permissions you're updating. The ID is part of the analysis URL. * **GrantPermissions** (*list*) -- A structure that describes the permissions to add and the principal to add them to. * *(dict) --* Permission for the resource. * **Principal** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the principal. This can be one of the following: * The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.) * The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.) * The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.) * **Actions** *(list) --* **[REQUIRED]** The IAM action to grant or revoke permissions on. * *(string) --* * **RevokePermissions** (*list*) -- A structure that describes the permissions to remove and the principal to remove them from. * *(dict) --* Permission for the resource. * **Principal** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the principal. This can be one of the following: * The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.) * The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.) * The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.) * **Actions** *(list) --* **[REQUIRED]** The IAM action to grant or revoke permissions on. * *(string) --* Return type: dict Returns: **Response Syntax** { 'AnalysisArn': 'string', 'AnalysisId': 'string', 'Permissions': [ { 'Principal': 'string', 'Actions': [ 'string', ] }, ], 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **AnalysisArn** *(string) --* The Amazon Resource Name (ARN) of the analysis that you updated. * **AnalysisId** *(string) --* The ID of the analysis that you updated permissions for. * **Permissions** *(list) --* A structure that describes the principals and the resource- level permissions on an analysis. * *(dict) --* Permission for the resource. * **Principal** *(string) --* The Amazon Resource Name (ARN) of the principal. This can be one of the following: * The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.) * The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.) * The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.) * **Actions** *(list) --* The IAM action to grant or revoke permissions on. * *(string) --* * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.LimitExceededException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / delete_folder_membership delete_folder_membership ************************ QuickSight.Client.delete_folder_membership(**kwargs) Removes an asset, such as a dashboard, analysis, or dataset, from a folder. See also: AWS API Documentation **Request Syntax** response = client.delete_folder_membership( AwsAccountId='string', FolderId='string', MemberId='string', MemberType='DASHBOARD'|'ANALYSIS'|'DATASET'|'DATASOURCE'|'TOPIC' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID for the Amazon Web Services account that contains the folder. * **FolderId** (*string*) -- **[REQUIRED]** The Folder ID. * **MemberId** (*string*) -- **[REQUIRED]** The ID of the asset that you want to delete. * **MemberType** (*string*) -- **[REQUIRED]** The member type of the asset that you want to delete from a folder. Return type: dict Returns: **Response Syntax** { 'Status': 123, 'RequestId': 'string' } **Response Structure** * *(dict) --* * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / delete_user_by_principal_id delete_user_by_principal_id *************************** QuickSight.Client.delete_user_by_principal_id(**kwargs) Deletes a user identified by its principal ID. See also: AWS API Documentation **Request Syntax** response = client.delete_user_by_principal_id( PrincipalId='string', AwsAccountId='string', Namespace='string' ) Parameters: * **PrincipalId** (*string*) -- **[REQUIRED]** The principal ID of the user. * **AwsAccountId** (*string*) -- **[REQUIRED]** 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** (*string*) -- **[REQUIRED]** The namespace. Currently, you should set this to "default". Return type: dict Returns: **Response Syntax** { 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.PreconditionNotMetException" * "QuickSight.Client.exceptions.InternalFailureException" * "QuickSight.Client.exceptions.ResourceUnavailableException" QuickSight / Client / update_q_personalization_configuration update_q_personalization_configuration ************************************** QuickSight.Client.update_q_personalization_configuration(**kwargs) Updates a personalization configuration. See also: AWS API Documentation **Request Syntax** response = client.update_q_personalization_configuration( AwsAccountId='string', PersonalizationMode='ENABLED'|'DISABLED' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account account that contains the personalization configuration that the user wants to update. * **PersonalizationMode** (*string*) -- **[REQUIRED]** An option to allow Amazon QuickSight to customize data stories with user specific metadata, specifically location and job information, in your IAM Identity Center instance. Return type: dict Returns: **Response Syntax** { 'PersonalizationMode': 'ENABLED'|'DISABLED', 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **PersonalizationMode** *(string) --* The personalization mode that is used for the personalization configuration. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InternalFailureException" * "QuickSight.Client.exceptions.ResourceUnavailableException" QuickSight / Client / get_session_embed_url get_session_embed_url ********************* QuickSight.Client.get_session_embed_url(**kwargs) Generates a session URL and authorization code that you can use to embed the Amazon Amazon QuickSight console in your web server code. Use "GetSessionEmbedUrl" where you want to provide an authoring portal that allows users to create data sources, datasets, analyses, and dashboards. The users who access an embedded Amazon QuickSight console need belong to the author or admin security cohort. If you want to restrict permissions to some of these features, add a custom permissions profile to the user with the "UpdateUser" API operation. Use "RegisterUser" API operation to add a new user with a custom permission profile attached. For more information, see the following sections in the *Amazon QuickSight User Guide*: * Embedding Analytics * Customizing Access to the Amazon QuickSight Console See also: AWS API Documentation **Request Syntax** response = client.get_session_embed_url( AwsAccountId='string', EntryPoint='string', SessionLifetimeInMinutes=123, UserArn='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID for the Amazon Web Services account associated with your Amazon QuickSight subscription. * **EntryPoint** (*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 * **SessionLifetimeInMinutes** (*integer*) -- How many minutes the session is valid. The session lifetime must be 15-600 minutes. * **UserArn** (*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: * 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. Return type: dict Returns: **Response Syntax** { 'EmbedUrl': 'string', 'Status': 123, 'RequestId': 'string' } **Response Structure** * *(dict) --* * **EmbedUrl** *(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** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceExistsException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.QuickSightUserNotFoundException" * "QuickSight.Client.exceptions.SessionLifetimeInMinutesInvalidExc eption" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / list_topic_refresh_schedules list_topic_refresh_schedules **************************** QuickSight.Client.list_topic_refresh_schedules(**kwargs) Lists all of the refresh schedules for a topic. See also: AWS API Documentation **Request Syntax** response = client.list_topic_refresh_schedules( AwsAccountId='string', TopicId='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the topic whose refresh schedule you want described. * **TopicId** (*string*) -- **[REQUIRED]** The ID for the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. Return type: dict Returns: **Response Syntax** { 'TopicId': 'string', 'TopicArn': 'string', 'RefreshSchedules': [ { 'DatasetId': 'string', 'DatasetArn': 'string', 'DatasetName': 'string', 'RefreshSchedule': { 'IsEnabled': True|False, 'BasedOnSpiceSchedule': True|False, 'StartingAt': datetime(2015, 1, 1), 'Timezone': 'string', 'RepeatAt': 'string', 'TopicScheduleType': 'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY' } }, ], 'Status': 123, 'RequestId': 'string' } **Response Structure** * *(dict) --* * **TopicId** *(string) --* The ID for the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. * **TopicArn** *(string) --* The Amazon Resource Name (ARN) of the topic. * **RefreshSchedules** *(list) --* The list of topic refresh schedules. * *(dict) --* A summary of the refresh schedule details for a dataset. * **DatasetId** *(string) --* The ID of the dataset. * **DatasetArn** *(string) --* The Amazon Resource Name (ARN) of the dataset. * **DatasetName** *(string) --* The name of the dataset. * **RefreshSchedule** *(dict) --* The definition of a refresh schedule. * **IsEnabled** *(boolean) --* A Boolean value that controls whether to schedule is enabled. * **BasedOnSpiceSchedule** *(boolean) --* A Boolean value that controls whether to schedule runs at the same schedule that is specified in SPICE dataset. * **StartingAt** *(datetime) --* The starting date and time for the refresh schedule. * **Timezone** *(string) --* The timezone that you want the refresh schedule to use. * **RepeatAt** *(string) --* The time of day when the refresh should run, for example, Monday-Sunday. * **TopicScheduleType** *(string) --* The type of refresh schedule. Valid values for this structure are "HOURLY", "DAILY", "WEEKLY", and "MONTHLY". * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.LimitExceededException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ResourceExistsException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / delete_iam_policy_assignment delete_iam_policy_assignment **************************** QuickSight.Client.delete_iam_policy_assignment(**kwargs) Deletes an existing IAM policy assignment. See also: AWS API Documentation **Request Syntax** response = client.delete_iam_policy_assignment( AwsAccountId='string', AssignmentName='string', Namespace='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The Amazon Web Services account ID where you want to delete the IAM policy assignment. * **AssignmentName** (*string*) -- **[REQUIRED]** The name of the assignment. * **Namespace** (*string*) -- **[REQUIRED]** The namespace that contains the assignment. Return type: dict Returns: **Response Syntax** { 'AssignmentName': 'string', 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **AssignmentName** *(string) --* The name of the assignment. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceExistsException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.ConcurrentUpdatingException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / start_asset_bundle_import_job start_asset_bundle_import_job ***************************** QuickSight.Client.start_asset_bundle_import_job(**kwargs) Starts an Asset Bundle import job. An Asset Bundle import job imports specified Amazon QuickSight assets into an Amazon QuickSight account. You can also choose to import a naming prefix and specified configuration overrides. The assets that are contained in the bundle file that you provide are used to create or update a new or existing asset in your Amazon QuickSight account. Each Amazon QuickSight account can run up to 5 import jobs concurrently. The API caller must have the necessary ""create"", ""describe"", and ""update"" permissions in their IAM role to access each resource type that is contained in the bundle file before the resources can be imported. See also: AWS API Documentation **Request Syntax** response = client.start_asset_bundle_import_job( AwsAccountId='string', AssetBundleImportJobId='string', AssetBundleImportSource={ 'Body': b'bytes', 'S3Uri': 'string' }, OverrideParameters={ 'ResourceIdOverrideConfiguration': { 'PrefixForAllResources': 'string' }, 'VPCConnections': [ { 'VPCConnectionId': 'string', 'Name': 'string', 'SubnetIds': [ 'string', ], 'SecurityGroupIds': [ 'string', ], 'DnsResolvers': [ 'string', ], 'RoleArn': 'string' }, ], 'RefreshSchedules': [ { 'DataSetId': 'string', 'ScheduleId': 'string', 'StartAfterDateTime': datetime(2015, 1, 1) }, ], 'DataSources': [ { 'DataSourceId': 'string', 'Name': 'string', 'DataSourceParameters': { 'AmazonElasticsearchParameters': { 'Domain': 'string' }, 'AthenaParameters': { 'WorkGroup': 'string', 'RoleArn': 'string', 'IdentityCenterConfiguration': { 'EnableIdentityPropagation': True|False } }, 'AuroraParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'AuroraPostgreSqlParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'AwsIotAnalyticsParameters': { 'DataSetName': 'string' }, 'JiraParameters': { 'SiteBaseUrl': 'string' }, 'MariaDbParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'MySqlParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'OracleParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string', 'UseServiceName': True|False }, 'PostgreSqlParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'PrestoParameters': { 'Host': 'string', 'Port': 123, 'Catalog': 'string' }, 'RdsParameters': { 'InstanceId': 'string', 'Database': 'string' }, 'RedshiftParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string', 'ClusterId': 'string', 'IAMParameters': { 'RoleArn': 'string', 'DatabaseUser': 'string', 'DatabaseGroups': [ 'string', ], 'AutoCreateDatabaseUser': True|False }, 'IdentityCenterConfiguration': { 'EnableIdentityPropagation': True|False } }, 'S3Parameters': { 'ManifestFileLocation': { 'Bucket': 'string', 'Key': 'string' }, 'RoleArn': 'string' }, 'ServiceNowParameters': { 'SiteBaseUrl': 'string' }, 'SnowflakeParameters': { 'Host': 'string', 'Database': 'string', 'Warehouse': 'string', 'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509', 'DatabaseAccessControlRole': 'string', 'OAuthParameters': { 'TokenProviderUrl': 'string', 'OAuthScope': 'string', 'IdentityProviderVpcConnectionProperties': { 'VpcConnectionArn': 'string' }, 'IdentityProviderResourceUri': 'string' } }, 'SparkParameters': { 'Host': 'string', 'Port': 123 }, 'SqlServerParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'TeradataParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string' }, 'TwitterParameters': { 'Query': 'string', 'MaxRows': 123 }, 'AmazonOpenSearchParameters': { 'Domain': 'string' }, 'ExasolParameters': { 'Host': 'string', 'Port': 123 }, 'DatabricksParameters': { 'Host': 'string', 'Port': 123, 'SqlEndpointPath': 'string' }, 'StarburstParameters': { 'Host': 'string', 'Port': 123, 'Catalog': 'string', 'ProductType': 'GALAXY'|'ENTERPRISE', 'DatabaseAccessControlRole': 'string', 'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509', 'OAuthParameters': { 'TokenProviderUrl': 'string', 'OAuthScope': 'string', 'IdentityProviderVpcConnectionProperties': { 'VpcConnectionArn': 'string' }, 'IdentityProviderResourceUri': 'string' } }, 'TrinoParameters': { 'Host': 'string', 'Port': 123, 'Catalog': 'string' }, 'BigQueryParameters': { 'ProjectId': 'string', 'DataSetRegion': 'string' }, 'ImpalaParameters': { 'Host': 'string', 'Port': 123, 'Database': 'string', 'SqlEndpointPath': 'string' } }, 'VpcConnectionProperties': { 'VpcConnectionArn': 'string' }, 'SslProperties': { 'DisableSsl': True|False }, 'Credentials': { 'CredentialPair': { 'Username': 'string', 'Password': 'string' }, 'SecretArn': 'string' } }, ], 'DataSets': [ { 'DataSetId': 'string', 'Name': 'string', 'DataSetRefreshProperties': { 'RefreshConfiguration': { 'IncrementalRefresh': { 'LookbackWindow': { 'ColumnName': 'string', 'Size': 123, 'SizeUnit': 'HOUR'|'DAY'|'WEEK' } } }, 'FailureConfiguration': { 'EmailAlert': { 'AlertStatus': 'ENABLED'|'DISABLED' } } } }, ], 'Themes': [ { 'ThemeId': 'string', 'Name': 'string' }, ], 'Analyses': [ { 'AnalysisId': 'string', 'Name': 'string' }, ], 'Dashboards': [ { 'DashboardId': 'string', 'Name': 'string' }, ], 'Folders': [ { 'FolderId': 'string', 'Name': 'string', 'ParentFolderArn': 'string' }, ] }, FailureAction='DO_NOTHING'|'ROLLBACK', OverridePermissions={ 'DataSources': [ { 'DataSourceIds': [ 'string', ], 'Permissions': { 'Principals': [ 'string', ], 'Actions': [ 'string', ] } }, ], 'DataSets': [ { 'DataSetIds': [ 'string', ], 'Permissions': { 'Principals': [ 'string', ], 'Actions': [ 'string', ] } }, ], 'Themes': [ { 'ThemeIds': [ 'string', ], 'Permissions': { 'Principals': [ 'string', ], 'Actions': [ 'string', ] } }, ], 'Analyses': [ { 'AnalysisIds': [ 'string', ], 'Permissions': { 'Principals': [ 'string', ], 'Actions': [ 'string', ] } }, ], 'Dashboards': [ { 'DashboardIds': [ 'string', ], 'Permissions': { 'Principals': [ 'string', ], 'Actions': [ 'string', ] }, 'LinkSharingConfiguration': { 'Permissions': { 'Principals': [ 'string', ], 'Actions': [ 'string', ] } } }, ], 'Folders': [ { 'FolderIds': [ 'string', ], 'Permissions': { 'Principals': [ 'string', ], 'Actions': [ 'string', ] } }, ] }, OverrideTags={ 'VPCConnections': [ { 'VPCConnectionIds': [ 'string', ], 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], 'DataSources': [ { 'DataSourceIds': [ 'string', ], 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], 'DataSets': [ { 'DataSetIds': [ 'string', ], 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], 'Themes': [ { 'ThemeIds': [ 'string', ], 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], 'Analyses': [ { 'AnalysisIds': [ 'string', ], 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], 'Dashboards': [ { 'DashboardIds': [ 'string', ], 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], 'Folders': [ { 'FolderIds': [ 'string', ], 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ] }, OverrideValidationStrategy={ 'StrictModeForAllResources': True|False } ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account to import assets into. * **AssetBundleImportJobId** (*string*) -- **[REQUIRED]** The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job. * **AssetBundleImportSource** (*dict*) -- **[REQUIRED]** The source of the asset bundle zip file that contains the data that you want to import. The file must be in "QUICKSIGHT_JSON" format. * **Body** *(bytes) --* The bytes of the base64 encoded asset bundle import zip file. This file can't exceed 20 MB. If the size of the file that you want to upload is more than 20 MB, add the file to your Amazon S3 bucket and use "S3Uri" of the file for this operation. If you are calling the API operations from the Amazon Web Services SDK for Java, JavaScript, Python, or PHP, the SDK encodes base64 automatically to allow the direct setting of the zip file's bytes. If you are using an SDK for a different language or receiving related errors, try to base64 encode your data. * **S3Uri** *(string) --* The Amazon S3 URI for an asset bundle import file that exists in an Amazon S3 bucket that the caller has read access to. The file must be a zip format file and can't exceed 1 GB. * **OverrideParameters** (*dict*) -- Optional overrides that are applied to the resource configuration before import. * **ResourceIdOverrideConfiguration** *(dict) --* An optional structure that configures resource ID overrides to be applied within the import job. * **PrefixForAllResources** *(string) --* An option to request a CloudFormation variable for a prefix to be prepended to each resource's ID before import. The prefix is only added to the asset IDs and does not change the name of the asset. * **VPCConnections** *(list) --* A list of overrides for any "VPCConnection" resources that are present in the asset bundle that is imported. * *(dict) --* The override parameters for a single VPC connection that is imported. * **VPCConnectionId** *(string) --* **[REQUIRED]** The ID of the VPC Connection to apply overrides to. * **Name** *(string) --* A new name for the VPC connection. * **SubnetIds** *(list) --* A list of new subnet IDs for the VPC connection you are importing. This field is required if you are importing the VPC connection from another Amazon Web Services account or Region. * *(string) --* * **SecurityGroupIds** *(list) --* A new security group ID for the VPC connection you are importing. This field is required if you are importing the VPC connection from another Amazon Web Services account or Region. * *(string) --* * **DnsResolvers** *(list) --* An optional override of DNS resolvers to be used by the VPC connection. * *(string) --* * **RoleArn** *(string) --* An optional override of the role ARN to be used by the VPC connection. * **RefreshSchedules** *(list) --* A list of overrides for any "RefreshSchedule" resources that are present in the asset bundle that is imported. * *(dict) --* A list of overrides for a specific "RefreshsSchedule" resource that is present in the asset bundle that is imported. * **DataSetId** *(string) --* **[REQUIRED]** A partial identifier for the specific "RefreshSchedule" resource that is being overridden. This structure is used together with the "ScheduleID" structure. * **ScheduleId** *(string) --* **[REQUIRED]** A partial identifier for the specific "RefreshSchedule" resource being overridden. This structure is used together with the "DataSetId" structure. * **StartAfterDateTime** *(datetime) --* An override for the "StartAfterDateTime" of a "RefreshSchedule". Make sure that the "StartAfterDateTime" is set to a time that takes place in the future. * **DataSources** *(list) --* A list of overrides for any "DataSource" resources that are present in the asset bundle that is imported. * *(dict) --* The override parameters for a single data source that is being imported. * **DataSourceId** *(string) --* **[REQUIRED]** The ID of the data source to apply overrides to. * **Name** *(string) --* A new name for the data source. * **DataSourceParameters** *(dict) --* The parameters that Amazon QuickSight uses to connect to your underlying data source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null. * **AmazonElasticsearchParameters** *(dict) --* The parameters for OpenSearch. * **Domain** *(string) --* **[REQUIRED]** The OpenSearch domain. * **AthenaParameters** *(dict) --* The parameters for Amazon Athena. * **WorkGroup** *(string) --* The workgroup that Amazon Athena uses. * **RoleArn** *(string) --* Use the "RoleArn" structure to override an account- wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use "RoleArn" to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active. * **IdentityCenterConfiguration** *(dict) --* An optional parameter that configures IAM Identity Center authentication to grant Amazon QuickSight access to your workgroup. This parameter can only be specified if your Amazon QuickSight account is configured with IAM Identity Center. * **EnableIdentityPropagation** *(boolean) --* A Boolean option that controls whether Trusted Identity Propagation should be used. * **AuroraParameters** *(dict) --* The parameters for Amazon Aurora MySQL. * **Host** *(string) --* **[REQUIRED]** Host. * **Port** *(integer) --* **[REQUIRED]** Port. * **Database** *(string) --* **[REQUIRED]** Database. * **AuroraPostgreSqlParameters** *(dict) --* The parameters for Amazon Aurora. * **Host** *(string) --* **[REQUIRED]** The Amazon Aurora PostgreSQL-Compatible host to connect to. * **Port** *(integer) --* **[REQUIRED]** The port that Amazon Aurora PostgreSQL is listening on. * **Database** *(string) --* **[REQUIRED]** The Amazon Aurora PostgreSQL database to connect to. * **AwsIotAnalyticsParameters** *(dict) --* The parameters for IoT Analytics. * **DataSetName** *(string) --* **[REQUIRED]** Dataset name. * **JiraParameters** *(dict) --* The parameters for Jira. * **SiteBaseUrl** *(string) --* **[REQUIRED]** The base URL of the Jira site. * **MariaDbParameters** *(dict) --* The parameters for MariaDB. * **Host** *(string) --* **[REQUIRED]** Host. * **Port** *(integer) --* **[REQUIRED]** Port. * **Database** *(string) --* **[REQUIRED]** Database. * **MySqlParameters** *(dict) --* The parameters for MySQL. * **Host** *(string) --* **[REQUIRED]** Host. * **Port** *(integer) --* **[REQUIRED]** Port. * **Database** *(string) --* **[REQUIRED]** Database. * **OracleParameters** *(dict) --* The parameters for Oracle. * **Host** *(string) --* **[REQUIRED]** An Oracle host. * **Port** *(integer) --* **[REQUIRED]** The port. * **Database** *(string) --* **[REQUIRED]** The database. * **UseServiceName** *(boolean) --* A Boolean value that indicates whether the "Database" uses a service name or an SID. If this value is left blank, the default value is "SID". If this value is set to "false", the value is "SID". * **PostgreSqlParameters** *(dict) --* The parameters for PostgreSQL. * **Host** *(string) --* **[REQUIRED]** Host. * **Port** *(integer) --* **[REQUIRED]** Port. * **Database** *(string) --* **[REQUIRED]** Database. * **PrestoParameters** *(dict) --* The parameters for Presto. * **Host** *(string) --* **[REQUIRED]** Host. * **Port** *(integer) --* **[REQUIRED]** Port. * **Catalog** *(string) --* **[REQUIRED]** Catalog. * **RdsParameters** *(dict) --* The parameters for Amazon RDS. * **InstanceId** *(string) --* **[REQUIRED]** Instance ID. * **Database** *(string) --* **[REQUIRED]** Database. * **RedshiftParameters** *(dict) --* The parameters for Amazon Redshift. * **Host** *(string) --* Host. This field can be blank if "ClusterId" is provided. * **Port** *(integer) --* Port. This field can be blank if the "ClusterId" is provided. * **Database** *(string) --* **[REQUIRED]** Database. * **ClusterId** *(string) --* Cluster ID. This field can be blank if the "Host" and "Port" are provided. * **IAMParameters** *(dict) --* An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials. * **RoleArn** *(string) --* **[REQUIRED]** Use the "RoleArn" structure to allow Amazon QuickSight to call "redshift:GetClusterCredentials" on your cluster. The calling principal must have "iam:PassRole" access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role. * **DatabaseUser** *(string) --* The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of "AutoCreateDatabaseUser" to "True" to create a new user with PUBLIC permissions. * **DatabaseGroups** *(list) --* A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the "DatabaseUser". If you choose to include this parameter, the "RoleArn" must grant access to "redshift:JoinGroup". * *(string) --* * **AutoCreateDatabaseUser** *(boolean) --* Automatically creates a database user. If your database doesn't have a "DatabaseUser", set this parameter to "True". If there is no "DatabaseUser", Amazon QuickSight can't connect to your cluster. The "RoleArn" that you use for this operation must grant access to "redshift:CreateClusterUser" to successfully create the user. * **IdentityCenterConfiguration** *(dict) --* An optional parameter that configures IAM Identity Center authentication to grant Amazon QuickSight access to your cluster. This parameter can only be specified if your Amazon QuickSight account is configured with IAM Identity Center. * **EnableIdentityPropagation** *(boolean) --* A Boolean option that controls whether Trusted Identity Propagation should be used. * **S3Parameters** *(dict) --* The parameters for S3. * **ManifestFileLocation** *(dict) --* **[REQUIRED]** Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight. * **Bucket** *(string) --* **[REQUIRED]** Amazon S3 bucket. * **Key** *(string) --* **[REQUIRED]** Amazon S3 key that identifies an object. * **RoleArn** *(string) --* Use the "RoleArn" structure to override an account- wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use "RoleArn" to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active. * **ServiceNowParameters** *(dict) --* The parameters for ServiceNow. * **SiteBaseUrl** *(string) --* **[REQUIRED]** URL of the base site. * **SnowflakeParameters** *(dict) --* The parameters for Snowflake. * **Host** *(string) --* **[REQUIRED]** Host. * **Database** *(string) --* **[REQUIRED]** Database. * **Warehouse** *(string) --* **[REQUIRED]** Warehouse. * **AuthenticationType** *(string) --* The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types. * **DatabaseAccessControlRole** *(string) --* The database access control role. * **OAuthParameters** *(dict) --* An object that contains information needed to create a data source connection between an Amazon QuickSight account and Snowflake. * **TokenProviderUrl** *(string) --* **[REQUIRED]** The token endpoint URL of the identity provider. * **OAuthScope** *(string) --* The OAuth scope. * **IdentityProviderVpcConnectionProperties** *(dict) --* VPC connection properties. * **VpcConnectionArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) for the VPC connection. * **IdentityProviderResourceUri** *(string) --* The resource uri of the identity provider. * **SparkParameters** *(dict) --* The parameters for Spark. * **Host** *(string) --* **[REQUIRED]** Host. * **Port** *(integer) --* **[REQUIRED]** Port. * **SqlServerParameters** *(dict) --* The parameters for SQL Server. * **Host** *(string) --* **[REQUIRED]** Host. * **Port** *(integer) --* **[REQUIRED]** Port. * **Database** *(string) --* **[REQUIRED]** Database. * **TeradataParameters** *(dict) --* The parameters for Teradata. * **Host** *(string) --* **[REQUIRED]** Host. * **Port** *(integer) --* **[REQUIRED]** Port. * **Database** *(string) --* **[REQUIRED]** Database. * **TwitterParameters** *(dict) --* The parameters for Twitter. * **Query** *(string) --* **[REQUIRED]** Twitter query string. * **MaxRows** *(integer) --* **[REQUIRED]** Maximum number of rows to query Twitter. * **AmazonOpenSearchParameters** *(dict) --* The parameters for OpenSearch. * **Domain** *(string) --* **[REQUIRED]** The OpenSearch domain. * **ExasolParameters** *(dict) --* The parameters for Exasol. * **Host** *(string) --* **[REQUIRED]** The hostname or IP address of the Exasol data source. * **Port** *(integer) --* **[REQUIRED]** The port for the Exasol data source. * **DatabricksParameters** *(dict) --* The parameters that are required to connect to a Databricks data source. * **Host** *(string) --* **[REQUIRED]** The host name of the Databricks data source. * **Port** *(integer) --* **[REQUIRED]** The port for the Databricks data source. * **SqlEndpointPath** *(string) --* **[REQUIRED]** The HTTP path of the Databricks data source. * **StarburstParameters** *(dict) --* The parameters that are required to connect to a Starburst data source. * **Host** *(string) --* **[REQUIRED]** The host name of the Starburst data source. * **Port** *(integer) --* **[REQUIRED]** The port for the Starburst data source. * **Catalog** *(string) --* **[REQUIRED]** The catalog name for the Starburst data source. * **ProductType** *(string) --* The product type for the Starburst data source. * **DatabaseAccessControlRole** *(string) --* The database access control role. * **AuthenticationType** *(string) --* The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types. * **OAuthParameters** *(dict) --* An object that contains information needed to create a data source connection between an Amazon QuickSight account and Starburst. * **TokenProviderUrl** *(string) --* **[REQUIRED]** The token endpoint URL of the identity provider. * **OAuthScope** *(string) --* The OAuth scope. * **IdentityProviderVpcConnectionProperties** *(dict) --* VPC connection properties. * **VpcConnectionArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) for the VPC connection. * **IdentityProviderResourceUri** *(string) --* The resource uri of the identity provider. * **TrinoParameters** *(dict) --* The parameters that are required to connect to a Trino data source. * **Host** *(string) --* **[REQUIRED]** The host name of the Trino data source. * **Port** *(integer) --* **[REQUIRED]** The port for the Trino data source. * **Catalog** *(string) --* **[REQUIRED]** The catalog name for the Trino data source. * **BigQueryParameters** *(dict) --* The parameters that are required to connect to a Google BigQuery data source. * **ProjectId** *(string) --* **[REQUIRED]** The Google Cloud Platform project ID where your datasource was created. * **DataSetRegion** *(string) --* The storage location where you create a Google BigQuery data source. * **ImpalaParameters** *(dict) --* The parameters for Impala. * **Host** *(string) --* **[REQUIRED]** The host name of the Impala data source. * **Port** *(integer) --* **[REQUIRED]** The port of the Impala data source. * **Database** *(string) --* The database of the Impala data source. * **SqlEndpointPath** *(string) --* **[REQUIRED]** The HTTP path of the Impala data source. * **VpcConnectionProperties** *(dict) --* VPC connection properties. * **VpcConnectionArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) for the VPC connection. * **SslProperties** *(dict) --* Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying data source. * **DisableSsl** *(boolean) --* A Boolean option to control whether SSL should be disabled. * **Credentials** *(dict) --* An optional structure that provides the credentials to be used to create the imported data source. * **CredentialPair** *(dict) --* A username and password credential pair to be used to create the imported data source. Keep this field blank if you are using a Secrets Manager secret to provide credentials. * **Username** *(string) --* **[REQUIRED]** The username for the data source connection. * **Password** *(string) --* **[REQUIRED]** The password for the data source connection. * **SecretArn** *(string) --* The ARN of the Secrets Manager secret that's used to create the imported data source. Keep this field blank, unless you are using a secret in place of a credential pair. * **DataSets** *(list) --* A list of overrides for any "DataSet" resources that are present in the asset bundle that is imported. * *(dict) --* The override parameters for a single dataset that is being imported. * **DataSetId** *(string) --* **[REQUIRED]** The ID of the dataset to apply overrides to. * **Name** *(string) --* A new name for the dataset. * **DataSetRefreshProperties** *(dict) --* The refresh properties of a dataset. * **RefreshConfiguration** *(dict) --* The refresh configuration for a dataset. * **IncrementalRefresh** *(dict) --* **[REQUIRED]** The incremental refresh for the dataset. * **LookbackWindow** *(dict) --* **[REQUIRED]** The lookback window setup for an incremental refresh configuration. * **ColumnName** *(string) --* **[REQUIRED]** The name of the lookback window column. * **Size** *(integer) --* **[REQUIRED]** The lookback window column size. * **SizeUnit** *(string) --* **[REQUIRED]** The size unit that is used for the lookback window column. Valid values for this structure are "HOUR", "DAY", and "WEEK". * **FailureConfiguration** *(dict) --* The failure configuration for a dataset. * **EmailAlert** *(dict) --* The email alert configuration for a dataset refresh failure. * **AlertStatus** *(string) --* The status value that determines if email alerts are sent. * **Themes** *(list) --* A list of overrides for any "Theme" resources that are present in the asset bundle that is imported. * *(dict) --* The override parameters for a single theme that is imported. * **ThemeId** *(string) --* **[REQUIRED]** The ID of the theme to apply overrides to. * **Name** *(string) --* A new name for the theme. * **Analyses** *(list) --* A list of overrides for any "Analysis" resources that are present in the asset bundle that is imported. * *(dict) --* The override parameters for a single analysis that is being imported. * **AnalysisId** *(string) --* **[REQUIRED]** The ID of the analysis that you ant to apply overrides to. * **Name** *(string) --* A new name for the analysis. * **Dashboards** *(list) --* A list of overrides for any "Dashboard" resources that are present in the asset bundle that is imported. * *(dict) --* The override parameters for a single dashboard that is being imported. * **DashboardId** *(string) --* **[REQUIRED]** The ID of the dashboard that you want to apply overrides to. * **Name** *(string) --* A new name for the dashboard. * **Folders** *(list) --* A list of overrides for any "Folder" resources that are present in the asset bundle that is imported. * *(dict) --* The override parameters for a single folder that is being imported. * **FolderId** *(string) --* **[REQUIRED]** The ID of the folder that you want to apply overrides to. * **Name** *(string) --* A new name for the folder. * **ParentFolderArn** *(string) --* A new parent folder arn. This change can only be applied if the import creates a brand new folder. Existing folders cannot be moved. * **FailureAction** (*string*) -- The failure action for the import job. If you choose "ROLLBACK", failed import jobs will attempt to undo any asset changes caused by the failed job. If you choose "DO_NOTHING", failed import jobs will not attempt to roll back any asset changes caused by the failed job, possibly keeping the Amazon QuickSight account in an inconsistent state. * **OverridePermissions** (*dict*) -- Optional permission overrides that are applied to the resource configuration before import. * **DataSources** *(list) --* A list of permissions overrides for any "DataSource" resources that are present in the asset bundle that is imported. * *(dict) --* An object that contains a list of permissions to be applied to a list of data source IDs. * **DataSourceIds** *(list) --* **[REQUIRED]** A list of data source IDs that you want to apply overrides to. You can use "*" to override all data sources in this asset bundle. * *(string) --* * **Permissions** *(dict) --* **[REQUIRED]** A list of permissions for the data source that you want to apply overrides to. * **Principals** *(list) --* **[REQUIRED]** A list of principals to grant permissions on. * *(string) --* * **Actions** *(list) --* **[REQUIRED]** A list of IAM actions to grant permissions on. * *(string) --* * **DataSets** *(list) --* A list of permissions overrides for any "DataSet" resources that are present in the asset bundle that is imported. * *(dict) --* An object that contains a list of permissions to be applied to a list of dataset IDs. * **DataSetIds** *(list) --* **[REQUIRED]** A list of dataset IDs that you want to apply overrides to. You can use "*" to override all datasets in this asset bundle. * *(string) --* * **Permissions** *(dict) --* **[REQUIRED]** A list of permissions for the datasets that you want to apply overrides to. * **Principals** *(list) --* **[REQUIRED]** A list of principals to grant permissions on. * *(string) --* * **Actions** *(list) --* **[REQUIRED]** A list of IAM actions to grant permissions on. * *(string) --* * **Themes** *(list) --* A list of permissions overrides for any "Theme" resources that are present in the asset bundle that is imported. * *(dict) --* An object that contains a list of permissions to be applied to a list of theme IDs. * **ThemeIds** *(list) --* **[REQUIRED]** A list of theme IDs that you want to apply overrides to. You can use "*" to override all themes in this asset bundle. * *(string) --* * **Permissions** *(dict) --* **[REQUIRED]** A list of permissions for the themes that you want to apply overrides to. * **Principals** *(list) --* **[REQUIRED]** A list of principals to grant permissions on. * *(string) --* * **Actions** *(list) --* **[REQUIRED]** A list of IAM actions to grant permissions on. * *(string) --* * **Analyses** *(list) --* A list of permissions overrides for any "Analysis" resources that are present in the asset bundle that is imported. * *(dict) --* An object that contains a list of permissions to be applied to a list of analysis IDs. * **AnalysisIds** *(list) --* **[REQUIRED]** A list of analysis IDs that you want to apply overrides to. You can use "*" to override all analyses in this asset bundle. * *(string) --* * **Permissions** *(dict) --* **[REQUIRED]** A list of permissions for the analyses that you want to apply overrides to. * **Principals** *(list) --* **[REQUIRED]** A list of principals to grant permissions on. * *(string) --* * **Actions** *(list) --* **[REQUIRED]** A list of IAM actions to grant permissions on. * *(string) --* * **Dashboards** *(list) --* A list of permissions overrides for any "Dashboard" resources that are present in the asset bundle that is imported. * *(dict) --* An object that contains a list of permissions to be applied to a list of dashboard IDs. * **DashboardIds** *(list) --* **[REQUIRED]** A list of dashboard IDs that you want to apply overrides to. You can use "*" to override all dashboards in this asset bundle. * *(string) --* * **Permissions** *(dict) --* A list of permissions for the dashboards that you want to apply overrides to. * **Principals** *(list) --* **[REQUIRED]** A list of principals to grant permissions on. * *(string) --* * **Actions** *(list) --* **[REQUIRED]** A list of IAM actions to grant permissions on. * *(string) --* * **LinkSharingConfiguration** *(dict) --* A structure that contains the link sharing configurations that you want to apply overrides to. * **Permissions** *(dict) --* A list of link sharing permissions for the dashboards that you want to apply overrides to. * **Principals** *(list) --* **[REQUIRED]** A list of principals to grant permissions on. * *(string) --* * **Actions** *(list) --* **[REQUIRED]** A list of IAM actions to grant permissions on. * *(string) --* * **Folders** *(list) --* A list of permissions for the folders that you want to apply overrides to. * *(dict) --* An object that contains a list of permissions to be applied to a list of folder IDs. * **FolderIds** *(list) --* **[REQUIRED]** A list of folder IDs that you want to apply overrides to. You can use "*" to override all folders in this asset bundle. * *(string) --* * **Permissions** *(dict) --* A structure that contains the permissions for the resource that you want to override in an asset bundle import job. * **Principals** *(list) --* **[REQUIRED]** A list of principals to grant permissions on. * *(string) --* * **Actions** *(list) --* **[REQUIRED]** A list of IAM actions to grant permissions on. * *(string) --* * **OverrideTags** (*dict*) -- Optional tag overrides that are applied to the resource configuration before import. * **VPCConnections** *(list) --* A list of tag overrides for any "VPCConnection" resources that are present in the asset bundle that is imported. * *(dict) --* An object that contains a list of tags to be assigned to a list of VPC connection IDs. * **VPCConnectionIds** *(list) --* **[REQUIRED]** A list of VPC connection IDs that you want to apply overrides to. You can use "*" to override all VPC connections in this asset bundle. * *(string) --* * **Tags** *(list) --* **[REQUIRED]** A list of tags for the VPC connections that you want to apply overrides to. * *(dict) --* The key or keys of the key-value pairs for the resource tag or tags assigned to the resource. * **Key** *(string) --* **[REQUIRED]** Tag key. * **Value** *(string) --* **[REQUIRED]** Tag value. * **DataSources** *(list) --* A list of tag overrides for any "DataSource" resources that are present in the asset bundle that is imported. * *(dict) --* An object that contains a list of tags to be assigned to a list of data source IDs. * **DataSourceIds** *(list) --* **[REQUIRED]** A list of data source IDs that you want to apply overrides to. You can use "*" to override all data sources in this asset bundle. * *(string) --* * **Tags** *(list) --* **[REQUIRED]** A list of tags for the data source that you want to apply overrides to. * *(dict) --* The key or keys of the key-value pairs for the resource tag or tags assigned to the resource. * **Key** *(string) --* **[REQUIRED]** Tag key. * **Value** *(string) --* **[REQUIRED]** Tag value. * **DataSets** *(list) --* A list of tag overrides for any "DataSet" resources that are present in the asset bundle that is imported. * *(dict) --* An object that contains a list of tags to be assigned to a list of dataset IDs. * **DataSetIds** *(list) --* **[REQUIRED]** A list of dataset IDs that you want to apply overrides to. You can use "*" to override all datasets in this asset bundle. * *(string) --* * **Tags** *(list) --* **[REQUIRED]** A list of tags for the datasets that you want to apply overrides to. * *(dict) --* The key or keys of the key-value pairs for the resource tag or tags assigned to the resource. * **Key** *(string) --* **[REQUIRED]** Tag key. * **Value** *(string) --* **[REQUIRED]** Tag value. * **Themes** *(list) --* A list of tag overrides for any "Theme" resources that are present in the asset bundle that is imported. * *(dict) --* An object that contains a list of tags to be assigned to a list of theme IDs. * **ThemeIds** *(list) --* **[REQUIRED]** A list of theme IDs that you want to apply overrides to. You can use "*" to override all themes in this asset bundle. * *(string) --* * **Tags** *(list) --* **[REQUIRED]** A list of tags for the themes that you want to apply overrides to. * *(dict) --* The key or keys of the key-value pairs for the resource tag or tags assigned to the resource. * **Key** *(string) --* **[REQUIRED]** Tag key. * **Value** *(string) --* **[REQUIRED]** Tag value. * **Analyses** *(list) --* A list of tag overrides for any "Analysis" resources that are present in the asset bundle that is imported. * *(dict) --* An object that contains a list of tags to be assigned to a list of analysis IDs. * **AnalysisIds** *(list) --* **[REQUIRED]** A list of analysis IDs that you want to apply overrides to. You can use "*" to override all analyses in this asset bundle. * *(string) --* * **Tags** *(list) --* **[REQUIRED]** A list of tags for the analyses that you want to apply overrides to. * *(dict) --* The key or keys of the key-value pairs for the resource tag or tags assigned to the resource. * **Key** *(string) --* **[REQUIRED]** Tag key. * **Value** *(string) --* **[REQUIRED]** Tag value. * **Dashboards** *(list) --* A list of tag overrides for any "Dashboard" resources that are present in the asset bundle that is imported. * *(dict) --* An object that contains a list of tags to be assigned to a list of dashboard IDs. * **DashboardIds** *(list) --* **[REQUIRED]** A list of dashboard IDs that you want to apply overrides to. You can use "*" to override all dashboards in this asset bundle. * *(string) --* * **Tags** *(list) --* **[REQUIRED]** A list of tags for the dashboards that you want to apply overrides to. * *(dict) --* The key or keys of the key-value pairs for the resource tag or tags assigned to the resource. * **Key** *(string) --* **[REQUIRED]** Tag key. * **Value** *(string) --* **[REQUIRED]** Tag value. * **Folders** *(list) --* A list of tag overrides for any "Folder" resources that are present in the asset bundle that is imported. * *(dict) --* An object that contains a list of tags to be assigned to a list of folder IDs. * **FolderIds** *(list) --* **[REQUIRED]** A list of folder IDs that you want to apply overrides to. You can use "*" to override all folders in this asset bundle. * *(string) --* * **Tags** *(list) --* **[REQUIRED]** A list of tags for the folders that you want to apply overrides to. * *(dict) --* The key or keys of the key-value pairs for the resource tag or tags assigned to the resource. * **Key** *(string) --* **[REQUIRED]** Tag key. * **Value** *(string) --* **[REQUIRED]** Tag value. * **OverrideValidationStrategy** (*dict*) -- An optional validation strategy override for all analyses and dashboards that is applied to the resource configuration before import. * **StrictModeForAllResources** *(boolean) --* A Boolean value that indicates whether to import all analyses and dashboards under strict or lenient mode. Return type: dict Returns: **Response Syntax** { 'Arn': 'string', 'AssetBundleImportJobId': 'string', 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **Arn** *(string) --* The Amazon Resource Name (ARN) for the import job. * **AssetBundleImportJobId** *(string) --* The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job. * **RequestId** *(string) --* The Amazon Web Services response ID for this operation. * **Status** *(integer) --* The HTTP status of the response. **Exceptions** * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.LimitExceededException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.ResourceNotFoundException" QuickSight / Client / describe_template describe_template ***************** QuickSight.Client.describe_template(**kwargs) Describes a template's metadata. See also: AWS API Documentation **Request Syntax** response = client.describe_template( AwsAccountId='string', TemplateId='string', VersionNumber=123, AliasName='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the template that you're describing. * **TemplateId** (*string*) -- **[REQUIRED]** The ID for the template. * **VersionNumber** (*integer*) -- (Optional) The number for the version to describe. If a "VersionNumber" parameter value isn't provided, the latest version of the template is described. * **AliasName** (*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. Return type: dict Returns: **Response Syntax** { 'Template': { 'Arn': 'string', 'Name': 'string', 'Version': { 'CreatedTime': datetime(2015, 1, 1), 'Errors': [ { 'Type': 'SOURCE_NOT_FOUND'|'DATA_SET_NOT_FOUND'|'INTERNAL_FAILURE'|'ACCESS_DENIED', 'Message': 'string', 'ViolatedEntities': [ { 'Path': 'string' }, ] }, ], 'VersionNumber': 123, 'Status': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED', 'DataSetConfigurations': [ { 'Placeholder': 'string', 'DataSetSchema': { 'ColumnSchemaList': [ { 'Name': 'string', 'DataType': 'string', 'GeographicRole': 'string' }, ] }, 'ColumnGroupSchemaList': [ { 'Name': 'string', 'ColumnGroupColumnSchemaList': [ { 'Name': 'string' }, ] }, ] }, ], 'Description': 'string', 'SourceEntityArn': 'string', 'ThemeArn': 'string', 'Sheets': [ { 'SheetId': 'string', 'Name': 'string', 'Images': [ { 'SheetImageId': 'string', 'Source': { 'SheetImageStaticFileSource': { 'StaticFileId': 'string' } }, 'Scaling': { 'ScalingType': 'SCALE_TO_WIDTH'|'SCALE_TO_HEIGHT'|'SCALE_TO_CONTAINER'|'SCALE_NONE' }, 'Tooltip': { 'TooltipText': { 'PlainText': 'string' }, 'Visibility': 'HIDDEN'|'VISIBLE' }, 'ImageContentAltText': 'string', 'Interactions': { 'ImageMenuOption': { 'AvailabilityStatus': 'ENABLED'|'DISABLED' } }, 'Actions': [ { 'CustomActionId': 'string', 'Name': 'string', 'Status': 'ENABLED'|'DISABLED', 'Trigger': 'CLICK'|'MENU', 'ActionOperations': [ { 'NavigationOperation': { 'LocalNavigationConfiguration': { 'TargetSheetId': 'string' } }, 'URLOperation': { 'URLTemplate': 'string', 'URLTarget': 'NEW_TAB'|'NEW_WINDOW'|'SAME_TAB' }, 'SetParametersOperation': { 'ParameterValueConfigurations': [ { 'DestinationParameterName': 'string', 'Value': { 'CustomValuesConfiguration': { 'IncludeNullValue': True|False, 'CustomValues': { 'StringValues': [ 'string', ], 'IntegerValues': [ 123, ], 'DecimalValues': [ 123.0, ], 'DateTimeValues': [ datetime(2015, 1, 1), ] } }, 'SelectAllValueOptions': 'ALL_VALUES', 'SourceParameterName': 'string', 'SourceField': 'string', 'SourceColumn': { 'DataSetIdentifier': 'string', 'ColumnName': 'string' } } }, ] } }, ] }, ] }, ] }, ] }, 'TemplateId': 'string', 'LastUpdatedTime': datetime(2015, 1, 1), 'CreatedTime': datetime(2015, 1, 1) }, 'Status': 123, 'RequestId': 'string' } **Response Structure** * *(dict) --* * **Template** *(dict) --* The template structure for the object you want to describe. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the template. * **Name** *(string) --* The display name of the template. * **Version** *(dict) --* A structure describing the versions of the template. * **CreatedTime** *(datetime) --* The time that this template version was created. * **Errors** *(list) --* Errors associated with this template version. * *(dict) --* List of errors that occurred when the template version creation failed. * **Type** *(string) --* Type of error. * **Message** *(string) --* Description of the error type. * **ViolatedEntities** *(list) --* An error path that shows which entities caused the template error. * *(dict) --* An object, structure, or sub-structure of an analysis, template, or dashboard. * **Path** *(string) --* The hierarchical path of the entity within the analysis, template, or dashboard definition tree. * **VersionNumber** *(integer) --* The version number of the template version. * **Status** *(string) --* The status that is associated with the template. * "CREATION_IN_PROGRESS" * "CREATION_SUCCESSFUL" * "CREATION_FAILED" * "UPDATE_IN_PROGRESS" * "UPDATE_SUCCESSFUL" * "UPDATE_FAILED" * "DELETED" * **DataSetConfigurations** *(list) --* Schema of the dataset identified by the placeholder. Any dashboard created from this template should be bound to new datasets matching the same schema described through this API operation. * *(dict) --* Dataset configuration. * **Placeholder** *(string) --* Placeholder. * **DataSetSchema** *(dict) --* Dataset schema. * **ColumnSchemaList** *(list) --* A structure containing the list of column schemas. * *(dict) --* The column schema. * **Name** *(string) --* The name of the column schema. * **DataType** *(string) --* The data type of the column schema. * **GeographicRole** *(string) --* The geographic role of the column schema. * **ColumnGroupSchemaList** *(list) --* A structure containing the list of column group schemas. * *(dict) --* The column group schema. * **Name** *(string) --* The name of the column group schema. * **ColumnGroupColumnSchemaList** *(list) --* A structure containing the list of schemas for column group columns. * *(dict) --* A structure describing the name, data type, and geographic role of the columns. * **Name** *(string) --* The name of the column group's column schema. * **Description** *(string) --* The description of the template. * **SourceEntityArn** *(string) --* The Amazon Resource Name (ARN) of an analysis or template that was used to create this template. * **ThemeArn** *(string) --* The ARN of the theme associated with this version of the template. * **Sheets** *(list) --* A list of the associated sheets with the unique identifier and name of each sheet. * *(dict) --* A *sheet*, which is an object that contains a set of visuals that are viewed together on one page in Amazon QuickSight. Every analysis and dashboard contains at least one sheet. Each sheet contains at least one visualization widget, for example a chart, pivot table, or narrative insight. Sheets can be associated with other components, such as controls, filters, and so on. * **SheetId** *(string) --* The unique identifier associated with a sheet. * **Name** *(string) --* The name of a sheet. This name is displayed on the sheet's tab in the Amazon QuickSight console. * **Images** *(list) --* A list of images on a sheet. * *(dict) --* An image that is located on a sheet. * **SheetImageId** *(string) --* The ID of the sheet image. * **Source** *(dict) --* The source of the image. * **SheetImageStaticFileSource** *(dict) --* The source of the static file that contains the image. * **StaticFileId** *(string) --* The ID of the static file that contains the image. * **Scaling** *(dict) --* Determines how the image is scaled. * **ScalingType** *(string) --* The scaling option to use when fitting the image inside the container. Valid values are defined as follows: * "SCALE_TO_WIDTH": The image takes up the entire width of the container. The image aspect ratio is preserved. * "SCALE_TO_HEIGHT": The image takes up the entire height of the container. The image aspect ratio is preserved. * "SCALE_TO_CONTAINER": The image takes up the entire width and height of the container. The image aspect ratio is not preserved. * "SCALE_NONE": The image is displayed in its original size and is not scaled to the container. * **Tooltip** *(dict) --* The tooltip to be shown when hovering over the image. * **TooltipText** *(dict) --* The text that appears in the tooltip. * **PlainText** *(string) --* The plain text format. * **Visibility** *(string) --* The visibility of the tooltip. * **ImageContentAltText** *(string) --* The alt text for the image. * **Interactions** *(dict) --* The general image interactions setup for an image. * **ImageMenuOption** *(dict) --* The menu options for the image. * **AvailabilityStatus** *(string) --* The availability status of the image menu. If the value of this property is set to "ENABLED", dashboard readers can interact with the image menu. * **Actions** *(list) --* A list of custom actions that are configured for an image. * *(dict) --* A custom action defined on an image. * **CustomActionId** *(string) --* The ID of the custom action. * **Name** *(string) --* The name of the custom action. * **Status** *(string) --* The status of the custom action. * **Trigger** *(string) --* The trigger of the "VisualCustomAction". Valid values are defined as follows: * "CLICK": Initiates a custom action by a left pointer click on a data point. * "MENU": Initiates a custom action by right pointer click from the menu. * **ActionOperations** *(list) --* A list of "ImageCustomActionOperations". This is a union type structure. For this structure to be valid, only one of the attributes can be defined. * *(dict) --* The operation that is defined by the custom action. This is a union type structure. For this structure to be valid, only one of the attributes can be defined. * **NavigationOperation** *(dict) --* The navigation operation that navigates between different sheets in the same analysis. This is a union type structure. For this structure to be valid, only one of the attributes can be defined. * **LocalNavigationConfiguration** *(dict) --* The configuration that chooses the navigation target. * **TargetSheetId** *(string) --* The sheet that is targeted for navigation in the same analysis. * **URLOperation** *(dict) --* The URL operation that opens a link to another webpage. * **URLTemplate** *(string) --* THe URL link of the "CustomActionURLOperation". * **URLTarget** *(string) --* The target of the "CustomActionURLOperation". Valid values are defined as follows: * "NEW_TAB": Opens the target URL in a new browser tab. * "NEW_WINDOW": Opens the target URL in a new browser window. * "SAME_TAB": Opens the target URL in the same browser tab. * **SetParametersOperation** *(dict) --* The set parameter operation that sets parameters in custom action. * **ParameterValueConfigurations** *(list) --* The parameter that determines the value configuration. * *(dict) --* The configuration of adding parameters in action. * **DestinationParameterName** *(string) --* The destination parameter name of the "SetParameterValueConfiguration". * **Value** *(dict) --* The configuration of destination parameter values. This is a union type structure. For this structure to be valid, only one of the attributes can be defined. * **CustomValuesConfiguration** *(dict) --* The configuration of custom values for destination parameter in "DestinationParameterValueCo nfiguration". * **IncludeNullValue** *(boolean) --* Includes the null value in custom action parameter values. * **CustomValues** *(dict) --* The customized parameter values. This is a union type structure. For this structure to be valid, only one of the attributes can be defined. * **StringValues** *(list) --* A list of string-type parameter values. * *(string) --* * **IntegerValues** *(list) --* A list of integer-type parameter values. * *(integer) --* * **DecimalValues** *(list) --* A list of decimal-type parameter values. * *(float) --* * **DateTimeValues** *(list) --* A list of datetime-type parameter values. * *(datetime) --* * **SelectAllValueOptions** *(string) --* The configuration that selects all options. * **SourceParameterName** *(string) --* The source parameter name of the destination parameter. * **SourceField** *(string) --* The source field ID of the destination parameter. * **SourceColumn** *(dict) --* A column of a data set. * **DataSetIdentifier** *(string) --* The data set that the column belongs to. * **ColumnName** *(string) --* The name of the column. * **TemplateId** *(string) --* The ID for the template. This is unique per Amazon Web Services Region for each Amazon Web Services account. * **LastUpdatedTime** *(datetime) --* Time when this was last updated. * **CreatedTime** *(datetime) --* Time when this was created. * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.ResourceExistsException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / describe_data_source_permissions describe_data_source_permissions ******************************** QuickSight.Client.describe_data_source_permissions(**kwargs) Describes the resource permissions for a data source. See also: AWS API Documentation **Request Syntax** response = client.describe_data_source_permissions( AwsAccountId='string', DataSourceId='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The Amazon Web Services account ID. * **DataSourceId** (*string*) -- **[REQUIRED]** The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. Return type: dict Returns: **Response Syntax** { 'DataSourceArn': 'string', 'DataSourceId': 'string', 'Permissions': [ { 'Principal': 'string', 'Actions': [ 'string', ] }, ], 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **DataSourceArn** *(string) --* The Amazon Resource Name (ARN) of the data source. * **DataSourceId** *(string) --* The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. * **Permissions** *(list) --* A list of resource permissions on the data source. * *(dict) --* Permission for the resource. * **Principal** *(string) --* The Amazon Resource Name (ARN) of the principal. This can be one of the following: * The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.) * The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.) * The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.) * **Actions** *(list) --* The IAM action to grant or revoke permissions on. * *(string) --* * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / describe_dashboards_qa_configuration describe_dashboards_qa_configuration ************************************ QuickSight.Client.describe_dashboards_qa_configuration(**kwargs) Describes an existing dashboard QA configuration. See also: AWS API Documentation **Request Syntax** response = client.describe_dashboards_qa_configuration( AwsAccountId='string' ) Parameters: **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the dashboard QA configuration that you want described. Return type: dict Returns: **Response Syntax** { 'DashboardsQAStatus': 'ENABLED'|'DISABLED', 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **DashboardsQAStatus** *(string) --* The status of dashboards QA configuration that you want described. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / list_template_versions list_template_versions ********************** QuickSight.Client.list_template_versions(**kwargs) Lists all the versions of the templates in the current Amazon QuickSight account. See also: AWS API Documentation **Request Syntax** response = client.list_template_versions( AwsAccountId='string', TemplateId='string', NextToken='string', MaxResults=123 ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the templates that you're listing. * **TemplateId** (*string*) -- **[REQUIRED]** The ID for the template. * **NextToken** (*string*) -- The token for the next set of results, or null if there are no more results. * **MaxResults** (*integer*) -- The maximum number of results to be returned per request. Return type: dict Returns: **Response Syntax** { 'TemplateVersionSummaryList': [ { 'Arn': 'string', 'VersionNumber': 123, 'CreatedTime': datetime(2015, 1, 1), 'Status': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED', 'Description': 'string' }, ], 'NextToken': 'string', 'Status': 123, 'RequestId': 'string' } **Response Structure** * *(dict) --* * **TemplateVersionSummaryList** *(list) --* A structure containing a list of all the versions of the specified template. * *(dict) --* The template version. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the template version. * **VersionNumber** *(integer) --* The version number of the template version. * **CreatedTime** *(datetime) --* The time that this template version was created. * **Status** *(string) --* The status of the template version. * **Description** *(string) --* The description of the template version. * **NextToken** *(string) --* The token for the next set of results, or null if there are no more results. * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.InvalidNextTokenException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / close close ***** QuickSight.Client.close() Closes underlying endpoint connections. QuickSight / Client / update_template update_template *************** QuickSight.Client.update_template(**kwargs) Updates a template from an existing Amazon QuickSight analysis or another template. See also: AWS API Documentation **Request Syntax** # This section is too large to render. # Please see the AWS API Documentation linked below. AWS API Documentation **Parameters** # This section is too large to render. # Please see the AWS API Documentation linked below. AWS API Documentation Return type: dict Returns: **Response Syntax** { 'TemplateId': 'string', 'Arn': 'string', 'VersionArn': 'string', 'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED', 'Status': 123, 'RequestId': 'string' } **Response Structure** * *(dict) --* * **TemplateId** *(string) --* The ID for the template. * **Arn** *(string) --* The Amazon Resource Name (ARN) for the template. * **VersionArn** *(string) --* The ARN for the template, including the version information of the first version. * **CreationStatus** *(string) --* The creation status of the template. * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceExistsException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.LimitExceededException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / update_dashboard_permissions update_dashboard_permissions **************************** QuickSight.Client.update_dashboard_permissions(**kwargs) Updates read and write permissions on a dashboard. See also: AWS API Documentation **Request Syntax** response = client.update_dashboard_permissions( AwsAccountId='string', DashboardId='string', GrantPermissions=[ { 'Principal': 'string', 'Actions': [ 'string', ] }, ], RevokePermissions=[ { 'Principal': 'string', 'Actions': [ 'string', ] }, ], GrantLinkPermissions=[ { 'Principal': 'string', 'Actions': [ 'string', ] }, ], RevokeLinkPermissions=[ { 'Principal': 'string', 'Actions': [ 'string', ] }, ] ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the dashboard whose permissions you're updating. * **DashboardId** (*string*) -- **[REQUIRED]** The ID for the dashboard. * **GrantPermissions** (*list*) -- The permissions that you want to grant on this resource. * *(dict) --* Permission for the resource. * **Principal** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the principal. This can be one of the following: * The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.) * The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.) * The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.) * **Actions** *(list) --* **[REQUIRED]** The IAM action to grant or revoke permissions on. * *(string) --* * **RevokePermissions** (*list*) -- The permissions that you want to revoke from this resource. * *(dict) --* Permission for the resource. * **Principal** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the principal. This can be one of the following: * The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.) * The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.) * The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.) * **Actions** *(list) --* **[REQUIRED]** The IAM action to grant or revoke permissions on. * *(string) --* * **GrantLinkPermissions** (*list*) -- Grants link permissions to all users in a defined namespace. * *(dict) --* Permission for the resource. * **Principal** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the principal. This can be one of the following: * The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.) * The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.) * The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.) * **Actions** *(list) --* **[REQUIRED]** The IAM action to grant or revoke permissions on. * *(string) --* * **RevokeLinkPermissions** (*list*) -- Revokes link permissions from all users in a defined namespace. * *(dict) --* Permission for the resource. * **Principal** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the principal. This can be one of the following: * The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.) * The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.) * The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.) * **Actions** *(list) --* **[REQUIRED]** The IAM action to grant or revoke permissions on. * *(string) --* Return type: dict Returns: **Response Syntax** { 'DashboardArn': 'string', 'DashboardId': 'string', 'Permissions': [ { 'Principal': 'string', 'Actions': [ 'string', ] }, ], 'RequestId': 'string', 'Status': 123, 'LinkSharingConfiguration': { 'Permissions': [ { 'Principal': 'string', 'Actions': [ 'string', ] }, ] } } **Response Structure** * *(dict) --* * **DashboardArn** *(string) --* The Amazon Resource Name (ARN) of the dashboard. * **DashboardId** *(string) --* The ID for the dashboard. * **Permissions** *(list) --* Information about the permissions on the dashboard. * *(dict) --* Permission for the resource. * **Principal** *(string) --* The Amazon Resource Name (ARN) of the principal. This can be one of the following: * The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.) * The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.) * The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.) * **Actions** *(list) --* The IAM action to grant or revoke permissions on. * *(string) --* * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. * **LinkSharingConfiguration** *(dict) --* Updates the permissions of a shared link to an Amazon QuickSight dashboard. * **Permissions** *(list) --* A structure that contains the permissions of a shareable link. * *(dict) --* Permission for the resource. * **Principal** *(string) --* The Amazon Resource Name (ARN) of the principal. This can be one of the following: * The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.) * The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.) * The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.) * **Actions** *(list) --* The IAM action to grant or revoke permissions on. * *(string) --* **Exceptions** * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.LimitExceededException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / search_topics search_topics ************* QuickSight.Client.search_topics(**kwargs) Searches for any Q topic that exists in an Amazon QuickSight account. See also: AWS API Documentation **Request Syntax** response = client.search_topics( AwsAccountId='string', Filters=[ { 'Operator': 'StringEquals'|'StringLike', 'Name': 'QUICKSIGHT_USER'|'QUICKSIGHT_VIEWER_OR_OWNER'|'DIRECT_QUICKSIGHT_VIEWER_OR_OWNER'|'QUICKSIGHT_OWNER'|'DIRECT_QUICKSIGHT_OWNER'|'DIRECT_QUICKSIGHT_SOLE_OWNER'|'TOPIC_NAME', 'Value': 'string' }, ], NextToken='string', MaxResults=123 ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the topic that you want to find. * **Filters** (*list*) -- **[REQUIRED]** The filters that you want to use to search for the topic. * *(dict) --* The filter that is used to search for a topic. * **Operator** *(string) --* **[REQUIRED]** The operator like equals or like. * **Name** *(string) --* **[REQUIRED]** The name of the topic search filter. * **Value** *(string) --* **[REQUIRED]** The value of the topic search filter. * **NextToken** (*string*) -- The token for the next set of results, or null if there are no more results. * **MaxResults** (*integer*) -- The maximum number of results to be returned per request. Return type: dict Returns: **Response Syntax** { 'TopicSummaryList': [ { 'Arn': 'string', 'TopicId': 'string', 'Name': 'string', 'UserExperienceVersion': 'LEGACY'|'NEW_READER_EXPERIENCE' }, ], 'NextToken': 'string', 'Status': 123, 'RequestId': 'string' } **Response Structure** * *(dict) --* * **TopicSummaryList** *(list) --* A list of topic summaries that is returned by the search topic request. * *(dict) --* A topic summary. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the topic. * **TopicId** *(string) --* The ID for the topic. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. * **Name** *(string) --* The name of the topic. * **UserExperienceVersion** *(string) --* The user experience version of the topic. * **NextToken** *(string) --* The token for the next set of results, or null if there are no more results. * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.InvalidNextTokenException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / start_dashboard_snapshot_job start_dashboard_snapshot_job **************************** QuickSight.Client.start_dashboard_snapshot_job(**kwargs) Starts an asynchronous job that generates a snapshot of a dashboard's output. You can request one or several of the following format configurations in each API call. * 1 Paginated PDF * 1 Excel workbook that includes up to 5 table or pivot table visuals * 5 CSVs from table or pivot table visuals The status of a submitted job can be polled with the "DescribeDashboardSnapshotJob" API. When you call the "DescribeDashboardSnapshotJob" API, check the "JobStatus" field in the response. Once the job reaches a "COMPLETED" or "FAILED" status, use the "DescribeDashboardSnapshotJobResult" API to obtain the URLs for the generated files. If the job fails, the "DescribeDashboardSnapshotJobResult" API returns detailed information about the error that occurred. **StartDashboardSnapshotJob API throttling** Amazon QuickSight utilizes API throttling to create a more consistent user experience within a time span for customers when they call the "StartDashboardSnapshotJob". By default, 12 jobs can run simlutaneously in one Amazon Web Services account and users can submit up 10 API requests per second before an account is throttled. If an overwhelming number of API requests are made by the same user in a short period of time, Amazon QuickSight throttles the API calls to maintin an optimal experience and reliability for all Amazon QuickSight users. **Common throttling scenarios** The following list provides information about the most commin throttling scenarios that can occur. * A large number of "SnapshotExport" API jobs are running simultaneously on an Amazon Web Services account. When a new "StartDashboardSnapshotJob" is created and there are already 12 jobs with the "RUNNING" status, the new job request fails and returns a "LimitExceededException" error. Wait for a current job to comlpete before you resubmit the new job. * **A large number of API requests are submitted on an Amazon Web Services account.** When a user makes more than 10 API calls to the Amazon QuickSight API in one second, a "ThrottlingException" is returned. If your use case requires a higher throttling limit, contact your account admin or Amazon Web ServicesSupport to explore options to tailor a more optimal expereince for your account. **Best practices to handle throttling** If your use case projects high levels of API traffic, try to reduce the degree of frequency and parallelism of API calls as much as you can to avoid throttling. You can also perform a timing test to calculate an estimate for the total processing time of your projected load that stays within the throttling limits of the Amazon QuickSight APIs. For example, if your projected traffic is 100 snapshot jobs before 12:00 PM per day, start 12 jobs in parallel and measure the amount of time it takes to proccess all 12 jobs. Once you obtain the result, multiply the duration by 9, for example "(12 minutes * 9 = 108 minutes)". Use the new result to determine the latest time at which the jobs need to be started to meet your target deadline. The time that it takes to process a job can be impacted by the following factors: * The dataset type (Direct Query or SPICE). * The size of the dataset. * The complexity of the calculated fields that are used in the dashboard. * The number of visuals that are on a sheet. * The types of visuals that are on the sheet. * The number of formats and snapshots that are requested in the job configuration. * The size of the generated snapshots. See also: AWS API Documentation **Request Syntax** response = client.start_dashboard_snapshot_job( AwsAccountId='string', DashboardId='string', SnapshotJobId='string', UserConfiguration={ 'AnonymousUsers': [ { 'RowLevelPermissionTags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ] }, SnapshotConfiguration={ 'FileGroups': [ { 'Files': [ { 'SheetSelections': [ { 'SheetId': 'string', 'SelectionScope': 'ALL_VISUALS'|'SELECTED_VISUALS', 'VisualIds': [ 'string', ] }, ], 'FormatType': 'CSV'|'PDF'|'EXCEL' }, ] }, ], 'DestinationConfiguration': { 'S3Destinations': [ { 'BucketConfiguration': { 'BucketName': 'string', 'BucketPrefix': 'string', 'BucketRegion': 'string' } }, ] }, 'Parameters': { 'StringParameters': [ { 'Name': 'string', 'Values': [ 'string', ] }, ], 'IntegerParameters': [ { 'Name': 'string', 'Values': [ 123, ] }, ], 'DecimalParameters': [ { 'Name': 'string', 'Values': [ 123.0, ] }, ], 'DateTimeParameters': [ { 'Name': 'string', 'Values': [ datetime(2015, 1, 1), ] }, ] } } ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that the dashboard snapshot job is executed in. * **DashboardId** (*string*) -- **[REQUIRED]** The ID of the dashboard that you want to start a snapshot job for. * **SnapshotJobId** (*string*) -- **[REQUIRED]** An ID for the dashboard snapshot job. This ID is unique to the dashboard while the job is running. This ID can be used to poll the status of a job with a "DescribeDashboardSnapshotJob" while the job runs. You can reuse this ID for another job 24 hours after the current job is completed. * **UserConfiguration** (*dict*) -- **[REQUIRED]** A structure that contains information about the anonymous users that the generated snapshot is for. This API will not return information about registered Amazon QuickSight. * **AnonymousUsers** *(list) --* An array of records that describe the anonymous users that the dashboard snapshot is generated for. * *(dict) --* A structure that contains information on the anonymous user configuration. * **RowLevelPermissionTags** *(list) --* The tags to be used for row-level security (RLS). Make sure that the relevant datasets have RLS tags configured before you start a snapshot export job. You can configure the RLS tags of a dataset with a "DataSet$RowLevelPermissionTagConfiguration" API call. These are not the tags that are used for Amazon Web Services resource tagging. For more information on row level security in Amazon QuickSight, see >>`<`__in the *Amazon QuickSight User Guide*. * *(dict) --* The key-value pair used for the row-level security tags feature. * **Key** *(string) --* **[REQUIRED]** The key for the tag. * **Value** *(string) --* **[REQUIRED]** The value that you want to assign the tag. * **SnapshotConfiguration** (*dict*) -- **[REQUIRED]** A structure that describes the configuration of the dashboard snapshot. * **FileGroups** *(list) --* **[REQUIRED]** A list of "SnapshotJobResultFileGroup" objects that contain information about the snapshot that is generated. This list can hold a maximum of 6 "FileGroup" configurations. * *(dict) --* A structure that contains the information on the snapshot files. * **Files** *(list) --* A list of "SnapshotFile" objects that contain the information on the snapshot files that need to be generated. This structure can hold 1 configuration at a time. * *(dict) --* A structure that contains the information for the snapshot that you want to generate. This information is provided by you when you start a new snapshot job. * **SheetSelections** *(list) --* **[REQUIRED]** A list of "SnapshotFileSheetSelection" objects that contain information on the dashboard sheet that is exported. These objects provide information about the snapshot artifacts that are generated during the job. This structure can hold a maximum of 5 CSV configurations, 5 Excel configurations, or 1 configuration for PDF. * *(dict) --* A structure that contains information that identifies the snapshot that needs to be generated. * **SheetId** *(string) --* **[REQUIRED]** The sheet ID of the dashboard to generate the snapshot artifact from. This value is required for CSV, Excel, and PDF format types. * **SelectionScope** *(string) --* **[REQUIRED]** The selection scope of the visuals on a sheet of a dashboard that you are generating a snapthot of. You can choose one of the following options. * "ALL_VISUALS" - Selects all visuals that are on the sheet. This value is required if the snapshot is a PDF. * "SELECTED_VISUALS" - Select the visual that you want to add to the snapshot. This value is required if the snapshot is a CSV or Excel workbook. * **VisualIds** *(list) --* A structure that lists the IDs of the visuals in the selected sheet. Supported visual types are table, pivot table visuals. This value is required if you are generating a CSV or Excel workbook. This value supports a maximum of 1 visual ID for CSV and 5 visual IDs across up to 5 sheet selections for Excel. If you are generating an Excel workbook, the order of the visual IDs provided in this structure determines the order of the worksheets in the Excel file. * *(string) --* * **FormatType** *(string) --* **[REQUIRED]** The format of the snapshot file to be generated. You can choose between "CSV", "Excel", or "PDF". * **DestinationConfiguration** *(dict) --* A structure that contains information on the Amazon S3 bucket that the generated snapshot is stored in. * **S3Destinations** *(list) --* A list of "SnapshotS3DestinationConfiguration" objects that contain Amazon S3 destination configurations. This structure can hold a maximum of 1 "S3DestinationConfiguration". * *(dict) --* A structure that describes the Amazon S3 settings to use to save the generated dashboard snapshot. * **BucketConfiguration** *(dict) --* **[REQUIRED]** A structure that contains details about the Amazon S3 bucket that the generated dashboard snapshot is saved in. * **BucketName** *(string) --* **[REQUIRED]** The name of an existing Amazon S3 bucket where the generated snapshot artifacts are sent. * **BucketPrefix** *(string) --* **[REQUIRED]** The prefix of the Amazon S3 bucket that the generated snapshots are stored in. * **BucketRegion** *(string) --* **[REQUIRED]** The region that the Amazon S3 bucket is located in. The bucket must be located in the same region that the "StartDashboardSnapshotJob" API call is made. * **Parameters** *(dict) --* A list of Amazon QuickSight parameters and the list's override values. * **StringParameters** *(list) --* The parameters that have a data type of string. * *(dict) --* A string parameter. * **Name** *(string) --* **[REQUIRED]** A display name for a string parameter. * **Values** *(list) --* **[REQUIRED]** The values of a string parameter. * *(string) --* * **IntegerParameters** *(list) --* The parameters that have a data type of integer. * *(dict) --* An integer parameter. * **Name** *(string) --* **[REQUIRED]** The name of the integer parameter. * **Values** *(list) --* **[REQUIRED]** The values for the integer parameter. * *(integer) --* * **DecimalParameters** *(list) --* The parameters that have a data type of decimal. * *(dict) --* A decimal parameter. * **Name** *(string) --* **[REQUIRED]** A display name for the decimal parameter. * **Values** *(list) --* **[REQUIRED]** The values for the decimal parameter. * *(float) --* * **DateTimeParameters** *(list) --* The parameters that have a data type of date-time. * *(dict) --* A date-time parameter. * **Name** *(string) --* **[REQUIRED]** A display name for the date-time parameter. * **Values** *(list) --* **[REQUIRED]** The values for the date-time parameter. * *(datetime) --* Return type: dict Returns: **Response Syntax** { 'Arn': 'string', 'SnapshotJobId': 'string', 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **Arn** *(string) --* The Amazon Resource Name (ARN) for the dashboard snapshot job. * **SnapshotJobId** *(string) --* The ID of the job. The job ID is set when you start a new job with a "StartDashboardSnapshotJob" API call. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.LimitExceededException" * "QuickSight.Client.exceptions.ResourceExistsException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.UnsupportedPricingPlanException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / list_theme_versions list_theme_versions ******************* QuickSight.Client.list_theme_versions(**kwargs) Lists all the versions of the themes in the current Amazon Web Services account. See also: AWS API Documentation **Request Syntax** response = client.list_theme_versions( AwsAccountId='string', ThemeId='string', NextToken='string', MaxResults=123 ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the themes that you're listing. * **ThemeId** (*string*) -- **[REQUIRED]** The ID for the theme. * **NextToken** (*string*) -- The token for the next set of results, or null if there are no more results. * **MaxResults** (*integer*) -- The maximum number of results to be returned per request. Return type: dict Returns: **Response Syntax** { 'ThemeVersionSummaryList': [ { 'VersionNumber': 123, 'Arn': 'string', 'Description': 'string', 'CreatedTime': datetime(2015, 1, 1), 'Status': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED' }, ], 'NextToken': 'string', 'Status': 123, 'RequestId': 'string' } **Response Structure** * *(dict) --* * **ThemeVersionSummaryList** *(list) --* A structure containing a list of all the versions of the specified theme. * *(dict) --* The theme version. * **VersionNumber** *(integer) --* The version number of the theme version. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the theme version. * **Description** *(string) --* The description of the theme version. * **CreatedTime** *(datetime) --* The date and time that this theme version was created. * **Status** *(string) --* The status of the theme version. * **NextToken** *(string) --* The token for the next set of results, or null if there are no more results. * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidNextTokenException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / list_groups list_groups *********** QuickSight.Client.list_groups(**kwargs) Lists all user groups in Amazon QuickSight. See also: AWS API Documentation **Request Syntax** response = client.list_groups( AwsAccountId='string', NextToken='string', MaxResults=123, Namespace='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** 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. * **NextToken** (*string*) -- A pagination token that can be used in a subsequent request. * **MaxResults** (*integer*) -- The maximum number of results to return. * **Namespace** (*string*) -- **[REQUIRED]** The namespace that you want a list of groups from. Return type: dict Returns: **Response Syntax** { 'GroupList': [ { 'Arn': 'string', 'GroupName': 'string', 'Description': 'string', 'PrincipalId': 'string' }, ], 'NextToken': 'string', 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **GroupList** *(list) --* The list of the groups. * *(dict) --* A *group* in Amazon QuickSight consists of a set of users. You can use groups to make it easier to manage access and security. * **Arn** *(string) --* The Amazon Resource Name (ARN) for the group. * **GroupName** *(string) --* The name of the group. * **Description** *(string) --* The group description. * **PrincipalId** *(string) --* The principal ID of the group. * **NextToken** *(string) --* A pagination token that can be used in a subsequent request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InvalidNextTokenException" * "QuickSight.Client.exceptions.PreconditionNotMetException" * "QuickSight.Client.exceptions.InternalFailureException" * "QuickSight.Client.exceptions.ResourceUnavailableException" QuickSight / Client / describe_account_subscription describe_account_subscription ***************************** QuickSight.Client.describe_account_subscription(**kwargs) Use the DescribeAccountSubscription operation to receive a description of an Amazon QuickSight account's subscription. A successful API call returns an "AccountInfo" object that includes an account's name, subscription status, authentication type, edition, and notification email address. See also: AWS API Documentation **Request Syntax** response = client.describe_account_subscription( AwsAccountId='string' ) Parameters: **AwsAccountId** (*string*) -- **[REQUIRED]** The Amazon Web Services account ID associated with your Amazon QuickSight account. Return type: dict Returns: **Response Syntax** { 'AccountInfo': { 'AccountName': 'string', 'Edition': 'STANDARD'|'ENTERPRISE'|'ENTERPRISE_AND_Q', 'NotificationEmail': 'string', 'AuthenticationType': 'string', 'AccountSubscriptionStatus': 'string', 'IAMIdentityCenterInstanceArn': 'string' }, 'Status': 123, 'RequestId': 'string' } **Response Structure** * *(dict) --* * **AccountInfo** *(dict) --* A structure that contains the following elements: * Your Amazon QuickSight account name. * The edition of Amazon QuickSight that your account is using. * The notification email address that is associated with the Amazon QuickSight account. * The authentication type of the Amazon QuickSight account. * The status of the Amazon QuickSight account's subscription. * **AccountName** *(string) --* The account name that you provided for the Amazon QuickSight subscription in your Amazon Web Services account. You create this name when you sign up for Amazon QuickSight. It's unique over all of Amazon Web Services, and it appears only when users sign in. * **Edition** *(string) --* The edition of your Amazon QuickSight account. * **NotificationEmail** *(string) --* The email address that will be used for Amazon QuickSight to send notifications regarding your Amazon Web Services account or Amazon QuickSight subscription. * **AuthenticationType** *(string) --* The way that your Amazon QuickSight account is authenticated. * **AccountSubscriptionStatus** *(string) --* The status of your account subscription. * **IAMIdentityCenterInstanceArn** *(string) --* The Amazon Resource Name (ARN) for the IAM Identity Center instance. * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InternalFailureException" * "QuickSight.Client.exceptions.ResourceUnavailableException" QuickSight / Client / describe_topic describe_topic ************** QuickSight.Client.describe_topic(**kwargs) Describes a topic. See also: AWS API Documentation **Request Syntax** response = client.describe_topic( AwsAccountId='string', TopicId='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The Amazon Web Services account ID. * **TopicId** (*string*) -- **[REQUIRED]** The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. Return type: dict Returns: **Response Syntax** { 'Arn': 'string', 'TopicId': 'string', 'Topic': { 'Name': 'string', 'Description': 'string', 'UserExperienceVersion': 'LEGACY'|'NEW_READER_EXPERIENCE', 'DataSets': [ { 'DatasetArn': 'string', 'DatasetName': 'string', 'DatasetDescription': 'string', 'DataAggregation': { 'DatasetRowDateGranularity': 'SECOND'|'MINUTE'|'HOUR'|'DAY'|'WEEK'|'MONTH'|'QUARTER'|'YEAR', 'DefaultDateColumnName': 'string' }, 'Filters': [ { 'FilterDescription': 'string', 'FilterClass': 'ENFORCED_VALUE_FILTER'|'CONDITIONAL_VALUE_FILTER'|'NAMED_VALUE_FILTER', 'FilterName': 'string', 'FilterSynonyms': [ 'string', ], 'OperandFieldName': 'string', 'FilterType': 'CATEGORY_FILTER'|'NUMERIC_EQUALITY_FILTER'|'NUMERIC_RANGE_FILTER'|'DATE_RANGE_FILTER'|'RELATIVE_DATE_FILTER', 'CategoryFilter': { 'CategoryFilterFunction': 'EXACT'|'CONTAINS', 'CategoryFilterType': 'CUSTOM_FILTER'|'CUSTOM_FILTER_LIST'|'FILTER_LIST', 'Constant': { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'SingularConstant': 'string', 'CollectiveConstant': { 'ValueList': [ 'string', ] } }, 'Inverse': True|False }, 'NumericEqualityFilter': { 'Constant': { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'SingularConstant': 'string' }, 'Aggregation': 'NO_AGGREGATION'|'SUM'|'AVERAGE'|'COUNT'|'DISTINCT_COUNT'|'MAX'|'MEDIAN'|'MIN'|'STDEV'|'STDEVP'|'VAR'|'VARP' }, 'NumericRangeFilter': { 'Inclusive': True|False, 'Constant': { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'RangeConstant': { 'Minimum': 'string', 'Maximum': 'string' } }, 'Aggregation': 'NO_AGGREGATION'|'SUM'|'AVERAGE'|'COUNT'|'DISTINCT_COUNT'|'MAX'|'MEDIAN'|'MIN'|'STDEV'|'STDEVP'|'VAR'|'VARP' }, 'DateRangeFilter': { 'Inclusive': True|False, 'Constant': { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'RangeConstant': { 'Minimum': 'string', 'Maximum': 'string' } } }, 'RelativeDateFilter': { 'TimeGranularity': 'SECOND'|'MINUTE'|'HOUR'|'DAY'|'WEEK'|'MONTH'|'QUARTER'|'YEAR', 'RelativeDateFilterFunction': 'PREVIOUS'|'THIS'|'LAST'|'NEXT'|'NOW', 'Constant': { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'SingularConstant': 'string' } } }, ], 'Columns': [ { 'ColumnName': 'string', 'ColumnFriendlyName': 'string', 'ColumnDescription': 'string', 'ColumnSynonyms': [ 'string', ], 'ColumnDataRole': 'DIMENSION'|'MEASURE', 'Aggregation': 'SUM'|'MAX'|'MIN'|'COUNT'|'DISTINCT_COUNT'|'AVERAGE'|'MEDIAN'|'STDEV'|'STDEVP'|'VAR'|'VARP', 'IsIncludedInTopic': True|False, 'DisableIndexing': True|False, 'ComparativeOrder': { 'UseOrdering': 'GREATER_IS_BETTER'|'LESSER_IS_BETTER'|'SPECIFIED', 'SpecifedOrder': [ 'string', ], 'TreatUndefinedSpecifiedValues': 'LEAST'|'MOST' }, 'SemanticType': { 'TypeName': 'string', 'SubTypeName': 'string', 'TypeParameters': { 'string': 'string' }, 'TruthyCellValue': 'string', 'TruthyCellValueSynonyms': [ 'string', ], 'FalseyCellValue': 'string', 'FalseyCellValueSynonyms': [ 'string', ] }, 'TimeGranularity': 'SECOND'|'MINUTE'|'HOUR'|'DAY'|'WEEK'|'MONTH'|'QUARTER'|'YEAR', 'AllowedAggregations': [ 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX'|'MEDIAN'|'SUM'|'AVERAGE'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE', ], 'NotAllowedAggregations': [ 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX'|'MEDIAN'|'SUM'|'AVERAGE'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE', ], 'DefaultFormatting': { 'DisplayFormat': 'AUTO'|'PERCENT'|'CURRENCY'|'NUMBER'|'DATE'|'STRING', 'DisplayFormatOptions': { 'UseBlankCellFormat': True|False, 'BlankCellFormat': 'string', 'DateFormat': 'string', 'DecimalSeparator': 'COMMA'|'DOT', 'GroupingSeparator': 'string', 'UseGrouping': True|False, 'FractionDigits': 123, 'Prefix': 'string', 'Suffix': 'string', 'UnitScaler': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS'|'LAKHS'|'CRORES', 'NegativeFormat': { 'Prefix': 'string', 'Suffix': 'string' }, 'CurrencySymbol': 'string' } }, 'NeverAggregateInFilter': True|False, 'CellValueSynonyms': [ { 'CellValue': 'string', 'Synonyms': [ 'string', ] }, ], 'NonAdditive': True|False }, ], 'CalculatedFields': [ { 'CalculatedFieldName': 'string', 'CalculatedFieldDescription': 'string', 'Expression': 'string', 'CalculatedFieldSynonyms': [ 'string', ], 'IsIncludedInTopic': True|False, 'DisableIndexing': True|False, 'ColumnDataRole': 'DIMENSION'|'MEASURE', 'TimeGranularity': 'SECOND'|'MINUTE'|'HOUR'|'DAY'|'WEEK'|'MONTH'|'QUARTER'|'YEAR', 'DefaultFormatting': { 'DisplayFormat': 'AUTO'|'PERCENT'|'CURRENCY'|'NUMBER'|'DATE'|'STRING', 'DisplayFormatOptions': { 'UseBlankCellFormat': True|False, 'BlankCellFormat': 'string', 'DateFormat': 'string', 'DecimalSeparator': 'COMMA'|'DOT', 'GroupingSeparator': 'string', 'UseGrouping': True|False, 'FractionDigits': 123, 'Prefix': 'string', 'Suffix': 'string', 'UnitScaler': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS'|'LAKHS'|'CRORES', 'NegativeFormat': { 'Prefix': 'string', 'Suffix': 'string' }, 'CurrencySymbol': 'string' } }, 'Aggregation': 'SUM'|'MAX'|'MIN'|'COUNT'|'DISTINCT_COUNT'|'AVERAGE'|'MEDIAN'|'STDEV'|'STDEVP'|'VAR'|'VARP', 'ComparativeOrder': { 'UseOrdering': 'GREATER_IS_BETTER'|'LESSER_IS_BETTER'|'SPECIFIED', 'SpecifedOrder': [ 'string', ], 'TreatUndefinedSpecifiedValues': 'LEAST'|'MOST' }, 'SemanticType': { 'TypeName': 'string', 'SubTypeName': 'string', 'TypeParameters': { 'string': 'string' }, 'TruthyCellValue': 'string', 'TruthyCellValueSynonyms': [ 'string', ], 'FalseyCellValue': 'string', 'FalseyCellValueSynonyms': [ 'string', ] }, 'AllowedAggregations': [ 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX'|'MEDIAN'|'SUM'|'AVERAGE'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE', ], 'NotAllowedAggregations': [ 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX'|'MEDIAN'|'SUM'|'AVERAGE'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE', ], 'NeverAggregateInFilter': True|False, 'CellValueSynonyms': [ { 'CellValue': 'string', 'Synonyms': [ 'string', ] }, ], 'NonAdditive': True|False }, ], 'NamedEntities': [ { 'EntityName': 'string', 'EntityDescription': 'string', 'EntitySynonyms': [ 'string', ], 'SemanticEntityType': { 'TypeName': 'string', 'SubTypeName': 'string', 'TypeParameters': { 'string': 'string' } }, 'Definition': [ { 'FieldName': 'string', 'PropertyName': 'string', 'PropertyRole': 'PRIMARY'|'ID', 'PropertyUsage': 'INHERIT'|'DIMENSION'|'MEASURE', 'Metric': { 'Aggregation': 'SUM'|'MIN'|'MAX'|'COUNT'|'AVERAGE'|'DISTINCT_COUNT'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE'|'MEDIAN'|'CUSTOM', 'AggregationFunctionParameters': { 'string': 'string' } } }, ] }, ] }, ], 'ConfigOptions': { 'QBusinessInsightsEnabled': True|False } }, 'RequestId': 'string', 'Status': 123, 'CustomInstructions': { 'CustomInstructionsString': 'string' } } **Response Structure** * *(dict) --* * **Arn** *(string) --* The Amazon Resource Name (ARN) of the topic. * **TopicId** *(string) --* The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. * **Topic** *(dict) --* The definition of a topic. * **Name** *(string) --* The name of the topic. * **Description** *(string) --* The description of the topic. * **UserExperienceVersion** *(string) --* The user experience version of a topic. * **DataSets** *(list) --* The data sets that the topic is associated with. * *(dict) --* A structure that represents a dataset. * **DatasetArn** *(string) --* The Amazon Resource Name (ARN) of the dataset. * **DatasetName** *(string) --* The name of the dataset. * **DatasetDescription** *(string) --* The description of the dataset. * **DataAggregation** *(dict) --* The definition of a data aggregation. * **DatasetRowDateGranularity** *(string) --* The level of time precision that is used to aggregate "DateTime" values. * **DefaultDateColumnName** *(string) --* The column name for the default date. * **Filters** *(list) --* The list of filter definitions. * *(dict) --* A structure that represents a filter used to select items for a topic. * **FilterDescription** *(string) --* A description of the filter used to select items for a topic. * **FilterClass** *(string) --* The class of the filter. Valid values for this structure are "ENFORCED_VALUE_FILTER", "CONDITIONAL_VALUE_FILTER", and "NAMED_VALUE_FILTER". * **FilterName** *(string) --* The name of the filter. * **FilterSynonyms** *(list) --* The other names or aliases for the filter. * *(string) --* * **OperandFieldName** *(string) --* The name of the field that the filter operates on. * **FilterType** *(string) --* The type of the filter. Valid values for this structure are "CATEGORY_FILTER", "NUMERIC_EQUALITY_FILTER", "NUMERIC_RANGE_FILTER", "DATE_RANGE_FILTER", and "RELATIVE_DATE_FILTER". * **CategoryFilter** *(dict) --* The category filter that is associated with this filter. * **CategoryFilterFunction** *(string) --* The category filter function. Valid values for this structure are "EXACT" and "CONTAINS". * **CategoryFilterType** *(string) --* The category filter type. This element is used to specify whether a filter is a simple category filter or an inverse category filter. * **Constant** *(dict) --* The constant used in a category filter. * **ConstantType** *(string) --* The type of category filter constant. This element is used to specify whether a constant is a singular or collective. Valid values are "SINGULAR" and "COLLECTIVE". * **SingularConstant** *(string) --* A singular constant used in a category filter. This element is used to specify a single value for the constant. * **CollectiveConstant** *(dict) --* A collective constant used in a category filter. This element is used to specify a list of values for the constant. * **ValueList** *(list) --* A list of values for the collective constant. * *(string) --* * **Inverse** *(boolean) --* A Boolean value that indicates if the filter is inverse. * **NumericEqualityFilter** *(dict) --* The numeric equality filter. * **Constant** *(dict) --* The constant used in a numeric equality filter. * **ConstantType** *(string) --* The type of the singular filter constant. Valid values for this structure are "SINGULAR". * **SingularConstant** *(string) --* The value of the singular filter constant. * **Aggregation** *(string) --* An aggregation function that specifies how to calculate the value of a numeric field for a topic. Valid values for this structure are "NO_AGGREGATION", "SUM", "AVERAGE", "COUNT", "DISTINCT_COUNT", "MAX", "MEDIAN", "MIN", "STDEV", "STDEVP", "VAR", and "VARP". * **NumericRangeFilter** *(dict) --* The numeric range filter. * **Inclusive** *(boolean) --* A Boolean value that indicates whether the endpoints of the numeric range are included in the filter. If set to true, topics whose numeric field value is equal to the endpoint values will be included in the filter. If set to false, topics whose numeric field value is equal to the endpoint values will be excluded from the filter. * **Constant** *(dict) --* The constant used in a numeric range filter. * **ConstantType** *(string) --* The data type of the constant value that is used in a range filter. Valid values for this structure are "RANGE". * **RangeConstant** *(dict) --* The value of the constant that is used to specify the endpoints of a range filter. * **Minimum** *(string) --* The minimum value for a range constant. * **Maximum** *(string) --* The maximum value for a range constant. * **Aggregation** *(string) --* An aggregation function that specifies how to calculate the value of a numeric field for a topic, Valid values for this structure are "NO_AGGREGATION", "SUM", "AVERAGE", "COUNT", "DISTINCT_COUNT", "MAX", "MEDIAN", "MIN", "STDEV", "STDEVP", "VAR", and "VARP". * **DateRangeFilter** *(dict) --* The date range filter. * **Inclusive** *(boolean) --* A Boolean value that indicates whether the date range filter should include the boundary values. If set to true, the filter includes the start and end dates. If set to false, the filter excludes them. * **Constant** *(dict) --* The constant used in a date range filter. * **ConstantType** *(string) --* The data type of the constant value that is used in a range filter. Valid values for this structure are "RANGE". * **RangeConstant** *(dict) --* The value of the constant that is used to specify the endpoints of a range filter. * **Minimum** *(string) --* The minimum value for a range constant. * **Maximum** *(string) --* The maximum value for a range constant. * **RelativeDateFilter** *(dict) --* The relative date filter. * **TimeGranularity** *(string) --* The level of time precision that is used to aggregate "DateTime" values. * **RelativeDateFilterFunction** *(string) --* The function to be used in a relative date filter to determine the range of dates to include in the results. Valid values for this structure are "BEFORE", "AFTER", and "BETWEEN". * **Constant** *(dict) --* The constant used in a relative date filter. * **ConstantType** *(string) --* The type of the singular filter constant. Valid values for this structure are "SINGULAR". * **SingularConstant** *(string) --* The value of the singular filter constant. * **Columns** *(list) --* The list of column definitions. * *(dict) --* Represents a column in a dataset. * **ColumnName** *(string) --* The name of the column. * **ColumnFriendlyName** *(string) --* A user-friendly name for the column. * **ColumnDescription** *(string) --* A description of the column and its contents. * **ColumnSynonyms** *(list) --* The other names or aliases for the column. * *(string) --* * **ColumnDataRole** *(string) --* The role of the column in the data. Valid values are "DIMENSION" and "MEASURE". * **Aggregation** *(string) --* The type of aggregation that is performed on the column data when it's queried. * **IsIncludedInTopic** *(boolean) --* A Boolean value that indicates whether the column is included in the query results. * **DisableIndexing** *(boolean) --* A Boolean value that indicates whether the column shows in the autocomplete functionality. * **ComparativeOrder** *(dict) --* The order in which data is displayed for the column when it's used in a comparative context. * **UseOrdering** *(string) --* The ordering type for a column. Valid values for this structure are "GREATER_IS_BETTER", "LESSER_IS_BETTER" and "SPECIFIED". * **SpecifedOrder** *(list) --* The list of columns to be used in the ordering. * *(string) --* * **TreatUndefinedSpecifiedValues** *(string) --* The treat of undefined specified values. Valid values for this structure are "LEAST" and "MOST". * **SemanticType** *(dict) --* The semantic type of data contained in the column. * **TypeName** *(string) --* The semantic type name. * **SubTypeName** *(string) --* The semantic type sub type name. * **TypeParameters** *(dict) --* The semantic type parameters. * *(string) --* * *(string) --* * **TruthyCellValue** *(string) --* The semantic type truthy cell value. * **TruthyCellValueSynonyms** *(list) --* The other names or aliases for the true cell value. * *(string) --* * **FalseyCellValue** *(string) --* The semantic type falsey cell value. * **FalseyCellValueSynonyms** *(list) --* The other names or aliases for the false cell value. * *(string) --* * **TimeGranularity** *(string) --* The level of time precision that is used to aggregate "DateTime" values. * **AllowedAggregations** *(list) --* The list of aggregation types that are allowed for the column. Valid values for this structure are "COUNT", "DISTINCT_COUNT", "MIN", "MAX", "MEDIAN", "SUM", "AVERAGE", "STDEV", "STDEVP", "VAR", "VARP", and "PERCENTILE". * *(string) --* * **NotAllowedAggregations** *(list) --* The list of aggregation types that are not allowed for the column. Valid values for this structure are "COUNT", "DISTINCT_COUNT", "MIN", "MAX", "MEDIAN", "SUM", "AVERAGE", "STDEV", "STDEVP", "VAR", "VARP", and "PERCENTILE". * *(string) --* * **DefaultFormatting** *(dict) --* The default formatting used for values in the column. * **DisplayFormat** *(string) --* The display format. Valid values for this structure are "AUTO", "PERCENT", "CURRENCY", "NUMBER", "DATE", and "STRING". * **DisplayFormatOptions** *(dict) --* The additional options for display formatting. * **UseBlankCellFormat** *(boolean) --* A Boolean value that indicates whether to use blank cell format. * **BlankCellFormat** *(string) --* Determines the blank cell format. * **DateFormat** *(string) --* Determines the "DateTime" format. * **DecimalSeparator** *(string) --* Determines the decimal separator. * **GroupingSeparator** *(string) --* Determines the grouping separator. * **UseGrouping** *(boolean) --* A Boolean value that indicates whether to use grouping. * **FractionDigits** *(integer) --* Determines the number of fraction digits. * **Prefix** *(string) --* The prefix value for a display format. * **Suffix** *(string) --* The suffix value for a display format. * **UnitScaler** *(string) --* The unit scaler. Valid values for this structure are: "NONE", "AUTO", "THOUSANDS", "MILLIONS", "BILLIONS", and "TRILLIONS". * **NegativeFormat** *(dict) --* The negative format. * **Prefix** *(string) --* The prefix for a negative format. * **Suffix** *(string) --* The suffix for a negative format. * **CurrencySymbol** *(string) --* The currency symbol, such as "USD". * **NeverAggregateInFilter** *(boolean) --* A Boolean value that indicates whether to aggregate the column data when it's used in a filter context. * **CellValueSynonyms** *(list) --* The other names or aliases for the column cell value. * *(dict) --* A structure that represents the cell value synonym. * **CellValue** *(string) --* The cell value. * **Synonyms** *(list) --* Other names or aliases for the cell value. * *(string) --* * **NonAdditive** *(boolean) --* The non additive value for the column. * **CalculatedFields** *(list) --* The list of calculated field definitions. * *(dict) --* A structure that represents a calculated field. * **CalculatedFieldName** *(string) --* The calculated field name. * **CalculatedFieldDescription** *(string) --* The calculated field description. * **Expression** *(string) --* The calculated field expression. * **CalculatedFieldSynonyms** *(list) --* The other names or aliases for the calculated field. * *(string) --* * **IsIncludedInTopic** *(boolean) --* A boolean value that indicates if a calculated field is included in the topic. * **DisableIndexing** *(boolean) --* A Boolean value that indicates if a calculated field is visible in the autocomplete. * **ColumnDataRole** *(string) --* The column data role for a calculated field. Valid values for this structure are "DIMENSION" and "MEASURE". * **TimeGranularity** *(string) --* The level of time precision that is used to aggregate "DateTime" values. * **DefaultFormatting** *(dict) --* The default formatting definition. * **DisplayFormat** *(string) --* The display format. Valid values for this structure are "AUTO", "PERCENT", "CURRENCY", "NUMBER", "DATE", and "STRING". * **DisplayFormatOptions** *(dict) --* The additional options for display formatting. * **UseBlankCellFormat** *(boolean) --* A Boolean value that indicates whether to use blank cell format. * **BlankCellFormat** *(string) --* Determines the blank cell format. * **DateFormat** *(string) --* Determines the "DateTime" format. * **DecimalSeparator** *(string) --* Determines the decimal separator. * **GroupingSeparator** *(string) --* Determines the grouping separator. * **UseGrouping** *(boolean) --* A Boolean value that indicates whether to use grouping. * **FractionDigits** *(integer) --* Determines the number of fraction digits. * **Prefix** *(string) --* The prefix value for a display format. * **Suffix** *(string) --* The suffix value for a display format. * **UnitScaler** *(string) --* The unit scaler. Valid values for this structure are: "NONE", "AUTO", "THOUSANDS", "MILLIONS", "BILLIONS", and "TRILLIONS". * **NegativeFormat** *(dict) --* The negative format. * **Prefix** *(string) --* The prefix for a negative format. * **Suffix** *(string) --* The suffix for a negative format. * **CurrencySymbol** *(string) --* The currency symbol, such as "USD". * **Aggregation** *(string) --* The default aggregation. Valid values for this structure are "SUM", "MAX", "MIN", "COUNT", "DISTINCT_COUNT", and "AVERAGE". * **ComparativeOrder** *(dict) --* The order in which data is displayed for the calculated field when it's used in a comparative context. * **UseOrdering** *(string) --* The ordering type for a column. Valid values for this structure are "GREATER_IS_BETTER", "LESSER_IS_BETTER" and "SPECIFIED". * **SpecifedOrder** *(list) --* The list of columns to be used in the ordering. * *(string) --* * **TreatUndefinedSpecifiedValues** *(string) --* The treat of undefined specified values. Valid values for this structure are "LEAST" and "MOST". * **SemanticType** *(dict) --* The semantic type. * **TypeName** *(string) --* The semantic type name. * **SubTypeName** *(string) --* The semantic type sub type name. * **TypeParameters** *(dict) --* The semantic type parameters. * *(string) --* * *(string) --* * **TruthyCellValue** *(string) --* The semantic type truthy cell value. * **TruthyCellValueSynonyms** *(list) --* The other names or aliases for the true cell value. * *(string) --* * **FalseyCellValue** *(string) --* The semantic type falsey cell value. * **FalseyCellValueSynonyms** *(list) --* The other names or aliases for the false cell value. * *(string) --* * **AllowedAggregations** *(list) --* The list of aggregation types that are allowed for the calculated field. Valid values for this structure are "COUNT", "DISTINCT_COUNT", "MIN", "MAX", "MEDIAN", "SUM", "AVERAGE", "STDEV", "STDEVP", "VAR", "VARP", and "PERCENTILE". * *(string) --* * **NotAllowedAggregations** *(list) --* The list of aggregation types that are not allowed for the calculated field. Valid values for this structure are "COUNT", "DISTINCT_COUNT", "MIN", "MAX", "MEDIAN", "SUM", "AVERAGE", "STDEV", "STDEVP", "VAR", "VARP", and "PERCENTILE". * *(string) --* * **NeverAggregateInFilter** *(boolean) --* A Boolean value that indicates whether to never aggregate calculated field in filters. * **CellValueSynonyms** *(list) --* The other names or aliases for the calculated field cell value. * *(dict) --* A structure that represents the cell value synonym. * **CellValue** *(string) --* The cell value. * **Synonyms** *(list) --* Other names or aliases for the cell value. * *(string) --* * **NonAdditive** *(boolean) --* The non additive for the table style target. * **NamedEntities** *(list) --* The list of named entities definitions. * *(dict) --* A structure that represents a named entity. * **EntityName** *(string) --* The name of the named entity. * **EntityDescription** *(string) --* The description of the named entity. * **EntitySynonyms** *(list) --* The other names or aliases for the named entity. * *(string) --* * **SemanticEntityType** *(dict) --* The type of named entity that a topic represents. * **TypeName** *(string) --* The semantic entity type name. * **SubTypeName** *(string) --* The semantic entity sub type name. * **TypeParameters** *(dict) --* The semantic entity type parameters. * *(string) --* * *(string) --* * **Definition** *(list) --* The definition of a named entity. * *(dict) --* A structure that represents a named entity. * **FieldName** *(string) --* The name of the entity. * **PropertyName** *(string) --* The property name to be used for the named entity. * **PropertyRole** *(string) --* The property role. Valid values for this structure are "PRIMARY" and "ID". * **PropertyUsage** *(string) --* The property usage. Valid values for this structure are "INHERIT", "DIMENSION", and "MEASURE". * **Metric** *(dict) --* The definition of a metric. * **Aggregation** *(string) --* The aggregation of a named entity. Valid values for this structure are "SUM", "MIN", "MAX", "COUNT", "AVERAGE", "DISTINCT_COUNT", "STDEV", "STDEVP", "VAR", "VARP", "PERCENTILE", "MEDIAN", and "CUSTOM". * **AggregationFunctionParameters** *(dict) --* The additional parameters for an aggregation function. * *(string) --* * *(string) --* * **ConfigOptions** *(dict) --* Configuration options for a "Topic". * **QBusinessInsightsEnabled** *(boolean) --* Enables Amazon Q Business Insights for a "Topic". * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. * **CustomInstructions** *(dict) --* Custom instructions for the topic. * **CustomInstructionsString** *(string) --* A text field for providing additional guidance or context for response generation. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / create_data_set create_data_set *************** QuickSight.Client.create_data_set(**kwargs) Creates a dataset. This operation doesn't support datasets that include uploaded files as a source. See also: AWS API Documentation **Request Syntax** response = client.create_data_set( AwsAccountId='string', DataSetId='string', Name='string', PhysicalTableMap={ 'string': { 'RelationalTable': { 'DataSourceArn': 'string', 'Catalog': 'string', 'Schema': 'string', 'Name': 'string', 'InputColumns': [ { 'Name': 'string', 'Type': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME'|'BIT'|'BOOLEAN'|'JSON', 'SubType': 'FLOAT'|'FIXED' }, ] }, 'CustomSql': { 'DataSourceArn': 'string', 'Name': 'string', 'SqlQuery': 'string', 'Columns': [ { 'Name': 'string', 'Type': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME'|'BIT'|'BOOLEAN'|'JSON', 'SubType': 'FLOAT'|'FIXED' }, ] }, 'S3Source': { 'DataSourceArn': 'string', 'UploadSettings': { 'Format': 'CSV'|'TSV'|'CLF'|'ELF'|'XLSX'|'JSON', 'StartFromRow': 123, 'ContainsHeader': True|False, 'TextQualifier': 'DOUBLE_QUOTE'|'SINGLE_QUOTE', 'Delimiter': 'string' }, 'InputColumns': [ { 'Name': 'string', 'Type': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME'|'BIT'|'BOOLEAN'|'JSON', 'SubType': 'FLOAT'|'FIXED' }, ] } } }, LogicalTableMap={ 'string': { 'Alias': 'string', 'DataTransforms': [ { 'ProjectOperation': { 'ProjectedColumns': [ 'string', ] }, 'FilterOperation': { 'ConditionExpression': 'string' }, 'CreateColumnsOperation': { 'Columns': [ { 'ColumnName': 'string', 'ColumnId': 'string', 'Expression': 'string' }, ] }, 'RenameColumnOperation': { 'ColumnName': 'string', 'NewColumnName': 'string' }, 'CastColumnTypeOperation': { 'ColumnName': 'string', 'NewColumnType': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME', 'SubType': 'FLOAT'|'FIXED', 'Format': 'string' }, 'TagColumnOperation': { 'ColumnName': 'string', 'Tags': [ { 'ColumnGeographicRole': 'COUNTRY'|'STATE'|'COUNTY'|'CITY'|'POSTCODE'|'LONGITUDE'|'LATITUDE', 'ColumnDescription': { 'Text': 'string' } }, ] }, 'UntagColumnOperation': { 'ColumnName': 'string', 'TagNames': [ 'COLUMN_GEOGRAPHIC_ROLE'|'COLUMN_DESCRIPTION', ] }, 'OverrideDatasetParameterOperation': { 'ParameterName': 'string', 'NewParameterName': 'string', 'NewDefaultValues': { 'StringStaticValues': [ 'string', ], 'DecimalStaticValues': [ 123.0, ], 'DateTimeStaticValues': [ datetime(2015, 1, 1), ], 'IntegerStaticValues': [ 123, ] } } }, ], 'Source': { 'JoinInstruction': { 'LeftOperand': 'string', 'RightOperand': 'string', 'LeftJoinKeyProperties': { 'UniqueKey': True|False }, 'RightJoinKeyProperties': { 'UniqueKey': True|False }, 'Type': 'INNER'|'OUTER'|'LEFT'|'RIGHT', 'OnClause': 'string' }, 'PhysicalTableId': 'string', 'DataSetArn': 'string' } } }, ImportMode='SPICE'|'DIRECT_QUERY', ColumnGroups=[ { 'GeoSpatialColumnGroup': { 'Name': 'string', 'CountryCode': 'US', 'Columns': [ 'string', ] } }, ], FieldFolders={ 'string': { 'description': 'string', 'columns': [ 'string', ] } }, Permissions=[ { 'Principal': 'string', 'Actions': [ 'string', ] }, ], RowLevelPermissionDataSet={ 'Namespace': 'string', 'Arn': 'string', 'PermissionPolicy': 'GRANT_ACCESS'|'DENY_ACCESS', 'FormatVersion': 'VERSION_1'|'VERSION_2', 'Status': 'ENABLED'|'DISABLED' }, RowLevelPermissionTagConfiguration={ 'Status': 'ENABLED'|'DISABLED', 'TagRules': [ { 'TagKey': 'string', 'ColumnName': 'string', 'TagMultiValueDelimiter': 'string', 'MatchAllValue': 'string' }, ], 'TagRuleConfigurations': [ [ 'string', ], ] }, ColumnLevelPermissionRules=[ { 'Principals': [ 'string', ], 'ColumnNames': [ 'string', ] }, ], Tags=[ { 'Key': 'string', 'Value': 'string' }, ], DataSetUsageConfiguration={ 'DisableUseAsDirectQuerySource': True|False, 'DisableUseAsImportedSource': True|False }, DatasetParameters=[ { 'StringDatasetParameter': { 'Id': 'string', 'Name': 'string', 'ValueType': 'MULTI_VALUED'|'SINGLE_VALUED', 'DefaultValues': { 'StaticValues': [ 'string', ] } }, 'DecimalDatasetParameter': { 'Id': 'string', 'Name': 'string', 'ValueType': 'MULTI_VALUED'|'SINGLE_VALUED', 'DefaultValues': { 'StaticValues': [ 123.0, ] } }, 'IntegerDatasetParameter': { 'Id': 'string', 'Name': 'string', 'ValueType': 'MULTI_VALUED'|'SINGLE_VALUED', 'DefaultValues': { 'StaticValues': [ 123, ] } }, 'DateTimeDatasetParameter': { 'Id': 'string', 'Name': 'string', 'ValueType': 'MULTI_VALUED'|'SINGLE_VALUED', 'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND', 'DefaultValues': { 'StaticValues': [ datetime(2015, 1, 1), ] } } }, ], FolderArns=[ 'string', ], PerformanceConfiguration={ 'UniqueKeys': [ { 'ColumnNames': [ 'string', ] }, ] }, UseAs='RLS_RULES' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The Amazon Web Services account ID. * **DataSetId** (*string*) -- **[REQUIRED]** 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** (*string*) -- **[REQUIRED]** The display name for the dataset. * **PhysicalTableMap** (*dict*) -- **[REQUIRED]** Declares the physical tables that are available in the underlying data sources. * *(string) --* * *(dict) --* A view of a data source that contains information about the shape of the data in the underlying source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null. * **RelationalTable** *(dict) --* A physical table type for relational data sources. * **DataSourceArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) for the data source. * **Catalog** *(string) --* The catalog associated with a table. * **Schema** *(string) --* The schema name. This name applies to certain relational database engines. * **Name** *(string) --* **[REQUIRED]** The name of the relational table. * **InputColumns** *(list) --* **[REQUIRED]** The column schema of the table. * *(dict) --* Metadata for a column that is used as the input of a transform operation. * **Name** *(string) --* **[REQUIRED]** The name of this column in the underlying data source. * **Type** *(string) --* **[REQUIRED]** The data type of the column. * **SubType** *(string) --* The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset. * **CustomSql** *(dict) --* A physical table type built from the results of the custom SQL query. * **DataSourceArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the data source. * **Name** *(string) --* **[REQUIRED]** A display name for the SQL query result. * **SqlQuery** *(string) --* **[REQUIRED]** The SQL query. * **Columns** *(list) --* The column schema from the SQL query result set. * *(dict) --* Metadata for a column that is used as the input of a transform operation. * **Name** *(string) --* **[REQUIRED]** The name of this column in the underlying data source. * **Type** *(string) --* **[REQUIRED]** The data type of the column. * **SubType** *(string) --* The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset. * **S3Source** *(dict) --* A physical table type for as S3 data source. * **DataSourceArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) for the data source. * **UploadSettings** *(dict) --* Information about the format for the S3 source file or files. * **Format** *(string) --* File format. * **StartFromRow** *(integer) --* A row number to start reading data from. * **ContainsHeader** *(boolean) --* Whether the file has a header row, or the files each have a header row. * **TextQualifier** *(string) --* Text qualifier. * **Delimiter** *(string) --* The delimiter between values in the file. * **InputColumns** *(list) --* **[REQUIRED]** A physical table type for an S3 data source. Note: For files that aren't JSON, only "STRING" data types are supported in input columns. * *(dict) --* Metadata for a column that is used as the input of a transform operation. * **Name** *(string) --* **[REQUIRED]** The name of this column in the underlying data source. * **Type** *(string) --* **[REQUIRED]** The data type of the column. * **SubType** *(string) --* The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset. * **LogicalTableMap** (*dict*) -- Configures the combination and transformation of the data from the physical tables. * *(string) --* An identifier for the logical table that is defined in the dataset * *(dict) --* A *logical table* is a unit that joins and that data transformations operate on. A logical table has a source, which can be either a physical table or result of a join. When a logical table points to a physical table, the logical table acts as a mutable copy of that physical table through transform operations. * **Alias** *(string) --* **[REQUIRED]** A display name for the logical table. * **DataTransforms** *(list) --* Transform operations that act on this logical table. For this structure to be valid, only one of the attributes can be non-null. * *(dict) --* A data transformation on a logical table. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null. * **ProjectOperation** *(dict) --* An operation that projects columns. Operations that come after a projection can only refer to projected columns. * **ProjectedColumns** *(list) --* **[REQUIRED]** Projected columns. * *(string) --* * **FilterOperation** *(dict) --* An operation that filters rows based on some condition. * **ConditionExpression** *(string) --* **[REQUIRED]** An expression that must evaluate to a Boolean value. Rows for which the expression evaluates to true are kept in the dataset. * **CreateColumnsOperation** *(dict) --* An operation that creates calculated columns. Columns created in one such operation form a lexical closure. * **Columns** *(list) --* **[REQUIRED]** Calculated columns to create. * *(dict) --* A calculated column for a dataset. * **ColumnName** *(string) --* **[REQUIRED]** Column name. * **ColumnId** *(string) --* **[REQUIRED]** A unique ID to identify a calculated column. During a dataset update, if the column ID of a calculated column matches that of an existing calculated column, Amazon QuickSight preserves the existing calculated column. * **Expression** *(string) --* **[REQUIRED]** An expression that defines the calculated column. * **RenameColumnOperation** *(dict) --* An operation that renames a column. * **ColumnName** *(string) --* **[REQUIRED]** The name of the column to be renamed. * **NewColumnName** *(string) --* **[REQUIRED]** The new name for the column. * **CastColumnTypeOperation** *(dict) --* A transform operation that casts a column to a different type. * **ColumnName** *(string) --* **[REQUIRED]** Column name. * **NewColumnType** *(string) --* **[REQUIRED]** New column data type. * **SubType** *(string) --* The sub data type of the new column. Sub types are only available for decimal columns that are part of a SPICE dataset. * **Format** *(string) --* When casting a column from string to datetime type, you can supply a string in a format supported by Amazon QuickSight to denote the source data format. * **TagColumnOperation** *(dict) --* An operation that tags a column with additional information. * **ColumnName** *(string) --* **[REQUIRED]** The column that this operation acts on. * **Tags** *(list) --* **[REQUIRED]** The dataset column tag, currently only used for geospatial type tagging. Note: This is not tags for the Amazon Web Services tagging feature. * *(dict) --* A tag for a column in a "TagColumnOperation" structure. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null. * **ColumnGeographicRole** *(string) --* A geospatial role for a column. * **ColumnDescription** *(dict) --* A description for a column. * **Text** *(string) --* The text of a description for a column. * **UntagColumnOperation** *(dict) --* A transform operation that removes tags associated with a column. * **ColumnName** *(string) --* **[REQUIRED]** The column that this operation acts on. * **TagNames** *(list) --* **[REQUIRED]** The column tags to remove from this column. * *(string) --* * **OverrideDatasetParameterOperation** *(dict) --* A transform operation that overrides the dataset parameter values that are defined in another dataset. * **ParameterName** *(string) --* **[REQUIRED]** The name of the parameter to be overridden with different values. * **NewParameterName** *(string) --* The new name for the parameter. * **NewDefaultValues** *(dict) --* The new default values for the parameter. * **StringStaticValues** *(list) --* A list of static default values for a given string parameter. * *(string) --* The default value for the string parameter. * **DecimalStaticValues** *(list) --* A list of static default values for a given decimal parameter. * *(float) --* The default value for the decimal parameter. * **DateTimeStaticValues** *(list) --* A list of static default values for a given date time parameter. * *(datetime) --* The default value for the date time parameter. * **IntegerStaticValues** *(list) --* A list of static default values for a given integer parameter. * *(integer) --* The default value for the integer parameter. * **Source** *(dict) --* **[REQUIRED]** Source of this logical table. * **JoinInstruction** *(dict) --* Specifies the result of a join of two logical tables. * **LeftOperand** *(string) --* **[REQUIRED]** The operand on the left side of a join. * **RightOperand** *(string) --* **[REQUIRED]** The operand on the right side of a join. * **LeftJoinKeyProperties** *(dict) --* Join key properties of the left operand. * **UniqueKey** *(boolean) --* A value that indicates that a row in a table is uniquely identified by the columns in a join key. This is used by Amazon QuickSight to optimize query performance. * **RightJoinKeyProperties** *(dict) --* Join key properties of the right operand. * **UniqueKey** *(boolean) --* A value that indicates that a row in a table is uniquely identified by the columns in a join key. This is used by Amazon QuickSight to optimize query performance. * **Type** *(string) --* **[REQUIRED]** The type of join that it is. * **OnClause** *(string) --* **[REQUIRED]** The join instructions provided in the "ON" clause of a join. * **PhysicalTableId** *(string) --* Physical table ID. * **DataSetArn** *(string) --* The Amazon Resource Number (ARN) of the parent dataset. * **ImportMode** (*string*) -- **[REQUIRED]** Indicates whether you want to import the data into SPICE. * **ColumnGroups** (*list*) -- Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported. * *(dict) --* Groupings of columns that work together in certain Amazon QuickSight features. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null. * **GeoSpatialColumnGroup** *(dict) --* Geospatial column group that denotes a hierarchy. * **Name** *(string) --* **[REQUIRED]** A display name for the hierarchy. * **CountryCode** *(string) --* Country code. * **Columns** *(list) --* **[REQUIRED]** Columns in this hierarchy. * *(string) --* * **FieldFolders** (*dict*) -- The folder that contains fields and nested subfolders for your dataset. * *(string) --* * *(dict) --* A FieldFolder element is a folder that contains fields and nested subfolders. * **description** *(string) --* The description for a field folder. * **columns** *(list) --* A folder has a list of columns. A column can only be in one folder. * *(string) --* * **Permissions** (*list*) -- A list of resource permissions on the dataset. * *(dict) --* Permission for the resource. * **Principal** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the principal. This can be one of the following: * The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.) * The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.) * The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.) * **Actions** *(list) --* **[REQUIRED]** The IAM action to grant or revoke permissions on. * *(string) --* * **RowLevelPermissionDataSet** (*dict*) -- The row-level security configuration for the data that you want to create. * **Namespace** *(string) --* The namespace associated with the dataset that contains permissions for RLS. * **Arn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS. * **PermissionPolicy** *(string) --* **[REQUIRED]** The type of permissions to use when interpreting the permissions for RLS. "DENY_ACCESS" is included for backward compatibility only. * **FormatVersion** *(string) --* The user or group rules associated with the dataset that contains permissions for RLS. By default, "FormatVersion" is "VERSION_1". When "FormatVersion" is "VERSION_1", "UserName" and "GroupName" are required. When "FormatVersion" is "VERSION_2", "UserARN" and "GroupARN" are required, and "Namespace" must not exist. * **Status** *(string) --* The status of the row-level security permission dataset. If enabled, the status is "ENABLED". If disabled, the status is "DISABLED". * **RowLevelPermissionTagConfiguration** (*dict*) -- The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only. * **Status** *(string) --* The status of row-level security tags. If enabled, the status is "ENABLED". If disabled, the status is "DISABLED". * **TagRules** *(list) --* **[REQUIRED]** A set of rules associated with row-level security, such as the tag names and columns that they are assigned to. * *(dict) --* A set of rules associated with a tag. * **TagKey** *(string) --* **[REQUIRED]** The unique key for a tag. * **ColumnName** *(string) --* **[REQUIRED]** The column name that a tag key is assigned to. * **TagMultiValueDelimiter** *(string) --* A string that you want to use to delimit the values when you pass the values at run time. For example, you can delimit the values with a comma. * **MatchAllValue** *(string) --* A string that you want to use to filter by all the values in a column in the dataset and don’t want to list the values one by one. For example, you can use an asterisk as your match all value. * **TagRuleConfigurations** *(list) --* A list of tag configuration rules to apply to a dataset. All tag configurations have the OR condition. Tags within each tile will be joined (AND). At least one rule in this structure must have all tag values assigned to it to apply Row-level security (RLS) to the dataset. * *(list) --* * *(string) --* * **ColumnLevelPermissionRules** (*list*) -- A set of one or more definitions of a >>``<>``<<. * *(dict) --* A rule defined to grant access on one or more restricted columns. Each dataset can have multiple rules. To create a restricted column, you add it to one or more rules. Each rule must contain at least one column and at least one user or group. To be able to see a restricted column, a user or group needs to be added to a rule for that column. * **Principals** *(list) --* An array of Amazon Resource Names (ARNs) for Amazon QuickSight users or groups. * *(string) --* * **ColumnNames** *(list) --* An array of column names. * *(string) --* * **Tags** (*list*) -- Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset. * *(dict) --* The key or keys of the key-value pairs for the resource tag or tags assigned to the resource. * **Key** *(string) --* **[REQUIRED]** Tag key. * **Value** *(string) --* **[REQUIRED]** Tag value. * **DataSetUsageConfiguration** (*dict*) -- The usage configuration to apply to child datasets that reference this dataset as a source. * **DisableUseAsDirectQuerySource** *(boolean) --* An option that controls whether a child dataset of a direct query can use this dataset as a source. * **DisableUseAsImportedSource** *(boolean) --* An option that controls whether a child dataset that's stored in QuickSight can use this dataset as a source. * **DatasetParameters** (*list*) -- The parameter declarations of the dataset. * *(dict) --* A parameter that is created in a dataset. The parameter can be a string, integer, decimal, or datetime data type. * **StringDatasetParameter** *(dict) --* A string parameter that is created in the dataset. * **Id** *(string) --* **[REQUIRED]** An identifier for the string parameter that is created in the dataset. * **Name** *(string) --* **[REQUIRED]** The name of the string parameter that is created in the dataset. * **ValueType** *(string) --* **[REQUIRED]** The value type of the dataset parameter. Valid values are "single value" or "multi value". * **DefaultValues** *(dict) --* A list of default values for a given string dataset parameter type. This structure only accepts static values. * **StaticValues** *(list) --* A list of static default values for a given string parameter. * *(string) --* The default value for the string parameter. * **DecimalDatasetParameter** *(dict) --* A decimal parameter that is created in the dataset. * **Id** *(string) --* **[REQUIRED]** An identifier for the decimal parameter created in the dataset. * **Name** *(string) --* **[REQUIRED]** The name of the decimal parameter that is created in the dataset. * **ValueType** *(string) --* **[REQUIRED]** The value type of the dataset parameter. Valid values are "single value" or "multi value". * **DefaultValues** *(dict) --* A list of default values for a given decimal parameter. This structure only accepts static values. * **StaticValues** *(list) --* A list of static default values for a given decimal parameter. * *(float) --* The default value for the decimal parameter. * **IntegerDatasetParameter** *(dict) --* An integer parameter that is created in the dataset. * **Id** *(string) --* **[REQUIRED]** An identifier for the integer parameter created in the dataset. * **Name** *(string) --* **[REQUIRED]** The name of the integer parameter that is created in the dataset. * **ValueType** *(string) --* **[REQUIRED]** The value type of the dataset parameter. Valid values are "single value" or "multi value". * **DefaultValues** *(dict) --* A list of default values for a given integer parameter. This structure only accepts static values. * **StaticValues** *(list) --* A list of static default values for a given integer parameter. * *(integer) --* The default value for the integer parameter. * **DateTimeDatasetParameter** *(dict) --* A date time parameter that is created in the dataset. * **Id** *(string) --* **[REQUIRED]** An identifier for the parameter that is created in the dataset. * **Name** *(string) --* **[REQUIRED]** The name of the date time parameter that is created in the dataset. * **ValueType** *(string) --* **[REQUIRED]** The value type of the dataset parameter. Valid values are "single value" or "multi value". * **TimeGranularity** *(string) --* The time granularity of the date time parameter. * **DefaultValues** *(dict) --* A list of default values for a given date time parameter. This structure only accepts static values. * **StaticValues** *(list) --* A list of static default values for a given date time parameter. * *(datetime) --* The default value for the date time parameter. * **FolderArns** (*list*) -- When you create the dataset, Amazon QuickSight adds the dataset to these folders. * *(string) --* * **PerformanceConfiguration** (*dict*) -- The configuration for the performance optimization of the dataset that contains a "UniqueKey" configuration. * **UniqueKeys** *(list) --* A "UniqueKey" configuration. * *(dict) --* A "UniqueKey" configuration that references a dataset column. * **ColumnNames** *(list) --* **[REQUIRED]** The name of the column that is referenced in the "UniqueKey" configuration. * *(string) --* * **UseAs** (*string*) -- The usage of the dataset. "RLS_RULES" must be specified for RLS permission datasets. Return type: dict Returns: **Response Syntax** { 'Arn': 'string', 'DataSetId': 'string', 'IngestionArn': 'string', 'IngestionId': 'string', 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **Arn** *(string) --* The Amazon Resource Name (ARN) of the dataset. * **DataSetId** *(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. * **IngestionArn** *(string) --* The ARN for the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE. * **IngestionId** *(string) --* The ID of the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.LimitExceededException" * "QuickSight.Client.exceptions.ResourceExistsException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / update_dashboards_qa_configuration update_dashboards_qa_configuration ********************************** QuickSight.Client.update_dashboards_qa_configuration(**kwargs) Updates a Dashboard QA configuration. See also: AWS API Documentation **Request Syntax** response = client.update_dashboards_qa_configuration( AwsAccountId='string', DashboardsQAStatus='ENABLED'|'DISABLED' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the dashboard QA configuration that you want to update. * **DashboardsQAStatus** (*string*) -- **[REQUIRED]** The status of dashboards QA configuration that you want to update. Return type: dict Returns: **Response Syntax** { 'DashboardsQAStatus': 'ENABLED'|'DISABLED', 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **DashboardsQAStatus** *(string) --* A value that indicates whether the dashboard QA configuration is enabled or not. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / list_refresh_schedules list_refresh_schedules ********************** QuickSight.Client.list_refresh_schedules(**kwargs) Lists the refresh schedules of a dataset. Each dataset can have up to 5 schedules. See also: AWS API Documentation **Request Syntax** response = client.list_refresh_schedules( AwsAccountId='string', DataSetId='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The Amazon Web Services account ID. * **DataSetId** (*string*) -- **[REQUIRED]** The ID of the dataset. Return type: dict Returns: **Response Syntax** { 'RefreshSchedules': [ { 'ScheduleId': 'string', 'ScheduleFrequency': { 'Interval': 'MINUTE15'|'MINUTE30'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY', 'RefreshOnDay': { 'DayOfWeek': 'SUNDAY'|'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY', 'DayOfMonth': 'string' }, 'Timezone': 'string', 'TimeOfTheDay': 'string' }, 'StartAfterDateTime': datetime(2015, 1, 1), 'RefreshType': 'INCREMENTAL_REFRESH'|'FULL_REFRESH', 'Arn': 'string' }, ], 'Status': 123, 'RequestId': 'string' } **Response Structure** * *(dict) --* * **RefreshSchedules** *(list) --* The list of refresh schedules for the dataset. * *(dict) --* A list of "RefreshSchedule" objects. * **ScheduleId** *(string) --* An identifier for the refresh schedule. * **ScheduleFrequency** *(dict) --* The frequency for the refresh schedule. * **Interval** *(string) --* The interval between scheduled refreshes. Valid values are as follows: * "MINUTE15": The dataset refreshes every 15 minutes. This value is only supported for incremental refreshes. This interval can only be used for one schedule per dataset. * "MINUTE30":The dataset refreshes every 30 minutes. This value is only supported for incremental refreshes. This interval can only be used for one schedule per dataset. * "HOURLY": The dataset refreshes every hour. This interval can only be used for one schedule per dataset. * "DAILY": The dataset refreshes every day. * "WEEKLY": The dataset refreshes every week. * "MONTHLY": The dataset refreshes every month. * **RefreshOnDay** *(dict) --* The day of the week that you want to schedule the refresh on. This value is required for weekly and monthly refresh intervals. * **DayOfWeek** *(string) --* The day of the week that you want to schedule a refresh on. * **DayOfMonth** *(string) --* The day of the month that you want to schedule refresh on. * **Timezone** *(string) --* The timezone that you want the refresh schedule to use. The timezone ID must match a corresponding ID found on "java.util.time.getAvailableIDs()". * **TimeOfTheDay** *(string) --* The time of day that you want the datset to refresh. This value is expressed in HH:MM format. This field is not required for schedules that refresh hourly. * **StartAfterDateTime** *(datetime) --* Time after which the refresh schedule can be started, expressed in "YYYY-MM-DDTHH:MM:SS" format. * **RefreshType** *(string) --* The type of refresh that a datset undergoes. Valid values are as follows: * "FULL_REFRESH": A complete refresh of a dataset. * "INCREMENTAL_REFRESH": A partial refresh of some rows of a dataset, based on the time window specified. For more information on full and incremental refreshes, see Refreshing SPICE data in the *Amazon QuickSight User Guide*. * **Arn** *(string) --* The Amazon Resource Name (ARN) for the refresh schedule. * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.LimitExceededException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / create_iam_policy_assignment create_iam_policy_assignment **************************** QuickSight.Client.create_iam_policy_assignment(**kwargs) Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN). This policy assignment is attached to the specified groups or users of Amazon QuickSight. Assignment names are unique per Amazon Web Services account. To avoid overwriting rules in other namespaces, use assignment names that are unique. See also: AWS API Documentation **Request Syntax** response = client.create_iam_policy_assignment( AwsAccountId='string', AssignmentName='string', AssignmentStatus='ENABLED'|'DRAFT'|'DISABLED', PolicyArn='string', Identities={ 'string': [ 'string', ] }, Namespace='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account where you want to assign an IAM policy to Amazon QuickSight users or groups. * **AssignmentName** (*string*) -- **[REQUIRED]** The name of the assignment, also called a rule. The name must be unique within the Amazon Web Services account. * **AssignmentStatus** (*string*) -- **[REQUIRED]** 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. * **PolicyArn** (*string*) -- The ARN for the IAM policy to apply to the Amazon QuickSight users and groups specified in this assignment. * **Identities** (*dict*) -- The Amazon QuickSight users, groups, or both that you want to assign the policy to. * *(string) --* * *(list) --* * *(string) --* * **Namespace** (*string*) -- **[REQUIRED]** The namespace that contains the assignment. Return type: dict Returns: **Response Syntax** { 'AssignmentName': 'string', 'AssignmentId': 'string', 'AssignmentStatus': 'ENABLED'|'DRAFT'|'DISABLED', 'PolicyArn': 'string', 'Identities': { 'string': [ 'string', ] }, 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **AssignmentName** *(string) --* The name of the assignment. The name must be unique within the Amazon Web Services account. * **AssignmentId** *(string) --* The ID for the assignment. * **AssignmentStatus** *(string) --* The status of the assignment. Possible values are as follows: * "ENABLED" - Anything specified in this assignment is used when creating the data source. * "DISABLED" - This assignment isn't used when creating the data source. * "DRAFT" - This assignment is an unfinished draft and isn't used when creating the data source. * **PolicyArn** *(string) --* The ARN for the IAM policy that is applied to the Amazon QuickSight users and groups specified in this assignment. * **Identities** *(dict) --* The Amazon QuickSight users, groups, or both that the IAM policy is assigned to. * *(string) --* * *(list) --* * *(string) --* * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceExistsException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.ConcurrentUpdatingException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / delete_role_custom_permission delete_role_custom_permission ***************************** QuickSight.Client.delete_role_custom_permission(**kwargs) Removes custom permissions from the role. See also: AWS API Documentation **Request Syntax** response = client.delete_role_custom_permission( Role='ADMIN'|'AUTHOR'|'READER'|'ADMIN_PRO'|'AUTHOR_PRO'|'READER_PRO', AwsAccountId='string', Namespace='string' ) Parameters: * **Role** (*string*) -- **[REQUIRED]** The role that you want to remove permissions from. * **AwsAccountId** (*string*) -- **[REQUIRED]** 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** (*string*) -- **[REQUIRED]** The namespace that includes the role. Return type: dict Returns: **Response Syntax** { 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.PreconditionNotMetException" * "QuickSight.Client.exceptions.InternalFailureException" * "QuickSight.Client.exceptions.ResourceUnavailableException" QuickSight / Client / describe_namespace describe_namespace ****************** QuickSight.Client.describe_namespace(**kwargs) Describes the current namespace. See also: AWS API Documentation **Request Syntax** response = client.describe_namespace( AwsAccountId='string', Namespace='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID for the Amazon Web Services account that contains the Amazon QuickSight namespace that you want to describe. * **Namespace** (*string*) -- **[REQUIRED]** The namespace that you want to describe. Return type: dict Returns: **Response Syntax** { 'Namespace': { 'Name': 'string', 'Arn': 'string', 'CapacityRegion': 'string', 'CreationStatus': 'CREATED'|'CREATING'|'DELETING'|'RETRYABLE_FAILURE'|'NON_RETRYABLE_FAILURE', 'IdentityStore': 'QUICKSIGHT', 'NamespaceError': { 'Type': 'PERMISSION_DENIED'|'INTERNAL_SERVICE_ERROR', 'Message': 'string' }, 'IamIdentityCenterApplicationArn': 'string', 'IamIdentityCenterInstanceArn': 'string' }, 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **Namespace** *(dict) --* 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. * **Name** *(string) --* The name of the error. * **Arn** *(string) --* The namespace ARN. * **CapacityRegion** *(string) --* The namespace Amazon Web Services Region. * **CreationStatus** *(string) --* The creation status of a namespace that is not yet completely created. * **IdentityStore** *(string) --* The identity store used for the namespace. * **NamespaceError** *(dict) --* An error that occurred when the namespace was created. * **Type** *(string) --* The error type. * **Message** *(string) --* The message for the error. * **IamIdentityCenterApplicationArn** *(string) --* The Amazon Resource Name (ARN) for the IAM Identity Center application. * **IamIdentityCenterInstanceArn** *(string) --* The Amazon Resource Name (ARN) for the IAM Identity Center instance. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InternalFailureException" * "QuickSight.Client.exceptions.ResourceUnavailableException" QuickSight / Client / describe_group_membership describe_group_membership ************************* QuickSight.Client.describe_group_membership(**kwargs) Use the "DescribeGroupMembership" operation to determine if a user is a member of the specified group. If the user exists and is a member of the specified group, an associated "GroupMember" object is returned. See also: AWS API Documentation **Request Syntax** response = client.describe_group_membership( MemberName='string', GroupName='string', AwsAccountId='string', Namespace='string' ) Parameters: * **MemberName** (*string*) -- **[REQUIRED]** The user name of the user that you want to search for. * **GroupName** (*string*) -- **[REQUIRED]** The name of the group that you want to search. * **AwsAccountId** (*string*) -- **[REQUIRED]** 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** (*string*) -- **[REQUIRED]** The namespace that includes the group you are searching within. Return type: dict Returns: **Response Syntax** { 'GroupMember': { 'Arn': 'string', 'MemberName': 'string' }, 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **GroupMember** *(dict) --* A member of an Amazon QuickSight group. Currently, group members must be users. Groups can't be members of another group. . * **Arn** *(string) --* The Amazon Resource Name (ARN) for the group member (user). * **MemberName** *(string) --* The name of the group member (user). * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.PreconditionNotMetException" * "QuickSight.Client.exceptions.InternalFailureException" * "QuickSight.Client.exceptions.ResourceUnavailableException" QuickSight / Client / describe_refresh_schedule describe_refresh_schedule ************************* QuickSight.Client.describe_refresh_schedule(**kwargs) Provides a summary of a refresh schedule. See also: AWS API Documentation **Request Syntax** response = client.describe_refresh_schedule( AwsAccountId='string', DataSetId='string', ScheduleId='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The Amazon Web Services account ID. * **DataSetId** (*string*) -- **[REQUIRED]** The ID of the dataset. * **ScheduleId** (*string*) -- **[REQUIRED]** The ID of the refresh schedule. Return type: dict Returns: **Response Syntax** { 'RefreshSchedule': { 'ScheduleId': 'string', 'ScheduleFrequency': { 'Interval': 'MINUTE15'|'MINUTE30'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY', 'RefreshOnDay': { 'DayOfWeek': 'SUNDAY'|'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY', 'DayOfMonth': 'string' }, 'Timezone': 'string', 'TimeOfTheDay': 'string' }, 'StartAfterDateTime': datetime(2015, 1, 1), 'RefreshType': 'INCREMENTAL_REFRESH'|'FULL_REFRESH', 'Arn': 'string' }, 'Status': 123, 'RequestId': 'string', 'Arn': 'string' } **Response Structure** * *(dict) --* * **RefreshSchedule** *(dict) --* The refresh schedule. * **ScheduleId** *(string) --* An identifier for the refresh schedule. * **ScheduleFrequency** *(dict) --* The frequency for the refresh schedule. * **Interval** *(string) --* The interval between scheduled refreshes. Valid values are as follows: * "MINUTE15": The dataset refreshes every 15 minutes. This value is only supported for incremental refreshes. This interval can only be used for one schedule per dataset. * "MINUTE30":The dataset refreshes every 30 minutes. This value is only supported for incremental refreshes. This interval can only be used for one schedule per dataset. * "HOURLY": The dataset refreshes every hour. This interval can only be used for one schedule per dataset. * "DAILY": The dataset refreshes every day. * "WEEKLY": The dataset refreshes every week. * "MONTHLY": The dataset refreshes every month. * **RefreshOnDay** *(dict) --* The day of the week that you want to schedule the refresh on. This value is required for weekly and monthly refresh intervals. * **DayOfWeek** *(string) --* The day of the week that you want to schedule a refresh on. * **DayOfMonth** *(string) --* The day of the month that you want to schedule refresh on. * **Timezone** *(string) --* The timezone that you want the refresh schedule to use. The timezone ID must match a corresponding ID found on "java.util.time.getAvailableIDs()". * **TimeOfTheDay** *(string) --* The time of day that you want the datset to refresh. This value is expressed in HH:MM format. This field is not required for schedules that refresh hourly. * **StartAfterDateTime** *(datetime) --* Time after which the refresh schedule can be started, expressed in "YYYY-MM-DDTHH:MM:SS" format. * **RefreshType** *(string) --* The type of refresh that a datset undergoes. Valid values are as follows: * "FULL_REFRESH": A complete refresh of a dataset. * "INCREMENTAL_REFRESH": A partial refresh of some rows of a dataset, based on the time window specified. For more information on full and incremental refreshes, see Refreshing SPICE data in the *Amazon QuickSight User Guide*. * **Arn** *(string) --* The Amazon Resource Name (ARN) for the refresh schedule. * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Arn** *(string) --* The Amazon Resource Name (ARN) for the refresh schedule. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.LimitExceededException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / describe_account_customization describe_account_customization ****************************** QuickSight.Client.describe_account_customization(**kwargs) Describes the customizations associated with the provided Amazon Web Services account and Amazon Amazon QuickSight namespace in an Amazon Web Services Region. The Amazon QuickSight console evaluates which customizations to apply by running this API operation with the "Resolved" flag included. To determine what customizations display when you run this command, it can help to visualize the relationship of the entities involved. * "Amazon Web Services account" - The Amazon Web Services account exists at the top of the hierarchy. It has the potential to use all of the Amazon Web Services Regions and Amazon Web Services Services. When you subscribe to Amazon QuickSight, you choose one Amazon Web Services Region to use as your home Region. That's where your free SPICE capacity is located. You can use Amazon QuickSight in any supported Amazon Web Services Region. * "Amazon Web Services Region" - In each Amazon Web Services Region where you sign in to Amazon QuickSight at least once, Amazon QuickSight acts as a separate instance of the same service. If you have a user directory, it resides in us-east-1, which is the US East (N. Virginia). Generally speaking, these users have access to Amazon QuickSight in any Amazon Web Services Region, unless they are constrained to a namespace. To run the command in a different Amazon Web Services Region, you change your Region settings. If you're using the CLI, you can use one of the following options: * Use command line options. * Use named profiles. * Run "aws configure" to change your default Amazon Web Services Region. Use Enter to key the same settings for your keys. For more information, see Configuring the CLI. * "Namespace" - A QuickSight namespace is a partition that contains users and assets (data sources, datasets, dashboards, and so on). To access assets that are in a specific namespace, users and groups must also be part of the same namespace. People who share a namespace are completely isolated from users and assets in other namespaces, even if they are in the same Amazon Web Services account and Amazon Web Services Region. * "Applied customizations" - Within an Amazon Web Services Region, a set of Amazon QuickSight customizations can apply to an Amazon Web Services account or to a namespace. Settings that you apply to a namespace override settings that you apply to an Amazon Web Services account. All settings are isolated to a single Amazon Web Services Region. To apply them in other Amazon Web Services Regions, run the "CreateAccountCustomization" command in each Amazon Web Services Region where you want to apply the same customizations. See also: AWS API Documentation **Request Syntax** response = client.describe_account_customization( AwsAccountId='string', Namespace='string', Resolved=True|False ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID for the Amazon Web Services account that you want to describe Amazon QuickSight customizations for. * **Namespace** (*string*) -- The Amazon QuickSight namespace that you want to describe Amazon QuickSight customizations for. * **Resolved** (*boolean*) -- 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. Return type: dict Returns: **Response Syntax** { 'Arn': 'string', 'AwsAccountId': 'string', 'Namespace': 'string', 'AccountCustomization': { 'DefaultTheme': 'string', 'DefaultEmailCustomizationTemplate': 'string' }, 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **Arn** *(string) --* The Amazon Resource Name (ARN) of the customization that's associated with this Amazon Web Services account. * **AwsAccountId** *(string) --* The ID for the Amazon Web Services account that you're describing. * **Namespace** *(string) --* The Amazon QuickSight namespace that you're describing. * **AccountCustomization** *(dict) --* The Amazon QuickSight customizations that exist in the current Amazon Web Services Region. * **DefaultTheme** *(string) --* The default theme for this Amazon QuickSight subscription. * **DefaultEmailCustomizationTemplate** *(string) --* The default email customization template. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InternalFailureException" * "QuickSight.Client.exceptions.ResourceUnavailableException" QuickSight / Client / list_role_memberships list_role_memberships ********************* QuickSight.Client.list_role_memberships(**kwargs) Lists all groups that are associated with a role. See also: AWS API Documentation **Request Syntax** response = client.list_role_memberships( Role='ADMIN'|'AUTHOR'|'READER'|'ADMIN_PRO'|'AUTHOR_PRO'|'READER_PRO', NextToken='string', MaxResults=123, AwsAccountId='string', Namespace='string' ) Parameters: * **Role** (*string*) -- **[REQUIRED]** The name of the role. * **NextToken** (*string*) -- A pagination token that can be used in a subsequent request. * **MaxResults** (*integer*) -- The maximum number of results to return. * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account. * **Namespace** (*string*) -- **[REQUIRED]** The namespace that includes the role. Return type: dict Returns: **Response Syntax** { 'MembersList': [ 'string', ], 'NextToken': 'string', 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **MembersList** *(list) --* The list of groups associated with a role * *(string) --* * **NextToken** *(string) --* A pagination token that can be used in a subsequent request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InvalidNextTokenException" * "QuickSight.Client.exceptions.PreconditionNotMetException" * "QuickSight.Client.exceptions.LimitExceededException" * "QuickSight.Client.exceptions.InternalFailureException" * "QuickSight.Client.exceptions.ResourceUnavailableException" QuickSight / Client / create_folder create_folder ************* QuickSight.Client.create_folder(**kwargs) Creates an empty shared folder. See also: AWS API Documentation **Request Syntax** response = client.create_folder( AwsAccountId='string', FolderId='string', Name='string', FolderType='SHARED'|'RESTRICTED', ParentFolderArn='string', Permissions=[ { 'Principal': 'string', 'Actions': [ 'string', ] }, ], Tags=[ { 'Key': 'string', 'Value': 'string' }, ], SharingModel='ACCOUNT'|'NAMESPACE' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID for the Amazon Web Services account where you want to create the folder. * **FolderId** (*string*) -- **[REQUIRED]** The ID of the folder. * **Name** (*string*) -- The name of the folder. * **FolderType** (*string*) -- The type of folder. By default, "folderType" is "SHARED". * **ParentFolderArn** (*string*) -- The Amazon Resource Name (ARN) for the parent folder. "ParentFolderArn" can be null. An empty "parentFolderArn" creates a root-level folder. * **Permissions** (*list*) -- A structure that describes the principals and the resource- level permissions of a folder. To specify no permissions, omit "Permissions". * *(dict) --* Permission for the resource. * **Principal** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the principal. This can be one of the following: * The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.) * The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.) * The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.) * **Actions** *(list) --* **[REQUIRED]** The IAM action to grant or revoke permissions on. * *(string) --* * **Tags** (*list*) -- Tags for the folder. * *(dict) --* The key or keys of the key-value pairs for the resource tag or tags assigned to the resource. * **Key** *(string) --* **[REQUIRED]** Tag key. * **Value** *(string) --* **[REQUIRED]** Tag value. * **SharingModel** (*string*) -- An optional parameter that determines the sharing scope of the folder. The default value for this parameter is "ACCOUNT". Return type: dict Returns: **Response Syntax** { 'Status': 123, 'Arn': 'string', 'FolderId': 'string', 'RequestId': 'string' } **Response Structure** * *(dict) --* * **Status** *(integer) --* The HTTP status of the request. * **Arn** *(string) --* The Amazon Resource Name (ARN) for the newly created folder. * **FolderId** *(string) --* The folder ID for the newly created folder. * **RequestId** *(string) --* The request ID for the newly created folder. **Exceptions** * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.ResourceExistsException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.LimitExceededException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / list_topic_reviewed_answers list_topic_reviewed_answers *************************** QuickSight.Client.list_topic_reviewed_answers(**kwargs) Lists all reviewed answers for a Q Topic. See also: AWS API Documentation **Request Syntax** response = client.list_topic_reviewed_answers( AwsAccountId='string', TopicId='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that containd the reviewed answers that you want listed. * **TopicId** (*string*) -- **[REQUIRED]** The ID for the topic that contains the reviewed answer that you want to list. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. Return type: dict Returns: **Response Syntax** { 'TopicId': 'string', 'TopicArn': 'string', 'Answers': [ { 'Arn': 'string', 'AnswerId': 'string', 'DatasetArn': 'string', 'Question': 'string', 'Mir': { 'Metrics': [ { 'MetricId': { 'Identity': 'string' }, 'Function': { 'Aggregation': 'SUM'|'MIN'|'MAX'|'COUNT'|'AVERAGE'|'DISTINCT_COUNT'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE'|'MEDIAN'|'PTD_SUM'|'PTD_MIN'|'PTD_MAX'|'PTD_COUNT'|'PTD_DISTINCT_COUNT'|'PTD_AVERAGE'|'COLUMN'|'CUSTOM', 'AggregationFunctionParameters': { 'string': 'string' }, 'Period': 'SECOND'|'MINUTE'|'HOUR'|'DAY'|'WEEK'|'MONTH'|'QUARTER'|'YEAR', 'PeriodField': 'string' }, 'Operands': [ { 'Identity': 'string' }, ], 'ComparisonMethod': { 'Type': 'DIFF'|'PERC_DIFF'|'DIFF_AS_PERC'|'POP_CURRENT_DIFF_AS_PERC'|'POP_CURRENT_DIFF'|'POP_OVERTIME_DIFF_AS_PERC'|'POP_OVERTIME_DIFF'|'PERCENT_OF_TOTAL'|'RUNNING_SUM'|'MOVING_AVERAGE', 'Period': 'SECOND'|'MINUTE'|'HOUR'|'DAY'|'WEEK'|'MONTH'|'QUARTER'|'YEAR', 'WindowSize': 123 }, 'Expression': 'string', 'CalculatedFieldReferences': [ { 'Identity': 'string' }, ], 'DisplayFormat': 'AUTO'|'PERCENT'|'CURRENCY'|'NUMBER'|'DATE'|'STRING', 'DisplayFormatOptions': { 'UseBlankCellFormat': True|False, 'BlankCellFormat': 'string', 'DateFormat': 'string', 'DecimalSeparator': 'COMMA'|'DOT', 'GroupingSeparator': 'string', 'UseGrouping': True|False, 'FractionDigits': 123, 'Prefix': 'string', 'Suffix': 'string', 'UnitScaler': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS'|'LAKHS'|'CRORES', 'NegativeFormat': { 'Prefix': 'string', 'Suffix': 'string' }, 'CurrencySymbol': 'string' }, 'NamedEntity': { 'NamedEntityName': 'string' } }, ], 'GroupByList': [ { 'FieldName': { 'Identity': 'string' }, 'TimeGranularity': 'SECOND'|'MINUTE'|'HOUR'|'DAY'|'WEEK'|'MONTH'|'QUARTER'|'YEAR', 'Sort': { 'Operand': { 'Identity': 'string' }, 'SortDirection': 'ASCENDING'|'DESCENDING' }, 'DisplayFormat': 'AUTO'|'PERCENT'|'CURRENCY'|'NUMBER'|'DATE'|'STRING', 'DisplayFormatOptions': { 'UseBlankCellFormat': True|False, 'BlankCellFormat': 'string', 'DateFormat': 'string', 'DecimalSeparator': 'COMMA'|'DOT', 'GroupingSeparator': 'string', 'UseGrouping': True|False, 'FractionDigits': 123, 'Prefix': 'string', 'Suffix': 'string', 'UnitScaler': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS'|'LAKHS'|'CRORES', 'NegativeFormat': { 'Prefix': 'string', 'Suffix': 'string' }, 'CurrencySymbol': 'string' }, 'NamedEntity': { 'NamedEntityName': 'string' } }, ], 'Filters': [ [ { 'FilterType': 'CATEGORY_FILTER'|'NUMERIC_EQUALITY_FILTER'|'NUMERIC_RANGE_FILTER'|'DATE_RANGE_FILTER'|'RELATIVE_DATE_FILTER'|'TOP_BOTTOM_FILTER'|'EQUALS'|'RANK_LIMIT_FILTER'|'ACCEPT_ALL_FILTER', 'FilterClass': 'ENFORCED_VALUE_FILTER'|'CONDITIONAL_VALUE_FILTER'|'NAMED_VALUE_FILTER', 'OperandField': { 'Identity': 'string' }, 'Function': 'CONTAINS'|'EXACT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS_STRING'|'PREVIOUS'|'THIS'|'LAST'|'NEXT'|'NOW', 'Constant': { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string', 'Minimum': 'string', 'Maximum': 'string', 'ValueList': [ { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string' }, ] }, 'Inverse': True|False, 'NullFilter': 'ALL_VALUES'|'NON_NULLS_ONLY'|'NULLS_ONLY', 'Aggregation': 'SUM'|'MIN'|'MAX'|'COUNT'|'AVERAGE'|'DISTINCT_COUNT'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE'|'MEDIAN'|'PTD_SUM'|'PTD_MIN'|'PTD_MAX'|'PTD_COUNT'|'PTD_DISTINCT_COUNT'|'PTD_AVERAGE'|'COLUMN'|'CUSTOM', 'AggregationFunctionParameters': { 'string': 'string' }, 'AggregationPartitionBy': [ { 'FieldName': 'string', 'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND' }, ], 'Range': { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string', 'Minimum': 'string', 'Maximum': 'string', 'ValueList': [ { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string' }, ] }, 'Inclusive': True|False, 'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND', 'LastNextOffset': { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string', 'Minimum': 'string', 'Maximum': 'string', 'ValueList': [ { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string' }, ] }, 'AggMetrics': [ { 'MetricOperand': { 'Identity': 'string' }, 'Function': 'SUM'|'MIN'|'MAX'|'COUNT'|'AVERAGE'|'DISTINCT_COUNT'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE'|'MEDIAN'|'PTD_SUM'|'PTD_MIN'|'PTD_MAX'|'PTD_COUNT'|'PTD_DISTINCT_COUNT'|'PTD_AVERAGE'|'COLUMN'|'CUSTOM', 'SortDirection': 'ASCENDING'|'DESCENDING' }, ], 'TopBottomLimit': { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string', 'Minimum': 'string', 'Maximum': 'string', 'ValueList': [ { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string' }, ] }, 'SortDirection': 'ASCENDING'|'DESCENDING', 'Anchor': { 'AnchorType': 'TODAY', 'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND', 'Offset': 123 } }, ], ], 'Sort': { 'Operand': { 'Identity': 'string' }, 'SortDirection': 'ASCENDING'|'DESCENDING' }, 'ContributionAnalysis': { 'Factors': [ { 'FieldName': 'string' }, ], 'TimeRanges': { 'StartRange': { 'FilterType': 'CATEGORY_FILTER'|'NUMERIC_EQUALITY_FILTER'|'NUMERIC_RANGE_FILTER'|'DATE_RANGE_FILTER'|'RELATIVE_DATE_FILTER'|'TOP_BOTTOM_FILTER'|'EQUALS'|'RANK_LIMIT_FILTER'|'ACCEPT_ALL_FILTER', 'FilterClass': 'ENFORCED_VALUE_FILTER'|'CONDITIONAL_VALUE_FILTER'|'NAMED_VALUE_FILTER', 'OperandField': { 'Identity': 'string' }, 'Function': 'CONTAINS'|'EXACT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS_STRING'|'PREVIOUS'|'THIS'|'LAST'|'NEXT'|'NOW', 'Constant': { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string', 'Minimum': 'string', 'Maximum': 'string', 'ValueList': [ { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string' }, ] }, 'Inverse': True|False, 'NullFilter': 'ALL_VALUES'|'NON_NULLS_ONLY'|'NULLS_ONLY', 'Aggregation': 'SUM'|'MIN'|'MAX'|'COUNT'|'AVERAGE'|'DISTINCT_COUNT'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE'|'MEDIAN'|'PTD_SUM'|'PTD_MIN'|'PTD_MAX'|'PTD_COUNT'|'PTD_DISTINCT_COUNT'|'PTD_AVERAGE'|'COLUMN'|'CUSTOM', 'AggregationFunctionParameters': { 'string': 'string' }, 'AggregationPartitionBy': [ { 'FieldName': 'string', 'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND' }, ], 'Range': { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string', 'Minimum': 'string', 'Maximum': 'string', 'ValueList': [ { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string' }, ] }, 'Inclusive': True|False, 'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND', 'LastNextOffset': { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string', 'Minimum': 'string', 'Maximum': 'string', 'ValueList': [ { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string' }, ] }, 'AggMetrics': [ { 'MetricOperand': { 'Identity': 'string' }, 'Function': 'SUM'|'MIN'|'MAX'|'COUNT'|'AVERAGE'|'DISTINCT_COUNT'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE'|'MEDIAN'|'PTD_SUM'|'PTD_MIN'|'PTD_MAX'|'PTD_COUNT'|'PTD_DISTINCT_COUNT'|'PTD_AVERAGE'|'COLUMN'|'CUSTOM', 'SortDirection': 'ASCENDING'|'DESCENDING' }, ], 'TopBottomLimit': { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string', 'Minimum': 'string', 'Maximum': 'string', 'ValueList': [ { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string' }, ] }, 'SortDirection': 'ASCENDING'|'DESCENDING', 'Anchor': { 'AnchorType': 'TODAY', 'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND', 'Offset': 123 } }, 'EndRange': { 'FilterType': 'CATEGORY_FILTER'|'NUMERIC_EQUALITY_FILTER'|'NUMERIC_RANGE_FILTER'|'DATE_RANGE_FILTER'|'RELATIVE_DATE_FILTER'|'TOP_BOTTOM_FILTER'|'EQUALS'|'RANK_LIMIT_FILTER'|'ACCEPT_ALL_FILTER', 'FilterClass': 'ENFORCED_VALUE_FILTER'|'CONDITIONAL_VALUE_FILTER'|'NAMED_VALUE_FILTER', 'OperandField': { 'Identity': 'string' }, 'Function': 'CONTAINS'|'EXACT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS_STRING'|'PREVIOUS'|'THIS'|'LAST'|'NEXT'|'NOW', 'Constant': { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string', 'Minimum': 'string', 'Maximum': 'string', 'ValueList': [ { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string' }, ] }, 'Inverse': True|False, 'NullFilter': 'ALL_VALUES'|'NON_NULLS_ONLY'|'NULLS_ONLY', 'Aggregation': 'SUM'|'MIN'|'MAX'|'COUNT'|'AVERAGE'|'DISTINCT_COUNT'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE'|'MEDIAN'|'PTD_SUM'|'PTD_MIN'|'PTD_MAX'|'PTD_COUNT'|'PTD_DISTINCT_COUNT'|'PTD_AVERAGE'|'COLUMN'|'CUSTOM', 'AggregationFunctionParameters': { 'string': 'string' }, 'AggregationPartitionBy': [ { 'FieldName': 'string', 'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND' }, ], 'Range': { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string', 'Minimum': 'string', 'Maximum': 'string', 'ValueList': [ { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string' }, ] }, 'Inclusive': True|False, 'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND', 'LastNextOffset': { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string', 'Minimum': 'string', 'Maximum': 'string', 'ValueList': [ { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string' }, ] }, 'AggMetrics': [ { 'MetricOperand': { 'Identity': 'string' }, 'Function': 'SUM'|'MIN'|'MAX'|'COUNT'|'AVERAGE'|'DISTINCT_COUNT'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE'|'MEDIAN'|'PTD_SUM'|'PTD_MIN'|'PTD_MAX'|'PTD_COUNT'|'PTD_DISTINCT_COUNT'|'PTD_AVERAGE'|'COLUMN'|'CUSTOM', 'SortDirection': 'ASCENDING'|'DESCENDING' }, ], 'TopBottomLimit': { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string', 'Minimum': 'string', 'Maximum': 'string', 'ValueList': [ { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string' }, ] }, 'SortDirection': 'ASCENDING'|'DESCENDING', 'Anchor': { 'AnchorType': 'TODAY', 'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND', 'Offset': 123 } } }, 'Direction': 'INCREASE'|'DECREASE'|'NEUTRAL', 'SortType': 'ABSOLUTE_DIFFERENCE'|'CONTRIBUTION_PERCENTAGE'|'DEVIATION_FROM_EXPECTED'|'PERCENTAGE_DIFFERENCE' }, 'Visual': { 'type': 'string' } }, 'PrimaryVisual': { 'VisualId': 'string', 'Role': 'PRIMARY'|'COMPLIMENTARY'|'MULTI_INTENT'|'FALLBACK'|'FRAGMENT', 'Ir': { 'Metrics': [ { 'MetricId': { 'Identity': 'string' }, 'Function': { 'Aggregation': 'SUM'|'MIN'|'MAX'|'COUNT'|'AVERAGE'|'DISTINCT_COUNT'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE'|'MEDIAN'|'PTD_SUM'|'PTD_MIN'|'PTD_MAX'|'PTD_COUNT'|'PTD_DISTINCT_COUNT'|'PTD_AVERAGE'|'COLUMN'|'CUSTOM', 'AggregationFunctionParameters': { 'string': 'string' }, 'Period': 'SECOND'|'MINUTE'|'HOUR'|'DAY'|'WEEK'|'MONTH'|'QUARTER'|'YEAR', 'PeriodField': 'string' }, 'Operands': [ { 'Identity': 'string' }, ], 'ComparisonMethod': { 'Type': 'DIFF'|'PERC_DIFF'|'DIFF_AS_PERC'|'POP_CURRENT_DIFF_AS_PERC'|'POP_CURRENT_DIFF'|'POP_OVERTIME_DIFF_AS_PERC'|'POP_OVERTIME_DIFF'|'PERCENT_OF_TOTAL'|'RUNNING_SUM'|'MOVING_AVERAGE', 'Period': 'SECOND'|'MINUTE'|'HOUR'|'DAY'|'WEEK'|'MONTH'|'QUARTER'|'YEAR', 'WindowSize': 123 }, 'Expression': 'string', 'CalculatedFieldReferences': [ { 'Identity': 'string' }, ], 'DisplayFormat': 'AUTO'|'PERCENT'|'CURRENCY'|'NUMBER'|'DATE'|'STRING', 'DisplayFormatOptions': { 'UseBlankCellFormat': True|False, 'BlankCellFormat': 'string', 'DateFormat': 'string', 'DecimalSeparator': 'COMMA'|'DOT', 'GroupingSeparator': 'string', 'UseGrouping': True|False, 'FractionDigits': 123, 'Prefix': 'string', 'Suffix': 'string', 'UnitScaler': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS'|'LAKHS'|'CRORES', 'NegativeFormat': { 'Prefix': 'string', 'Suffix': 'string' }, 'CurrencySymbol': 'string' }, 'NamedEntity': { 'NamedEntityName': 'string' } }, ], 'GroupByList': [ { 'FieldName': { 'Identity': 'string' }, 'TimeGranularity': 'SECOND'|'MINUTE'|'HOUR'|'DAY'|'WEEK'|'MONTH'|'QUARTER'|'YEAR', 'Sort': { 'Operand': { 'Identity': 'string' }, 'SortDirection': 'ASCENDING'|'DESCENDING' }, 'DisplayFormat': 'AUTO'|'PERCENT'|'CURRENCY'|'NUMBER'|'DATE'|'STRING', 'DisplayFormatOptions': { 'UseBlankCellFormat': True|False, 'BlankCellFormat': 'string', 'DateFormat': 'string', 'DecimalSeparator': 'COMMA'|'DOT', 'GroupingSeparator': 'string', 'UseGrouping': True|False, 'FractionDigits': 123, 'Prefix': 'string', 'Suffix': 'string', 'UnitScaler': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS'|'LAKHS'|'CRORES', 'NegativeFormat': { 'Prefix': 'string', 'Suffix': 'string' }, 'CurrencySymbol': 'string' }, 'NamedEntity': { 'NamedEntityName': 'string' } }, ], 'Filters': [ [ { 'FilterType': 'CATEGORY_FILTER'|'NUMERIC_EQUALITY_FILTER'|'NUMERIC_RANGE_FILTER'|'DATE_RANGE_FILTER'|'RELATIVE_DATE_FILTER'|'TOP_BOTTOM_FILTER'|'EQUALS'|'RANK_LIMIT_FILTER'|'ACCEPT_ALL_FILTER', 'FilterClass': 'ENFORCED_VALUE_FILTER'|'CONDITIONAL_VALUE_FILTER'|'NAMED_VALUE_FILTER', 'OperandField': { 'Identity': 'string' }, 'Function': 'CONTAINS'|'EXACT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS_STRING'|'PREVIOUS'|'THIS'|'LAST'|'NEXT'|'NOW', 'Constant': { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string', 'Minimum': 'string', 'Maximum': 'string', 'ValueList': [ { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string' }, ] }, 'Inverse': True|False, 'NullFilter': 'ALL_VALUES'|'NON_NULLS_ONLY'|'NULLS_ONLY', 'Aggregation': 'SUM'|'MIN'|'MAX'|'COUNT'|'AVERAGE'|'DISTINCT_COUNT'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE'|'MEDIAN'|'PTD_SUM'|'PTD_MIN'|'PTD_MAX'|'PTD_COUNT'|'PTD_DISTINCT_COUNT'|'PTD_AVERAGE'|'COLUMN'|'CUSTOM', 'AggregationFunctionParameters': { 'string': 'string' }, 'AggregationPartitionBy': [ { 'FieldName': 'string', 'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND' }, ], 'Range': { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string', 'Minimum': 'string', 'Maximum': 'string', 'ValueList': [ { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string' }, ] }, 'Inclusive': True|False, 'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND', 'LastNextOffset': { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string', 'Minimum': 'string', 'Maximum': 'string', 'ValueList': [ { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string' }, ] }, 'AggMetrics': [ { 'MetricOperand': { 'Identity': 'string' }, 'Function': 'SUM'|'MIN'|'MAX'|'COUNT'|'AVERAGE'|'DISTINCT_COUNT'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE'|'MEDIAN'|'PTD_SUM'|'PTD_MIN'|'PTD_MAX'|'PTD_COUNT'|'PTD_DISTINCT_COUNT'|'PTD_AVERAGE'|'COLUMN'|'CUSTOM', 'SortDirection': 'ASCENDING'|'DESCENDING' }, ], 'TopBottomLimit': { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string', 'Minimum': 'string', 'Maximum': 'string', 'ValueList': [ { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string' }, ] }, 'SortDirection': 'ASCENDING'|'DESCENDING', 'Anchor': { 'AnchorType': 'TODAY', 'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND', 'Offset': 123 } }, ], ], 'Sort': { 'Operand': { 'Identity': 'string' }, 'SortDirection': 'ASCENDING'|'DESCENDING' }, 'ContributionAnalysis': { 'Factors': [ { 'FieldName': 'string' }, ], 'TimeRanges': { 'StartRange': { 'FilterType': 'CATEGORY_FILTER'|'NUMERIC_EQUALITY_FILTER'|'NUMERIC_RANGE_FILTER'|'DATE_RANGE_FILTER'|'RELATIVE_DATE_FILTER'|'TOP_BOTTOM_FILTER'|'EQUALS'|'RANK_LIMIT_FILTER'|'ACCEPT_ALL_FILTER', 'FilterClass': 'ENFORCED_VALUE_FILTER'|'CONDITIONAL_VALUE_FILTER'|'NAMED_VALUE_FILTER', 'OperandField': { 'Identity': 'string' }, 'Function': 'CONTAINS'|'EXACT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS_STRING'|'PREVIOUS'|'THIS'|'LAST'|'NEXT'|'NOW', 'Constant': { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string', 'Minimum': 'string', 'Maximum': 'string', 'ValueList': [ { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string' }, ] }, 'Inverse': True|False, 'NullFilter': 'ALL_VALUES'|'NON_NULLS_ONLY'|'NULLS_ONLY', 'Aggregation': 'SUM'|'MIN'|'MAX'|'COUNT'|'AVERAGE'|'DISTINCT_COUNT'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE'|'MEDIAN'|'PTD_SUM'|'PTD_MIN'|'PTD_MAX'|'PTD_COUNT'|'PTD_DISTINCT_COUNT'|'PTD_AVERAGE'|'COLUMN'|'CUSTOM', 'AggregationFunctionParameters': { 'string': 'string' }, 'AggregationPartitionBy': [ { 'FieldName': 'string', 'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND' }, ], 'Range': { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string', 'Minimum': 'string', 'Maximum': 'string', 'ValueList': [ { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string' }, ] }, 'Inclusive': True|False, 'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND', 'LastNextOffset': { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string', 'Minimum': 'string', 'Maximum': 'string', 'ValueList': [ { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string' }, ] }, 'AggMetrics': [ { 'MetricOperand': { 'Identity': 'string' }, 'Function': 'SUM'|'MIN'|'MAX'|'COUNT'|'AVERAGE'|'DISTINCT_COUNT'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE'|'MEDIAN'|'PTD_SUM'|'PTD_MIN'|'PTD_MAX'|'PTD_COUNT'|'PTD_DISTINCT_COUNT'|'PTD_AVERAGE'|'COLUMN'|'CUSTOM', 'SortDirection': 'ASCENDING'|'DESCENDING' }, ], 'TopBottomLimit': { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string', 'Minimum': 'string', 'Maximum': 'string', 'ValueList': [ { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string' }, ] }, 'SortDirection': 'ASCENDING'|'DESCENDING', 'Anchor': { 'AnchorType': 'TODAY', 'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND', 'Offset': 123 } }, 'EndRange': { 'FilterType': 'CATEGORY_FILTER'|'NUMERIC_EQUALITY_FILTER'|'NUMERIC_RANGE_FILTER'|'DATE_RANGE_FILTER'|'RELATIVE_DATE_FILTER'|'TOP_BOTTOM_FILTER'|'EQUALS'|'RANK_LIMIT_FILTER'|'ACCEPT_ALL_FILTER', 'FilterClass': 'ENFORCED_VALUE_FILTER'|'CONDITIONAL_VALUE_FILTER'|'NAMED_VALUE_FILTER', 'OperandField': { 'Identity': 'string' }, 'Function': 'CONTAINS'|'EXACT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS_STRING'|'PREVIOUS'|'THIS'|'LAST'|'NEXT'|'NOW', 'Constant': { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string', 'Minimum': 'string', 'Maximum': 'string', 'ValueList': [ { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string' }, ] }, 'Inverse': True|False, 'NullFilter': 'ALL_VALUES'|'NON_NULLS_ONLY'|'NULLS_ONLY', 'Aggregation': 'SUM'|'MIN'|'MAX'|'COUNT'|'AVERAGE'|'DISTINCT_COUNT'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE'|'MEDIAN'|'PTD_SUM'|'PTD_MIN'|'PTD_MAX'|'PTD_COUNT'|'PTD_DISTINCT_COUNT'|'PTD_AVERAGE'|'COLUMN'|'CUSTOM', 'AggregationFunctionParameters': { 'string': 'string' }, 'AggregationPartitionBy': [ { 'FieldName': 'string', 'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND' }, ], 'Range': { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string', 'Minimum': 'string', 'Maximum': 'string', 'ValueList': [ { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string' }, ] }, 'Inclusive': True|False, 'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND', 'LastNextOffset': { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string', 'Minimum': 'string', 'Maximum': 'string', 'ValueList': [ { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string' }, ] }, 'AggMetrics': [ { 'MetricOperand': { 'Identity': 'string' }, 'Function': 'SUM'|'MIN'|'MAX'|'COUNT'|'AVERAGE'|'DISTINCT_COUNT'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE'|'MEDIAN'|'PTD_SUM'|'PTD_MIN'|'PTD_MAX'|'PTD_COUNT'|'PTD_DISTINCT_COUNT'|'PTD_AVERAGE'|'COLUMN'|'CUSTOM', 'SortDirection': 'ASCENDING'|'DESCENDING' }, ], 'TopBottomLimit': { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string', 'Minimum': 'string', 'Maximum': 'string', 'ValueList': [ { 'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE', 'Value': 'string' }, ] }, 'SortDirection': 'ASCENDING'|'DESCENDING', 'Anchor': { 'AnchorType': 'TODAY', 'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND', 'Offset': 123 } } }, 'Direction': 'INCREASE'|'DECREASE'|'NEUTRAL', 'SortType': 'ABSOLUTE_DIFFERENCE'|'CONTRIBUTION_PERCENTAGE'|'DEVIATION_FROM_EXPECTED'|'PERCENTAGE_DIFFERENCE' }, 'Visual': { 'type': 'string' } }, 'SupportingVisuals': [ {'... recursive ...'}, ] }, 'Template': { 'TemplateType': 'string', 'Slots': [ { 'SlotId': 'string', 'VisualId': 'string' }, ] } }, ], 'Status': 123, 'RequestId': 'string' } **Response Structure** * *(dict) --* * **TopicId** *(string) --* The ID for the topic that contains the reviewed answer that you want to list. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. * **TopicArn** *(string) --* The Amazon Resource Name (ARN) of the topic. * **Answers** *(list) --* The definition of all Answers in the topic. * *(dict) --* The deinition for a "TopicReviewedAnswer". * **Arn** *(string) --* The Amazon Resource Name (ARN) of the reviewed answer. * **AnswerId** *(string) --* The answer ID of the reviewed answer. * **DatasetArn** *(string) --* The Dataset ARN for the "TopicReviewedAnswer". * **Question** *(string) --* The question for the "TopicReviewedAnswer". * **Mir** *(dict) --* The mir for the "TopicReviewedAnswer". * **Metrics** *(list) --* The metrics for the "TopicIR". * *(dict) --* The definition for a "TopicIRMetric". * **MetricId** *(dict) --* The metric ID for the "TopicIRMetric". * **Identity** *(string) --* The identity of the identifier. * **Function** *(dict) --* The function for the "TopicIRMetric". * **Aggregation** *(string) --* The aggregation of an Agg function. * **AggregationFunctionParameters** *(dict) --* The aggregation parameters for an Agg function. * *(string) --* * *(string) --* * **Period** *(string) --* The period of an Agg function. * **PeriodField** *(string) --* The period field for an Agg function. * **Operands** *(list) --* The operands for the "TopicIRMetric". * *(dict) --* The definition for the identifier. * **Identity** *(string) --* The identity of the identifier. * **ComparisonMethod** *(dict) --* The comparison method for the "TopicIRMetric". * **Type** *(string) --* The type for the "TopicIRComparisonMethod". * **Period** *(string) --* The period for the "TopicIRComparisonMethod". * **WindowSize** *(integer) --* The window size for the "TopicIRComparisonMethod". * **Expression** *(string) --* The expression for the "TopicIRMetric". * **CalculatedFieldReferences** *(list) --* The calculated field references for the "TopicIRMetric". * *(dict) --* The definition for the identifier. * **Identity** *(string) --* The identity of the identifier. * **DisplayFormat** *(string) --* The display format for the "TopicIRMetric". * **DisplayFormatOptions** *(dict) --* A structure that represents additional options for display formatting. * **UseBlankCellFormat** *(boolean) --* A Boolean value that indicates whether to use blank cell format. * **BlankCellFormat** *(string) --* Determines the blank cell format. * **DateFormat** *(string) --* Determines the "DateTime" format. * **DecimalSeparator** *(string) --* Determines the decimal separator. * **GroupingSeparator** *(string) --* Determines the grouping separator. * **UseGrouping** *(boolean) --* A Boolean value that indicates whether to use grouping. * **FractionDigits** *(integer) --* Determines the number of fraction digits. * **Prefix** *(string) --* The prefix value for a display format. * **Suffix** *(string) --* The suffix value for a display format. * **UnitScaler** *(string) --* The unit scaler. Valid values for this structure are: "NONE", "AUTO", "THOUSANDS", "MILLIONS", "BILLIONS", and "TRILLIONS". * **NegativeFormat** *(dict) --* The negative format. * **Prefix** *(string) --* The prefix for a negative format. * **Suffix** *(string) --* The suffix for a negative format. * **CurrencySymbol** *(string) --* The currency symbol, such as "USD". * **NamedEntity** *(dict) --* The named entity for the "TopicIRMetric". * **NamedEntityName** *(string) --* The "NamedEntityName" for the "NamedEntityRef". * **GroupByList** *(list) --* The GroupBy list for the "TopicIR". * *(dict) --* The definition for a "TopicIRGroupBy". * **FieldName** *(dict) --* The field name for the "TopicIRGroupBy". * **Identity** *(string) --* The identity of the identifier. * **TimeGranularity** *(string) --* The time granularity for the "TopicIRGroupBy". * **Sort** *(dict) --* The sort for the "TopicIRGroupBy". * **Operand** *(dict) --* The operand for a "TopicSortClause". * **Identity** *(string) --* The identity of the identifier. * **SortDirection** *(string) --* The sort direction for the "TopicSortClause". * **DisplayFormat** *(string) --* The display format for the "TopicIRGroupBy". * **DisplayFormatOptions** *(dict) --* A structure that represents additional options for display formatting. * **UseBlankCellFormat** *(boolean) --* A Boolean value that indicates whether to use blank cell format. * **BlankCellFormat** *(string) --* Determines the blank cell format. * **DateFormat** *(string) --* Determines the "DateTime" format. * **DecimalSeparator** *(string) --* Determines the decimal separator. * **GroupingSeparator** *(string) --* Determines the grouping separator. * **UseGrouping** *(boolean) --* A Boolean value that indicates whether to use grouping. * **FractionDigits** *(integer) --* Determines the number of fraction digits. * **Prefix** *(string) --* The prefix value for a display format. * **Suffix** *(string) --* The suffix value for a display format. * **UnitScaler** *(string) --* The unit scaler. Valid values for this structure are: "NONE", "AUTO", "THOUSANDS", "MILLIONS", "BILLIONS", and "TRILLIONS". * **NegativeFormat** *(dict) --* The negative format. * **Prefix** *(string) --* The prefix for a negative format. * **Suffix** *(string) --* The suffix for a negative format. * **CurrencySymbol** *(string) --* The currency symbol, such as "USD". * **NamedEntity** *(dict) --* The named entity for the "TopicIRGroupBy". * **NamedEntityName** *(string) --* The "NamedEntityName" for the "NamedEntityRef". * **Filters** *(list) --* The filters for the "TopicIR". * *(list) --* * *(dict) --* The definition for a "TopicIRFilterOption". * **FilterType** *(string) --* The filter type for the "TopicIRFilterOption". * **FilterClass** *(string) --* The filter class for the "TopicIRFilterOption". * **OperandField** *(dict) --* The operand field for the "TopicIRFilterOption". * **Identity** *(string) --* The identity of the identifier. * **Function** *(string) --* The function for the "TopicIRFilterOption". * **Constant** *(dict) --* The constant for the "TopicIRFilterOption". * **ConstantType** *(string) --* The constant type of a "TopicConstantValue". * **Value** *(string) --* The value of the "TopicConstantValue". * **Minimum** *(string) --* The minimum for the "TopicConstantValue". * **Maximum** *(string) --* The maximum for the "TopicConstantValue". * **ValueList** *(list) --* The value list of the "TopicConstantValue". * *(dict) --* The definition for a "CollectiveConstantEntry". * **ConstantType** *(string) --* The "ConstantType" of a "CollectiveConstantEntry". * **Value** *(string) --* The value of a "CollectiveConstantEntry". * **Inverse** *(boolean) --* The inverse for the "TopicIRFilterOption". * **NullFilter** *(string) --* The null filter for the "TopicIRFilterOption". * **Aggregation** *(string) --* The aggregation for the "TopicIRFilterOption". * **AggregationFunctionParameters** *(dict) --* The aggregation function parameters for the "TopicIRFilterOption". * *(string) --* * *(string) --* * **AggregationPartitionBy** *(list) --* The "AggregationPartitionBy" for the "TopicIRFilterOption". * *(dict) --* The definition of an "AggregationPartitionBy". * **FieldName** *(string) --* The field Name for an "AggregationPartitionBy". * **TimeGranularity** *(string) --* The "TimeGranularity" for an "AggregationPartitionBy". * **Range** *(dict) --* The range for the "TopicIRFilterOption". * **ConstantType** *(string) --* The constant type of a "TopicConstantValue". * **Value** *(string) --* The value of the "TopicConstantValue". * **Minimum** *(string) --* The minimum for the "TopicConstantValue". * **Maximum** *(string) --* The maximum for the "TopicConstantValue". * **ValueList** *(list) --* The value list of the "TopicConstantValue". * *(dict) --* The definition for a "CollectiveConstantEntry". * **ConstantType** *(string) --* The "ConstantType" of a "CollectiveConstantEntry". * **Value** *(string) --* The value of a "CollectiveConstantEntry". * **Inclusive** *(boolean) --* The inclusive for the "TopicIRFilterOption". * **TimeGranularity** *(string) --* The time granularity for the "TopicIRFilterOption". * **LastNextOffset** *(dict) --* The last next offset for the "TopicIRFilterOption". * **ConstantType** *(string) --* The constant type of a "TopicConstantValue". * **Value** *(string) --* The value of the "TopicConstantValue". * **Minimum** *(string) --* The minimum for the "TopicConstantValue". * **Maximum** *(string) --* The maximum for the "TopicConstantValue". * **ValueList** *(list) --* The value list of the "TopicConstantValue". * *(dict) --* The definition for a "CollectiveConstantEntry". * **ConstantType** *(string) --* The "ConstantType" of a "CollectiveConstantEntry". * **Value** *(string) --* The value of a "CollectiveConstantEntry". * **AggMetrics** *(list) --* The agg metrics for the "TopicIRFilterOption". * *(dict) --* The definition for the "FilterAggMetrics". * **MetricOperand** *(dict) --* The metric operand of the "FilterAggMetrics". * **Identity** *(string) --* The identity of the identifier. * **Function** *(string) --* The function for the "FilterAggMetrics". * **SortDirection** *(string) --* The sort direction for "FilterAggMetrics". * **TopBottomLimit** *(dict) --* The "TopBottomLimit" for the "TopicIRFilterOption". * **ConstantType** *(string) --* The constant type of a "TopicConstantValue". * **Value** *(string) --* The value of the "TopicConstantValue". * **Minimum** *(string) --* The minimum for the "TopicConstantValue". * **Maximum** *(string) --* The maximum for the "TopicConstantValue". * **ValueList** *(list) --* The value list of the "TopicConstantValue". * *(dict) --* The definition for a "CollectiveConstantEntry". * **ConstantType** *(string) --* The "ConstantType" of a "CollectiveConstantEntry". * **Value** *(string) --* The value of a "CollectiveConstantEntry". * **SortDirection** *(string) --* The sort direction for the "TopicIRFilterOption". * **Anchor** *(dict) --* The anchor for the "TopicIRFilterOption". * **AnchorType** *(string) --* The "AnchorType" for the Anchor. * **TimeGranularity** *(string) --* The "TimeGranularity" of the Anchor. * **Offset** *(integer) --* The offset of the Anchor. * **Sort** *(dict) --* The sort for the "TopicIR". * **Operand** *(dict) --* The operand for a "TopicSortClause". * **Identity** *(string) --* The identity of the identifier. * **SortDirection** *(string) --* The sort direction for the "TopicSortClause". * **ContributionAnalysis** *(dict) --* The contribution analysis for the "TopicIR". * **Factors** *(list) --* The factors for a "TopicIRContributionAnalysis". * *(dict) --* The definition for the "ContributionAnalysisFactor". * **FieldName** *(string) --* The field name of the "ContributionAnalysisFactor". * **TimeRanges** *(dict) --* The time ranges for the "TopicIRContributionAnalysis". * **StartRange** *(dict) --* The start range for the "ContributionAnalysisTimeRanges". * **FilterType** *(string) --* The filter type for the "TopicIRFilterOption". * **FilterClass** *(string) --* The filter class for the "TopicIRFilterOption". * **OperandField** *(dict) --* The operand field for the "TopicIRFilterOption". * **Identity** *(string) --* The identity of the identifier. * **Function** *(string) --* The function for the "TopicIRFilterOption". * **Constant** *(dict) --* The constant for the "TopicIRFilterOption". * **ConstantType** *(string) --* The constant type of a "TopicConstantValue". * **Value** *(string) --* The value of the "TopicConstantValue". * **Minimum** *(string) --* The minimum for the "TopicConstantValue". * **Maximum** *(string) --* The maximum for the "TopicConstantValue". * **ValueList** *(list) --* The value list of the "TopicConstantValue". * *(dict) --* The definition for a "CollectiveConstantEntry". * **ConstantType** *(string) --* The "ConstantType" of a "CollectiveConstantEntry". * **Value** *(string) --* The value of a "CollectiveConstantEntry". * **Inverse** *(boolean) --* The inverse for the "TopicIRFilterOption". * **NullFilter** *(string) --* The null filter for the "TopicIRFilterOption". * **Aggregation** *(string) --* The aggregation for the "TopicIRFilterOption". * **AggregationFunctionParameters** *(dict) --* The aggregation function parameters for the "TopicIRFilterOption". * *(string) --* * *(string) --* * **AggregationPartitionBy** *(list) --* The "AggregationPartitionBy" for the "TopicIRFilterOption". * *(dict) --* The definition of an "AggregationPartitionBy". * **FieldName** *(string) --* The field Name for an "AggregationPartitionBy". * **TimeGranularity** *(string) --* The "TimeGranularity" for an "AggregationPartitionBy". * **Range** *(dict) --* The range for the "TopicIRFilterOption". * **ConstantType** *(string) --* The constant type of a "TopicConstantValue". * **Value** *(string) --* The value of the "TopicConstantValue". * **Minimum** *(string) --* The minimum for the "TopicConstantValue". * **Maximum** *(string) --* The maximum for the "TopicConstantValue". * **ValueList** *(list) --* The value list of the "TopicConstantValue". * *(dict) --* The definition for a "CollectiveConstantEntry". * **ConstantType** *(string) --* The "ConstantType" of a "CollectiveConstantEntry". * **Value** *(string) --* The value of a "CollectiveConstantEntry". * **Inclusive** *(boolean) --* The inclusive for the "TopicIRFilterOption". * **TimeGranularity** *(string) --* The time granularity for the "TopicIRFilterOption". * **LastNextOffset** *(dict) --* The last next offset for the "TopicIRFilterOption". * **ConstantType** *(string) --* The constant type of a "TopicConstantValue". * **Value** *(string) --* The value of the "TopicConstantValue". * **Minimum** *(string) --* The minimum for the "TopicConstantValue". * **Maximum** *(string) --* The maximum for the "TopicConstantValue". * **ValueList** *(list) --* The value list of the "TopicConstantValue". * *(dict) --* The definition for a "CollectiveConstantEntry". * **ConstantType** *(string) --* The "ConstantType" of a "CollectiveConstantEntry". * **Value** *(string) --* The value of a "CollectiveConstantEntry". * **AggMetrics** *(list) --* The agg metrics for the "TopicIRFilterOption". * *(dict) --* The definition for the "FilterAggMetrics". * **MetricOperand** *(dict) --* The metric operand of the "FilterAggMetrics". * **Identity** *(string) --* The identity of the identifier. * **Function** *(string) --* The function for the "FilterAggMetrics". * **SortDirection** *(string) --* The sort direction for "FilterAggMetrics". * **TopBottomLimit** *(dict) --* The "TopBottomLimit" for the "TopicIRFilterOption". * **ConstantType** *(string) --* The constant type of a "TopicConstantValue". * **Value** *(string) --* The value of the "TopicConstantValue". * **Minimum** *(string) --* The minimum for the "TopicConstantValue". * **Maximum** *(string) --* The maximum for the "TopicConstantValue". * **ValueList** *(list) --* The value list of the "TopicConstantValue". * *(dict) --* The definition for a "CollectiveConstantEntry". * **ConstantType** *(string) --* The "ConstantType" of a "CollectiveConstantEntry". * **Value** *(string) --* The value of a "CollectiveConstantEntry". * **SortDirection** *(string) --* The sort direction for the "TopicIRFilterOption". * **Anchor** *(dict) --* The anchor for the "TopicIRFilterOption". * **AnchorType** *(string) --* The "AnchorType" for the Anchor. * **TimeGranularity** *(string) --* The "TimeGranularity" of the Anchor. * **Offset** *(integer) --* The offset of the Anchor. * **EndRange** *(dict) --* The end range for the "ContributionAnalysisTimeRanges". * **FilterType** *(string) --* The filter type for the "TopicIRFilterOption". * **FilterClass** *(string) --* The filter class for the "TopicIRFilterOption". * **OperandField** *(dict) --* The operand field for the "TopicIRFilterOption". * **Identity** *(string) --* The identity of the identifier. * **Function** *(string) --* The function for the "TopicIRFilterOption". * **Constant** *(dict) --* The constant for the "TopicIRFilterOption". * **ConstantType** *(string) --* The constant type of a "TopicConstantValue". * **Value** *(string) --* The value of the "TopicConstantValue". * **Minimum** *(string) --* The minimum for the "TopicConstantValue". * **Maximum** *(string) --* The maximum for the "TopicConstantValue". * **ValueList** *(list) --* The value list of the "TopicConstantValue". * *(dict) --* The definition for a "CollectiveConstantEntry". * **ConstantType** *(string) --* The "ConstantType" of a "CollectiveConstantEntry". * **Value** *(string) --* The value of a "CollectiveConstantEntry". * **Inverse** *(boolean) --* The inverse for the "TopicIRFilterOption". * **NullFilter** *(string) --* The null filter for the "TopicIRFilterOption". * **Aggregation** *(string) --* The aggregation for the "TopicIRFilterOption". * **AggregationFunctionParameters** *(dict) --* The aggregation function parameters for the "TopicIRFilterOption". * *(string) --* * *(string) --* * **AggregationPartitionBy** *(list) --* The "AggregationPartitionBy" for the "TopicIRFilterOption". * *(dict) --* The definition of an "AggregationPartitionBy". * **FieldName** *(string) --* The field Name for an "AggregationPartitionBy". * **TimeGranularity** *(string) --* The "TimeGranularity" for an "AggregationPartitionBy". * **Range** *(dict) --* The range for the "TopicIRFilterOption". * **ConstantType** *(string) --* The constant type of a "TopicConstantValue". * **Value** *(string) --* The value of the "TopicConstantValue". * **Minimum** *(string) --* The minimum for the "TopicConstantValue". * **Maximum** *(string) --* The maximum for the "TopicConstantValue". * **ValueList** *(list) --* The value list of the "TopicConstantValue". * *(dict) --* The definition for a "CollectiveConstantEntry". * **ConstantType** *(string) --* The "ConstantType" of a "CollectiveConstantEntry". * **Value** *(string) --* The value of a "CollectiveConstantEntry". * **Inclusive** *(boolean) --* The inclusive for the "TopicIRFilterOption". * **TimeGranularity** *(string) --* The time granularity for the "TopicIRFilterOption". * **LastNextOffset** *(dict) --* The last next offset for the "TopicIRFilterOption". * **ConstantType** *(string) --* The constant type of a "TopicConstantValue". * **Value** *(string) --* The value of the "TopicConstantValue". * **Minimum** *(string) --* The minimum for the "TopicConstantValue". * **Maximum** *(string) --* The maximum for the "TopicConstantValue". * **ValueList** *(list) --* The value list of the "TopicConstantValue". * *(dict) --* The definition for a "CollectiveConstantEntry". * **ConstantType** *(string) --* The "ConstantType" of a "CollectiveConstantEntry". * **Value** *(string) --* The value of a "CollectiveConstantEntry". * **AggMetrics** *(list) --* The agg metrics for the "TopicIRFilterOption". * *(dict) --* The definition for the "FilterAggMetrics". * **MetricOperand** *(dict) --* The metric operand of the "FilterAggMetrics". * **Identity** *(string) --* The identity of the identifier. * **Function** *(string) --* The function for the "FilterAggMetrics". * **SortDirection** *(string) --* The sort direction for "FilterAggMetrics". * **TopBottomLimit** *(dict) --* The "TopBottomLimit" for the "TopicIRFilterOption". * **ConstantType** *(string) --* The constant type of a "TopicConstantValue". * **Value** *(string) --* The value of the "TopicConstantValue". * **Minimum** *(string) --* The minimum for the "TopicConstantValue". * **Maximum** *(string) --* The maximum for the "TopicConstantValue". * **ValueList** *(list) --* The value list of the "TopicConstantValue". * *(dict) --* The definition for a "CollectiveConstantEntry". * **ConstantType** *(string) --* The "ConstantType" of a "CollectiveConstantEntry". * **Value** *(string) --* The value of a "CollectiveConstantEntry". * **SortDirection** *(string) --* The sort direction for the "TopicIRFilterOption". * **Anchor** *(dict) --* The anchor for the "TopicIRFilterOption". * **AnchorType** *(string) --* The "AnchorType" for the Anchor. * **TimeGranularity** *(string) --* The "TimeGranularity" of the Anchor. * **Offset** *(integer) --* The offset of the Anchor. * **Direction** *(string) --* The direction for the "TopicIRContributionAnalysis". * **SortType** *(string) --* The sort type for the "TopicIRContributionAnalysis". * **Visual** *(dict) --* The visual for the "TopicIR". * **type** *(string) --* The type for a "VisualOptions". * **PrimaryVisual** *(dict) --* The primary visual for the "TopicReviewedAnswer". * **VisualId** *(string) --* The visual ID for the "TopicVisual". * **Role** *(string) --* The role for the "TopicVisual". * **Ir** *(dict) --* The ir for the "TopicVisual". * **Metrics** *(list) --* The metrics for the "TopicIR". * *(dict) --* The definition for a "TopicIRMetric". * **MetricId** *(dict) --* The metric ID for the "TopicIRMetric". * **Identity** *(string) --* The identity of the identifier. * **Function** *(dict) --* The function for the "TopicIRMetric". * **Aggregation** *(string) --* The aggregation of an Agg function. * **AggregationFunctionParameters** *(dict) --* The aggregation parameters for an Agg function. * *(string) --* * *(string) --* * **Period** *(string) --* The period of an Agg function. * **PeriodField** *(string) --* The period field for an Agg function. * **Operands** *(list) --* The operands for the "TopicIRMetric". * *(dict) --* The definition for the identifier. * **Identity** *(string) --* The identity of the identifier. * **ComparisonMethod** *(dict) --* The comparison method for the "TopicIRMetric". * **Type** *(string) --* The type for the "TopicIRComparisonMethod". * **Period** *(string) --* The period for the "TopicIRComparisonMethod". * **WindowSize** *(integer) --* The window size for the "TopicIRComparisonMethod". * **Expression** *(string) --* The expression for the "TopicIRMetric". * **CalculatedFieldReferences** *(list) --* The calculated field references for the "TopicIRMetric". * *(dict) --* The definition for the identifier. * **Identity** *(string) --* The identity of the identifier. * **DisplayFormat** *(string) --* The display format for the "TopicIRMetric". * **DisplayFormatOptions** *(dict) --* A structure that represents additional options for display formatting. * **UseBlankCellFormat** *(boolean) --* A Boolean value that indicates whether to use blank cell format. * **BlankCellFormat** *(string) --* Determines the blank cell format. * **DateFormat** *(string) --* Determines the "DateTime" format. * **DecimalSeparator** *(string) --* Determines the decimal separator. * **GroupingSeparator** *(string) --* Determines the grouping separator. * **UseGrouping** *(boolean) --* A Boolean value that indicates whether to use grouping. * **FractionDigits** *(integer) --* Determines the number of fraction digits. * **Prefix** *(string) --* The prefix value for a display format. * **Suffix** *(string) --* The suffix value for a display format. * **UnitScaler** *(string) --* The unit scaler. Valid values for this structure are: "NONE", "AUTO", "THOUSANDS", "MILLIONS", "BILLIONS", and "TRILLIONS". * **NegativeFormat** *(dict) --* The negative format. * **Prefix** *(string) --* The prefix for a negative format. * **Suffix** *(string) --* The suffix for a negative format. * **CurrencySymbol** *(string) --* The currency symbol, such as "USD". * **NamedEntity** *(dict) --* The named entity for the "TopicIRMetric". * **NamedEntityName** *(string) --* The "NamedEntityName" for the "NamedEntityRef". * **GroupByList** *(list) --* The GroupBy list for the "TopicIR". * *(dict) --* The definition for a "TopicIRGroupBy". * **FieldName** *(dict) --* The field name for the "TopicIRGroupBy". * **Identity** *(string) --* The identity of the identifier. * **TimeGranularity** *(string) --* The time granularity for the "TopicIRGroupBy". * **Sort** *(dict) --* The sort for the "TopicIRGroupBy". * **Operand** *(dict) --* The operand for a "TopicSortClause". * **Identity** *(string) --* The identity of the identifier. * **SortDirection** *(string) --* The sort direction for the "TopicSortClause". * **DisplayFormat** *(string) --* The display format for the "TopicIRGroupBy". * **DisplayFormatOptions** *(dict) --* A structure that represents additional options for display formatting. * **UseBlankCellFormat** *(boolean) --* A Boolean value that indicates whether to use blank cell format. * **BlankCellFormat** *(string) --* Determines the blank cell format. * **DateFormat** *(string) --* Determines the "DateTime" format. * **DecimalSeparator** *(string) --* Determines the decimal separator. * **GroupingSeparator** *(string) --* Determines the grouping separator. * **UseGrouping** *(boolean) --* A Boolean value that indicates whether to use grouping. * **FractionDigits** *(integer) --* Determines the number of fraction digits. * **Prefix** *(string) --* The prefix value for a display format. * **Suffix** *(string) --* The suffix value for a display format. * **UnitScaler** *(string) --* The unit scaler. Valid values for this structure are: "NONE", "AUTO", "THOUSANDS", "MILLIONS", "BILLIONS", and "TRILLIONS". * **NegativeFormat** *(dict) --* The negative format. * **Prefix** *(string) --* The prefix for a negative format. * **Suffix** *(string) --* The suffix for a negative format. * **CurrencySymbol** *(string) --* The currency symbol, such as "USD". * **NamedEntity** *(dict) --* The named entity for the "TopicIRGroupBy". * **NamedEntityName** *(string) --* The "NamedEntityName" for the "NamedEntityRef". * **Filters** *(list) --* The filters for the "TopicIR". * *(list) --* * *(dict) --* The definition for a "TopicIRFilterOption". * **FilterType** *(string) --* The filter type for the "TopicIRFilterOption". * **FilterClass** *(string) --* The filter class for the "TopicIRFilterOption". * **OperandField** *(dict) --* The operand field for the "TopicIRFilterOption". * **Identity** *(string) --* The identity of the identifier. * **Function** *(string) --* The function for the "TopicIRFilterOption". * **Constant** *(dict) --* The constant for the "TopicIRFilterOption". * **ConstantType** *(string) --* The constant type of a "TopicConstantValue". * **Value** *(string) --* The value of the "TopicConstantValue". * **Minimum** *(string) --* The minimum for the "TopicConstantValue". * **Maximum** *(string) --* The maximum for the "TopicConstantValue". * **ValueList** *(list) --* The value list of the "TopicConstantValue". * *(dict) --* The definition for a "CollectiveConstantEntry". * **ConstantType** *(string) --* The "ConstantType" of a "CollectiveConstantEntry". * **Value** *(string) --* The value of a "CollectiveConstantEntry". * **Inverse** *(boolean) --* The inverse for the "TopicIRFilterOption". * **NullFilter** *(string) --* The null filter for the "TopicIRFilterOption". * **Aggregation** *(string) --* The aggregation for the "TopicIRFilterOption". * **AggregationFunctionParameters** *(dict) --* The aggregation function parameters for the "TopicIRFilterOption". * *(string) --* * *(string) --* * **AggregationPartitionBy** *(list) --* The "AggregationPartitionBy" for the "TopicIRFilterOption". * *(dict) --* The definition of an "AggregationPartitionBy". * **FieldName** *(string) --* The field Name for an "AggregationPartitionBy". * **TimeGranularity** *(string) --* The "TimeGranularity" for an "AggregationPartitionBy". * **Range** *(dict) --* The range for the "TopicIRFilterOption". * **ConstantType** *(string) --* The constant type of a "TopicConstantValue". * **Value** *(string) --* The value of the "TopicConstantValue". * **Minimum** *(string) --* The minimum for the "TopicConstantValue". * **Maximum** *(string) --* The maximum for the "TopicConstantValue". * **ValueList** *(list) --* The value list of the "TopicConstantValue". * *(dict) --* The definition for a "CollectiveConstantEntry". * **ConstantType** *(string) --* The "ConstantType" of a "CollectiveConstantEntry". * **Value** *(string) --* The value of a "CollectiveConstantEntry". * **Inclusive** *(boolean) --* The inclusive for the "TopicIRFilterOption". * **TimeGranularity** *(string) --* The time granularity for the "TopicIRFilterOption". * **LastNextOffset** *(dict) --* The last next offset for the "TopicIRFilterOption". * **ConstantType** *(string) --* The constant type of a "TopicConstantValue". * **Value** *(string) --* The value of the "TopicConstantValue". * **Minimum** *(string) --* The minimum for the "TopicConstantValue". * **Maximum** *(string) --* The maximum for the "TopicConstantValue". * **ValueList** *(list) --* The value list of the "TopicConstantValue". * *(dict) --* The definition for a "CollectiveConstantEntry". * **ConstantType** *(string) --* The "ConstantType" of a "CollectiveConstantEntry". * **Value** *(string) --* The value of a "CollectiveConstantEntry". * **AggMetrics** *(list) --* The agg metrics for the "TopicIRFilterOption". * *(dict) --* The definition for the "FilterAggMetrics". * **MetricOperand** *(dict) --* The metric operand of the "FilterAggMetrics". * **Identity** *(string) --* The identity of the identifier. * **Function** *(string) --* The function for the "FilterAggMetrics". * **SortDirection** *(string) --* The sort direction for "FilterAggMetrics". * **TopBottomLimit** *(dict) --* The "TopBottomLimit" for the "TopicIRFilterOption". * **ConstantType** *(string) --* The constant type of a "TopicConstantValue". * **Value** *(string) --* The value of the "TopicConstantValue". * **Minimum** *(string) --* The minimum for the "TopicConstantValue". * **Maximum** *(string) --* The maximum for the "TopicConstantValue". * **ValueList** *(list) --* The value list of the "TopicConstantValue". * *(dict) --* The definition for a "CollectiveConstantEntry". * **ConstantType** *(string) --* The "ConstantType" of a "CollectiveConstantEntry". * **Value** *(string) --* The value of a "CollectiveConstantEntry". * **SortDirection** *(string) --* The sort direction for the "TopicIRFilterOption". * **Anchor** *(dict) --* The anchor for the "TopicIRFilterOption". * **AnchorType** *(string) --* The "AnchorType" for the Anchor. * **TimeGranularity** *(string) --* The "TimeGranularity" of the Anchor. * **Offset** *(integer) --* The offset of the Anchor. * **Sort** *(dict) --* The sort for the "TopicIR". * **Operand** *(dict) --* The operand for a "TopicSortClause". * **Identity** *(string) --* The identity of the identifier. * **SortDirection** *(string) --* The sort direction for the "TopicSortClause". * **ContributionAnalysis** *(dict) --* The contribution analysis for the "TopicIR". * **Factors** *(list) --* The factors for a "TopicIRContributionAnalysis". * *(dict) --* The definition for the "ContributionAnalysisFactor". * **FieldName** *(string) --* The field name of the "ContributionAnalysisFactor". * **TimeRanges** *(dict) --* The time ranges for the "TopicIRContributionAnalysis". * **StartRange** *(dict) --* The start range for the "ContributionAnalysisTimeRanges". * **FilterType** *(string) --* The filter type for the "TopicIRFilterOption". * **FilterClass** *(string) --* The filter class for the "TopicIRFilterOption". * **OperandField** *(dict) --* The operand field for the "TopicIRFilterOption". * **Identity** *(string) --* The identity of the identifier. * **Function** *(string) --* The function for the "TopicIRFilterOption". * **Constant** *(dict) --* The constant for the "TopicIRFilterOption". * **ConstantType** *(string) --* The constant type of a "TopicConstantValue". * **Value** *(string) --* The value of the "TopicConstantValue". * **Minimum** *(string) --* The minimum for the "TopicConstantValue". * **Maximum** *(string) --* The maximum for the "TopicConstantValue". * **ValueList** *(list) --* The value list of the "TopicConstantValue". * *(dict) --* The definition for a "CollectiveConstantEntry". * **ConstantType** *(string) --* The "ConstantType" of a "CollectiveConstantEntry". * **Value** *(string) --* The value of a "CollectiveConstantEntry". * **Inverse** *(boolean) --* The inverse for the "TopicIRFilterOption". * **NullFilter** *(string) --* The null filter for the "TopicIRFilterOption". * **Aggregation** *(string) --* The aggregation for the "TopicIRFilterOption". * **AggregationFunctionParameters** *(dict) --* The aggregation function parameters for the "TopicIRFilterOption". * *(string) --* * *(string) --* * **AggregationPartitionBy** *(list) --* The "AggregationPartitionBy" for the "TopicIRFilterOption". * *(dict) --* The definition of an "AggregationPartitionBy". * **FieldName** *(string) --* The field Name for an "AggregationPartitionBy". * **TimeGranularity** *(string) --* The "TimeGranularity" for an "AggregationPartitionBy". * **Range** *(dict) --* The range for the "TopicIRFilterOption". * **ConstantType** *(string) --* The constant type of a "TopicConstantValue". * **Value** *(string) --* The value of the "TopicConstantValue". * **Minimum** *(string) --* The minimum for the "TopicConstantValue". * **Maximum** *(string) --* The maximum for the "TopicConstantValue". * **ValueList** *(list) --* The value list of the "TopicConstantValue". * *(dict) --* The definition for a "CollectiveConstantEntry". * **ConstantType** *(string) --* The "ConstantType" of a "CollectiveConstantEntry". * **Value** *(string) --* The value of a "CollectiveConstantEntry". * **Inclusive** *(boolean) --* The inclusive for the "TopicIRFilterOption". * **TimeGranularity** *(string) --* The time granularity for the "TopicIRFilterOption". * **LastNextOffset** *(dict) --* The last next offset for the "TopicIRFilterOption". * **ConstantType** *(string) --* The constant type of a "TopicConstantValue". * **Value** *(string) --* The value of the "TopicConstantValue". * **Minimum** *(string) --* The minimum for the "TopicConstantValue". * **Maximum** *(string) --* The maximum for the "TopicConstantValue". * **ValueList** *(list) --* The value list of the "TopicConstantValue". * *(dict) --* The definition for a "CollectiveConstantEntry". * **ConstantType** *(string) --* The "ConstantType" of a "CollectiveConstantEntry". * **Value** *(string) --* The value of a "CollectiveConstantEntry". * **AggMetrics** *(list) --* The agg metrics for the "TopicIRFilterOption". * *(dict) --* The definition for the "FilterAggMetrics". * **MetricOperand** *(dict) --* The metric operand of the "FilterAggMetrics". * **Identity** *(string) --* The identity of the identifier. * **Function** *(string) --* The function for the "FilterAggMetrics". * **SortDirection** *(string) --* The sort direction for "FilterAggMetrics". * **TopBottomLimit** *(dict) --* The "TopBottomLimit" for the "TopicIRFilterOption". * **ConstantType** *(string) --* The constant type of a "TopicConstantValue". * **Value** *(string) --* The value of the "TopicConstantValue". * **Minimum** *(string) --* The minimum for the "TopicConstantValue". * **Maximum** *(string) --* The maximum for the "TopicConstantValue". * **ValueList** *(list) --* The value list of the "TopicConstantValue". * *(dict) --* The definition for a "CollectiveConstantEntry". * **ConstantType** *(string) --* The "ConstantType" of a "CollectiveConstantEntry". * **Value** *(string) --* The value of a "CollectiveConstantEntry". * **SortDirection** *(string) --* The sort direction for the "TopicIRFilterOption". * **Anchor** *(dict) --* The anchor for the "TopicIRFilterOption". * **AnchorType** *(string) --* The "AnchorType" for the Anchor. * **TimeGranularity** *(string) --* The "TimeGranularity" of the Anchor. * **Offset** *(integer) --* The offset of the Anchor. * **EndRange** *(dict) --* The end range for the "ContributionAnalysisTimeRanges". * **FilterType** *(string) --* The filter type for the "TopicIRFilterOption". * **FilterClass** *(string) --* The filter class for the "TopicIRFilterOption". * **OperandField** *(dict) --* The operand field for the "TopicIRFilterOption". * **Identity** *(string) --* The identity of the identifier. * **Function** *(string) --* The function for the "TopicIRFilterOption". * **Constant** *(dict) --* The constant for the "TopicIRFilterOption". * **ConstantType** *(string) --* The constant type of a "TopicConstantValue". * **Value** *(string) --* The value of the "TopicConstantValue". * **Minimum** *(string) --* The minimum for the "TopicConstantValue". * **Maximum** *(string) --* The maximum for the "TopicConstantValue". * **ValueList** *(list) --* The value list of the "TopicConstantValue". * *(dict) --* The definition for a "CollectiveConstantEntry". * **ConstantType** *(string) --* The "ConstantType" of a "CollectiveConstantEntry". * **Value** *(string) --* The value of a "CollectiveConstantEntry". * **Inverse** *(boolean) --* The inverse for the "TopicIRFilterOption". * **NullFilter** *(string) --* The null filter for the "TopicIRFilterOption". * **Aggregation** *(string) --* The aggregation for the "TopicIRFilterOption". * **AggregationFunctionParameters** *(dict) --* The aggregation function parameters for the "TopicIRFilterOption". * *(string) --* * *(string) --* * **AggregationPartitionBy** *(list) --* The "AggregationPartitionBy" for the "TopicIRFilterOption". * *(dict) --* The definition of an "AggregationPartitionBy". * **FieldName** *(string) --* The field Name for an "AggregationPartitionBy". * **TimeGranularity** *(string) --* The "TimeGranularity" for an "AggregationPartitionBy". * **Range** *(dict) --* The range for the "TopicIRFilterOption". * **ConstantType** *(string) --* The constant type of a "TopicConstantValue". * **Value** *(string) --* The value of the "TopicConstantValue". * **Minimum** *(string) --* The minimum for the "TopicConstantValue". * **Maximum** *(string) --* The maximum for the "TopicConstantValue". * **ValueList** *(list) --* The value list of the "TopicConstantValue". * *(dict) --* The definition for a "CollectiveConstantEntry". * **ConstantType** *(string) --* The "ConstantType" of a "CollectiveConstantEntry". * **Value** *(string) --* The value of a "CollectiveConstantEntry". * **Inclusive** *(boolean) --* The inclusive for the "TopicIRFilterOption". * **TimeGranularity** *(string) --* The time granularity for the "TopicIRFilterOption". * **LastNextOffset** *(dict) --* The last next offset for the "TopicIRFilterOption". * **ConstantType** *(string) --* The constant type of a "TopicConstantValue". * **Value** *(string) --* The value of the "TopicConstantValue". * **Minimum** *(string) --* The minimum for the "TopicConstantValue". * **Maximum** *(string) --* The maximum for the "TopicConstantValue". * **ValueList** *(list) --* The value list of the "TopicConstantValue". * *(dict) --* The definition for a "CollectiveConstantEntry". * **ConstantType** *(string) --* The "ConstantType" of a "CollectiveConstantEntry". * **Value** *(string) --* The value of a "CollectiveConstantEntry". * **AggMetrics** *(list) --* The agg metrics for the "TopicIRFilterOption". * *(dict) --* The definition for the "FilterAggMetrics". * **MetricOperand** *(dict) --* The metric operand of the "FilterAggMetrics". * **Identity** *(string) --* The identity of the identifier. * **Function** *(string) --* The function for the "FilterAggMetrics". * **SortDirection** *(string) --* The sort direction for "FilterAggMetrics". * **TopBottomLimit** *(dict) --* The "TopBottomLimit" for the "TopicIRFilterOption". * **ConstantType** *(string) --* The constant type of a "TopicConstantValue". * **Value** *(string) --* The value of the "TopicConstantValue". * **Minimum** *(string) --* The minimum for the "TopicConstantValue". * **Maximum** *(string) --* The maximum for the "TopicConstantValue". * **ValueList** *(list) --* The value list of the "TopicConstantValue". * *(dict) --* The definition for a "CollectiveConstantEntry". * **ConstantType** *(string) --* The "ConstantType" of a "CollectiveConstantEntry". * **Value** *(string) --* The value of a "CollectiveConstantEntry". * **SortDirection** *(string) --* The sort direction for the "TopicIRFilterOption". * **Anchor** *(dict) --* The anchor for the "TopicIRFilterOption". * **AnchorType** *(string) --* The "AnchorType" for the Anchor. * **TimeGranularity** *(string) --* The "TimeGranularity" of the Anchor. * **Offset** *(integer) --* The offset of the Anchor. * **Direction** *(string) --* The direction for the "TopicIRContributionAnalysis". * **SortType** *(string) --* The sort type for the "TopicIRContributionAnalysis". * **Visual** *(dict) --* The visual for the "TopicIR". * **type** *(string) --* The type for a "VisualOptions". * **SupportingVisuals** *(list) --* The supporting visuals for the "TopicVisual". * *(dict) --* The definition for a "TopicVisual". * **Template** *(dict) --* The template for the "TopicReviewedAnswer". * **TemplateType** *(string) --* The template type for the "TopicTemplate". * **Slots** *(list) --* The slots for the "TopicTemplate". * *(dict) --* The definition for the slot. * **SlotId** *(string) --* The slot ID of the slot. * **VisualId** *(string) --* The visual ID for the slot. * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / list_user_groups list_user_groups **************** QuickSight.Client.list_user_groups(**kwargs) Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of. See also: AWS API Documentation **Request Syntax** response = client.list_user_groups( UserName='string', AwsAccountId='string', Namespace='string', NextToken='string', MaxResults=123 ) Parameters: * **UserName** (*string*) -- **[REQUIRED]** The Amazon QuickSight user name that you want to list group memberships for. * **AwsAccountId** (*string*) -- **[REQUIRED]** 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** (*string*) -- **[REQUIRED]** The namespace. Currently, you should set this to "default". * **NextToken** (*string*) -- A pagination token that can be used in a subsequent request. * **MaxResults** (*integer*) -- The maximum number of results to return from this request. Return type: dict Returns: **Response Syntax** { 'GroupList': [ { 'Arn': 'string', 'GroupName': 'string', 'Description': 'string', 'PrincipalId': 'string' }, ], 'NextToken': 'string', 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **GroupList** *(list) --* The list of groups the user is a member of. * *(dict) --* A *group* in Amazon QuickSight consists of a set of users. You can use groups to make it easier to manage access and security. * **Arn** *(string) --* The Amazon Resource Name (ARN) for the group. * **GroupName** *(string) --* The name of the group. * **Description** *(string) --* The group description. * **PrincipalId** *(string) --* The principal ID of the group. * **NextToken** *(string) --* A pagination token that can be used in a subsequent request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.PreconditionNotMetException" * "QuickSight.Client.exceptions.InternalFailureException" * "QuickSight.Client.exceptions.ResourceUnavailableException" QuickSight / Client / search_dashboards search_dashboards ***************** QuickSight.Client.search_dashboards(**kwargs) Searches for dashboards that belong to a user. Note: This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. See also: AWS API Documentation **Request Syntax** response = client.search_dashboards( AwsAccountId='string', Filters=[ { 'Operator': 'StringEquals'|'StringLike', 'Name': 'QUICKSIGHT_USER'|'QUICKSIGHT_VIEWER_OR_OWNER'|'DIRECT_QUICKSIGHT_VIEWER_OR_OWNER'|'QUICKSIGHT_OWNER'|'DIRECT_QUICKSIGHT_OWNER'|'DIRECT_QUICKSIGHT_SOLE_OWNER'|'DASHBOARD_NAME', 'Value': 'string' }, ], NextToken='string', MaxResults=123 ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the user whose dashboards you're searching for. * **Filters** (*list*) -- **[REQUIRED]** 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" } ]" * *(dict) --* A filter that you apply when searching for dashboards. * **Operator** *(string) --* **[REQUIRED]** The comparison operator that you want to use as a filter, for example ""Operator": "StringEquals"". Valid values are ""StringEquals"" and ""StringLike"". If you set the operator value to ""StringEquals"", you need to provide an ownership related filter in the ""NAME"" field and the arn of the user or group whose folders you want to search in the ""Value"" field. For example, ""Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us- east-1:1:user/default/UserName1"". If you set the value to ""StringLike"", you need to provide the name of the folders you are searching for. For example, ""Name":"DASHBOARD_NAME", "Operator": "StringLike", "Value": "Test"". The ""StringLike"" operator only supports the "NAME" value "DASHBOARD_NAME". * **Name** *(string) --* The name of the value that you want to use as a filter, for example, ""Name": "QUICKSIGHT_OWNER"". Valid values are defined as follows: * "QUICKSIGHT_VIEWER_OR_OWNER": Provide an ARN of a user or group, and any dashboards with that ARN listed as one of the dashboards's owners or viewers are returned. Implicit permissions from folders or groups are considered. * "QUICKSIGHT_OWNER": Provide an ARN of a user or group, and any dashboards with that ARN listed as one of the owners of the dashboards are returned. Implicit permissions from folders or groups are considered. * "DIRECT_QUICKSIGHT_SOLE_OWNER": Provide an ARN of a user or group, and any dashboards with that ARN listed as the only owner of the dashboard are returned. Implicit permissions from folders or groups are not considered. * "DIRECT_QUICKSIGHT_OWNER": Provide an ARN of a user or group, and any dashboards with that ARN listed as one of the owners of the dashboards are returned. Implicit permissions from folders or groups are not considered. * "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER": Provide an ARN of a user or group, and any dashboards with that ARN listed as one of the owners or viewers of the dashboards are returned. Implicit permissions from folders or groups are not considered. * "DASHBOARD_NAME": Any dashboards whose names have a substring match to this value will be returned. * **Value** *(string) --* The value of the named item, in this case "QUICKSIGHT_USER", that you want to use as a filter, for example, ""Value": "arn:aws:quicksight:us- east-1:1:user/default/UserName1"". * **NextToken** (*string*) -- The token for the next set of results, or null if there are no more results. * **MaxResults** (*integer*) -- The maximum number of results to be returned per request. Return type: dict Returns: **Response Syntax** { 'DashboardSummaryList': [ { 'Arn': 'string', 'DashboardId': 'string', 'Name': 'string', 'CreatedTime': datetime(2015, 1, 1), 'LastUpdatedTime': datetime(2015, 1, 1), 'PublishedVersionNumber': 123, 'LastPublishedTime': datetime(2015, 1, 1) }, ], 'NextToken': 'string', 'Status': 123, 'RequestId': 'string' } **Response Structure** * *(dict) --* * **DashboardSummaryList** *(list) --* The list of dashboards owned by the user specified in "Filters" in your request. * *(dict) --* Dashboard summary. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the resource. * **DashboardId** *(string) --* Dashboard ID. * **Name** *(string) --* A display name for the dashboard. * **CreatedTime** *(datetime) --* The time that this dashboard was created. * **LastUpdatedTime** *(datetime) --* The last time that this dashboard was updated. * **PublishedVersionNumber** *(integer) --* Published version number. * **LastPublishedTime** *(datetime) --* The last time that this dashboard was published. * **NextToken** *(string) --* The token for the next set of results, or null if there are no more results. * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.InvalidNextTokenException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / create_role_membership create_role_membership ********************** QuickSight.Client.create_role_membership(**kwargs) Use "CreateRoleMembership" to add an existing Amazon QuickSight group to an existing role. See also: AWS API Documentation **Request Syntax** response = client.create_role_membership( MemberName='string', AwsAccountId='string', Namespace='string', Role='ADMIN'|'AUTHOR'|'READER'|'ADMIN_PRO'|'AUTHOR_PRO'|'READER_PRO' ) Parameters: * **MemberName** (*string*) -- **[REQUIRED]** The name of the group that you want to add to the role. * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account. * **Namespace** (*string*) -- **[REQUIRED]** The namespace that the role belongs to. * **Role** (*string*) -- **[REQUIRED]** The role that you want to add a group to. Return type: dict Returns: **Response Syntax** { 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.PreconditionNotMetException" * "QuickSight.Client.exceptions.InternalFailureException" * "QuickSight.Client.exceptions.ResourceUnavailableException" QuickSight / Client / create_theme create_theme ************ QuickSight.Client.create_theme(**kwargs) Creates a theme. A *theme* is set of configuration options for color and layout. Themes apply to analyses and dashboards. For more information, see Using Themes in Amazon QuickSight in the *Amazon QuickSight User Guide*. See also: AWS API Documentation **Request Syntax** response = client.create_theme( AwsAccountId='string', ThemeId='string', Name='string', BaseThemeId='string', VersionDescription='string', Configuration={ 'DataColorPalette': { 'Colors': [ 'string', ], 'MinMaxGradient': [ 'string', ], 'EmptyFillColor': 'string' }, 'UIColorPalette': { 'PrimaryForeground': 'string', 'PrimaryBackground': 'string', 'SecondaryForeground': 'string', 'SecondaryBackground': 'string', 'Accent': 'string', 'AccentForeground': 'string', 'Danger': 'string', 'DangerForeground': 'string', 'Warning': 'string', 'WarningForeground': 'string', 'Success': 'string', 'SuccessForeground': 'string', 'Dimension': 'string', 'DimensionForeground': 'string', 'Measure': 'string', 'MeasureForeground': 'string' }, 'Sheet': { 'Tile': { 'Border': { 'Show': True|False } }, 'TileLayout': { 'Gutter': { 'Show': True|False }, 'Margin': { 'Show': True|False } } }, 'Typography': { 'FontFamilies': [ { 'FontFamily': 'string' }, ] } }, Permissions=[ { 'Principal': 'string', 'Actions': [ 'string', ] }, ], Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account where you want to store the new theme. * **ThemeId** (*string*) -- **[REQUIRED]** 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** (*string*) -- **[REQUIRED]** A display name for the theme. * **BaseThemeId** (*string*) -- **[REQUIRED]** 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. * **VersionDescription** (*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** (*dict*) -- **[REQUIRED]** The theme configuration, which contains the theme display properties. * **DataColorPalette** *(dict) --* Color properties that apply to chart data colors. * **Colors** *(list) --* The hexadecimal codes for the colors. * *(string) --* * **MinMaxGradient** *(list) --* The minimum and maximum hexadecimal codes that describe a color gradient. * *(string) --* * **EmptyFillColor** *(string) --* The hexadecimal code of a color that applies to charts where a lack of data is highlighted. * **UIColorPalette** *(dict) --* Color properties that apply to the UI and to charts, excluding the colors that apply to data. * **PrimaryForeground** *(string) --* The color of text and other foreground elements that appear over the primary background regions, such as grid lines, borders, table banding, icons, and so on. * **PrimaryBackground** *(string) --* The background color that applies to visuals and other high emphasis UI. * **SecondaryForeground** *(string) --* The foreground color that applies to any sheet title, sheet control text, or UI that appears over the secondary background. * **SecondaryBackground** *(string) --* The background color that applies to the sheet background and sheet controls. * **Accent** *(string) --* This color is that applies to selected states and buttons. * **AccentForeground** *(string) --* The foreground color that applies to any text or other elements that appear over the accent color. * **Danger** *(string) --* The color that applies to error messages. * **DangerForeground** *(string) --* The foreground color that applies to any text or other elements that appear over the error color. * **Warning** *(string) --* This color that applies to warning and informational messages. * **WarningForeground** *(string) --* The foreground color that applies to any text or other elements that appear over the warning color. * **Success** *(string) --* The color that applies to success messages, for example the check mark for a successful download. * **SuccessForeground** *(string) --* The foreground color that applies to any text or other elements that appear over the success color. * **Dimension** *(string) --* The color that applies to the names of fields that are identified as dimensions. * **DimensionForeground** *(string) --* The foreground color that applies to any text or other elements that appear over the dimension color. * **Measure** *(string) --* The color that applies to the names of fields that are identified as measures. * **MeasureForeground** *(string) --* The foreground color that applies to any text or other elements that appear over the measure color. * **Sheet** *(dict) --* Display options related to sheets. * **Tile** *(dict) --* The display options for tiles. * **Border** *(dict) --* The border around a tile. * **Show** *(boolean) --* The option to enable display of borders for visuals. * **TileLayout** *(dict) --* The layout options for tiles. * **Gutter** *(dict) --* The gutter settings that apply between tiles. * **Show** *(boolean) --* This Boolean value controls whether to display a gutter space between sheet tiles. * **Margin** *(dict) --* The margin settings that apply around the outside edge of sheets. * **Show** *(boolean) --* This Boolean value controls whether to display sheet margins. * **Typography** *(dict) --* Determines the typography options. * **FontFamilies** *(list) --* Determines the list of font families. * *(dict) --* Determines the font settings. * **FontFamily** *(string) --* Determines the font family settings. * **Permissions** (*list*) -- A valid grouping of resource permissions to apply to the new theme. * *(dict) --* Permission for the resource. * **Principal** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the principal. This can be one of the following: * The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.) * The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.) * The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.) * **Actions** *(list) --* **[REQUIRED]** The IAM action to grant or revoke permissions on. * *(string) --* * **Tags** (*list*) -- A map of the key-value pairs for the resource tag or tags that you want to add to the resource. * *(dict) --* The key or keys of the key-value pairs for the resource tag or tags assigned to the resource. * **Key** *(string) --* **[REQUIRED]** Tag key. * **Value** *(string) --* **[REQUIRED]** Tag value. Return type: dict Returns: **Response Syntax** { 'Arn': 'string', 'VersionArn': 'string', 'ThemeId': 'string', 'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED', 'Status': 123, 'RequestId': 'string' } **Response Structure** * *(dict) --* * **Arn** *(string) --* The Amazon Resource Name (ARN) for the theme. * **VersionArn** *(string) --* The Amazon Resource Name (ARN) for the new theme. * **ThemeId** *(string) --* The ID of the theme. * **CreationStatus** *(string) --* The theme creation status. * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceExistsException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.LimitExceededException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / update_group update_group ************ QuickSight.Client.update_group(**kwargs) Changes a group description. See also: AWS API Documentation **Request Syntax** response = client.update_group( GroupName='string', Description='string', AwsAccountId='string', Namespace='string' ) Parameters: * **GroupName** (*string*) -- **[REQUIRED]** The name of the group that you want to update. * **Description** (*string*) -- The description for the group that you want to update. * **AwsAccountId** (*string*) -- **[REQUIRED]** 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** (*string*) -- **[REQUIRED]** The namespace of the group that you want to update. Return type: dict Returns: **Response Syntax** { 'Group': { 'Arn': 'string', 'GroupName': 'string', 'Description': 'string', 'PrincipalId': 'string' }, 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **Group** *(dict) --* The name of the group. * **Arn** *(string) --* The Amazon Resource Name (ARN) for the group. * **GroupName** *(string) --* The name of the group. * **Description** *(string) --* The group description. * **PrincipalId** *(string) --* The principal ID of the group. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.PreconditionNotMetException" * "QuickSight.Client.exceptions.InternalFailureException" * "QuickSight.Client.exceptions.ResourceUnavailableException" QuickSight / Client / delete_topic_refresh_schedule delete_topic_refresh_schedule ***************************** QuickSight.Client.delete_topic_refresh_schedule(**kwargs) Deletes a topic refresh schedule. See also: AWS API Documentation **Request Syntax** response = client.delete_topic_refresh_schedule( AwsAccountId='string', TopicId='string', DatasetId='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The Amazon Web Services account ID. * **TopicId** (*string*) -- **[REQUIRED]** The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. * **DatasetId** (*string*) -- **[REQUIRED]** The ID of the dataset. Return type: dict Returns: **Response Syntax** { 'TopicId': 'string', 'TopicArn': 'string', 'DatasetArn': 'string', 'Status': 123, 'RequestId': 'string' } **Response Structure** * *(dict) --* * **TopicId** *(string) --* The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. * **TopicArn** *(string) --* The Amazon Resource Name (ARN) of the topic. * **DatasetArn** *(string) --* The Amazon Resource Name (ARN) of the dataset. * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.LimitExceededException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ResourceExistsException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / describe_analysis_permissions describe_analysis_permissions ***************************** QuickSight.Client.describe_analysis_permissions(**kwargs) Provides the read and write permissions for an analysis. See also: AWS API Documentation **Request Syntax** response = client.describe_analysis_permissions( AwsAccountId='string', AnalysisId='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** 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. * **AnalysisId** (*string*) -- **[REQUIRED]** The ID of the analysis whose permissions you're describing. The ID is part of the analysis URL. Return type: dict Returns: **Response Syntax** { 'AnalysisId': 'string', 'AnalysisArn': 'string', 'Permissions': [ { 'Principal': 'string', 'Actions': [ 'string', ] }, ], 'Status': 123, 'RequestId': 'string' } **Response Structure** * *(dict) --* * **AnalysisId** *(string) --* The ID of the analysis whose permissions you're describing. * **AnalysisArn** *(string) --* The Amazon Resource Name (ARN) of the analysis whose permissions you're describing. * **Permissions** *(list) --* A structure that describes the principals and the resource- level permissions on an analysis. * *(dict) --* Permission for the resource. * **Principal** *(string) --* The Amazon Resource Name (ARN) of the principal. This can be one of the following: * The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.) * The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.) * The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.) * **Actions** *(list) --* The IAM action to grant or revoke permissions on. * *(string) --* * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / delete_folder delete_folder ************* QuickSight.Client.delete_folder(**kwargs) Deletes an empty folder. See also: AWS API Documentation **Request Syntax** response = client.delete_folder( AwsAccountId='string', FolderId='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID for the Amazon Web Services account that contains the folder. * **FolderId** (*string*) -- **[REQUIRED]** The ID of the folder. Return type: dict Returns: **Response Syntax** { 'Status': 123, 'Arn': 'string', 'FolderId': 'string', 'RequestId': 'string' } **Response Structure** * *(dict) --* * **Status** *(integer) --* The HTTP status of the request. * **Arn** *(string) --* The Amazon Resource Name of the deleted folder. * **FolderId** *(string) --* The ID of the folder. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.PreconditionNotMetException" * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / update_dashboard_published_version update_dashboard_published_version ********************************** QuickSight.Client.update_dashboard_published_version(**kwargs) Updates the published version of a dashboard. See also: AWS API Documentation **Request Syntax** response = client.update_dashboard_published_version( AwsAccountId='string', DashboardId='string', VersionNumber=123 ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the dashboard that you're updating. * **DashboardId** (*string*) -- **[REQUIRED]** The ID for the dashboard. * **VersionNumber** (*integer*) -- **[REQUIRED]** The version number of the dashboard. Return type: dict Returns: **Response Syntax** { 'DashboardId': 'string', 'DashboardArn': 'string', 'Status': 123, 'RequestId': 'string' } **Response Structure** * *(dict) --* * **DashboardId** *(string) --* The ID for the dashboard. * **DashboardArn** *(string) --* The Amazon Resource Name (ARN) of the dashboard. * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / list_dashboard_versions list_dashboard_versions *********************** QuickSight.Client.list_dashboard_versions(**kwargs) Lists all the versions of the dashboards in the Amazon QuickSight subscription. See also: AWS API Documentation **Request Syntax** response = client.list_dashboard_versions( AwsAccountId='string', DashboardId='string', NextToken='string', MaxResults=123 ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the dashboard that you're listing versions for. * **DashboardId** (*string*) -- **[REQUIRED]** The ID for the dashboard. * **NextToken** (*string*) -- The token for the next set of results, or null if there are no more results. * **MaxResults** (*integer*) -- The maximum number of results to be returned per request. Return type: dict Returns: **Response Syntax** { 'DashboardVersionSummaryList': [ { 'Arn': 'string', 'CreatedTime': datetime(2015, 1, 1), 'VersionNumber': 123, 'Status': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED', 'SourceEntityArn': 'string', 'Description': 'string' }, ], 'NextToken': 'string', 'Status': 123, 'RequestId': 'string' } **Response Structure** * *(dict) --* * **DashboardVersionSummaryList** *(list) --* A structure that contains information about each version of the dashboard. * *(dict) --* Dashboard version summary. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the resource. * **CreatedTime** *(datetime) --* The time that this dashboard version was created. * **VersionNumber** *(integer) --* Version number. * **Status** *(string) --* The HTTP status of the request. * **SourceEntityArn** *(string) --* Source entity ARN. * **Description** *(string) --* Description. * **NextToken** *(string) --* The token for the next set of results, or null if there are no more results. * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InvalidNextTokenException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / describe_default_q_business_application describe_default_q_business_application *************************************** QuickSight.Client.describe_default_q_business_application(**kwargs) Describes a Amazon Q Business application that is linked to an Amazon QuickSight account. See also: AWS API Documentation **Request Syntax** response = client.describe_default_q_business_application( AwsAccountId='string', Namespace='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon QuickSight account that is linked to the Amazon Q Business application that you want described. * **Namespace** (*string*) -- The Amazon QuickSight namespace that contains the linked Amazon Q Business application. If this field is left blank, the default namespace is used. Currently, the default namespace is the only valid value for this parameter. Return type: dict Returns: **Response Syntax** { 'RequestId': 'string', 'Status': 123, 'ApplicationId': 'string' } **Response Structure** * *(dict) --* * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. * **ApplicationId** *(string) --* The ID of the Amazon Q Business application that is linked to the Amazon QuickSight account. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / delete_account_subscription delete_account_subscription *************************** QuickSight.Client.delete_account_subscription(**kwargs) Use the "DeleteAccountSubscription" operation to delete an Amazon QuickSight account. This operation will result in an error message if you have configured your account termination protection settings to "True". To change this setting and delete your account, call the "UpdateAccountSettings" API and set the value of the "TerminationProtectionEnabled" parameter to "False", then make another call to the "DeleteAccountSubscription" API. See also: AWS API Documentation **Request Syntax** response = client.delete_account_subscription( AwsAccountId='string' ) Parameters: **AwsAccountId** (*string*) -- **[REQUIRED]** The Amazon Web Services account ID of the account that you want to delete. Return type: dict Returns: **Response Syntax** { 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.PreconditionNotMetException" * "QuickSight.Client.exceptions.InternalFailureException" * "QuickSight.Client.exceptions.ResourceUnavailableException" QuickSight / Client / describe_dashboard_snapshot_job describe_dashboard_snapshot_job ******************************* QuickSight.Client.describe_dashboard_snapshot_job(**kwargs) Describes an existing snapshot job. Poll job descriptions after a job starts to know the status of the job. For information on available status codes, see "JobStatus". See also: AWS API Documentation **Request Syntax** response = client.describe_dashboard_snapshot_job( AwsAccountId='string', DashboardId='string', SnapshotJobId='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that the dashboard snapshot job is executed in. * **DashboardId** (*string*) -- **[REQUIRED]** The ID of the dashboard that you have started a snapshot job for. * **SnapshotJobId** (*string*) -- **[REQUIRED]** The ID of the job to be described. The job ID is set when you start a new job with a "StartDashboardSnapshotJob" API call. Return type: dict Returns: **Response Syntax** { 'AwsAccountId': 'string', 'DashboardId': 'string', 'SnapshotJobId': 'string', 'UserConfiguration': { 'AnonymousUsers': [ { 'RowLevelPermissionTagKeys': [ 'string', ] }, ] }, 'SnapshotConfiguration': { 'FileGroups': [ { 'Files': [ { 'SheetSelections': [ { 'SheetId': 'string', 'SelectionScope': 'ALL_VISUALS'|'SELECTED_VISUALS', 'VisualIds': [ 'string', ] }, ], 'FormatType': 'CSV'|'PDF'|'EXCEL' }, ] }, ], 'DestinationConfiguration': { 'S3Destinations': [ { 'BucketConfiguration': { 'BucketName': 'string', 'BucketPrefix': 'string', 'BucketRegion': 'string' } }, ] }, 'Parameters': { 'StringParameters': [ { 'Name': 'string', 'Values': [ 'string', ] }, ], 'IntegerParameters': [ { 'Name': 'string', 'Values': [ 123, ] }, ], 'DecimalParameters': [ { 'Name': 'string', 'Values': [ 123.0, ] }, ], 'DateTimeParameters': [ { 'Name': 'string', 'Values': [ datetime(2015, 1, 1), ] }, ] } }, 'Arn': 'string', 'JobStatus': 'QUEUED'|'RUNNING'|'COMPLETED'|'FAILED', 'CreatedTime': datetime(2015, 1, 1), 'LastUpdatedTime': datetime(2015, 1, 1), 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **AwsAccountId** *(string) --* The ID of the Amazon Web Services account that the dashboard snapshot job is executed in. * **DashboardId** *(string) --* The ID of the dashboard that you have started a snapshot job for. * **SnapshotJobId** *(string) --* The ID of the job to be described. The job ID is set when you start a new job with a "StartDashboardSnapshotJob" API call. * **UserConfiguration** *(dict) --* The user configuration for the snapshot job. This information is provided when you make a "StartDashboardSnapshotJob" API call. * **AnonymousUsers** *(list) --* An array of records that describe anonymous users that the dashboard snapshot is generated for. Sensitive user information is excluded. * *(dict) --* Use this structure to redact sensitive information that you provide about an anonymous user from the snapshot. * **RowLevelPermissionTagKeys** *(list) --* The tag keys for the "RowLevelPermissionTags". * *(string) --* * **SnapshotConfiguration** *(dict) --* The snapshot configuration of the job. This information is provided when you make a "StartDashboardSnapshotJob" API call. * **FileGroups** *(list) --* A list of "SnapshotJobResultFileGroup" objects that contain information about the snapshot that is generated. This list can hold a maximum of 6 "FileGroup" configurations. * *(dict) --* A structure that contains the information on the snapshot files. * **Files** *(list) --* A list of "SnapshotFile" objects that contain the information on the snapshot files that need to be generated. This structure can hold 1 configuration at a time. * *(dict) --* A structure that contains the information for the snapshot that you want to generate. This information is provided by you when you start a new snapshot job. * **SheetSelections** *(list) --* A list of "SnapshotFileSheetSelection" objects that contain information on the dashboard sheet that is exported. These objects provide information about the snapshot artifacts that are generated during the job. This structure can hold a maximum of 5 CSV configurations, 5 Excel configurations, or 1 configuration for PDF. * *(dict) --* A structure that contains information that identifies the snapshot that needs to be generated. * **SheetId** *(string) --* The sheet ID of the dashboard to generate the snapshot artifact from. This value is required for CSV, Excel, and PDF format types. * **SelectionScope** *(string) --* The selection scope of the visuals on a sheet of a dashboard that you are generating a snapthot of. You can choose one of the following options. * "ALL_VISUALS" - Selects all visuals that are on the sheet. This value is required if the snapshot is a PDF. * "SELECTED_VISUALS" - Select the visual that you want to add to the snapshot. This value is required if the snapshot is a CSV or Excel workbook. * **VisualIds** *(list) --* A structure that lists the IDs of the visuals in the selected sheet. Supported visual types are table, pivot table visuals. This value is required if you are generating a CSV or Excel workbook. This value supports a maximum of 1 visual ID for CSV and 5 visual IDs across up to 5 sheet selections for Excel. If you are generating an Excel workbook, the order of the visual IDs provided in this structure determines the order of the worksheets in the Excel file. * *(string) --* * **FormatType** *(string) --* The format of the snapshot file to be generated. You can choose between "CSV", "Excel", or "PDF". * **DestinationConfiguration** *(dict) --* A structure that contains information on the Amazon S3 bucket that the generated snapshot is stored in. * **S3Destinations** *(list) --* A list of "SnapshotS3DestinationConfiguration" objects that contain Amazon S3 destination configurations. This structure can hold a maximum of 1 "S3DestinationConfiguration". * *(dict) --* A structure that describes the Amazon S3 settings to use to save the generated dashboard snapshot. * **BucketConfiguration** *(dict) --* A structure that contains details about the Amazon S3 bucket that the generated dashboard snapshot is saved in. * **BucketName** *(string) --* The name of an existing Amazon S3 bucket where the generated snapshot artifacts are sent. * **BucketPrefix** *(string) --* The prefix of the Amazon S3 bucket that the generated snapshots are stored in. * **BucketRegion** *(string) --* The region that the Amazon S3 bucket is located in. The bucket must be located in the same region that the "StartDashboardSnapshotJob" API call is made. * **Parameters** *(dict) --* A list of Amazon QuickSight parameters and the list's override values. * **StringParameters** *(list) --* The parameters that have a data type of string. * *(dict) --* A string parameter. * **Name** *(string) --* A display name for a string parameter. * **Values** *(list) --* The values of a string parameter. * *(string) --* * **IntegerParameters** *(list) --* The parameters that have a data type of integer. * *(dict) --* An integer parameter. * **Name** *(string) --* The name of the integer parameter. * **Values** *(list) --* The values for the integer parameter. * *(integer) --* * **DecimalParameters** *(list) --* The parameters that have a data type of decimal. * *(dict) --* A decimal parameter. * **Name** *(string) --* A display name for the decimal parameter. * **Values** *(list) --* The values for the decimal parameter. * *(float) --* * **DateTimeParameters** *(list) --* The parameters that have a data type of date-time. * *(dict) --* A date-time parameter. * **Name** *(string) --* A display name for the date-time parameter. * **Values** *(list) --* The values for the date-time parameter. * *(datetime) --* * **Arn** *(string) --* The Amazon Resource Name (ARN) for the snapshot job. The job ARN is generated when you start a new job with a "StartDashboardSnapshotJob" API call. * **JobStatus** *(string) --* Indicates the status of a job. The status updates as the job executes. This shows one of the following values. * "COMPLETED" - The job was completed successfully. * "FAILED" - The job failed to execute. * "QUEUED" - The job is queued and hasn't started yet. * "RUNNING" - The job is still running. * **CreatedTime** *(datetime) --* The time that the snapshot job was created. * **LastUpdatedTime** *(datetime) --* The time that the snapshot job status was last updated. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / list_data_sets list_data_sets ************** QuickSight.Client.list_data_sets(**kwargs) Lists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region. The permissions resource is "arn:aws:quicksight:region:aws-account- id:dataset/*". See also: AWS API Documentation **Request Syntax** response = client.list_data_sets( AwsAccountId='string', NextToken='string', MaxResults=123 ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The Amazon Web Services account ID. * **NextToken** (*string*) -- The token for the next set of results, or null if there are no more results. * **MaxResults** (*integer*) -- The maximum number of results to be returned per request. Return type: dict Returns: **Response Syntax** { 'DataSetSummaries': [ { 'Arn': 'string', 'DataSetId': 'string', 'Name': 'string', 'CreatedTime': datetime(2015, 1, 1), 'LastUpdatedTime': datetime(2015, 1, 1), 'ImportMode': 'SPICE'|'DIRECT_QUERY', 'RowLevelPermissionDataSet': { 'Namespace': 'string', 'Arn': 'string', 'PermissionPolicy': 'GRANT_ACCESS'|'DENY_ACCESS', 'FormatVersion': 'VERSION_1'|'VERSION_2', 'Status': 'ENABLED'|'DISABLED' }, 'RowLevelPermissionTagConfigurationApplied': True|False, 'ColumnLevelPermissionRulesApplied': True|False, 'UseAs': 'RLS_RULES' }, ], 'NextToken': 'string', 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **DataSetSummaries** *(list) --* The list of dataset summaries. * *(dict) --* Dataset summary. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the dataset. * **DataSetId** *(string) --* The ID of the dataset. * **Name** *(string) --* A display name for the dataset. * **CreatedTime** *(datetime) --* The time that this dataset was created. * **LastUpdatedTime** *(datetime) --* The last time that this dataset was updated. * **ImportMode** *(string) --* A value that indicates whether you want to import the data into SPICE. * **RowLevelPermissionDataSet** *(dict) --* The row-level security configuration for the dataset. * **Namespace** *(string) --* The namespace associated with the dataset that contains permissions for RLS. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS. * **PermissionPolicy** *(string) --* The type of permissions to use when interpreting the permissions for RLS. "DENY_ACCESS" is included for backward compatibility only. * **FormatVersion** *(string) --* The user or group rules associated with the dataset that contains permissions for RLS. By default, "FormatVersion" is "VERSION_1". When "FormatVersion" is "VERSION_1", "UserName" and "GroupName" are required. When "FormatVersion" is "VERSION_2", "UserARN" and "GroupARN" are required, and "Namespace" must not exist. * **Status** *(string) --* The status of the row-level security permission dataset. If enabled, the status is "ENABLED". If disabled, the status is "DISABLED". * **RowLevelPermissionTagConfigurationApplied** *(boolean) --* Whether or not the row level permission tags are applied. * **ColumnLevelPermissionRulesApplied** *(boolean) --* A value that indicates if the dataset has column level permission configured. * **UseAs** *(string) --* The usage of the dataset. * **NextToken** *(string) --* The token for the next set of results, or null if there are no more results. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InvalidNextTokenException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / list_iam_policy_assignments_for_user list_iam_policy_assignments_for_user ************************************ QuickSight.Client.list_iam_policy_assignments_for_user(**kwargs) Lists all of the IAM policy assignments, including the Amazon Resource Names (ARNs), for the IAM policies assigned to the specified user and group, or groups that the user belongs to. See also: AWS API Documentation **Request Syntax** response = client.list_iam_policy_assignments_for_user( AwsAccountId='string', UserName='string', NextToken='string', MaxResults=123, Namespace='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the assignments. * **UserName** (*string*) -- **[REQUIRED]** The name of the user. * **NextToken** (*string*) -- The token for the next set of results, or null if there are no more results. * **MaxResults** (*integer*) -- The maximum number of results to be returned per request. * **Namespace** (*string*) -- **[REQUIRED]** The namespace of the assignment. Return type: dict Returns: **Response Syntax** { 'ActiveAssignments': [ { 'AssignmentName': 'string', 'PolicyArn': 'string' }, ], 'RequestId': 'string', 'NextToken': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **ActiveAssignments** *(list) --* The active assignments for this user. * *(dict) --* The active Identity and Access Management (IAM) policy assignment. * **AssignmentName** *(string) --* A name for the IAM policy assignment. * **PolicyArn** *(string) --* The Amazon Resource Name (ARN) of the resource. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **NextToken** *(string) --* The token for the next set of results, or null if there are no more results. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceExistsException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.ConcurrentUpdatingException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / describe_theme_permissions describe_theme_permissions ************************** QuickSight.Client.describe_theme_permissions(**kwargs) Describes the read and write permissions for a theme. See also: AWS API Documentation **Request Syntax** response = client.describe_theme_permissions( AwsAccountId='string', ThemeId='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the theme that you're describing. * **ThemeId** (*string*) -- **[REQUIRED]** The ID for the theme that you want to describe permissions for. Return type: dict Returns: **Response Syntax** { 'ThemeId': 'string', 'ThemeArn': 'string', 'Permissions': [ { 'Principal': 'string', 'Actions': [ 'string', ] }, ], 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **ThemeId** *(string) --* The ID for the theme. * **ThemeArn** *(string) --* The Amazon Resource Name (ARN) of the theme. * **Permissions** *(list) --* A list of resource permissions set on the theme. * *(dict) --* Permission for the resource. * **Principal** *(string) --* The Amazon Resource Name (ARN) of the principal. This can be one of the following: * The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.) * The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.) * The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.) * **Actions** *(list) --* The IAM action to grant or revoke permissions on. * *(string) --* * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / update_data_set update_data_set *************** QuickSight.Client.update_data_set(**kwargs) Updates a dataset. This operation doesn't support datasets that include uploaded files as a source. Partial updates are not supported by this operation. See also: AWS API Documentation **Request Syntax** response = client.update_data_set( AwsAccountId='string', DataSetId='string', Name='string', PhysicalTableMap={ 'string': { 'RelationalTable': { 'DataSourceArn': 'string', 'Catalog': 'string', 'Schema': 'string', 'Name': 'string', 'InputColumns': [ { 'Name': 'string', 'Type': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME'|'BIT'|'BOOLEAN'|'JSON', 'SubType': 'FLOAT'|'FIXED' }, ] }, 'CustomSql': { 'DataSourceArn': 'string', 'Name': 'string', 'SqlQuery': 'string', 'Columns': [ { 'Name': 'string', 'Type': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME'|'BIT'|'BOOLEAN'|'JSON', 'SubType': 'FLOAT'|'FIXED' }, ] }, 'S3Source': { 'DataSourceArn': 'string', 'UploadSettings': { 'Format': 'CSV'|'TSV'|'CLF'|'ELF'|'XLSX'|'JSON', 'StartFromRow': 123, 'ContainsHeader': True|False, 'TextQualifier': 'DOUBLE_QUOTE'|'SINGLE_QUOTE', 'Delimiter': 'string' }, 'InputColumns': [ { 'Name': 'string', 'Type': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME'|'BIT'|'BOOLEAN'|'JSON', 'SubType': 'FLOAT'|'FIXED' }, ] } } }, LogicalTableMap={ 'string': { 'Alias': 'string', 'DataTransforms': [ { 'ProjectOperation': { 'ProjectedColumns': [ 'string', ] }, 'FilterOperation': { 'ConditionExpression': 'string' }, 'CreateColumnsOperation': { 'Columns': [ { 'ColumnName': 'string', 'ColumnId': 'string', 'Expression': 'string' }, ] }, 'RenameColumnOperation': { 'ColumnName': 'string', 'NewColumnName': 'string' }, 'CastColumnTypeOperation': { 'ColumnName': 'string', 'NewColumnType': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME', 'SubType': 'FLOAT'|'FIXED', 'Format': 'string' }, 'TagColumnOperation': { 'ColumnName': 'string', 'Tags': [ { 'ColumnGeographicRole': 'COUNTRY'|'STATE'|'COUNTY'|'CITY'|'POSTCODE'|'LONGITUDE'|'LATITUDE', 'ColumnDescription': { 'Text': 'string' } }, ] }, 'UntagColumnOperation': { 'ColumnName': 'string', 'TagNames': [ 'COLUMN_GEOGRAPHIC_ROLE'|'COLUMN_DESCRIPTION', ] }, 'OverrideDatasetParameterOperation': { 'ParameterName': 'string', 'NewParameterName': 'string', 'NewDefaultValues': { 'StringStaticValues': [ 'string', ], 'DecimalStaticValues': [ 123.0, ], 'DateTimeStaticValues': [ datetime(2015, 1, 1), ], 'IntegerStaticValues': [ 123, ] } } }, ], 'Source': { 'JoinInstruction': { 'LeftOperand': 'string', 'RightOperand': 'string', 'LeftJoinKeyProperties': { 'UniqueKey': True|False }, 'RightJoinKeyProperties': { 'UniqueKey': True|False }, 'Type': 'INNER'|'OUTER'|'LEFT'|'RIGHT', 'OnClause': 'string' }, 'PhysicalTableId': 'string', 'DataSetArn': 'string' } } }, ImportMode='SPICE'|'DIRECT_QUERY', ColumnGroups=[ { 'GeoSpatialColumnGroup': { 'Name': 'string', 'CountryCode': 'US', 'Columns': [ 'string', ] } }, ], FieldFolders={ 'string': { 'description': 'string', 'columns': [ 'string', ] } }, RowLevelPermissionDataSet={ 'Namespace': 'string', 'Arn': 'string', 'PermissionPolicy': 'GRANT_ACCESS'|'DENY_ACCESS', 'FormatVersion': 'VERSION_1'|'VERSION_2', 'Status': 'ENABLED'|'DISABLED' }, RowLevelPermissionTagConfiguration={ 'Status': 'ENABLED'|'DISABLED', 'TagRules': [ { 'TagKey': 'string', 'ColumnName': 'string', 'TagMultiValueDelimiter': 'string', 'MatchAllValue': 'string' }, ], 'TagRuleConfigurations': [ [ 'string', ], ] }, ColumnLevelPermissionRules=[ { 'Principals': [ 'string', ], 'ColumnNames': [ 'string', ] }, ], DataSetUsageConfiguration={ 'DisableUseAsDirectQuerySource': True|False, 'DisableUseAsImportedSource': True|False }, DatasetParameters=[ { 'StringDatasetParameter': { 'Id': 'string', 'Name': 'string', 'ValueType': 'MULTI_VALUED'|'SINGLE_VALUED', 'DefaultValues': { 'StaticValues': [ 'string', ] } }, 'DecimalDatasetParameter': { 'Id': 'string', 'Name': 'string', 'ValueType': 'MULTI_VALUED'|'SINGLE_VALUED', 'DefaultValues': { 'StaticValues': [ 123.0, ] } }, 'IntegerDatasetParameter': { 'Id': 'string', 'Name': 'string', 'ValueType': 'MULTI_VALUED'|'SINGLE_VALUED', 'DefaultValues': { 'StaticValues': [ 123, ] } }, 'DateTimeDatasetParameter': { 'Id': 'string', 'Name': 'string', 'ValueType': 'MULTI_VALUED'|'SINGLE_VALUED', 'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND', 'DefaultValues': { 'StaticValues': [ datetime(2015, 1, 1), ] } } }, ], PerformanceConfiguration={ 'UniqueKeys': [ { 'ColumnNames': [ 'string', ] }, ] } ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The Amazon Web Services account ID. * **DataSetId** (*string*) -- **[REQUIRED]** 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** (*string*) -- **[REQUIRED]** The display name for the dataset. * **PhysicalTableMap** (*dict*) -- **[REQUIRED]** Declares the physical tables that are available in the underlying data sources. * *(string) --* * *(dict) --* A view of a data source that contains information about the shape of the data in the underlying source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null. * **RelationalTable** *(dict) --* A physical table type for relational data sources. * **DataSourceArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) for the data source. * **Catalog** *(string) --* The catalog associated with a table. * **Schema** *(string) --* The schema name. This name applies to certain relational database engines. * **Name** *(string) --* **[REQUIRED]** The name of the relational table. * **InputColumns** *(list) --* **[REQUIRED]** The column schema of the table. * *(dict) --* Metadata for a column that is used as the input of a transform operation. * **Name** *(string) --* **[REQUIRED]** The name of this column in the underlying data source. * **Type** *(string) --* **[REQUIRED]** The data type of the column. * **SubType** *(string) --* The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset. * **CustomSql** *(dict) --* A physical table type built from the results of the custom SQL query. * **DataSourceArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the data source. * **Name** *(string) --* **[REQUIRED]** A display name for the SQL query result. * **SqlQuery** *(string) --* **[REQUIRED]** The SQL query. * **Columns** *(list) --* The column schema from the SQL query result set. * *(dict) --* Metadata for a column that is used as the input of a transform operation. * **Name** *(string) --* **[REQUIRED]** The name of this column in the underlying data source. * **Type** *(string) --* **[REQUIRED]** The data type of the column. * **SubType** *(string) --* The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset. * **S3Source** *(dict) --* A physical table type for as S3 data source. * **DataSourceArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) for the data source. * **UploadSettings** *(dict) --* Information about the format for the S3 source file or files. * **Format** *(string) --* File format. * **StartFromRow** *(integer) --* A row number to start reading data from. * **ContainsHeader** *(boolean) --* Whether the file has a header row, or the files each have a header row. * **TextQualifier** *(string) --* Text qualifier. * **Delimiter** *(string) --* The delimiter between values in the file. * **InputColumns** *(list) --* **[REQUIRED]** A physical table type for an S3 data source. Note: For files that aren't JSON, only "STRING" data types are supported in input columns. * *(dict) --* Metadata for a column that is used as the input of a transform operation. * **Name** *(string) --* **[REQUIRED]** The name of this column in the underlying data source. * **Type** *(string) --* **[REQUIRED]** The data type of the column. * **SubType** *(string) --* The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset. * **LogicalTableMap** (*dict*) -- Configures the combination and transformation of the data from the physical tables. * *(string) --* An identifier for the logical table that is defined in the dataset * *(dict) --* A *logical table* is a unit that joins and that data transformations operate on. A logical table has a source, which can be either a physical table or result of a join. When a logical table points to a physical table, the logical table acts as a mutable copy of that physical table through transform operations. * **Alias** *(string) --* **[REQUIRED]** A display name for the logical table. * **DataTransforms** *(list) --* Transform operations that act on this logical table. For this structure to be valid, only one of the attributes can be non-null. * *(dict) --* A data transformation on a logical table. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null. * **ProjectOperation** *(dict) --* An operation that projects columns. Operations that come after a projection can only refer to projected columns. * **ProjectedColumns** *(list) --* **[REQUIRED]** Projected columns. * *(string) --* * **FilterOperation** *(dict) --* An operation that filters rows based on some condition. * **ConditionExpression** *(string) --* **[REQUIRED]** An expression that must evaluate to a Boolean value. Rows for which the expression evaluates to true are kept in the dataset. * **CreateColumnsOperation** *(dict) --* An operation that creates calculated columns. Columns created in one such operation form a lexical closure. * **Columns** *(list) --* **[REQUIRED]** Calculated columns to create. * *(dict) --* A calculated column for a dataset. * **ColumnName** *(string) --* **[REQUIRED]** Column name. * **ColumnId** *(string) --* **[REQUIRED]** A unique ID to identify a calculated column. During a dataset update, if the column ID of a calculated column matches that of an existing calculated column, Amazon QuickSight preserves the existing calculated column. * **Expression** *(string) --* **[REQUIRED]** An expression that defines the calculated column. * **RenameColumnOperation** *(dict) --* An operation that renames a column. * **ColumnName** *(string) --* **[REQUIRED]** The name of the column to be renamed. * **NewColumnName** *(string) --* **[REQUIRED]** The new name for the column. * **CastColumnTypeOperation** *(dict) --* A transform operation that casts a column to a different type. * **ColumnName** *(string) --* **[REQUIRED]** Column name. * **NewColumnType** *(string) --* **[REQUIRED]** New column data type. * **SubType** *(string) --* The sub data type of the new column. Sub types are only available for decimal columns that are part of a SPICE dataset. * **Format** *(string) --* When casting a column from string to datetime type, you can supply a string in a format supported by Amazon QuickSight to denote the source data format. * **TagColumnOperation** *(dict) --* An operation that tags a column with additional information. * **ColumnName** *(string) --* **[REQUIRED]** The column that this operation acts on. * **Tags** *(list) --* **[REQUIRED]** The dataset column tag, currently only used for geospatial type tagging. Note: This is not tags for the Amazon Web Services tagging feature. * *(dict) --* A tag for a column in a "TagColumnOperation" structure. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null. * **ColumnGeographicRole** *(string) --* A geospatial role for a column. * **ColumnDescription** *(dict) --* A description for a column. * **Text** *(string) --* The text of a description for a column. * **UntagColumnOperation** *(dict) --* A transform operation that removes tags associated with a column. * **ColumnName** *(string) --* **[REQUIRED]** The column that this operation acts on. * **TagNames** *(list) --* **[REQUIRED]** The column tags to remove from this column. * *(string) --* * **OverrideDatasetParameterOperation** *(dict) --* A transform operation that overrides the dataset parameter values that are defined in another dataset. * **ParameterName** *(string) --* **[REQUIRED]** The name of the parameter to be overridden with different values. * **NewParameterName** *(string) --* The new name for the parameter. * **NewDefaultValues** *(dict) --* The new default values for the parameter. * **StringStaticValues** *(list) --* A list of static default values for a given string parameter. * *(string) --* The default value for the string parameter. * **DecimalStaticValues** *(list) --* A list of static default values for a given decimal parameter. * *(float) --* The default value for the decimal parameter. * **DateTimeStaticValues** *(list) --* A list of static default values for a given date time parameter. * *(datetime) --* The default value for the date time parameter. * **IntegerStaticValues** *(list) --* A list of static default values for a given integer parameter. * *(integer) --* The default value for the integer parameter. * **Source** *(dict) --* **[REQUIRED]** Source of this logical table. * **JoinInstruction** *(dict) --* Specifies the result of a join of two logical tables. * **LeftOperand** *(string) --* **[REQUIRED]** The operand on the left side of a join. * **RightOperand** *(string) --* **[REQUIRED]** The operand on the right side of a join. * **LeftJoinKeyProperties** *(dict) --* Join key properties of the left operand. * **UniqueKey** *(boolean) --* A value that indicates that a row in a table is uniquely identified by the columns in a join key. This is used by Amazon QuickSight to optimize query performance. * **RightJoinKeyProperties** *(dict) --* Join key properties of the right operand. * **UniqueKey** *(boolean) --* A value that indicates that a row in a table is uniquely identified by the columns in a join key. This is used by Amazon QuickSight to optimize query performance. * **Type** *(string) --* **[REQUIRED]** The type of join that it is. * **OnClause** *(string) --* **[REQUIRED]** The join instructions provided in the "ON" clause of a join. * **PhysicalTableId** *(string) --* Physical table ID. * **DataSetArn** *(string) --* The Amazon Resource Number (ARN) of the parent dataset. * **ImportMode** (*string*) -- **[REQUIRED]** Indicates whether you want to import the data into SPICE. * **ColumnGroups** (*list*) -- Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported. * *(dict) --* Groupings of columns that work together in certain Amazon QuickSight features. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null. * **GeoSpatialColumnGroup** *(dict) --* Geospatial column group that denotes a hierarchy. * **Name** *(string) --* **[REQUIRED]** A display name for the hierarchy. * **CountryCode** *(string) --* Country code. * **Columns** *(list) --* **[REQUIRED]** Columns in this hierarchy. * *(string) --* * **FieldFolders** (*dict*) -- The folder that contains fields and nested subfolders for your dataset. * *(string) --* * *(dict) --* A FieldFolder element is a folder that contains fields and nested subfolders. * **description** *(string) --* The description for a field folder. * **columns** *(list) --* A folder has a list of columns. A column can only be in one folder. * *(string) --* * **RowLevelPermissionDataSet** (*dict*) -- The row-level security configuration for the data you want to create. * **Namespace** *(string) --* The namespace associated with the dataset that contains permissions for RLS. * **Arn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS. * **PermissionPolicy** *(string) --* **[REQUIRED]** The type of permissions to use when interpreting the permissions for RLS. "DENY_ACCESS" is included for backward compatibility only. * **FormatVersion** *(string) --* The user or group rules associated with the dataset that contains permissions for RLS. By default, "FormatVersion" is "VERSION_1". When "FormatVersion" is "VERSION_1", "UserName" and "GroupName" are required. When "FormatVersion" is "VERSION_2", "UserARN" and "GroupARN" are required, and "Namespace" must not exist. * **Status** *(string) --* The status of the row-level security permission dataset. If enabled, the status is "ENABLED". If disabled, the status is "DISABLED". * **RowLevelPermissionTagConfiguration** (*dict*) -- The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only. * **Status** *(string) --* The status of row-level security tags. If enabled, the status is "ENABLED". If disabled, the status is "DISABLED". * **TagRules** *(list) --* **[REQUIRED]** A set of rules associated with row-level security, such as the tag names and columns that they are assigned to. * *(dict) --* A set of rules associated with a tag. * **TagKey** *(string) --* **[REQUIRED]** The unique key for a tag. * **ColumnName** *(string) --* **[REQUIRED]** The column name that a tag key is assigned to. * **TagMultiValueDelimiter** *(string) --* A string that you want to use to delimit the values when you pass the values at run time. For example, you can delimit the values with a comma. * **MatchAllValue** *(string) --* A string that you want to use to filter by all the values in a column in the dataset and don’t want to list the values one by one. For example, you can use an asterisk as your match all value. * **TagRuleConfigurations** *(list) --* A list of tag configuration rules to apply to a dataset. All tag configurations have the OR condition. Tags within each tile will be joined (AND). At least one rule in this structure must have all tag values assigned to it to apply Row-level security (RLS) to the dataset. * *(list) --* * *(string) --* * **ColumnLevelPermissionRules** (*list*) -- A set of one or more definitions of a >>``<>``<<. * *(dict) --* A rule defined to grant access on one or more restricted columns. Each dataset can have multiple rules. To create a restricted column, you add it to one or more rules. Each rule must contain at least one column and at least one user or group. To be able to see a restricted column, a user or group needs to be added to a rule for that column. * **Principals** *(list) --* An array of Amazon Resource Names (ARNs) for Amazon QuickSight users or groups. * *(string) --* * **ColumnNames** *(list) --* An array of column names. * *(string) --* * **DataSetUsageConfiguration** (*dict*) -- The usage configuration to apply to child datasets that reference this dataset as a source. * **DisableUseAsDirectQuerySource** *(boolean) --* An option that controls whether a child dataset of a direct query can use this dataset as a source. * **DisableUseAsImportedSource** *(boolean) --* An option that controls whether a child dataset that's stored in QuickSight can use this dataset as a source. * **DatasetParameters** (*list*) -- The parameter declarations of the dataset. * *(dict) --* A parameter that is created in a dataset. The parameter can be a string, integer, decimal, or datetime data type. * **StringDatasetParameter** *(dict) --* A string parameter that is created in the dataset. * **Id** *(string) --* **[REQUIRED]** An identifier for the string parameter that is created in the dataset. * **Name** *(string) --* **[REQUIRED]** The name of the string parameter that is created in the dataset. * **ValueType** *(string) --* **[REQUIRED]** The value type of the dataset parameter. Valid values are "single value" or "multi value". * **DefaultValues** *(dict) --* A list of default values for a given string dataset parameter type. This structure only accepts static values. * **StaticValues** *(list) --* A list of static default values for a given string parameter. * *(string) --* The default value for the string parameter. * **DecimalDatasetParameter** *(dict) --* A decimal parameter that is created in the dataset. * **Id** *(string) --* **[REQUIRED]** An identifier for the decimal parameter created in the dataset. * **Name** *(string) --* **[REQUIRED]** The name of the decimal parameter that is created in the dataset. * **ValueType** *(string) --* **[REQUIRED]** The value type of the dataset parameter. Valid values are "single value" or "multi value". * **DefaultValues** *(dict) --* A list of default values for a given decimal parameter. This structure only accepts static values. * **StaticValues** *(list) --* A list of static default values for a given decimal parameter. * *(float) --* The default value for the decimal parameter. * **IntegerDatasetParameter** *(dict) --* An integer parameter that is created in the dataset. * **Id** *(string) --* **[REQUIRED]** An identifier for the integer parameter created in the dataset. * **Name** *(string) --* **[REQUIRED]** The name of the integer parameter that is created in the dataset. * **ValueType** *(string) --* **[REQUIRED]** The value type of the dataset parameter. Valid values are "single value" or "multi value". * **DefaultValues** *(dict) --* A list of default values for a given integer parameter. This structure only accepts static values. * **StaticValues** *(list) --* A list of static default values for a given integer parameter. * *(integer) --* The default value for the integer parameter. * **DateTimeDatasetParameter** *(dict) --* A date time parameter that is created in the dataset. * **Id** *(string) --* **[REQUIRED]** An identifier for the parameter that is created in the dataset. * **Name** *(string) --* **[REQUIRED]** The name of the date time parameter that is created in the dataset. * **ValueType** *(string) --* **[REQUIRED]** The value type of the dataset parameter. Valid values are "single value" or "multi value". * **TimeGranularity** *(string) --* The time granularity of the date time parameter. * **DefaultValues** *(dict) --* A list of default values for a given date time parameter. This structure only accepts static values. * **StaticValues** *(list) --* A list of static default values for a given date time parameter. * *(datetime) --* The default value for the date time parameter. * **PerformanceConfiguration** (*dict*) -- The configuration for the performance optimization of the dataset that contains a "UniqueKey" configuration. * **UniqueKeys** *(list) --* A "UniqueKey" configuration. * *(dict) --* A "UniqueKey" configuration that references a dataset column. * **ColumnNames** *(list) --* **[REQUIRED]** The name of the column that is referenced in the "UniqueKey" configuration. * *(string) --* Return type: dict Returns: **Response Syntax** { 'Arn': 'string', 'DataSetId': 'string', 'IngestionArn': 'string', 'IngestionId': 'string', 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **Arn** *(string) --* The Amazon Resource Name (ARN) of the dataset. * **DataSetId** *(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. * **IngestionArn** *(string) --* The ARN for the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE. * **IngestionId** *(string) --* The ID of the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.LimitExceededException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / batch_delete_topic_reviewed_answer batch_delete_topic_reviewed_answer ********************************** QuickSight.Client.batch_delete_topic_reviewed_answer(**kwargs) Deletes reviewed answers for Q Topic. See also: AWS API Documentation **Request Syntax** response = client.batch_delete_topic_reviewed_answer( AwsAccountId='string', TopicId='string', AnswerIds=[ 'string', ] ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that you want to delete a reviewed answers in. * **TopicId** (*string*) -- **[REQUIRED]** The ID for the topic reviewed answer that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. * **AnswerIds** (*list*) -- The Answer IDs of the Answers to be deleted. * *(string) --* Return type: dict Returns: **Response Syntax** { 'TopicId': 'string', 'TopicArn': 'string', 'SucceededAnswers': [ { 'AnswerId': 'string' }, ], 'InvalidAnswers': [ { 'AnswerId': 'string', 'Error': 'INTERNAL_ERROR'|'MISSING_ANSWER'|'DATASET_DOES_NOT_EXIST'|'INVALID_DATASET_ARN'|'DUPLICATED_ANSWER'|'INVALID_DATA'|'MISSING_REQUIRED_FIELDS' }, ], 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **TopicId** *(string) --* The ID of the topic reviewed answer that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. * **TopicArn** *(string) --* The Amazon Resource Name (ARN) of the topic. * **SucceededAnswers** *(list) --* The definition of Answers that are successfully deleted. * *(dict) --* The definition for a "SucceededTopicReviewedAnswer". * **AnswerId** *(string) --* The answer ID for the "SucceededTopicReviewedAnswer". * **InvalidAnswers** *(list) --* The definition of Answers that are invalid and not deleted. * *(dict) --* The definition for a "InvalidTopicReviewedAnswer". * **AnswerId** *(string) --* The answer ID for the "InvalidTopicReviewedAnswer". * **Error** *(string) --* The error that is returned for the "InvalidTopicReviewedAnswer". * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / tag_resource tag_resource ************ QuickSight.Client.tag_resource(**kwargs) Assigns one or more tags (key-value pairs) to the specified Amazon QuickSight resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. You can use the "TagResource" operation with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag. You can associate as many as 50 tags with a resource. Amazon QuickSight supports tagging on data set, data source, dashboard, template, topic, and user. Tagging for Amazon QuickSight works in a similar way to tagging for other Amazon Web Services services, except for the following: * Tags are used to track costs for users in Amazon QuickSight. You can't tag other resources that Amazon QuickSight costs are based on, such as storage capacoty (SPICE), session usage, alert consumption, or reporting units. * Amazon QuickSight doesn't currently support the tag editor for Resource Groups. See also: AWS API Documentation **Request Syntax** response = client.tag_resource( ResourceArn='string', Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **ResourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the resource that you want to tag. * **Tags** (*list*) -- **[REQUIRED]** Contains a map of the key-value pairs for the resource tag or tags assigned to the resource. * *(dict) --* The key or keys of the key-value pairs for the resource tag or tags assigned to the resource. * **Key** *(string) --* **[REQUIRED]** Tag key. * **Value** *(string) --* **[REQUIRED]** Tag value. Return type: dict Returns: **Response Syntax** { 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.LimitExceededException" * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / describe_data_set describe_data_set ***************** QuickSight.Client.describe_data_set(**kwargs) Describes a dataset. This operation doesn't support datasets that include uploaded files as a source. See also: AWS API Documentation **Request Syntax** response = client.describe_data_set( AwsAccountId='string', DataSetId='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The Amazon Web Services account ID. * **DataSetId** (*string*) -- **[REQUIRED]** 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. Return type: dict Returns: **Response Syntax** { 'DataSet': { 'Arn': 'string', 'DataSetId': 'string', 'Name': 'string', 'CreatedTime': datetime(2015, 1, 1), 'LastUpdatedTime': datetime(2015, 1, 1), 'PhysicalTableMap': { 'string': { 'RelationalTable': { 'DataSourceArn': 'string', 'Catalog': 'string', 'Schema': 'string', 'Name': 'string', 'InputColumns': [ { 'Name': 'string', 'Type': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME'|'BIT'|'BOOLEAN'|'JSON', 'SubType': 'FLOAT'|'FIXED' }, ] }, 'CustomSql': { 'DataSourceArn': 'string', 'Name': 'string', 'SqlQuery': 'string', 'Columns': [ { 'Name': 'string', 'Type': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME'|'BIT'|'BOOLEAN'|'JSON', 'SubType': 'FLOAT'|'FIXED' }, ] }, 'S3Source': { 'DataSourceArn': 'string', 'UploadSettings': { 'Format': 'CSV'|'TSV'|'CLF'|'ELF'|'XLSX'|'JSON', 'StartFromRow': 123, 'ContainsHeader': True|False, 'TextQualifier': 'DOUBLE_QUOTE'|'SINGLE_QUOTE', 'Delimiter': 'string' }, 'InputColumns': [ { 'Name': 'string', 'Type': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME'|'BIT'|'BOOLEAN'|'JSON', 'SubType': 'FLOAT'|'FIXED' }, ] } } }, 'LogicalTableMap': { 'string': { 'Alias': 'string', 'DataTransforms': [ { 'ProjectOperation': { 'ProjectedColumns': [ 'string', ] }, 'FilterOperation': { 'ConditionExpression': 'string' }, 'CreateColumnsOperation': { 'Columns': [ { 'ColumnName': 'string', 'ColumnId': 'string', 'Expression': 'string' }, ] }, 'RenameColumnOperation': { 'ColumnName': 'string', 'NewColumnName': 'string' }, 'CastColumnTypeOperation': { 'ColumnName': 'string', 'NewColumnType': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME', 'SubType': 'FLOAT'|'FIXED', 'Format': 'string' }, 'TagColumnOperation': { 'ColumnName': 'string', 'Tags': [ { 'ColumnGeographicRole': 'COUNTRY'|'STATE'|'COUNTY'|'CITY'|'POSTCODE'|'LONGITUDE'|'LATITUDE', 'ColumnDescription': { 'Text': 'string' } }, ] }, 'UntagColumnOperation': { 'ColumnName': 'string', 'TagNames': [ 'COLUMN_GEOGRAPHIC_ROLE'|'COLUMN_DESCRIPTION', ] }, 'OverrideDatasetParameterOperation': { 'ParameterName': 'string', 'NewParameterName': 'string', 'NewDefaultValues': { 'StringStaticValues': [ 'string', ], 'DecimalStaticValues': [ 123.0, ], 'DateTimeStaticValues': [ datetime(2015, 1, 1), ], 'IntegerStaticValues': [ 123, ] } } }, ], 'Source': { 'JoinInstruction': { 'LeftOperand': 'string', 'RightOperand': 'string', 'LeftJoinKeyProperties': { 'UniqueKey': True|False }, 'RightJoinKeyProperties': { 'UniqueKey': True|False }, 'Type': 'INNER'|'OUTER'|'LEFT'|'RIGHT', 'OnClause': 'string' }, 'PhysicalTableId': 'string', 'DataSetArn': 'string' } } }, 'OutputColumns': [ { 'Name': 'string', 'Description': 'string', 'Type': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME', 'SubType': 'FLOAT'|'FIXED' }, ], 'ImportMode': 'SPICE'|'DIRECT_QUERY', 'ConsumedSpiceCapacityInBytes': 123, 'ColumnGroups': [ { 'GeoSpatialColumnGroup': { 'Name': 'string', 'CountryCode': 'US', 'Columns': [ 'string', ] } }, ], 'FieldFolders': { 'string': { 'description': 'string', 'columns': [ 'string', ] } }, 'RowLevelPermissionDataSet': { 'Namespace': 'string', 'Arn': 'string', 'PermissionPolicy': 'GRANT_ACCESS'|'DENY_ACCESS', 'FormatVersion': 'VERSION_1'|'VERSION_2', 'Status': 'ENABLED'|'DISABLED' }, 'RowLevelPermissionTagConfiguration': { 'Status': 'ENABLED'|'DISABLED', 'TagRules': [ { 'TagKey': 'string', 'ColumnName': 'string', 'TagMultiValueDelimiter': 'string', 'MatchAllValue': 'string' }, ], 'TagRuleConfigurations': [ [ 'string', ], ] }, 'ColumnLevelPermissionRules': [ { 'Principals': [ 'string', ], 'ColumnNames': [ 'string', ] }, ], 'DataSetUsageConfiguration': { 'DisableUseAsDirectQuerySource': True|False, 'DisableUseAsImportedSource': True|False }, 'DatasetParameters': [ { 'StringDatasetParameter': { 'Id': 'string', 'Name': 'string', 'ValueType': 'MULTI_VALUED'|'SINGLE_VALUED', 'DefaultValues': { 'StaticValues': [ 'string', ] } }, 'DecimalDatasetParameter': { 'Id': 'string', 'Name': 'string', 'ValueType': 'MULTI_VALUED'|'SINGLE_VALUED', 'DefaultValues': { 'StaticValues': [ 123.0, ] } }, 'IntegerDatasetParameter': { 'Id': 'string', 'Name': 'string', 'ValueType': 'MULTI_VALUED'|'SINGLE_VALUED', 'DefaultValues': { 'StaticValues': [ 123, ] } }, 'DateTimeDatasetParameter': { 'Id': 'string', 'Name': 'string', 'ValueType': 'MULTI_VALUED'|'SINGLE_VALUED', 'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND', 'DefaultValues': { 'StaticValues': [ datetime(2015, 1, 1), ] } } }, ], 'PerformanceConfiguration': { 'UniqueKeys': [ { 'ColumnNames': [ 'string', ] }, ] }, 'UseAs': 'RLS_RULES' }, 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **DataSet** *(dict) --* Information on the dataset. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the resource. * **DataSetId** *(string) --* The ID of the dataset. Limited to 96 characters. * **Name** *(string) --* A display name for the dataset. * **CreatedTime** *(datetime) --* The time that this dataset was created. * **LastUpdatedTime** *(datetime) --* The last time that this dataset was updated. * **PhysicalTableMap** *(dict) --* Declares the physical tables that are available in the underlying data sources. * *(string) --* * *(dict) --* A view of a data source that contains information about the shape of the data in the underlying source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non- null. * **RelationalTable** *(dict) --* A physical table type for relational data sources. * **DataSourceArn** *(string) --* The Amazon Resource Name (ARN) for the data source. * **Catalog** *(string) --* The catalog associated with a table. * **Schema** *(string) --* The schema name. This name applies to certain relational database engines. * **Name** *(string) --* The name of the relational table. * **InputColumns** *(list) --* The column schema of the table. * *(dict) --* Metadata for a column that is used as the input of a transform operation. * **Name** *(string) --* The name of this column in the underlying data source. * **Type** *(string) --* The data type of the column. * **SubType** *(string) --* The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset. * **CustomSql** *(dict) --* A physical table type built from the results of the custom SQL query. * **DataSourceArn** *(string) --* The Amazon Resource Name (ARN) of the data source. * **Name** *(string) --* A display name for the SQL query result. * **SqlQuery** *(string) --* The SQL query. * **Columns** *(list) --* The column schema from the SQL query result set. * *(dict) --* Metadata for a column that is used as the input of a transform operation. * **Name** *(string) --* The name of this column in the underlying data source. * **Type** *(string) --* The data type of the column. * **SubType** *(string) --* The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset. * **S3Source** *(dict) --* A physical table type for as S3 data source. * **DataSourceArn** *(string) --* The Amazon Resource Name (ARN) for the data source. * **UploadSettings** *(dict) --* Information about the format for the S3 source file or files. * **Format** *(string) --* File format. * **StartFromRow** *(integer) --* A row number to start reading data from. * **ContainsHeader** *(boolean) --* Whether the file has a header row, or the files each have a header row. * **TextQualifier** *(string) --* Text qualifier. * **Delimiter** *(string) --* The delimiter between values in the file. * **InputColumns** *(list) --* A physical table type for an S3 data source. Note: For files that aren't JSON, only "STRING" data types are supported in input columns. * *(dict) --* Metadata for a column that is used as the input of a transform operation. * **Name** *(string) --* The name of this column in the underlying data source. * **Type** *(string) --* The data type of the column. * **SubType** *(string) --* The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset. * **LogicalTableMap** *(dict) --* Configures the combination and transformation of the data from the physical tables. * *(string) --* An identifier for the logical table that is defined in the dataset * *(dict) --* A *logical table* is a unit that joins and that data transformations operate on. A logical table has a source, which can be either a physical table or result of a join. When a logical table points to a physical table, the logical table acts as a mutable copy of that physical table through transform operations. * **Alias** *(string) --* A display name for the logical table. * **DataTransforms** *(list) --* Transform operations that act on this logical table. For this structure to be valid, only one of the attributes can be non-null. * *(dict) --* A data transformation on a logical table. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null. * **ProjectOperation** *(dict) --* An operation that projects columns. Operations that come after a projection can only refer to projected columns. * **ProjectedColumns** *(list) --* Projected columns. * *(string) --* * **FilterOperation** *(dict) --* An operation that filters rows based on some condition. * **ConditionExpression** *(string) --* An expression that must evaluate to a Boolean value. Rows for which the expression evaluates to true are kept in the dataset. * **CreateColumnsOperation** *(dict) --* An operation that creates calculated columns. Columns created in one such operation form a lexical closure. * **Columns** *(list) --* Calculated columns to create. * *(dict) --* A calculated column for a dataset. * **ColumnName** *(string) --* Column name. * **ColumnId** *(string) --* A unique ID to identify a calculated column. During a dataset update, if the column ID of a calculated column matches that of an existing calculated column, Amazon QuickSight preserves the existing calculated column. * **Expression** *(string) --* An expression that defines the calculated column. * **RenameColumnOperation** *(dict) --* An operation that renames a column. * **ColumnName** *(string) --* The name of the column to be renamed. * **NewColumnName** *(string) --* The new name for the column. * **CastColumnTypeOperation** *(dict) --* A transform operation that casts a column to a different type. * **ColumnName** *(string) --* Column name. * **NewColumnType** *(string) --* New column data type. * **SubType** *(string) --* The sub data type of the new column. Sub types are only available for decimal columns that are part of a SPICE dataset. * **Format** *(string) --* When casting a column from string to datetime type, you can supply a string in a format supported by Amazon QuickSight to denote the source data format. * **TagColumnOperation** *(dict) --* An operation that tags a column with additional information. * **ColumnName** *(string) --* The column that this operation acts on. * **Tags** *(list) --* The dataset column tag, currently only used for geospatial type tagging. Note: This is not tags for the Amazon Web Services tagging feature. * *(dict) --* A tag for a column in a "TagColumnOperation" structure. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null. * **ColumnGeographicRole** *(string) --* A geospatial role for a column. * **ColumnDescription** *(dict) --* A description for a column. * **Text** *(string) --* The text of a description for a column. * **UntagColumnOperation** *(dict) --* A transform operation that removes tags associated with a column. * **ColumnName** *(string) --* The column that this operation acts on. * **TagNames** *(list) --* The column tags to remove from this column. * *(string) --* * **OverrideDatasetParameterOperation** *(dict) --* A transform operation that overrides the dataset parameter values that are defined in another dataset. * **ParameterName** *(string) --* The name of the parameter to be overridden with different values. * **NewParameterName** *(string) --* The new name for the parameter. * **NewDefaultValues** *(dict) --* The new default values for the parameter. * **StringStaticValues** *(list) --* A list of static default values for a given string parameter. * *(string) --* The default value for the string parameter. * **DecimalStaticValues** *(list) --* A list of static default values for a given decimal parameter. * *(float) --* The default value for the decimal parameter. * **DateTimeStaticValues** *(list) --* A list of static default values for a given date time parameter. * *(datetime) --* The default value for the date time parameter. * **IntegerStaticValues** *(list) --* A list of static default values for a given integer parameter. * *(integer) --* The default value for the integer parameter. * **Source** *(dict) --* Source of this logical table. * **JoinInstruction** *(dict) --* Specifies the result of a join of two logical tables. * **LeftOperand** *(string) --* The operand on the left side of a join. * **RightOperand** *(string) --* The operand on the right side of a join. * **LeftJoinKeyProperties** *(dict) --* Join key properties of the left operand. * **UniqueKey** *(boolean) --* A value that indicates that a row in a table is uniquely identified by the columns in a join key. This is used by Amazon QuickSight to optimize query performance. * **RightJoinKeyProperties** *(dict) --* Join key properties of the right operand. * **UniqueKey** *(boolean) --* A value that indicates that a row in a table is uniquely identified by the columns in a join key. This is used by Amazon QuickSight to optimize query performance. * **Type** *(string) --* The type of join that it is. * **OnClause** *(string) --* The join instructions provided in the "ON" clause of a join. * **PhysicalTableId** *(string) --* Physical table ID. * **DataSetArn** *(string) --* The Amazon Resource Number (ARN) of the parent dataset. * **OutputColumns** *(list) --* The list of columns after all transforms. These columns are available in templates, analyses, and dashboards. * *(dict) --* Output column. * **Name** *(string) --* The display name of the column.. * **Description** *(string) --* A description for a column. * **Type** *(string) --* The data type of the column. * **SubType** *(string) --* The sub data type of the column. * **ImportMode** *(string) --* A value that indicates whether you want to import the data into SPICE. * **ConsumedSpiceCapacityInBytes** *(integer) --* The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't imported into SPICE. * **ColumnGroups** *(list) --* Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported. * *(dict) --* Groupings of columns that work together in certain Amazon QuickSight features. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null. * **GeoSpatialColumnGroup** *(dict) --* Geospatial column group that denotes a hierarchy. * **Name** *(string) --* A display name for the hierarchy. * **CountryCode** *(string) --* Country code. * **Columns** *(list) --* Columns in this hierarchy. * *(string) --* * **FieldFolders** *(dict) --* The folder that contains fields and nested subfolders for your dataset. * *(string) --* * *(dict) --* A FieldFolder element is a folder that contains fields and nested subfolders. * **description** *(string) --* The description for a field folder. * **columns** *(list) --* A folder has a list of columns. A column can only be in one folder. * *(string) --* * **RowLevelPermissionDataSet** *(dict) --* The row-level security configuration for the dataset. * **Namespace** *(string) --* The namespace associated with the dataset that contains permissions for RLS. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS. * **PermissionPolicy** *(string) --* The type of permissions to use when interpreting the permissions for RLS. "DENY_ACCESS" is included for backward compatibility only. * **FormatVersion** *(string) --* The user or group rules associated with the dataset that contains permissions for RLS. By default, "FormatVersion" is "VERSION_1". When "FormatVersion" is "VERSION_1", "UserName" and "GroupName" are required. When "FormatVersion" is "VERSION_2", "UserARN" and "GroupARN" are required, and "Namespace" must not exist. * **Status** *(string) --* The status of the row-level security permission dataset. If enabled, the status is "ENABLED". If disabled, the status is "DISABLED". * **RowLevelPermissionTagConfiguration** *(dict) --* The element you can use to define tags for row-level security. * **Status** *(string) --* The status of row-level security tags. If enabled, the status is "ENABLED". If disabled, the status is "DISABLED". * **TagRules** *(list) --* A set of rules associated with row-level security, such as the tag names and columns that they are assigned to. * *(dict) --* A set of rules associated with a tag. * **TagKey** *(string) --* The unique key for a tag. * **ColumnName** *(string) --* The column name that a tag key is assigned to. * **TagMultiValueDelimiter** *(string) --* A string that you want to use to delimit the values when you pass the values at run time. For example, you can delimit the values with a comma. * **MatchAllValue** *(string) --* A string that you want to use to filter by all the values in a column in the dataset and don’t want to list the values one by one. For example, you can use an asterisk as your match all value. * **TagRuleConfigurations** *(list) --* A list of tag configuration rules to apply to a dataset. All tag configurations have the OR condition. Tags within each tile will be joined (AND). At least one rule in this structure must have all tag values assigned to it to apply Row-level security (RLS) to the dataset. * *(list) --* * *(string) --* * **ColumnLevelPermissionRules** *(list) --* A set of one or more definitions of a >>``<>``<<. * *(dict) --* A rule defined to grant access on one or more restricted columns. Each dataset can have multiple rules. To create a restricted column, you add it to one or more rules. Each rule must contain at least one column and at least one user or group. To be able to see a restricted column, a user or group needs to be added to a rule for that column. * **Principals** *(list) --* An array of Amazon Resource Names (ARNs) for Amazon QuickSight users or groups. * *(string) --* * **ColumnNames** *(list) --* An array of column names. * *(string) --* * **DataSetUsageConfiguration** *(dict) --* The usage configuration to apply to child datasets that reference this dataset as a source. * **DisableUseAsDirectQuerySource** *(boolean) --* An option that controls whether a child dataset of a direct query can use this dataset as a source. * **DisableUseAsImportedSource** *(boolean) --* An option that controls whether a child dataset that's stored in QuickSight can use this dataset as a source. * **DatasetParameters** *(list) --* The parameters that are declared in a dataset. * *(dict) --* A parameter that is created in a dataset. The parameter can be a string, integer, decimal, or datetime data type. * **StringDatasetParameter** *(dict) --* A string parameter that is created in the dataset. * **Id** *(string) --* An identifier for the string parameter that is created in the dataset. * **Name** *(string) --* The name of the string parameter that is created in the dataset. * **ValueType** *(string) --* The value type of the dataset parameter. Valid values are "single value" or "multi value". * **DefaultValues** *(dict) --* A list of default values for a given string dataset parameter type. This structure only accepts static values. * **StaticValues** *(list) --* A list of static default values for a given string parameter. * *(string) --* The default value for the string parameter. * **DecimalDatasetParameter** *(dict) --* A decimal parameter that is created in the dataset. * **Id** *(string) --* An identifier for the decimal parameter created in the dataset. * **Name** *(string) --* The name of the decimal parameter that is created in the dataset. * **ValueType** *(string) --* The value type of the dataset parameter. Valid values are "single value" or "multi value". * **DefaultValues** *(dict) --* A list of default values for a given decimal parameter. This structure only accepts static values. * **StaticValues** *(list) --* A list of static default values for a given decimal parameter. * *(float) --* The default value for the decimal parameter. * **IntegerDatasetParameter** *(dict) --* An integer parameter that is created in the dataset. * **Id** *(string) --* An identifier for the integer parameter created in the dataset. * **Name** *(string) --* The name of the integer parameter that is created in the dataset. * **ValueType** *(string) --* The value type of the dataset parameter. Valid values are "single value" or "multi value". * **DefaultValues** *(dict) --* A list of default values for a given integer parameter. This structure only accepts static values. * **StaticValues** *(list) --* A list of static default values for a given integer parameter. * *(integer) --* The default value for the integer parameter. * **DateTimeDatasetParameter** *(dict) --* A date time parameter that is created in the dataset. * **Id** *(string) --* An identifier for the parameter that is created in the dataset. * **Name** *(string) --* The name of the date time parameter that is created in the dataset. * **ValueType** *(string) --* The value type of the dataset parameter. Valid values are "single value" or "multi value". * **TimeGranularity** *(string) --* The time granularity of the date time parameter. * **DefaultValues** *(dict) --* A list of default values for a given date time parameter. This structure only accepts static values. * **StaticValues** *(list) --* A list of static default values for a given date time parameter. * *(datetime) --* The default value for the date time parameter. * **PerformanceConfiguration** *(dict) --* The performance optimization configuration of a dataset. * **UniqueKeys** *(list) --* A "UniqueKey" configuration. * *(dict) --* A "UniqueKey" configuration that references a dataset column. * **ColumnNames** *(list) --* The name of the column that is referenced in the "UniqueKey" configuration. * *(string) --* * **UseAs** *(string) --* The usage of the dataset. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / delete_refresh_schedule delete_refresh_schedule *********************** QuickSight.Client.delete_refresh_schedule(**kwargs) Deletes a refresh schedule from a dataset. See also: AWS API Documentation **Request Syntax** response = client.delete_refresh_schedule( DataSetId='string', AwsAccountId='string', ScheduleId='string' ) Parameters: * **DataSetId** (*string*) -- **[REQUIRED]** The ID of the dataset. * **AwsAccountId** (*string*) -- **[REQUIRED]** The Amazon Web Services account ID. * **ScheduleId** (*string*) -- **[REQUIRED]** The ID of the refresh schedule. Return type: dict Returns: **Response Syntax** { 'Status': 123, 'RequestId': 'string', 'ScheduleId': 'string', 'Arn': 'string' } **Response Structure** * *(dict) --* * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **ScheduleId** *(string) --* The ID of the refresh schedule. * **Arn** *(string) --* The Amazon Resource Name (ARN) for the refresh schedule. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.LimitExceededException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / update_folder update_folder ************* QuickSight.Client.update_folder(**kwargs) Updates the name of a folder. See also: AWS API Documentation **Request Syntax** response = client.update_folder( AwsAccountId='string', FolderId='string', Name='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID for the Amazon Web Services account that contains the folder to update. * **FolderId** (*string*) -- **[REQUIRED]** The ID of the folder. * **Name** (*string*) -- **[REQUIRED]** The name of the folder. Return type: dict Returns: **Response Syntax** { 'Status': 123, 'Arn': 'string', 'FolderId': 'string', 'RequestId': 'string' } **Response Structure** * *(dict) --* * **Status** *(integer) --* The HTTP status of the request. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the folder. * **FolderId** *(string) --* The ID of the folder. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.ResourceExistsException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / create_account_subscription create_account_subscription *************************** QuickSight.Client.create_account_subscription(**kwargs) Creates an Amazon QuickSight account, or subscribes to Amazon QuickSight Q. The Amazon Web Services Region for the account is derived from what is configured in the CLI or SDK. Before you use this operation, make sure that you can connect to an existing Amazon Web Services account. If you don't have an Amazon Web Services account, see Sign up for Amazon Web Services in the *Amazon QuickSight User Guide*. The person who signs up for Amazon QuickSight needs to have the correct Identity and Access Management (IAM) permissions. For more information, see IAM Policy Examples for Amazon QuickSight in the *Amazon QuickSight User Guide*. If your IAM policy includes both the "Subscribe" and "CreateAccountSubscription" actions, make sure that both actions are set to "Allow". If either action is set to "Deny", the "Deny" action prevails and your API call fails. You can't pass an existing IAM role to access other Amazon Web Services services using this API operation. To pass your existing IAM role to Amazon QuickSight, see Passing IAM roles to Amazon QuickSight in the *Amazon QuickSight User Guide*. You can't set default resource access on the new account from the Amazon QuickSight API. Instead, add default resource access from the Amazon QuickSight console. For more information about setting default resource access to Amazon Web Services services, see Setting default resource access to Amazon Web Services services in the *Amazon QuickSight User Guide*. See also: AWS API Documentation **Request Syntax** response = client.create_account_subscription( Edition='STANDARD'|'ENTERPRISE'|'ENTERPRISE_AND_Q', AuthenticationMethod='IAM_AND_QUICKSIGHT'|'IAM_ONLY'|'ACTIVE_DIRECTORY'|'IAM_IDENTITY_CENTER', AwsAccountId='string', AccountName='string', NotificationEmail='string', ActiveDirectoryName='string', Realm='string', DirectoryId='string', AdminGroup=[ 'string', ], AuthorGroup=[ 'string', ], ReaderGroup=[ 'string', ], AdminProGroup=[ 'string', ], AuthorProGroup=[ 'string', ], ReaderProGroup=[ 'string', ], FirstName='string', LastName='string', EmailAddress='string', ContactNumber='string', IAMIdentityCenterInstanceArn='string' ) Parameters: * **Edition** (*string*) -- The edition of Amazon QuickSight that you want your account to have. Currently, you can choose from "ENTERPRISE" or "ENTERPRISE_AND_Q". If you choose "ENTERPRISE_AND_Q", the following parameters are required: * "FirstName" * "LastName" * "EmailAddress" * "ContactNumber" * **AuthenticationMethod** (*string*) -- **[REQUIRED]** The method that you want to use to authenticate your Amazon QuickSight account. If you choose "ACTIVE_DIRECTORY", provide an "ActiveDirectoryName" and an "AdminGroup" associated with your Active Directory. If you choose "IAM_IDENTITY_CENTER", provide an "AdminGroup" associated with your IAM Identity Center account. * **AwsAccountId** (*string*) -- **[REQUIRED]** The Amazon Web Services account ID of the account that you're using to create your Amazon QuickSight account. * **AccountName** (*string*) -- **[REQUIRED]** The name of your Amazon QuickSight account. This name is unique over all of Amazon Web Services, and it appears only when users sign in. You can't change "AccountName" value after the Amazon QuickSight account is created. * **NotificationEmail** (*string*) -- **[REQUIRED]** The email address that you want Amazon QuickSight to send notifications to regarding your Amazon QuickSight account or Amazon QuickSight subscription. * **ActiveDirectoryName** (*string*) -- The name of your Active Directory. This field is required if "ACTIVE_DIRECTORY" is the selected authentication method of the new Amazon QuickSight account. * **Realm** (*string*) -- The realm of the Active Directory that is associated with your Amazon QuickSight account. This field is required if "ACTIVE_DIRECTORY" is the selected authentication method of the new Amazon QuickSight account. * **DirectoryId** (*string*) -- The ID of the Active Directory that is associated with your Amazon QuickSight account. * **AdminGroup** (*list*) -- The admin group associated with your Active Directory or IAM Identity Center account. Either this field or the "AdminProGroup" field is required if "ACTIVE_DIRECTORY" or "IAM_IDENTITY_CENTER" is the selected authentication method of the new Amazon QuickSight account. For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. * *(string) --* * **AuthorGroup** (*list*) -- The author group associated with your Active Directory or IAM Identity Center account. For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. * *(string) --* * **ReaderGroup** (*list*) -- The reader group associated with your Active Directory or IAM Identity Center account. For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. * *(string) --* * **AdminProGroup** (*list*) -- The admin pro group associated with your Active Directory or IAM Identity Center account. Either this field or the "AdminGroup" field is required if "ACTIVE_DIRECTORY" or "IAM_IDENTITY_CENTER" is the selected authentication method of the new Amazon QuickSight account. For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. * *(string) --* * **AuthorProGroup** (*list*) -- The author pro group associated with your Active Directory or IAM Identity Center account. For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. * *(string) --* * **ReaderProGroup** (*list*) -- The reader pro group associated with your Active Directory or IAM Identity Center account. For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. * *(string) --* * **FirstName** (*string*) -- The first name of the author of the Amazon QuickSight account to use for future communications. This field is required if "ENTERPPRISE_AND_Q" is the selected edition of the new Amazon QuickSight account. * **LastName** (*string*) -- The last name of the author of the Amazon QuickSight account to use for future communications. This field is required if "ENTERPPRISE_AND_Q" is the selected edition of the new Amazon QuickSight account. * **EmailAddress** (*string*) -- The email address of the author of the Amazon QuickSight account to use for future communications. This field is required if "ENTERPPRISE_AND_Q" is the selected edition of the new Amazon QuickSight account. * **ContactNumber** (*string*) -- A 10-digit phone number for the author of the Amazon QuickSight account to use for future communications. This field is required if "ENTERPPRISE_AND_Q" is the selected edition of the new Amazon QuickSight account. * **IAMIdentityCenterInstanceArn** (*string*) -- The Amazon Resource Name (ARN) for the IAM Identity Center instance. Return type: dict Returns: **Response Syntax** { 'SignupResponse': { 'IAMUser': True|False, 'userLoginName': 'string', 'accountName': 'string', 'directoryType': 'string' }, 'Status': 123, 'RequestId': 'string' } **Response Structure** * *(dict) --* * **SignupResponse** *(dict) --* A "SignupResponse" object that returns information about a newly created Amazon QuickSight account. * **IAMUser** *(boolean) --* A Boolean that is "TRUE" if the Amazon QuickSight uses IAM as an authentication method. * **userLoginName** *(string) --* The user login name for your Amazon QuickSight account. * **accountName** *(string) --* The name of your Amazon QuickSight account. * **directoryType** *(string) --* The type of Active Directory that is being used to authenticate the Amazon QuickSight account. Valid values are "SIMPLE_AD", "AD_CONNECTOR", and "MICROSOFT_AD". * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.ResourceExistsException" * "QuickSight.Client.exceptions.PreconditionNotMetException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.InternalFailureException" * "QuickSight.Client.exceptions.ResourceUnavailableException" QuickSight / Client / list_theme_aliases list_theme_aliases ****************** QuickSight.Client.list_theme_aliases(**kwargs) Lists all the aliases of a theme. See also: AWS API Documentation **Request Syntax** response = client.list_theme_aliases( AwsAccountId='string', ThemeId='string', NextToken='string', MaxResults=123 ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the theme aliases that you're listing. * **ThemeId** (*string*) -- **[REQUIRED]** The ID for the theme. * **NextToken** (*string*) -- The token for the next set of results, or null if there are no more results. * **MaxResults** (*integer*) -- The maximum number of results to be returned per request. Return type: dict Returns: **Response Syntax** { 'ThemeAliasList': [ { 'Arn': 'string', 'AliasName': 'string', 'ThemeVersionNumber': 123 }, ], 'Status': 123, 'RequestId': 'string', 'NextToken': 'string' } **Response Structure** * *(dict) --* * **ThemeAliasList** *(list) --* A structure containing the list of the theme's aliases. * *(dict) --* An alias for a theme. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the theme alias. * **AliasName** *(string) --* The display name of the theme alias. * **ThemeVersionNumber** *(integer) --* The version number of the theme alias. * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **NextToken** *(string) --* The token for the next set of results, or null if there are no more results. **Exceptions** * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.InvalidNextTokenException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / delete_user_custom_permission delete_user_custom_permission ***************************** QuickSight.Client.delete_user_custom_permission(**kwargs) Deletes a custom permissions profile from a user. See also: AWS API Documentation **Request Syntax** response = client.delete_user_custom_permission( UserName='string', AwsAccountId='string', Namespace='string' ) Parameters: * **UserName** (*string*) -- **[REQUIRED]** The username of the user that you want to remove custom permissions from. * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the custom permission configuration that you want to delete. * **Namespace** (*string*) -- **[REQUIRED]** The namespace that the user belongs to. Return type: dict Returns: **Response Syntax** { 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.PreconditionNotMetException" * "QuickSight.Client.exceptions.InternalFailureException" * "QuickSight.Client.exceptions.ResourceUnavailableException" QuickSight / Client / update_spice_capacity_configuration update_spice_capacity_configuration *********************************** QuickSight.Client.update_spice_capacity_configuration(**kwargs) Updates the SPICE capacity configuration for a Amazon QuickSight account. See also: AWS API Documentation **Request Syntax** response = client.update_spice_capacity_configuration( AwsAccountId='string', PurchaseMode='MANUAL'|'AUTO_PURCHASE' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the SPICE configuration that you want to update. * **PurchaseMode** (*string*) -- **[REQUIRED]** Determines how SPICE capacity can be purchased. The following options are available. * "MANUAL": SPICE capacity can only be purchased manually. * "AUTO_PURCHASE": Extra SPICE capacity is automatically purchased on your behalf as needed. SPICE capacity can also be purchased manually with this option. Return type: dict Returns: **Response Syntax** { 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / create_topic_refresh_schedule create_topic_refresh_schedule ***************************** QuickSight.Client.create_topic_refresh_schedule(**kwargs) Creates a topic refresh schedule. See also: AWS API Documentation **Request Syntax** response = client.create_topic_refresh_schedule( AwsAccountId='string', TopicId='string', DatasetArn='string', DatasetName='string', RefreshSchedule={ 'IsEnabled': True|False, 'BasedOnSpiceSchedule': True|False, 'StartingAt': datetime(2015, 1, 1), 'Timezone': 'string', 'RepeatAt': 'string', 'TopicScheduleType': 'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY' } ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the topic you're creating a refresh schedule for. * **TopicId** (*string*) -- **[REQUIRED]** The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. * **DatasetArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the dataset. * **DatasetName** (*string*) -- The name of the dataset. * **RefreshSchedule** (*dict*) -- **[REQUIRED]** The definition of a refresh schedule. * **IsEnabled** *(boolean) --* **[REQUIRED]** A Boolean value that controls whether to schedule is enabled. * **BasedOnSpiceSchedule** *(boolean) --* **[REQUIRED]** A Boolean value that controls whether to schedule runs at the same schedule that is specified in SPICE dataset. * **StartingAt** *(datetime) --* The starting date and time for the refresh schedule. * **Timezone** *(string) --* The timezone that you want the refresh schedule to use. * **RepeatAt** *(string) --* The time of day when the refresh should run, for example, Monday-Sunday. * **TopicScheduleType** *(string) --* The type of refresh schedule. Valid values for this structure are "HOURLY", "DAILY", "WEEKLY", and "MONTHLY". Return type: dict Returns: **Response Syntax** { 'TopicId': 'string', 'TopicArn': 'string', 'DatasetArn': 'string', 'Status': 123, 'RequestId': 'string' } **Response Structure** * *(dict) --* * **TopicId** *(string) --* The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. * **TopicArn** *(string) --* The Amazon Resource Name (ARN) of the topic. * **DatasetArn** *(string) --* The Amazon Resource Name (ARN) of the dataset. * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.LimitExceededException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ResourceExistsException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / list_folders_for_resource list_folders_for_resource ************************* QuickSight.Client.list_folders_for_resource(**kwargs) List all folders that a resource is a member of. See also: AWS API Documentation **Request Syntax** response = client.list_folders_for_resource( AwsAccountId='string', ResourceArn='string', NextToken='string', MaxResults=123 ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID for the Amazon Web Services account that contains the resource. * **ResourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) the resource whose folders you need to list. * **NextToken** (*string*) -- The token for the next set of results, or null if there are no more results. * **MaxResults** (*integer*) -- The maximum number of results to be returned per request. Return type: dict Returns: **Response Syntax** { 'Status': 123, 'Folders': [ 'string', ], 'NextToken': 'string', 'RequestId': 'string' } **Response Structure** * *(dict) --* * **Status** *(integer) --* The HTTP status of the request. * **Folders** *(list) --* A list that contains the Amazon Resource Names (ARNs) of all folders that the resource is a member of. * *(string) --* * **NextToken** *(string) --* The token for the next set of results, or null if there are no more results. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InvalidNextTokenException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / list_templates list_templates ************** QuickSight.Client.list_templates(**kwargs) Lists all the templates in the current Amazon QuickSight account. See also: AWS API Documentation **Request Syntax** response = client.list_templates( AwsAccountId='string', NextToken='string', MaxResults=123 ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the templates that you're listing. * **NextToken** (*string*) -- The token for the next set of results, or null if there are no more results. * **MaxResults** (*integer*) -- The maximum number of results to be returned per request. Return type: dict Returns: **Response Syntax** { 'TemplateSummaryList': [ { 'Arn': 'string', 'TemplateId': 'string', 'Name': 'string', 'LatestVersionNumber': 123, 'CreatedTime': datetime(2015, 1, 1), 'LastUpdatedTime': datetime(2015, 1, 1) }, ], 'NextToken': 'string', 'Status': 123, 'RequestId': 'string' } **Response Structure** * *(dict) --* * **TemplateSummaryList** *(list) --* A structure containing information about the templates in the list. * *(dict) --* The template summary. * **Arn** *(string) --* A summary of a template. * **TemplateId** *(string) --* The ID of the template. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. * **Name** *(string) --* A display name for the template. * **LatestVersionNumber** *(integer) --* A structure containing a list of version numbers for the template summary. * **CreatedTime** *(datetime) --* The last time that this template was created. * **LastUpdatedTime** *(datetime) --* The last time that this template was updated. * **NextToken** *(string) --* The token for the next set of results, or null if there are no more results. * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.InvalidNextTokenException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / list_vpc_connections list_vpc_connections ******************** QuickSight.Client.list_vpc_connections(**kwargs) Lists all of the VPC connections in the current set Amazon Web Services Region of an Amazon Web Services account. See also: AWS API Documentation **Request Syntax** response = client.list_vpc_connections( AwsAccountId='string', NextToken='string', MaxResults=123 ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The Amazon Web Services account ID of the account that contains the VPC connections that you want to list. * **NextToken** (*string*) -- The token for the next set of results, or null if there are no more results. * **MaxResults** (*integer*) -- The maximum number of results to be returned per request. Return type: dict Returns: **Response Syntax** { 'VPCConnectionSummaries': [ { 'VPCConnectionId': 'string', 'Arn': 'string', 'Name': 'string', 'VPCId': 'string', 'SecurityGroupIds': [ 'string', ], 'DnsResolvers': [ 'string', ], 'Status': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETION_IN_PROGRESS'|'DELETION_FAILED'|'DELETED', 'AvailabilityStatus': 'AVAILABLE'|'UNAVAILABLE'|'PARTIALLY_AVAILABLE', 'NetworkInterfaces': [ { 'SubnetId': 'string', 'AvailabilityZone': 'string', 'ErrorMessage': 'string', 'Status': 'CREATING'|'AVAILABLE'|'CREATION_FAILED'|'UPDATING'|'UPDATE_FAILED'|'DELETING'|'DELETED'|'DELETION_FAILED'|'DELETION_SCHEDULED'|'ATTACHMENT_FAILED_ROLLBACK_FAILED', 'NetworkInterfaceId': 'string' }, ], 'RoleArn': 'string', 'CreatedTime': datetime(2015, 1, 1), 'LastUpdatedTime': datetime(2015, 1, 1) }, ], 'NextToken': 'string', 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **VPCConnectionSummaries** *(list) --* A "VPCConnectionSummaries" object that returns a summary of VPC connection objects. * *(dict) --* The summary metadata that describes a VPC connection. * **VPCConnectionId** *(string) --* The ID of the VPC connection that you're creating. This ID is a unique identifier for each Amazon Web Services Region in an Amazon Web Services account. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the VPC connection. * **Name** *(string) --* The display name for the VPC connection. * **VPCId** *(string) --* The Amazon EC2 VPC ID associated with the VPC connection. * **SecurityGroupIds** *(list) --* The Amazon EC2 security group IDs associated with the VPC connection. * *(string) --* * **DnsResolvers** *(list) --* A list of IP addresses of DNS resolver endpoints for the VPC connection. * *(string) --* * **Status** *(string) --* The status of the VPC connection. * **AvailabilityStatus** *(string) --* The availability status of the VPC connection. * **NetworkInterfaces** *(list) --* A list of network interfaces. * *(dict) --* The structure that contains information about a network interface. * **SubnetId** *(string) --* The subnet ID associated with the network interface. * **AvailabilityZone** *(string) --* The availability zone that the network interface resides in. * **ErrorMessage** *(string) --* An error message. * **Status** *(string) --* The status of the network interface. * **NetworkInterfaceId** *(string) --* The network interface ID. * **RoleArn** *(string) --* The ARN of the IAM role associated with the VPC connection. * **CreatedTime** *(datetime) --* The time that the VPC connection was created. * **LastUpdatedTime** *(datetime) --* The time that the VPC connection was last updated. * **NextToken** *(string) --* The token for the next set of results, or null if there are no more results. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InvalidNextTokenException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / update_identity_propagation_config update_identity_propagation_config ********************************** QuickSight.Client.update_identity_propagation_config(**kwargs) Adds or updates services and authorized targets to configure what the Amazon QuickSight IAM Identity Center application can access. This operation is only supported for Amazon QuickSight accounts using IAM Identity Center See also: AWS API Documentation **Request Syntax** response = client.update_identity_propagation_config( AwsAccountId='string', Service='REDSHIFT'|'QBUSINESS'|'ATHENA', AuthorizedTargets=[ 'string', ] ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the identity propagation configuration that you want to update. * **Service** (*string*) -- **[REQUIRED]** The name of the Amazon Web Services service that contains the authorized targets that you want to add or update. * **AuthorizedTargets** (*list*) -- Specifies a list of application ARNs that represent the authorized targets for a service. * *(string) --* Return type: dict Returns: **Response Syntax** { 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / create_ingestion create_ingestion **************** QuickSight.Client.create_ingestion(**kwargs) Creates and starts a new SPICE ingestion for a dataset. You can manually refresh datasets in an Enterprise edition account 32 times in a 24-hour period. You can manually refresh datasets in a Standard edition account 8 times in a 24-hour period. Each 24-hour period is measured starting 24 hours before the current date and time. Any ingestions operating on tagged datasets inherit the same tags automatically for use in access control. For an example, see How do I create an IAM policy to control access to Amazon EC2 resources using tags? in the Amazon Web Services Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource. See also: AWS API Documentation **Request Syntax** response = client.create_ingestion( DataSetId='string', IngestionId='string', AwsAccountId='string', IngestionType='INCREMENTAL_REFRESH'|'FULL_REFRESH' ) Parameters: * **DataSetId** (*string*) -- **[REQUIRED]** The ID of the dataset used in the ingestion. * **IngestionId** (*string*) -- **[REQUIRED]** An ID for the ingestion. * **AwsAccountId** (*string*) -- **[REQUIRED]** The Amazon Web Services account ID. * **IngestionType** (*string*) -- The type of ingestion that you want to create. Return type: dict Returns: **Response Syntax** { 'Arn': 'string', 'IngestionId': 'string', 'IngestionStatus': 'INITIALIZED'|'QUEUED'|'RUNNING'|'FAILED'|'COMPLETED'|'CANCELLED', 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **Arn** *(string) --* The Amazon Resource Name (ARN) for the data ingestion. * **IngestionId** *(string) --* An ID for the ingestion. * **IngestionStatus** *(string) --* The ingestion status. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.LimitExceededException" * "QuickSight.Client.exceptions.ResourceExistsException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / delete_vpc_connection delete_vpc_connection ********************* QuickSight.Client.delete_vpc_connection(**kwargs) Deletes a VPC connection. See also: AWS API Documentation **Request Syntax** response = client.delete_vpc_connection( AwsAccountId='string', VPCConnectionId='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The Amazon Web Services account ID of the account where you want to delete a VPC connection. * **VPCConnectionId** (*string*) -- **[REQUIRED]** The ID of the VPC connection that you're creating. This ID is a unique identifier for each Amazon Web Services Region in an Amazon Web Services account. Return type: dict Returns: **Response Syntax** { 'Arn': 'string', 'VPCConnectionId': 'string', 'DeletionStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETION_IN_PROGRESS'|'DELETION_FAILED'|'DELETED', 'AvailabilityStatus': 'AVAILABLE'|'UNAVAILABLE'|'PARTIALLY_AVAILABLE', 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **Arn** *(string) --* The Amazon Resource Name (ARN) of the deleted VPC connection. * **VPCConnectionId** *(string) --* The ID of the VPC connection that you're creating. This ID is a unique identifier for each Amazon Web Services Region in an Amazon Web Services account. * **DeletionStatus** *(string) --* The deletion status of the VPC connection. * **AvailabilityStatus** *(string) --* The availability status of the VPC connection. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / create_dashboard create_dashboard **************** QuickSight.Client.create_dashboard(**kwargs) Creates a dashboard from either a template or directly with a "DashboardDefinition". To first create a template, see the "CreateTemplate" API operation. A dashboard is an entity in Amazon QuickSight that identifies Amazon QuickSight reports, created from analyses. You can share Amazon QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different Amazon Web Services account. See also: AWS API Documentation **Request Syntax** # This section is too large to render. # Please see the AWS API Documentation linked below. AWS API Documentation **Parameters** # This section is too large to render. # Please see the AWS API Documentation linked below. AWS API Documentation Return type: dict Returns: **Response Syntax** { 'Arn': 'string', 'VersionArn': 'string', 'DashboardId': 'string', 'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED', 'Status': 123, 'RequestId': 'string' } **Response Structure** * *(dict) --* * **Arn** *(string) --* The ARN of the dashboard. * **VersionArn** *(string) --* The ARN of the dashboard, including the version number of the first version that is created. * **DashboardId** *(string) --* The ID for the dashboard. * **CreationStatus** *(string) --* The status of the dashboard creation request. * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.ResourceExistsException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.LimitExceededException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / start_dashboard_snapshot_job_schedule start_dashboard_snapshot_job_schedule ************************************* QuickSight.Client.start_dashboard_snapshot_job_schedule(**kwargs) Starts an asynchronous job that runs an existing dashboard schedule and sends the dashboard snapshot through email. Only one job can run simultaneously in a given schedule. Repeated requests are skipped with a "202" HTTP status code. For more information, see Scheduling and sending Amazon QuickSight reports by email and Configuring email report settings for a Amazon QuickSight dashboard in the *Amazon QuickSight User Guide*. See also: AWS API Documentation **Request Syntax** response = client.start_dashboard_snapshot_job_schedule( AwsAccountId='string', DashboardId='string', ScheduleId='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that the dashboard snapshot job is executed in. * **DashboardId** (*string*) -- **[REQUIRED]** The ID of the dashboard that you want to start a snapshot job schedule for. * **ScheduleId** (*string*) -- **[REQUIRED]** The ID of the schedule that you want to start a snapshot job schedule for. The schedule ID can be found in the Amazon QuickSight console in the **Schedules** pane of the dashboard that the schedule is configured for. Return type: dict Returns: **Response Syntax** { 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.LimitExceededException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / delete_group_membership delete_group_membership *********************** QuickSight.Client.delete_group_membership(**kwargs) Removes a user from a group so that the user is no longer a member of the group. See also: AWS API Documentation **Request Syntax** response = client.delete_group_membership( MemberName='string', GroupName='string', AwsAccountId='string', Namespace='string' ) Parameters: * **MemberName** (*string*) -- **[REQUIRED]** The name of the user that you want to delete from the group membership. * **GroupName** (*string*) -- **[REQUIRED]** The name of the group that you want to delete the user from. * **AwsAccountId** (*string*) -- **[REQUIRED]** 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** (*string*) -- **[REQUIRED]** The namespace of the group that you want to remove a user from. Return type: dict Returns: **Response Syntax** { 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.PreconditionNotMetException" * "QuickSight.Client.exceptions.InternalFailureException" * "QuickSight.Client.exceptions.ResourceUnavailableException" QuickSight / Client / update_theme_alias update_theme_alias ****************** QuickSight.Client.update_theme_alias(**kwargs) Updates an alias of a theme. See also: AWS API Documentation **Request Syntax** response = client.update_theme_alias( AwsAccountId='string', ThemeId='string', AliasName='string', ThemeVersionNumber=123 ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that contains the theme alias that you're updating. * **ThemeId** (*string*) -- **[REQUIRED]** The ID for the theme. * **AliasName** (*string*) -- **[REQUIRED]** The name of the theme alias that you want to update. * **ThemeVersionNumber** (*integer*) -- **[REQUIRED]** The version number of the theme that the alias should reference. Return type: dict Returns: **Response Syntax** { 'ThemeAlias': { 'Arn': 'string', 'AliasName': 'string', 'ThemeVersionNumber': 123 }, 'Status': 123, 'RequestId': 'string' } **Response Structure** * *(dict) --* * **ThemeAlias** *(dict) --* Information about the theme alias. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the theme alias. * **AliasName** *(string) --* The display name of the theme alias. * **ThemeVersionNumber** *(integer) --* The version number of the theme alias. * **Status** *(integer) --* The HTTP status of the request. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. **Exceptions** * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceExistsException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / create_vpc_connection create_vpc_connection ********************* QuickSight.Client.create_vpc_connection(**kwargs) Creates a new VPC connection. See also: AWS API Documentation **Request Syntax** response = client.create_vpc_connection( AwsAccountId='string', VPCConnectionId='string', Name='string', SubnetIds=[ 'string', ], SecurityGroupIds=[ 'string', ], DnsResolvers=[ 'string', ], RoleArn='string', Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The Amazon Web Services account ID of the account where you want to create a new VPC connection. * **VPCConnectionId** (*string*) -- **[REQUIRED]** The ID of the VPC connection that you're creating. This ID is a unique identifier for each Amazon Web Services Region in an Amazon Web Services account. * **Name** (*string*) -- **[REQUIRED]** The display name for the VPC connection. * **SubnetIds** (*list*) -- **[REQUIRED]** A list of subnet IDs for the VPC connection. * *(string) --* * **SecurityGroupIds** (*list*) -- **[REQUIRED]** A list of security group IDs for the VPC connection. * *(string) --* * **DnsResolvers** (*list*) -- A list of IP addresses of DNS resolver endpoints for the VPC connection. * *(string) --* * **RoleArn** (*string*) -- **[REQUIRED]** The IAM role to associate with the VPC connection. * **Tags** (*list*) -- A map of the key-value pairs for the resource tag or tags assigned to the VPC connection. * *(dict) --* The key or keys of the key-value pairs for the resource tag or tags assigned to the resource. * **Key** *(string) --* **[REQUIRED]** Tag key. * **Value** *(string) --* **[REQUIRED]** Tag value. Return type: dict Returns: **Response Syntax** { 'Arn': 'string', 'VPCConnectionId': 'string', 'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETION_IN_PROGRESS'|'DELETION_FAILED'|'DELETED', 'AvailabilityStatus': 'AVAILABLE'|'UNAVAILABLE'|'PARTIALLY_AVAILABLE', 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **Arn** *(string) --* The Amazon Resource Name (ARN) of the VPC connection. * **VPCConnectionId** *(string) --* The ID for the VPC connection that you're creating. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. * **CreationStatus** *(string) --* The status of the creation of the VPC connection. * **AvailabilityStatus** *(string) --* The availability status of the VPC connection. * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.LimitExceededException" * "QuickSight.Client.exceptions.ResourceExistsException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.UnsupportedUserEditionException" * "QuickSight.Client.exceptions.InternalFailureException" QuickSight / Client / delete_role_membership delete_role_membership ********************** QuickSight.Client.delete_role_membership(**kwargs) Removes a group from a role. See also: AWS API Documentation **Request Syntax** response = client.delete_role_membership( MemberName='string', Role='ADMIN'|'AUTHOR'|'READER'|'ADMIN_PRO'|'AUTHOR_PRO'|'READER_PRO', AwsAccountId='string', Namespace='string' ) Parameters: * **MemberName** (*string*) -- **[REQUIRED]** The name of the group. * **Role** (*string*) -- **[REQUIRED]** The role that you want to remove permissions from. * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account. * **Namespace** (*string*) -- **[REQUIRED]** The namespace that contains the role. Return type: dict Returns: **Response Syntax** { 'RequestId': 'string', 'Status': 123 } **Response Structure** * *(dict) --* * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **Status** *(integer) --* The HTTP status of the request. **Exceptions** * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InvalidParameterValueException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.PreconditionNotMetException" * "QuickSight.Client.exceptions.InternalFailureException" * "QuickSight.Client.exceptions.ResourceUnavailableException" QuickSight / Client / update_brand_published_version update_brand_published_version ****************************** QuickSight.Client.update_brand_published_version(**kwargs) Updates the published version of a brand. See also: AWS API Documentation **Request Syntax** response = client.update_brand_published_version( AwsAccountId='string', BrandId='string', VersionId='string' ) Parameters: * **AwsAccountId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services account that owns the brand. * **BrandId** (*string*) -- **[REQUIRED]** The ID of the Amazon QuickSight brand. * **VersionId** (*string*) -- **[REQUIRED]** The ID of the published version. Return type: dict Returns: **Response Syntax** { 'RequestId': 'string', 'VersionId': 'string' } **Response Structure** * *(dict) --* * **RequestId** *(string) --* The Amazon Web Services request ID for this operation. * **VersionId** *(string) --* The ID of the published version. **Exceptions** * "QuickSight.Client.exceptions.ThrottlingException" * "QuickSight.Client.exceptions.InvalidRequestException" * "QuickSight.Client.exceptions.ResourceNotFoundException" * "QuickSight.Client.exceptions.ConflictException" * "QuickSight.Client.exceptions.AccessDeniedException" * "QuickSight.Client.exceptions.InternalServerException"