2025/03/28 - Amazon QuickSight - 25 updated api methods
Changes RLS permission dataset with userAs: RLS_RULES flag, Q in QuickSight/Threshold Alerts/Schedules/Snapshots in QS embedding, toggle dataset refresh email alerts via API, transposed table with options: column width, type and index, toggle Q&A on dashboards, Oracle Service Name when creating data source.
{'Definition': {'Options': {'ExcludedDataSetArns': ['string'],
'QBusinessInsightsStatus': 'ENABLED | DISABLED'},
'Sheets': {'Visuals': {'TableVisual': {'ChartConfiguration': {'FieldOptions': {'TransposedTableOptions': [{'ColumnIndex': 'integer',
'ColumnType': 'ROW_HEADER_COLUMN '
'| '
'VALUE_COLUMN',
'ColumnWidth': 'string'}]}}}}}}}
Creates an analysis in Amazon QuickSight. Analyses can be created either from a template or from an AnalysisDefinition.
See also: AWS API Documentation
Request Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.Parameters
# This section is too large to render. # Please see the AWS API Documentation linked below.
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 Amazon Web Services request ID for this operation.
{'DashboardPublishOptions': {'DataQAEnabledOption': {'AvailabilityStatus': 'ENABLED '
'| '
'DISABLED'}},
'Definition': {'Options': {'ExcludedDataSetArns': ['string'],
'QBusinessInsightsStatus': 'ENABLED | DISABLED'},
'Sheets': {'Visuals': {'TableVisual': {'ChartConfiguration': {'FieldOptions': {'TransposedTableOptions': [{'ColumnIndex': 'integer',
'ColumnType': 'ROW_HEADER_COLUMN '
'| '
'VALUE_COLUMN',
'ColumnWidth': 'string'}]}}}}}}}
Creates a dashboard from either a template or directly with a DashboardDefinition. To first create a template, see the CreateTemplate API operation.
A dashboard is an entity in Amazon QuickSight that identifies Amazon QuickSight reports, created from analyses. You can share Amazon QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.Parameters
# This section is too large to render. # Please see the AWS API Documentation linked below.
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 Amazon Web Services request ID for this operation.
{'UseAs': 'RLS_RULES'}
Creates a dataset. This operation doesn't support datasets that include uploaded files as a source.
See also: AWS API Documentation
Request Syntax
client.create_data_set(
AwsAccountId='string',
DataSetId='string',
Name='string',
PhysicalTableMap={
'string': {
'RelationalTable': {
'DataSourceArn': 'string',
'Catalog': 'string',
'Schema': 'string',
'Name': 'string',
'InputColumns': [
{
'Name': 'string',
'Type': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME'|'BIT'|'BOOLEAN'|'JSON',
'SubType': 'FLOAT'|'FIXED'
},
]
},
'CustomSql': {
'DataSourceArn': 'string',
'Name': 'string',
'SqlQuery': 'string',
'Columns': [
{
'Name': 'string',
'Type': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME'|'BIT'|'BOOLEAN'|'JSON',
'SubType': 'FLOAT'|'FIXED'
},
]
},
'S3Source': {
'DataSourceArn': 'string',
'UploadSettings': {
'Format': 'CSV'|'TSV'|'CLF'|'ELF'|'XLSX'|'JSON',
'StartFromRow': 123,
'ContainsHeader': True|False,
'TextQualifier': 'DOUBLE_QUOTE'|'SINGLE_QUOTE',
'Delimiter': 'string'
},
'InputColumns': [
{
'Name': 'string',
'Type': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME'|'BIT'|'BOOLEAN'|'JSON',
'SubType': 'FLOAT'|'FIXED'
},
]
}
}
},
LogicalTableMap={
'string': {
'Alias': 'string',
'DataTransforms': [
{
'ProjectOperation': {
'ProjectedColumns': [
'string',
]
},
'FilterOperation': {
'ConditionExpression': 'string'
},
'CreateColumnsOperation': {
'Columns': [
{
'ColumnName': 'string',
'ColumnId': 'string',
'Expression': 'string'
},
]
},
'RenameColumnOperation': {
'ColumnName': 'string',
'NewColumnName': 'string'
},
'CastColumnTypeOperation': {
'ColumnName': 'string',
'NewColumnType': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME',
'SubType': 'FLOAT'|'FIXED',
'Format': 'string'
},
'TagColumnOperation': {
'ColumnName': 'string',
'Tags': [
{
'ColumnGeographicRole': 'COUNTRY'|'STATE'|'COUNTY'|'CITY'|'POSTCODE'|'LONGITUDE'|'LATITUDE',
'ColumnDescription': {
'Text': 'string'
}
},
]
},
'UntagColumnOperation': {
'ColumnName': 'string',
'TagNames': [
'COLUMN_GEOGRAPHIC_ROLE'|'COLUMN_DESCRIPTION',
]
},
'OverrideDatasetParameterOperation': {
'ParameterName': 'string',
'NewParameterName': 'string',
'NewDefaultValues': {
'StringStaticValues': [
'string',
],
'DecimalStaticValues': [
123.0,
],
'DateTimeStaticValues': [
datetime(2015, 1, 1),
],
'IntegerStaticValues': [
123,
]
}
}
},
],
'Source': {
'JoinInstruction': {
'LeftOperand': 'string',
'RightOperand': 'string',
'LeftJoinKeyProperties': {
'UniqueKey': True|False
},
'RightJoinKeyProperties': {
'UniqueKey': True|False
},
'Type': 'INNER'|'OUTER'|'LEFT'|'RIGHT',
'OnClause': 'string'
},
'PhysicalTableId': 'string',
'DataSetArn': 'string'
}
}
},
ImportMode='SPICE'|'DIRECT_QUERY',
ColumnGroups=[
{
'GeoSpatialColumnGroup': {
'Name': 'string',
'CountryCode': 'US',
'Columns': [
'string',
]
}
},
],
FieldFolders={
'string': {
'description': 'string',
'columns': [
'string',
]
}
},
Permissions=[
{
'Principal': 'string',
'Actions': [
'string',
]
},
],
RowLevelPermissionDataSet={
'Namespace': 'string',
'Arn': 'string',
'PermissionPolicy': 'GRANT_ACCESS'|'DENY_ACCESS',
'FormatVersion': 'VERSION_1'|'VERSION_2',
'Status': 'ENABLED'|'DISABLED'
},
RowLevelPermissionTagConfiguration={
'Status': 'ENABLED'|'DISABLED',
'TagRules': [
{
'TagKey': 'string',
'ColumnName': 'string',
'TagMultiValueDelimiter': 'string',
'MatchAllValue': 'string'
},
],
'TagRuleConfigurations': [
[
'string',
],
]
},
ColumnLevelPermissionRules=[
{
'Principals': [
'string',
],
'ColumnNames': [
'string',
]
},
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
DataSetUsageConfiguration={
'DisableUseAsDirectQuerySource': True|False,
'DisableUseAsImportedSource': True|False
},
DatasetParameters=[
{
'StringDatasetParameter': {
'Id': 'string',
'Name': 'string',
'ValueType': 'MULTI_VALUED'|'SINGLE_VALUED',
'DefaultValues': {
'StaticValues': [
'string',
]
}
},
'DecimalDatasetParameter': {
'Id': 'string',
'Name': 'string',
'ValueType': 'MULTI_VALUED'|'SINGLE_VALUED',
'DefaultValues': {
'StaticValues': [
123.0,
]
}
},
'IntegerDatasetParameter': {
'Id': 'string',
'Name': 'string',
'ValueType': 'MULTI_VALUED'|'SINGLE_VALUED',
'DefaultValues': {
'StaticValues': [
123,
]
}
},
'DateTimeDatasetParameter': {
'Id': 'string',
'Name': 'string',
'ValueType': 'MULTI_VALUED'|'SINGLE_VALUED',
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'DefaultValues': {
'StaticValues': [
datetime(2015, 1, 1),
]
}
}
},
],
FolderArns=[
'string',
],
PerformanceConfiguration={
'UniqueKeys': [
{
'ColumnNames': [
'string',
]
},
]
},
UseAs='RLS_RULES'
)
string
[REQUIRED]
The Amazon Web Services account ID.
string
[REQUIRED]
An ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
string
[REQUIRED]
The display name for the dataset.
dict
[REQUIRED]
Declares the physical tables that are available in the underlying data sources.
(string) --
(dict) --
A view of a data source that contains information about the shape of the data in the underlying source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
RelationalTable (dict) --
A physical table type for relational data sources.
DataSourceArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the data source.
Catalog (string) --
The catalog associated with a table.
Schema (string) --
The schema name. This name applies to certain relational database engines.
Name (string) -- [REQUIRED]
The name of the relational table.
InputColumns (list) -- [REQUIRED]
The column schema of the table.
(dict) --
Metadata for a column that is used as the input of a transform operation.
Name (string) -- [REQUIRED]
The name of this column in the underlying data source.
Type (string) -- [REQUIRED]
The data type of the column.
SubType (string) --
The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset.
CustomSql (dict) --
A physical table type built from the results of the custom SQL query.
DataSourceArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the data source.
Name (string) -- [REQUIRED]
A display name for the SQL query result.
SqlQuery (string) -- [REQUIRED]
The SQL query.
Columns (list) --
The column schema from the SQL query result set.
(dict) --
Metadata for a column that is used as the input of a transform operation.
Name (string) -- [REQUIRED]
The name of this column in the underlying data source.
Type (string) -- [REQUIRED]
The data type of the column.
SubType (string) --
The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset.
S3Source (dict) --
A physical table type for as S3 data source.
DataSourceArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the data source.
UploadSettings (dict) --
Information about the format for the S3 source file or files.
Format (string) --
File format.
StartFromRow (integer) --
A row number to start reading data from.
ContainsHeader (boolean) --
Whether the file has a header row, or the files each have a header row.
TextQualifier (string) --
Text qualifier.
Delimiter (string) --
The delimiter between values in the file.
InputColumns (list) -- [REQUIRED]
A physical table type for an S3 data source.
(dict) --
Metadata for a column that is used as the input of a transform operation.
Name (string) -- [REQUIRED]
The name of this column in the underlying data source.
Type (string) -- [REQUIRED]
The data type of the column.
SubType (string) --
The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset.
dict
Configures the combination and transformation of the data from the physical tables.
(string) --
An identifier for the logical table that is defined in the dataset
(dict) --
A logical table is a unit that joins and that data transformations operate on. A logical table has a source, which can be either a physical table or result of a join. When a logical table points to a physical table, the logical table acts as a mutable copy of that physical table through transform operations.
Alias (string) -- [REQUIRED]
A display name for the logical table.
DataTransforms (list) --
Transform operations that act on this logical table. For this structure to be valid, only one of the attributes can be non-null.
(dict) --
A data transformation on a logical table. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
ProjectOperation (dict) --
An operation that projects columns. Operations that come after a projection can only refer to projected columns.
ProjectedColumns (list) -- [REQUIRED]
Projected columns.
(string) --
FilterOperation (dict) --
An operation that filters rows based on some condition.
ConditionExpression (string) -- [REQUIRED]
An expression that must evaluate to a Boolean value. Rows for which the expression evaluates to true are kept in the dataset.
CreateColumnsOperation (dict) --
An operation that creates calculated columns. Columns created in one such operation form a lexical closure.
Columns (list) -- [REQUIRED]
Calculated columns to create.
(dict) --
A calculated column for a dataset.
ColumnName (string) -- [REQUIRED]
Column name.
ColumnId (string) -- [REQUIRED]
A unique ID to identify a calculated column. During a dataset update, if the column ID of a calculated column matches that of an existing calculated column, Amazon QuickSight preserves the existing calculated column.
Expression (string) -- [REQUIRED]
An expression that defines the calculated column.
RenameColumnOperation (dict) --
An operation that renames a column.
ColumnName (string) -- [REQUIRED]
The name of the column to be renamed.
NewColumnName (string) -- [REQUIRED]
The new name for the column.
CastColumnTypeOperation (dict) --
A transform operation that casts a column to a different type.
ColumnName (string) -- [REQUIRED]
Column name.
NewColumnType (string) -- [REQUIRED]
New column data type.
SubType (string) --
The sub data type of the new column. Sub types are only available for decimal columns that are part of a SPICE dataset.
Format (string) --
When casting a column from string to datetime type, you can supply a string in a format supported by Amazon QuickSight to denote the source data format.
TagColumnOperation (dict) --
An operation that tags a column with additional information.
ColumnName (string) -- [REQUIRED]
The column that this operation acts on.
Tags (list) -- [REQUIRED]
The dataset column tag, currently only used for geospatial type tagging.
(dict) --
A tag for a column in a TagColumnOperation structure. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
ColumnGeographicRole (string) --
A geospatial role for a column.
ColumnDescription (dict) --
A description for a column.
Text (string) --
The text of a description for a column.
UntagColumnOperation (dict) --
A transform operation that removes tags associated with a column.
ColumnName (string) -- [REQUIRED]
The column that this operation acts on.
TagNames (list) -- [REQUIRED]
The column tags to remove from this column.
(string) --
OverrideDatasetParameterOperation (dict) --
A transform operation that overrides the dataset parameter values that are defined in another dataset.
ParameterName (string) -- [REQUIRED]
The name of the parameter to be overridden with different values.
NewParameterName (string) --
The new name for the parameter.
NewDefaultValues (dict) --
The new default values for the parameter.
StringStaticValues (list) --
A list of static default values for a given string parameter.
(string) --
The default value for the string parameter.
DecimalStaticValues (list) --
A list of static default values for a given decimal parameter.
(float) --
The default value for the decimal parameter.
DateTimeStaticValues (list) --
A list of static default values for a given date time parameter.
(datetime) --
The default value for the date time parameter.
IntegerStaticValues (list) --
A list of static default values for a given integer parameter.
(integer) --
The default value for the integer parameter.
Source (dict) -- [REQUIRED]
Source of this logical table.
JoinInstruction (dict) --
Specifies the result of a join of two logical tables.
LeftOperand (string) -- [REQUIRED]
The operand on the left side of a join.
RightOperand (string) -- [REQUIRED]
The operand on the right side of a join.
LeftJoinKeyProperties (dict) --
Join key properties of the left operand.
UniqueKey (boolean) --
A value that indicates that a row in a table is uniquely identified by the columns in a join key. This is used by Amazon QuickSight to optimize query performance.
RightJoinKeyProperties (dict) --
Join key properties of the right operand.
UniqueKey (boolean) --
A value that indicates that a row in a table is uniquely identified by the columns in a join key. This is used by Amazon QuickSight to optimize query performance.
Type (string) -- [REQUIRED]
The type of join that it is.
OnClause (string) -- [REQUIRED]
The join instructions provided in the ON clause of a join.
PhysicalTableId (string) --
Physical table ID.
DataSetArn (string) --
The Amazon Resource Number (ARN) of the parent dataset.
string
[REQUIRED]
Indicates whether you want to import the data into SPICE.
list
Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.
(dict) --
Groupings of columns that work together in certain Amazon QuickSight features. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
GeoSpatialColumnGroup (dict) --
Geospatial column group that denotes a hierarchy.
Name (string) -- [REQUIRED]
A display name for the hierarchy.
CountryCode (string) --
Country code.
Columns (list) -- [REQUIRED]
Columns in this hierarchy.
(string) --
dict
The folder that contains fields and nested subfolders for your dataset.
(string) --
(dict) --
A FieldFolder element is a folder that contains fields and nested subfolders.
description (string) --
The description for a field folder.
columns (list) --
A folder has a list of columns. A column can only be in one folder.
(string) --
list
A list of resource permissions on the dataset.
(dict) --
Permission for the resource.
Principal (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the principal. This can be one of the following:
The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)
The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)
The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.)
Actions (list) -- [REQUIRED]
The IAM action to grant or revoke permissions on.
(string) --
dict
The row-level security configuration for the data that you want to create.
Namespace (string) --
The namespace associated with the dataset that contains permissions for RLS.
Arn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.
PermissionPolicy (string) -- [REQUIRED]
The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS is included for backward compatibility only.
FormatVersion (string) --
The user or group rules associated with the dataset that contains permissions for RLS.
By default, FormatVersion is VERSION_1. When FormatVersion is VERSION_1, UserName and GroupName are required. When FormatVersion is VERSION_2, UserARN and GroupARN are required, and Namespace must not exist.
Status (string) --
The status of the row-level security permission dataset. If enabled, the status is ENABLED. If disabled, the status is DISABLED.
dict
The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only.
Status (string) --
The status of row-level security tags. If enabled, the status is ENABLED. If disabled, the status is DISABLED.
TagRules (list) -- [REQUIRED]
A set of rules associated with row-level security, such as the tag names and columns that they are assigned to.
(dict) --
A set of rules associated with a tag.
TagKey (string) -- [REQUIRED]
The unique key for a tag.
ColumnName (string) -- [REQUIRED]
The column name that a tag key is assigned to.
TagMultiValueDelimiter (string) --
A string that you want to use to delimit the values when you pass the values at run time. For example, you can delimit the values with a comma.
MatchAllValue (string) --
A string that you want to use to filter by all the values in a column in the dataset and don’t want to list the values one by one. For example, you can use an asterisk as your match all value.
TagRuleConfigurations (list) --
A list of tag configuration rules to apply to a dataset. All tag configurations have the OR condition. Tags within each tile will be joined (AND). At least one rule in this structure must have all tag values assigned to it to apply Row-level security (RLS) to the dataset.
(list) --
(string) --
list
A set of one or more definitions of a ``ColumnLevelPermissionRule ``.
(dict) --
A rule defined to grant access on one or more restricted columns. Each dataset can have multiple rules. To create a restricted column, you add it to one or more rules. Each rule must contain at least one column and at least one user or group. To be able to see a restricted column, a user or group needs to be added to a rule for that column.
Principals (list) --
An array of Amazon Resource Names (ARNs) for Amazon QuickSight users or groups.
(string) --
ColumnNames (list) --
An array of column names.
(string) --
list
Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) -- [REQUIRED]
Tag key.
Value (string) -- [REQUIRED]
Tag value.
dict
The usage configuration to apply to child datasets that reference this dataset as a source.
DisableUseAsDirectQuerySource (boolean) --
An option that controls whether a child dataset of a direct query can use this dataset as a source.
DisableUseAsImportedSource (boolean) --
An option that controls whether a child dataset that's stored in QuickSight can use this dataset as a source.
list
The parameter declarations of the dataset.
(dict) --
A parameter that is created in a dataset. The parameter can be a string, integer, decimal, or datetime data type.
StringDatasetParameter (dict) --
A string parameter that is created in the dataset.
Id (string) -- [REQUIRED]
An identifier for the string parameter that is created in the dataset.
Name (string) -- [REQUIRED]
The name of the string parameter that is created in the dataset.
ValueType (string) -- [REQUIRED]
The value type of the dataset parameter. Valid values are single value or multi value.
DefaultValues (dict) --
A list of default values for a given string dataset parameter type. This structure only accepts static values.
StaticValues (list) --
A list of static default values for a given string parameter.
(string) --
The default value for the string parameter.
DecimalDatasetParameter (dict) --
A decimal parameter that is created in the dataset.
Id (string) -- [REQUIRED]
An identifier for the decimal parameter created in the dataset.
Name (string) -- [REQUIRED]
The name of the decimal parameter that is created in the dataset.
ValueType (string) -- [REQUIRED]
The value type of the dataset parameter. Valid values are single value or multi value.
DefaultValues (dict) --
A list of default values for a given decimal parameter. This structure only accepts static values.
StaticValues (list) --
A list of static default values for a given decimal parameter.
(float) --
The default value for the decimal parameter.
IntegerDatasetParameter (dict) --
An integer parameter that is created in the dataset.
Id (string) -- [REQUIRED]
An identifier for the integer parameter created in the dataset.
Name (string) -- [REQUIRED]
The name of the integer parameter that is created in the dataset.
ValueType (string) -- [REQUIRED]
The value type of the dataset parameter. Valid values are single value or multi value.
DefaultValues (dict) --
A list of default values for a given integer parameter. This structure only accepts static values.
StaticValues (list) --
A list of static default values for a given integer parameter.
(integer) --
The default value for the integer parameter.
DateTimeDatasetParameter (dict) --
A date time parameter that is created in the dataset.
Id (string) -- [REQUIRED]
An identifier for the parameter that is created in the dataset.
Name (string) -- [REQUIRED]
The name of the date time parameter that is created in the dataset.
ValueType (string) -- [REQUIRED]
The value type of the dataset parameter. Valid values are single value or multi value.
TimeGranularity (string) --
The time granularity of the date time parameter.
DefaultValues (dict) --
A list of default values for a given date time parameter. This structure only accepts static values.
StaticValues (list) --
A list of static default values for a given date time parameter.
(datetime) --
The default value for the date time parameter.
list
When you create the dataset, Amazon QuickSight adds the dataset to these folders.
(string) --
dict
The configuration for the performance optimization of the dataset that contains a UniqueKey configuration.
UniqueKeys (list) --
A UniqueKey configuration.
(dict) --
A UniqueKey configuration that references a dataset column.
ColumnNames (list) -- [REQUIRED]
The name of the column that is referenced in the UniqueKey configuration.
(string) --
string
The usage of the dataset. RLS_RULES must be specified for RLS permission datasets.
dict
Response Syntax
{
'Arn': 'string',
'DataSetId': 'string',
'IngestionArn': 'string',
'IngestionId': 'string',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) of the dataset.
DataSetId (string) --
The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
IngestionArn (string) --
The ARN for the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.
IngestionId (string) --
The ID of the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'Credentials': {'CredentialPair': {'AlternateDataSourceParameters': {'OracleParameters': {'UseServiceName': 'boolean'}}}},
'DataSourceParameters': {'OracleParameters': {'UseServiceName': 'boolean'}}}
Creates a data source.
See also: AWS API Documentation
Request Syntax
client.create_data_source(
AwsAccountId='string',
DataSourceId='string',
Name='string',
Type='ADOBE_ANALYTICS'|'AMAZON_ELASTICSEARCH'|'ATHENA'|'AURORA'|'AURORA_POSTGRESQL'|'AWS_IOT_ANALYTICS'|'GITHUB'|'JIRA'|'MARIADB'|'MYSQL'|'ORACLE'|'POSTGRESQL'|'PRESTO'|'REDSHIFT'|'S3'|'SALESFORCE'|'SERVICENOW'|'SNOWFLAKE'|'SPARK'|'SQLSERVER'|'TERADATA'|'TWITTER'|'TIMESTREAM'|'AMAZON_OPENSEARCH'|'EXASOL'|'DATABRICKS'|'STARBURST'|'TRINO'|'BIGQUERY',
DataSourceParameters={
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string',
'RoleArn': 'string'
},
'AuroraParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AuroraPostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AwsIotAnalyticsParameters': {
'DataSetName': 'string'
},
'JiraParameters': {
'SiteBaseUrl': 'string'
},
'MariaDbParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'MySqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'OracleParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'UseServiceName': True|False
},
'PostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PrestoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'RdsParameters': {
'InstanceId': 'string',
'Database': 'string'
},
'RedshiftParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'ClusterId': 'string',
'IAMParameters': {
'RoleArn': 'string',
'DatabaseUser': 'string',
'DatabaseGroups': [
'string',
],
'AutoCreateDatabaseUser': True|False
},
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string',
'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509',
'DatabaseAccessControlRole': 'string',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string'
}
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
},
'AmazonOpenSearchParameters': {
'Domain': 'string'
},
'ExasolParameters': {
'Host': 'string',
'Port': 123
},
'DatabricksParameters': {
'Host': 'string',
'Port': 123,
'SqlEndpointPath': 'string'
},
'StarburstParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string',
'ProductType': 'GALAXY'|'ENTERPRISE',
'DatabaseAccessControlRole': 'string',
'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string'
}
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'BigQueryParameters': {
'ProjectId': 'string',
'DataSetRegion': 'string'
}
},
Credentials={
'CredentialPair': {
'Username': 'string',
'Password': 'string',
'AlternateDataSourceParameters': [
{
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string',
'RoleArn': 'string'
},
'AuroraParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AuroraPostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AwsIotAnalyticsParameters': {
'DataSetName': 'string'
},
'JiraParameters': {
'SiteBaseUrl': 'string'
},
'MariaDbParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'MySqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'OracleParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'UseServiceName': True|False
},
'PostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PrestoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'RdsParameters': {
'InstanceId': 'string',
'Database': 'string'
},
'RedshiftParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'ClusterId': 'string',
'IAMParameters': {
'RoleArn': 'string',
'DatabaseUser': 'string',
'DatabaseGroups': [
'string',
],
'AutoCreateDatabaseUser': True|False
},
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string',
'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509',
'DatabaseAccessControlRole': 'string',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string'
}
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
},
'AmazonOpenSearchParameters': {
'Domain': 'string'
},
'ExasolParameters': {
'Host': 'string',
'Port': 123
},
'DatabricksParameters': {
'Host': 'string',
'Port': 123,
'SqlEndpointPath': 'string'
},
'StarburstParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string',
'ProductType': 'GALAXY'|'ENTERPRISE',
'DatabaseAccessControlRole': 'string',
'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string'
}
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'BigQueryParameters': {
'ProjectId': 'string',
'DataSetRegion': 'string'
}
},
]
},
'CopySourceArn': 'string',
'SecretArn': 'string'
},
Permissions=[
{
'Principal': 'string',
'Actions': [
'string',
]
},
],
VpcConnectionProperties={
'VpcConnectionArn': 'string'
},
SslProperties={
'DisableSsl': True|False
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
FolderArns=[
'string',
]
)
string
[REQUIRED]
The Amazon Web Services account ID.
string
[REQUIRED]
An ID for the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
string
[REQUIRED]
A display name for the data source.
string
[REQUIRED]
The type of the data source. To return a list of all data sources, use ListDataSources.
Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service.
dict
The parameters that Amazon QuickSight uses to connect to your underlying source.
AmazonElasticsearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) -- [REQUIRED]
The OpenSearch domain.
AthenaParameters (dict) --
The parameters for Amazon Athena.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.
AuroraParameters (dict) --
The parameters for Amazon Aurora MySQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
AuroraPostgreSqlParameters (dict) --
The parameters for Amazon Aurora.
Host (string) -- [REQUIRED]
The Amazon Aurora PostgreSQL-Compatible host to connect to.
Port (integer) -- [REQUIRED]
The port that Amazon Aurora PostgreSQL is listening on.
Database (string) -- [REQUIRED]
The Amazon Aurora PostgreSQL database to connect to.
AwsIotAnalyticsParameters (dict) --
The parameters for IoT Analytics.
DataSetName (string) -- [REQUIRED]
Dataset name.
JiraParameters (dict) --
The parameters for Jira.
SiteBaseUrl (string) -- [REQUIRED]
The base URL of the Jira site.
MariaDbParameters (dict) --
The parameters for MariaDB.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
MySqlParameters (dict) --
The parameters for MySQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
OracleParameters (dict) --
The parameters for Oracle.
Host (string) -- [REQUIRED]
An Oracle host.
Port (integer) -- [REQUIRED]
The port.
Database (string) -- [REQUIRED]
The database.
UseServiceName (boolean) --
A Boolean value that indicates whether the Database uses a service name or an SID. If this value is left blank, the default value is SID. If this value is set to false, the value is SID.
PostgreSqlParameters (dict) --
The parameters for PostgreSQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
PrestoParameters (dict) --
The parameters for Presto.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Catalog (string) -- [REQUIRED]
Catalog.
RdsParameters (dict) --
The parameters for Amazon RDS.
InstanceId (string) -- [REQUIRED]
Instance ID.
Database (string) -- [REQUIRED]
Database.
RedshiftParameters (dict) --
The parameters for Amazon Redshift.
Host (string) --
Host. This field can be blank if ClusterId is provided.
Port (integer) --
Port. This field can be blank if the ClusterId is provided.
Database (string) -- [REQUIRED]
Database.
ClusterId (string) --
Cluster ID. This field can be blank if the Host and Port are provided.
IAMParameters (dict) --
An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials.
RoleArn (string) -- [REQUIRED]
Use the RoleArn structure to allow Amazon QuickSight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role.
DatabaseUser (string) --
The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.
DatabaseGroups (list) --
A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the DatabaseUser. If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup.
(string) --
AutoCreateDatabaseUser (boolean) --
Automatically creates a database user. If your database doesn't have a DatabaseUser, set this parameter to True. If there is no DatabaseUser, Amazon QuickSight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Amazon QuickSight access to your cluster.
This parameter can only be specified if your Amazon QuickSight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
S3Parameters (dict) --
The parameters for S3.
ManifestFileLocation (dict) -- [REQUIRED]
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight.
Bucket (string) -- [REQUIRED]
Amazon S3 bucket.
Key (string) -- [REQUIRED]
Amazon S3 key that identifies an object.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
ServiceNowParameters (dict) --
The parameters for ServiceNow.
SiteBaseUrl (string) -- [REQUIRED]
URL of the base site.
SnowflakeParameters (dict) --
The parameters for Snowflake.
Host (string) -- [REQUIRED]
Host.
Database (string) -- [REQUIRED]
Database.
Warehouse (string) -- [REQUIRED]
Warehouse.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
DatabaseAccessControlRole (string) --
The database access control role.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Amazon QuickSight account and Snowflake.
TokenProviderUrl (string) -- [REQUIRED]
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
SparkParameters (dict) --
The parameters for Spark.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
SqlServerParameters (dict) --
The parameters for SQL Server.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TeradataParameters (dict) --
The parameters for Teradata.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TwitterParameters (dict) --
The parameters for Twitter.
Query (string) -- [REQUIRED]
Twitter query string.
MaxRows (integer) -- [REQUIRED]
Maximum number of rows to query Twitter.
AmazonOpenSearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) -- [REQUIRED]
The OpenSearch domain.
ExasolParameters (dict) --
The parameters for Exasol.
Host (string) -- [REQUIRED]
The hostname or IP address of the Exasol data source.
Port (integer) -- [REQUIRED]
The port for the Exasol data source.
DatabricksParameters (dict) --
The parameters that are required to connect to a Databricks data source.
Host (string) -- [REQUIRED]
The host name of the Databricks data source.
Port (integer) -- [REQUIRED]
The port for the Databricks data source.
SqlEndpointPath (string) -- [REQUIRED]
The HTTP path of the Databricks data source.
StarburstParameters (dict) --
The parameters that are required to connect to a Starburst data source.
Host (string) -- [REQUIRED]
The host name of the Starburst data source.
Port (integer) -- [REQUIRED]
The port for the Starburst data source.
Catalog (string) -- [REQUIRED]
The catalog name for the Starburst data source.
ProductType (string) --
The product type for the Starburst data source.
DatabaseAccessControlRole (string) --
The database access control role.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Amazon QuickSight account and Starburst.
TokenProviderUrl (string) -- [REQUIRED]
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
TrinoParameters (dict) --
The parameters that are required to connect to a Trino data source.
Host (string) -- [REQUIRED]
The host name of the Trino data source.
Port (integer) -- [REQUIRED]
The port for the Trino data source.
Catalog (string) -- [REQUIRED]
The catalog name for the Trino data source.
BigQueryParameters (dict) --
The parameters that are required to connect to a Google BigQuery data source.
ProjectId (string) -- [REQUIRED]
The Google Cloud Platform project ID where your datasource was created.
DataSetRegion (string) --
The storage location where you create a Google BigQuery data source.
dict
The credentials Amazon QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.
CredentialPair (dict) --
Credential pair. For more information, see ``CredentialPair ``.
Username (string) -- [REQUIRED]
User name.
Password (string) -- [REQUIRED]
Password.
AlternateDataSourceParameters (list) --
A set of alternate data source parameters that you want to share for these credentials. The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the DataSourceParameters structure that's in the request with the structures in the AlternateDataSourceParameters allow list. If the structures are an exact match, the request is allowed to use the new data source with the existing credentials. If the AlternateDataSourceParameters list is null, the DataSourceParameters originally used with these Credentials is automatically allowed.
(dict) --
The parameters that Amazon QuickSight uses to connect to your underlying data source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
AmazonElasticsearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) -- [REQUIRED]
The OpenSearch domain.
AthenaParameters (dict) --
The parameters for Amazon Athena.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.
AuroraParameters (dict) --
The parameters for Amazon Aurora MySQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
AuroraPostgreSqlParameters (dict) --
The parameters for Amazon Aurora.
Host (string) -- [REQUIRED]
The Amazon Aurora PostgreSQL-Compatible host to connect to.
Port (integer) -- [REQUIRED]
The port that Amazon Aurora PostgreSQL is listening on.
Database (string) -- [REQUIRED]
The Amazon Aurora PostgreSQL database to connect to.
AwsIotAnalyticsParameters (dict) --
The parameters for IoT Analytics.
DataSetName (string) -- [REQUIRED]
Dataset name.
JiraParameters (dict) --
The parameters for Jira.
SiteBaseUrl (string) -- [REQUIRED]
The base URL of the Jira site.
MariaDbParameters (dict) --
The parameters for MariaDB.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
MySqlParameters (dict) --
The parameters for MySQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
OracleParameters (dict) --
The parameters for Oracle.
Host (string) -- [REQUIRED]
An Oracle host.
Port (integer) -- [REQUIRED]
The port.
Database (string) -- [REQUIRED]
The database.
UseServiceName (boolean) --
A Boolean value that indicates whether the Database uses a service name or an SID. If this value is left blank, the default value is SID. If this value is set to false, the value is SID.
PostgreSqlParameters (dict) --
The parameters for PostgreSQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
PrestoParameters (dict) --
The parameters for Presto.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Catalog (string) -- [REQUIRED]
Catalog.
RdsParameters (dict) --
The parameters for Amazon RDS.
InstanceId (string) -- [REQUIRED]
Instance ID.
Database (string) -- [REQUIRED]
Database.
RedshiftParameters (dict) --
The parameters for Amazon Redshift.
Host (string) --
Host. This field can be blank if ClusterId is provided.
Port (integer) --
Port. This field can be blank if the ClusterId is provided.
Database (string) -- [REQUIRED]
Database.
ClusterId (string) --
Cluster ID. This field can be blank if the Host and Port are provided.
IAMParameters (dict) --
An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials.
RoleArn (string) -- [REQUIRED]
Use the RoleArn structure to allow Amazon QuickSight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role.
DatabaseUser (string) --
The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.
DatabaseGroups (list) --
A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the DatabaseUser. If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup.
(string) --
AutoCreateDatabaseUser (boolean) --
Automatically creates a database user. If your database doesn't have a DatabaseUser, set this parameter to True. If there is no DatabaseUser, Amazon QuickSight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Amazon QuickSight access to your cluster.
This parameter can only be specified if your Amazon QuickSight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
S3Parameters (dict) --
The parameters for S3.
ManifestFileLocation (dict) -- [REQUIRED]
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight.
Bucket (string) -- [REQUIRED]
Amazon S3 bucket.
Key (string) -- [REQUIRED]
Amazon S3 key that identifies an object.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
ServiceNowParameters (dict) --
The parameters for ServiceNow.
SiteBaseUrl (string) -- [REQUIRED]
URL of the base site.
SnowflakeParameters (dict) --
The parameters for Snowflake.
Host (string) -- [REQUIRED]
Host.
Database (string) -- [REQUIRED]
Database.
Warehouse (string) -- [REQUIRED]
Warehouse.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
DatabaseAccessControlRole (string) --
The database access control role.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Amazon QuickSight account and Snowflake.
TokenProviderUrl (string) -- [REQUIRED]
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
SparkParameters (dict) --
The parameters for Spark.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
SqlServerParameters (dict) --
The parameters for SQL Server.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TeradataParameters (dict) --
The parameters for Teradata.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TwitterParameters (dict) --
The parameters for Twitter.
Query (string) -- [REQUIRED]
Twitter query string.
MaxRows (integer) -- [REQUIRED]
Maximum number of rows to query Twitter.
AmazonOpenSearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) -- [REQUIRED]
The OpenSearch domain.
ExasolParameters (dict) --
The parameters for Exasol.
Host (string) -- [REQUIRED]
The hostname or IP address of the Exasol data source.
Port (integer) -- [REQUIRED]
The port for the Exasol data source.
DatabricksParameters (dict) --
The parameters that are required to connect to a Databricks data source.
Host (string) -- [REQUIRED]
The host name of the Databricks data source.
Port (integer) -- [REQUIRED]
The port for the Databricks data source.
SqlEndpointPath (string) -- [REQUIRED]
The HTTP path of the Databricks data source.
StarburstParameters (dict) --
The parameters that are required to connect to a Starburst data source.
Host (string) -- [REQUIRED]
The host name of the Starburst data source.
Port (integer) -- [REQUIRED]
The port for the Starburst data source.
Catalog (string) -- [REQUIRED]
The catalog name for the Starburst data source.
ProductType (string) --
The product type for the Starburst data source.
DatabaseAccessControlRole (string) --
The database access control role.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Amazon QuickSight account and Starburst.
TokenProviderUrl (string) -- [REQUIRED]
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
TrinoParameters (dict) --
The parameters that are required to connect to a Trino data source.
Host (string) -- [REQUIRED]
The host name of the Trino data source.
Port (integer) -- [REQUIRED]
The port for the Trino data source.
Catalog (string) -- [REQUIRED]
The catalog name for the Trino data source.
BigQueryParameters (dict) --
The parameters that are required to connect to a Google BigQuery data source.
ProjectId (string) -- [REQUIRED]
The Google Cloud Platform project ID where your datasource was created.
DataSetRegion (string) --
The storage location where you create a Google BigQuery data source.
CopySourceArn (string) --
The Amazon Resource Name (ARN) of a data source that has the credential pair that you want to use. When CopySourceArn is not null, the credential pair from the data source in the ARN is used as the credentials for the DataSourceCredentials structure.
SecretArn (string) --
The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.
list
A list of resource permissions on the data source.
(dict) --
Permission for the resource.
Principal (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the principal. This can be one of the following:
The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)
The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)
The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.)
Actions (list) -- [REQUIRED]
The IAM action to grant or revoke permissions on.
(string) --
dict
Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
dict
Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.
DisableSsl (boolean) --
A Boolean option to control whether SSL should be disabled.
list
Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) -- [REQUIRED]
Tag key.
Value (string) -- [REQUIRED]
Tag value.
list
When you create the data source, Amazon QuickSight adds the data source to these folders.
(string) --
dict
Response Syntax
{
'Arn': 'string',
'DataSourceId': 'string',
'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) of the data source.
DataSourceId (string) --
The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
CreationStatus (string) --
The status of creating the data source.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'Definition': {'Options': {'ExcludedDataSetArns': ['string'],
'QBusinessInsightsStatus': 'ENABLED | DISABLED'},
'Sheets': {'Visuals': {'TableVisual': {'ChartConfiguration': {'FieldOptions': {'TransposedTableOptions': [{'ColumnIndex': 'integer',
'ColumnType': 'ROW_HEADER_COLUMN '
'| '
'VALUE_COLUMN',
'ColumnWidth': 'string'}]}}}}}}}
Creates a template either from a TemplateDefinition or from an existing Amazon QuickSight analysis or template. You can use the resulting template to create additional dashboards, templates, or analyses.
A template is an entity in Amazon QuickSight that encapsulates the metadata required to create an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.
See also: AWS API Documentation
Request Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.Parameters
# This section is too large to render. # Please see the AWS API Documentation linked below.
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 Amazon Web Services request ID for this operation.
{'Definition': {'Options': {'ExcludedDataSetArns': ['string'],
'QBusinessInsightsStatus': 'ENABLED | DISABLED'},
'Sheets': {'Visuals': {'TableVisual': {'ChartConfiguration': {'FieldOptions': {'TransposedTableOptions': [{'ColumnIndex': 'integer',
'ColumnType': 'ROW_HEADER_COLUMN '
'| '
'VALUE_COLUMN',
'ColumnWidth': 'string'}]}}}}}}}
Provides a detailed description of the definition of an analysis.
See also: AWS API Documentation
Request Syntax
client.describe_analysis_definition(
AwsAccountId='string',
AnalysisId='string'
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the analysis. You must be using the Amazon Web Services account that the analysis is in.
string
[REQUIRED]
The ID of the analysis that you're describing. The ID is part of the URL of the analysis.
dict
Response Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.
Response Structure
# This section is too large to render. # Please see the AWS API Documentation linked below.
{'CloudFormationOverridePropertyConfiguration': {'DataSets': {'Properties': {'RefreshFailureEmailAlertStatus'}}}}
Describes an existing export job.
Poll job descriptions after a job starts to know the status of the job. When a job succeeds, a URL is provided to download the exported assets' data from. Download URLs are valid for five minutes after they are generated. You can call the DescribeAssetBundleExportJob API for a new download URL as needed.
Job descriptions are available for 14 days after the job starts.
See also: AWS API Documentation
Request Syntax
client.describe_asset_bundle_export_job(
AwsAccountId='string',
AssetBundleExportJobId='string'
)
string
[REQUIRED]
The ID of the Amazon Web Services account the export job is executed in.
string
[REQUIRED]
The ID of the job that you want described. The job ID is set when you start a new job with a StartAssetBundleExportJob API call.
dict
Response Syntax
{
'JobStatus': 'QUEUED_FOR_IMMEDIATE_EXECUTION'|'IN_PROGRESS'|'SUCCESSFUL'|'FAILED',
'DownloadUrl': 'string',
'Errors': [
{
'Arn': 'string',
'Type': 'string',
'Message': 'string'
},
],
'Arn': 'string',
'CreatedTime': datetime(2015, 1, 1),
'AssetBundleExportJobId': 'string',
'AwsAccountId': 'string',
'ResourceArns': [
'string',
],
'IncludeAllDependencies': True|False,
'ExportFormat': 'CLOUDFORMATION_JSON'|'QUICKSIGHT_JSON',
'CloudFormationOverridePropertyConfiguration': {
'ResourceIdOverrideConfiguration': {
'PrefixForAllResources': True|False
},
'VPCConnections': [
{
'Arn': 'string',
'Properties': [
'Name'|'DnsResolvers'|'RoleArn',
]
},
],
'RefreshSchedules': [
{
'Arn': 'string',
'Properties': [
'StartAfterDateTime',
]
},
],
'DataSources': [
{
'Arn': 'string',
'Properties': [
'Name'|'DisableSsl'|'SecretArn'|'Username'|'Password'|'Domain'|'WorkGroup'|'Host'|'Port'|'Database'|'DataSetName'|'Catalog'|'InstanceId'|'ClusterId'|'ManifestFileLocation'|'Warehouse'|'RoleArn'|'ProductType',
]
},
],
'DataSets': [
{
'Arn': 'string',
'Properties': [
'Name'|'RefreshFailureEmailAlertStatus',
]
},
],
'Themes': [
{
'Arn': 'string',
'Properties': [
'Name',
]
},
],
'Analyses': [
{
'Arn': 'string',
'Properties': [
'Name',
]
},
],
'Dashboards': [
{
'Arn': 'string',
'Properties': [
'Name',
]
},
],
'Folders': [
{
'Arn': 'string',
'Properties': [
'Name'|'ParentFolderArn',
]
},
]
},
'RequestId': 'string',
'Status': 123,
'IncludePermissions': True|False,
'IncludeTags': True|False,
'ValidationStrategy': {
'StrictModeForAllResources': True|False
},
'Warnings': [
{
'Arn': 'string',
'Message': 'string'
},
],
'IncludeFolderMemberships': True|False,
'IncludeFolderMembers': 'RECURSE'|'ONE_LEVEL'|'NONE'
}
Response Structure
(dict) --
JobStatus (string) --
Indicates the status of a job through its queuing and execution.
Poll this DescribeAssetBundleExportApi until JobStatus is either SUCCESSFUL or FAILED.
DownloadUrl (string) --
The URL to download the exported asset bundle data from.
This URL is available only after the job has succeeded. This URL is valid for 5 minutes after issuance. Call DescribeAssetBundleExportJob again for a fresh URL if needed.
The downloaded asset bundle is a zip file named assetbundle-{jobId}.qs. The file has a .qs extension.
This URL can't be used in a StartAssetBundleImportJob API call and should only be used for download purposes.
Errors (list) --
An array of error records that describes any failures that occurred during the export job processing.
Error records accumulate while the job runs. The complete set of error records is available after the job has completed and failed.
(dict) --
Describes an error that occurred during an Asset Bundle export job.
Arn (string) --
The ARN of the resource whose processing caused an error.
Type (string) --
The specific error type of the error that occurred.
Message (string) --
A description of the error.
Arn (string) --
The Amazon Resource Name (ARN) for the export job.
CreatedTime (datetime) --
The time that the export job was created.
AssetBundleExportJobId (string) --
The ID of the job. The job ID is set when you start a new job with a StartAssetBundleExportJob API call.
AwsAccountId (string) --
The ID of the Amazon Web Services account that the export job was executed in.
ResourceArns (list) --
A list of resource ARNs that exported with the job.
(string) --
IncludeAllDependencies (boolean) --
The include dependencies flag.
ExportFormat (string) --
The format of the exported asset bundle. A QUICKSIGHT_JSON formatted file can be used to make a StartAssetBundleImportJob API call. A CLOUDFORMATION_JSON formatted file can be used in the CloudFormation console and with the CloudFormation APIs.
CloudFormationOverridePropertyConfiguration (dict) --
The CloudFormation override property configuration for the export job.
ResourceIdOverrideConfiguration (dict) --
An optional list of structures that control how resource IDs are parameterized in the returned CloudFormation template.
PrefixForAllResources (boolean) --
An option to request a CloudFormation variable for a prefix to be prepended to each resource's ID before import. The prefix is only added to the asset IDs and does not change the name of the asset.
VPCConnections (list) --
An optional list of structures that control how VPCConnection resources are parameterized in the returned CloudFormation template.
(dict) --
Controls how a specific VPCConnection resource is parameterized in the outputted CloudFormation template.
Arn (string) --
The ARN of the specific VPCConnection resource whose override properties are configured in this structure.
Properties (list) --
A list of VPCConnection resource properties to generate variables for in the returned CloudFormation template.
(string) --
RefreshSchedules (list) --
An optional list of structures that control how RefreshSchedule resources are parameterized in the returned CloudFormation template.
(dict) --
Controls how a specific RefreshSchedule resource is parameterized in the returned CloudFormation template.
Arn (string) --
The ARN of the specific RefreshSchedule resource whose override properties are configured in this structure.
Properties (list) --
A list of RefreshSchedule resource properties to generate variables for in the returned CloudFormation template.
(string) --
DataSources (list) --
An optional list of structures that control how DataSource resources are parameterized in the returned CloudFormation template.
(dict) --
Controls how a specific DataSource resource is parameterized in the returned CloudFormation template.
Arn (string) --
The ARN of the specific DataSource resource whose override properties are configured in this structure.
Properties (list) --
A list of DataSource resource properties to generate variables for in the returned CloudFormation template.
(string) --
DataSets (list) --
An optional list of structures that control how DataSet resources are parameterized in the returned CloudFormation template.
(dict) --
Controls how a specific DataSet resource is parameterized in the returned CloudFormation template.
Arn (string) --
The ARN of the specific DataSet resource whose override properties are configured in this structure.
Properties (list) --
A list of DataSet resource properties to generate variables for in the returned CloudFormation template.
(string) --
Themes (list) --
An optional list of structures that control how Theme resources are parameterized in the returned CloudFormation template.
(dict) --
Controls how a specific Theme resource is parameterized in the returned CloudFormation template.
Arn (string) --
The ARN of the specific Theme resource whose override properties are configured in this structure.
Properties (list) --
A list of Theme resource properties to generate variables for in the returned CloudFormation template.
(string) --
Analyses (list) --
An optional list of structures that control how Analysis resources are parameterized in the returned CloudFormation template.
(dict) --
Controls how a specific Analysis resource is parameterized in the returned CloudFormation template.
Arn (string) --
The ARN of the specific Analysis resource whose override properties are configured in this structure.
Properties (list) --
A list of Analysis resource properties to generate variables for in the returned CloudFormation template.
(string) --
Dashboards (list) --
An optional list of structures that control how Dashboard resources are parameterized in the returned CloudFormation template.
(dict) --
Controls how a specific Dashboard resource is parameterized in the returned CloudFormation template.
Arn (string) --
The ARN of the specific Dashboard resource whose override properties are configured in this structure.
Properties (list) --
A list of Dashboard resource properties to generate variables for in the returned CloudFormation template.
(string) --
Folders (list) --
An optional list of structures that controls how Folder resources are parameterized in the returned CloudFormation template.
(dict) --
Controls how a specific Folder resource is parameterized in the returned CloudFormation template.
Arn (string) --
The ARN of the specific Folder resource whose override properties are configured in this structure.
Properties (list) --
A list of Folder resource properties to generate variables for in the returned CloudFormation template.
(string) --
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the response.
IncludePermissions (boolean) --
The include permissions flag.
IncludeTags (boolean) --
The include tags flag.
ValidationStrategy (dict) --
The validation strategy that is used to export the analysis or dashboard.
StrictModeForAllResources (boolean) --
A Boolean value that indicates whether to export resources under strict or lenient mode.
Warnings (list) --
An array of warning records that describe the analysis or dashboard that is exported. This array includes UI errors that can be skipped during the validation process.
This property only appears if StrictModeForAllResources in ValidationStrategy is set to FALSE.
(dict) --
Describes a warning that occurred during an Asset Bundle export job.
Arn (string) --
The ARN of the resource whose processing caused a warning.
Message (string) --
A description of the warning.
IncludeFolderMemberships (boolean) --
The include folder memberships flag.
IncludeFolderMembers (string) --
A setting that determines whether folder members are included.
{'OverrideParameters': {'DataSets': {'DataSetRefreshProperties': {'FailureConfiguration': {'EmailAlert': {'AlertStatus': 'ENABLED '
'| '
'DISABLED'}},
'RefreshConfiguration': {'IncrementalRefresh': {'LookbackWindow': {'ColumnName': 'string',
'Size': 'long',
'SizeUnit': 'HOUR '
'| '
'DAY '
'| '
'WEEK'}}}}},
'DataSources': {'DataSourceParameters': {'OracleParameters': {'UseServiceName': 'boolean'}}}}}
Describes an existing import job.
Poll job descriptions after starting a job to know when it has succeeded or failed. Job descriptions are available for 14 days after job starts.
See also: AWS API Documentation
Request Syntax
client.describe_asset_bundle_import_job(
AwsAccountId='string',
AssetBundleImportJobId='string'
)
string
[REQUIRED]
The ID of the Amazon Web Services account the import job was executed in.
string
[REQUIRED]
The ID of the job. The job ID is set when you start a new job with a StartAssetBundleImportJob API call.
dict
Response Syntax
{
'JobStatus': 'QUEUED_FOR_IMMEDIATE_EXECUTION'|'IN_PROGRESS'|'SUCCESSFUL'|'FAILED'|'FAILED_ROLLBACK_IN_PROGRESS'|'FAILED_ROLLBACK_COMPLETED'|'FAILED_ROLLBACK_ERROR',
'Errors': [
{
'Arn': 'string',
'Type': 'string',
'Message': 'string'
},
],
'RollbackErrors': [
{
'Arn': 'string',
'Type': 'string',
'Message': 'string'
},
],
'Arn': 'string',
'CreatedTime': datetime(2015, 1, 1),
'AssetBundleImportJobId': 'string',
'AwsAccountId': 'string',
'AssetBundleImportSource': {
'Body': 'string',
'S3Uri': 'string'
},
'OverrideParameters': {
'ResourceIdOverrideConfiguration': {
'PrefixForAllResources': 'string'
},
'VPCConnections': [
{
'VPCConnectionId': 'string',
'Name': 'string',
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
],
'DnsResolvers': [
'string',
],
'RoleArn': 'string'
},
],
'RefreshSchedules': [
{
'DataSetId': 'string',
'ScheduleId': 'string',
'StartAfterDateTime': datetime(2015, 1, 1)
},
],
'DataSources': [
{
'DataSourceId': 'string',
'Name': 'string',
'DataSourceParameters': {
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string',
'RoleArn': 'string'
},
'AuroraParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AuroraPostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AwsIotAnalyticsParameters': {
'DataSetName': 'string'
},
'JiraParameters': {
'SiteBaseUrl': 'string'
},
'MariaDbParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'MySqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'OracleParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'UseServiceName': True|False
},
'PostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PrestoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'RdsParameters': {
'InstanceId': 'string',
'Database': 'string'
},
'RedshiftParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'ClusterId': 'string',
'IAMParameters': {
'RoleArn': 'string',
'DatabaseUser': 'string',
'DatabaseGroups': [
'string',
],
'AutoCreateDatabaseUser': True|False
},
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string',
'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509',
'DatabaseAccessControlRole': 'string',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string'
}
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
},
'AmazonOpenSearchParameters': {
'Domain': 'string'
},
'ExasolParameters': {
'Host': 'string',
'Port': 123
},
'DatabricksParameters': {
'Host': 'string',
'Port': 123,
'SqlEndpointPath': 'string'
},
'StarburstParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string',
'ProductType': 'GALAXY'|'ENTERPRISE',
'DatabaseAccessControlRole': 'string',
'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string'
}
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'BigQueryParameters': {
'ProjectId': 'string',
'DataSetRegion': 'string'
}
},
'VpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'SslProperties': {
'DisableSsl': True|False
},
'Credentials': {
'CredentialPair': {
'Username': 'string',
'Password': 'string'
},
'SecretArn': 'string'
}
},
],
'DataSets': [
{
'DataSetId': 'string',
'Name': 'string',
'DataSetRefreshProperties': {
'RefreshConfiguration': {
'IncrementalRefresh': {
'LookbackWindow': {
'ColumnName': 'string',
'Size': 123,
'SizeUnit': 'HOUR'|'DAY'|'WEEK'
}
}
},
'FailureConfiguration': {
'EmailAlert': {
'AlertStatus': 'ENABLED'|'DISABLED'
}
}
}
},
],
'Themes': [
{
'ThemeId': 'string',
'Name': 'string'
},
],
'Analyses': [
{
'AnalysisId': 'string',
'Name': 'string'
},
],
'Dashboards': [
{
'DashboardId': 'string',
'Name': 'string'
},
],
'Folders': [
{
'FolderId': 'string',
'Name': 'string',
'ParentFolderArn': 'string'
},
]
},
'FailureAction': 'DO_NOTHING'|'ROLLBACK',
'RequestId': 'string',
'Status': 123,
'OverridePermissions': {
'DataSources': [
{
'DataSourceIds': [
'string',
],
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
}
},
],
'DataSets': [
{
'DataSetIds': [
'string',
],
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
}
},
],
'Themes': [
{
'ThemeIds': [
'string',
],
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
}
},
],
'Analyses': [
{
'AnalysisIds': [
'string',
],
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
}
},
],
'Dashboards': [
{
'DashboardIds': [
'string',
],
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
},
'LinkSharingConfiguration': {
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
}
}
},
],
'Folders': [
{
'FolderIds': [
'string',
],
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
}
},
]
},
'OverrideTags': {
'VPCConnections': [
{
'VPCConnectionIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'DataSources': [
{
'DataSourceIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'DataSets': [
{
'DataSetIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'Themes': [
{
'ThemeIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'Analyses': [
{
'AnalysisIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'Dashboards': [
{
'DashboardIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'Folders': [
{
'FolderIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
},
'OverrideValidationStrategy': {
'StrictModeForAllResources': True|False
},
'Warnings': [
{
'Arn': 'string',
'Message': 'string'
},
]
}
Response Structure
(dict) --
JobStatus (string) --
Indicates the status of a job through its queuing and execution.
Poll the DescribeAssetBundleImport API until JobStatus returns one of the following values:
SUCCESSFUL
FAILED
FAILED_ROLLBACK_COMPLETED
FAILED_ROLLBACK_ERROR
Errors (list) --
An array of error records that describes any failures that occurred during the export job processing.
Error records accumulate while the job is still running. The complete set of error records is available after the job has completed and failed.
(dict) --
Describes an error that occurred within an Asset Bundle import execution.
Arn (string) --
The ARN of the resource whose processing caused an error.
Type (string) --
The specific error type or the error that occurred.
Message (string) --
A description of the error.
RollbackErrors (list) --
An array of error records that describes any failures that occurred while an import job was attempting a rollback.
Error records accumulate while the job is still running. The complete set of error records is available after the job has completed and failed.
(dict) --
Describes an error that occurred within an Asset Bundle import execution.
Arn (string) --
The ARN of the resource whose processing caused an error.
Type (string) --
The specific error type or the error that occurred.
Message (string) --
A description of the error.
Arn (string) --
The Amazon Resource Name (ARN) for the import job.
CreatedTime (datetime) --
The time that the import job was created.
AssetBundleImportJobId (string) --
The ID of the job. The job ID is set when you start a new job with a StartAssetBundleImportJob API call.
AwsAccountId (string) --
The ID of the Amazon Web Services account the import job was executed in.
AssetBundleImportSource (dict) --
The source of the asset bundle zip file that contains the data that is imported by the job.
Body (string) --
An HTTPS download URL for the provided asset bundle that you optionally provided at the start of the import job. This URL is valid for five minutes after issuance. Call DescribeAssetBundleExportJob again for a fresh URL if needed. The downloaded asset bundle is a .qs zip file.
S3Uri (string) --
The Amazon S3 URI that you provided at the start of the import job.
OverrideParameters (dict) --
Optional overrides that are applied to the resource configuration before import.
ResourceIdOverrideConfiguration (dict) --
An optional structure that configures resource ID overrides to be applied within the import job.
PrefixForAllResources (string) --
An option to request a CloudFormation variable for a prefix to be prepended to each resource's ID before import. The prefix is only added to the asset IDs and does not change the name of the asset.
VPCConnections (list) --
A list of overrides for any VPCConnection resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single VPC connection that is imported.
VPCConnectionId (string) --
The ID of the VPC Connection to apply overrides to.
Name (string) --
A new name for the VPC connection.
SubnetIds (list) --
A list of new subnet IDs for the VPC connection you are importing. This field is required if you are importing the VPC connection from another Amazon Web Services account or Region.
(string) --
SecurityGroupIds (list) --
A new security group ID for the VPC connection you are importing. This field is required if you are importing the VPC connection from another Amazon Web Services account or Region.
(string) --
DnsResolvers (list) --
An optional override of DNS resolvers to be used by the VPC connection.
(string) --
RoleArn (string) --
An optional override of the role ARN to be used by the VPC connection.
RefreshSchedules (list) --
A list of overrides for any RefreshSchedule resources that are present in the asset bundle that is imported.
(dict) --
A list of overrides for a specific RefreshsSchedule resource that is present in the asset bundle that is imported.
DataSetId (string) --
A partial identifier for the specific RefreshSchedule resource that is being overridden. This structure is used together with the ScheduleID structure.
ScheduleId (string) --
A partial identifier for the specific RefreshSchedule resource being overridden. This structure is used together with the DataSetId structure.
StartAfterDateTime (datetime) --
An override for the StartAfterDateTime of a RefreshSchedule. Make sure that the StartAfterDateTime is set to a time that takes place in the future.
DataSources (list) --
A list of overrides for any DataSource resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single data source that is being imported.
DataSourceId (string) --
The ID of the data source to apply overrides to.
Name (string) --
A new name for the data source.
DataSourceParameters (dict) --
The parameters that Amazon QuickSight uses to connect to your underlying data source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
AmazonElasticsearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) --
The OpenSearch domain.
AthenaParameters (dict) --
The parameters for Amazon Athena.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.
AuroraParameters (dict) --
The parameters for Amazon Aurora MySQL.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
AuroraPostgreSqlParameters (dict) --
The parameters for Amazon Aurora.
Host (string) --
The Amazon Aurora PostgreSQL-Compatible host to connect to.
Port (integer) --
The port that Amazon Aurora PostgreSQL is listening on.
Database (string) --
The Amazon Aurora PostgreSQL database to connect to.
AwsIotAnalyticsParameters (dict) --
The parameters for IoT Analytics.
DataSetName (string) --
Dataset name.
JiraParameters (dict) --
The parameters for Jira.
SiteBaseUrl (string) --
The base URL of the Jira site.
MariaDbParameters (dict) --
The parameters for MariaDB.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
MySqlParameters (dict) --
The parameters for MySQL.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
OracleParameters (dict) --
The parameters for Oracle.
Host (string) --
An Oracle host.
Port (integer) --
The port.
Database (string) --
The database.
UseServiceName (boolean) --
A Boolean value that indicates whether the Database uses a service name or an SID. If this value is left blank, the default value is SID. If this value is set to false, the value is SID.
PostgreSqlParameters (dict) --
The parameters for PostgreSQL.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
PrestoParameters (dict) --
The parameters for Presto.
Host (string) --
Host.
Port (integer) --
Port.
Catalog (string) --
Catalog.
RdsParameters (dict) --
The parameters for Amazon RDS.
InstanceId (string) --
Instance ID.
Database (string) --
Database.
RedshiftParameters (dict) --
The parameters for Amazon Redshift.
Host (string) --
Host. This field can be blank if ClusterId is provided.
Port (integer) --
Port. This field can be blank if the ClusterId is provided.
Database (string) --
Database.
ClusterId (string) --
Cluster ID. This field can be blank if the Host and Port are provided.
IAMParameters (dict) --
An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials.
RoleArn (string) --
Use the RoleArn structure to allow Amazon QuickSight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role.
DatabaseUser (string) --
The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.
DatabaseGroups (list) --
A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the DatabaseUser. If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup.
(string) --
AutoCreateDatabaseUser (boolean) --
Automatically creates a database user. If your database doesn't have a DatabaseUser, set this parameter to True. If there is no DatabaseUser, Amazon QuickSight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Amazon QuickSight access to your cluster.
This parameter can only be specified if your Amazon QuickSight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
S3Parameters (dict) --
The parameters for S3.
ManifestFileLocation (dict) --
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight.
Bucket (string) --
Amazon S3 bucket.
Key (string) --
Amazon S3 key that identifies an object.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
ServiceNowParameters (dict) --
The parameters for ServiceNow.
SiteBaseUrl (string) --
URL of the base site.
SnowflakeParameters (dict) --
The parameters for Snowflake.
Host (string) --
Host.
Database (string) --
Database.
Warehouse (string) --
Warehouse.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
DatabaseAccessControlRole (string) --
The database access control role.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Amazon QuickSight account and Snowflake.
TokenProviderUrl (string) --
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) --
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
SparkParameters (dict) --
The parameters for Spark.
Host (string) --
Host.
Port (integer) --
Port.
SqlServerParameters (dict) --
The parameters for SQL Server.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TeradataParameters (dict) --
The parameters for Teradata.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TwitterParameters (dict) --
The parameters for Twitter.
Query (string) --
Twitter query string.
MaxRows (integer) --
Maximum number of rows to query Twitter.
AmazonOpenSearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) --
The OpenSearch domain.
ExasolParameters (dict) --
The parameters for Exasol.
Host (string) --
The hostname or IP address of the Exasol data source.
Port (integer) --
The port for the Exasol data source.
DatabricksParameters (dict) --
The parameters that are required to connect to a Databricks data source.
Host (string) --
The host name of the Databricks data source.
Port (integer) --
The port for the Databricks data source.
SqlEndpointPath (string) --
The HTTP path of the Databricks data source.
StarburstParameters (dict) --
The parameters that are required to connect to a Starburst data source.
Host (string) --
The host name of the Starburst data source.
Port (integer) --
The port for the Starburst data source.
Catalog (string) --
The catalog name for the Starburst data source.
ProductType (string) --
The product type for the Starburst data source.
DatabaseAccessControlRole (string) --
The database access control role.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Amazon QuickSight account and Starburst.
TokenProviderUrl (string) --
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) --
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
TrinoParameters (dict) --
The parameters that are required to connect to a Trino data source.
Host (string) --
The host name of the Trino data source.
Port (integer) --
The port for the Trino data source.
Catalog (string) --
The catalog name for the Trino data source.
BigQueryParameters (dict) --
The parameters that are required to connect to a Google BigQuery data source.
ProjectId (string) --
The Google Cloud Platform project ID where your datasource was created.
DataSetRegion (string) --
The storage location where you create a Google BigQuery data source.
VpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) --
The Amazon Resource Name (ARN) for the VPC connection.
SslProperties (dict) --
Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying data source.
DisableSsl (boolean) --
A Boolean option to control whether SSL should be disabled.
Credentials (dict) --
An optional structure that provides the credentials to be used to create the imported data source.
CredentialPair (dict) --
A username and password credential pair to be used to create the imported data source. Keep this field blank if you are using a Secrets Manager secret to provide credentials.
Username (string) --
The username for the data source connection.
Password (string) --
The password for the data source connection.
SecretArn (string) --
The ARN of the Secrets Manager secret that's used to create the imported data source. Keep this field blank, unless you are using a secret in place of a credential pair.
DataSets (list) --
A list of overrides for any DataSet resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single dataset that is being imported.
DataSetId (string) --
The ID of the dataset to apply overrides to.
Name (string) --
A new name for the dataset.
DataSetRefreshProperties (dict) --
The refresh properties of a dataset.
RefreshConfiguration (dict) --
The refresh configuration for a dataset.
IncrementalRefresh (dict) --
The incremental refresh for the dataset.
LookbackWindow (dict) --
The lookback window setup for an incremental refresh configuration.
ColumnName (string) --
The name of the lookback window column.
Size (integer) --
The lookback window column size.
SizeUnit (string) --
The size unit that is used for the lookback window column. Valid values for this structure are HOUR, DAY, and WEEK.
FailureConfiguration (dict) --
The failure configuration for a dataset.
EmailAlert (dict) --
The email alert configuration for a dataset refresh failure.
AlertStatus (string) --
The status value that determines if email alerts are sent.
Themes (list) --
A list of overrides for any Theme resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single theme that is imported.
ThemeId (string) --
The ID of the theme to apply overrides to.
Name (string) --
A new name for the theme.
Analyses (list) --
A list of overrides for any Analysis resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single analysis that is being imported.
AnalysisId (string) --
The ID of the analysis that you ant to apply overrides to.
Name (string) --
A new name for the analysis.
Dashboards (list) --
A list of overrides for any Dashboard resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single dashboard that is being imported.
DashboardId (string) --
The ID of the dashboard that you want to apply overrides to.
Name (string) --
A new name for the dashboard.
Folders (list) --
A list of overrides for any Folder resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single folder that is being imported.
FolderId (string) --
The ID of the folder that you want to apply overrides to.
Name (string) --
A new name for the folder.
ParentFolderArn (string) --
A new parent folder arn. This change can only be applied if the import creates a brand new folder. Existing folders cannot be moved.
FailureAction (string) --
The failure action for the import job.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the response.
OverridePermissions (dict) --
Optional permission overrides that are applied to the resource configuration before import.
DataSources (list) --
A list of permissions overrides for any DataSource resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of permissions to be applied to a list of data source IDs.
DataSourceIds (list) --
A list of data source IDs that you want to apply overrides to. You can use * to override all data sources in this asset bundle.
(string) --
Permissions (dict) --
A list of permissions for the data source that you want to apply overrides to.
Principals (list) --
A list of principals to grant permissions on.
(string) --
Actions (list) --
A list of IAM actions to grant permissions on.
(string) --
DataSets (list) --
A list of permissions overrides for any DataSet resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of permissions to be applied to a list of dataset IDs.
DataSetIds (list) --
A list of dataset IDs that you want to apply overrides to. You can use * to override all datasets in this asset bundle.
(string) --
Permissions (dict) --
A list of permissions for the datasets that you want to apply overrides to.
Principals (list) --
A list of principals to grant permissions on.
(string) --
Actions (list) --
A list of IAM actions to grant permissions on.
(string) --
Themes (list) --
A list of permissions overrides for any Theme resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of permissions to be applied to a list of theme IDs.
ThemeIds (list) --
A list of theme IDs that you want to apply overrides to. You can use * to override all themes in this asset bundle.
(string) --
Permissions (dict) --
A list of permissions for the themes that you want to apply overrides to.
Principals (list) --
A list of principals to grant permissions on.
(string) --
Actions (list) --
A list of IAM actions to grant permissions on.
(string) --
Analyses (list) --
A list of permissions overrides for any Analysis resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of permissions to be applied to a list of analysis IDs.
AnalysisIds (list) --
A list of analysis IDs that you want to apply overrides to. You can use * to override all analyses in this asset bundle.
(string) --
Permissions (dict) --
A list of permissions for the analyses that you want to apply overrides to.
Principals (list) --
A list of principals to grant permissions on.
(string) --
Actions (list) --
A list of IAM actions to grant permissions on.
(string) --
Dashboards (list) --
A list of permissions overrides for any Dashboard resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of permissions to be applied to a list of dashboard IDs.
DashboardIds (list) --
A list of dashboard IDs that you want to apply overrides to. You can use * to override all dashboards in this asset bundle.
(string) --
Permissions (dict) --
A list of permissions for the dashboards that you want to apply overrides to.
Principals (list) --
A list of principals to grant permissions on.
(string) --
Actions (list) --
A list of IAM actions to grant permissions on.
(string) --
LinkSharingConfiguration (dict) --
A structure that contains the link sharing configurations that you want to apply overrides to.
Permissions (dict) --
A list of link sharing permissions for the dashboards that you want to apply overrides to.
Principals (list) --
A list of principals to grant permissions on.
(string) --
Actions (list) --
A list of IAM actions to grant permissions on.
(string) --
Folders (list) --
A list of permissions for the folders that you want to apply overrides to.
(dict) --
An object that contains a list of permissions to be applied to a list of folder IDs.
FolderIds (list) --
A list of folder IDs that you want to apply overrides to. You can use * to override all folders in this asset bundle.
(string) --
Permissions (dict) --
A structure that contains the permissions for the resource that you want to override in an asset bundle import job.
Principals (list) --
A list of principals to grant permissions on.
(string) --
Actions (list) --
A list of IAM actions to grant permissions on.
(string) --
OverrideTags (dict) --
Optional tag overrides that are applied to the resource configuration before import.
VPCConnections (list) --
A list of tag overrides for any VPCConnection resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of VPC connection IDs.
VPCConnectionIds (list) --
A list of VPC connection IDs that you want to apply overrides to. You can use * to override all VPC connections in this asset bundle.
(string) --
Tags (list) --
A list of tags for the VPC connections that you want to apply overrides to.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) --
Tag key.
Value (string) --
Tag value.
DataSources (list) --
A list of tag overrides for any DataSource resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of data source IDs.
DataSourceIds (list) --
A list of data source IDs that you want to apply overrides to. You can use * to override all data sources in this asset bundle.
(string) --
Tags (list) --
A list of tags for the data source that you want to apply overrides to.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) --
Tag key.
Value (string) --
Tag value.
DataSets (list) --
A list of tag overrides for any DataSet resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of dataset IDs.
DataSetIds (list) --
A list of dataset IDs that you want to apply overrides to. You can use * to override all datasets in this asset bundle.
(string) --
Tags (list) --
A list of tags for the datasets that you want to apply overrides to.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) --
Tag key.
Value (string) --
Tag value.
Themes (list) --
A list of tag overrides for any Theme resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of theme IDs.
ThemeIds (list) --
A list of theme IDs that you want to apply overrides to. You can use * to override all themes in this asset bundle.
(string) --
Tags (list) --
A list of tags for the themes that you want to apply overrides to.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) --
Tag key.
Value (string) --
Tag value.
Analyses (list) --
A list of tag overrides for any Analysis resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of analysis IDs.
AnalysisIds (list) --
A list of analysis IDs that you want to apply overrides to. You can use * to override all analyses in this asset bundle.
(string) --
Tags (list) --
A list of tags for the analyses that you want to apply overrides to.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) --
Tag key.
Value (string) --
Tag value.
Dashboards (list) --
A list of tag overrides for any Dashboard resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of dashboard IDs.
DashboardIds (list) --
A list of dashboard IDs that you want to apply overrides to. You can use * to override all dashboards in this asset bundle.
(string) --
Tags (list) --
A list of tags for the dashboards that you want to apply overrides to.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) --
Tag key.
Value (string) --
Tag value.
Folders (list) --
A list of tag overrides for any Folder resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of folder IDs.
FolderIds (list) --
A list of folder IDs that you want to apply overrides to. You can use * to override all folders in this asset bundle.
(string) --
Tags (list) --
A list of tags for the folders that you want to apply overrides to.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) --
Tag key.
Value (string) --
Tag value.
OverrideValidationStrategy (dict) --
An optional validation strategy override for all analyses and dashboards to be applied to the resource configuration before import.
StrictModeForAllResources (boolean) --
A Boolean value that indicates whether to import all analyses and dashboards under strict or lenient mode.
Warnings (list) --
An array of warning records that describe all permitted errors that are encountered during the import job.
(dict) --
Describes a warning that occurred during an Asset Bundle import job.
Arn (string) --
The ARN of the resource that the warning occurred for.
Message (string) --
A description of the warning that occurred during an Asset Bundle import job.
{'DashboardPublishOptions': {'DataQAEnabledOption': {'AvailabilityStatus': 'ENABLED '
'| '
'DISABLED'}},
'Definition': {'Options': {'ExcludedDataSetArns': ['string'],
'QBusinessInsightsStatus': 'ENABLED | DISABLED'},
'Sheets': {'Visuals': {'TableVisual': {'ChartConfiguration': {'FieldOptions': {'TransposedTableOptions': [{'ColumnIndex': 'integer',
'ColumnType': 'ROW_HEADER_COLUMN '
'| '
'VALUE_COLUMN',
'ColumnWidth': 'string'}]}}}}}}}
Provides a detailed description of the definition of a dashboard.
See also: AWS API Documentation
Request Syntax
client.describe_dashboard_definition(
AwsAccountId='string',
DashboardId='string',
VersionNumber=123,
AliasName='string'
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the dashboard that you're describing.
string
[REQUIRED]
The ID for the dashboard.
integer
The version number for the dashboard. If a version number isn't passed, the latest published dashboard version is described.
string
The alias name.
dict
Response Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.
Response Structure
# This section is too large to render. # Please see the AWS API Documentation linked below.
{'DataSet': {'UseAs': 'RLS_RULES'}}
Describes a dataset. This operation doesn't support datasets that include uploaded files as a source.
See also: AWS API Documentation
Request Syntax
client.describe_data_set(
AwsAccountId='string',
DataSetId='string'
)
string
[REQUIRED]
The Amazon Web Services account ID.
string
[REQUIRED]
The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
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',
'SubType': 'FLOAT'|'FIXED'
},
]
},
'CustomSql': {
'DataSourceArn': 'string',
'Name': 'string',
'SqlQuery': 'string',
'Columns': [
{
'Name': 'string',
'Type': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME'|'BIT'|'BOOLEAN'|'JSON',
'SubType': 'FLOAT'|'FIXED'
},
]
},
'S3Source': {
'DataSourceArn': 'string',
'UploadSettings': {
'Format': 'CSV'|'TSV'|'CLF'|'ELF'|'XLSX'|'JSON',
'StartFromRow': 123,
'ContainsHeader': True|False,
'TextQualifier': 'DOUBLE_QUOTE'|'SINGLE_QUOTE',
'Delimiter': 'string'
},
'InputColumns': [
{
'Name': 'string',
'Type': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME'|'BIT'|'BOOLEAN'|'JSON',
'SubType': 'FLOAT'|'FIXED'
},
]
}
}
},
'LogicalTableMap': {
'string': {
'Alias': 'string',
'DataTransforms': [
{
'ProjectOperation': {
'ProjectedColumns': [
'string',
]
},
'FilterOperation': {
'ConditionExpression': 'string'
},
'CreateColumnsOperation': {
'Columns': [
{
'ColumnName': 'string',
'ColumnId': 'string',
'Expression': 'string'
},
]
},
'RenameColumnOperation': {
'ColumnName': 'string',
'NewColumnName': 'string'
},
'CastColumnTypeOperation': {
'ColumnName': 'string',
'NewColumnType': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME',
'SubType': 'FLOAT'|'FIXED',
'Format': 'string'
},
'TagColumnOperation': {
'ColumnName': 'string',
'Tags': [
{
'ColumnGeographicRole': 'COUNTRY'|'STATE'|'COUNTY'|'CITY'|'POSTCODE'|'LONGITUDE'|'LATITUDE',
'ColumnDescription': {
'Text': 'string'
}
},
]
},
'UntagColumnOperation': {
'ColumnName': 'string',
'TagNames': [
'COLUMN_GEOGRAPHIC_ROLE'|'COLUMN_DESCRIPTION',
]
},
'OverrideDatasetParameterOperation': {
'ParameterName': 'string',
'NewParameterName': 'string',
'NewDefaultValues': {
'StringStaticValues': [
'string',
],
'DecimalStaticValues': [
123.0,
],
'DateTimeStaticValues': [
datetime(2015, 1, 1),
],
'IntegerStaticValues': [
123,
]
}
}
},
],
'Source': {
'JoinInstruction': {
'LeftOperand': 'string',
'RightOperand': 'string',
'LeftJoinKeyProperties': {
'UniqueKey': True|False
},
'RightJoinKeyProperties': {
'UniqueKey': True|False
},
'Type': 'INNER'|'OUTER'|'LEFT'|'RIGHT',
'OnClause': 'string'
},
'PhysicalTableId': 'string',
'DataSetArn': 'string'
}
}
},
'OutputColumns': [
{
'Name': 'string',
'Description': 'string',
'Type': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME',
'SubType': 'FLOAT'|'FIXED'
},
],
'ImportMode': 'SPICE'|'DIRECT_QUERY',
'ConsumedSpiceCapacityInBytes': 123,
'ColumnGroups': [
{
'GeoSpatialColumnGroup': {
'Name': 'string',
'CountryCode': 'US',
'Columns': [
'string',
]
}
},
],
'FieldFolders': {
'string': {
'description': 'string',
'columns': [
'string',
]
}
},
'RowLevelPermissionDataSet': {
'Namespace': 'string',
'Arn': 'string',
'PermissionPolicy': 'GRANT_ACCESS'|'DENY_ACCESS',
'FormatVersion': 'VERSION_1'|'VERSION_2',
'Status': 'ENABLED'|'DISABLED'
},
'RowLevelPermissionTagConfiguration': {
'Status': 'ENABLED'|'DISABLED',
'TagRules': [
{
'TagKey': 'string',
'ColumnName': 'string',
'TagMultiValueDelimiter': 'string',
'MatchAllValue': 'string'
},
],
'TagRuleConfigurations': [
[
'string',
],
]
},
'ColumnLevelPermissionRules': [
{
'Principals': [
'string',
],
'ColumnNames': [
'string',
]
},
],
'DataSetUsageConfiguration': {
'DisableUseAsDirectQuerySource': True|False,
'DisableUseAsImportedSource': True|False
},
'DatasetParameters': [
{
'StringDatasetParameter': {
'Id': 'string',
'Name': 'string',
'ValueType': 'MULTI_VALUED'|'SINGLE_VALUED',
'DefaultValues': {
'StaticValues': [
'string',
]
}
},
'DecimalDatasetParameter': {
'Id': 'string',
'Name': 'string',
'ValueType': 'MULTI_VALUED'|'SINGLE_VALUED',
'DefaultValues': {
'StaticValues': [
123.0,
]
}
},
'IntegerDatasetParameter': {
'Id': 'string',
'Name': 'string',
'ValueType': 'MULTI_VALUED'|'SINGLE_VALUED',
'DefaultValues': {
'StaticValues': [
123,
]
}
},
'DateTimeDatasetParameter': {
'Id': 'string',
'Name': 'string',
'ValueType': 'MULTI_VALUED'|'SINGLE_VALUED',
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'DefaultValues': {
'StaticValues': [
datetime(2015, 1, 1),
]
}
}
},
],
'PerformanceConfiguration': {
'UniqueKeys': [
{
'ColumnNames': [
'string',
]
},
]
},
'UseAs': 'RLS_RULES'
},
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
DataSet (dict) --
Information on the dataset.
Arn (string) --
The Amazon Resource Name (ARN) of the resource.
DataSetId (string) --
The ID of the dataset.
Name (string) --
A display name for the dataset.
CreatedTime (datetime) --
The time that this dataset was created.
LastUpdatedTime (datetime) --
The last time that this dataset was updated.
PhysicalTableMap (dict) --
Declares the physical tables that are available in the underlying data sources.
(string) --
(dict) --
A view of a data source that contains information about the shape of the data in the underlying source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
RelationalTable (dict) --
A physical table type for relational data sources.
DataSourceArn (string) --
The Amazon Resource Name (ARN) for the data source.
Catalog (string) --
The catalog associated with a table.
Schema (string) --
The schema name. This name applies to certain relational database engines.
Name (string) --
The name of the relational table.
InputColumns (list) --
The column schema of the table.
(dict) --
Metadata for a column that is used as the input of a transform operation.
Name (string) --
The name of this column in the underlying data source.
Type (string) --
The data type of the column.
SubType (string) --
The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset.
CustomSql (dict) --
A physical table type built from the results of the custom SQL query.
DataSourceArn (string) --
The Amazon Resource Name (ARN) of the data source.
Name (string) --
A display name for the SQL query result.
SqlQuery (string) --
The SQL query.
Columns (list) --
The column schema from the SQL query result set.
(dict) --
Metadata for a column that is used as the input of a transform operation.
Name (string) --
The name of this column in the underlying data source.
Type (string) --
The data type of the column.
SubType (string) --
The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset.
S3Source (dict) --
A physical table type for as S3 data source.
DataSourceArn (string) --
The Amazon Resource Name (ARN) for the data source.
UploadSettings (dict) --
Information about the format for the S3 source file or files.
Format (string) --
File format.
StartFromRow (integer) --
A row number to start reading data from.
ContainsHeader (boolean) --
Whether the file has a header row, or the files each have a header row.
TextQualifier (string) --
Text qualifier.
Delimiter (string) --
The delimiter between values in the file.
InputColumns (list) --
A physical table type for an S3 data source.
(dict) --
Metadata for a column that is used as the input of a transform operation.
Name (string) --
The name of this column in the underlying data source.
Type (string) --
The data type of the column.
SubType (string) --
The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset.
LogicalTableMap (dict) --
Configures the combination and transformation of the data from the physical tables.
(string) --
An identifier for the logical table that is defined in the dataset
(dict) --
A logical table is a unit that joins and that data transformations operate on. A logical table has a source, which can be either a physical table or result of a join. When a logical table points to a physical table, the logical table acts as a mutable copy of that physical table through transform operations.
Alias (string) --
A display name for the logical table.
DataTransforms (list) --
Transform operations that act on this logical table. For this structure to be valid, only one of the attributes can be non-null.
(dict) --
A data transformation on a logical table. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
ProjectOperation (dict) --
An operation that projects columns. Operations that come after a projection can only refer to projected columns.
ProjectedColumns (list) --
Projected columns.
(string) --
FilterOperation (dict) --
An operation that filters rows based on some condition.
ConditionExpression (string) --
An expression that must evaluate to a Boolean value. Rows for which the expression evaluates to true are kept in the dataset.
CreateColumnsOperation (dict) --
An operation that creates calculated columns. Columns created in one such operation form a lexical closure.
Columns (list) --
Calculated columns to create.
(dict) --
A calculated column for a dataset.
ColumnName (string) --
Column name.
ColumnId (string) --
A unique ID to identify a calculated column. During a dataset update, if the column ID of a calculated column matches that of an existing calculated column, Amazon QuickSight preserves the existing calculated column.
Expression (string) --
An expression that defines the calculated column.
RenameColumnOperation (dict) --
An operation that renames a column.
ColumnName (string) --
The name of the column to be renamed.
NewColumnName (string) --
The new name for the column.
CastColumnTypeOperation (dict) --
A transform operation that casts a column to a different type.
ColumnName (string) --
Column name.
NewColumnType (string) --
New column data type.
SubType (string) --
The sub data type of the new column. Sub types are only available for decimal columns that are part of a SPICE dataset.
Format (string) --
When casting a column from string to datetime type, you can supply a string in a format supported by Amazon QuickSight to denote the source data format.
TagColumnOperation (dict) --
An operation that tags a column with additional information.
ColumnName (string) --
The column that this operation acts on.
Tags (list) --
The dataset column tag, currently only used for geospatial type tagging.
(dict) --
A tag for a column in a TagColumnOperation structure. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
ColumnGeographicRole (string) --
A geospatial role for a column.
ColumnDescription (dict) --
A description for a column.
Text (string) --
The text of a description for a column.
UntagColumnOperation (dict) --
A transform operation that removes tags associated with a column.
ColumnName (string) --
The column that this operation acts on.
TagNames (list) --
The column tags to remove from this column.
(string) --
OverrideDatasetParameterOperation (dict) --
A transform operation that overrides the dataset parameter values that are defined in another dataset.
ParameterName (string) --
The name of the parameter to be overridden with different values.
NewParameterName (string) --
The new name for the parameter.
NewDefaultValues (dict) --
The new default values for the parameter.
StringStaticValues (list) --
A list of static default values for a given string parameter.
(string) --
The default value for the string parameter.
DecimalStaticValues (list) --
A list of static default values for a given decimal parameter.
(float) --
The default value for the decimal parameter.
DateTimeStaticValues (list) --
A list of static default values for a given date time parameter.
(datetime) --
The default value for the date time parameter.
IntegerStaticValues (list) --
A list of static default values for a given integer parameter.
(integer) --
The default value for the integer parameter.
Source (dict) --
Source of this logical table.
JoinInstruction (dict) --
Specifies the result of a join of two logical tables.
LeftOperand (string) --
The operand on the left side of a join.
RightOperand (string) --
The operand on the right side of a join.
LeftJoinKeyProperties (dict) --
Join key properties of the left operand.
UniqueKey (boolean) --
A value that indicates that a row in a table is uniquely identified by the columns in a join key. This is used by Amazon QuickSight to optimize query performance.
RightJoinKeyProperties (dict) --
Join key properties of the right operand.
UniqueKey (boolean) --
A value that indicates that a row in a table is uniquely identified by the columns in a join key. This is used by Amazon QuickSight to optimize query performance.
Type (string) --
The type of join that it is.
OnClause (string) --
The join instructions provided in the ON clause of a join.
PhysicalTableId (string) --
Physical table ID.
DataSetArn (string) --
The Amazon Resource Number (ARN) of the parent dataset.
OutputColumns (list) --
The list of columns after all transforms. These columns are available in templates, analyses, and dashboards.
(dict) --
Output column.
Name (string) --
The display name of the column..
Description (string) --
A description for a column.
Type (string) --
The data type of the column.
SubType (string) --
The sub data type of the column.
ImportMode (string) --
A value that indicates whether you want to import the data into SPICE.
ConsumedSpiceCapacityInBytes (integer) --
The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't imported into SPICE.
ColumnGroups (list) --
Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.
(dict) --
Groupings of columns that work together in certain Amazon QuickSight features. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
GeoSpatialColumnGroup (dict) --
Geospatial column group that denotes a hierarchy.
Name (string) --
A display name for the hierarchy.
CountryCode (string) --
Country code.
Columns (list) --
Columns in this hierarchy.
(string) --
FieldFolders (dict) --
The folder that contains fields and nested subfolders for your dataset.
(string) --
(dict) --
A FieldFolder element is a folder that contains fields and nested subfolders.
description (string) --
The description for a field folder.
columns (list) --
A folder has a list of columns. A column can only be in one folder.
(string) --
RowLevelPermissionDataSet (dict) --
The row-level security configuration for the dataset.
Namespace (string) --
The namespace associated with the dataset that contains permissions for RLS.
Arn (string) --
The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.
PermissionPolicy (string) --
The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS is included for backward compatibility only.
FormatVersion (string) --
The user or group rules associated with the dataset that contains permissions for RLS.
By default, FormatVersion is VERSION_1. When FormatVersion is VERSION_1, UserName and GroupName are required. When FormatVersion is VERSION_2, UserARN and GroupARN are required, and Namespace must not exist.
Status (string) --
The status of the row-level security permission dataset. If enabled, the status is ENABLED. If disabled, the status is DISABLED.
RowLevelPermissionTagConfiguration (dict) --
The element you can use to define tags for row-level security.
Status (string) --
The status of row-level security tags. If enabled, the status is ENABLED. If disabled, the status is DISABLED.
TagRules (list) --
A set of rules associated with row-level security, such as the tag names and columns that they are assigned to.
(dict) --
A set of rules associated with a tag.
TagKey (string) --
The unique key for a tag.
ColumnName (string) --
The column name that a tag key is assigned to.
TagMultiValueDelimiter (string) --
A string that you want to use to delimit the values when you pass the values at run time. For example, you can delimit the values with a comma.
MatchAllValue (string) --
A string that you want to use to filter by all the values in a column in the dataset and don’t want to list the values one by one. For example, you can use an asterisk as your match all value.
TagRuleConfigurations (list) --
A list of tag configuration rules to apply to a dataset. All tag configurations have the OR condition. Tags within each tile will be joined (AND). At least one rule in this structure must have all tag values assigned to it to apply Row-level security (RLS) to the dataset.
(list) --
(string) --
ColumnLevelPermissionRules (list) --
A set of one or more definitions of a ``ColumnLevelPermissionRule ``.
(dict) --
A rule defined to grant access on one or more restricted columns. Each dataset can have multiple rules. To create a restricted column, you add it to one or more rules. Each rule must contain at least one column and at least one user or group. To be able to see a restricted column, a user or group needs to be added to a rule for that column.
Principals (list) --
An array of Amazon Resource Names (ARNs) for Amazon QuickSight users or groups.
(string) --
ColumnNames (list) --
An array of column names.
(string) --
DataSetUsageConfiguration (dict) --
The usage configuration to apply to child datasets that reference this dataset as a source.
DisableUseAsDirectQuerySource (boolean) --
An option that controls whether a child dataset of a direct query can use this dataset as a source.
DisableUseAsImportedSource (boolean) --
An option that controls whether a child dataset that's stored in QuickSight can use this dataset as a source.
DatasetParameters (list) --
The parameters that are declared in a dataset.
(dict) --
A parameter that is created in a dataset. The parameter can be a string, integer, decimal, or datetime data type.
StringDatasetParameter (dict) --
A string parameter that is created in the dataset.
Id (string) --
An identifier for the string parameter that is created in the dataset.
Name (string) --
The name of the string parameter that is created in the dataset.
ValueType (string) --
The value type of the dataset parameter. Valid values are single value or multi value.
DefaultValues (dict) --
A list of default values for a given string dataset parameter type. This structure only accepts static values.
StaticValues (list) --
A list of static default values for a given string parameter.
(string) --
The default value for the string parameter.
DecimalDatasetParameter (dict) --
A decimal parameter that is created in the dataset.
Id (string) --
An identifier for the decimal parameter created in the dataset.
Name (string) --
The name of the decimal parameter that is created in the dataset.
ValueType (string) --
The value type of the dataset parameter. Valid values are single value or multi value.
DefaultValues (dict) --
A list of default values for a given decimal parameter. This structure only accepts static values.
StaticValues (list) --
A list of static default values for a given decimal parameter.
(float) --
The default value for the decimal parameter.
IntegerDatasetParameter (dict) --
An integer parameter that is created in the dataset.
Id (string) --
An identifier for the integer parameter created in the dataset.
Name (string) --
The name of the integer parameter that is created in the dataset.
ValueType (string) --
The value type of the dataset parameter. Valid values are single value or multi value.
DefaultValues (dict) --
A list of default values for a given integer parameter. This structure only accepts static values.
StaticValues (list) --
A list of static default values for a given integer parameter.
(integer) --
The default value for the integer parameter.
DateTimeDatasetParameter (dict) --
A date time parameter that is created in the dataset.
Id (string) --
An identifier for the parameter that is created in the dataset.
Name (string) --
The name of the date time parameter that is created in the dataset.
ValueType (string) --
The value type of the dataset parameter. Valid values are single value or multi value.
TimeGranularity (string) --
The time granularity of the date time parameter.
DefaultValues (dict) --
A list of default values for a given date time parameter. This structure only accepts static values.
StaticValues (list) --
A list of static default values for a given date time parameter.
(datetime) --
The default value for the date time parameter.
PerformanceConfiguration (dict) --
The performance optimization configuration of a dataset.
UniqueKeys (list) --
A UniqueKey configuration.
(dict) --
A UniqueKey configuration that references a dataset column.
ColumnNames (list) --
The name of the column that is referenced in the UniqueKey configuration.
(string) --
UseAs (string) --
The usage of the dataset.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'DataSetRefreshProperties': {'FailureConfiguration': {'EmailAlert': {'AlertStatus': 'ENABLED '
'| '
'DISABLED'}}}}
Describes the refresh properties of a dataset.
See also: AWS API Documentation
Request Syntax
client.describe_data_set_refresh_properties(
AwsAccountId='string',
DataSetId='string'
)
string
[REQUIRED]
The Amazon Web Services account ID.
string
[REQUIRED]
The ID of the dataset.
dict
Response Syntax
{
'RequestId': 'string',
'Status': 123,
'DataSetRefreshProperties': {
'RefreshConfiguration': {
'IncrementalRefresh': {
'LookbackWindow': {
'ColumnName': 'string',
'Size': 123,
'SizeUnit': 'HOUR'|'DAY'|'WEEK'
}
}
},
'FailureConfiguration': {
'EmailAlert': {
'AlertStatus': 'ENABLED'|'DISABLED'
}
}
}
}
Response Structure
(dict) --
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
DataSetRefreshProperties (dict) --
The dataset refresh properties.
RefreshConfiguration (dict) --
The refresh configuration for a dataset.
IncrementalRefresh (dict) --
The incremental refresh for the dataset.
LookbackWindow (dict) --
The lookback window setup for an incremental refresh configuration.
ColumnName (string) --
The name of the lookback window column.
Size (integer) --
The lookback window column size.
SizeUnit (string) --
The size unit that is used for the lookback window column. Valid values for this structure are HOUR, DAY, and WEEK.
FailureConfiguration (dict) --
The failure configuration for a dataset.
EmailAlert (dict) --
The email alert configuration for a dataset refresh failure.
AlertStatus (string) --
The status value that determines if email alerts are sent.
{'DataSource': {'AlternateDataSourceParameters': {'OracleParameters': {'UseServiceName': 'boolean'}},
'DataSourceParameters': {'OracleParameters': {'UseServiceName': 'boolean'}}}}
Describes a data source.
See also: AWS API Documentation
Request Syntax
client.describe_data_source(
AwsAccountId='string',
DataSourceId='string'
)
string
[REQUIRED]
The Amazon Web Services account ID.
string
[REQUIRED]
The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
dict
Response Syntax
{
'DataSource': {
'Arn': 'string',
'DataSourceId': 'string',
'Name': 'string',
'Type': 'ADOBE_ANALYTICS'|'AMAZON_ELASTICSEARCH'|'ATHENA'|'AURORA'|'AURORA_POSTGRESQL'|'AWS_IOT_ANALYTICS'|'GITHUB'|'JIRA'|'MARIADB'|'MYSQL'|'ORACLE'|'POSTGRESQL'|'PRESTO'|'REDSHIFT'|'S3'|'SALESFORCE'|'SERVICENOW'|'SNOWFLAKE'|'SPARK'|'SQLSERVER'|'TERADATA'|'TWITTER'|'TIMESTREAM'|'AMAZON_OPENSEARCH'|'EXASOL'|'DATABRICKS'|'STARBURST'|'TRINO'|'BIGQUERY',
'Status': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'DataSourceParameters': {
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string',
'RoleArn': 'string'
},
'AuroraParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AuroraPostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AwsIotAnalyticsParameters': {
'DataSetName': 'string'
},
'JiraParameters': {
'SiteBaseUrl': 'string'
},
'MariaDbParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'MySqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'OracleParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'UseServiceName': True|False
},
'PostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PrestoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'RdsParameters': {
'InstanceId': 'string',
'Database': 'string'
},
'RedshiftParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'ClusterId': 'string',
'IAMParameters': {
'RoleArn': 'string',
'DatabaseUser': 'string',
'DatabaseGroups': [
'string',
],
'AutoCreateDatabaseUser': True|False
},
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string',
'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509',
'DatabaseAccessControlRole': 'string',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string'
}
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
},
'AmazonOpenSearchParameters': {
'Domain': 'string'
},
'ExasolParameters': {
'Host': 'string',
'Port': 123
},
'DatabricksParameters': {
'Host': 'string',
'Port': 123,
'SqlEndpointPath': 'string'
},
'StarburstParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string',
'ProductType': 'GALAXY'|'ENTERPRISE',
'DatabaseAccessControlRole': 'string',
'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string'
}
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'BigQueryParameters': {
'ProjectId': 'string',
'DataSetRegion': 'string'
}
},
'AlternateDataSourceParameters': [
{
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string',
'RoleArn': 'string'
},
'AuroraParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AuroraPostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AwsIotAnalyticsParameters': {
'DataSetName': 'string'
},
'JiraParameters': {
'SiteBaseUrl': 'string'
},
'MariaDbParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'MySqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'OracleParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'UseServiceName': True|False
},
'PostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PrestoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'RdsParameters': {
'InstanceId': 'string',
'Database': 'string'
},
'RedshiftParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'ClusterId': 'string',
'IAMParameters': {
'RoleArn': 'string',
'DatabaseUser': 'string',
'DatabaseGroups': [
'string',
],
'AutoCreateDatabaseUser': True|False
},
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string',
'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509',
'DatabaseAccessControlRole': 'string',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string'
}
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
},
'AmazonOpenSearchParameters': {
'Domain': 'string'
},
'ExasolParameters': {
'Host': 'string',
'Port': 123
},
'DatabricksParameters': {
'Host': 'string',
'Port': 123,
'SqlEndpointPath': 'string'
},
'StarburstParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string',
'ProductType': 'GALAXY'|'ENTERPRISE',
'DatabaseAccessControlRole': 'string',
'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string'
}
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'BigQueryParameters': {
'ProjectId': 'string',
'DataSetRegion': 'string'
}
},
],
'VpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'SslProperties': {
'DisableSsl': True|False
},
'ErrorInfo': {
'Type': 'ACCESS_DENIED'|'COPY_SOURCE_NOT_FOUND'|'TIMEOUT'|'ENGINE_VERSION_NOT_SUPPORTED'|'UNKNOWN_HOST'|'GENERIC_SQL_FAILURE'|'CONFLICT'|'UNKNOWN',
'Message': 'string'
},
'SecretArn': 'string'
},
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
DataSource (dict) --
The information on the data source.
Arn (string) --
The Amazon Resource Name (ARN) of the data source.
DataSourceId (string) --
The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
Name (string) --
A display name for the data source.
Type (string) --
The type of the data source. This type indicates which database engine the data source connects to.
Status (string) --
The HTTP status of the request.
CreatedTime (datetime) --
The time that this data source was created.
LastUpdatedTime (datetime) --
The last time that this data source was updated.
DataSourceParameters (dict) --
The parameters that Amazon QuickSight uses to connect to your underlying source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
AmazonElasticsearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) --
The OpenSearch domain.
AthenaParameters (dict) --
The parameters for Amazon Athena.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.
AuroraParameters (dict) --
The parameters for Amazon Aurora MySQL.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
AuroraPostgreSqlParameters (dict) --
The parameters for Amazon Aurora.
Host (string) --
The Amazon Aurora PostgreSQL-Compatible host to connect to.
Port (integer) --
The port that Amazon Aurora PostgreSQL is listening on.
Database (string) --
The Amazon Aurora PostgreSQL database to connect to.
AwsIotAnalyticsParameters (dict) --
The parameters for IoT Analytics.
DataSetName (string) --
Dataset name.
JiraParameters (dict) --
The parameters for Jira.
SiteBaseUrl (string) --
The base URL of the Jira site.
MariaDbParameters (dict) --
The parameters for MariaDB.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
MySqlParameters (dict) --
The parameters for MySQL.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
OracleParameters (dict) --
The parameters for Oracle.
Host (string) --
An Oracle host.
Port (integer) --
The port.
Database (string) --
The database.
UseServiceName (boolean) --
A Boolean value that indicates whether the Database uses a service name or an SID. If this value is left blank, the default value is SID. If this value is set to false, the value is SID.
PostgreSqlParameters (dict) --
The parameters for PostgreSQL.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
PrestoParameters (dict) --
The parameters for Presto.
Host (string) --
Host.
Port (integer) --
Port.
Catalog (string) --
Catalog.
RdsParameters (dict) --
The parameters for Amazon RDS.
InstanceId (string) --
Instance ID.
Database (string) --
Database.
RedshiftParameters (dict) --
The parameters for Amazon Redshift.
Host (string) --
Host. This field can be blank if ClusterId is provided.
Port (integer) --
Port. This field can be blank if the ClusterId is provided.
Database (string) --
Database.
ClusterId (string) --
Cluster ID. This field can be blank if the Host and Port are provided.
IAMParameters (dict) --
An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials.
RoleArn (string) --
Use the RoleArn structure to allow Amazon QuickSight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role.
DatabaseUser (string) --
The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.
DatabaseGroups (list) --
A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the DatabaseUser. If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup.
(string) --
AutoCreateDatabaseUser (boolean) --
Automatically creates a database user. If your database doesn't have a DatabaseUser, set this parameter to True. If there is no DatabaseUser, Amazon QuickSight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Amazon QuickSight access to your cluster.
This parameter can only be specified if your Amazon QuickSight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
S3Parameters (dict) --
The parameters for S3.
ManifestFileLocation (dict) --
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight.
Bucket (string) --
Amazon S3 bucket.
Key (string) --
Amazon S3 key that identifies an object.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
ServiceNowParameters (dict) --
The parameters for ServiceNow.
SiteBaseUrl (string) --
URL of the base site.
SnowflakeParameters (dict) --
The parameters for Snowflake.
Host (string) --
Host.
Database (string) --
Database.
Warehouse (string) --
Warehouse.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
DatabaseAccessControlRole (string) --
The database access control role.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Amazon QuickSight account and Snowflake.
TokenProviderUrl (string) --
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) --
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
SparkParameters (dict) --
The parameters for Spark.
Host (string) --
Host.
Port (integer) --
Port.
SqlServerParameters (dict) --
The parameters for SQL Server.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TeradataParameters (dict) --
The parameters for Teradata.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TwitterParameters (dict) --
The parameters for Twitter.
Query (string) --
Twitter query string.
MaxRows (integer) --
Maximum number of rows to query Twitter.
AmazonOpenSearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) --
The OpenSearch domain.
ExasolParameters (dict) --
The parameters for Exasol.
Host (string) --
The hostname or IP address of the Exasol data source.
Port (integer) --
The port for the Exasol data source.
DatabricksParameters (dict) --
The parameters that are required to connect to a Databricks data source.
Host (string) --
The host name of the Databricks data source.
Port (integer) --
The port for the Databricks data source.
SqlEndpointPath (string) --
The HTTP path of the Databricks data source.
StarburstParameters (dict) --
The parameters that are required to connect to a Starburst data source.
Host (string) --
The host name of the Starburst data source.
Port (integer) --
The port for the Starburst data source.
Catalog (string) --
The catalog name for the Starburst data source.
ProductType (string) --
The product type for the Starburst data source.
DatabaseAccessControlRole (string) --
The database access control role.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Amazon QuickSight account and Starburst.
TokenProviderUrl (string) --
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) --
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
TrinoParameters (dict) --
The parameters that are required to connect to a Trino data source.
Host (string) --
The host name of the Trino data source.
Port (integer) --
The port for the Trino data source.
Catalog (string) --
The catalog name for the Trino data source.
BigQueryParameters (dict) --
The parameters that are required to connect to a Google BigQuery data source.
ProjectId (string) --
The Google Cloud Platform project ID where your datasource was created.
DataSetRegion (string) --
The storage location where you create a Google BigQuery data source.
AlternateDataSourceParameters (list) --
A set of alternate data source parameters that you want to share for the credentials stored with this data source. The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the DataSourceParameters structure that's in the request with the structures in the AlternateDataSourceParameters allow list. If the structures are an exact match, the request is allowed to use the credentials from this existing data source. If the AlternateDataSourceParameters list is null, the Credentials originally used with this DataSourceParameters are automatically allowed.
(dict) --
The parameters that Amazon QuickSight uses to connect to your underlying data source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
AmazonElasticsearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) --
The OpenSearch domain.
AthenaParameters (dict) --
The parameters for Amazon Athena.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.
AuroraParameters (dict) --
The parameters for Amazon Aurora MySQL.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
AuroraPostgreSqlParameters (dict) --
The parameters for Amazon Aurora.
Host (string) --
The Amazon Aurora PostgreSQL-Compatible host to connect to.
Port (integer) --
The port that Amazon Aurora PostgreSQL is listening on.
Database (string) --
The Amazon Aurora PostgreSQL database to connect to.
AwsIotAnalyticsParameters (dict) --
The parameters for IoT Analytics.
DataSetName (string) --
Dataset name.
JiraParameters (dict) --
The parameters for Jira.
SiteBaseUrl (string) --
The base URL of the Jira site.
MariaDbParameters (dict) --
The parameters for MariaDB.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
MySqlParameters (dict) --
The parameters for MySQL.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
OracleParameters (dict) --
The parameters for Oracle.
Host (string) --
An Oracle host.
Port (integer) --
The port.
Database (string) --
The database.
UseServiceName (boolean) --
A Boolean value that indicates whether the Database uses a service name or an SID. If this value is left blank, the default value is SID. If this value is set to false, the value is SID.
PostgreSqlParameters (dict) --
The parameters for PostgreSQL.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
PrestoParameters (dict) --
The parameters for Presto.
Host (string) --
Host.
Port (integer) --
Port.
Catalog (string) --
Catalog.
RdsParameters (dict) --
The parameters for Amazon RDS.
InstanceId (string) --
Instance ID.
Database (string) --
Database.
RedshiftParameters (dict) --
The parameters for Amazon Redshift.
Host (string) --
Host. This field can be blank if ClusterId is provided.
Port (integer) --
Port. This field can be blank if the ClusterId is provided.
Database (string) --
Database.
ClusterId (string) --
Cluster ID. This field can be blank if the Host and Port are provided.
IAMParameters (dict) --
An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials.
RoleArn (string) --
Use the RoleArn structure to allow Amazon QuickSight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role.
DatabaseUser (string) --
The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.
DatabaseGroups (list) --
A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the DatabaseUser. If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup.
(string) --
AutoCreateDatabaseUser (boolean) --
Automatically creates a database user. If your database doesn't have a DatabaseUser, set this parameter to True. If there is no DatabaseUser, Amazon QuickSight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Amazon QuickSight access to your cluster.
This parameter can only be specified if your Amazon QuickSight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
S3Parameters (dict) --
The parameters for S3.
ManifestFileLocation (dict) --
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight.
Bucket (string) --
Amazon S3 bucket.
Key (string) --
Amazon S3 key that identifies an object.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
ServiceNowParameters (dict) --
The parameters for ServiceNow.
SiteBaseUrl (string) --
URL of the base site.
SnowflakeParameters (dict) --
The parameters for Snowflake.
Host (string) --
Host.
Database (string) --
Database.
Warehouse (string) --
Warehouse.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
DatabaseAccessControlRole (string) --
The database access control role.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Amazon QuickSight account and Snowflake.
TokenProviderUrl (string) --
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) --
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
SparkParameters (dict) --
The parameters for Spark.
Host (string) --
Host.
Port (integer) --
Port.
SqlServerParameters (dict) --
The parameters for SQL Server.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TeradataParameters (dict) --
The parameters for Teradata.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TwitterParameters (dict) --
The parameters for Twitter.
Query (string) --
Twitter query string.
MaxRows (integer) --
Maximum number of rows to query Twitter.
AmazonOpenSearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) --
The OpenSearch domain.
ExasolParameters (dict) --
The parameters for Exasol.
Host (string) --
The hostname or IP address of the Exasol data source.
Port (integer) --
The port for the Exasol data source.
DatabricksParameters (dict) --
The parameters that are required to connect to a Databricks data source.
Host (string) --
The host name of the Databricks data source.
Port (integer) --
The port for the Databricks data source.
SqlEndpointPath (string) --
The HTTP path of the Databricks data source.
StarburstParameters (dict) --
The parameters that are required to connect to a Starburst data source.
Host (string) --
The host name of the Starburst data source.
Port (integer) --
The port for the Starburst data source.
Catalog (string) --
The catalog name for the Starburst data source.
ProductType (string) --
The product type for the Starburst data source.
DatabaseAccessControlRole (string) --
The database access control role.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Amazon QuickSight account and Starburst.
TokenProviderUrl (string) --
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) --
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
TrinoParameters (dict) --
The parameters that are required to connect to a Trino data source.
Host (string) --
The host name of the Trino data source.
Port (integer) --
The port for the Trino data source.
Catalog (string) --
The catalog name for the Trino data source.
BigQueryParameters (dict) --
The parameters that are required to connect to a Google BigQuery data source.
ProjectId (string) --
The Google Cloud Platform project ID where your datasource was created.
DataSetRegion (string) --
The storage location where you create a Google BigQuery data source.
VpcConnectionProperties (dict) --
The VPC connection information. You need to use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.
VpcConnectionArn (string) --
The Amazon Resource Name (ARN) for the VPC connection.
SslProperties (dict) --
Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.
DisableSsl (boolean) --
A Boolean option to control whether SSL should be disabled.
ErrorInfo (dict) --
Error information from the last update or the creation of the data source.
Type (string) --
Error type.
Message (string) --
Error message.
SecretArn (string) --
The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'Definition': {'Options': {'ExcludedDataSetArns': ['string'],
'QBusinessInsightsStatus': 'ENABLED | DISABLED'},
'Sheets': {'Visuals': {'TableVisual': {'ChartConfiguration': {'FieldOptions': {'TransposedTableOptions': [{'ColumnIndex': 'integer',
'ColumnType': 'ROW_HEADER_COLUMN '
'| '
'VALUE_COLUMN',
'ColumnWidth': 'string'}]}}}}}}}
Provides a detailed description of the definition of a template.
See also: AWS API Documentation
Request Syntax
client.describe_template_definition(
AwsAccountId='string',
TemplateId='string',
VersionNumber=123,
AliasName='string'
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the template. You must be using the Amazon Web Services account that the template is in.
string
[REQUIRED]
The ID of the template that you're describing.
integer
The version number of the template.
string
The alias of the template that you want to describe. If you name a specific alias, you describe the version that the alias points to. You can specify the latest version of the template by providing the keyword $LATEST in the AliasName parameter. The keyword $PUBLISHED doesn't apply to templates.
dict
Response Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.
Response Structure
# This section is too large to render. # Please see the AWS API Documentation linked below.
{'ExperienceConfiguration': {'Dashboard': {'FeatureConfigurations': {'AmazonQInQuickSight': {'ExecutiveSummary': {'Enabled': 'boolean'}},
'RecentSnapshots': {'Enabled': 'boolean'},
'Schedules': {'Enabled': 'boolean'},
'ThresholdAlerts': {'Enabled': 'boolean'}}},
'QuickSightConsole': {'FeatureConfigurations': {'AmazonQInQuickSight': {'DataQnA': {'Enabled': 'boolean'},
'DataStories': {'Enabled': 'boolean'},
'ExecutiveSummary': {'Enabled': 'boolean'},
'GenerativeAuthoring': {'Enabled': 'boolean'}},
'RecentSnapshots': {'Enabled': 'boolean'},
'Schedules': {'Enabled': 'boolean'},
'ThresholdAlerts': {'Enabled': 'boolean'}}}}}
Generates an embed URL that you can use to embed an Amazon QuickSight experience in your website. This action can be used for any type of user registered in an Amazon QuickSight account. Before you use this action, make sure that you have configured the relevant Amazon QuickSight resource and permissions.
The following rules apply to the generated URL:
It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.
The URL validity period should not be confused with the actual session lifetime that can be customized using the SessionLifetimeInMinutes parameter. The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours.
You are charged only when the URL is used or there is interaction with Amazon QuickSight.
For more information, see Embedded Analytics in the Amazon QuickSight User Guide.
For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
See also: AWS API Documentation
Request Syntax
client.generate_embed_url_for_registered_user(
AwsAccountId='string',
SessionLifetimeInMinutes=123,
UserArn='string',
ExperienceConfiguration={
'Dashboard': {
'InitialDashboardId': 'string',
'FeatureConfigurations': {
'StatePersistence': {
'Enabled': True|False
},
'SharedView': {
'Enabled': True|False
},
'Bookmarks': {
'Enabled': True|False
},
'AmazonQInQuickSight': {
'ExecutiveSummary': {
'Enabled': True|False
}
},
'Schedules': {
'Enabled': True|False
},
'RecentSnapshots': {
'Enabled': True|False
},
'ThresholdAlerts': {
'Enabled': True|False
}
}
},
'QuickSightConsole': {
'InitialPath': 'string',
'FeatureConfigurations': {
'StatePersistence': {
'Enabled': True|False
},
'SharedView': {
'Enabled': True|False
},
'AmazonQInQuickSight': {
'DataQnA': {
'Enabled': True|False
},
'GenerativeAuthoring': {
'Enabled': True|False
},
'ExecutiveSummary': {
'Enabled': True|False
},
'DataStories': {
'Enabled': True|False
}
},
'Schedules': {
'Enabled': True|False
},
'RecentSnapshots': {
'Enabled': True|False
},
'ThresholdAlerts': {
'Enabled': True|False
}
}
},
'QSearchBar': {
'InitialTopicId': 'string'
},
'DashboardVisual': {
'InitialDashboardVisualId': {
'DashboardId': 'string',
'SheetId': 'string',
'VisualId': 'string'
}
},
'GenerativeQnA': {
'InitialTopicId': 'string'
}
},
AllowedDomains=[
'string',
]
)
string
[REQUIRED]
The ID for the Amazon Web Services account that contains the dashboard that you're embedding.
integer
How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.
string
[REQUIRED]
The Amazon Resource Name for the registered user.
dict
[REQUIRED]
The experience that you want to embed. For registered users, you can embed Amazon QuickSight dashboards, Amazon QuickSight visuals, the Amazon QuickSight Q search bar, the Amazon QuickSight Generative Q&A experience, or the entire Amazon QuickSight console.
Dashboard (dict) --
The configuration details for providing a dashboard embedding experience.
InitialDashboardId (string) -- [REQUIRED]
The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this dashboard if the user has permissions to view it.
If the user does not have permission to view this dashboard, they see a permissions error message.
FeatureConfigurations (dict) --
The feature configurations of an embbedded Amazon QuickSight dashboard.
StatePersistence (dict) --
The state persistence settings of an embedded dashboard.
Enabled (boolean) -- [REQUIRED]
Determines if a Amazon QuickSight dashboard's state persistence settings are turned on or off.
SharedView (dict) --
The shared view settings of an embedded dashboard.
Enabled (boolean) -- [REQUIRED]
The shared view settings of an embedded dashboard.
Bookmarks (dict) --
The bookmarks configuration for an embedded dashboard in Amazon QuickSight.
Enabled (boolean) -- [REQUIRED]
A Boolean value that determines whether a user can bookmark an embedded dashboard.
AmazonQInQuickSight (dict) --
The Amazon Q configurations of an embedded Amazon QuickSight dashboard.
ExecutiveSummary (dict) --
A generated executive summary of an embedded Amazon QuickSight dashboard.
Enabled (boolean) -- [REQUIRED]
The executive summary settings of an embedded Amazon QuickSight console or dashboard.
Schedules (dict) --
The schedules configuration for an embedded Amazon QuickSight dashboard.
Enabled (boolean) -- [REQUIRED]
The schedules configuration for an embedded Amazon QuickSight dashboard.
RecentSnapshots (dict) --
The recent snapshots configuration for an Amazon QuickSight embedded dashboard
Enabled (boolean) -- [REQUIRED]
The recent snapshots configuration for an embedded Amazon QuickSight dashboard.
ThresholdAlerts (dict) --
The threshold alerts configuration for an Amazon QuickSight embedded dashboard.
Enabled (boolean) -- [REQUIRED]
The threshold alerts configuration for an embedded Amazon QuickSight dashboard.
QuickSightConsole (dict) --
The configuration details for providing each Amazon QuickSight console embedding experience. This can be used along with custom permissions to restrict access to certain features. For more information, see Customizing Access to the Amazon QuickSight Console in the Amazon QuickSight User Guide.
Use GenerateEmbedUrlForRegisteredUser where you want to provide an authoring portal that allows users to create data sources, datasets, analyses, and dashboards. The users who accesses an embedded Amazon QuickSight console needs to belong to the author or admin security cohort. If you want to restrict permissions to some of these features, add a custom permissions profile to the user with the UpdateUser API operation. Use the RegisterUser API operation to add a new user with a custom permission profile attached. For more information, see the following sections in the Amazon QuickSight User Guide:
For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
InitialPath (string) --
The initial URL path for the Amazon QuickSight console. InitialPath is required.
The entry point URL is constrained to the following paths:
/start
/start/analyses
/start/dashboards
/start/favorites
/dashboards/DashboardId. DashboardId is the actual ID key from the Amazon QuickSight console URL of the dashboard.
/analyses/AnalysisId. AnalysisId is the actual ID key from the Amazon QuickSight console URL of the analysis.
FeatureConfigurations (dict) --
The embedding configuration of an embedded Amazon QuickSight console.
StatePersistence (dict) --
The state persistence configurations of an embedded Amazon QuickSight console.
Enabled (boolean) -- [REQUIRED]
Determines if a Amazon QuickSight dashboard's state persistence settings are turned on or off.
SharedView (dict) --
The shared view settings of an embedded dashboard.
Enabled (boolean) -- [REQUIRED]
The shared view settings of an embedded dashboard.
AmazonQInQuickSight (dict) --
The Amazon Q configurations of an embedded Amazon QuickSight console.
DataQnA (dict) --
Adds generative Q&A capabilitiees to an embedded Amazon QuickSight console.
Enabled (boolean) -- [REQUIRED]
The generative Q&A settings of an embedded Amazon QuickSight console.
GenerativeAuthoring (dict) --
Adds the generative BI authoring experience to an embedded Amazon QuickSight console.
Enabled (boolean) -- [REQUIRED]
The generative BI authoring settings of an embedded Amazon QuickSight console.
ExecutiveSummary (dict) --
Adds the executive summaries feature to an embedded Amazon QuickSight console.
Enabled (boolean) -- [REQUIRED]
The executive summary settings of an embedded Amazon QuickSight console or dashboard.
DataStories (dict) --
Adds the data stories feature to an embedded Amazon QuickSight console.
Enabled (boolean) -- [REQUIRED]
The data story settings of an embedded Amazon QuickSight console.
Schedules (dict) --
The schedules configuration for an embedded Amazon QuickSight dashboard.
Enabled (boolean) -- [REQUIRED]
The schedules configuration for an embedded Amazon QuickSight dashboard.
RecentSnapshots (dict) --
The recent snapshots configuration for an embedded Amazon QuickSight dashboard.
Enabled (boolean) -- [REQUIRED]
The recent snapshots configuration for an embedded Amazon QuickSight dashboard.
ThresholdAlerts (dict) --
The threshold alerts configuration for an embedded Amazon QuickSight dashboard.
Enabled (boolean) -- [REQUIRED]
The threshold alerts configuration for an embedded Amazon QuickSight dashboard.
QSearchBar (dict) --
The configuration details for embedding the Q search bar.
For more information about embedding the Q search bar, see Embedding Overview in the Amazon QuickSight User Guide.
InitialTopicId (string) --
The ID of the legacy Q topic that you want to use as the starting topic in the Q search bar. To locate the topic ID of the topic that you want to use, open the Amazon QuickSight console, navigate to the Topics pane, and choose thre topic that you want to use. The TopicID is located in the URL of the topic that opens. When you select an initial topic, you can specify whether or not readers are allowed to select other topics from the list of available topics.
If you don't specify an initial topic or if you specify a new reader experience topic, a list of all shared legacy topics is shown in the Q bar.
DashboardVisual (dict) --
The type of embedding experience. In this case, Amazon QuickSight visuals.
InitialDashboardVisualId (dict) -- [REQUIRED]
The visual ID for the visual that you want the user to embed. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this visual.
The Amazon Resource Name (ARN) of the dashboard that the visual belongs to must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.
DashboardId (string) -- [REQUIRED]
The ID of the dashboard that has the visual that you want to embed. The DashboardId can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon QuickSight console. You can also get the DashboardId with a ListDashboards API operation.
SheetId (string) -- [REQUIRED]
The ID of the sheet that the has visual that you want to embed. The SheetId can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon QuickSight console.
VisualId (string) -- [REQUIRED]
The ID of the visual that you want to embed. The VisualID can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon QuickSight console.
GenerativeQnA (dict) --
The configuration details for embedding the Generative Q&A experience.
For more information about embedding the Generative Q&A experience, see Embedding Overview in the Amazon QuickSight User Guide.
InitialTopicId (string) --
The ID of the new Q reader experience topic that you want to make the starting topic in the Generative Q&A experience. You can find a topic ID by navigating to the Topics pane in the Amazon QuickSight application and opening a topic. The ID is in the URL for the topic that you open.
If you don't specify an initial topic or you specify a legacy topic, a list of all shared new reader experience topics is shown in the Generative Q&A experience for your readers. When you select an initial new reader experience topic, you can specify whether or not readers are allowed to select other new reader experience topics from the available ones in the list.
list
The domains that you want to add to the allow list for access to the generated URL that is then embedded. This optional parameter overrides the static domains that are configured in the Manage QuickSight menu in the Amazon QuickSight console. Instead, it allows only the domains that you include in this parameter. You can list up to three domains or subdomains in each API call.
To include all subdomains under a specific domain to the allow list, use *. For example, https://*.sapp.amazon.com includes all subdomains under https://sapp.amazon.com.
(string) --
dict
Response Syntax
{
'EmbedUrl': 'string',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
EmbedUrl (string) --
The embed URL for the Amazon QuickSight dashboard, visual, Q search bar, Generative Q&A experience, or console.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'ExperienceConfiguration': {'Dashboard': {'FeatureConfigurations': {'AmazonQInQuickSight': {'ExecutiveSummary': {'Enabled': 'boolean'}},
'RecentSnapshots': {'Enabled': 'boolean'},
'Schedules': {'Enabled': 'boolean'},
'ThresholdAlerts': {'Enabled': 'boolean'}}},
'QuickSightConsole': {'FeatureConfigurations': {'AmazonQInQuickSight': {'DataQnA': {'Enabled': 'boolean'},
'DataStories': {'Enabled': 'boolean'},
'ExecutiveSummary': {'Enabled': 'boolean'},
'GenerativeAuthoring': {'Enabled': 'boolean'}},
'RecentSnapshots': {'Enabled': 'boolean'},
'Schedules': {'Enabled': 'boolean'},
'ThresholdAlerts': {'Enabled': 'boolean'}}}}}
Generates an embed URL that you can use to embed an Amazon QuickSight experience in your website. This action can be used for any type of user that is registered in an Amazon QuickSight account that uses IAM Identity Center for authentication. This API requires identity-enhanced IAM Role sessions for the authenticated user that the API call is being made for.
This API uses trusted identity propagation to ensure that an end user is authenticated and receives the embed URL that is specific to that user. The IAM Identity Center application that the user has logged into needs to have trusted Identity Propagation enabled for Amazon QuickSight with the scope value set to quicksight:read. Before you use this action, make sure that you have configured the relevant Amazon QuickSight resource and permissions.
See also: AWS API Documentation
Request Syntax
client.generate_embed_url_for_registered_user_with_identity(
AwsAccountId='string',
SessionLifetimeInMinutes=123,
ExperienceConfiguration={
'Dashboard': {
'InitialDashboardId': 'string',
'FeatureConfigurations': {
'StatePersistence': {
'Enabled': True|False
},
'SharedView': {
'Enabled': True|False
},
'Bookmarks': {
'Enabled': True|False
},
'AmazonQInQuickSight': {
'ExecutiveSummary': {
'Enabled': True|False
}
},
'Schedules': {
'Enabled': True|False
},
'RecentSnapshots': {
'Enabled': True|False
},
'ThresholdAlerts': {
'Enabled': True|False
}
}
},
'QuickSightConsole': {
'InitialPath': 'string',
'FeatureConfigurations': {
'StatePersistence': {
'Enabled': True|False
},
'SharedView': {
'Enabled': True|False
},
'AmazonQInQuickSight': {
'DataQnA': {
'Enabled': True|False
},
'GenerativeAuthoring': {
'Enabled': True|False
},
'ExecutiveSummary': {
'Enabled': True|False
},
'DataStories': {
'Enabled': True|False
}
},
'Schedules': {
'Enabled': True|False
},
'RecentSnapshots': {
'Enabled': True|False
},
'ThresholdAlerts': {
'Enabled': True|False
}
}
},
'QSearchBar': {
'InitialTopicId': 'string'
},
'DashboardVisual': {
'InitialDashboardVisualId': {
'DashboardId': 'string',
'SheetId': 'string',
'VisualId': 'string'
}
},
'GenerativeQnA': {
'InitialTopicId': 'string'
}
},
AllowedDomains=[
'string',
]
)
string
[REQUIRED]
The ID of the Amazon Web Services registered user.
integer
The validity of the session in minutes.
dict
[REQUIRED]
The type of experience you want to embed. For registered users, you can embed Amazon QuickSight dashboards or the Amazon QuickSight console.
Dashboard (dict) --
The configuration details for providing a dashboard embedding experience.
InitialDashboardId (string) -- [REQUIRED]
The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this dashboard if the user has permissions to view it.
If the user does not have permission to view this dashboard, they see a permissions error message.
FeatureConfigurations (dict) --
The feature configurations of an embbedded Amazon QuickSight dashboard.
StatePersistence (dict) --
The state persistence settings of an embedded dashboard.
Enabled (boolean) -- [REQUIRED]
Determines if a Amazon QuickSight dashboard's state persistence settings are turned on or off.
SharedView (dict) --
The shared view settings of an embedded dashboard.
Enabled (boolean) -- [REQUIRED]
The shared view settings of an embedded dashboard.
Bookmarks (dict) --
The bookmarks configuration for an embedded dashboard in Amazon QuickSight.
Enabled (boolean) -- [REQUIRED]
A Boolean value that determines whether a user can bookmark an embedded dashboard.
AmazonQInQuickSight (dict) --
The Amazon Q configurations of an embedded Amazon QuickSight dashboard.
ExecutiveSummary (dict) --
A generated executive summary of an embedded Amazon QuickSight dashboard.
Enabled (boolean) -- [REQUIRED]
The executive summary settings of an embedded Amazon QuickSight console or dashboard.
Schedules (dict) --
The schedules configuration for an embedded Amazon QuickSight dashboard.
Enabled (boolean) -- [REQUIRED]
The schedules configuration for an embedded Amazon QuickSight dashboard.
RecentSnapshots (dict) --
The recent snapshots configuration for an Amazon QuickSight embedded dashboard
Enabled (boolean) -- [REQUIRED]
The recent snapshots configuration for an embedded Amazon QuickSight dashboard.
ThresholdAlerts (dict) --
The threshold alerts configuration for an Amazon QuickSight embedded dashboard.
Enabled (boolean) -- [REQUIRED]
The threshold alerts configuration for an embedded Amazon QuickSight dashboard.
QuickSightConsole (dict) --
The configuration details for providing each Amazon QuickSight console embedding experience. This can be used along with custom permissions to restrict access to certain features. For more information, see Customizing Access to the Amazon QuickSight Console in the Amazon QuickSight User Guide.
Use GenerateEmbedUrlForRegisteredUser where you want to provide an authoring portal that allows users to create data sources, datasets, analyses, and dashboards. The users who accesses an embedded Amazon QuickSight console needs to belong to the author or admin security cohort. If you want to restrict permissions to some of these features, add a custom permissions profile to the user with the UpdateUser API operation. Use the RegisterUser API operation to add a new user with a custom permission profile attached. For more information, see the following sections in the Amazon QuickSight User Guide:
For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
InitialPath (string) --
The initial URL path for the Amazon QuickSight console. InitialPath is required.
The entry point URL is constrained to the following paths:
/start
/start/analyses
/start/dashboards
/start/favorites
/dashboards/DashboardId. DashboardId is the actual ID key from the Amazon QuickSight console URL of the dashboard.
/analyses/AnalysisId. AnalysisId is the actual ID key from the Amazon QuickSight console URL of the analysis.
FeatureConfigurations (dict) --
The embedding configuration of an embedded Amazon QuickSight console.
StatePersistence (dict) --
The state persistence configurations of an embedded Amazon QuickSight console.
Enabled (boolean) -- [REQUIRED]
Determines if a Amazon QuickSight dashboard's state persistence settings are turned on or off.
SharedView (dict) --
The shared view settings of an embedded dashboard.
Enabled (boolean) -- [REQUIRED]
The shared view settings of an embedded dashboard.
AmazonQInQuickSight (dict) --
The Amazon Q configurations of an embedded Amazon QuickSight console.
DataQnA (dict) --
Adds generative Q&A capabilitiees to an embedded Amazon QuickSight console.
Enabled (boolean) -- [REQUIRED]
The generative Q&A settings of an embedded Amazon QuickSight console.
GenerativeAuthoring (dict) --
Adds the generative BI authoring experience to an embedded Amazon QuickSight console.
Enabled (boolean) -- [REQUIRED]
The generative BI authoring settings of an embedded Amazon QuickSight console.
ExecutiveSummary (dict) --
Adds the executive summaries feature to an embedded Amazon QuickSight console.
Enabled (boolean) -- [REQUIRED]
The executive summary settings of an embedded Amazon QuickSight console or dashboard.
DataStories (dict) --
Adds the data stories feature to an embedded Amazon QuickSight console.
Enabled (boolean) -- [REQUIRED]
The data story settings of an embedded Amazon QuickSight console.
Schedules (dict) --
The schedules configuration for an embedded Amazon QuickSight dashboard.
Enabled (boolean) -- [REQUIRED]
The schedules configuration for an embedded Amazon QuickSight dashboard.
RecentSnapshots (dict) --
The recent snapshots configuration for an embedded Amazon QuickSight dashboard.
Enabled (boolean) -- [REQUIRED]
The recent snapshots configuration for an embedded Amazon QuickSight dashboard.
ThresholdAlerts (dict) --
The threshold alerts configuration for an embedded Amazon QuickSight dashboard.
Enabled (boolean) -- [REQUIRED]
The threshold alerts configuration for an embedded Amazon QuickSight dashboard.
QSearchBar (dict) --
The configuration details for embedding the Q search bar.
For more information about embedding the Q search bar, see Embedding Overview in the Amazon QuickSight User Guide.
InitialTopicId (string) --
The ID of the legacy Q topic that you want to use as the starting topic in the Q search bar. To locate the topic ID of the topic that you want to use, open the Amazon QuickSight console, navigate to the Topics pane, and choose thre topic that you want to use. The TopicID is located in the URL of the topic that opens. When you select an initial topic, you can specify whether or not readers are allowed to select other topics from the list of available topics.
If you don't specify an initial topic or if you specify a new reader experience topic, a list of all shared legacy topics is shown in the Q bar.
DashboardVisual (dict) --
The type of embedding experience. In this case, Amazon QuickSight visuals.
InitialDashboardVisualId (dict) -- [REQUIRED]
The visual ID for the visual that you want the user to embed. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this visual.
The Amazon Resource Name (ARN) of the dashboard that the visual belongs to must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.
DashboardId (string) -- [REQUIRED]
The ID of the dashboard that has the visual that you want to embed. The DashboardId can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon QuickSight console. You can also get the DashboardId with a ListDashboards API operation.
SheetId (string) -- [REQUIRED]
The ID of the sheet that the has visual that you want to embed. The SheetId can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon QuickSight console.
VisualId (string) -- [REQUIRED]
The ID of the visual that you want to embed. The VisualID can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon QuickSight console.
GenerativeQnA (dict) --
The configuration details for embedding the Generative Q&A experience.
For more information about embedding the Generative Q&A experience, see Embedding Overview in the Amazon QuickSight User Guide.
InitialTopicId (string) --
The ID of the new Q reader experience topic that you want to make the starting topic in the Generative Q&A experience. You can find a topic ID by navigating to the Topics pane in the Amazon QuickSight application and opening a topic. The ID is in the URL for the topic that you open.
If you don't specify an initial topic or you specify a legacy topic, a list of all shared new reader experience topics is shown in the Generative Q&A experience for your readers. When you select an initial new reader experience topic, you can specify whether or not readers are allowed to select other new reader experience topics from the available ones in the list.
list
A list of domains to be allowed to generate the embed URL.
(string) --
dict
Response Syntax
{
'EmbedUrl': 'string',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
EmbedUrl (string) --
The generated embed URL for the registered user.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'DataSetSummaries': {'UseAs': 'RLS_RULES'}}
Lists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region.
The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*.
See also: AWS API Documentation
Request Syntax
client.list_data_sets(
AwsAccountId='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The Amazon Web Services account ID.
string
The token for the next set of results, or null if there are no more results.
integer
The maximum number of results to be returned per request.
dict
Response Syntax
{
'DataSetSummaries': [
{
'Arn': 'string',
'DataSetId': 'string',
'Name': 'string',
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'ImportMode': 'SPICE'|'DIRECT_QUERY',
'RowLevelPermissionDataSet': {
'Namespace': 'string',
'Arn': 'string',
'PermissionPolicy': 'GRANT_ACCESS'|'DENY_ACCESS',
'FormatVersion': 'VERSION_1'|'VERSION_2',
'Status': 'ENABLED'|'DISABLED'
},
'RowLevelPermissionTagConfigurationApplied': True|False,
'ColumnLevelPermissionRulesApplied': True|False,
'UseAs': 'RLS_RULES'
},
],
'NextToken': 'string',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
DataSetSummaries (list) --
The list of dataset summaries.
(dict) --
Dataset summary.
Arn (string) --
The Amazon Resource Name (ARN) of the dataset.
DataSetId (string) --
The ID of the dataset.
Name (string) --
A display name for the dataset.
CreatedTime (datetime) --
The time that this dataset was created.
LastUpdatedTime (datetime) --
The last time that this dataset was updated.
ImportMode (string) --
A value that indicates whether you want to import the data into SPICE.
RowLevelPermissionDataSet (dict) --
The row-level security configuration for the dataset.
Namespace (string) --
The namespace associated with the dataset that contains permissions for RLS.
Arn (string) --
The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.
PermissionPolicy (string) --
The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS is included for backward compatibility only.
FormatVersion (string) --
The user or group rules associated with the dataset that contains permissions for RLS.
By default, FormatVersion is VERSION_1. When FormatVersion is VERSION_1, UserName and GroupName are required. When FormatVersion is VERSION_2, UserARN and GroupARN are required, and Namespace must not exist.
Status (string) --
The status of the row-level security permission dataset. If enabled, the status is ENABLED. If disabled, the status is DISABLED.
RowLevelPermissionTagConfigurationApplied (boolean) --
Whether or not the row level permission tags are applied.
ColumnLevelPermissionRulesApplied (boolean) --
A value that indicates if the dataset has column level permission configured.
UseAs (string) --
The usage of the dataset.
NextToken (string) --
The token for the next set of results, or null if there are no more results.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'DataSources': {'AlternateDataSourceParameters': {'OracleParameters': {'UseServiceName': 'boolean'}},
'DataSourceParameters': {'OracleParameters': {'UseServiceName': 'boolean'}}}}
Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
client.list_data_sources(
AwsAccountId='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The Amazon Web Services account ID.
string
The token for the next set of results, or null if there are no more results.
integer
The maximum number of results to be returned per request.
dict
Response Syntax
{
'DataSources': [
{
'Arn': 'string',
'DataSourceId': 'string',
'Name': 'string',
'Type': 'ADOBE_ANALYTICS'|'AMAZON_ELASTICSEARCH'|'ATHENA'|'AURORA'|'AURORA_POSTGRESQL'|'AWS_IOT_ANALYTICS'|'GITHUB'|'JIRA'|'MARIADB'|'MYSQL'|'ORACLE'|'POSTGRESQL'|'PRESTO'|'REDSHIFT'|'S3'|'SALESFORCE'|'SERVICENOW'|'SNOWFLAKE'|'SPARK'|'SQLSERVER'|'TERADATA'|'TWITTER'|'TIMESTREAM'|'AMAZON_OPENSEARCH'|'EXASOL'|'DATABRICKS'|'STARBURST'|'TRINO'|'BIGQUERY',
'Status': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'DataSourceParameters': {
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string',
'RoleArn': 'string'
},
'AuroraParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AuroraPostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AwsIotAnalyticsParameters': {
'DataSetName': 'string'
},
'JiraParameters': {
'SiteBaseUrl': 'string'
},
'MariaDbParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'MySqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'OracleParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'UseServiceName': True|False
},
'PostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PrestoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'RdsParameters': {
'InstanceId': 'string',
'Database': 'string'
},
'RedshiftParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'ClusterId': 'string',
'IAMParameters': {
'RoleArn': 'string',
'DatabaseUser': 'string',
'DatabaseGroups': [
'string',
],
'AutoCreateDatabaseUser': True|False
},
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string',
'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509',
'DatabaseAccessControlRole': 'string',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string'
}
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
},
'AmazonOpenSearchParameters': {
'Domain': 'string'
},
'ExasolParameters': {
'Host': 'string',
'Port': 123
},
'DatabricksParameters': {
'Host': 'string',
'Port': 123,
'SqlEndpointPath': 'string'
},
'StarburstParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string',
'ProductType': 'GALAXY'|'ENTERPRISE',
'DatabaseAccessControlRole': 'string',
'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string'
}
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'BigQueryParameters': {
'ProjectId': 'string',
'DataSetRegion': 'string'
}
},
'AlternateDataSourceParameters': [
{
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string',
'RoleArn': 'string'
},
'AuroraParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AuroraPostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AwsIotAnalyticsParameters': {
'DataSetName': 'string'
},
'JiraParameters': {
'SiteBaseUrl': 'string'
},
'MariaDbParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'MySqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'OracleParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'UseServiceName': True|False
},
'PostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PrestoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'RdsParameters': {
'InstanceId': 'string',
'Database': 'string'
},
'RedshiftParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'ClusterId': 'string',
'IAMParameters': {
'RoleArn': 'string',
'DatabaseUser': 'string',
'DatabaseGroups': [
'string',
],
'AutoCreateDatabaseUser': True|False
},
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string',
'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509',
'DatabaseAccessControlRole': 'string',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string'
}
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
},
'AmazonOpenSearchParameters': {
'Domain': 'string'
},
'ExasolParameters': {
'Host': 'string',
'Port': 123
},
'DatabricksParameters': {
'Host': 'string',
'Port': 123,
'SqlEndpointPath': 'string'
},
'StarburstParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string',
'ProductType': 'GALAXY'|'ENTERPRISE',
'DatabaseAccessControlRole': 'string',
'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string'
}
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'BigQueryParameters': {
'ProjectId': 'string',
'DataSetRegion': 'string'
}
},
],
'VpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'SslProperties': {
'DisableSsl': True|False
},
'ErrorInfo': {
'Type': 'ACCESS_DENIED'|'COPY_SOURCE_NOT_FOUND'|'TIMEOUT'|'ENGINE_VERSION_NOT_SUPPORTED'|'UNKNOWN_HOST'|'GENERIC_SQL_FAILURE'|'CONFLICT'|'UNKNOWN',
'Message': 'string'
},
'SecretArn': 'string'
},
],
'NextToken': 'string',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
DataSources (list) --
A list of data sources.
(dict) --
The structure of a data source.
Arn (string) --
The Amazon Resource Name (ARN) of the data source.
DataSourceId (string) --
The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
Name (string) --
A display name for the data source.
Type (string) --
The type of the data source. This type indicates which database engine the data source connects to.
Status (string) --
The HTTP status of the request.
CreatedTime (datetime) --
The time that this data source was created.
LastUpdatedTime (datetime) --
The last time that this data source was updated.
DataSourceParameters (dict) --
The parameters that Amazon QuickSight uses to connect to your underlying source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
AmazonElasticsearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) --
The OpenSearch domain.
AthenaParameters (dict) --
The parameters for Amazon Athena.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.
AuroraParameters (dict) --
The parameters for Amazon Aurora MySQL.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
AuroraPostgreSqlParameters (dict) --
The parameters for Amazon Aurora.
Host (string) --
The Amazon Aurora PostgreSQL-Compatible host to connect to.
Port (integer) --
The port that Amazon Aurora PostgreSQL is listening on.
Database (string) --
The Amazon Aurora PostgreSQL database to connect to.
AwsIotAnalyticsParameters (dict) --
The parameters for IoT Analytics.
DataSetName (string) --
Dataset name.
JiraParameters (dict) --
The parameters for Jira.
SiteBaseUrl (string) --
The base URL of the Jira site.
MariaDbParameters (dict) --
The parameters for MariaDB.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
MySqlParameters (dict) --
The parameters for MySQL.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
OracleParameters (dict) --
The parameters for Oracle.
Host (string) --
An Oracle host.
Port (integer) --
The port.
Database (string) --
The database.
UseServiceName (boolean) --
A Boolean value that indicates whether the Database uses a service name or an SID. If this value is left blank, the default value is SID. If this value is set to false, the value is SID.
PostgreSqlParameters (dict) --
The parameters for PostgreSQL.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
PrestoParameters (dict) --
The parameters for Presto.
Host (string) --
Host.
Port (integer) --
Port.
Catalog (string) --
Catalog.
RdsParameters (dict) --
The parameters for Amazon RDS.
InstanceId (string) --
Instance ID.
Database (string) --
Database.
RedshiftParameters (dict) --
The parameters for Amazon Redshift.
Host (string) --
Host. This field can be blank if ClusterId is provided.
Port (integer) --
Port. This field can be blank if the ClusterId is provided.
Database (string) --
Database.
ClusterId (string) --
Cluster ID. This field can be blank if the Host and Port are provided.
IAMParameters (dict) --
An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials.
RoleArn (string) --
Use the RoleArn structure to allow Amazon QuickSight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role.
DatabaseUser (string) --
The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.
DatabaseGroups (list) --
A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the DatabaseUser. If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup.
(string) --
AutoCreateDatabaseUser (boolean) --
Automatically creates a database user. If your database doesn't have a DatabaseUser, set this parameter to True. If there is no DatabaseUser, Amazon QuickSight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Amazon QuickSight access to your cluster.
This parameter can only be specified if your Amazon QuickSight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
S3Parameters (dict) --
The parameters for S3.
ManifestFileLocation (dict) --
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight.
Bucket (string) --
Amazon S3 bucket.
Key (string) --
Amazon S3 key that identifies an object.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
ServiceNowParameters (dict) --
The parameters for ServiceNow.
SiteBaseUrl (string) --
URL of the base site.
SnowflakeParameters (dict) --
The parameters for Snowflake.
Host (string) --
Host.
Database (string) --
Database.
Warehouse (string) --
Warehouse.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
DatabaseAccessControlRole (string) --
The database access control role.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Amazon QuickSight account and Snowflake.
TokenProviderUrl (string) --
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) --
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
SparkParameters (dict) --
The parameters for Spark.
Host (string) --
Host.
Port (integer) --
Port.
SqlServerParameters (dict) --
The parameters for SQL Server.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TeradataParameters (dict) --
The parameters for Teradata.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TwitterParameters (dict) --
The parameters for Twitter.
Query (string) --
Twitter query string.
MaxRows (integer) --
Maximum number of rows to query Twitter.
AmazonOpenSearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) --
The OpenSearch domain.
ExasolParameters (dict) --
The parameters for Exasol.
Host (string) --
The hostname or IP address of the Exasol data source.
Port (integer) --
The port for the Exasol data source.
DatabricksParameters (dict) --
The parameters that are required to connect to a Databricks data source.
Host (string) --
The host name of the Databricks data source.
Port (integer) --
The port for the Databricks data source.
SqlEndpointPath (string) --
The HTTP path of the Databricks data source.
StarburstParameters (dict) --
The parameters that are required to connect to a Starburst data source.
Host (string) --
The host name of the Starburst data source.
Port (integer) --
The port for the Starburst data source.
Catalog (string) --
The catalog name for the Starburst data source.
ProductType (string) --
The product type for the Starburst data source.
DatabaseAccessControlRole (string) --
The database access control role.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Amazon QuickSight account and Starburst.
TokenProviderUrl (string) --
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) --
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
TrinoParameters (dict) --
The parameters that are required to connect to a Trino data source.
Host (string) --
The host name of the Trino data source.
Port (integer) --
The port for the Trino data source.
Catalog (string) --
The catalog name for the Trino data source.
BigQueryParameters (dict) --
The parameters that are required to connect to a Google BigQuery data source.
ProjectId (string) --
The Google Cloud Platform project ID where your datasource was created.
DataSetRegion (string) --
The storage location where you create a Google BigQuery data source.
AlternateDataSourceParameters (list) --
A set of alternate data source parameters that you want to share for the credentials stored with this data source. The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the DataSourceParameters structure that's in the request with the structures in the AlternateDataSourceParameters allow list. If the structures are an exact match, the request is allowed to use the credentials from this existing data source. If the AlternateDataSourceParameters list is null, the Credentials originally used with this DataSourceParameters are automatically allowed.
(dict) --
The parameters that Amazon QuickSight uses to connect to your underlying data source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
AmazonElasticsearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) --
The OpenSearch domain.
AthenaParameters (dict) --
The parameters for Amazon Athena.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.
AuroraParameters (dict) --
The parameters for Amazon Aurora MySQL.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
AuroraPostgreSqlParameters (dict) --
The parameters for Amazon Aurora.
Host (string) --
The Amazon Aurora PostgreSQL-Compatible host to connect to.
Port (integer) --
The port that Amazon Aurora PostgreSQL is listening on.
Database (string) --
The Amazon Aurora PostgreSQL database to connect to.
AwsIotAnalyticsParameters (dict) --
The parameters for IoT Analytics.
DataSetName (string) --
Dataset name.
JiraParameters (dict) --
The parameters for Jira.
SiteBaseUrl (string) --
The base URL of the Jira site.
MariaDbParameters (dict) --
The parameters for MariaDB.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
MySqlParameters (dict) --
The parameters for MySQL.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
OracleParameters (dict) --
The parameters for Oracle.
Host (string) --
An Oracle host.
Port (integer) --
The port.
Database (string) --
The database.
UseServiceName (boolean) --
A Boolean value that indicates whether the Database uses a service name or an SID. If this value is left blank, the default value is SID. If this value is set to false, the value is SID.
PostgreSqlParameters (dict) --
The parameters for PostgreSQL.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
PrestoParameters (dict) --
The parameters for Presto.
Host (string) --
Host.
Port (integer) --
Port.
Catalog (string) --
Catalog.
RdsParameters (dict) --
The parameters for Amazon RDS.
InstanceId (string) --
Instance ID.
Database (string) --
Database.
RedshiftParameters (dict) --
The parameters for Amazon Redshift.
Host (string) --
Host. This field can be blank if ClusterId is provided.
Port (integer) --
Port. This field can be blank if the ClusterId is provided.
Database (string) --
Database.
ClusterId (string) --
Cluster ID. This field can be blank if the Host and Port are provided.
IAMParameters (dict) --
An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials.
RoleArn (string) --
Use the RoleArn structure to allow Amazon QuickSight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role.
DatabaseUser (string) --
The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.
DatabaseGroups (list) --
A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the DatabaseUser. If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup.
(string) --
AutoCreateDatabaseUser (boolean) --
Automatically creates a database user. If your database doesn't have a DatabaseUser, set this parameter to True. If there is no DatabaseUser, Amazon QuickSight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Amazon QuickSight access to your cluster.
This parameter can only be specified if your Amazon QuickSight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
S3Parameters (dict) --
The parameters for S3.
ManifestFileLocation (dict) --
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight.
Bucket (string) --
Amazon S3 bucket.
Key (string) --
Amazon S3 key that identifies an object.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
ServiceNowParameters (dict) --
The parameters for ServiceNow.
SiteBaseUrl (string) --
URL of the base site.
SnowflakeParameters (dict) --
The parameters for Snowflake.
Host (string) --
Host.
Database (string) --
Database.
Warehouse (string) --
Warehouse.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
DatabaseAccessControlRole (string) --
The database access control role.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Amazon QuickSight account and Snowflake.
TokenProviderUrl (string) --
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) --
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
SparkParameters (dict) --
The parameters for Spark.
Host (string) --
Host.
Port (integer) --
Port.
SqlServerParameters (dict) --
The parameters for SQL Server.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TeradataParameters (dict) --
The parameters for Teradata.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TwitterParameters (dict) --
The parameters for Twitter.
Query (string) --
Twitter query string.
MaxRows (integer) --
Maximum number of rows to query Twitter.
AmazonOpenSearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) --
The OpenSearch domain.
ExasolParameters (dict) --
The parameters for Exasol.
Host (string) --
The hostname or IP address of the Exasol data source.
Port (integer) --
The port for the Exasol data source.
DatabricksParameters (dict) --
The parameters that are required to connect to a Databricks data source.
Host (string) --
The host name of the Databricks data source.
Port (integer) --
The port for the Databricks data source.
SqlEndpointPath (string) --
The HTTP path of the Databricks data source.
StarburstParameters (dict) --
The parameters that are required to connect to a Starburst data source.
Host (string) --
The host name of the Starburst data source.
Port (integer) --
The port for the Starburst data source.
Catalog (string) --
The catalog name for the Starburst data source.
ProductType (string) --
The product type for the Starburst data source.
DatabaseAccessControlRole (string) --
The database access control role.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Amazon QuickSight account and Starburst.
TokenProviderUrl (string) --
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) --
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
TrinoParameters (dict) --
The parameters that are required to connect to a Trino data source.
Host (string) --
The host name of the Trino data source.
Port (integer) --
The port for the Trino data source.
Catalog (string) --
The catalog name for the Trino data source.
BigQueryParameters (dict) --
The parameters that are required to connect to a Google BigQuery data source.
ProjectId (string) --
The Google Cloud Platform project ID where your datasource was created.
DataSetRegion (string) --
The storage location where you create a Google BigQuery data source.
VpcConnectionProperties (dict) --
The VPC connection information. You need to use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.
VpcConnectionArn (string) --
The Amazon Resource Name (ARN) for the VPC connection.
SslProperties (dict) --
Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.
DisableSsl (boolean) --
A Boolean option to control whether SSL should be disabled.
ErrorInfo (dict) --
Error information from the last update or the creation of the data source.
Type (string) --
Error type.
Message (string) --
Error message.
SecretArn (string) --
The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.
NextToken (string) --
The token for the next set of results, or null if there are no more results.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'DataSetRefreshProperties': {'FailureConfiguration': {'EmailAlert': {'AlertStatus': 'ENABLED '
'| '
'DISABLED'}}}}
Creates or updates the dataset refresh properties for the dataset.
See also: AWS API Documentation
Request Syntax
client.put_data_set_refresh_properties(
AwsAccountId='string',
DataSetId='string',
DataSetRefreshProperties={
'RefreshConfiguration': {
'IncrementalRefresh': {
'LookbackWindow': {
'ColumnName': 'string',
'Size': 123,
'SizeUnit': 'HOUR'|'DAY'|'WEEK'
}
}
},
'FailureConfiguration': {
'EmailAlert': {
'AlertStatus': 'ENABLED'|'DISABLED'
}
}
}
)
string
[REQUIRED]
The Amazon Web Services account ID.
string
[REQUIRED]
The ID of the dataset.
dict
[REQUIRED]
The dataset refresh properties.
RefreshConfiguration (dict) --
The refresh configuration for a dataset.
IncrementalRefresh (dict) -- [REQUIRED]
The incremental refresh for the dataset.
LookbackWindow (dict) -- [REQUIRED]
The lookback window setup for an incremental refresh configuration.
ColumnName (string) -- [REQUIRED]
The name of the lookback window column.
Size (integer) -- [REQUIRED]
The lookback window column size.
SizeUnit (string) -- [REQUIRED]
The size unit that is used for the lookback window column. Valid values for this structure are HOUR, DAY, and WEEK.
FailureConfiguration (dict) --
The failure configuration for a dataset.
EmailAlert (dict) --
The email alert configuration for a dataset refresh failure.
AlertStatus (string) --
The status value that determines if email alerts are sent.
dict
Response Syntax
{
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'DataSetSummaries': {'UseAs': 'RLS_RULES'}}
Use the SearchDataSets operation to search for datasets that belong to an account.
See also: AWS API Documentation
Request Syntax
client.search_data_sets(
AwsAccountId='string',
Filters=[
{
'Operator': 'StringEquals'|'StringLike',
'Name': 'QUICKSIGHT_VIEWER_OR_OWNER'|'QUICKSIGHT_OWNER'|'DIRECT_QUICKSIGHT_VIEWER_OR_OWNER'|'DIRECT_QUICKSIGHT_OWNER'|'DIRECT_QUICKSIGHT_SOLE_OWNER'|'DATASET_NAME',
'Value': 'string'
},
],
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The Amazon Web Services account ID.
list
[REQUIRED]
The filters to apply to the search.
(dict) --
A filter that you apply when searching for datasets.
Operator (string) -- [REQUIRED]
The comparison operator that you want to use as a filter, for example "Operator": "StringEquals". Valid values are "StringEquals" and "StringLike".
If you set the operator value to "StringEquals", you need to provide an ownership related filter in the "NAME" field and the arn of the user or group whose datasets you want to search in the "Value" field. For example, "Name":"QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east- 1:1:user/default/UserName1".
If you set the value to "StringLike", you need to provide the name of the datasets you are searching for. For example, "Name":"DATASET_NAME", "Operator": "StringLike", "Value": "Test". The "StringLike" operator only supports the NAME value DATASET_NAME.
Name (string) -- [REQUIRED]
The name of the value that you want to use as a filter, for example, "Name": "QUICKSIGHT_OWNER".
Valid values are defined as follows:
QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any datasets with that ARN listed as one of the dataset owners or viewers are returned. Implicit permissions from folders or groups are considered.
QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any datasets with that ARN listed as one of the owners of the dataset are returned. Implicit permissions from folders or groups are considered.
DIRECT_QUICKSIGHT_SOLE_OWNER: Provide an ARN of a user or group, and any datasets with that ARN listed as the only owner of the dataset are returned. Implicit permissions from folders or groups are not considered.
DIRECT_QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any datasets with that ARN listed as one of the owners if the dataset are returned. Implicit permissions from folders or groups are not considered.
DIRECT_QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any datasets with that ARN listed as one of the owners or viewers of the dataset are returned. Implicit permissions from folders or groups are not considered.
DATASET_NAME: Any datasets whose names have a substring match to this value will be returned.
Value (string) -- [REQUIRED]
The value of the named item, in this case QUICKSIGHT_OWNER, that you want to use as a filter, for example, "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1".
string
A pagination token that can be used in a subsequent request.
integer
The maximum number of results to be returned per request.
dict
Response Syntax
{
'DataSetSummaries': [
{
'Arn': 'string',
'DataSetId': 'string',
'Name': 'string',
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'ImportMode': 'SPICE'|'DIRECT_QUERY',
'RowLevelPermissionDataSet': {
'Namespace': 'string',
'Arn': 'string',
'PermissionPolicy': 'GRANT_ACCESS'|'DENY_ACCESS',
'FormatVersion': 'VERSION_1'|'VERSION_2',
'Status': 'ENABLED'|'DISABLED'
},
'RowLevelPermissionTagConfigurationApplied': True|False,
'ColumnLevelPermissionRulesApplied': True|False,
'UseAs': 'RLS_RULES'
},
],
'NextToken': 'string',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
DataSetSummaries (list) --
A DataSetSummaries object that returns a summary of a dataset.
(dict) --
Dataset summary.
Arn (string) --
The Amazon Resource Name (ARN) of the dataset.
DataSetId (string) --
The ID of the dataset.
Name (string) --
A display name for the dataset.
CreatedTime (datetime) --
The time that this dataset was created.
LastUpdatedTime (datetime) --
The last time that this dataset was updated.
ImportMode (string) --
A value that indicates whether you want to import the data into SPICE.
RowLevelPermissionDataSet (dict) --
The row-level security configuration for the dataset.
Namespace (string) --
The namespace associated with the dataset that contains permissions for RLS.
Arn (string) --
The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.
PermissionPolicy (string) --
The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS is included for backward compatibility only.
FormatVersion (string) --
The user or group rules associated with the dataset that contains permissions for RLS.
By default, FormatVersion is VERSION_1. When FormatVersion is VERSION_1, UserName and GroupName are required. When FormatVersion is VERSION_2, UserARN and GroupARN are required, and Namespace must not exist.
Status (string) --
The status of the row-level security permission dataset. If enabled, the status is ENABLED. If disabled, the status is DISABLED.
RowLevelPermissionTagConfigurationApplied (boolean) --
Whether or not the row level permission tags are applied.
ColumnLevelPermissionRulesApplied (boolean) --
A value that indicates if the dataset has column level permission configured.
UseAs (string) --
The usage of the dataset.
NextToken (string) --
A pagination token that can be used in a subsequent request.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'CloudFormationOverridePropertyConfiguration': {'DataSets': {'Properties': {'RefreshFailureEmailAlertStatus'}}}}
Starts an Asset Bundle export job.
An Asset Bundle export job exports specified Amazon QuickSight assets. You can also choose to export any asset dependencies in the same job. Export jobs run asynchronously and can be polled with a DescribeAssetBundleExportJob API call. When a job is successfully completed, a download URL that contains the exported assets is returned. The URL is valid for 5 minutes and can be refreshed with a DescribeAssetBundleExportJob API call. Each Amazon QuickSight account can run up to 5 export jobs concurrently.
The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported.
See also: AWS API Documentation
Request Syntax
client.start_asset_bundle_export_job(
AwsAccountId='string',
AssetBundleExportJobId='string',
ResourceArns=[
'string',
],
IncludeAllDependencies=True|False,
ExportFormat='CLOUDFORMATION_JSON'|'QUICKSIGHT_JSON',
CloudFormationOverridePropertyConfiguration={
'ResourceIdOverrideConfiguration': {
'PrefixForAllResources': True|False
},
'VPCConnections': [
{
'Arn': 'string',
'Properties': [
'Name'|'DnsResolvers'|'RoleArn',
]
},
],
'RefreshSchedules': [
{
'Arn': 'string',
'Properties': [
'StartAfterDateTime',
]
},
],
'DataSources': [
{
'Arn': 'string',
'Properties': [
'Name'|'DisableSsl'|'SecretArn'|'Username'|'Password'|'Domain'|'WorkGroup'|'Host'|'Port'|'Database'|'DataSetName'|'Catalog'|'InstanceId'|'ClusterId'|'ManifestFileLocation'|'Warehouse'|'RoleArn'|'ProductType',
]
},
],
'DataSets': [
{
'Arn': 'string',
'Properties': [
'Name'|'RefreshFailureEmailAlertStatus',
]
},
],
'Themes': [
{
'Arn': 'string',
'Properties': [
'Name',
]
},
],
'Analyses': [
{
'Arn': 'string',
'Properties': [
'Name',
]
},
],
'Dashboards': [
{
'Arn': 'string',
'Properties': [
'Name',
]
},
],
'Folders': [
{
'Arn': 'string',
'Properties': [
'Name'|'ParentFolderArn',
]
},
]
},
IncludePermissions=True|False,
IncludeTags=True|False,
ValidationStrategy={
'StrictModeForAllResources': True|False
},
IncludeFolderMemberships=True|False,
IncludeFolderMembers='RECURSE'|'ONE_LEVEL'|'NONE'
)
string
[REQUIRED]
The ID of the Amazon Web Services account to export assets from.
string
[REQUIRED]
The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.
list
[REQUIRED]
An array of resource ARNs to export. The following resources are supported.
Analysis
Dashboard
DataSet
DataSource
RefreshSchedule
Theme
VPCConnection
The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported.
(string) --
boolean
A Boolean that determines whether all dependencies of each resource ARN are recursively exported with the job. For example, say you provided a Dashboard ARN to the ResourceArns parameter. If you set IncludeAllDependencies to TRUE, any theme, dataset, and data source resource that is a dependency of the dashboard is also exported.
string
[REQUIRED]
The export data format.
dict
An optional collection of structures that generate CloudFormation parameters to override the existing resource property values when the resource is exported to a new CloudFormation template.
Use this field if the ExportFormat field of a StartAssetBundleExportJobRequest API call is set to CLOUDFORMATION_JSON.
ResourceIdOverrideConfiguration (dict) --
An optional list of structures that control how resource IDs are parameterized in the returned CloudFormation template.
PrefixForAllResources (boolean) --
An option to request a CloudFormation variable for a prefix to be prepended to each resource's ID before import. The prefix is only added to the asset IDs and does not change the name of the asset.
VPCConnections (list) --
An optional list of structures that control how VPCConnection resources are parameterized in the returned CloudFormation template.
(dict) --
Controls how a specific VPCConnection resource is parameterized in the outputted CloudFormation template.
Arn (string) -- [REQUIRED]
The ARN of the specific VPCConnection resource whose override properties are configured in this structure.
Properties (list) -- [REQUIRED]
A list of VPCConnection resource properties to generate variables for in the returned CloudFormation template.
(string) --
RefreshSchedules (list) --
An optional list of structures that control how RefreshSchedule resources are parameterized in the returned CloudFormation template.
(dict) --
Controls how a specific RefreshSchedule resource is parameterized in the returned CloudFormation template.
Arn (string) -- [REQUIRED]
The ARN of the specific RefreshSchedule resource whose override properties are configured in this structure.
Properties (list) -- [REQUIRED]
A list of RefreshSchedule resource properties to generate variables for in the returned CloudFormation template.
(string) --
DataSources (list) --
An optional list of structures that control how DataSource resources are parameterized in the returned CloudFormation template.
(dict) --
Controls how a specific DataSource resource is parameterized in the returned CloudFormation template.
Arn (string) -- [REQUIRED]
The ARN of the specific DataSource resource whose override properties are configured in this structure.
Properties (list) -- [REQUIRED]
A list of DataSource resource properties to generate variables for in the returned CloudFormation template.
(string) --
DataSets (list) --
An optional list of structures that control how DataSet resources are parameterized in the returned CloudFormation template.
(dict) --
Controls how a specific DataSet resource is parameterized in the returned CloudFormation template.
Arn (string) -- [REQUIRED]
The ARN of the specific DataSet resource whose override properties are configured in this structure.
Properties (list) -- [REQUIRED]
A list of DataSet resource properties to generate variables for in the returned CloudFormation template.
(string) --
Themes (list) --
An optional list of structures that control how Theme resources are parameterized in the returned CloudFormation template.
(dict) --
Controls how a specific Theme resource is parameterized in the returned CloudFormation template.
Arn (string) -- [REQUIRED]
The ARN of the specific Theme resource whose override properties are configured in this structure.
Properties (list) -- [REQUIRED]
A list of Theme resource properties to generate variables for in the returned CloudFormation template.
(string) --
Analyses (list) --
An optional list of structures that control how Analysis resources are parameterized in the returned CloudFormation template.
(dict) --
Controls how a specific Analysis resource is parameterized in the returned CloudFormation template.
Arn (string) -- [REQUIRED]
The ARN of the specific Analysis resource whose override properties are configured in this structure.
Properties (list) -- [REQUIRED]
A list of Analysis resource properties to generate variables for in the returned CloudFormation template.
(string) --
Dashboards (list) --
An optional list of structures that control how Dashboard resources are parameterized in the returned CloudFormation template.
(dict) --
Controls how a specific Dashboard resource is parameterized in the returned CloudFormation template.
Arn (string) -- [REQUIRED]
The ARN of the specific Dashboard resource whose override properties are configured in this structure.
Properties (list) -- [REQUIRED]
A list of Dashboard resource properties to generate variables for in the returned CloudFormation template.
(string) --
Folders (list) --
An optional list of structures that controls how Folder resources are parameterized in the returned CloudFormation template.
(dict) --
Controls how a specific Folder resource is parameterized in the returned CloudFormation template.
Arn (string) -- [REQUIRED]
The ARN of the specific Folder resource whose override properties are configured in this structure.
Properties (list) -- [REQUIRED]
A list of Folder resource properties to generate variables for in the returned CloudFormation template.
(string) --
boolean
A Boolean that determines whether all permissions for each resource ARN are exported with the job. If you set IncludePermissions to TRUE, any permissions associated with each resource are exported.
boolean
A Boolean that determines whether all tags for each resource ARN are exported with the job. If you set IncludeTags to TRUE, any tags associated with each resource are exported.
dict
An optional parameter that determines which validation strategy to use for the export job. If StrictModeForAllResources is set to TRUE, strict validation for every error is enforced. If it is set to FALSE, validation is skipped for specific UI errors that are shown as warnings. The default value for StrictModeForAllResources is FALSE.
StrictModeForAllResources (boolean) --
A Boolean value that indicates whether to export resources under strict or lenient mode.
boolean
A Boolean that determines if the exported asset carries over information about the folders that the asset is a member of.
string
A setting that indicates whether you want to include folder assets. You can also use this setting to recusrsively include all subfolders of an exported folder.
dict
Response Syntax
{
'Arn': 'string',
'AssetBundleExportJobId': 'string',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) for the export job.
AssetBundleExportJobId (string) --
The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.
RequestId (string) --
The Amazon Web Services response ID for this operation.
Status (integer) --
The HTTP status of the response.
{'OverrideParameters': {'DataSets': {'DataSetRefreshProperties': {'FailureConfiguration': {'EmailAlert': {'AlertStatus': 'ENABLED '
'| '
'DISABLED'}},
'RefreshConfiguration': {'IncrementalRefresh': {'LookbackWindow': {'ColumnName': 'string',
'Size': 'long',
'SizeUnit': 'HOUR '
'| '
'DAY '
'| '
'WEEK'}}}}},
'DataSources': {'DataSourceParameters': {'OracleParameters': {'UseServiceName': 'boolean'}}}}}
Starts an Asset Bundle import job.
An Asset Bundle import job imports specified Amazon QuickSight assets into an Amazon QuickSight account. You can also choose to import a naming prefix and specified configuration overrides. The assets that are contained in the bundle file that you provide are used to create or update a new or existing asset in your Amazon QuickSight account. Each Amazon QuickSight account can run up to 5 import jobs concurrently.
The API caller must have the necessary "create", "describe", and "update" permissions in their IAM role to access each resource type that is contained in the bundle file before the resources can be imported.
See also: AWS API Documentation
Request Syntax
client.start_asset_bundle_import_job(
AwsAccountId='string',
AssetBundleImportJobId='string',
AssetBundleImportSource={
'Body': b'bytes',
'S3Uri': 'string'
},
OverrideParameters={
'ResourceIdOverrideConfiguration': {
'PrefixForAllResources': 'string'
},
'VPCConnections': [
{
'VPCConnectionId': 'string',
'Name': 'string',
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
],
'DnsResolvers': [
'string',
],
'RoleArn': 'string'
},
],
'RefreshSchedules': [
{
'DataSetId': 'string',
'ScheduleId': 'string',
'StartAfterDateTime': datetime(2015, 1, 1)
},
],
'DataSources': [
{
'DataSourceId': 'string',
'Name': 'string',
'DataSourceParameters': {
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string',
'RoleArn': 'string'
},
'AuroraParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AuroraPostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AwsIotAnalyticsParameters': {
'DataSetName': 'string'
},
'JiraParameters': {
'SiteBaseUrl': 'string'
},
'MariaDbParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'MySqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'OracleParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'UseServiceName': True|False
},
'PostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PrestoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'RdsParameters': {
'InstanceId': 'string',
'Database': 'string'
},
'RedshiftParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'ClusterId': 'string',
'IAMParameters': {
'RoleArn': 'string',
'DatabaseUser': 'string',
'DatabaseGroups': [
'string',
],
'AutoCreateDatabaseUser': True|False
},
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string',
'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509',
'DatabaseAccessControlRole': 'string',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string'
}
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
},
'AmazonOpenSearchParameters': {
'Domain': 'string'
},
'ExasolParameters': {
'Host': 'string',
'Port': 123
},
'DatabricksParameters': {
'Host': 'string',
'Port': 123,
'SqlEndpointPath': 'string'
},
'StarburstParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string',
'ProductType': 'GALAXY'|'ENTERPRISE',
'DatabaseAccessControlRole': 'string',
'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string'
}
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'BigQueryParameters': {
'ProjectId': 'string',
'DataSetRegion': 'string'
}
},
'VpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'SslProperties': {
'DisableSsl': True|False
},
'Credentials': {
'CredentialPair': {
'Username': 'string',
'Password': 'string'
},
'SecretArn': 'string'
}
},
],
'DataSets': [
{
'DataSetId': 'string',
'Name': 'string',
'DataSetRefreshProperties': {
'RefreshConfiguration': {
'IncrementalRefresh': {
'LookbackWindow': {
'ColumnName': 'string',
'Size': 123,
'SizeUnit': 'HOUR'|'DAY'|'WEEK'
}
}
},
'FailureConfiguration': {
'EmailAlert': {
'AlertStatus': 'ENABLED'|'DISABLED'
}
}
}
},
],
'Themes': [
{
'ThemeId': 'string',
'Name': 'string'
},
],
'Analyses': [
{
'AnalysisId': 'string',
'Name': 'string'
},
],
'Dashboards': [
{
'DashboardId': 'string',
'Name': 'string'
},
],
'Folders': [
{
'FolderId': 'string',
'Name': 'string',
'ParentFolderArn': 'string'
},
]
},
FailureAction='DO_NOTHING'|'ROLLBACK',
OverridePermissions={
'DataSources': [
{
'DataSourceIds': [
'string',
],
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
}
},
],
'DataSets': [
{
'DataSetIds': [
'string',
],
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
}
},
],
'Themes': [
{
'ThemeIds': [
'string',
],
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
}
},
],
'Analyses': [
{
'AnalysisIds': [
'string',
],
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
}
},
],
'Dashboards': [
{
'DashboardIds': [
'string',
],
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
},
'LinkSharingConfiguration': {
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
}
}
},
],
'Folders': [
{
'FolderIds': [
'string',
],
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
}
},
]
},
OverrideTags={
'VPCConnections': [
{
'VPCConnectionIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'DataSources': [
{
'DataSourceIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'DataSets': [
{
'DataSetIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'Themes': [
{
'ThemeIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'Analyses': [
{
'AnalysisIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'Dashboards': [
{
'DashboardIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'Folders': [
{
'FolderIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
},
OverrideValidationStrategy={
'StrictModeForAllResources': True|False
}
)
string
[REQUIRED]
The ID of the Amazon Web Services account to import assets into.
string
[REQUIRED]
The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.
dict
[REQUIRED]
The source of the asset bundle zip file that contains the data that you want to import. The file must be in QUICKSIGHT_JSON format.
Body (bytes) --
The bytes of the base64 encoded asset bundle import zip file. This file can't exceed 20 MB. If the size of the file that you want to upload is more than 20 MB, add the file to your Amazon S3 bucket and use S3Uri of the file for this operation.
If you are calling the API operations from the Amazon Web Services SDK for Java, JavaScript, Python, or PHP, the SDK encodes base64 automatically to allow the direct setting of the zip file's bytes. If you are using an SDK for a different language or receiving related errors, try to base64 encode your data.
S3Uri (string) --
The Amazon S3 URI for an asset bundle import file that exists in an Amazon S3 bucket that the caller has read access to. The file must be a zip format file and can't exceed 1 GB.
dict
Optional overrides that are applied to the resource configuration before import.
ResourceIdOverrideConfiguration (dict) --
An optional structure that configures resource ID overrides to be applied within the import job.
PrefixForAllResources (string) --
An option to request a CloudFormation variable for a prefix to be prepended to each resource's ID before import. The prefix is only added to the asset IDs and does not change the name of the asset.
VPCConnections (list) --
A list of overrides for any VPCConnection resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single VPC connection that is imported.
VPCConnectionId (string) -- [REQUIRED]
The ID of the VPC Connection to apply overrides to.
Name (string) --
A new name for the VPC connection.
SubnetIds (list) --
A list of new subnet IDs for the VPC connection you are importing. This field is required if you are importing the VPC connection from another Amazon Web Services account or Region.
(string) --
SecurityGroupIds (list) --
A new security group ID for the VPC connection you are importing. This field is required if you are importing the VPC connection from another Amazon Web Services account or Region.
(string) --
DnsResolvers (list) --
An optional override of DNS resolvers to be used by the VPC connection.
(string) --
RoleArn (string) --
An optional override of the role ARN to be used by the VPC connection.
RefreshSchedules (list) --
A list of overrides for any RefreshSchedule resources that are present in the asset bundle that is imported.
(dict) --
A list of overrides for a specific RefreshsSchedule resource that is present in the asset bundle that is imported.
DataSetId (string) -- [REQUIRED]
A partial identifier for the specific RefreshSchedule resource that is being overridden. This structure is used together with the ScheduleID structure.
ScheduleId (string) -- [REQUIRED]
A partial identifier for the specific RefreshSchedule resource being overridden. This structure is used together with the DataSetId structure.
StartAfterDateTime (datetime) --
An override for the StartAfterDateTime of a RefreshSchedule. Make sure that the StartAfterDateTime is set to a time that takes place in the future.
DataSources (list) --
A list of overrides for any DataSource resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single data source that is being imported.
DataSourceId (string) -- [REQUIRED]
The ID of the data source to apply overrides to.
Name (string) --
A new name for the data source.
DataSourceParameters (dict) --
The parameters that Amazon QuickSight uses to connect to your underlying data source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
AmazonElasticsearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) -- [REQUIRED]
The OpenSearch domain.
AthenaParameters (dict) --
The parameters for Amazon Athena.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.
AuroraParameters (dict) --
The parameters for Amazon Aurora MySQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
AuroraPostgreSqlParameters (dict) --
The parameters for Amazon Aurora.
Host (string) -- [REQUIRED]
The Amazon Aurora PostgreSQL-Compatible host to connect to.
Port (integer) -- [REQUIRED]
The port that Amazon Aurora PostgreSQL is listening on.
Database (string) -- [REQUIRED]
The Amazon Aurora PostgreSQL database to connect to.
AwsIotAnalyticsParameters (dict) --
The parameters for IoT Analytics.
DataSetName (string) -- [REQUIRED]
Dataset name.
JiraParameters (dict) --
The parameters for Jira.
SiteBaseUrl (string) -- [REQUIRED]
The base URL of the Jira site.
MariaDbParameters (dict) --
The parameters for MariaDB.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
MySqlParameters (dict) --
The parameters for MySQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
OracleParameters (dict) --
The parameters for Oracle.
Host (string) -- [REQUIRED]
An Oracle host.
Port (integer) -- [REQUIRED]
The port.
Database (string) -- [REQUIRED]
The database.
UseServiceName (boolean) --
A Boolean value that indicates whether the Database uses a service name or an SID. If this value is left blank, the default value is SID. If this value is set to false, the value is SID.
PostgreSqlParameters (dict) --
The parameters for PostgreSQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
PrestoParameters (dict) --
The parameters for Presto.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Catalog (string) -- [REQUIRED]
Catalog.
RdsParameters (dict) --
The parameters for Amazon RDS.
InstanceId (string) -- [REQUIRED]
Instance ID.
Database (string) -- [REQUIRED]
Database.
RedshiftParameters (dict) --
The parameters for Amazon Redshift.
Host (string) --
Host. This field can be blank if ClusterId is provided.
Port (integer) --
Port. This field can be blank if the ClusterId is provided.
Database (string) -- [REQUIRED]
Database.
ClusterId (string) --
Cluster ID. This field can be blank if the Host and Port are provided.
IAMParameters (dict) --
An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials.
RoleArn (string) -- [REQUIRED]
Use the RoleArn structure to allow Amazon QuickSight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role.
DatabaseUser (string) --
The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.
DatabaseGroups (list) --
A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the DatabaseUser. If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup.
(string) --
AutoCreateDatabaseUser (boolean) --
Automatically creates a database user. If your database doesn't have a DatabaseUser, set this parameter to True. If there is no DatabaseUser, Amazon QuickSight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Amazon QuickSight access to your cluster.
This parameter can only be specified if your Amazon QuickSight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
S3Parameters (dict) --
The parameters for S3.
ManifestFileLocation (dict) -- [REQUIRED]
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight.
Bucket (string) -- [REQUIRED]
Amazon S3 bucket.
Key (string) -- [REQUIRED]
Amazon S3 key that identifies an object.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
ServiceNowParameters (dict) --
The parameters for ServiceNow.
SiteBaseUrl (string) -- [REQUIRED]
URL of the base site.
SnowflakeParameters (dict) --
The parameters for Snowflake.
Host (string) -- [REQUIRED]
Host.
Database (string) -- [REQUIRED]
Database.
Warehouse (string) -- [REQUIRED]
Warehouse.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
DatabaseAccessControlRole (string) --
The database access control role.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Amazon QuickSight account and Snowflake.
TokenProviderUrl (string) -- [REQUIRED]
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
SparkParameters (dict) --
The parameters for Spark.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
SqlServerParameters (dict) --
The parameters for SQL Server.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TeradataParameters (dict) --
The parameters for Teradata.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TwitterParameters (dict) --
The parameters for Twitter.
Query (string) -- [REQUIRED]
Twitter query string.
MaxRows (integer) -- [REQUIRED]
Maximum number of rows to query Twitter.
AmazonOpenSearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) -- [REQUIRED]
The OpenSearch domain.
ExasolParameters (dict) --
The parameters for Exasol.
Host (string) -- [REQUIRED]
The hostname or IP address of the Exasol data source.
Port (integer) -- [REQUIRED]
The port for the Exasol data source.
DatabricksParameters (dict) --
The parameters that are required to connect to a Databricks data source.
Host (string) -- [REQUIRED]
The host name of the Databricks data source.
Port (integer) -- [REQUIRED]
The port for the Databricks data source.
SqlEndpointPath (string) -- [REQUIRED]
The HTTP path of the Databricks data source.
StarburstParameters (dict) --
The parameters that are required to connect to a Starburst data source.
Host (string) -- [REQUIRED]
The host name of the Starburst data source.
Port (integer) -- [REQUIRED]
The port for the Starburst data source.
Catalog (string) -- [REQUIRED]
The catalog name for the Starburst data source.
ProductType (string) --
The product type for the Starburst data source.
DatabaseAccessControlRole (string) --
The database access control role.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Amazon QuickSight account and Starburst.
TokenProviderUrl (string) -- [REQUIRED]
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
TrinoParameters (dict) --
The parameters that are required to connect to a Trino data source.
Host (string) -- [REQUIRED]
The host name of the Trino data source.
Port (integer) -- [REQUIRED]
The port for the Trino data source.
Catalog (string) -- [REQUIRED]
The catalog name for the Trino data source.
BigQueryParameters (dict) --
The parameters that are required to connect to a Google BigQuery data source.
ProjectId (string) -- [REQUIRED]
The Google Cloud Platform project ID where your datasource was created.
DataSetRegion (string) --
The storage location where you create a Google BigQuery data source.
VpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
SslProperties (dict) --
Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying data source.
DisableSsl (boolean) --
A Boolean option to control whether SSL should be disabled.
Credentials (dict) --
An optional structure that provides the credentials to be used to create the imported data source.
CredentialPair (dict) --
A username and password credential pair to be used to create the imported data source. Keep this field blank if you are using a Secrets Manager secret to provide credentials.
Username (string) -- [REQUIRED]
The username for the data source connection.
Password (string) -- [REQUIRED]
The password for the data source connection.
SecretArn (string) --
The ARN of the Secrets Manager secret that's used to create the imported data source. Keep this field blank, unless you are using a secret in place of a credential pair.
DataSets (list) --
A list of overrides for any DataSet resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single dataset that is being imported.
DataSetId (string) -- [REQUIRED]
The ID of the dataset to apply overrides to.
Name (string) --
A new name for the dataset.
DataSetRefreshProperties (dict) --
The refresh properties of a dataset.
RefreshConfiguration (dict) --
The refresh configuration for a dataset.
IncrementalRefresh (dict) -- [REQUIRED]
The incremental refresh for the dataset.
LookbackWindow (dict) -- [REQUIRED]
The lookback window setup for an incremental refresh configuration.
ColumnName (string) -- [REQUIRED]
The name of the lookback window column.
Size (integer) -- [REQUIRED]
The lookback window column size.
SizeUnit (string) -- [REQUIRED]
The size unit that is used for the lookback window column. Valid values for this structure are HOUR, DAY, and WEEK.
FailureConfiguration (dict) --
The failure configuration for a dataset.
EmailAlert (dict) --
The email alert configuration for a dataset refresh failure.
AlertStatus (string) --
The status value that determines if email alerts are sent.
Themes (list) --
A list of overrides for any Theme resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single theme that is imported.
ThemeId (string) -- [REQUIRED]
The ID of the theme to apply overrides to.
Name (string) --
A new name for the theme.
Analyses (list) --
A list of overrides for any Analysis resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single analysis that is being imported.
AnalysisId (string) -- [REQUIRED]
The ID of the analysis that you ant to apply overrides to.
Name (string) --
A new name for the analysis.
Dashboards (list) --
A list of overrides for any Dashboard resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single dashboard that is being imported.
DashboardId (string) -- [REQUIRED]
The ID of the dashboard that you want to apply overrides to.
Name (string) --
A new name for the dashboard.
Folders (list) --
A list of overrides for any Folder resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single folder that is being imported.
FolderId (string) -- [REQUIRED]
The ID of the folder that you want to apply overrides to.
Name (string) --
A new name for the folder.
ParentFolderArn (string) --
A new parent folder arn. This change can only be applied if the import creates a brand new folder. Existing folders cannot be moved.
string
The failure action for the import job.
If you choose ROLLBACK, failed import jobs will attempt to undo any asset changes caused by the failed job.
If you choose DO_NOTHING, failed import jobs will not attempt to roll back any asset changes caused by the failed job, possibly keeping the Amazon QuickSight account in an inconsistent state.
dict
Optional permission overrides that are applied to the resource configuration before import.
DataSources (list) --
A list of permissions overrides for any DataSource resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of permissions to be applied to a list of data source IDs.
DataSourceIds (list) -- [REQUIRED]
A list of data source IDs that you want to apply overrides to. You can use * to override all data sources in this asset bundle.
(string) --
Permissions (dict) -- [REQUIRED]
A list of permissions for the data source that you want to apply overrides to.
Principals (list) -- [REQUIRED]
A list of principals to grant permissions on.
(string) --
Actions (list) -- [REQUIRED]
A list of IAM actions to grant permissions on.
(string) --
DataSets (list) --
A list of permissions overrides for any DataSet resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of permissions to be applied to a list of dataset IDs.
DataSetIds (list) -- [REQUIRED]
A list of dataset IDs that you want to apply overrides to. You can use * to override all datasets in this asset bundle.
(string) --
Permissions (dict) -- [REQUIRED]
A list of permissions for the datasets that you want to apply overrides to.
Principals (list) -- [REQUIRED]
A list of principals to grant permissions on.
(string) --
Actions (list) -- [REQUIRED]
A list of IAM actions to grant permissions on.
(string) --
Themes (list) --
A list of permissions overrides for any Theme resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of permissions to be applied to a list of theme IDs.
ThemeIds (list) -- [REQUIRED]
A list of theme IDs that you want to apply overrides to. You can use * to override all themes in this asset bundle.
(string) --
Permissions (dict) -- [REQUIRED]
A list of permissions for the themes that you want to apply overrides to.
Principals (list) -- [REQUIRED]
A list of principals to grant permissions on.
(string) --
Actions (list) -- [REQUIRED]
A list of IAM actions to grant permissions on.
(string) --
Analyses (list) --
A list of permissions overrides for any Analysis resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of permissions to be applied to a list of analysis IDs.
AnalysisIds (list) -- [REQUIRED]
A list of analysis IDs that you want to apply overrides to. You can use * to override all analyses in this asset bundle.
(string) --
Permissions (dict) -- [REQUIRED]
A list of permissions for the analyses that you want to apply overrides to.
Principals (list) -- [REQUIRED]
A list of principals to grant permissions on.
(string) --
Actions (list) -- [REQUIRED]
A list of IAM actions to grant permissions on.
(string) --
Dashboards (list) --
A list of permissions overrides for any Dashboard resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of permissions to be applied to a list of dashboard IDs.
DashboardIds (list) -- [REQUIRED]
A list of dashboard IDs that you want to apply overrides to. You can use * to override all dashboards in this asset bundle.
(string) --
Permissions (dict) --
A list of permissions for the dashboards that you want to apply overrides to.
Principals (list) -- [REQUIRED]
A list of principals to grant permissions on.
(string) --
Actions (list) -- [REQUIRED]
A list of IAM actions to grant permissions on.
(string) --
LinkSharingConfiguration (dict) --
A structure that contains the link sharing configurations that you want to apply overrides to.
Permissions (dict) --
A list of link sharing permissions for the dashboards that you want to apply overrides to.
Principals (list) -- [REQUIRED]
A list of principals to grant permissions on.
(string) --
Actions (list) -- [REQUIRED]
A list of IAM actions to grant permissions on.
(string) --
Folders (list) --
A list of permissions for the folders that you want to apply overrides to.
(dict) --
An object that contains a list of permissions to be applied to a list of folder IDs.
FolderIds (list) -- [REQUIRED]
A list of folder IDs that you want to apply overrides to. You can use * to override all folders in this asset bundle.
(string) --
Permissions (dict) --
A structure that contains the permissions for the resource that you want to override in an asset bundle import job.
Principals (list) -- [REQUIRED]
A list of principals to grant permissions on.
(string) --
Actions (list) -- [REQUIRED]
A list of IAM actions to grant permissions on.
(string) --
dict
Optional tag overrides that are applied to the resource configuration before import.
VPCConnections (list) --
A list of tag overrides for any VPCConnection resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of VPC connection IDs.
VPCConnectionIds (list) -- [REQUIRED]
A list of VPC connection IDs that you want to apply overrides to. You can use * to override all VPC connections in this asset bundle.
(string) --
Tags (list) -- [REQUIRED]
A list of tags for the VPC connections that you want to apply overrides to.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) -- [REQUIRED]
Tag key.
Value (string) -- [REQUIRED]
Tag value.
DataSources (list) --
A list of tag overrides for any DataSource resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of data source IDs.
DataSourceIds (list) -- [REQUIRED]
A list of data source IDs that you want to apply overrides to. You can use * to override all data sources in this asset bundle.
(string) --
Tags (list) -- [REQUIRED]
A list of tags for the data source that you want to apply overrides to.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) -- [REQUIRED]
Tag key.
Value (string) -- [REQUIRED]
Tag value.
DataSets (list) --
A list of tag overrides for any DataSet resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of dataset IDs.
DataSetIds (list) -- [REQUIRED]
A list of dataset IDs that you want to apply overrides to. You can use * to override all datasets in this asset bundle.
(string) --
Tags (list) -- [REQUIRED]
A list of tags for the datasets that you want to apply overrides to.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) -- [REQUIRED]
Tag key.
Value (string) -- [REQUIRED]
Tag value.
Themes (list) --
A list of tag overrides for any Theme resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of theme IDs.
ThemeIds (list) -- [REQUIRED]
A list of theme IDs that you want to apply overrides to. You can use * to override all themes in this asset bundle.
(string) --
Tags (list) -- [REQUIRED]
A list of tags for the themes that you want to apply overrides to.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) -- [REQUIRED]
Tag key.
Value (string) -- [REQUIRED]
Tag value.
Analyses (list) --
A list of tag overrides for any Analysis resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of analysis IDs.
AnalysisIds (list) -- [REQUIRED]
A list of analysis IDs that you want to apply overrides to. You can use * to override all analyses in this asset bundle.
(string) --
Tags (list) -- [REQUIRED]
A list of tags for the analyses that you want to apply overrides to.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) -- [REQUIRED]
Tag key.
Value (string) -- [REQUIRED]
Tag value.
Dashboards (list) --
A list of tag overrides for any Dashboard resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of dashboard IDs.
DashboardIds (list) -- [REQUIRED]
A list of dashboard IDs that you want to apply overrides to. You can use * to override all dashboards in this asset bundle.
(string) --
Tags (list) -- [REQUIRED]
A list of tags for the dashboards that you want to apply overrides to.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) -- [REQUIRED]
Tag key.
Value (string) -- [REQUIRED]
Tag value.
Folders (list) --
A list of tag overrides for any Folder resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of folder IDs.
FolderIds (list) -- [REQUIRED]
A list of folder IDs that you want to apply overrides to. You can use * to override all folders in this asset bundle.
(string) --
Tags (list) -- [REQUIRED]
A list of tags for the folders that you want to apply overrides to.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) -- [REQUIRED]
Tag key.
Value (string) -- [REQUIRED]
Tag value.
dict
An optional validation strategy override for all analyses and dashboards that is applied to the resource configuration before import.
StrictModeForAllResources (boolean) --
A Boolean value that indicates whether to import all analyses and dashboards under strict or lenient mode.
dict
Response Syntax
{
'Arn': 'string',
'AssetBundleImportJobId': 'string',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) for the import job.
AssetBundleImportJobId (string) --
The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.
RequestId (string) --
The Amazon Web Services response ID for this operation.
Status (integer) --
The HTTP status of the response.
{'Definition': {'Options': {'ExcludedDataSetArns': ['string'],
'QBusinessInsightsStatus': 'ENABLED | DISABLED'},
'Sheets': {'Visuals': {'TableVisual': {'ChartConfiguration': {'FieldOptions': {'TransposedTableOptions': [{'ColumnIndex': 'integer',
'ColumnType': 'ROW_HEADER_COLUMN '
'| '
'VALUE_COLUMN',
'ColumnWidth': 'string'}]}}}}}}}
Updates an analysis in Amazon QuickSight
See also: AWS API Documentation
Request Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.Parameters
# This section is too large to render. # Please see the AWS API Documentation linked below.
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 Amazon Web Services request ID for this operation.
{'DashboardPublishOptions': {'DataQAEnabledOption': {'AvailabilityStatus': 'ENABLED '
'| '
'DISABLED'}},
'Definition': {'Options': {'ExcludedDataSetArns': ['string'],
'QBusinessInsightsStatus': 'ENABLED | DISABLED'},
'Sheets': {'Visuals': {'TableVisual': {'ChartConfiguration': {'FieldOptions': {'TransposedTableOptions': [{'ColumnIndex': 'integer',
'ColumnType': 'ROW_HEADER_COLUMN '
'| '
'VALUE_COLUMN',
'ColumnWidth': 'string'}]}}}}}}}
Updates a dashboard in an Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.Parameters
# This section is too large to render. # Please see the AWS API Documentation linked below.
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 Amazon Web Services request ID for this operation.
{'Credentials': {'CredentialPair': {'AlternateDataSourceParameters': {'OracleParameters': {'UseServiceName': 'boolean'}}}},
'DataSourceParameters': {'OracleParameters': {'UseServiceName': 'boolean'}}}
Updates a data source.
See also: AWS API Documentation
Request Syntax
client.update_data_source(
AwsAccountId='string',
DataSourceId='string',
Name='string',
DataSourceParameters={
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string',
'RoleArn': 'string'
},
'AuroraParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AuroraPostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AwsIotAnalyticsParameters': {
'DataSetName': 'string'
},
'JiraParameters': {
'SiteBaseUrl': 'string'
},
'MariaDbParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'MySqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'OracleParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'UseServiceName': True|False
},
'PostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PrestoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'RdsParameters': {
'InstanceId': 'string',
'Database': 'string'
},
'RedshiftParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'ClusterId': 'string',
'IAMParameters': {
'RoleArn': 'string',
'DatabaseUser': 'string',
'DatabaseGroups': [
'string',
],
'AutoCreateDatabaseUser': True|False
},
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string',
'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509',
'DatabaseAccessControlRole': 'string',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string'
}
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
},
'AmazonOpenSearchParameters': {
'Domain': 'string'
},
'ExasolParameters': {
'Host': 'string',
'Port': 123
},
'DatabricksParameters': {
'Host': 'string',
'Port': 123,
'SqlEndpointPath': 'string'
},
'StarburstParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string',
'ProductType': 'GALAXY'|'ENTERPRISE',
'DatabaseAccessControlRole': 'string',
'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string'
}
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'BigQueryParameters': {
'ProjectId': 'string',
'DataSetRegion': 'string'
}
},
Credentials={
'CredentialPair': {
'Username': 'string',
'Password': 'string',
'AlternateDataSourceParameters': [
{
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string',
'RoleArn': 'string'
},
'AuroraParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AuroraPostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AwsIotAnalyticsParameters': {
'DataSetName': 'string'
},
'JiraParameters': {
'SiteBaseUrl': 'string'
},
'MariaDbParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'MySqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'OracleParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'UseServiceName': True|False
},
'PostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PrestoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'RdsParameters': {
'InstanceId': 'string',
'Database': 'string'
},
'RedshiftParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'ClusterId': 'string',
'IAMParameters': {
'RoleArn': 'string',
'DatabaseUser': 'string',
'DatabaseGroups': [
'string',
],
'AutoCreateDatabaseUser': True|False
},
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string',
'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509',
'DatabaseAccessControlRole': 'string',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string'
}
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
},
'AmazonOpenSearchParameters': {
'Domain': 'string'
},
'ExasolParameters': {
'Host': 'string',
'Port': 123
},
'DatabricksParameters': {
'Host': 'string',
'Port': 123,
'SqlEndpointPath': 'string'
},
'StarburstParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string',
'ProductType': 'GALAXY'|'ENTERPRISE',
'DatabaseAccessControlRole': 'string',
'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string'
}
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'BigQueryParameters': {
'ProjectId': 'string',
'DataSetRegion': 'string'
}
},
]
},
'CopySourceArn': 'string',
'SecretArn': 'string'
},
VpcConnectionProperties={
'VpcConnectionArn': 'string'
},
SslProperties={
'DisableSsl': True|False
}
)
string
[REQUIRED]
The Amazon Web Services account ID.
string
[REQUIRED]
The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
string
[REQUIRED]
A display name for the data source.
dict
The parameters that Amazon QuickSight uses to connect to your underlying source.
AmazonElasticsearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) -- [REQUIRED]
The OpenSearch domain.
AthenaParameters (dict) --
The parameters for Amazon Athena.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.
AuroraParameters (dict) --
The parameters for Amazon Aurora MySQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
AuroraPostgreSqlParameters (dict) --
The parameters for Amazon Aurora.
Host (string) -- [REQUIRED]
The Amazon Aurora PostgreSQL-Compatible host to connect to.
Port (integer) -- [REQUIRED]
The port that Amazon Aurora PostgreSQL is listening on.
Database (string) -- [REQUIRED]
The Amazon Aurora PostgreSQL database to connect to.
AwsIotAnalyticsParameters (dict) --
The parameters for IoT Analytics.
DataSetName (string) -- [REQUIRED]
Dataset name.
JiraParameters (dict) --
The parameters for Jira.
SiteBaseUrl (string) -- [REQUIRED]
The base URL of the Jira site.
MariaDbParameters (dict) --
The parameters for MariaDB.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
MySqlParameters (dict) --
The parameters for MySQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
OracleParameters (dict) --
The parameters for Oracle.
Host (string) -- [REQUIRED]
An Oracle host.
Port (integer) -- [REQUIRED]
The port.
Database (string) -- [REQUIRED]
The database.
UseServiceName (boolean) --
A Boolean value that indicates whether the Database uses a service name or an SID. If this value is left blank, the default value is SID. If this value is set to false, the value is SID.
PostgreSqlParameters (dict) --
The parameters for PostgreSQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
PrestoParameters (dict) --
The parameters for Presto.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Catalog (string) -- [REQUIRED]
Catalog.
RdsParameters (dict) --
The parameters for Amazon RDS.
InstanceId (string) -- [REQUIRED]
Instance ID.
Database (string) -- [REQUIRED]
Database.
RedshiftParameters (dict) --
The parameters for Amazon Redshift.
Host (string) --
Host. This field can be blank if ClusterId is provided.
Port (integer) --
Port. This field can be blank if the ClusterId is provided.
Database (string) -- [REQUIRED]
Database.
ClusterId (string) --
Cluster ID. This field can be blank if the Host and Port are provided.
IAMParameters (dict) --
An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials.
RoleArn (string) -- [REQUIRED]
Use the RoleArn structure to allow Amazon QuickSight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role.
DatabaseUser (string) --
The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.
DatabaseGroups (list) --
A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the DatabaseUser. If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup.
(string) --
AutoCreateDatabaseUser (boolean) --
Automatically creates a database user. If your database doesn't have a DatabaseUser, set this parameter to True. If there is no DatabaseUser, Amazon QuickSight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Amazon QuickSight access to your cluster.
This parameter can only be specified if your Amazon QuickSight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
S3Parameters (dict) --
The parameters for S3.
ManifestFileLocation (dict) -- [REQUIRED]
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight.
Bucket (string) -- [REQUIRED]
Amazon S3 bucket.
Key (string) -- [REQUIRED]
Amazon S3 key that identifies an object.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
ServiceNowParameters (dict) --
The parameters for ServiceNow.
SiteBaseUrl (string) -- [REQUIRED]
URL of the base site.
SnowflakeParameters (dict) --
The parameters for Snowflake.
Host (string) -- [REQUIRED]
Host.
Database (string) -- [REQUIRED]
Database.
Warehouse (string) -- [REQUIRED]
Warehouse.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
DatabaseAccessControlRole (string) --
The database access control role.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Amazon QuickSight account and Snowflake.
TokenProviderUrl (string) -- [REQUIRED]
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
SparkParameters (dict) --
The parameters for Spark.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
SqlServerParameters (dict) --
The parameters for SQL Server.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TeradataParameters (dict) --
The parameters for Teradata.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TwitterParameters (dict) --
The parameters for Twitter.
Query (string) -- [REQUIRED]
Twitter query string.
MaxRows (integer) -- [REQUIRED]
Maximum number of rows to query Twitter.
AmazonOpenSearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) -- [REQUIRED]
The OpenSearch domain.
ExasolParameters (dict) --
The parameters for Exasol.
Host (string) -- [REQUIRED]
The hostname or IP address of the Exasol data source.
Port (integer) -- [REQUIRED]
The port for the Exasol data source.
DatabricksParameters (dict) --
The parameters that are required to connect to a Databricks data source.
Host (string) -- [REQUIRED]
The host name of the Databricks data source.
Port (integer) -- [REQUIRED]
The port for the Databricks data source.
SqlEndpointPath (string) -- [REQUIRED]
The HTTP path of the Databricks data source.
StarburstParameters (dict) --
The parameters that are required to connect to a Starburst data source.
Host (string) -- [REQUIRED]
The host name of the Starburst data source.
Port (integer) -- [REQUIRED]
The port for the Starburst data source.
Catalog (string) -- [REQUIRED]
The catalog name for the Starburst data source.
ProductType (string) --
The product type for the Starburst data source.
DatabaseAccessControlRole (string) --
The database access control role.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Amazon QuickSight account and Starburst.
TokenProviderUrl (string) -- [REQUIRED]
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
TrinoParameters (dict) --
The parameters that are required to connect to a Trino data source.
Host (string) -- [REQUIRED]
The host name of the Trino data source.
Port (integer) -- [REQUIRED]
The port for the Trino data source.
Catalog (string) -- [REQUIRED]
The catalog name for the Trino data source.
BigQueryParameters (dict) --
The parameters that are required to connect to a Google BigQuery data source.
ProjectId (string) -- [REQUIRED]
The Google Cloud Platform project ID where your datasource was created.
DataSetRegion (string) --
The storage location where you create a Google BigQuery data source.
dict
The credentials that Amazon QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.
CredentialPair (dict) --
Credential pair. For more information, see ``CredentialPair ``.
Username (string) -- [REQUIRED]
User name.
Password (string) -- [REQUIRED]
Password.
AlternateDataSourceParameters (list) --
A set of alternate data source parameters that you want to share for these credentials. The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the DataSourceParameters structure that's in the request with the structures in the AlternateDataSourceParameters allow list. If the structures are an exact match, the request is allowed to use the new data source with the existing credentials. If the AlternateDataSourceParameters list is null, the DataSourceParameters originally used with these Credentials is automatically allowed.
(dict) --
The parameters that Amazon QuickSight uses to connect to your underlying data source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
AmazonElasticsearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) -- [REQUIRED]
The OpenSearch domain.
AthenaParameters (dict) --
The parameters for Amazon Athena.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.
AuroraParameters (dict) --
The parameters for Amazon Aurora MySQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
AuroraPostgreSqlParameters (dict) --
The parameters for Amazon Aurora.
Host (string) -- [REQUIRED]
The Amazon Aurora PostgreSQL-Compatible host to connect to.
Port (integer) -- [REQUIRED]
The port that Amazon Aurora PostgreSQL is listening on.
Database (string) -- [REQUIRED]
The Amazon Aurora PostgreSQL database to connect to.
AwsIotAnalyticsParameters (dict) --
The parameters for IoT Analytics.
DataSetName (string) -- [REQUIRED]
Dataset name.
JiraParameters (dict) --
The parameters for Jira.
SiteBaseUrl (string) -- [REQUIRED]
The base URL of the Jira site.
MariaDbParameters (dict) --
The parameters for MariaDB.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
MySqlParameters (dict) --
The parameters for MySQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
OracleParameters (dict) --
The parameters for Oracle.
Host (string) -- [REQUIRED]
An Oracle host.
Port (integer) -- [REQUIRED]
The port.
Database (string) -- [REQUIRED]
The database.
UseServiceName (boolean) --
A Boolean value that indicates whether the Database uses a service name or an SID. If this value is left blank, the default value is SID. If this value is set to false, the value is SID.
PostgreSqlParameters (dict) --
The parameters for PostgreSQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
PrestoParameters (dict) --
The parameters for Presto.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Catalog (string) -- [REQUIRED]
Catalog.
RdsParameters (dict) --
The parameters for Amazon RDS.
InstanceId (string) -- [REQUIRED]
Instance ID.
Database (string) -- [REQUIRED]
Database.
RedshiftParameters (dict) --
The parameters for Amazon Redshift.
Host (string) --
Host. This field can be blank if ClusterId is provided.
Port (integer) --
Port. This field can be blank if the ClusterId is provided.
Database (string) -- [REQUIRED]
Database.
ClusterId (string) --
Cluster ID. This field can be blank if the Host and Port are provided.
IAMParameters (dict) --
An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials.
RoleArn (string) -- [REQUIRED]
Use the RoleArn structure to allow Amazon QuickSight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role.
DatabaseUser (string) --
The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.
DatabaseGroups (list) --
A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the DatabaseUser. If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup.
(string) --
AutoCreateDatabaseUser (boolean) --
Automatically creates a database user. If your database doesn't have a DatabaseUser, set this parameter to True. If there is no DatabaseUser, Amazon QuickSight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Amazon QuickSight access to your cluster.
This parameter can only be specified if your Amazon QuickSight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
S3Parameters (dict) --
The parameters for S3.
ManifestFileLocation (dict) -- [REQUIRED]
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight.
Bucket (string) -- [REQUIRED]
Amazon S3 bucket.
Key (string) -- [REQUIRED]
Amazon S3 key that identifies an object.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
ServiceNowParameters (dict) --
The parameters for ServiceNow.
SiteBaseUrl (string) -- [REQUIRED]
URL of the base site.
SnowflakeParameters (dict) --
The parameters for Snowflake.
Host (string) -- [REQUIRED]
Host.
Database (string) -- [REQUIRED]
Database.
Warehouse (string) -- [REQUIRED]
Warehouse.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
DatabaseAccessControlRole (string) --
The database access control role.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Amazon QuickSight account and Snowflake.
TokenProviderUrl (string) -- [REQUIRED]
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
SparkParameters (dict) --
The parameters for Spark.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
SqlServerParameters (dict) --
The parameters for SQL Server.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TeradataParameters (dict) --
The parameters for Teradata.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TwitterParameters (dict) --
The parameters for Twitter.
Query (string) -- [REQUIRED]
Twitter query string.
MaxRows (integer) -- [REQUIRED]
Maximum number of rows to query Twitter.
AmazonOpenSearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) -- [REQUIRED]
The OpenSearch domain.
ExasolParameters (dict) --
The parameters for Exasol.
Host (string) -- [REQUIRED]
The hostname or IP address of the Exasol data source.
Port (integer) -- [REQUIRED]
The port for the Exasol data source.
DatabricksParameters (dict) --
The parameters that are required to connect to a Databricks data source.
Host (string) -- [REQUIRED]
The host name of the Databricks data source.
Port (integer) -- [REQUIRED]
The port for the Databricks data source.
SqlEndpointPath (string) -- [REQUIRED]
The HTTP path of the Databricks data source.
StarburstParameters (dict) --
The parameters that are required to connect to a Starburst data source.
Host (string) -- [REQUIRED]
The host name of the Starburst data source.
Port (integer) -- [REQUIRED]
The port for the Starburst data source.
Catalog (string) -- [REQUIRED]
The catalog name for the Starburst data source.
ProductType (string) --
The product type for the Starburst data source.
DatabaseAccessControlRole (string) --
The database access control role.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Amazon QuickSight account and Starburst.
TokenProviderUrl (string) -- [REQUIRED]
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
TrinoParameters (dict) --
The parameters that are required to connect to a Trino data source.
Host (string) -- [REQUIRED]
The host name of the Trino data source.
Port (integer) -- [REQUIRED]
The port for the Trino data source.
Catalog (string) -- [REQUIRED]
The catalog name for the Trino data source.
BigQueryParameters (dict) --
The parameters that are required to connect to a Google BigQuery data source.
ProjectId (string) -- [REQUIRED]
The Google Cloud Platform project ID where your datasource was created.
DataSetRegion (string) --
The storage location where you create a Google BigQuery data source.
CopySourceArn (string) --
The Amazon Resource Name (ARN) of a data source that has the credential pair that you want to use. When CopySourceArn is not null, the credential pair from the data source in the ARN is used as the credentials for the DataSourceCredentials structure.
SecretArn (string) --
The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.
dict
Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
dict
Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.
DisableSsl (boolean) --
A Boolean option to control whether SSL should be disabled.
dict
Response Syntax
{
'Arn': 'string',
'DataSourceId': 'string',
'UpdateStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) of the data source.
DataSourceId (string) --
The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
UpdateStatus (string) --
The update status of the data source's last update.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'Definition': {'Options': {'ExcludedDataSetArns': ['string'],
'QBusinessInsightsStatus': 'ENABLED | DISABLED'},
'Sheets': {'Visuals': {'TableVisual': {'ChartConfiguration': {'FieldOptions': {'TransposedTableOptions': [{'ColumnIndex': 'integer',
'ColumnType': 'ROW_HEADER_COLUMN '
'| '
'VALUE_COLUMN',
'ColumnWidth': 'string'}]}}}}}}}
Updates a template from an existing Amazon QuickSight analysis or another template.
See also: AWS API Documentation
Request Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.Parameters
# This section is too large to render. # Please see the AWS API Documentation linked below.
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 Amazon Web Services request ID for this operation.