Table of Contents
A low-level client representing Amazon QuickSight
Amazon QuickSight is a fully managed, serverless business intelligence service for the AWS 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:
Check if an operation can be paginated.
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 AWS 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 AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
Exceptions
Creates Amazon QuickSight customizations the current AWS Region. Currently, you can add a custom default theme by using the CreateAccountCustomization or UpdateAccountCustomization API operation. To further customize QuickSight by removing QuickSight sample assets and videos for all new users, see Customizing QuickSight in the Amazon QuickSight User Guide.
You can create customizations for your AWS 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 AWS 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'
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The ID for the AWS account that you want to customize QuickSight for.
[REQUIRED]
The QuickSight customizations you're adding in the current AWS Region. You can add these to an AWS 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 QuickSight subscription.
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'
},
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) for the customization that you created for this AWS account.
AwsAccountId (string) --
The ID for the AWS account that you want to customize QuickSight for.
Namespace (string) --
The namespace associated with the customization you're creating.
AccountCustomization (dict) --
The QuickSight customizations you're adding in the current AWS Region.
DefaultTheme (string) --
The default theme for this QuickSight subscription.
RequestId (string) --
The AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
Exceptions
Creates an analysis in Amazon QuickSight.
See also: AWS API Documentation
Request Syntax
response = client.create_analysis(
AwsAccountId='string',
AnalysisId='string',
Name='string',
Parameters={
'StringParameters': [
{
'Name': 'string',
'Values': [
'string',
]
},
],
'IntegerParameters': [
{
'Name': 'string',
'Values': [
123,
]
},
],
'DecimalParameters': [
{
'Name': 'string',
'Values': [
123.0,
]
},
],
'DateTimeParameters': [
{
'Name': 'string',
'Values': [
datetime(2015, 1, 1),
]
},
]
},
Permissions=[
{
'Principal': 'string',
'Actions': [
'string',
]
},
],
SourceEntity={
'SourceTemplate': {
'DataSetReferences': [
{
'DataSetPlaceholder': 'string',
'DataSetArn': 'string'
},
],
'Arn': 'string'
}
},
ThemeArn='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The ID of the AWS account where you are creating an analysis.
[REQUIRED]
The ID for the analysis that you're creating. This ID displays in the URL of the analysis.
[REQUIRED]
A descriptive name for the analysis that you're creating. This name displays for the analysis in the QuickSight console.
The parameter names and override values that you want to use. An analysis can have any parameter type, and some parameters might accept multiple values.
String parameters.
A string parameter.
A display name for a string parameter.
The values of a string parameter.
Integer parameters.
An integer parameter.
The name of the integer parameter.
The values for the integer parameter.
Decimal parameters.
A decimal parameter.
A display name for the decimal parameter.
The values for the decimal parameter.
Date-time parameters.
A date-time parameter.
A display name for the date-time parameter.
The values for the date-time parameter.
A structure that describes the principals and the resource-level permissions on an analysis. You can use the Permissions structure to grant permissions by providing a list of AWS Identity and Access Management (IAM) action information for each principal listed by Amazon Resource Name (ARN).
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.
[REQUIRED]
A source entity to use for the analysis that you're creating. This metadata structure contains details that describe a source template and one or more datasets.
The source template for the source entity of the analysis.
The dataset references of the source template of an analysis.
Dataset reference.
Dataset placeholder.
Dataset Amazon Resource Name (ARN).
The Amazon Resource Name (ARN) of the source template of an analysis.
Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.
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',
'AnalysisId': 'string',
'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
Arn (string) --
The ARN for the analysis.
AnalysisId (string) --
The ID of the analysis.
CreationStatus (string) --
The status of the creation of the analysis.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The AWS request ID for this operation.
Exceptions
Creates a dashboard from a template. To first create a template, see the `` CreateTemplate `` API operation.
A dashboard is an entity in QuickSight that identifies QuickSight reports, created from analyses. You can share 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 AWS account.
See also: AWS API Documentation
Request Syntax
response = client.create_dashboard(
AwsAccountId='string',
DashboardId='string',
Name='string',
Parameters={
'StringParameters': [
{
'Name': 'string',
'Values': [
'string',
]
},
],
'IntegerParameters': [
{
'Name': 'string',
'Values': [
123,
]
},
],
'DecimalParameters': [
{
'Name': 'string',
'Values': [
123.0,
]
},
],
'DateTimeParameters': [
{
'Name': 'string',
'Values': [
datetime(2015, 1, 1),
]
},
]
},
Permissions=[
{
'Principal': 'string',
'Actions': [
'string',
]
},
],
SourceEntity={
'SourceTemplate': {
'DataSetReferences': [
{
'DataSetPlaceholder': 'string',
'DataSetArn': 'string'
},
],
'Arn': 'string'
}
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
VersionDescription='string',
DashboardPublishOptions={
'AdHocFilteringOption': {
'AvailabilityStatus': 'ENABLED'|'DISABLED'
},
'ExportToCSVOption': {
'AvailabilityStatus': 'ENABLED'|'DISABLED'
},
'SheetControlsOption': {
'VisibilityState': 'EXPANDED'|'COLLAPSED'
}
},
ThemeArn='string'
)
[REQUIRED]
The ID of the AWS account where you want to create the dashboard.
[REQUIRED]
The ID for the dashboard, also added to the IAM policy.
[REQUIRED]
The display name of the dashboard.
The parameters for the creation of the dashboard, which you want to use to override the default settings. A dashboard can have any type of parameters, and some parameters might accept multiple values.
String parameters.
A string parameter.
A display name for a string parameter.
The values of a string parameter.
Integer parameters.
An integer parameter.
The name of the integer parameter.
The values for the integer parameter.
Decimal parameters.
A decimal parameter.
A display name for the decimal parameter.
The values for the decimal parameter.
Date-time parameters.
A date-time parameter.
A display name for the date-time parameter.
The values for the date-time parameter.
A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN.
To specify no permissions, omit the permissions list.
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.
[REQUIRED]
The entity that you are using as a source when you create the dashboard. In SourceEntity , you specify the type of object you're using as source. You can only create a dashboard from a template, so you use a SourceTemplate entity. If you need to create a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate API operation. For SourceTemplate , specify the Amazon Resource Name (ARN) of the source template. The SourceTemplate ARN can contain any AWS Account and any QuickSight-supported AWS Region.
Use the DataSetReferences entity within SourceTemplate to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.
Source template.
Dataset references.
Dataset reference.
Dataset placeholder.
Dataset Amazon Resource Name (ARN).
The Amazon Resource Name (ARN) of the resource.
Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Tag key.
Tag value.
Options for publishing the dashboard when you create it:
Ad hoc (one-time) filtering option.
Availability status.
Export to .csv option.
Availability status.
Sheet controls option.
Visibility state.
dict
Response Syntax
{
'Arn': 'string',
'VersionArn': 'string',
'DashboardId': 'string',
'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
Arn (string) --
The ARN of the dashboard.
VersionArn (string) --
The ARN of the dashboard, including the version number of the first version that is created.
DashboardId (string) --
The ID for the dashboard.
CreationStatus (string) --
The status of the dashboard creation request.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The AWS request ID for this operation.
Exceptions
Creates a dataset.
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'
}
},
]
}
},
],
'Source': {
'JoinInstruction': {
'LeftOperand': 'string',
'RightOperand': 'string',
'LeftJoinKeyProperties': {
'UniqueKey': True|False
},
'RightJoinKeyProperties': {
'UniqueKey': True|False
},
'Type': 'INNER'|'OUTER'|'LEFT'|'RIGHT',
'OnClause': 'string'
},
'PhysicalTableId': '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'
},
ColumnLevelPermissionRules=[
{
'Principals': [
'string',
],
'ColumnNames': [
'string',
]
},
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The AWS account ID.
[REQUIRED]
An ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS 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 as S3 data source.
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.
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 AWS 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.
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 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 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.
[REQUIRED]
Indicates whether you want to import the data into SPICE.
Groupings of columns that work together in certain 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 interpretting 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.
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 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.
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 AWS Region for each AWS 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 AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
Exceptions
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',
DataSourceParameters={
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': '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
}
},
Credentials={
'CredentialPair': {
'Username': 'string',
'Password': 'string',
'AlternateDataSourceParameters': [
{
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': '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
}
},
]
},
'CopySourceArn': 'string'
},
Permissions=[
{
'Principal': 'string',
'Actions': [
'string',
]
},
],
VpcConnectionProperties={
'VpcConnectionArn': 'string'
},
SslProperties={
'DisableSsl': True|False
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The AWS account ID.
[REQUIRED]
An ID for the data source. This ID is unique per AWS Region for each AWS account.
[REQUIRED]
A display name for the data source.
[REQUIRED]
The type of the data source. Currently, the supported types for this operation are: ATHENA, AURORA, AURORA_POSTGRESQL, AMAZON_ELASTICSEARCH, MARIADB, MYSQL, POSTGRESQL, PRESTO, REDSHIFT, S3, SNOWFLAKE, SPARK, SQLSERVER, TERADATA . Use ListDataSources to return a list of all data sources.
AMAZON_ELASTICSEARCH is for Amazon managed Elasticsearch Service.
The parameters that QuickSight uses to connect to your underlying source.
Amazon Elasticsearch Service parameters.
The Amazon Elasticsearch Service domain.
Amazon Athena parameters.
The workgroup that Amazon Athena uses.
Amazon Aurora MySQL parameters.
Host.
Port.
Database.
Aurora PostgreSQL parameters.
Host.
Port.
Database.
AWS IoT Analytics parameters.
Dataset name.
Jira parameters.
The base URL of the Jira site.
MariaDB parameters.
Host.
Port.
Database.
MySQL parameters.
Host.
Port.
Database.
Oracle parameters.
An Oracle host.
Port.
Database.
PostgreSQL parameters.
Host.
Port.
Database.
Presto parameters.
Host.
Port.
Catalog.
Amazon RDS parameters.
Instance ID.
Database.
Amazon Redshift parameters.
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.
S3 parameters.
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded in the console.
Amazon S3 bucket.
Amazon S3 key that identifies an object.
ServiceNow parameters.
URL of the base site.
Snowflake parameters.
Host.
Database.
Warehouse.
Spark parameters.
Host.
Port.
SQL Server parameters.
Host.
Port.
Database.
Teradata parameters.
Host.
Port.
Database.
Twitter parameters.
Twitter query string.
Maximum number of rows to query Twitter.
The credentials 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.
Amazon Elasticsearch Service parameters.
The Amazon Elasticsearch Service domain.
Amazon Athena parameters.
The workgroup that Amazon Athena uses.
Amazon Aurora MySQL parameters.
Host.
Port.
Database.
Aurora PostgreSQL parameters.
Host.
Port.
Database.
AWS IoT Analytics parameters.
Dataset name.
Jira parameters.
The base URL of the Jira site.
MariaDB parameters.
Host.
Port.
Database.
MySQL parameters.
Host.
Port.
Database.
Oracle parameters.
An Oracle host.
Port.
Database.
PostgreSQL parameters.
Host.
Port.
Database.
Presto parameters.
Host.
Port.
Catalog.
Amazon RDS parameters.
Instance ID.
Database.
Amazon Redshift parameters.
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.
S3 parameters.
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded in the console.
Amazon S3 bucket.
Amazon S3 key that identifies an object.
ServiceNow parameters.
URL of the base site.
Snowflake parameters.
Host.
Database.
Warehouse.
Spark parameters.
Host.
Port.
SQL Server parameters.
Host.
Port.
Database.
Teradata parameters.
Host.
Port.
Database.
Twitter parameters.
Twitter query string.
Maximum number of rows to query Twitter.
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.
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 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 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 AWS Region for each AWS account.
CreationStatus (string) --
The status of creating the data source.
RequestId (string) --
The AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
Exceptions
Creates an Amazon QuickSight group.
The permissions resource is ``arn:aws:quicksight:us-east-1:<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 AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
[REQUIRED]
The namespace. Currently, you should set this to default .
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 AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
Exceptions
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 AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
[REQUIRED]
The namespace. Currently, you should set this to default .
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 AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
Exceptions
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 AWS 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 AWS account where you want to assign an IAM policy to QuickSight users or groups.
[REQUIRED]
The name of the assignment, also called a rule. It must be unique within an AWS account.
[REQUIRED]
The status of the assignment. Possible values are as follows:
The 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 AWS account.
AssignmentId (string) --
The ID for the assignment.
AssignmentStatus (string) --
The status of the assignment. Possible values are as follows:
PolicyArn (string) --
The ARN for the IAM policy that is applied to the QuickSight users and groups specified in this assignment.
Identities (dict) --
The QuickSight users, groups, or both that the IAM policy is assigned to.
RequestId (string) --
The AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
Exceptions
Creates and starts a new SPICE ingestion on a dataset
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 AWS 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'
)
[REQUIRED]
The ID of the dataset used in the ingestion.
[REQUIRED]
An ID for the ingestion.
[REQUIRED]
The AWS 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 AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
Exceptions
(Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight.
A namespace allows you to isolate the 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 AWS account is subscribed to QuickSight. The namespace must be unique within the AWS account. By default, there is a limit of 100 namespaces per AWS account. To increase your limit, create a ticket with AWS 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 AWS account that you want to create the 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 QuickSight namespace you created.
Name (string) --
The name of the new namespace that you created.
CapacityRegion (string) --
The AWS 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 AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
Exceptions
Creates a template from an existing QuickSight analysis or template. You can use the resulting template to create a dashboard.
A template is an entity in 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
response = client.create_template(
AwsAccountId='string',
TemplateId='string',
Name='string',
Permissions=[
{
'Principal': 'string',
'Actions': [
'string',
]
},
],
SourceEntity={
'SourceAnalysis': {
'Arn': 'string',
'DataSetReferences': [
{
'DataSetPlaceholder': 'string',
'DataSetArn': 'string'
},
]
},
'SourceTemplate': {
'Arn': 'string'
}
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
VersionDescription='string'
)
[REQUIRED]
The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
[REQUIRED]
An ID for the template that you want to create. This template is unique per AWS Region in each AWS account.
A list of resource permissions to be set 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.
[REQUIRED]
The entity that you are using as a source when you create the template. In SourceEntity , you specify the type of object you're using as source: SourceTemplate for a template or SourceAnalysis for an analysis. Both of these require an Amazon Resource Name (ARN). For SourceTemplate , specify the ARN of the source template. For SourceAnalysis , specify the ARN of the source analysis. The SourceTemplate ARN can contain any AWS Account and any QuickSight-supported AWS Region.
Use the DataSetReferences entity within SourceTemplate or SourceAnalysis to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.
The source analysis, if it is based on an analysis.
The Amazon Resource Name (ARN) of the resource.
A structure containing information about the dataset references used as placeholders in the template.
Dataset reference.
Dataset placeholder.
Dataset Amazon Resource Name (ARN).
The source template, if it is based on an template.
The Amazon Resource Name (ARN) of the resource.
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
{
'Arn': 'string',
'VersionArn': 'string',
'TemplateId': 'string',
'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
Arn (string) --
The ARN for the template.
VersionArn (string) --
The ARN for the template, including the version information of the first version.
TemplateId (string) --
The ID of the template.
CreationStatus (string) --
The template creation status.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The AWS request ID for this operation.
Exceptions
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 AWS 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 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 AWS request ID for this operation.
Exceptions
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
}
}
}
},
Permissions=[
{
'Principal': 'string',
'Actions': [
'string',
]
},
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The ID of the AWS 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 AWS Region in each AWS 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 a QuickSight analysis.
[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.
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 AWS request ID for this operation.
Exceptions
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 AWS 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 AWS request ID for this operation.
Exceptions
Deletes all Amazon QuickSight customizations in this AWS Region for the specified AWS account and QuickSight namespace.
See also: AWS API Documentation
Request Syntax
response = client.delete_account_customization(
AwsAccountId='string',
Namespace='string'
)
[REQUIRED]
The ID for the AWS account that you want to delete QuickSight customizations from in this AWS Region.
dict
Response Syntax
{
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
RequestId (string) --
The AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
Exceptions
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. QuickSight attaches a DeletionTime stamp to the response that specifies the end of the recovery window. At the end of the recovery window, 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 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 AWS account where you want to delete an analysis.
[REQUIRED]
The ID of the analysis that you're deleting.
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 AWS request ID for this operation.
Exceptions
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 AWS 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 AWS request ID for this operation.
Exceptions
Deletes a dataset.
See also: AWS API Documentation
Request Syntax
response = client.delete_data_set(
AwsAccountId='string',
DataSetId='string'
)
[REQUIRED]
The AWS account ID.
[REQUIRED]
The ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS 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 AWS Region for each AWS account.
RequestId (string) --
The AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
Exceptions
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 AWS account ID.
[REQUIRED]
The ID of the data source. This ID is unique per AWS Region for each AWS 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 AWS Region for each AWS account.
RequestId (string) --
The AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
Exceptions
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 AWS account that the group is in. Currently, you use the ID for the AWS 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 AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
Exceptions
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 AWS account that the group is in. Currently, you use the ID for the AWS 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 AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
Exceptions
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 AWS 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 AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
Exceptions
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 AWS account that you want to delete the QuickSight namespace from.
[REQUIRED]
The namespace that you want to delete.
dict
Response Syntax
{
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
RequestId (string) --
The AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
Exceptions
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 AWS account that contains the template that you're deleting.
[REQUIRED]
An ID for the template you want to delete.
dict
Response Syntax
{
'RequestId': 'string',
'Arn': 'string',
'TemplateId': 'string',
'Status': 123
}
Response Structure
(dict) --
RequestId (string) --
The AWS 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
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 AWS 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 AWS request ID for this operation.
Exceptions
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 AWS 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 to DeleteTheme to 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 AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
ThemeId (string) --
An ID for the theme.
Exceptions
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 AWS 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 AWS 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
Deletes the Amazon QuickSight user that is associated with the identity of the AWS 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 AWS account that the user is in. Currently, you use the ID for the AWS 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 AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
Exceptions
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 AWS account that the user is in. Currently, you use the ID for the AWS 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 AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
Exceptions
Describes the customizations associated with the provided AWS account and Amazon QuickSight namespace in an AWS Region. The 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.
See also: AWS API Documentation
Request Syntax
response = client.describe_account_customization(
AwsAccountId='string',
Namespace='string',
Resolved=True|False
)
[REQUIRED]
The ID for the AWS account that you want to describe QuickSight customizations for.
dict
Response Syntax
{
'Arn': 'string',
'AwsAccountId': 'string',
'Namespace': 'string',
'AccountCustomization': {
'DefaultTheme': 'string'
},
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) of the customization that's associated with this AWS account.
AwsAccountId (string) --
The ID for the AWS account that you're describing.
Namespace (string) --
The QuickSight namespace that you're describing.
AccountCustomization (dict) --
The QuickSight customizations that exist in the current AWS Region.
DefaultTheme (string) --
The default theme for this QuickSight subscription.
RequestId (string) --
The AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
Exceptions
Describes the settings that were used when your QuickSight subscription was first created in this AWS account.
See also: AWS API Documentation
Request Syntax
response = client.describe_account_settings(
AwsAccountId='string'
)
[REQUIRED]
The ID for the AWS account that contains the settings that you want to list.
{
'AccountSettings': {
'AccountName': 'string',
'Edition': 'STANDARD'|'ENTERPRISE',
'DefaultNamespace': 'string',
'NotificationEmail': 'string'
},
'RequestId': 'string',
'Status': 123
}
Response Structure
The QuickSight settings for this AWS account. This information includes the edition of Amazon QuickSight that you subscribed to (Standard or Enterprise) and the notification email for the QuickSight subscription. In the QuickSight console, the 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 QuickSight service for your AWS account. The edition that you subscribe to applies to QuickSight in every AWS Region where you use it.
The "account name" you provided for the QuickSight subscription in your AWS account. You create this name when you sign up for QuickSight. It is unique in all of AWS and it appears only in the console when users sign in.
The edition of QuickSight that you're currently subscribed to: Enterprise edition or Standard edition.
The default QuickSight namespace for your AWS account.
The main notification email for your QuickSight subscription.
The AWS request ID for this operation.
The HTTP status of the request.
Exceptions
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 AWS account that contains the analysis. You must be using the AWS 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'
},
],
'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) --
A metadata error structure for an analysis.
Type (string) --
The type of the analysis error.
Message (string) --
The message associated with the analysis error.
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 the Amazon QuickSight console. 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 QuickSight console.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The AWS request ID for this operation.
Exceptions
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 AWS account that contains the analysis whose permissions you're describing. You must be using the AWS 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 AWS request ID for this operation.
Exceptions
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 AWS 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'
},
],
'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.
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 the Amazon QuickSight console. 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 QuickSight console.
CreatedTime (datetime) --
The time that this dataset was created.
LastPublishedTime (datetime) --
The last time that this dataset was published.
LastUpdatedTime (datetime) --
The last time that this dataset was updated.
Status (integer) --
The HTTP status of this request.
RequestId (string) --
The AWS request ID for this operation.
Exceptions
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 AWS 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'
}
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 AWS request ID for this operation.
Exceptions
Describes a dataset.
See also: AWS API Documentation
Request Syntax
response = client.describe_data_set(
AwsAccountId='string',
DataSetId='string'
)
[REQUIRED]
The AWS account ID.
[REQUIRED]
The ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS 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'
}
},
]
}
},
],
'Source': {
'JoinInstruction': {
'LeftOperand': 'string',
'RightOperand': 'string',
'LeftJoinKeyProperties': {
'UniqueKey': True|False
},
'RightJoinKeyProperties': {
'UniqueKey': True|False
},
'Type': 'INNER'|'OUTER'|'LEFT'|'RIGHT',
'OnClause': 'string'
},
'PhysicalTableId': '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'
},
'ColumnLevelPermissionRules': [
{
'Principals': [
'string',
],
'ColumnNames': [
'string',
]
},
]
},
'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 as S3 data source.
(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.
(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 AWS 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.
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 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 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.
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 interpretting 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.
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 QuickSight users or groups.
ColumnNames (list) --
An array of column names.
RequestId (string) --
The AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
Exceptions
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 AWS account ID.
[REQUIRED]
The ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS 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 AWS Region for each AWS 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 AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
Exceptions
Describes a data source.
See also: AWS API Documentation
Request Syntax
response = client.describe_data_source(
AwsAccountId='string',
DataSourceId='string'
)
[REQUIRED]
The AWS account ID.
[REQUIRED]
The ID of the data source. This ID is unique per AWS Region for each AWS 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',
'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'
},
'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
}
},
'AlternateDataSourceParameters': [
{
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': '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
}
},
],
'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'
}
},
'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 AWS Region for each AWS 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) --
Amazon Elasticsearch Service parameters.
Domain (string) --
The Amazon Elasticsearch Service domain.
AthenaParameters (dict) --
Amazon Athena parameters.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
AuroraParameters (dict) --
Amazon Aurora MySQL parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
AuroraPostgreSqlParameters (dict) --
Aurora PostgreSQL parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
AwsIotAnalyticsParameters (dict) --
AWS IoT Analytics parameters.
DataSetName (string) --
Dataset name.
JiraParameters (dict) --
Jira parameters.
SiteBaseUrl (string) --
The base URL of the Jira site.
MariaDbParameters (dict) --
MariaDB parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
MySqlParameters (dict) --
MySQL parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
OracleParameters (dict) --
Oracle parameters.
Host (string) --
An Oracle host.
Port (integer) --
Port.
Database (string) --
Database.
PostgreSqlParameters (dict) --
PostgreSQL parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
PrestoParameters (dict) --
Presto parameters.
Host (string) --
Host.
Port (integer) --
Port.
Catalog (string) --
Catalog.
RdsParameters (dict) --
Amazon RDS parameters.
InstanceId (string) --
Instance ID.
Database (string) --
Database.
RedshiftParameters (dict) --
Amazon Redshift parameters.
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) --
S3 parameters.
ManifestFileLocation (dict) --
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded in the console.
Bucket (string) --
Amazon S3 bucket.
Key (string) --
Amazon S3 key that identifies an object.
ServiceNowParameters (dict) --
ServiceNow parameters.
SiteBaseUrl (string) --
URL of the base site.
SnowflakeParameters (dict) --
Snowflake parameters.
Host (string) --
Host.
Database (string) --
Database.
Warehouse (string) --
Warehouse.
SparkParameters (dict) --
Spark parameters.
Host (string) --
Host.
Port (integer) --
Port.
SqlServerParameters (dict) --
SQL Server parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TeradataParameters (dict) --
Teradata parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TwitterParameters (dict) --
Twitter parameters.
Query (string) --
Twitter query string.
MaxRows (integer) --
Maximum number of rows to query Twitter.
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) --
Amazon Elasticsearch Service parameters.
Domain (string) --
The Amazon Elasticsearch Service domain.
AthenaParameters (dict) --
Amazon Athena parameters.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
AuroraParameters (dict) --
Amazon Aurora MySQL parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
AuroraPostgreSqlParameters (dict) --
Aurora PostgreSQL parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
AwsIotAnalyticsParameters (dict) --
AWS IoT Analytics parameters.
DataSetName (string) --
Dataset name.
JiraParameters (dict) --
Jira parameters.
SiteBaseUrl (string) --
The base URL of the Jira site.
MariaDbParameters (dict) --
MariaDB parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
MySqlParameters (dict) --
MySQL parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
OracleParameters (dict) --
Oracle parameters.
Host (string) --
An Oracle host.
Port (integer) --
Port.
Database (string) --
Database.
PostgreSqlParameters (dict) --
PostgreSQL parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
PrestoParameters (dict) --
Presto parameters.
Host (string) --
Host.
Port (integer) --
Port.
Catalog (string) --
Catalog.
RdsParameters (dict) --
Amazon RDS parameters.
InstanceId (string) --
Instance ID.
Database (string) --
Database.
RedshiftParameters (dict) --
Amazon Redshift parameters.
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) --
S3 parameters.
ManifestFileLocation (dict) --
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded in the console.
Bucket (string) --
Amazon S3 bucket.
Key (string) --
Amazon S3 key that identifies an object.
ServiceNowParameters (dict) --
ServiceNow parameters.
SiteBaseUrl (string) --
URL of the base site.
SnowflakeParameters (dict) --
Snowflake parameters.
Host (string) --
Host.
Database (string) --
Database.
Warehouse (string) --
Warehouse.
SparkParameters (dict) --
Spark parameters.
Host (string) --
Host.
Port (integer) --
Port.
SqlServerParameters (dict) --
SQL Server parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TeradataParameters (dict) --
Teradata parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TwitterParameters (dict) --
Twitter parameters.
Query (string) --
Twitter query string.
MaxRows (integer) --
Maximum number of rows to query Twitter.
VpcConnectionProperties (dict) --
The VPC connection information. You need to use this parameter only when you want 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 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.
RequestId (string) --
The AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
Exceptions
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 AWS account ID.
[REQUIRED]
The ID of the data source. This ID is unique per AWS Region for each AWS 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 AWS Region for each AWS 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 AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
Exceptions
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 AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
[REQUIRED]
The namespace. Currently, you should set this to default .
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 AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
Exceptions
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 AWS 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 AWS 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 AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
Exceptions
Describes a SPICE ingestion.
See also: AWS API Documentation
Request Syntax
response = client.describe_ingestion(
AwsAccountId='string',
DataSetId='string',
IngestionId='string'
)
[REQUIRED]
The AWS 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',
'Message': 'string'
},
'RowInfo': {
'RowsIngested': 123,
'RowsDropped': 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.
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 AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
Exceptions
Describes the current namespace.
See also: AWS API Documentation
Request Syntax
response = client.describe_namespace(
AwsAccountId='string',
Namespace='string'
)
[REQUIRED]
The ID for the AWS account that contains the 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, AWS 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 AWS 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 AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
Exceptions
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 AWS account that contains the template that you're describing.
[REQUIRED]
The ID for the template.
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'
},
],
'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.
VersionNumber (integer) --
The version number of the template version.
Status (string) --
The HTTP status of the request.
DataSetConfigurations (list) --
Schema of the dataset identified by the placeholder. Any dashboard created from this template should be bound to new datasets matching the same schema described through this API operation.
(dict) --
Dataset configuration.
Placeholder (string) --
Placeholder.
DataSetSchema (dict) --
Dataset schema.
ColumnSchemaList (list) --
A structure containing the list of column schemas.
(dict) --
The column schema.
Name (string) --
The name of the column schema.
DataType (string) --
The data type of the column schema.
GeographicRole (string) --
The geographic role of the column schema.
ColumnGroupSchemaList (list) --
A structure containing the list of column group schemas.
(dict) --
The column group schema.
Name (string) --
The name of the column group schema.
ColumnGroupColumnSchemaList (list) --
A structure containing the list of schemas for column group columns.
(dict) --
A structure describing the name, data type, and geographic role of the columns.
Name (string) --
The name of the column group's column schema.
Description (string) --
The description of the template.
SourceEntityArn (string) --
The Amazon Resource Name (ARN) of an analysis or template that was used to create this template.
ThemeArn (string) --
The ARN of the theme associated with this version of the template.
Sheets (list) --
A list of the associated sheets with the unique identifier and name of each sheet.
(dict) --
A sheet , which is an object that contains a set of visuals that are viewed together on one page in the Amazon QuickSight console. 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 QuickSight console.
TemplateId (string) --
The ID for the template. This is unique per AWS Region for each AWS 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 AWS request ID for this operation.
Exceptions
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 AWS 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 AWS request ID for this operation.
Exceptions
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 AWS 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 AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
Exceptions
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 AWS account that contains the theme that you're describing.
[REQUIRED]
The ID for the theme.
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
}
}
}
},
'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 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.
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 AWS request ID for this operation.
Exceptions
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 AWS 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 AWS request ID for this operation.
Exceptions
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 AWS 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 AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
Exceptions
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 AWS account that the user is in. Currently, you use the ID for the AWS 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.
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:.
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.
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 AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
Exceptions
Generate a presigned url given a client, its method, and arguments
The presigned url
Generates a session URL and authorization code that you can use to embed an Amazon QuickSight read-only dashboard in your web server code. 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 combination of URL and authorization code:
For more information, see Embedded Analytics in the Amazon QuickSight User Guide .
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 AWS account that contains the dashboard that you're embedding.
[REQUIRED]
The ID for the dashboard, also added to the AWS Identity and Access Management (IAM) policy.
[REQUIRED]
The authentication method that the user uses to sign in.
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.
A list of one or more dashboard IDs that you want to add to a session that includes anonymous users. The IdentityType parameter must be set to ANONYMOUS for this to work, because other identity types authenticate as 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 AWS request ID for this operation.
Exceptions
Create a paginator for an operation.
Generates a session URL and authorization code that you can use to embed the 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 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 AWS account associated with your QuickSight subscription.
The URL you use to access the embedded session. The entry point URL is constrained to the following paths:
The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type. You can use this for any type of Amazon QuickSight users in your account (readers, authors, or admins). They need to be authenticated as one of the following:
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 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 AWS request ID for this operation.
Exceptions
Returns an object that can wait for some condition.
Lists Amazon QuickSight analyses that exist in the specified AWS account.
See also: AWS API Documentation
Request Syntax
response = client.list_analyses(
AwsAccountId='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The ID of the AWS 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 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 AWS request ID for this operation.
Exceptions
Lists all the versions of the dashboards in the 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 AWS 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 AWS request ID for this operation.
Exceptions
Lists dashboards in an AWS account.
See also: AWS API Documentation
Request Syntax
response = client.list_dashboards(
AwsAccountId='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The ID of the AWS 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 AWS 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 AWS request ID for this operation.
Exceptions
Lists all of the datasets belonging to the current AWS account in an AWS 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 AWS 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'
},
'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 interpretting 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.
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 AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
Exceptions
Lists data sources in current AWS Region that belong to this AWS account.
See also: AWS API Documentation
Request Syntax
response = client.list_data_sources(
AwsAccountId='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The AWS 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',
'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'
},
'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
}
},
'AlternateDataSourceParameters': [
{
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': '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
}
},
],
'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'
}
},
],
'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 AWS Region for each AWS 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) --
Amazon Elasticsearch Service parameters.
Domain (string) --
The Amazon Elasticsearch Service domain.
AthenaParameters (dict) --
Amazon Athena parameters.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
AuroraParameters (dict) --
Amazon Aurora MySQL parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
AuroraPostgreSqlParameters (dict) --
Aurora PostgreSQL parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
AwsIotAnalyticsParameters (dict) --
AWS IoT Analytics parameters.
DataSetName (string) --
Dataset name.
JiraParameters (dict) --
Jira parameters.
SiteBaseUrl (string) --
The base URL of the Jira site.
MariaDbParameters (dict) --
MariaDB parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
MySqlParameters (dict) --
MySQL parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
OracleParameters (dict) --
Oracle parameters.
Host (string) --
An Oracle host.
Port (integer) --
Port.
Database (string) --
Database.
PostgreSqlParameters (dict) --
PostgreSQL parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
PrestoParameters (dict) --
Presto parameters.
Host (string) --
Host.
Port (integer) --
Port.
Catalog (string) --
Catalog.
RdsParameters (dict) --
Amazon RDS parameters.
InstanceId (string) --
Instance ID.
Database (string) --
Database.
RedshiftParameters (dict) --
Amazon Redshift parameters.
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) --
S3 parameters.
ManifestFileLocation (dict) --
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded in the console.
Bucket (string) --
Amazon S3 bucket.
Key (string) --
Amazon S3 key that identifies an object.
ServiceNowParameters (dict) --
ServiceNow parameters.
SiteBaseUrl (string) --
URL of the base site.
SnowflakeParameters (dict) --
Snowflake parameters.
Host (string) --
Host.
Database (string) --
Database.
Warehouse (string) --
Warehouse.
SparkParameters (dict) --
Spark parameters.
Host (string) --
Host.
Port (integer) --
Port.
SqlServerParameters (dict) --
SQL Server parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TeradataParameters (dict) --
Teradata parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TwitterParameters (dict) --
Twitter parameters.
Query (string) --
Twitter query string.
MaxRows (integer) --
Maximum number of rows to query Twitter.
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) --
Amazon Elasticsearch Service parameters.
Domain (string) --
The Amazon Elasticsearch Service domain.
AthenaParameters (dict) --
Amazon Athena parameters.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
AuroraParameters (dict) --
Amazon Aurora MySQL parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
AuroraPostgreSqlParameters (dict) --
Aurora PostgreSQL parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
AwsIotAnalyticsParameters (dict) --
AWS IoT Analytics parameters.
DataSetName (string) --
Dataset name.
JiraParameters (dict) --
Jira parameters.
SiteBaseUrl (string) --
The base URL of the Jira site.
MariaDbParameters (dict) --
MariaDB parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
MySqlParameters (dict) --
MySQL parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
OracleParameters (dict) --
Oracle parameters.
Host (string) --
An Oracle host.
Port (integer) --
Port.
Database (string) --
Database.
PostgreSqlParameters (dict) --
PostgreSQL parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
PrestoParameters (dict) --
Presto parameters.
Host (string) --
Host.
Port (integer) --
Port.
Catalog (string) --
Catalog.
RdsParameters (dict) --
Amazon RDS parameters.
InstanceId (string) --
Instance ID.
Database (string) --
Database.
RedshiftParameters (dict) --
Amazon Redshift parameters.
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) --
S3 parameters.
ManifestFileLocation (dict) --
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded in the console.
Bucket (string) --
Amazon S3 bucket.
Key (string) --
Amazon S3 key that identifies an object.
ServiceNowParameters (dict) --
ServiceNow parameters.
SiteBaseUrl (string) --
URL of the base site.
SnowflakeParameters (dict) --
Snowflake parameters.
Host (string) --
Host.
Database (string) --
Database.
Warehouse (string) --
Warehouse.
SparkParameters (dict) --
Spark parameters.
Host (string) --
Host.
Port (integer) --
Port.
SqlServerParameters (dict) --
SQL Server parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TeradataParameters (dict) --
Teradata parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TwitterParameters (dict) --
Twitter parameters.
Query (string) --
Twitter query string.
MaxRows (integer) --
Maximum number of rows to query Twitter.
VpcConnectionProperties (dict) --
The VPC connection information. You need to use this parameter only when you want 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 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.
NextToken (string) --
The token for the next set of results, or null if there are no more results.
RequestId (string) --
The AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
Exceptions
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 AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
[REQUIRED]
The namespace. Currently, you should set this to default .
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 AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
Exceptions
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 AWS account that the group is in. Currently, you use the ID for the AWS 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 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 AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
Exceptions
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 AWS 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 AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
Exceptions
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 AWS 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 AWS 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 AWS 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
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 AWS 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',
'Message': 'string'
},
'RowInfo': {
'RowsIngested': 123,
'RowsDropped': 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.
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 AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
Exceptions
Lists the namespaces for the specified AWS account.
See also: AWS API Documentation
Request Syntax
response = client.list_namespaces(
AwsAccountId='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The ID for the AWS account that contains the QuickSight namespaces that you want to list.
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 AWS account. The response includes the namespace ARN, name, AWS 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 AWS 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 pagination token that can be used in a subsequent request.
RequestId (string) --
The AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
Exceptions
Lists 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 AWS request ID for this operation.
The HTTP status of the request.
Exceptions
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 AWS 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 AWS request ID for this operation.
NextToken (string) --
The token for the next set of results, or null if there are no more results.
Exceptions
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 AWS 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 AWS request ID for this operation.
Exceptions
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 AWS 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 AWS Region for each AWS 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 AWS request ID for this operation.
Exceptions
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 AWS 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 AWS request ID for this operation.
NextToken (string) --
The token for the next set of results, or null if there are no more results.
Exceptions
Lists all the versions of the themes in the current AWS 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 AWS 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 AWS request ID for this operation.
Exceptions
Lists all the themes in the current AWS 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 AWS account that contains the themes that you're listing.
The type of themes that you want to list. Valid options include the following:
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 AWS Region for each AWS 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 AWS request ID for this operation.
Exceptions
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 AWS account ID that the user is in. Currently, you use the ID for the AWS 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 AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
Exceptions
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 AWS account that the user is in. Currently, you use the ID for the AWS 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.
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:.
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.
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 AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
Exceptions
Creates an Amazon QuickSight user, whose identity is associated with the AWS Identity and Access Management (IAM) identity or role specified in the request.
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:
[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:
[REQUIRED]
The ID for the AWS account that the user is in. Currently, you use the ID for the AWS 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 QuickSight console. Then, you use the RegisterUser API operation to assign the named set of permissions to a QuickSight user.
QuickSight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning QuickSight users to one of the default security cohorts in QuickSight (admin, author, reader).
This feature is available only to QuickSight Enterprise edition subscriptions that use SAML 2.0-Based Federation for Single Sign-On (SSO).
The type of supported external login provider that provides identity to let a user federate into Amazon QuickSight with an associated AWS Identity and Access Management (IAM) role. The type of supported external login provider can be one of the following.
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.
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:.
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.
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 AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
Exceptions
Restores an analysis.
See also: AWS API Documentation
Request Syntax
response = client.restore_analysis(
AwsAccountId='string',
AnalysisId='string'
)
[REQUIRED]
The ID of the AWS 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 AWS request ID for this operation.
Exceptions
Searches for analyses that belong to the user specified in the filter.
See also: AWS API Documentation
Request Syntax
response = client.search_analyses(
AwsAccountId='string',
Filters=[
{
'Operator': 'StringEquals',
'Name': 'QUICKSIGHT_USER',
'Value': 'string'
},
],
NextToken='string',
MaxResults=123
)
[REQUIRED]
The ID of the AWS 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" .
The name of the value that you want to use as a filter, for example "Name": "QUICKSIGHT_USER" .
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 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 AWS request ID for this operation.
Exceptions
Searches for dashboards that belong to a user.
See also: AWS API Documentation
Request Syntax
response = client.search_dashboards(
AwsAccountId='string',
Filters=[
{
'Operator': 'StringEquals',
'Name': 'QUICKSIGHT_USER',
'Value': 'string'
},
],
NextToken='string',
MaxResults=123
)
[REQUIRED]
The ID of the AWS 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" .
The name of the value that you want to use as a filter, for example, "Name": "QUICKSIGHT_USER" .
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 AWS request ID for this operation.
Exceptions
Assigns one or more tags (key-value pairs) to the specified 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. QuickSight supports tagging on data set, data source, dashboard, and template.
Tagging for QuickSight works in a similar way to tagging for other AWS 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 AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
Exceptions
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 AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
Exceptions
Updates Amazon QuickSight customizations the current AWS Region. Currently, the only customization you can use is a theme.
You can use customizations for your AWS account or, if you specify a namespace, for a QuickSight namespace instead. Customizations that apply to a namespace override customizations that apply to an AWS 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'
}
)
[REQUIRED]
The ID for the AWS account that you want to update QuickSight customizations for.
[REQUIRED]
The QuickSight customizations you're updating in the current AWS Region.
The default theme for this QuickSight subscription.
dict
Response Syntax
{
'Arn': 'string',
'AwsAccountId': 'string',
'Namespace': 'string',
'AccountCustomization': {
'DefaultTheme': 'string'
},
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) for the updated customization for this AWS account.
AwsAccountId (string) --
The ID for the AWS account that you want to update QuickSight customizations for.
Namespace (string) --
The namespace associated with the customization that you're updating.
AccountCustomization (dict) --
The QuickSight customizations you're updating in the current AWS Region.
DefaultTheme (string) --
The default theme for this QuickSight subscription.
RequestId (string) --
The AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
Exceptions
Updates the Amazon QuickSight settings in your AWS account.
See also: AWS API Documentation
Request Syntax
response = client.update_account_settings(
AwsAccountId='string',
DefaultNamespace='string',
NotificationEmail='string'
)
[REQUIRED]
The ID for the AWS account that contains the QuickSight settings that you want to list.
[REQUIRED]
The default namespace for this AWS account. Currently, the default is default . AWS Identity and Access Management (IAM) users that register for the first time with QuickSight provide an email that becomes associated with the default namespace.
dict
Response Syntax
{
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
RequestId (string) --
The AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
Exceptions
Updates an analysis in Amazon QuickSight
See also: AWS API Documentation
Request Syntax
response = client.update_analysis(
AwsAccountId='string',
AnalysisId='string',
Name='string',
Parameters={
'StringParameters': [
{
'Name': 'string',
'Values': [
'string',
]
},
],
'IntegerParameters': [
{
'Name': 'string',
'Values': [
123,
]
},
],
'DecimalParameters': [
{
'Name': 'string',
'Values': [
123.0,
]
},
],
'DateTimeParameters': [
{
'Name': 'string',
'Values': [
datetime(2015, 1, 1),
]
},
]
},
SourceEntity={
'SourceTemplate': {
'DataSetReferences': [
{
'DataSetPlaceholder': 'string',
'DataSetArn': 'string'
},
],
'Arn': 'string'
}
},
ThemeArn='string'
)
[REQUIRED]
The ID of the AWS account that contains the analysis that you're updating.
[REQUIRED]
The ID for the analysis that you're updating. This ID displays in the URL of the analysis.
[REQUIRED]
A descriptive name for the analysis that you're updating. This name displays for the analysis in the QuickSight console.
The parameter names and override values that you want to use. An analysis can have any parameter type, and some parameters might accept multiple values.
String parameters.
A string parameter.
A display name for a string parameter.
The values of a string parameter.
Integer parameters.
An integer parameter.
The name of the integer parameter.
The values for the integer parameter.
Decimal parameters.
A decimal parameter.
A display name for the decimal parameter.
The values for the decimal parameter.
Date-time parameters.
A date-time parameter.
A display name for the date-time parameter.
The values for the date-time parameter.
[REQUIRED]
A source entity to use for the analysis that you're updating. This metadata structure contains details that describe a source template and one or more datasets.
The source template for the source entity of the analysis.
The dataset references of the source template of an analysis.
Dataset reference.
Dataset placeholder.
Dataset Amazon Resource Name (ARN).
The Amazon Resource Name (ARN) of the source template of an analysis.
dict
Response Syntax
{
'Arn': 'string',
'AnalysisId': 'string',
'UpdateStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
Arn (string) --
The ARN of the analysis that you're updating.
AnalysisId (string) --
The ID of the analysis.
UpdateStatus (string) --
The update status of the last update that was made to the analysis.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The AWS request ID for this operation.
Exceptions
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 AWS account that contains the analysis whose permissions you're updating. You must be using the AWS 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 AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
Exceptions
Updates a dashboard in an AWS account.
See also: AWS API Documentation
Request Syntax
response = client.update_dashboard(
AwsAccountId='string',
DashboardId='string',
Name='string',
SourceEntity={
'SourceTemplate': {
'DataSetReferences': [
{
'DataSetPlaceholder': 'string',
'DataSetArn': 'string'
},
],
'Arn': 'string'
}
},
Parameters={
'StringParameters': [
{
'Name': 'string',
'Values': [
'string',
]
},
],
'IntegerParameters': [
{
'Name': 'string',
'Values': [
123,
]
},
],
'DecimalParameters': [
{
'Name': 'string',
'Values': [
123.0,
]
},
],
'DateTimeParameters': [
{
'Name': 'string',
'Values': [
datetime(2015, 1, 1),
]
},
]
},
VersionDescription='string',
DashboardPublishOptions={
'AdHocFilteringOption': {
'AvailabilityStatus': 'ENABLED'|'DISABLED'
},
'ExportToCSVOption': {
'AvailabilityStatus': 'ENABLED'|'DISABLED'
},
'SheetControlsOption': {
'VisibilityState': 'EXPANDED'|'COLLAPSED'
}
},
ThemeArn='string'
)
[REQUIRED]
The ID of the AWS account that contains the dashboard that you're updating.
[REQUIRED]
The ID for the dashboard.
[REQUIRED]
The display name of the dashboard.
[REQUIRED]
The entity that you are using as a source when you update the dashboard. In SourceEntity , you specify the type of object you're using as source. You can only update a dashboard from a template, so you use a SourceTemplate entity. If you need to update a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate API operation. For SourceTemplate , specify the Amazon Resource Name (ARN) of the source template. The SourceTemplate ARN can contain any AWS Account and any QuickSight-supported AWS Region.
Use the DataSetReferences entity within SourceTemplate to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.
Source template.
Dataset references.
Dataset reference.
Dataset placeholder.
Dataset Amazon Resource Name (ARN).
The Amazon Resource Name (ARN) of the resource.
A structure that contains the parameters of the dashboard. These are parameter overrides for a dashboard. A dashboard can have any type of parameters, and some parameters might accept multiple values.
String parameters.
A string parameter.
A display name for a string parameter.
The values of a string parameter.
Integer parameters.
An integer parameter.
The name of the integer parameter.
The values for the integer parameter.
Decimal parameters.
A decimal parameter.
A display name for the decimal parameter.
The values for the decimal parameter.
Date-time parameters.
A date-time parameter.
A display name for the date-time parameter.
The values for the date-time parameter.
Options for publishing the dashboard when you create it:
Ad hoc (one-time) filtering option.
Availability status.
Export to .csv option.
Availability status.
Sheet controls option.
Visibility state.
dict
Response Syntax
{
'Arn': 'string',
'VersionArn': 'string',
'DashboardId': 'string',
'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) of the resource.
VersionArn (string) --
The ARN of the dashboard, including the version number.
DashboardId (string) --
The ID for the dashboard.
CreationStatus (string) --
The creation status of the request.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The AWS request ID for this operation.
Exceptions
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',
]
},
]
)
[REQUIRED]
The ID of the AWS 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.
dict
Response Syntax
{
'DashboardArn': 'string',
'DashboardId': 'string',
'Permissions': [
{
'Principal': 'string',
'Actions': [
'string',
]
},
],
'RequestId': 'string',
'Status': 123
}
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 AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
Exceptions
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 AWS 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 AWS request ID for this operation.
Exceptions
Updates a dataset.
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'
}
},
]
}
},
],
'Source': {
'JoinInstruction': {
'LeftOperand': 'string',
'RightOperand': 'string',
'LeftJoinKeyProperties': {
'UniqueKey': True|False
},
'RightJoinKeyProperties': {
'UniqueKey': True|False
},
'Type': 'INNER'|'OUTER'|'LEFT'|'RIGHT',
'OnClause': 'string'
},
'PhysicalTableId': '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'
},
ColumnLevelPermissionRules=[
{
'Principals': [
'string',
],
'ColumnNames': [
'string',
]
},
]
)
[REQUIRED]
The AWS account ID.
[REQUIRED]
The ID for the dataset that you want to update. This ID is unique per AWS Region for each AWS 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 as S3 data source.
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.
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 AWS 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.
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 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 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.
[REQUIRED]
Indicates whether you want to import the data into SPICE.
Groupings of columns that work together in certain 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 interpretting 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.
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 QuickSight users or groups.
An array of column names.
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 AWS Region for each AWS 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 AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
Exceptions
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 AWS account ID.
[REQUIRED]
The ID for the dataset whose permissions you want to update. This ID is unique per AWS Region for each AWS 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 AWS Region for each AWS account.
RequestId (string) --
The AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
Exceptions
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'
},
'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
}
},
Credentials={
'CredentialPair': {
'Username': 'string',
'Password': 'string',
'AlternateDataSourceParameters': [
{
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': '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
}
},
]
},
'CopySourceArn': 'string'
},
VpcConnectionProperties={
'VpcConnectionArn': 'string'
},
SslProperties={
'DisableSsl': True|False
}
)
[REQUIRED]
The AWS account ID.
[REQUIRED]
The ID of the data source. This ID is unique per AWS Region for each AWS account.
[REQUIRED]
A display name for the data source.
The parameters that QuickSight uses to connect to your underlying source.
Amazon Elasticsearch Service parameters.
The Amazon Elasticsearch Service domain.
Amazon Athena parameters.
The workgroup that Amazon Athena uses.
Amazon Aurora MySQL parameters.
Host.
Port.
Database.
Aurora PostgreSQL parameters.
Host.
Port.
Database.
AWS IoT Analytics parameters.
Dataset name.
Jira parameters.
The base URL of the Jira site.
MariaDB parameters.
Host.
Port.
Database.
MySQL parameters.
Host.
Port.
Database.
Oracle parameters.
An Oracle host.
Port.
Database.
PostgreSQL parameters.
Host.
Port.
Database.
Presto parameters.
Host.
Port.
Catalog.
Amazon RDS parameters.
Instance ID.
Database.
Amazon Redshift parameters.
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.
S3 parameters.
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded in the console.
Amazon S3 bucket.
Amazon S3 key that identifies an object.
ServiceNow parameters.
URL of the base site.
Snowflake parameters.
Host.
Database.
Warehouse.
Spark parameters.
Host.
Port.
SQL Server parameters.
Host.
Port.
Database.
Teradata parameters.
Host.
Port.
Database.
Twitter parameters.
Twitter query string.
Maximum number of rows to query Twitter.
The credentials that 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.
Amazon Elasticsearch Service parameters.
The Amazon Elasticsearch Service domain.
Amazon Athena parameters.
The workgroup that Amazon Athena uses.
Amazon Aurora MySQL parameters.
Host.
Port.
Database.
Aurora PostgreSQL parameters.
Host.
Port.
Database.
AWS IoT Analytics parameters.
Dataset name.
Jira parameters.
The base URL of the Jira site.
MariaDB parameters.
Host.
Port.
Database.
MySQL parameters.
Host.
Port.
Database.
Oracle parameters.
An Oracle host.
Port.
Database.
PostgreSQL parameters.
Host.
Port.
Database.
Presto parameters.
Host.
Port.
Catalog.
Amazon RDS parameters.
Instance ID.
Database.
Amazon Redshift parameters.
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.
S3 parameters.
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded in the console.
Amazon S3 bucket.
Amazon S3 key that identifies an object.
ServiceNow parameters.
URL of the base site.
Snowflake parameters.
Host.
Database.
Warehouse.
Spark parameters.
Host.
Port.
SQL Server parameters.
Host.
Port.
Database.
Teradata parameters.
Host.
Port.
Database.
Twitter parameters.
Twitter query string.
Maximum number of rows to query Twitter.
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.
Use this parameter only when you want 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 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 AWS Region for each AWS account.
UpdateStatus (string) --
The update status of the data source's last update.
RequestId (string) --
The AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
Exceptions
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 AWS account ID.
[REQUIRED]
The ID of the data source. This ID is unique per AWS Region for each AWS 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 AWS Region for each AWS account.
RequestId (string) --
The AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
Exceptions
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 AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
[REQUIRED]
The namespace. Currently, you should set this to default .
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 AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
Exceptions
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 AWS account that contains the IAM policy assignment.
[REQUIRED]
The name of the assignment, also called a rule. This name must be unique within an AWS account.
[REQUIRED]
The namespace of the assignment.
The status of the assignment. Possible values are as follows:
The 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 QuickSight users and groups specified in this assignment.
Identities (dict) --
The QuickSight users, groups, or both that the IAM policy is assigned to.
AssignmentStatus (string) --
The status of the assignment. Possible values are as follows:
RequestId (string) --
The AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
Exceptions
Updates a template from an existing Amazon QuickSight analysis or another template.
See also: AWS API Documentation
Request Syntax
response = client.update_template(
AwsAccountId='string',
TemplateId='string',
SourceEntity={
'SourceAnalysis': {
'Arn': 'string',
'DataSetReferences': [
{
'DataSetPlaceholder': 'string',
'DataSetArn': 'string'
},
]
},
'SourceTemplate': {
'Arn': 'string'
}
},
VersionDescription='string',
Name='string'
)
[REQUIRED]
The ID of the AWS account that contains the template that you're updating.
[REQUIRED]
The ID for the template.
[REQUIRED]
The entity that you are using as a source when you update the template. In SourceEntity , you specify the type of object you're using as source: SourceTemplate for a template or SourceAnalysis for an analysis. Both of these require an Amazon Resource Name (ARN). For SourceTemplate , specify the ARN of the source template. For SourceAnalysis , specify the ARN of the source analysis. The SourceTemplate ARN can contain any AWS Account and any QuickSight-supported AWS Region.
Use the DataSetReferences entity within SourceTemplate or SourceAnalysis to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.
The source analysis, if it is based on an analysis.
The Amazon Resource Name (ARN) of the resource.
A structure containing information about the dataset references used as placeholders in the template.
Dataset reference.
Dataset placeholder.
Dataset Amazon Resource Name (ARN).
The source template, if it is based on an template.
The Amazon Resource Name (ARN) of the resource.
dict
Response Syntax
{
'TemplateId': 'string',
'Arn': 'string',
'VersionArn': 'string',
'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
TemplateId (string) --
The ID for the template.
Arn (string) --
The Amazon Resource Name (ARN) for the template.
VersionArn (string) --
The ARN for the template, including the version information of the first version.
CreationStatus (string) --
The creation status of the template.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The AWS request ID for this operation.
Exceptions
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 AWS 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 AWS request ID for this operation.
Exceptions
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 AWS 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 AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
Exceptions
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
}
}
}
}
)
[REQUIRED]
The ID of the AWS 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 QuickSight theme.
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.
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 AWS request ID for this operation.
Exceptions
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 AWS 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 AWS request ID for this operation.
Exceptions
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:
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 AWS 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 AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
Exceptions
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 AWS account that the user is in. Currently, you use the ID for the AWS 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:
The name of the 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 QuickSight console. Then, you use the RegisterUser API operation to assign the named set of permissions to a QuickSight user.
QuickSight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning QuickSight users to one of the default security cohorts in QuickSight (admin, author, reader).
This feature is available only to QuickSight Enterprise edition subscriptions that use SAML 2.0-Based Federation for Single Sign-On (SSO).
The type of supported external login provider that provides identity to let a user federate into QuickSight with an associated AWS Identity and Access Management (IAM) role. The type of supported external login provider can be one of the following.
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.
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:.
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.
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 AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
Exceptions
The available paginators are:
paginator = client.get_paginator('list_analyses')
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 AWS 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 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 AWS request ID for this operation.
paginator = client.get_paginator('list_dashboard_versions')
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 AWS 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 AWS request ID for this operation.
paginator = client.get_paginator('list_dashboards')
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 AWS 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 AWS 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 AWS request ID for this operation.
paginator = client.get_paginator('list_data_sets')
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 AWS 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'
},
'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 interpretting 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.
ColumnLevelPermissionRulesApplied (boolean) --
A value that indicates if the dataset has column level permission configured.
RequestId (string) --
The AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
paginator = client.get_paginator('list_data_sources')
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 AWS 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',
'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'
},
'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
}
},
'AlternateDataSourceParameters': [
{
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': '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
}
},
],
'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'
}
},
],
'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 AWS Region for each AWS 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) --
Amazon Elasticsearch Service parameters.
Domain (string) --
The Amazon Elasticsearch Service domain.
AthenaParameters (dict) --
Amazon Athena parameters.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
AuroraParameters (dict) --
Amazon Aurora MySQL parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
AuroraPostgreSqlParameters (dict) --
Aurora PostgreSQL parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
AwsIotAnalyticsParameters (dict) --
AWS IoT Analytics parameters.
DataSetName (string) --
Dataset name.
JiraParameters (dict) --
Jira parameters.
SiteBaseUrl (string) --
The base URL of the Jira site.
MariaDbParameters (dict) --
MariaDB parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
MySqlParameters (dict) --
MySQL parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
OracleParameters (dict) --
Oracle parameters.
Host (string) --
An Oracle host.
Port (integer) --
Port.
Database (string) --
Database.
PostgreSqlParameters (dict) --
PostgreSQL parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
PrestoParameters (dict) --
Presto parameters.
Host (string) --
Host.
Port (integer) --
Port.
Catalog (string) --
Catalog.
RdsParameters (dict) --
Amazon RDS parameters.
InstanceId (string) --
Instance ID.
Database (string) --
Database.
RedshiftParameters (dict) --
Amazon Redshift parameters.
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) --
S3 parameters.
ManifestFileLocation (dict) --
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded in the console.
Bucket (string) --
Amazon S3 bucket.
Key (string) --
Amazon S3 key that identifies an object.
ServiceNowParameters (dict) --
ServiceNow parameters.
SiteBaseUrl (string) --
URL of the base site.
SnowflakeParameters (dict) --
Snowflake parameters.
Host (string) --
Host.
Database (string) --
Database.
Warehouse (string) --
Warehouse.
SparkParameters (dict) --
Spark parameters.
Host (string) --
Host.
Port (integer) --
Port.
SqlServerParameters (dict) --
SQL Server parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TeradataParameters (dict) --
Teradata parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TwitterParameters (dict) --
Twitter parameters.
Query (string) --
Twitter query string.
MaxRows (integer) --
Maximum number of rows to query Twitter.
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) --
Amazon Elasticsearch Service parameters.
Domain (string) --
The Amazon Elasticsearch Service domain.
AthenaParameters (dict) --
Amazon Athena parameters.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
AuroraParameters (dict) --
Amazon Aurora MySQL parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
AuroraPostgreSqlParameters (dict) --
Aurora PostgreSQL parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
AwsIotAnalyticsParameters (dict) --
AWS IoT Analytics parameters.
DataSetName (string) --
Dataset name.
JiraParameters (dict) --
Jira parameters.
SiteBaseUrl (string) --
The base URL of the Jira site.
MariaDbParameters (dict) --
MariaDB parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
MySqlParameters (dict) --
MySQL parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
OracleParameters (dict) --
Oracle parameters.
Host (string) --
An Oracle host.
Port (integer) --
Port.
Database (string) --
Database.
PostgreSqlParameters (dict) --
PostgreSQL parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
PrestoParameters (dict) --
Presto parameters.
Host (string) --
Host.
Port (integer) --
Port.
Catalog (string) --
Catalog.
RdsParameters (dict) --
Amazon RDS parameters.
InstanceId (string) --
Instance ID.
Database (string) --
Database.
RedshiftParameters (dict) --
Amazon Redshift parameters.
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) --
S3 parameters.
ManifestFileLocation (dict) --
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded in the console.
Bucket (string) --
Amazon S3 bucket.
Key (string) --
Amazon S3 key that identifies an object.
ServiceNowParameters (dict) --
ServiceNow parameters.
SiteBaseUrl (string) --
URL of the base site.
SnowflakeParameters (dict) --
Snowflake parameters.
Host (string) --
Host.
Database (string) --
Database.
Warehouse (string) --
Warehouse.
SparkParameters (dict) --
Spark parameters.
Host (string) --
Host.
Port (integer) --
Port.
SqlServerParameters (dict) --
SQL Server parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TeradataParameters (dict) --
Teradata parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TwitterParameters (dict) --
Twitter parameters.
Query (string) --
Twitter query string.
MaxRows (integer) --
Maximum number of rows to query Twitter.
VpcConnectionProperties (dict) --
The VPC connection information. You need to use this parameter only when you want 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 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.
RequestId (string) --
The AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
paginator = client.get_paginator('list_ingestions')
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 AWS 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',
'Message': 'string'
},
'RowInfo': {
'RowsIngested': 123,
'RowsDropped': 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.
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 AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
paginator = client.get_paginator('list_namespaces')
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 AWS account that contains the 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 AWS account. The response includes the namespace ARN, name, AWS 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 AWS 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 AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
paginator = client.get_paginator('list_template_aliases')
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 AWS 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 AWS request ID for this operation.
paginator = client.get_paginator('list_template_versions')
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 AWS 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 AWS request ID for this operation.
paginator = client.get_paginator('list_templates')
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 AWS 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 AWS Region for each AWS 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 AWS request ID for this operation.
paginator = client.get_paginator('list_theme_versions')
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 AWS 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 AWS request ID for this operation.
paginator = client.get_paginator('list_themes')
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 AWS account that contains the themes that you're listing.
The type of themes that you want to list. Valid options include the following:
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 AWS Region for each AWS 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 AWS request ID for this operation.
paginator = client.get_paginator('search_analyses')
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',
'Name': 'QUICKSIGHT_USER',
'Value': 'string'
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The ID of the AWS 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" .
The name of the value that you want to use as a filter, for example "Name": "QUICKSIGHT_USER" .
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 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 AWS request ID for this operation.
paginator = client.get_paginator('search_dashboards')
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',
'Name': 'QUICKSIGHT_USER',
'Value': 'string'
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The ID of the AWS 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" .
The name of the value that you want to use as a filter, for example, "Name": "QUICKSIGHT_USER" .
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 AWS request ID for this operation.