Table of Contents
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:
can_paginate()cancel_ingestion()close()create_account_customization()create_account_subscription()create_analysis()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_template()create_template_alias()create_theme()create_theme_alias()delete_account_customization()delete_account_subscription()delete_analysis()delete_dashboard()delete_data_set()delete_data_source()delete_folder()delete_folder_membership()delete_group()delete_group_membership()delete_iam_policy_assignment()delete_namespace()delete_template()delete_template_alias()delete_theme()delete_theme_alias()delete_user()delete_user_by_principal_id()describe_account_customization()describe_account_settings()describe_account_subscription()describe_analysis()describe_analysis_definition()describe_analysis_permissions()describe_dashboard()describe_dashboard_definition()describe_dashboard_permissions()describe_data_set()describe_data_set_permissions()describe_data_source()describe_data_source_permissions()describe_folder()describe_folder_permissions()describe_folder_resolved_permissions()describe_group()describe_group_membership()describe_iam_policy_assignment()describe_ingestion()describe_ip_restriction()describe_namespace()describe_template()describe_template_alias()describe_template_definition()describe_template_permissions()describe_theme()describe_theme_alias()describe_theme_permissions()describe_user()generate_embed_url_for_anonymous_user()generate_embed_url_for_registered_user()get_dashboard_embed_url()get_paginator()get_session_embed_url()get_waiter()list_analyses()list_dashboard_versions()list_dashboards()list_data_sets()list_data_sources()list_folder_members()list_folders()list_group_memberships()list_groups()list_iam_policy_assignments()list_iam_policy_assignments_for_user()list_ingestions()list_namespaces()list_tags_for_resource()list_template_aliases()list_template_versions()list_templates()list_theme_aliases()list_theme_versions()list_themes()list_user_groups()list_users()register_user()restore_analysis()search_analyses()search_dashboards()search_data_sets()search_data_sources()search_folders()search_groups()tag_resource()untag_resource()update_account_customization()update_account_settings()update_analysis()update_analysis_permissions()update_dashboard()update_dashboard_permissions()update_dashboard_published_version()update_data_set()update_data_set_permissions()update_data_source()update_data_source_permissions()update_folder()update_folder_permissions()update_group()update_iam_policy_assignment()update_ip_restriction()update_public_sharing_settings()update_template()update_template_alias()update_template_permissions()update_theme()update_theme_alias()update_theme_permissions()update_user()can_paginate(operation_name)¶Check if an operation can be paginated.
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").True if the operation can be paginated,
False otherwise.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'
)
[REQUIRED]
The Amazon Web Services account ID.
[REQUIRED]
The ID of the dataset used in the ingestion.
[REQUIRED]
An ID for the ingestion.
dict
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.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.ResourceExistsExceptionQuickSight.Client.exceptions.InternalFailureExceptionclose()¶Closes underlying endpoint connections.
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'
},
]
)
[REQUIRED]
The ID for the Amazon Web Services account that you want to customize Amazon QuickSight for.
[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:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639" } .
The default theme for this Amazon QuickSight subscription.
The default email customization template.
A list of the tags that you want to attach to this resource.
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Tag key.
Tag value.
dict
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.AccessDeniedExceptionQuickSight.Client.exceptions.ConflictExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceExistsExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.InternalFailureExceptionQuickSight.Client.exceptions.ResourceUnavailableExceptioncreate_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. This operation isn't supported in the US East (Ohio) Region, South America (Sao Paulo) Region, or Asia Pacific (Singapore) Region.
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',
AwsAccountId='string',
AccountName='string',
NotificationEmail='string',
ActiveDirectoryName='string',
Realm='string',
DirectoryId='string',
AdminGroup=[
'string',
],
AuthorGroup=[
'string',
],
ReaderGroup=[
'string',
],
FirstName='string',
LastName='string',
EmailAddress='string',
ContactNumber='string'
)
[REQUIRED]
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:
FirstNameLastNameEmailAddressContactNumber[REQUIRED]
The method that you want to use to authenticate your Amazon QuickSight account. Currently, the valid values for this parameter are IAM_AND_QUICKSIGHT , IAM_ONLY , and ACTIVE_DIRECTORY .
If you choose ACTIVE_DIRECTORY , provide an ActiveDirectoryName and an AdminGroup associated with your Active Directory.
[REQUIRED]
The Amazon Web Services account ID of the account that you're using to create your Amazon QuickSight account.
[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.
[REQUIRED]
The email address that you want Amazon QuickSight to send notifications to regarding your Amazon QuickSight account or Amazon QuickSight subscription.
ACTIVE_DIRECTORY is the selected authentication method of the new Amazon QuickSight account.ACTIVE_DIRECTORY is the selected authentication method of the new Amazon QuickSight account.The admin group associated with your Active Directory. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Amazon QuickSight account. 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.
The author group associated with your Active Directory. 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.
The reader group associated with your Active Direcrtory. 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 .
ENTERPPRISE_AND_Q is the selected edition of the new Amazon QuickSight account.ENTERPPRISE_AND_Q is the selected edition of the new Amazon QuickSight account.ENTERPPRISE_AND_Q is the selected edition of the new Amazon QuickSight account.ENTERPPRISE_AND_Q is the selected edition of the new Amazon QuickSight account.dict
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.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.ResourceExistsExceptionQuickSight.Client.exceptions.PreconditionNotMetExceptionQuickSight.Client.exceptions.ConflictExceptionQuickSight.Client.exceptions.InternalFailureExceptionQuickSight.Client.exceptions.ResourceUnavailableExceptioncreate_analysis(**kwargs)¶Creates 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.
Parameters
# This section is too large to render.
# Please see the AWS API Documentation linked below.
{
'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
The ARN for the analysis.
The ID of the analysis.
The status of the creation of the analysis.
The HTTP status of the request.
The Amazon Web Services request ID for this operation.
Exceptions
QuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.ResourceExistsExceptionQuickSight.Client.exceptions.ConflictExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.LimitExceededExceptionQuickSight.Client.exceptions.InternalFailureExceptioncreate_dashboard(**kwargs)¶Creates a dashboard from a template. 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.
Parameters
# This section is too large to render.
# Please see the AWS API Documentation linked below.
{
'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
The ARN of the dashboard.
The ARN of the dashboard, including the version number of the first version that is created.
The ID for the dashboard.
The status of the dashboard creation request.
The HTTP status of the request.
The Amazon Web Services request ID for this operation.
Exceptions
QuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.ResourceExistsExceptionQuickSight.Client.exceptions.ConflictExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.LimitExceededExceptionQuickSight.Client.exceptions.InternalFailureExceptioncreate_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'
},
]
},
'CustomSql': {
'DataSourceArn': 'string',
'Name': 'string',
'SqlQuery': 'string',
'Columns': [
{
'Name': 'string',
'Type': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME'|'BIT'|'BOOLEAN'|'JSON'
},
]
},
'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'
},
]
}
}
},
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',
'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',
]
}
},
],
'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'
},
]
},
ColumnLevelPermissionRules=[
{
'Principals': [
'string',
],
'ColumnNames': [
'string',
]
},
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
DataSetUsageConfiguration={
'DisableUseAsDirectQuerySource': True|False,
'DisableUseAsImportedSource': True|False
}
)
[REQUIRED]
The Amazon Web Services account ID.
[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.
[REQUIRED]
The display name for the dataset.
[REQUIRED]
Declares the physical tables that are available in the underlying data sources.
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.
A physical table type for relational data sources.
The Amazon Resource Name (ARN) for the data source.
The catalog associated with a table.
The schema name. This name applies to certain relational database engines.
The name of the relational table.
The column schema of the table.
Metadata for a column that is used as the input of a transform operation.
The name of this column in the underlying data source.
The data type of the column.
A physical table type built from the results of the custom SQL query.
The Amazon Resource Name (ARN) of the data source.
A display name for the SQL query result.
The SQL query.
The column schema from the SQL query result set.
Metadata for a column that is used as the input of a transform operation.
The name of this column in the underlying data source.
The data type of the column.
A physical table type for as S3 data source.
The Amazon Resource Name (ARN) for the data source.
Information about the format for the S3 source file or files.
File format.
A row number to start reading data from.
Whether the file has a header row, or the files each have a header row.
Text qualifier.
The delimiter between values in the file.
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.
Metadata for a column that is used as the input of a transform operation.
The name of this column in the underlying data source.
The data type of the column.
Configures the combination and transformation of the data from the physical tables.
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.
A display name for the logical table.
Transform operations that act on this logical table. For this structure to be valid, only one of the attributes can be non-null.
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.
An operation that projects columns. Operations that come after a projection can only refer to projected columns.
Projected columns.
An operation that filters rows based on some condition.
An expression that must evaluate to a Boolean value. Rows for which the expression evaluates to true are kept in the dataset.
An operation that creates calculated columns. Columns created in one such operation form a lexical closure.
Calculated columns to create.
A calculated column for a dataset.
Column name.
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.
An expression that defines the calculated column.
An operation that renames a column.
The name of the column to be renamed.
The new name for the column.
A transform operation that casts a column to a different type.
Column name.
New column data type.
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.
An operation that tags a column with additional information.
The column that this operation acts on.
The dataset column tag, currently only used for geospatial type tagging.
Note
This is not tags for the Amazon Web Services tagging feature.
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.
A geospatial role for a column.
A description for a column.
The text of a description for a column.
A transform operation that removes tags associated with a column.
The column that this operation acts on.
The column tags to remove from this column.
Source of this logical table.
Specifies the result of a join of two logical tables.
The operand on the left side of a join.
The operand on the right side of a join.
Join key properties of the left operand.
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.
Join key properties of the right operand.
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.
The type of join that it is.
The join instructions provided in the ON clause of a join.
Physical table ID.
The Amazon Resource Number (ARN) of the parent dataset.
[REQUIRED]
Indicates whether you want to import the data into SPICE.
Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.
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.
Geospatial column group that denotes a hierarchy.
A display name for the hierarchy.
Country code.
Columns in this hierarchy.
The folder that contains fields and nested subfolders for your dataset.
A FieldFolder element is a folder that contains fields and nested subfolders.
The description for a field folder.
A folder has a list of columns. A column can only be in one folder.
A list of resource permissions on the dataset.
Permission for the resource.
The Amazon Resource Name (ARN) of the principal. This can be one of the following:
The IAM action to grant or revoke permissions on.
The row-level security configuration for the data that you want to create.
The namespace associated with the dataset that contains permissions for RLS.
The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.
The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS is included for backward compatibility only.
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.
The status of the row-level security permission dataset. If enabled, the status is ENABLED . If disabled, the status is DISABLED .
The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only.
The status of row-level security tags. If enabled, the status is ENABLED . If disabled, the status is DISABLED .
A set of rules associated with row-level security, such as the tag names and columns that they are assigned to.
A set of rules associated with a tag.
The unique key for a tag.
The column name that a tag key is assigned to.
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.
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.
A set of one or more definitions of a ColumnLevelPermissionRule .
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.
An array of Amazon Resource Names (ARNs) for Amazon QuickSight users or groups.
An array of column names.
Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Tag key.
Tag value.
The usage configuration to apply to child datasets that reference this dataset as a source.
An option that controls whether a child dataset of a direct query can use this dataset as a source.
An option that controls whether a child dataset that's stored in QuickSight can use this dataset as a source.
dict
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.AccessDeniedExceptionQuickSight.Client.exceptions.ConflictExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.LimitExceededExceptionQuickSight.Client.exceptions.ResourceExistsExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.InternalFailureExceptioncreate_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',
DataSourceParameters={
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string',
'RoleArn': 'string'
},
'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'
},
'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'
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
}
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': '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'
}
},
Credentials={
'CredentialPair': {
'Username': 'string',
'Password': 'string',
'AlternateDataSourceParameters': [
{
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string',
'RoleArn': 'string'
},
'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'
},
'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'
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
}
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': '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'
}
},
]
},
'CopySourceArn': 'string',
'SecretArn': 'string'
},
Permissions=[
{
'Principal': 'string',
'Actions': [
'string',
]
},
],
VpcConnectionProperties={
'VpcConnectionArn': 'string'
},
SslProperties={
'DisableSsl': True|False
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The Amazon Web Services account ID.
[REQUIRED]
An ID for the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
[REQUIRED]
A display name for the data source.
[REQUIRED]
The type of the data source. To return a list of all data sources, use ListDataSources .
Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service.
The parameters that Amazon QuickSight uses to connect to your underlying source.
The parameters for OpenSearch.
The OpenSearch domain.
The parameters for Amazon Athena.
The workgroup that Amazon Athena uses.
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.
The parameters for Amazon Aurora MySQL.
Host.
Port.
Database.
The parameters for Amazon Aurora.
The Amazon Aurora PostgreSQL-Compatible host to connect to.
The port that Amazon Aurora PostgreSQL is listening on.
The Amazon Aurora PostgreSQL database to connect to.
The parameters for IoT Analytics.
Dataset name.
The parameters for Jira.
The base URL of the Jira site.
The parameters for MariaDB.
Host.
Port.
Database.
The parameters for MySQL.
Host.
Port.
Database.
The parameters for Oracle.
An Oracle host.
Port.
Database.
The parameters for PostgreSQL.
Host.
Port.
Database.
The parameters for Presto.
Host.
Port.
Catalog.
The parameters for Amazon RDS.
Instance ID.
Database.
The parameters for Amazon Redshift.
Host. This field can be blank if ClusterId is provided.
Port. This field can be blank if the ClusterId is provided.
Database.
Cluster ID. This field can be blank if the Host and Port are provided.
The parameters for S3.
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight.
Amazon S3 bucket.
Amazon S3 key that identifies an object.
The parameters for ServiceNow.
URL of the base site.
The parameters for Snowflake.
Host.
Database.
Warehouse.
The parameters for Spark.
Host.
Port.
The parameters for SQL Server.
Host.
Port.
Database.
The parameters for Teradata.
Host.
Port.
Database.
The parameters for Twitter.
Twitter query string.
Maximum number of rows to query Twitter.
The parameters for OpenSearch.
The OpenSearch domain.
The parameters for Exasol.
The hostname or IP address of the Exasol data source.
The port for the Exasol data source.
The required parameters that are needed to connect to a Databricks data source.
The host name of the Databricks data source.
The port for the Databricks data source.
The HTTP path of the Databricks data source.
The credentials Amazon QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.
Credential pair. For more information, see CredentialPair .
User name.
Password.
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.
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.
The parameters for OpenSearch.
The OpenSearch domain.
The parameters for Amazon Athena.
The workgroup that Amazon Athena uses.
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.
The parameters for Amazon Aurora MySQL.
Host.
Port.
Database.
The parameters for Amazon Aurora.
The Amazon Aurora PostgreSQL-Compatible host to connect to.
The port that Amazon Aurora PostgreSQL is listening on.
The Amazon Aurora PostgreSQL database to connect to.
The parameters for IoT Analytics.
Dataset name.
The parameters for Jira.
The base URL of the Jira site.
The parameters for MariaDB.
Host.
Port.
Database.
The parameters for MySQL.
Host.
Port.
Database.
The parameters for Oracle.
An Oracle host.
Port.
Database.
The parameters for PostgreSQL.
Host.
Port.
Database.
The parameters for Presto.
Host.
Port.
Catalog.
The parameters for Amazon RDS.
Instance ID.
Database.
The parameters for Amazon Redshift.
Host. This field can be blank if ClusterId is provided.
Port. This field can be blank if the ClusterId is provided.
Database.
Cluster ID. This field can be blank if the Host and Port are provided.
The parameters for S3.
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight.
Amazon S3 bucket.
Amazon S3 key that identifies an object.
The parameters for ServiceNow.
URL of the base site.
The parameters for Snowflake.
Host.
Database.
Warehouse.
The parameters for Spark.
Host.
Port.
The parameters for SQL Server.
Host.
Port.
Database.
The parameters for Teradata.
Host.
Port.
Database.
The parameters for Twitter.
Twitter query string.
Maximum number of rows to query Twitter.
The parameters for OpenSearch.
The OpenSearch domain.
The parameters for Exasol.
The hostname or IP address of the Exasol data source.
The port for the Exasol data source.
The required parameters that are needed to connect to a Databricks data source.
The host name of the Databricks data source.
The port for the Databricks data source.
The HTTP path of the Databricks data source.
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.
The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.
A list of resource permissions on the data source.
Permission for the resource.
The Amazon Resource Name (ARN) of the principal. This can be one of the following:
The IAM action to grant or revoke permissions on.
Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.
The Amazon Resource Name (ARN) for the VPC connection.
Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.
A Boolean option to control whether SSL should be disabled.
Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Tag key.
Tag value.
dict
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.AccessDeniedExceptionQuickSight.Client.exceptions.ConflictExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.LimitExceededExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ResourceExistsExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.InternalFailureExceptioncreate_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',
ParentFolderArn='string',
Permissions=[
{
'Principal': 'string',
'Actions': [
'string',
]
},
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The ID for the Amazon Web Services account where you want to create the folder.
[REQUIRED]
The ID of the folder.
folderType is SHARED .The Amazon Resource Name (ARN) for the parent folder.
ParentFolderArncan be null. An emptyparentFolderArncreates a root-level folder.
A structure that describes the principals and the resource-level permissions of a folder.
To specify no permissions, omit Permissions .
Permission for the resource.
The Amazon Resource Name (ARN) of the principal. This can be one of the following:
The IAM action to grant or revoke permissions on.
Tags for the folder.
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Tag key.
Tag value.
dict
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.ResourceNotFoundExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.ResourceExistsExceptionQuickSight.Client.exceptions.ConflictExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.AccessDeniedExceptionQuickSight.Client.exceptions.LimitExceededExceptionQuickSight.Client.exceptions.InternalFailureExceptioncreate_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'
)
[REQUIRED]
The ID for the Amazon Web Services account that contains the folder.
[REQUIRED]
The ID of the folder.
[REQUIRED]
The ID of the asset (the dashboard, analysis, or dataset).
[REQUIRED]
The type of the member, including DASHBOARD , ANALYSIS , and DATASET .
dict
Response Syntax
{
'Status': 123,
'FolderMember': {
'MemberId': 'string',
'MemberType': 'DASHBOARD'|'ANALYSIS'|'DATASET'
},
'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.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ResourceExistsExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.LimitExceededExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.InternalFailureExceptioncreate_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 AWS Support.
The permissions resource is arn:aws:quicksight:<your-region>:<relevant-aws-account-id>:group/default/<group-name> .
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'
)
[REQUIRED]
A name for the group that you want to create.
[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.
[REQUIRED]
The namespace that you want the group to be a part of.
dict
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.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceExistsExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.PreconditionNotMetExceptionQuickSight.Client.exceptions.LimitExceededExceptionQuickSight.Client.exceptions.InternalFailureExceptionQuickSight.Client.exceptions.ResourceUnavailableExceptioncreate_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'
)
[REQUIRED]
The name of the user that you want to add to the group membership.
[REQUIRED]
The name of the group that you want to add the user to.
[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.
[REQUIRED]
The namespace that you want the user to be a part of.
dict
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.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.PreconditionNotMetExceptionQuickSight.Client.exceptions.InternalFailureExceptionQuickSight.Client.exceptions.ResourceUnavailableExceptioncreate_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'
)
[REQUIRED]
The ID of the Amazon Web Services account where you want to assign an IAM policy to Amazon QuickSight users or groups.
[REQUIRED]
The name of the assignment, also called a rule. It must be unique within an Amazon Web Services account.
[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.The Amazon QuickSight users, groups, or both that you want to assign the policy to.
[REQUIRED]
The namespace that contains the assignment.
dict
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. This 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.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
Exceptions
QuickSight.Client.exceptions.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceExistsExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.ConcurrentUpdatingExceptionQuickSight.Client.exceptions.InternalFailureExceptioncreate_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'
)
[REQUIRED]
The ID of the dataset used in the ingestion.
[REQUIRED]
An ID for the ingestion.
[REQUIRED]
The Amazon Web Services account ID.
dict
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.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.LimitExceededExceptionQuickSight.Client.exceptions.ResourceExistsExceptionQuickSight.Client.exceptions.InternalFailureExceptioncreate_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 Services Support.
See also: AWS API Documentation
Request Syntax
response = client.create_namespace(
AwsAccountId='string',
Namespace='string',
IdentityStore='QUICKSIGHT',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The ID for the Amazon Web Services account that you want to create the Amazon QuickSight namespace in.
[REQUIRED]
The name that you want to use to describe the new namespace.
[REQUIRED]
Specifies the type of your user identity directory. Currently, this supports users with an identity type of QUICKSIGHT .
The tags that you want to associate with the namespace that you're creating.
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Tag key.
Tag value.
dict
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.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.LimitExceededExceptionQuickSight.Client.exceptions.ResourceExistsExceptionQuickSight.Client.exceptions.PreconditionNotMetExceptionQuickSight.Client.exceptions.ConflictExceptionQuickSight.Client.exceptions.InternalFailureExceptionQuickSight.Client.exceptions.ResourceUnavailableExceptioncreate_template(**kwargs)¶Creates a template from an existing Amazon QuickSight analysis or template. You can use the resulting template to create a dashboard.
A template is an entity in Amazon QuickSight that encapsulates the metadata required to create an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.
See also: AWS API Documentation
Request Syntax
# This section is too large to render.
# Please see the AWS API Documentation linked below.
Parameters
# This section is too large to render.
# Please see the AWS API Documentation linked below.
{
'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
The ARN for the template.
The ARN for the template, including the version information of the first version.
The ID of the template.
The template creation status.
The HTTP status of the request.
The Amazon Web Services request ID for this operation.
Exceptions
QuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.AccessDeniedExceptionQuickSight.Client.exceptions.ResourceExistsExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.LimitExceededExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.ConflictExceptionQuickSight.Client.exceptions.InternalFailureExceptioncreate_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
)
[REQUIRED]
The ID of the Amazon Web Services account that contains the template that you creating an alias for.
[REQUIRED]
An ID for the template.
[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.
[REQUIRED]
The version number of the template.
dict
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.ThrottlingExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ConflictExceptionQuickSight.Client.exceptions.ResourceExistsExceptionQuickSight.Client.exceptions.LimitExceededExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.ConflictExceptionQuickSight.Client.exceptions.InternalFailureExceptioncreate_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'
},
]
)
[REQUIRED]
The ID of the Amazon Web Services account where you want to store the new theme.
[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.
[REQUIRED]
A display name for the theme.
[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.
UpdateTheme is called, a new version is created. Each version of the theme has a description of the version in the VersionDescription field.[REQUIRED]
The theme configuration, which contains the theme display properties.
Color properties that apply to chart data colors.
The hexadecimal codes for the colors.
The minimum and maximum hexadecimal codes that describe a color gradient.
The hexadecimal code of a color that applies to charts where a lack of data is highlighted.
Color properties that apply to the UI and to charts, excluding the colors that apply to data.
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.
The background color that applies to visuals and other high emphasis UI.
The foreground color that applies to any sheet title, sheet control text, or UI that appears over the secondary background.
The background color that applies to the sheet background and sheet controls.
This color is that applies to selected states and buttons.
The foreground color that applies to any text or other elements that appear over the accent color.
The color that applies to error messages.
The foreground color that applies to any text or other elements that appear over the error color.
This color that applies to warning and informational messages.
The foreground color that applies to any text or other elements that appear over the warning color.
The color that applies to success messages, for example the check mark for a successful download.
The foreground color that applies to any text or other elements that appear over the success color.
The color that applies to the names of fields that are identified as dimensions.
The foreground color that applies to any text or other elements that appear over the dimension color.
The color that applies to the names of fields that are identified as measures.
The foreground color that applies to any text or other elements that appear over the measure color.
Display options related to sheets.
The display options for tiles.
The border around a tile.
The option to enable display of borders for visuals.
The layout options for tiles.
The gutter settings that apply between tiles.
This Boolean value controls whether to display a gutter space between sheet tiles.
The margin settings that apply around the outside edge of sheets.
This Boolean value controls whether to display sheet margins.
Determines the typography options.
Determines the list of font families.
Determines the font settings.
Determines the font family settings.
A valid grouping of resource permissions to apply to the new theme.
Permission for the resource.
The Amazon Resource Name (ARN) of the principal. This can be one of the following:
The IAM action to grant or revoke permissions on.
A map of the key-value pairs for the resource tag or tags that you want to add to the resource.
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Tag key.
Tag value.
dict
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.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceExistsExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.LimitExceededExceptionQuickSight.Client.exceptions.InternalFailureExceptioncreate_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
)
[REQUIRED]
The ID of the Amazon Web Services account that contains the theme for the new theme alias.
[REQUIRED]
An ID for the theme alias.
[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.
[REQUIRED]
The version number of the theme.
dict
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.ConflictExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.LimitExceededExceptionQuickSight.Client.exceptions.ResourceExistsExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.InternalFailureExceptiondelete_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'
)
[REQUIRED]
The ID for the Amazon Web Services account that you want to delete Amazon QuickSight customizations from in this Amazon Web Services Region.
dict
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.AccessDeniedExceptionQuickSight.Client.exceptions.ConflictExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.InternalFailureExceptionQuickSight.Client.exceptions.ResourceUnavailableExceptiondelete_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'
)
[REQUIRED]
The Amazon Web Services account ID of the account that you want to delete.
{
'RequestId': 'string',
'Status': 123
}
Response Structure
The Amazon Web Services request ID for this operation.
The HTTP status of the request.
Exceptions
QuickSight.Client.exceptions.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.PreconditionNotMetExceptionQuickSight.Client.exceptions.InternalFailureExceptionQuickSight.Client.exceptions.ResourceUnavailableExceptiondelete_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
)
[REQUIRED]
The ID of the Amazon Web Services account where you want to delete an analysis.
[REQUIRED]
The ID of the analysis that you're deleting.
ForceDeleteWithoutRecovery option in the same API call. The default value is 30.NoForceDeleteWithoutRecovery . To immediately delete the analysis, add the ForceDeleteWithoutRecovery option. You can't restore an analysis after it's deleted.dict
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.ThrottlingExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ConflictExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.InternalFailureExceptiondelete_dashboard(**kwargs)¶Deletes a dashboard.
See also: AWS API Documentation
Request Syntax
response = client.delete_dashboard(
AwsAccountId='string',
DashboardId='string',
VersionNumber=123
)
[REQUIRED]
The ID of the Amazon Web Services account that contains the dashboard that you're deleting.
[REQUIRED]
The ID for the dashboard.
dict
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.ThrottlingExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ConflictExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.InternalFailureExceptiondelete_data_set(**kwargs)¶Deletes a dataset.
See also: AWS API Documentation
Request Syntax
response = client.delete_data_set(
AwsAccountId='string',
DataSetId='string'
)
[REQUIRED]
The Amazon Web Services account ID.
[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.
dict
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.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.InternalFailureExceptiondelete_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'
)
[REQUIRED]
The Amazon Web Services account ID.
[REQUIRED]
The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
dict
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.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.InternalFailureExceptiondelete_folder(**kwargs)¶Deletes an empty folder.
See also: AWS API Documentation
Request Syntax
response = client.delete_folder(
AwsAccountId='string',
FolderId='string'
)
[REQUIRED]
The ID for the Amazon Web Services account that contains the folder.
[REQUIRED]
The ID of the folder.
dict
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.InvalidParameterValueExceptionQuickSight.Client.exceptions.PreconditionNotMetExceptionQuickSight.Client.exceptions.AccessDeniedExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ConflictExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.InternalFailureExceptiondelete_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'
)
[REQUIRED]
The ID for the Amazon Web Services account that contains the folder.
[REQUIRED]
The Folder ID.
[REQUIRED]
The ID of the asset (the dashboard, analysis, or dataset) that you want to delete.
[REQUIRED]
The type of the member, including DASHBOARD , ANALYSIS , and DATASET
dict
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.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.InternalFailureExceptiondelete_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'
)
[REQUIRED]
The name of the group that you want to delete.
[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.
[REQUIRED]
The namespace of the group that you want to delete.
dict
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.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.PreconditionNotMetExceptionQuickSight.Client.exceptions.InternalFailureExceptionQuickSight.Client.exceptions.ResourceUnavailableExceptiondelete_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'
)
[REQUIRED]
The name of the user that you want to delete from the group membership.
[REQUIRED]
The name of the group that you want to delete the user from.
[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.
[REQUIRED]
The namespace of the group that you want to remove a user from.
dict
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.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.PreconditionNotMetExceptionQuickSight.Client.exceptions.InternalFailureExceptionQuickSight.Client.exceptions.ResourceUnavailableExceptiondelete_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'
)
[REQUIRED]
The Amazon Web Services account ID where you want to delete the IAM policy assignment.
[REQUIRED]
The name of the assignment.
[REQUIRED]
The namespace that contains the assignment.
dict
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.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceExistsExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.ConcurrentUpdatingExceptionQuickSight.Client.exceptions.InternalFailureExceptiondelete_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'
)
[REQUIRED]
The ID for the Amazon Web Services account that you want to delete the Amazon QuickSight namespace from.
[REQUIRED]
The namespace that you want to delete.
dict
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.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.PreconditionNotMetExceptionQuickSight.Client.exceptions.InternalFailureExceptionQuickSight.Client.exceptions.ResourceUnavailableExceptiondelete_template(**kwargs)¶Deletes a template.
See also: AWS API Documentation
Request Syntax
response = client.delete_template(
AwsAccountId='string',
TemplateId='string',
VersionNumber=123
)
[REQUIRED]
The ID of the Amazon Web Services account that contains the template that you're deleting.
[REQUIRED]
An ID for the template you want to delete.
DeleteTemplate deletes all versions of the template.dict
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.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.ConflictExceptionQuickSight.Client.exceptions.LimitExceededExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.InternalFailureExceptiondelete_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'
)
[REQUIRED]
The ID of the Amazon Web Services account that contains the item to delete.
[REQUIRED]
The ID for the template that the specified alias is for.
[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.
dict
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.ThrottlingExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.ConflictExceptionQuickSight.Client.exceptions.InternalFailureExceptiondelete_theme(**kwargs)¶Deletes a theme.
See also: AWS API Documentation
Request Syntax
response = client.delete_theme(
AwsAccountId='string',
ThemeId='string',
VersionNumber=123
)
[REQUIRED]
The ID of the Amazon Web Services account that contains the theme that you're deleting.
[REQUIRED]
An ID for the theme that you want to delete.
The version of the theme that you want to delete.
Note: If you don't provide a version number, you're using this call toDeleteThemeto delete all versions of the theme.
dict
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.AccessDeniedExceptionQuickSight.Client.exceptions.ConflictExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.InternalFailureExceptiondelete_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'
)
[REQUIRED]
The ID of the Amazon Web Services account that contains the theme alias to delete.
[REQUIRED]
The ID for the theme that the specified alias is for.
[REQUIRED]
The unique name for the theme alias to delete.
dict
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.ConflictExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.InternalFailureExceptiondelete_user(**kwargs)¶Deletes the Amazon QuickSight user that is associated with the identity of the Identity and Access Management (IAM) user or role that's making the call. The IAM user isn't deleted as a result of this call.
See also: AWS API Documentation
Request Syntax
response = client.delete_user(
UserName='string',
AwsAccountId='string',
Namespace='string'
)
[REQUIRED]
The name of the user that you want to delete.
[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.
[REQUIRED]
The namespace. Currently, you should set this to default .
dict
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.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.PreconditionNotMetExceptionQuickSight.Client.exceptions.InternalFailureExceptionQuickSight.Client.exceptions.ResourceUnavailableExceptiondelete_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'
)
[REQUIRED]
The principal ID of the user.
[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.
[REQUIRED]
The namespace. Currently, you should set this to default .
dict
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.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.PreconditionNotMetExceptionQuickSight.Client.exceptions.InternalFailureExceptionQuickSight.Client.exceptions.ResourceUnavailableExceptiondescribe_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: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
)
[REQUIRED]
The ID for the Amazon Web Services account that you want to describe Amazon QuickSight customizations for.
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.dict
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.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.InternalFailureExceptionQuickSight.Client.exceptions.ResourceUnavailableExceptiondescribe_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'
)
[REQUIRED]
The ID for the Amazon Web Services account that contains the settings that you want to list.
{
'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
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.
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.
The edition of Amazon QuickSight that you're currently subscribed to: Enterprise edition or Standard edition.
The default Amazon QuickSight namespace for your Amazon Web Services account.
The main notification email for your Amazon QuickSight subscription.
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.
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.
The Amazon Web Services request ID for this operation.
The HTTP status of the request.
Exceptions
QuickSight.Client.exceptions.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.InternalFailureExceptionQuickSight.Client.exceptions.ResourceUnavailableExceptiondescribe_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'
)
[REQUIRED]
The Amazon Web Services account ID associated with your Amazon QuickSight account.
{
'AccountInfo': {
'AccountName': 'string',
'Edition': 'STANDARD'|'ENTERPRISE'|'ENTERPRISE_AND_Q',
'NotificationEmail': 'string',
'AuthenticationType': 'string',
'AccountSubscriptionStatus': 'string'
},
'Status': 123,
'RequestId': 'string'
}
Response Structure
A structure that contains the following elements:
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.
The edition of your Amazon QuickSight account.
The email address that will be used for Amazon QuickSight to send notifications regarding your Amazon Web Services account or Amazon QuickSight subscription.
The way that your Amazon QuickSight account is authenticated.
The status of your account subscription.
The HTTP status of the request.
The Amazon Web Services request ID for this operation.
Exceptions
QuickSight.Client.exceptions.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.InternalFailureExceptionQuickSight.Client.exceptions.ResourceUnavailableExceptiondescribe_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'
)
[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.
[REQUIRED]
The ID of the analysis that you're describing. The ID is part of the URL of the analysis.
dict
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'
},
]
},
'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) --
(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.
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.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Exceptions
QuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.AccessDeniedExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.InternalFailureExceptiondescribe_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'
)
[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.
[REQUIRED]
The ID of the analysis that you're describing. The ID is part of the URL of the analysis.
dict
Response Syntax
# This section is too large to render.
# Please see the AWS API Documentation linked below.
Response Structure
# This section is too large to render.
# Please see the AWS API Documentation linked below.
Exceptions
QuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.AccessDeniedExceptionQuickSight.Client.exceptions.ResourceExistsExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.ConflictExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.InternalFailureExceptiondescribe_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'
)
[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.
[REQUIRED]
The ID of the analysis whose permissions you're describing. The ID is part of the analysis URL.
dict
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:
Actions (list) --
The IAM action to grant or revoke permissions on.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Exceptions
QuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.InternalFailureExceptiondescribe_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'
)
[REQUIRED]
The ID of the Amazon Web Services account that contains the dashboard that you're describing.
[REQUIRED]
The ID for the dashboard.
dict
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'
},
]
},
'CreatedTime': datetime(2015, 1, 1),
'LastPublishedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1)
},
'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) --
(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.
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.
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.
Status (integer) --
The HTTP status of this request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Exceptions
QuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.AccessDeniedExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.InternalFailureExceptiondescribe_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'
)
[REQUIRED]
The ID of the Amazon Web Services account that contains the dashboard that you're describing.
[REQUIRED]
The ID for the dashboard.
dict
Response Syntax
# This section is too large to render.
# Please see the AWS API Documentation linked below.
Response Structure
# This section is too large to render.
# Please see the AWS API Documentation linked below.
Exceptions
QuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.AccessDeniedExceptionQuickSight.Client.exceptions.ResourceExistsExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.ConflictExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.InternalFailureExceptiondescribe_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'
)
[REQUIRED]
The ID of the Amazon Web Services account that contains the dashboard that you're describing permissions for.
[REQUIRED]
The ID for the dashboard, also added to the IAM policy.
dict
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:
Actions (list) --
The IAM action to grant or revoke permissions on.
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:
Actions (list) --
The IAM action to grant or revoke permissions on.
Exceptions
QuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.InternalFailureExceptiondescribe_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'
)
[REQUIRED]
The Amazon Web Services account ID.
[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.
dict
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'
},
]
},
'CustomSql': {
'DataSourceArn': 'string',
'Name': 'string',
'SqlQuery': 'string',
'Columns': [
{
'Name': 'string',
'Type': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME'|'BIT'|'BOOLEAN'|'JSON'
},
]
},
'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'
},
]
}
}
},
'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',
'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',
]
}
},
],
'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'
},
],
'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'
},
]
},
'ColumnLevelPermissionRules': [
{
'Principals': [
'string',
],
'ColumnNames': [
'string',
]
},
],
'DataSetUsageConfiguration': {
'DisableUseAsDirectQuerySource': True|False,
'DisableUseAsImportedSource': True|False
}
},
'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.
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.
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.
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.
LogicalTableMap (dict) --
Configures the combination and transformation of the data from the physical tables.
(string) --
(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.
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.
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.
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) --
A display name for the dataset.
Description (string) --
A description for a column.
Type (string) --
Type.
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.
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.
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.
ColumnLevelPermissionRules (list) --
A set of one or more definitions of a ColumnLevelPermissionRule .
(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.
ColumnNames (list) --
An array of column names.
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.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
Exceptions
QuickSight.Client.exceptions.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.InternalFailureExceptiondescribe_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'
)
[REQUIRED]
The Amazon Web Services account ID.
[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.
dict
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:
Actions (list) --
The IAM action to grant or revoke permissions on.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
Exceptions
QuickSight.Client.exceptions.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.InternalFailureExceptiondescribe_data_source(**kwargs)¶Describes a data source.
See also: AWS API Documentation
Request Syntax
response = client.describe_data_source(
AwsAccountId='string',
DataSourceId='string'
)
[REQUIRED]
The Amazon Web Services account ID.
[REQUIRED]
The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
dict
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',
'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'
},
'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'
},
'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'
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
}
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': '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'
}
},
'AlternateDataSourceParameters': [
{
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string',
'RoleArn': 'string'
},
'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'
},
'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'
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
}
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': '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'
}
},
],
'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.
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) --
Port.
Database (string) --
Database.
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.
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.
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.
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 required parameters that are needed 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.
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.
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) --
Port.
Database (string) --
Database.
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.
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.
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.
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 required parameters that are needed 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.
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.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.InternalFailureExceptiondescribe_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'
)
[REQUIRED]
The Amazon Web Services account ID.
[REQUIRED]
The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
dict
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:
Actions (list) --
The IAM action to grant or revoke permissions on.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
Exceptions
QuickSight.Client.exceptions.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.InternalFailureExceptiondescribe_folder(**kwargs)¶Describes a folder.
See also: AWS API Documentation
Request Syntax
response = client.describe_folder(
AwsAccountId='string',
FolderId='string'
)
[REQUIRED]
The ID for the Amazon Web Services account that contains the folder.
[REQUIRED]
The ID of the folder.
dict
Response Syntax
{
'Status': 123,
'Folder': {
'FolderId': 'string',
'Arn': 'string',
'Name': 'string',
'FolderType': 'SHARED',
'FolderPath': [
'string',
],
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1)
},
'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.
CreatedTime (datetime) --
The time that the folder was created.
LastUpdatedTime (datetime) --
The time that the folder was last updated.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Exceptions
QuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.AccessDeniedExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.InternalFailureExceptiondescribe_folder_permissions(**kwargs)¶Describes permissions for a folder.
See also: AWS API Documentation
Request Syntax
response = client.describe_folder_permissions(
AwsAccountId='string',
FolderId='string'
)
[REQUIRED]
The ID for the Amazon Web Services account that contains the folder.
[REQUIRED]
The ID of the folder.
dict
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:
Actions (list) --
The IAM action to grant or revoke permissions on.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Exceptions
QuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.AccessDeniedExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.InternalFailureExceptiondescribe_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'
)
[REQUIRED]
The ID for the Amazon Web Services account that contains the folder.
[REQUIRED]
The ID of the folder.
dict
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:
Actions (list) --
The IAM action to grant or revoke permissions on.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Exceptions
QuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.AccessDeniedExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.InternalFailureExceptiondescribe_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'
)
[REQUIRED]
The name of the group that you want to describe.
[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.
[REQUIRED]
The namespace of the group that you want described.
dict
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.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.PreconditionNotMetExceptionQuickSight.Client.exceptions.InternalFailureExceptionQuickSight.Client.exceptions.ResourceUnavailableExceptiondescribe_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'
)
[REQUIRED]
The user name of the user that you want to search for.
[REQUIRED]
The name of the group that you want to search.
[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.
[REQUIRED]
The namespace that includes the group you are searching within.
dict
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.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.PreconditionNotMetExceptionQuickSight.Client.exceptions.InternalFailureExceptionQuickSight.Client.exceptions.ResourceUnavailableExceptiondescribe_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'
)
[REQUIRED]
The ID of the Amazon Web Services account that contains the assignment that you want to describe.
[REQUIRED]
The name of the assignment, also called a rule.
[REQUIRED]
The namespace that contains the assignment.
dict
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.
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.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.InvalidNextTokenExceptionQuickSight.Client.exceptions.InternalFailureExceptiondescribe_ingestion(**kwargs)¶Describes a SPICE ingestion.
See also: AWS API Documentation
Request Syntax
response = client.describe_ingestion(
AwsAccountId='string',
DataSetId='string',
IngestionId='string'
)
[REQUIRED]
The Amazon Web Services account ID.
[REQUIRED]
The ID of the dataset used in the ingestion.
[REQUIRED]
An ID for the ingestion.
dict
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',
'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.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.ResourceExistsExceptionQuickSight.Client.exceptions.InternalFailureExceptiondescribe_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'
)
[REQUIRED]
The ID of the Amazon Web Services account that contains the IP rules.
{
'AwsAccountId': 'string',
'IpRestrictionRuleMap': {
'string': 'string'
},
'Enabled': True|False,
'RequestId': 'string',
'Status': 123
}
Response Structure
The ID of the Amazon Web Services account that contains the IP rules.
A map that describes the IP rules with CIDR range and description.
A value that specifies whether IP rules are turned on.
The Amazon Web Services request ID for this operation.
The HTTP status of the request.
Exceptions
QuickSight.Client.exceptions.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.InternalFailureExceptiondescribe_namespace(**kwargs)¶Describes the current namespace.
See also: AWS API Documentation
Request Syntax
response = client.describe_namespace(
AwsAccountId='string',
Namespace='string'
)
[REQUIRED]
The ID for the Amazon Web Services account that contains the Amazon QuickSight namespace that you want to describe.
[REQUIRED]
The namespace that you want to describe.
dict
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'
}
},
'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.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
Exceptions
QuickSight.Client.exceptions.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.InternalFailureExceptionQuickSight.Client.exceptions.ResourceUnavailableExceptiondescribe_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'
)
[REQUIRED]
The ID of the Amazon Web Services account that contains the template that you're describing.
[REQUIRED]
The ID for the template.
VersionNumber parameter value isn't provided, the latest version of the template is described.$LATEST in the AliasName parameter. The keyword $PUBLISHED doesn't apply to templates.dict
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'
},
]
},
'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_PROGRESSCREATION_SUCCESSFULCREATION_FAILEDUPDATE_IN_PROGRESSUPDATE_SUCCESSFULUPDATE_FAILEDDELETEDDataSetConfigurations (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.
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.InvalidParameterValueExceptionQuickSight.Client.exceptions.AccessDeniedExceptionQuickSight.Client.exceptions.ResourceExistsExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.ConflictExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.InternalFailureExceptiondescribe_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'
)
[REQUIRED]
The ID of the Amazon Web Services account that contains the template alias that you're describing.
[REQUIRED]
The ID for the template.
[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.
dict
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.ThrottlingExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.InternalFailureExceptiondescribe_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'
)
[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.
[REQUIRED]
The ID of the template that you're describing.
$LATEST in the AliasName parameter. The keyword $PUBLISHED doesn't apply to templates.dict
Response Syntax
# This section is too large to render.
# Please see the AWS API Documentation linked below.
Response Structure
# This section is too large to render.
# Please see the AWS API Documentation linked below.
Exceptions
QuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.AccessDeniedExceptionQuickSight.Client.exceptions.ResourceExistsExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.ConflictExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.InternalFailureExceptiondescribe_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'
)
[REQUIRED]
The ID of the Amazon Web Services account that contains the template that you're describing.
[REQUIRED]
The ID for the template.
dict
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:
Actions (list) --
The IAM action to grant or revoke permissions on.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
Exceptions
QuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ConflictExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.InternalFailureExceptiondescribe_theme(**kwargs)¶Describes a theme.
See also: AWS API Documentation
Request Syntax
response = client.describe_theme(
AwsAccountId='string',
ThemeId='string',
VersionNumber=123,
AliasName='string'
)
[REQUIRED]
The ID of the Amazon Web Services account that contains the theme that you're describing.
[REQUIRED]
The ID for the theme.
VersionNumber parameter value isn't provided, the latest version of the theme is described.$LATEST in the AliasName parameter. The keyword $PUBLISHED doesn't apply to themes.dict
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.
MinMaxGradient (list) --
The minimum and maximum hexadecimal codes that describe a color gradient.
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.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceExistsExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.InternalFailureExceptiondescribe_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'
)
[REQUIRED]
The ID of the Amazon Web Services account that contains the theme alias that you're describing.
[REQUIRED]
The ID for the theme.
[REQUIRED]
The name of the theme alias that you want to describe.
dict
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.ConflictExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.InternalFailureExceptiondescribe_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'
)
[REQUIRED]
The ID of the Amazon Web Services account that contains the theme that you're describing.
[REQUIRED]
The ID for the theme that you want to describe permissions for.
dict
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:
Actions (list) --
The IAM action to grant or revoke permissions on.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
Exceptions
QuickSight.Client.exceptions.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.InternalFailureExceptiondescribe_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'
)
[REQUIRED]
The name of the user that you want to describe.
[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.
[REQUIRED]
The namespace. Currently, you should set this to default .
dict
Response Syntax
{
'User': {
'Arn': 'string',
'UserName': 'string',
'Email': 'string',
'Role': 'ADMIN'|'AUTHOR'|'READER'|'RESTRICTED_AUTHOR'|'RESTRICTED_READER',
'IdentityType': 'IAM'|'QUICKSIGHT',
'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.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.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.PreconditionNotMetExceptionQuickSight.Client.exceptions.InternalFailureExceptionQuickSight.Client.exceptions.ResourceUnavailableExceptiongenerate_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:
SessionLifetimeInMinutes parameter. The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours.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'
},
'DashboardVisual': {
'InitialDashboardVisualId': {
'DashboardId': 'string',
'SheetId': 'string',
'VisualId': 'string'
}
},
'QSearchBar': {
'InitialTopicId': 'string'
}
},
AllowedDomains=[
'string',
]
)
[REQUIRED]
The ID for the Amazon Web Services account that contains the dashboard that you're embedding.
[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 .
The session tags used for row-level security. Before you use this parameter, make sure that you have configured the relevant datasets using the DataSet$RowLevelPermissionTagConfiguration parameter so that session tags can be used to provide row-level security.
These are not the tags used for the Amazon Web Services resource tagging feature. For more information, see Using Row-Level Security (RLS) with Tags in the Amazon QuickSight User Guide .
The key-value pair used for the row-level security tags feature.
The key for the tag.
The value that you want to assign the tag.
[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. Currently, you can pass up to 25 dashboard ARNs in each API call.
[REQUIRED]
The configuration of the experience that you are embedding.
The type of embedding experience. In this case, Amazon QuickSight dashboards.
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 .
The type of embedding experience. In this case, Amazon QuickSight visuals.
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 .
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.
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.
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.
The Q search bar that you want to use for anonymous user embedding.
The QuickSight Q topic ID of the 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 topic pre-selected.
The Amazon Resource Name (ARN) of this Q topic must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException .
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 .
dict
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.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.SessionLifetimeInMinutesInvalidExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.UnsupportedPricingPlanExceptionQuickSight.Client.exceptions.InternalFailureExceptiongenerate_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:
SessionLifetimeInMinutes parameter. The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours.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'
},
'QuickSightConsole': {
'InitialPath': 'string'
},
'QSearchBar': {
'InitialTopicId': 'string'
},
'DashboardVisual': {
'InitialDashboardVisualId': {
'DashboardId': 'string',
'SheetId': 'string',
'VisualId': 'string'
}
}
},
AllowedDomains=[
'string',
]
)
[REQUIRED]
The ID for the Amazon Web Services account that contains the dashboard that you're embedding.
[REQUIRED]
The Amazon Resource Name for the registered user.
[REQUIRED]
The experience you are embedding. For registered users, you can embed Amazon QuickSight dashboards, Amazon QuickSight visuals, the Amazon QuickSight Q search bar, or the entire Amazon QuickSight console.
The configuration details for providing a dashboard embedding experience.
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.
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 :
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.
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.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 .
The ID of the Q topic that you want to make the starting topic in the Q search bar. 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, a list of all shared topics is shown in the Q bar for your readers. When you select an initial topic, you can specify whether or not readers are allowed to select other topics from the available ones in the list.
The type of embedding experience. In this case, Amazon QuickSight visuals.
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 .
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.
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.
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.
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 .
dict
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, 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.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.QuickSightUserNotFoundExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.SessionLifetimeInMinutesInvalidExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.UnsupportedPricingPlanExceptionQuickSight.Client.exceptions.InternalFailureExceptionget_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:
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',
]
)
[REQUIRED]
The ID for the Amazon Web Services account that contains the dashboard that you're embedding.
[REQUIRED]
The ID for the dashboard, also added to the Identity and Access Management (IAM) policy.
[REQUIRED]
The authentication method that the user uses to sign in.
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 .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:
Omit this parameter for users in the third group – IAM users and IAM role-based sessions.
Namespace = default .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.
dict
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.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceExistsExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.DomainNotWhitelistedExceptionQuickSight.Client.exceptions.QuickSightUserNotFoundExceptionQuickSight.Client.exceptions.IdentityTypeNotSupportedExceptionQuickSight.Client.exceptions.SessionLifetimeInMinutesInvalidExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.UnsupportedPricingPlanExceptionQuickSight.Client.exceptions.InternalFailureExceptionget_paginator(operation_name)¶Create a paginator for an operation.
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").client.can_paginate method to
check if an operation is pageable.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 :
See also: AWS API Documentation
Request Syntax
response = client.get_session_embed_url(
AwsAccountId='string',
EntryPoint='string',
SessionLifetimeInMinutes=123,
UserArn='string'
)
[REQUIRED]
The ID for the Amazon Web Services account associated with your Amazon QuickSight subscription.
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 analysisThe 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:
Omit this parameter for users in the third group, IAM users and IAM role-based sessions.
dict
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.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceExistsExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.QuickSightUserNotFoundExceptionQuickSight.Client.exceptions.SessionLifetimeInMinutesInvalidExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.InternalFailureExceptionget_waiter(waiter_name)¶Returns an object that can wait for some condition.
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
)
[REQUIRED]
The ID of the Amazon Web Services account that contains the analyses.
dict
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.ThrottlingExceptionQuickSight.Client.exceptions.InvalidNextTokenExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.InternalFailureExceptionlist_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
)
[REQUIRED]
The ID of the Amazon Web Services account that contains the dashboard that you're listing versions for.
[REQUIRED]
The ID for the dashboard.
dict
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.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.InvalidNextTokenExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.InternalFailureExceptionlist_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
)
[REQUIRED]
The ID of the Amazon Web Services account that contains the dashboards that you're listing.
dict
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.ThrottlingExceptionQuickSight.Client.exceptions.InvalidNextTokenExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.InternalFailureExceptionlist_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
)
[REQUIRED]
The Amazon Web Services account ID.
dict
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
},
],
'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.
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.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.InvalidNextTokenExceptionQuickSight.Client.exceptions.InternalFailureExceptionlist_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
)
[REQUIRED]
The Amazon Web Services account ID.
dict
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',
'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'
},
'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'
},
'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'
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
}
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': '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'
}
},
'AlternateDataSourceParameters': [
{
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string',
'RoleArn': 'string'
},
'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'
},
'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'
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
}
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': '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'
}
},
],
'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.
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) --
Port.
Database (string) --
Database.
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.
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.
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.
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 required parameters that are needed 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.
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.
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) --
Port.
Database (string) --
Database.
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.
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.
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.
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 required parameters that are needed 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.
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.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.InvalidNextTokenExceptionQuickSight.Client.exceptions.InternalFailureExceptionlist_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
)
[REQUIRED]
The ID for the Amazon Web Services account that contains the folder.
[REQUIRED]
The ID of the folder.
dict
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.InvalidParameterValueExceptionQuickSight.Client.exceptions.AccessDeniedExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.InvalidNextTokenExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.InternalFailureExceptionlist_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
)
[REQUIRED]
The ID for the Amazon Web Services account that contains the folder.
dict
Response Syntax
{
'Status': 123,
'FolderSummaryList': [
{
'Arn': 'string',
'FolderId': 'string',
'Name': 'string',
'FolderType': 'SHARED',
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1)
},
],
'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.
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.InvalidParameterValueExceptionQuickSight.Client.exceptions.AccessDeniedExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.InvalidNextTokenExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.InternalFailureExceptionlist_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'
)
[REQUIRED]
The name of the group that you want to see a membership list of.
[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.
[REQUIRED]
The namespace of the group that you want a list of users from.
dict
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.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.InvalidNextTokenExceptionQuickSight.Client.exceptions.PreconditionNotMetExceptionQuickSight.Client.exceptions.InternalFailureExceptionQuickSight.Client.exceptions.ResourceUnavailableExceptionlist_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'
)
[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.
[REQUIRED]
The namespace that you want a list of groups from.
dict
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.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.InvalidNextTokenExceptionQuickSight.Client.exceptions.PreconditionNotMetExceptionQuickSight.Client.exceptions.InternalFailureExceptionQuickSight.Client.exceptions.ResourceUnavailableExceptionlist_iam_policy_assignments(**kwargs)¶Lists 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
)
[REQUIRED]
The ID of the Amazon Web Services account that contains these IAM policy assignments.
[REQUIRED]
The namespace for the assignments.
dict
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.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.InvalidNextTokenExceptionQuickSight.Client.exceptions.InternalFailureExceptionlist_iam_policy_assignments_for_user(**kwargs)¶Lists all the IAM policy assignments, including the Amazon Resource Names (ARNs) for the IAM policies assigned to the specified user and group or groups that the user belongs to.
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'
)
[REQUIRED]
The ID of the Amazon Web Services account that contains the assignments.
[REQUIRED]
The name of the user.
[REQUIRED]
The namespace of the assignment.
dict
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.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceExistsExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.ConcurrentUpdatingExceptionQuickSight.Client.exceptions.InternalFailureExceptionlist_ingestions(**kwargs)¶Lists the history of SPICE ingestions for a dataset.
See also: AWS API Documentation
Request Syntax
response = client.list_ingestions(
DataSetId='string',
NextToken='string',
AwsAccountId='string',
MaxResults=123
)
[REQUIRED]
The ID of the dataset used in the ingestion.
[REQUIRED]
The Amazon Web Services account ID.
dict
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',
'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.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.ResourceExistsExceptionQuickSight.Client.exceptions.InvalidNextTokenExceptionQuickSight.Client.exceptions.InternalFailureExceptionlist_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
)
[REQUIRED]
The ID for the Amazon Web Services account that contains the Amazon QuickSight namespaces that you want to list.
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.dict
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'
}
},
],
'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.
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.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.InvalidNextTokenExceptionQuickSight.Client.exceptions.PreconditionNotMetExceptionQuickSight.Client.exceptions.InternalFailureExceptionQuickSight.Client.exceptions.ResourceUnavailableExceptionLists the tags assigned to a resource.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
ResourceArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource that you want a list of tags for.
{
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'RequestId': 'string',
'Status': 123
}
Response Structure
Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Tag key.
Tag value.
The Amazon Web Services request ID for this operation.
The HTTP status of the request.
Exceptions
QuickSight.Client.exceptions.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.InternalFailureExceptionlist_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
)
[REQUIRED]
The ID of the Amazon Web Services account that contains the template aliases that you're listing.
[REQUIRED]
The ID for the template.
dict
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.InvalidNextTokenExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.InternalFailureExceptionlist_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
)
[REQUIRED]
The ID of the Amazon Web Services account that contains the templates that you're listing.
[REQUIRED]
The ID for the template.
dict
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.ThrottlingExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.InvalidNextTokenExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.InternalFailureExceptionlist_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
)
[REQUIRED]
The ID of the Amazon Web Services account that contains the templates that you're listing.
dict
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.ThrottlingExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.InvalidNextTokenExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.InternalFailureExceptionlist_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
)
[REQUIRED]
The ID of the Amazon Web Services account that contains the theme aliases that you're listing.
[REQUIRED]
The ID for the theme.
dict
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.ConflictExceptionQuickSight.Client.exceptions.InvalidNextTokenExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.InternalFailureExceptionlist_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
)
[REQUIRED]
The ID of the Amazon Web Services account that contains the themes that you're listing.
[REQUIRED]
The ID for the theme.
dict
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.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidNextTokenExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.InternalFailureExceptionlist_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'
)
[REQUIRED]
The ID of the Amazon Web Services account that contains the themes that you're listing.
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.dict
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.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.InvalidNextTokenExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.InternalFailureExceptionlist_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
)
[REQUIRED]
The Amazon QuickSight user name that you want to list group memberships for.
[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.
[REQUIRED]
The namespace. Currently, you should set this to default .
dict
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.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.PreconditionNotMetExceptionQuickSight.Client.exceptions.InternalFailureExceptionQuickSight.Client.exceptions.ResourceUnavailableExceptionlist_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'
)
[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.
[REQUIRED]
The namespace. Currently, you should set this to default .
dict
Response Syntax
{
'UserList': [
{
'Arn': 'string',
'UserName': 'string',
'Email': 'string',
'Role': 'ADMIN'|'AUTHOR'|'READER'|'RESTRICTED_AUTHOR'|'RESTRICTED_READER',
'IdentityType': 'IAM'|'QUICKSIGHT',
'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.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.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.InvalidNextTokenExceptionQuickSight.Client.exceptions.PreconditionNotMetExceptionQuickSight.Client.exceptions.InternalFailureExceptionQuickSight.Client.exceptions.ResourceUnavailableExceptionregister_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',
Email='string',
UserRole='ADMIN'|'AUTHOR'|'READER'|'RESTRICTED_AUTHOR'|'RESTRICTED_READER',
IamArn='string',
SessionName='string',
AwsAccountId='string',
Namespace='string',
UserName='string',
CustomPermissionsName='string',
ExternalLoginFederationProviderType='string',
CustomFederationProviderUrl='string',
ExternalLoginId='string'
)
[REQUIRED]
Amazon QuickSight supports several ways of managing the identity of users. This parameter accepts two values:
IAM : A user whose identity maps to an existing IAM user or role.QUICKSIGHT : A user whose identity is owned and managed internally by Amazon QuickSight.[REQUIRED]
The email address of the user that you want to register.
[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.RESTRICTED_READER : This role isn't currently available for use.RESTRICTED_AUTHOR : This role isn't currently available for use.[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.
[REQUIRED]
The namespace. Currently, you should set this to default .
(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:
To add custom permissions to an existing user, use UpdateUser instead.
A set of custom permissions includes any combination of these restrictions. Currently, you need to create the profile names for custom permission sets by using the Amazon QuickSight console. Then, you use the RegisterUser API operation to assign the named set of permissions to a Amazon QuickSight user.
Amazon QuickSight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning Amazon QuickSight users to one of the default security cohorts in Amazon QuickSight (admin, author, reader).
This feature is available only to Amazon QuickSight Enterprise edition subscriptions.
The type of supported external login provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. The type of supported external login provider can be one of the following.
COGNITO : Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the COGNITO provider type, don’t use the "CustomFederationProviderUrl" parameter which is only needed when the external provider is custom.CUSTOM_OIDC : Custom OpenID Connect (OIDC) provider. When choosing CUSTOM_OIDC type, use the CustomFederationProviderUrl parameter to provide the custom OIDC provider URL.ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC .dict
Response Syntax
{
'User': {
'Arn': 'string',
'UserName': 'string',
'Email': 'string',
'Role': 'ADMIN'|'AUTHOR'|'READER'|'RESTRICTED_AUTHOR'|'RESTRICTED_READER',
'IdentityType': 'IAM'|'QUICKSIGHT',
'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.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.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.LimitExceededExceptionQuickSight.Client.exceptions.ResourceExistsExceptionQuickSight.Client.exceptions.PreconditionNotMetExceptionQuickSight.Client.exceptions.InternalFailureExceptionQuickSight.Client.exceptions.ResourceUnavailableExceptionrestore_analysis(**kwargs)¶Restores an analysis.
See also: AWS API Documentation
Request Syntax
response = client.restore_analysis(
AwsAccountId='string',
AnalysisId='string'
)
[REQUIRED]
The ID of the Amazon Web Services account that contains the analysis.
[REQUIRED]
The ID of the analysis that you're restoring.
dict
Response Syntax
{
'Status': 123,
'Arn': 'string',
'AnalysisId': 'string',
'RequestId': '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.
Exceptions
QuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ConflictExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.InternalFailureExceptionsearch_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
)
[REQUIRED]
The ID of the Amazon Web Services account that contains the analyses that you're searching for.
[REQUIRED]
The structure for the search filters that you want to apply to your search.
A filter that you apply when searching for one or more analyses.
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 .
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.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" .
dict
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.ThrottlingExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.InvalidNextTokenExceptionQuickSight.Client.exceptions.InternalFailureExceptionsearch_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
)
[REQUIRED]
The ID of the Amazon Web Services account that contains the user whose dashboards you're searching for.
[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" } ]
A filter that you apply when searching for dashboards.
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 .
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.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" .
dict
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.ThrottlingExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.InvalidNextTokenExceptionQuickSight.Client.exceptions.InternalFailureExceptionsearch_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
)
[REQUIRED]
The Amazon Web Services account ID.
[REQUIRED]
The filters to apply to the search.
A filter that you apply when searching for datasets.
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 .
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.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" .
dict
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
},
],
'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.
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.ThrottlingExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidNextTokenExceptionQuickSight.Client.exceptions.InternalFailureExceptionsearch_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
)
[REQUIRED]
The Amazon Web Services account ID.
[REQUIRED]
The filters to apply to the search.
A filter that you apply when searching for data sources.
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 .
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.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" .
dict
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',
'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.ThrottlingExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidNextTokenExceptionQuickSight.Client.exceptions.InternalFailureExceptionsearch_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
)
[REQUIRED]
The ID for the Amazon Web Services account that contains the folder.
[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" } ] .
A filter to use to search an Amazon QuickSight folder.
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 .
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.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" .
dict
Response Syntax
{
'Status': 123,
'FolderSummaryList': [
{
'Arn': 'string',
'FolderId': 'string',
'Name': 'string',
'FolderType': 'SHARED',
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1)
},
],
'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.
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.InvalidParameterValueExceptionQuickSight.Client.exceptions.AccessDeniedExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.InvalidNextTokenExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.InvalidRequestExceptionQuickSight.Client.exceptions.InternalFailureExceptionsearch_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'
},
]
)
[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.
[REQUIRED]
The namespace that you want to search.
[REQUIRED]
The structure for the search filters that you want to apply to your search.
A GroupSearchFilter object that you want to apply to your search.
The comparison operator that you want to use as a filter, for example "Operator": "StartsWith" . Currently, the only supported operator is StartsWith .
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 .
The value of the named item, in this case GROUP_NAME , that you want to use as a filter.
dict
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.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.InvalidNextTokenExceptionQuickSight.Client.exceptions.PreconditionNotMetExceptionQuickSight.Client.exceptions.InternalFailureExceptionQuickSight.Client.exceptions.ResourceUnavailableExceptiontag_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, and template.
Tagging for Amazon QuickSight works in a similar way to tagging for other Amazon Web Services services, except for the following:
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
ResourceArn='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource that you want to tag.
[REQUIRED]
Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Tag key.
Tag value.
dict
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.LimitExceededExceptionQuickSight.Client.exceptions.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.InternalFailureExceptionuntag_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',
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource that you want to untag.
[REQUIRED]
The keys of the key-value pairs for the resource tag or tags assigned to the resource.
dict
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.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.InternalFailureExceptionupdate_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'
}
)
[REQUIRED]
The ID for the Amazon Web Services account that you want to update Amazon QuickSight customizations for.
[REQUIRED]
The Amazon QuickSight customizations you're updating in the current Amazon Web Services Region.
The default theme for this Amazon QuickSight subscription.
The default email customization template.
dict
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.AccessDeniedExceptionQuickSight.Client.exceptions.ConflictExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.InternalFailureExceptionQuickSight.Client.exceptions.ResourceUnavailableExceptionupdate_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
)
[REQUIRED]
The ID for the Amazon Web Services account that contains the Amazon QuickSight settings that you want to list.
[REQUIRED]
The default namespace for this Amazon Web Services account. Currently, the default is default . Identity and Access Management (IAM) users that register for the first time with Amazon QuickSight provide an email address that becomes associated with the default namespace.
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.dict
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.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.InternalFailureExceptionQuickSight.Client.exceptions.ResourceUnavailableExceptionupdate_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.
Parameters
# This section is too large to render.
# Please see the AWS API Documentation linked below.
{
'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
The ARN of the analysis that you're updating.
The ID of the analysis.
The update status of the last update that was made to the analysis.
The HTTP status of the request.
The Amazon Web Services request ID for this operation.
Exceptions
QuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.ResourceExistsExceptionQuickSight.Client.exceptions.ConflictExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.InternalFailureExceptionupdate_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',
]
},
]
)
[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.
[REQUIRED]
The ID of the analysis whose permissions you're updating. The ID is part of the analysis URL.
A structure that describes the permissions to add and the principal to add them to.
Permission for the resource.
The Amazon Resource Name (ARN) of the principal. This can be one of the following:
The IAM action to grant or revoke permissions on.
A structure that describes the permissions to remove and the principal to remove them from.
Permission for the resource.
The Amazon Resource Name (ARN) of the principal. This can be one of the following:
The IAM action to grant or revoke permissions on.
dict
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:
Actions (list) --
The IAM action to grant or revoke permissions on.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
Exceptions
QuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.ConflictExceptionQuickSight.Client.exceptions.LimitExceededExceptionQuickSight.Client.exceptions.InternalFailureExceptionupdate_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.
Parameters
# This section is too large to render.
# Please see the AWS API Documentation linked below.
{
'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
The Amazon Resource Name (ARN) of the resource.
The ARN of the dashboard, including the version number.
The ID for the dashboard.
The creation status of the request.
The HTTP status of the request.
The Amazon Web Services request ID for this operation.
Exceptions
QuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ConflictExceptionQuickSight.Client.exceptions.LimitExceededExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.InternalFailureExceptionupdate_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',
]
},
]
)
[REQUIRED]
The ID of the Amazon Web Services account that contains the dashboard whose permissions you're updating.
[REQUIRED]
The ID for the dashboard.
The permissions that you want to grant on this resource.
Permission for the resource.
The Amazon Resource Name (ARN) of the principal. This can be one of the following:
The IAM action to grant or revoke permissions on.
The permissions that you want to revoke from this resource.
Permission for the resource.
The Amazon Resource Name (ARN) of the principal. This can be one of the following:
The IAM action to grant or revoke permissions on.
Grants link permissions to all users in a defined namespace.
Permission for the resource.
The Amazon Resource Name (ARN) of the principal. This can be one of the following:
The IAM action to grant or revoke permissions on.
Revokes link permissions from all users in a defined namespace.
Permission for the resource.
The Amazon Resource Name (ARN) of the principal. This can be one of the following:
The IAM action to grant or revoke permissions on.
dict
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:
Actions (list) --
The IAM action to grant or revoke permissions on.
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:
Actions (list) --
The IAM action to grant or revoke permissions on.
Exceptions
QuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.ConflictExceptionQuickSight.Client.exceptions.LimitExceededExceptionQuickSight.Client.exceptions.InternalFailureExceptionupdate_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
)
[REQUIRED]
The ID of the Amazon Web Services account that contains the dashboard that you're updating.
[REQUIRED]
The ID for the dashboard.
[REQUIRED]
The version number of the dashboard.
dict
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.InvalidParameterValueExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.ConflictExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.InternalFailureExceptionupdate_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'
},
]
},
'CustomSql': {
'DataSourceArn': 'string',
'Name': 'string',
'SqlQuery': 'string',
'Columns': [
{
'Name': 'string',
'Type': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME'|'BIT'|'BOOLEAN'|'JSON'
},
]
},
'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'
},
]
}
}
},
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',
'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',
]
}
},
],
'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'
},
]
},
ColumnLevelPermissionRules=[
{
'Principals': [
'string',
],
'ColumnNames': [
'string',
]
},
],
DataSetUsageConfiguration={
'DisableUseAsDirectQuerySource': True|False,
'DisableUseAsImportedSource': True|False
}
)
[REQUIRED]
The Amazon Web Services account ID.
[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.
[REQUIRED]
The display name for the dataset.
[REQUIRED]
Declares the physical tables that are available in the underlying data sources.
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.
A physical table type for relational data sources.
The Amazon Resource Name (ARN) for the data source.
The catalog associated with a table.
The schema name. This name applies to certain relational database engines.
The name of the relational table.
The column schema of the table.
Metadata for a column that is used as the input of a transform operation.
The name of this column in the underlying data source.
The data type of the column.
A physical table type built from the results of the custom SQL query.
The Amazon Resource Name (ARN) of the data source.
A display name for the SQL query result.
The SQL query.
The column schema from the SQL query result set.
Metadata for a column that is used as the input of a transform operation.
The name of this column in the underlying data source.
The data type of the column.
A physical table type for as S3 data source.
The Amazon Resource Name (ARN) for the data source.
Information about the format for the S3 source file or files.
File format.
A row number to start reading data from.
Whether the file has a header row, or the files each have a header row.
Text qualifier.
The delimiter between values in the file.
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.
Metadata for a column that is used as the input of a transform operation.
The name of this column in the underlying data source.
The data type of the column.
Configures the combination and transformation of the data from the physical tables.
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.
A display name for the logical table.
Transform operations that act on this logical table. For this structure to be valid, only one of the attributes can be non-null.
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.
An operation that projects columns. Operations that come after a projection can only refer to projected columns.
Projected columns.
An operation that filters rows based on some condition.
An expression that must evaluate to a Boolean value. Rows for which the expression evaluates to true are kept in the dataset.
An operation that creates calculated columns. Columns created in one such operation form a lexical closure.
Calculated columns to create.
A calculated column for a dataset.
Column name.
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.
An expression that defines the calculated column.
An operation that renames a column.
The name of the column to be renamed.
The new name for the column.
A transform operation that casts a column to a different type.
Column name.
New column data type.
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.
An operation that tags a column with additional information.
The column that this operation acts on.
The dataset column tag, currently only used for geospatial type tagging.
Note
This is not tags for the Amazon Web Services tagging feature.
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.
A geospatial role for a column.
A description for a column.
The text of a description for a column.
A transform operation that removes tags associated with a column.
The column that this operation acts on.
The column tags to remove from this column.
Source of this logical table.
Specifies the result of a join of two logical tables.
The operand on the left side of a join.
The operand on the right side of a join.
Join key properties of the left operand.
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.
Join key properties of the right operand.
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.
The type of join that it is.
The join instructions provided in the ON clause of a join.
Physical table ID.
The Amazon Resource Number (ARN) of the parent dataset.
[REQUIRED]
Indicates whether you want to import the data into SPICE.
Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.
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.
Geospatial column group that denotes a hierarchy.
A display name for the hierarchy.
Country code.
Columns in this hierarchy.
The folder that contains fields and nested subfolders for your dataset.
A FieldFolder element is a folder that contains fields and nested subfolders.
The description for a field folder.
A folder has a list of columns. A column can only be in one folder.
The row-level security configuration for the data you want to create.
The namespace associated with the dataset that contains permissions for RLS.
The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.
The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS is included for backward compatibility only.
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.
The status of the row-level security permission dataset. If enabled, the status is ENABLED . If disabled, the status is DISABLED .
The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only.
The status of row-level security tags. If enabled, the status is ENABLED . If disabled, the status is DISABLED .
A set of rules associated with row-level security, such as the tag names and columns that they are assigned to.
A set of rules associated with a tag.
The unique key for a tag.
The column name that a tag key is assigned to.
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.
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.
A set of one or more definitions of a ColumnLevelPermissionRule .
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.
An array of Amazon Resource Names (ARNs) for Amazon QuickSight users or groups.
An array of column names.
The usage configuration to apply to child datasets that reference this dataset as a source.
An option that controls whether a child dataset of a direct query can use this dataset as a source.
An option that controls whether a child dataset that's stored in QuickSight can use this dataset as a source.
dict
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.AccessDeniedExceptionQuickSight.Client.exceptions.ConflictExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.LimitExceededExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.InternalFailureExceptionupdate_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',
]
},
]
)
[REQUIRED]
The Amazon Web Services account ID.
[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.
The resource permissions that you want to grant to the dataset.
Permission for the resource.
The Amazon Resource Name (ARN) of the principal. This can be one of the following:
The IAM action to grant or revoke permissions on.
The resource permissions that you want to revoke from the dataset.
Permission for the resource.
The Amazon Resource Name (ARN) of the principal. This can be one of the following:
The IAM action to grant or revoke permissions on.
dict
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.AccessDeniedExceptionQuickSight.Client.exceptions.ConflictExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.InternalFailureExceptionupdate_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'
},
'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'
},
'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'
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
}
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': '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'
}
},
Credentials={
'CredentialPair': {
'Username': 'string',
'Password': 'string',
'AlternateDataSourceParameters': [
{
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string',
'RoleArn': 'string'
},
'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'
},
'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'
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
}
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': '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'
}
},
]
},
'CopySourceArn': 'string',
'SecretArn': 'string'
},
VpcConnectionProperties={
'VpcConnectionArn': 'string'
},
SslProperties={
'DisableSsl': True|False
}
)
[REQUIRED]
The Amazon Web Services account ID.
[REQUIRED]
The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
[REQUIRED]
A display name for the data source.
The parameters that Amazon QuickSight uses to connect to your underlying source.
The parameters for OpenSearch.
The OpenSearch domain.
The parameters for Amazon Athena.
The workgroup that Amazon Athena uses.
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.
The parameters for Amazon Aurora MySQL.
Host.
Port.
Database.
The parameters for Amazon Aurora.
The Amazon Aurora PostgreSQL-Compatible host to connect to.
The port that Amazon Aurora PostgreSQL is listening on.
The Amazon Aurora PostgreSQL database to connect to.
The parameters for IoT Analytics.
Dataset name.
The parameters for Jira.
The base URL of the Jira site.
The parameters for MariaDB.
Host.
Port.
Database.
The parameters for MySQL.
Host.
Port.
Database.
The parameters for Oracle.
An Oracle host.
Port.
Database.
The parameters for PostgreSQL.
Host.
Port.
Database.
The parameters for Presto.
Host.
Port.
Catalog.
The parameters for Amazon RDS.
Instance ID.
Database.
The parameters for Amazon Redshift.
Host. This field can be blank if ClusterId is provided.
Port. This field can be blank if the ClusterId is provided.
Database.
Cluster ID. This field can be blank if the Host and Port are provided.
The parameters for S3.
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight.
Amazon S3 bucket.
Amazon S3 key that identifies an object.
The parameters for ServiceNow.
URL of the base site.
The parameters for Snowflake.
Host.
Database.
Warehouse.
The parameters for Spark.
Host.
Port.
The parameters for SQL Server.
Host.
Port.
Database.
The parameters for Teradata.
Host.
Port.
Database.
The parameters for Twitter.
Twitter query string.
Maximum number of rows to query Twitter.
The parameters for OpenSearch.
The OpenSearch domain.
The parameters for Exasol.
The hostname or IP address of the Exasol data source.
The port for the Exasol data source.
The required parameters that are needed to connect to a Databricks data source.
The host name of the Databricks data source.
The port for the Databricks data source.
The HTTP path of the Databricks data source.
The credentials that Amazon QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.
Credential pair. For more information, see CredentialPair .
User name.
Password.
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.
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.
The parameters for OpenSearch.
The OpenSearch domain.
The parameters for Amazon Athena.
The workgroup that Amazon Athena uses.
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.
The parameters for Amazon Aurora MySQL.
Host.
Port.
Database.
The parameters for Amazon Aurora.
The Amazon Aurora PostgreSQL-Compatible host to connect to.
The port that Amazon Aurora PostgreSQL is listening on.
The Amazon Aurora PostgreSQL database to connect to.
The parameters for IoT Analytics.
Dataset name.
The parameters for Jira.
The base URL of the Jira site.
The parameters for MariaDB.
Host.
Port.
Database.
The parameters for MySQL.
Host.
Port.
Database.
The parameters for Oracle.
An Oracle host.
Port.
Database.
The parameters for PostgreSQL.
Host.
Port.
Database.
The parameters for Presto.
Host.
Port.
Catalog.
The parameters for Amazon RDS.
Instance ID.
Database.
The parameters for Amazon Redshift.
Host. This field can be blank if ClusterId is provided.
Port. This field can be blank if the ClusterId is provided.
Database.
Cluster ID. This field can be blank if the Host and Port are provided.
The parameters for S3.
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight.
Amazon S3 bucket.
Amazon S3 key that identifies an object.
The parameters for ServiceNow.
URL of the base site.
The parameters for Snowflake.
Host.
Database.
Warehouse.
The parameters for Spark.
Host.
Port.
The parameters for SQL Server.
Host.
Port.
Database.
The parameters for Teradata.
Host.
Port.
Database.
The parameters for Twitter.
Twitter query string.
Maximum number of rows to query Twitter.
The parameters for OpenSearch.
The OpenSearch domain.
The parameters for Exasol.
The hostname or IP address of the Exasol data source.
The port for the Exasol data source.
The required parameters that are needed to connect to a Databricks data source.
The host name of the Databricks data source.
The port for the Databricks data source.
The HTTP path of the Databricks data source.
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.
The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.
Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.
The Amazon Resource Name (ARN) for the VPC connection.
Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.
A Boolean option to control whether SSL should be disabled.
dict
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.AccessDeniedExceptionQuickSight.Client.exceptions.ConflictExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.InternalFailureExceptionupdate_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',
]
},
]
)
[REQUIRED]
The Amazon Web Services account ID.
[REQUIRED]
The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
A list of resource permissions that you want to grant on the data source.
Permission for the resource.
The Amazon Resource Name (ARN) of the principal. This can be one of the following:
The IAM action to grant or revoke permissions on.
A list of resource permissions that you want to revoke on the data source.
Permission for the resource.
The Amazon Resource Name (ARN) of the principal. This can be one of the following:
The IAM action to grant or revoke permissions on.
dict
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.AccessDeniedExceptionQuickSight.Client.exceptions.ConflictExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.InternalFailureExceptionupdate_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'
)
[REQUIRED]
The ID for the Amazon Web Services account that contains the folder to update.
[REQUIRED]
The ID of the folder.
[REQUIRED]
The name of the folder.
dict
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.InvalidParameterValueExceptionQuickSight.Client.exceptions.AccessDeniedExceptionQuickSight.Client.exceptions.ResourceExistsExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ConflictExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.InternalFailureExceptionupdate_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',
]
},
]
)
[REQUIRED]
The ID for the Amazon Web Services account that contains the folder to update.
[REQUIRED]
The ID of the folder.
The permissions that you want to grant on a resource.
Permission for the resource.
The Amazon Resource Name (ARN) of the principal. This can be one of the following:
The IAM action to grant or revoke permissions on.
The permissions that you want to revoke from a resource.
Permission for the resource.
The Amazon Resource Name (ARN) of the principal. This can be one of the following:
The IAM action to grant or revoke permissions on.
dict
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:
Actions (list) --
The IAM action to grant or revoke permissions on.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Exceptions
QuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.AccessDeniedExceptionQuickSight.Client.exceptions.LimitExceededExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.InternalFailureExceptionupdate_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'
)
[REQUIRED]
The name of the group that you want to update.
[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.
[REQUIRED]
The namespace of the group that you want to update.
dict
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.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.PreconditionNotMetExceptionQuickSight.Client.exceptions.InternalFailureExceptionQuickSight.Client.exceptions.ResourceUnavailableExceptionupdate_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',
]
}
)
[REQUIRED]
The ID of the Amazon Web Services account that contains the IAM policy assignment.
[REQUIRED]
The name of the assignment, also called a rule. This name must be unique within an Amazon Web Services account.
[REQUIRED]
The namespace of the assignment.
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.The Amazon QuickSight users, groups, or both that you want to assign the policy to.
dict
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.
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.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceExistsExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.ConcurrentUpdatingExceptionQuickSight.Client.exceptions.InternalFailureExceptionupdate_ip_restriction(**kwargs)¶Updates the content and status of IP rules. To use this operation, you need to provide the entire map of rules. You can use the DescribeIpRestriction operation to get the current rule map.
See also: AWS API Documentation
Request Syntax
response = client.update_ip_restriction(
AwsAccountId='string',
IpRestrictionRuleMap={
'string': 'string'
},
Enabled=True|False
)
[REQUIRED]
The ID of the Amazon Web Services account that contains the IP rules.
A map that describes the updated IP rules with CIDR ranges and descriptions.
dict
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.LimitExceededExceptionQuickSight.Client.exceptions.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.InternalFailureExceptionupdate_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
)
[REQUIRED]
The Amazon Web Services account ID associated with your Amazon QuickSight subscription.
dict
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.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.UnsupportedPricingPlanExceptionQuickSight.Client.exceptions.InternalFailureExceptionupdate_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.
Parameters
# This section is too large to render.
# Please see the AWS API Documentation linked below.
{
'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
The ID for the template.
The Amazon Resource Name (ARN) for the template.
The ARN for the template, including the version information of the first version.
The creation status of the template.
The HTTP status of the request.
The Amazon Web Services request ID for this operation.
Exceptions
QuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceExistsExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.ConflictExceptionQuickSight.Client.exceptions.LimitExceededExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.InternalFailureExceptionupdate_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
)
[REQUIRED]
The ID of the Amazon Web Services account that contains the template alias that you're updating.
[REQUIRED]
The ID for the template.
[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.
[REQUIRED]
The version number of the template.
dict
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.ThrottlingExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ConflictExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.ConflictExceptionQuickSight.Client.exceptions.InternalFailureExceptionupdate_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',
]
},
]
)
[REQUIRED]
The ID of the Amazon Web Services account that contains the template.
[REQUIRED]
The ID for the template.
A list of resource permissions to be granted on the template.
Permission for the resource.
The Amazon Resource Name (ARN) of the principal. This can be one of the following:
The IAM action to grant or revoke permissions on.
A list of resource permissions to be revoked from the template.
Permission for the resource.
The Amazon Resource Name (ARN) of the principal. This can be one of the following:
The IAM action to grant or revoke permissions on.
dict
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:
Actions (list) --
The IAM action to grant or revoke permissions on.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
Exceptions
QuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ConflictExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.LimitExceededExceptionQuickSight.Client.exceptions.InternalFailureExceptionupdate_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'
},
]
}
}
)
[REQUIRED]
The ID of the Amazon Web Services account that contains the theme that you're updating.
[REQUIRED]
The ID for the theme.
[REQUIRED]
The theme ID, defined by Amazon QuickSight, that a custom theme inherits from. All themes initially inherit from a default Amazon QuickSight theme.
UpdateTheme , you create a new version of the theme. Each version of the theme maintains a description of the version in VersionDescription .The theme configuration, which contains the theme display properties.
Color properties that apply to chart data colors.
The hexadecimal codes for the colors.
The minimum and maximum hexadecimal codes that describe a color gradient.
The hexadecimal code of a color that applies to charts where a lack of data is highlighted.
Color properties that apply to the UI and to charts, excluding the colors that apply to data.
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.
The background color that applies to visuals and other high emphasis UI.
The foreground color that applies to any sheet title, sheet control text, or UI that appears over the secondary background.
The background color that applies to the sheet background and sheet controls.
This color is that applies to selected states and buttons.
The foreground color that applies to any text or other elements that appear over the accent color.
The color that applies to error messages.
The foreground color that applies to any text or other elements that appear over the error color.
This color that applies to warning and informational messages.
The foreground color that applies to any text or other elements that appear over the warning color.
The color that applies to success messages, for example the check mark for a successful download.
The foreground color that applies to any text or other elements that appear over the success color.
The color that applies to the names of fields that are identified as dimensions.
The foreground color that applies to any text or other elements that appear over the dimension color.
The color that applies to the names of fields that are identified as measures.
The foreground color that applies to any text or other elements that appear over the measure color.
Display options related to sheets.
The display options for tiles.
The border around a tile.
The option to enable display of borders for visuals.
The layout options for tiles.
The gutter settings that apply between tiles.
This Boolean value controls whether to display a gutter space between sheet tiles.
The margin settings that apply around the outside edge of sheets.
This Boolean value controls whether to display sheet margins.
Determines the typography options.
Determines the list of font families.
Determines the font settings.
Determines the font family settings.
dict
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.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.LimitExceededExceptionQuickSight.Client.exceptions.ResourceExistsExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.InternalFailureExceptionupdate_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
)
[REQUIRED]
The ID of the Amazon Web Services account that contains the theme alias that you're updating.
[REQUIRED]
The ID for the theme.
[REQUIRED]
The name of the theme alias that you want to update.
[REQUIRED]
The version number of the theme that the alias should reference.
dict
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.ConflictExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceExistsExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.InternalFailureExceptionupdate_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:
"quicksight:DescribeTheme""quicksight:DescribeThemeAlias""quicksight:ListThemeAliases""quicksight:ListThemeVersions""quicksight:DescribeTheme""quicksight:DescribeThemeAlias""quicksight:ListThemeAliases""quicksight:ListThemeVersions""quicksight:DeleteTheme""quicksight:UpdateTheme""quicksight:CreateThemeAlias""quicksight:DeleteThemeAlias""quicksight:UpdateThemeAlias""quicksight:UpdateThemePermissions""quicksight:DescribeThemePermissions"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',
]
},
]
)
[REQUIRED]
The ID of the Amazon Web Services account that contains the theme.
[REQUIRED]
The ID for the theme.
A list of resource permissions to be granted for the theme.
Permission for the resource.
The Amazon Resource Name (ARN) of the principal. This can be one of the following:
The IAM action to grant or revoke permissions on.
A list of resource permissions to be revoked from the theme.
Permission for the resource.
The Amazon Resource Name (ARN) of the principal. This can be one of the following:
The IAM action to grant or revoke permissions on.
dict
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:
Actions (list) --
The IAM action to grant or revoke permissions on.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
Exceptions
QuickSight.Client.exceptions.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.UnsupportedUserEditionExceptionQuickSight.Client.exceptions.LimitExceededExceptionQuickSight.Client.exceptions.InternalFailureExceptionupdate_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',
CustomPermissionsName='string',
UnapplyCustomPermissions=True|False,
ExternalLoginFederationProviderType='string',
CustomFederationProviderUrl='string',
ExternalLoginId='string'
)
[REQUIRED]
The Amazon QuickSight user name that you want to update.
[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.
[REQUIRED]
The namespace. Currently, you should set this to default .
[REQUIRED]
The email address of the user that you want to update.
[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.The name of the Amazon QuickSight role is invisible to the user except for the console screens dealing with permissions.
(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:
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.
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.ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC .dict
Response Syntax
{
'User': {
'Arn': 'string',
'UserName': 'string',
'Email': 'string',
'Role': 'ADMIN'|'AUTHOR'|'READER'|'RESTRICTED_AUTHOR'|'RESTRICTED_READER',
'IdentityType': 'IAM'|'QUICKSIGHT',
'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.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.AccessDeniedExceptionQuickSight.Client.exceptions.InvalidParameterValueExceptionQuickSight.Client.exceptions.ResourceNotFoundExceptionQuickSight.Client.exceptions.ThrottlingExceptionQuickSight.Client.exceptions.PreconditionNotMetExceptionQuickSight.Client.exceptions.InternalFailureExceptionQuickSight.Client.exceptions.ResourceUnavailableExceptionThe available paginators are:
QuickSight.Paginator.ListAnalysesQuickSight.Paginator.ListDashboardVersionsQuickSight.Paginator.ListDashboardsQuickSight.Paginator.ListDataSetsQuickSight.Paginator.ListDataSourcesQuickSight.Paginator.ListIngestionsQuickSight.Paginator.ListNamespacesQuickSight.Paginator.ListTemplateAliasesQuickSight.Paginator.ListTemplateVersionsQuickSight.Paginator.ListTemplatesQuickSight.Paginator.ListThemeVersionsQuickSight.Paginator.ListThemesQuickSight.Paginator.SearchAnalysesQuickSight.Paginator.SearchDashboardsQuickSight.Paginator.SearchDataSetsQuickSight.Paginator.SearchDataSourcesQuickSight.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'
}
)
[REQUIRED]
The ID of the Amazon Web Services account that contains the analyses.
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
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.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'
}
)
[REQUIRED]
The ID of the Amazon Web Services account that contains the dashboard that you're listing versions for.
[REQUIRED]
The ID for the dashboard.
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
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.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'
}
)
[REQUIRED]
The ID of the Amazon Web Services account that contains the dashboards that you're listing.
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
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.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'
}
)
[REQUIRED]
The Amazon Web Services account ID.
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
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
},
],
'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.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
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'
}
)
[REQUIRED]
The Amazon Web Services account ID.
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
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',
'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'
},
'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'
},
'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'
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
}
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': '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'
}
},
'AlternateDataSourceParameters': [
{
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string',
'RoleArn': 'string'
},
'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'
},
'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'
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
}
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': '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'
}
},
],
'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.
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) --
Port.
Database (string) --
Database.
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.
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.
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.
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 required parameters that are needed 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.
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.
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) --
Port.
Database (string) --
Database.
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.
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.
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.
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 required parameters that are needed 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.
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.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'
}
)
[REQUIRED]
The ID of the dataset used in the ingestion.
[REQUIRED]
The Amazon Web Services account ID.
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
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',
'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.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'
}
)
[REQUIRED]
The ID for the Amazon Web Services account that contains the Amazon QuickSight namespaces that you want to list.
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
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'
}
},
],
'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.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
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'
}
)
[REQUIRED]
The ID of the Amazon Web Services account that contains the template aliases that you're listing.
[REQUIRED]
The ID for the template.
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
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.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'
}
)
[REQUIRED]
The ID of the Amazon Web Services account that contains the templates that you're listing.
[REQUIRED]
The ID for the template.
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
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.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'
}
)
[REQUIRED]
The ID of the Amazon Web Services account that contains the templates that you're listing.
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
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.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'
}
)
[REQUIRED]
The ID of the Amazon Web Services account that contains the themes that you're listing.
[REQUIRED]
The ID for the theme.
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
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.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'
}
)
[REQUIRED]
The ID of the Amazon Web Services account that contains the themes that you're listing.
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.A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
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.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'
}
)
[REQUIRED]
The ID of the Amazon Web Services account that contains the analyses that you're searching for.
[REQUIRED]
The structure for the search filters that you want to apply to your search.
A filter that you apply when searching for one or more analyses.
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 .
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.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" .
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
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.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'
}
)
[REQUIRED]
The ID of the Amazon Web Services account that contains the user whose dashboards you're searching for.
[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" } ]
A filter that you apply when searching for dashboards.
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 .
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.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" .
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
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.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'
}
)
[REQUIRED]
The Amazon Web Services account ID.
[REQUIRED]
The filters to apply to the search.
A filter that you apply when searching for datasets.
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 .
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.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" .
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
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
},
],
'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.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
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'
}
)
[REQUIRED]
The Amazon Web Services account ID.
[REQUIRED]
The filters to apply to the search.
A filter that you apply when searching for data sources.
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 .
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.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" .
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
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',
'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.