2024/10/03 - Amazon QuickSight - 7 updated api methods
Changes QuickSight: Add support for exporting and importing folders in AssetBundle APIs
{'Topic': {'ConfigOptions': {'QBusinessInsightsEnabled': 'boolean'}}}
Creates a new Q topic.
See also: AWS API Documentation
Request Syntax
client.create_topic(
AwsAccountId='string',
TopicId='string',
Topic={
'Name': 'string',
'Description': 'string',
'UserExperienceVersion': 'LEGACY'|'NEW_READER_EXPERIENCE',
'DataSets': [
{
'DatasetArn': 'string',
'DatasetName': 'string',
'DatasetDescription': 'string',
'DataAggregation': {
'DatasetRowDateGranularity': 'SECOND'|'MINUTE'|'HOUR'|'DAY'|'WEEK'|'MONTH'|'QUARTER'|'YEAR',
'DefaultDateColumnName': 'string'
},
'Filters': [
{
'FilterDescription': 'string',
'FilterClass': 'ENFORCED_VALUE_FILTER'|'CONDITIONAL_VALUE_FILTER'|'NAMED_VALUE_FILTER',
'FilterName': 'string',
'FilterSynonyms': [
'string',
],
'OperandFieldName': 'string',
'FilterType': 'CATEGORY_FILTER'|'NUMERIC_EQUALITY_FILTER'|'NUMERIC_RANGE_FILTER'|'DATE_RANGE_FILTER'|'RELATIVE_DATE_FILTER',
'CategoryFilter': {
'CategoryFilterFunction': 'EXACT'|'CONTAINS',
'CategoryFilterType': 'CUSTOM_FILTER'|'CUSTOM_FILTER_LIST'|'FILTER_LIST',
'Constant': {
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'SingularConstant': 'string',
'CollectiveConstant': {
'ValueList': [
'string',
]
}
},
'Inverse': True|False
},
'NumericEqualityFilter': {
'Constant': {
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'SingularConstant': 'string'
},
'Aggregation': 'NO_AGGREGATION'|'SUM'|'AVERAGE'|'COUNT'|'DISTINCT_COUNT'|'MAX'|'MEDIAN'|'MIN'|'STDEV'|'STDEVP'|'VAR'|'VARP'
},
'NumericRangeFilter': {
'Inclusive': True|False,
'Constant': {
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'RangeConstant': {
'Minimum': 'string',
'Maximum': 'string'
}
},
'Aggregation': 'NO_AGGREGATION'|'SUM'|'AVERAGE'|'COUNT'|'DISTINCT_COUNT'|'MAX'|'MEDIAN'|'MIN'|'STDEV'|'STDEVP'|'VAR'|'VARP'
},
'DateRangeFilter': {
'Inclusive': True|False,
'Constant': {
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'RangeConstant': {
'Minimum': 'string',
'Maximum': 'string'
}
}
},
'RelativeDateFilter': {
'TimeGranularity': 'SECOND'|'MINUTE'|'HOUR'|'DAY'|'WEEK'|'MONTH'|'QUARTER'|'YEAR',
'RelativeDateFilterFunction': 'PREVIOUS'|'THIS'|'LAST'|'NEXT'|'NOW',
'Constant': {
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'SingularConstant': 'string'
}
}
},
],
'Columns': [
{
'ColumnName': 'string',
'ColumnFriendlyName': 'string',
'ColumnDescription': 'string',
'ColumnSynonyms': [
'string',
],
'ColumnDataRole': 'DIMENSION'|'MEASURE',
'Aggregation': 'SUM'|'MAX'|'MIN'|'COUNT'|'DISTINCT_COUNT'|'AVERAGE'|'MEDIAN'|'STDEV'|'STDEVP'|'VAR'|'VARP',
'IsIncludedInTopic': True|False,
'DisableIndexing': True|False,
'ComparativeOrder': {
'UseOrdering': 'GREATER_IS_BETTER'|'LESSER_IS_BETTER'|'SPECIFIED',
'SpecifedOrder': [
'string',
],
'TreatUndefinedSpecifiedValues': 'LEAST'|'MOST'
},
'SemanticType': {
'TypeName': 'string',
'SubTypeName': 'string',
'TypeParameters': {
'string': 'string'
},
'TruthyCellValue': 'string',
'TruthyCellValueSynonyms': [
'string',
],
'FalseyCellValue': 'string',
'FalseyCellValueSynonyms': [
'string',
]
},
'TimeGranularity': 'SECOND'|'MINUTE'|'HOUR'|'DAY'|'WEEK'|'MONTH'|'QUARTER'|'YEAR',
'AllowedAggregations': [
'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX'|'MEDIAN'|'SUM'|'AVERAGE'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE',
],
'NotAllowedAggregations': [
'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX'|'MEDIAN'|'SUM'|'AVERAGE'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE',
],
'DefaultFormatting': {
'DisplayFormat': 'AUTO'|'PERCENT'|'CURRENCY'|'NUMBER'|'DATE'|'STRING',
'DisplayFormatOptions': {
'UseBlankCellFormat': True|False,
'BlankCellFormat': 'string',
'DateFormat': 'string',
'DecimalSeparator': 'COMMA'|'DOT',
'GroupingSeparator': 'string',
'UseGrouping': True|False,
'FractionDigits': 123,
'Prefix': 'string',
'Suffix': 'string',
'UnitScaler': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeFormat': {
'Prefix': 'string',
'Suffix': 'string'
},
'CurrencySymbol': 'string'
}
},
'NeverAggregateInFilter': True|False,
'CellValueSynonyms': [
{
'CellValue': 'string',
'Synonyms': [
'string',
]
},
],
'NonAdditive': True|False
},
],
'CalculatedFields': [
{
'CalculatedFieldName': 'string',
'CalculatedFieldDescription': 'string',
'Expression': 'string',
'CalculatedFieldSynonyms': [
'string',
],
'IsIncludedInTopic': True|False,
'DisableIndexing': True|False,
'ColumnDataRole': 'DIMENSION'|'MEASURE',
'TimeGranularity': 'SECOND'|'MINUTE'|'HOUR'|'DAY'|'WEEK'|'MONTH'|'QUARTER'|'YEAR',
'DefaultFormatting': {
'DisplayFormat': 'AUTO'|'PERCENT'|'CURRENCY'|'NUMBER'|'DATE'|'STRING',
'DisplayFormatOptions': {
'UseBlankCellFormat': True|False,
'BlankCellFormat': 'string',
'DateFormat': 'string',
'DecimalSeparator': 'COMMA'|'DOT',
'GroupingSeparator': 'string',
'UseGrouping': True|False,
'FractionDigits': 123,
'Prefix': 'string',
'Suffix': 'string',
'UnitScaler': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeFormat': {
'Prefix': 'string',
'Suffix': 'string'
},
'CurrencySymbol': 'string'
}
},
'Aggregation': 'SUM'|'MAX'|'MIN'|'COUNT'|'DISTINCT_COUNT'|'AVERAGE'|'MEDIAN'|'STDEV'|'STDEVP'|'VAR'|'VARP',
'ComparativeOrder': {
'UseOrdering': 'GREATER_IS_BETTER'|'LESSER_IS_BETTER'|'SPECIFIED',
'SpecifedOrder': [
'string',
],
'TreatUndefinedSpecifiedValues': 'LEAST'|'MOST'
},
'SemanticType': {
'TypeName': 'string',
'SubTypeName': 'string',
'TypeParameters': {
'string': 'string'
},
'TruthyCellValue': 'string',
'TruthyCellValueSynonyms': [
'string',
],
'FalseyCellValue': 'string',
'FalseyCellValueSynonyms': [
'string',
]
},
'AllowedAggregations': [
'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX'|'MEDIAN'|'SUM'|'AVERAGE'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE',
],
'NotAllowedAggregations': [
'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX'|'MEDIAN'|'SUM'|'AVERAGE'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE',
],
'NeverAggregateInFilter': True|False,
'CellValueSynonyms': [
{
'CellValue': 'string',
'Synonyms': [
'string',
]
},
],
'NonAdditive': True|False
},
],
'NamedEntities': [
{
'EntityName': 'string',
'EntityDescription': 'string',
'EntitySynonyms': [
'string',
],
'SemanticEntityType': {
'TypeName': 'string',
'SubTypeName': 'string',
'TypeParameters': {
'string': 'string'
}
},
'Definition': [
{
'FieldName': 'string',
'PropertyName': 'string',
'PropertyRole': 'PRIMARY'|'ID',
'PropertyUsage': 'INHERIT'|'DIMENSION'|'MEASURE',
'Metric': {
'Aggregation': 'SUM'|'MIN'|'MAX'|'COUNT'|'AVERAGE'|'DISTINCT_COUNT'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE'|'MEDIAN'|'CUSTOM',
'AggregationFunctionParameters': {
'string': 'string'
}
}
},
]
},
]
},
],
'ConfigOptions': {
'QBusinessInsightsEnabled': True|False
}
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The ID of the Amazon Web Services account that you want to create a topic in.
string
[REQUIRED]
The ID for the topic that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
dict
[REQUIRED]
The definition of a topic to create.
Name (string) --
The name of the topic.
Description (string) --
The description of the topic.
UserExperienceVersion (string) --
The user experience version of a topic.
DataSets (list) --
The data sets that the topic is associated with.
(dict) --
A structure that represents a dataset.
DatasetArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the dataset.
DatasetName (string) --
The name of the dataset.
DatasetDescription (string) --
The description of the dataset.
DataAggregation (dict) --
The definition of a data aggregation.
DatasetRowDateGranularity (string) --
The level of time precision that is used to aggregate DateTime values.
DefaultDateColumnName (string) --
The column name for the default date.
Filters (list) --
The list of filter definitions.
(dict) --
A structure that represents a filter used to select items for a topic.
FilterDescription (string) --
A description of the filter used to select items for a topic.
FilterClass (string) --
The class of the filter. Valid values for this structure are ENFORCED_VALUE_FILTER , CONDITIONAL_VALUE_FILTER , and NAMED_VALUE_FILTER .
FilterName (string) -- [REQUIRED]
The name of the filter.
FilterSynonyms (list) --
The other names or aliases for the filter.
(string) --
OperandFieldName (string) -- [REQUIRED]
The name of the field that the filter operates on.
FilterType (string) --
The type of the filter. Valid values for this structure are CATEGORY_FILTER , NUMERIC_EQUALITY_FILTER , NUMERIC_RANGE_FILTER , DATE_RANGE_FILTER , and RELATIVE_DATE_FILTER .
CategoryFilter (dict) --
The category filter that is associated with this filter.
CategoryFilterFunction (string) --
The category filter function. Valid values for this structure are EXACT and CONTAINS .
CategoryFilterType (string) --
The category filter type. This element is used to specify whether a filter is a simple category filter or an inverse category filter.
Constant (dict) --
The constant used in a category filter.
ConstantType (string) --
The type of category filter constant. This element is used to specify whether a constant is a singular or collective. Valid values are SINGULAR and COLLECTIVE .
SingularConstant (string) --
A singular constant used in a category filter. This element is used to specify a single value for the constant.
CollectiveConstant (dict) --
A collective constant used in a category filter. This element is used to specify a list of values for the constant.
ValueList (list) --
A list of values for the collective constant.
(string) --
Inverse (boolean) --
A Boolean value that indicates if the filter is inverse.
NumericEqualityFilter (dict) --
The numeric equality filter.
Constant (dict) --
The constant used in a numeric equality filter.
ConstantType (string) --
The type of the singular filter constant. Valid values for this structure are SINGULAR .
SingularConstant (string) --
The value of the singular filter constant.
Aggregation (string) --
An aggregation function that specifies how to calculate the value of a numeric field for a topic. Valid values for this structure are NO_AGGREGATION , SUM , AVERAGE , COUNT , DISTINCT_COUNT , MAX , MEDIAN , MIN , STDEV , STDEVP , VAR , and VARP .
NumericRangeFilter (dict) --
The numeric range filter.
Inclusive (boolean) --
A Boolean value that indicates whether the endpoints of the numeric range are included in the filter. If set to true, topics whose numeric field value is equal to the endpoint values will be included in the filter. If set to false, topics whose numeric field value is equal to the endpoint values will be excluded from the filter.
Constant (dict) --
The constant used in a numeric range filter.
ConstantType (string) --
The data type of the constant value that is used in a range filter. Valid values for this structure are RANGE .
RangeConstant (dict) --
The value of the constant that is used to specify the endpoints of a range filter.
Minimum (string) --
The minimum value for a range constant.
Maximum (string) --
The maximum value for a range constant.
Aggregation (string) --
An aggregation function that specifies how to calculate the value of a numeric field for a topic, Valid values for this structure are NO_AGGREGATION , SUM , AVERAGE , COUNT , DISTINCT_COUNT , MAX , MEDIAN , MIN , STDEV , STDEVP , VAR , and VARP .
DateRangeFilter (dict) --
The date range filter.
Inclusive (boolean) --
A Boolean value that indicates whether the date range filter should include the boundary values. If set to true, the filter includes the start and end dates. If set to false, the filter excludes them.
Constant (dict) --
The constant used in a date range filter.
ConstantType (string) --
The data type of the constant value that is used in a range filter. Valid values for this structure are RANGE .
RangeConstant (dict) --
The value of the constant that is used to specify the endpoints of a range filter.
Minimum (string) --
The minimum value for a range constant.
Maximum (string) --
The maximum value for a range constant.
RelativeDateFilter (dict) --
The relative date filter.
TimeGranularity (string) --
The level of time precision that is used to aggregate DateTime values.
RelativeDateFilterFunction (string) --
The function to be used in a relative date filter to determine the range of dates to include in the results. Valid values for this structure are BEFORE , AFTER , and BETWEEN .
Constant (dict) --
The constant used in a relative date filter.
ConstantType (string) --
The type of the singular filter constant. Valid values for this structure are SINGULAR .
SingularConstant (string) --
The value of the singular filter constant.
Columns (list) --
The list of column definitions.
(dict) --
Represents a column in a dataset.
ColumnName (string) -- [REQUIRED]
The name of the column.
ColumnFriendlyName (string) --
A user-friendly name for the column.
ColumnDescription (string) --
A description of the column and its contents.
ColumnSynonyms (list) --
The other names or aliases for the column.
(string) --
ColumnDataRole (string) --
The role of the column in the data. Valid values are DIMENSION and MEASURE .
Aggregation (string) --
The type of aggregation that is performed on the column data when it's queried.
IsIncludedInTopic (boolean) --
A Boolean value that indicates whether the column is included in the query results.
DisableIndexing (boolean) --
A Boolean value that indicates whether the column shows in the autocomplete functionality.
ComparativeOrder (dict) --
The order in which data is displayed for the column when it's used in a comparative context.
UseOrdering (string) --
The ordering type for a column. Valid values for this structure are GREATER_IS_BETTER , LESSER_IS_BETTER and SPECIFIED .
SpecifedOrder (list) --
The list of columns to be used in the ordering.
(string) --
TreatUndefinedSpecifiedValues (string) --
The treat of undefined specified values. Valid values for this structure are LEAST and MOST .
SemanticType (dict) --
The semantic type of data contained in the column.
TypeName (string) --
The semantic type name.
SubTypeName (string) --
The semantic type sub type name.
TypeParameters (dict) --
The semantic type parameters.
(string) --
(string) --
TruthyCellValue (string) --
The semantic type truthy cell value.
TruthyCellValueSynonyms (list) --
The other names or aliases for the true cell value.
(string) --
FalseyCellValue (string) --
The semantic type falsey cell value.
FalseyCellValueSynonyms (list) --
The other names or aliases for the false cell value.
(string) --
TimeGranularity (string) --
The level of time precision that is used to aggregate DateTime values.
AllowedAggregations (list) --
The list of aggregation types that are allowed for the column. Valid values for this structure are COUNT , DISTINCT_COUNT , MIN , MAX , MEDIAN , SUM , AVERAGE , STDEV , STDEVP , VAR , VARP , and PERCENTILE .
(string) --
NotAllowedAggregations (list) --
The list of aggregation types that are not allowed for the column. Valid values for this structure are COUNT , DISTINCT_COUNT , MIN , MAX , MEDIAN , SUM , AVERAGE , STDEV , STDEVP , VAR , VARP , and PERCENTILE .
(string) --
DefaultFormatting (dict) --
The default formatting used for values in the column.
DisplayFormat (string) --
The display format. Valid values for this structure are AUTO , PERCENT , CURRENCY , NUMBER , DATE , and STRING .
DisplayFormatOptions (dict) --
The additional options for display formatting.
UseBlankCellFormat (boolean) --
A Boolean value that indicates whether to use blank cell format.
BlankCellFormat (string) --
Determines the blank cell format.
DateFormat (string) --
Determines the DateTime format.
DecimalSeparator (string) --
Determines the decimal separator.
GroupingSeparator (string) --
Determines the grouping separator.
UseGrouping (boolean) --
A Boolean value that indicates whether to use grouping.
FractionDigits (integer) --
Determines the number of fraction digits.
Prefix (string) --
The prefix value for a display format.
Suffix (string) --
The suffix value for a display format.
UnitScaler (string) --
The unit scaler. Valid values for this structure are: NONE , AUTO , THOUSANDS , MILLIONS , BILLIONS , and TRILLIONS .
NegativeFormat (dict) --
The negative format.
Prefix (string) --
The prefix for a negative format.
Suffix (string) --
The suffix for a negative format.
CurrencySymbol (string) --
The currency symbol, such as USD .
NeverAggregateInFilter (boolean) --
A Boolean value that indicates whether to aggregate the column data when it's used in a filter context.
CellValueSynonyms (list) --
The other names or aliases for the column cell value.
(dict) --
A structure that represents the cell value synonym.
CellValue (string) --
The cell value.
Synonyms (list) --
Other names or aliases for the cell value.
(string) --
NonAdditive (boolean) --
The non additive value for the column.
CalculatedFields (list) --
The list of calculated field definitions.
(dict) --
A structure that represents a calculated field.
CalculatedFieldName (string) -- [REQUIRED]
The calculated field name.
CalculatedFieldDescription (string) --
The calculated field description.
Expression (string) -- [REQUIRED]
The calculated field expression.
CalculatedFieldSynonyms (list) --
The other names or aliases for the calculated field.
(string) --
IsIncludedInTopic (boolean) --
A boolean value that indicates if a calculated field is included in the topic.
DisableIndexing (boolean) --
A Boolean value that indicates if a calculated field is visible in the autocomplete.
ColumnDataRole (string) --
The column data role for a calculated field. Valid values for this structure are DIMENSION and MEASURE .
TimeGranularity (string) --
The level of time precision that is used to aggregate DateTime values.
DefaultFormatting (dict) --
The default formatting definition.
DisplayFormat (string) --
The display format. Valid values for this structure are AUTO , PERCENT , CURRENCY , NUMBER , DATE , and STRING .
DisplayFormatOptions (dict) --
The additional options for display formatting.
UseBlankCellFormat (boolean) --
A Boolean value that indicates whether to use blank cell format.
BlankCellFormat (string) --
Determines the blank cell format.
DateFormat (string) --
Determines the DateTime format.
DecimalSeparator (string) --
Determines the decimal separator.
GroupingSeparator (string) --
Determines the grouping separator.
UseGrouping (boolean) --
A Boolean value that indicates whether to use grouping.
FractionDigits (integer) --
Determines the number of fraction digits.
Prefix (string) --
The prefix value for a display format.
Suffix (string) --
The suffix value for a display format.
UnitScaler (string) --
The unit scaler. Valid values for this structure are: NONE , AUTO , THOUSANDS , MILLIONS , BILLIONS , and TRILLIONS .
NegativeFormat (dict) --
The negative format.
Prefix (string) --
The prefix for a negative format.
Suffix (string) --
The suffix for a negative format.
CurrencySymbol (string) --
The currency symbol, such as USD .
Aggregation (string) --
The default aggregation. Valid values for this structure are SUM , MAX , MIN , COUNT , DISTINCT_COUNT , and AVERAGE .
ComparativeOrder (dict) --
The order in which data is displayed for the calculated field when it's used in a comparative context.
UseOrdering (string) --
The ordering type for a column. Valid values for this structure are GREATER_IS_BETTER , LESSER_IS_BETTER and SPECIFIED .
SpecifedOrder (list) --
The list of columns to be used in the ordering.
(string) --
TreatUndefinedSpecifiedValues (string) --
The treat of undefined specified values. Valid values for this structure are LEAST and MOST .
SemanticType (dict) --
The semantic type.
TypeName (string) --
The semantic type name.
SubTypeName (string) --
The semantic type sub type name.
TypeParameters (dict) --
The semantic type parameters.
(string) --
(string) --
TruthyCellValue (string) --
The semantic type truthy cell value.
TruthyCellValueSynonyms (list) --
The other names or aliases for the true cell value.
(string) --
FalseyCellValue (string) --
The semantic type falsey cell value.
FalseyCellValueSynonyms (list) --
The other names or aliases for the false cell value.
(string) --
AllowedAggregations (list) --
The list of aggregation types that are allowed for the calculated field. Valid values for this structure are COUNT , DISTINCT_COUNT , MIN , MAX , MEDIAN , SUM , AVERAGE , STDEV , STDEVP , VAR , VARP , and PERCENTILE .
(string) --
NotAllowedAggregations (list) --
The list of aggregation types that are not allowed for the calculated field. Valid values for this structure are COUNT , DISTINCT_COUNT , MIN , MAX , MEDIAN , SUM , AVERAGE , STDEV , STDEVP , VAR , VARP , and PERCENTILE .
(string) --
NeverAggregateInFilter (boolean) --
A Boolean value that indicates whether to never aggregate calculated field in filters.
CellValueSynonyms (list) --
The other names or aliases for the calculated field cell value.
(dict) --
A structure that represents the cell value synonym.
CellValue (string) --
The cell value.
Synonyms (list) --
Other names or aliases for the cell value.
(string) --
NonAdditive (boolean) --
The non additive for the table style target.
NamedEntities (list) --
The list of named entities definitions.
(dict) --
A structure that represents a named entity.
EntityName (string) -- [REQUIRED]
The name of the named entity.
EntityDescription (string) --
The description of the named entity.
EntitySynonyms (list) --
The other names or aliases for the named entity.
(string) --
SemanticEntityType (dict) --
The type of named entity that a topic represents.
TypeName (string) --
The semantic entity type name.
SubTypeName (string) --
The semantic entity sub type name.
TypeParameters (dict) --
The semantic entity type parameters.
(string) --
(string) --
Definition (list) --
The definition of a named entity.
(dict) --
A structure that represents a named entity.
FieldName (string) --
The name of the entity.
PropertyName (string) --
The property name to be used for the named entity.
PropertyRole (string) --
The property role. Valid values for this structure are PRIMARY and ID .
PropertyUsage (string) --
The property usage. Valid values for this structure are INHERIT , DIMENSION , and MEASURE .
Metric (dict) --
The definition of a metric.
Aggregation (string) --
The aggregation of a named entity. Valid values for this structure are SUM , MIN , MAX , COUNT , AVERAGE , DISTINCT_COUNT , STDEV , STDEVP , VAR , VARP , PERCENTILE , MEDIAN , and CUSTOM .
AggregationFunctionParameters (dict) --
The additional parameters for an aggregation function.
(string) --
(string) --
ConfigOptions (dict) --
Configuration options for a Topic .
QBusinessInsightsEnabled (boolean) --
Enables Amazon Q Business Insights for a Topic .
list
Contains a map of the key-value pairs for the resource tag or tags that are assigned to the dataset.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) -- [REQUIRED]
Tag key.
Value (string) -- [REQUIRED]
Tag value.
dict
Response Syntax
{
'Arn': 'string',
'TopicId': 'string',
'RefreshArn': 'string',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) of the topic.
TopicId (string) --
The ID for the topic that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
RefreshArn (string) --
The Amazon Resource Name (ARN) of the topic refresh.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'CloudFormationOverridePropertyConfiguration': {'Folders': [{'Arn': 'string',
'Properties': ['Name '
'| '
'ParentFolderArn']}]},
'IncludeFolderMembers': 'RECURSE | ONE_LEVEL | NONE',
'IncludeFolderMemberships': 'boolean'}
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',
]
},
],
'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': {'Folders': [{'FolderId': 'string',
'Name': 'string',
'ParentFolderArn': 'string'}]},
'OverridePermissions': {'Folders': [{'FolderIds': ['string'],
'Permissions': {'Actions': ['string'],
'Principals': ['string']}}]},
'OverrideTags': {'Folders': [{'FolderIds': ['string'],
'Tags': [{'Key': 'string',
'Value': 'string'}]}]}}
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'
},
'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'
},
'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'
},
'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'
},
],
'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.
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.
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.
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.
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.
{'Topic': {'ConfigOptions': {'QBusinessInsightsEnabled': 'boolean'}}}
Describes a topic.
See also: AWS API Documentation
Request Syntax
client.describe_topic(
AwsAccountId='string',
TopicId='string'
)
string
[REQUIRED]
The Amazon Web Services account ID.
string
[REQUIRED]
The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
dict
Response Syntax
{
'Arn': 'string',
'TopicId': 'string',
'Topic': {
'Name': 'string',
'Description': 'string',
'UserExperienceVersion': 'LEGACY'|'NEW_READER_EXPERIENCE',
'DataSets': [
{
'DatasetArn': 'string',
'DatasetName': 'string',
'DatasetDescription': 'string',
'DataAggregation': {
'DatasetRowDateGranularity': 'SECOND'|'MINUTE'|'HOUR'|'DAY'|'WEEK'|'MONTH'|'QUARTER'|'YEAR',
'DefaultDateColumnName': 'string'
},
'Filters': [
{
'FilterDescription': 'string',
'FilterClass': 'ENFORCED_VALUE_FILTER'|'CONDITIONAL_VALUE_FILTER'|'NAMED_VALUE_FILTER',
'FilterName': 'string',
'FilterSynonyms': [
'string',
],
'OperandFieldName': 'string',
'FilterType': 'CATEGORY_FILTER'|'NUMERIC_EQUALITY_FILTER'|'NUMERIC_RANGE_FILTER'|'DATE_RANGE_FILTER'|'RELATIVE_DATE_FILTER',
'CategoryFilter': {
'CategoryFilterFunction': 'EXACT'|'CONTAINS',
'CategoryFilterType': 'CUSTOM_FILTER'|'CUSTOM_FILTER_LIST'|'FILTER_LIST',
'Constant': {
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'SingularConstant': 'string',
'CollectiveConstant': {
'ValueList': [
'string',
]
}
},
'Inverse': True|False
},
'NumericEqualityFilter': {
'Constant': {
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'SingularConstant': 'string'
},
'Aggregation': 'NO_AGGREGATION'|'SUM'|'AVERAGE'|'COUNT'|'DISTINCT_COUNT'|'MAX'|'MEDIAN'|'MIN'|'STDEV'|'STDEVP'|'VAR'|'VARP'
},
'NumericRangeFilter': {
'Inclusive': True|False,
'Constant': {
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'RangeConstant': {
'Minimum': 'string',
'Maximum': 'string'
}
},
'Aggregation': 'NO_AGGREGATION'|'SUM'|'AVERAGE'|'COUNT'|'DISTINCT_COUNT'|'MAX'|'MEDIAN'|'MIN'|'STDEV'|'STDEVP'|'VAR'|'VARP'
},
'DateRangeFilter': {
'Inclusive': True|False,
'Constant': {
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'RangeConstant': {
'Minimum': 'string',
'Maximum': 'string'
}
}
},
'RelativeDateFilter': {
'TimeGranularity': 'SECOND'|'MINUTE'|'HOUR'|'DAY'|'WEEK'|'MONTH'|'QUARTER'|'YEAR',
'RelativeDateFilterFunction': 'PREVIOUS'|'THIS'|'LAST'|'NEXT'|'NOW',
'Constant': {
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'SingularConstant': 'string'
}
}
},
],
'Columns': [
{
'ColumnName': 'string',
'ColumnFriendlyName': 'string',
'ColumnDescription': 'string',
'ColumnSynonyms': [
'string',
],
'ColumnDataRole': 'DIMENSION'|'MEASURE',
'Aggregation': 'SUM'|'MAX'|'MIN'|'COUNT'|'DISTINCT_COUNT'|'AVERAGE'|'MEDIAN'|'STDEV'|'STDEVP'|'VAR'|'VARP',
'IsIncludedInTopic': True|False,
'DisableIndexing': True|False,
'ComparativeOrder': {
'UseOrdering': 'GREATER_IS_BETTER'|'LESSER_IS_BETTER'|'SPECIFIED',
'SpecifedOrder': [
'string',
],
'TreatUndefinedSpecifiedValues': 'LEAST'|'MOST'
},
'SemanticType': {
'TypeName': 'string',
'SubTypeName': 'string',
'TypeParameters': {
'string': 'string'
},
'TruthyCellValue': 'string',
'TruthyCellValueSynonyms': [
'string',
],
'FalseyCellValue': 'string',
'FalseyCellValueSynonyms': [
'string',
]
},
'TimeGranularity': 'SECOND'|'MINUTE'|'HOUR'|'DAY'|'WEEK'|'MONTH'|'QUARTER'|'YEAR',
'AllowedAggregations': [
'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX'|'MEDIAN'|'SUM'|'AVERAGE'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE',
],
'NotAllowedAggregations': [
'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX'|'MEDIAN'|'SUM'|'AVERAGE'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE',
],
'DefaultFormatting': {
'DisplayFormat': 'AUTO'|'PERCENT'|'CURRENCY'|'NUMBER'|'DATE'|'STRING',
'DisplayFormatOptions': {
'UseBlankCellFormat': True|False,
'BlankCellFormat': 'string',
'DateFormat': 'string',
'DecimalSeparator': 'COMMA'|'DOT',
'GroupingSeparator': 'string',
'UseGrouping': True|False,
'FractionDigits': 123,
'Prefix': 'string',
'Suffix': 'string',
'UnitScaler': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeFormat': {
'Prefix': 'string',
'Suffix': 'string'
},
'CurrencySymbol': 'string'
}
},
'NeverAggregateInFilter': True|False,
'CellValueSynonyms': [
{
'CellValue': 'string',
'Synonyms': [
'string',
]
},
],
'NonAdditive': True|False
},
],
'CalculatedFields': [
{
'CalculatedFieldName': 'string',
'CalculatedFieldDescription': 'string',
'Expression': 'string',
'CalculatedFieldSynonyms': [
'string',
],
'IsIncludedInTopic': True|False,
'DisableIndexing': True|False,
'ColumnDataRole': 'DIMENSION'|'MEASURE',
'TimeGranularity': 'SECOND'|'MINUTE'|'HOUR'|'DAY'|'WEEK'|'MONTH'|'QUARTER'|'YEAR',
'DefaultFormatting': {
'DisplayFormat': 'AUTO'|'PERCENT'|'CURRENCY'|'NUMBER'|'DATE'|'STRING',
'DisplayFormatOptions': {
'UseBlankCellFormat': True|False,
'BlankCellFormat': 'string',
'DateFormat': 'string',
'DecimalSeparator': 'COMMA'|'DOT',
'GroupingSeparator': 'string',
'UseGrouping': True|False,
'FractionDigits': 123,
'Prefix': 'string',
'Suffix': 'string',
'UnitScaler': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeFormat': {
'Prefix': 'string',
'Suffix': 'string'
},
'CurrencySymbol': 'string'
}
},
'Aggregation': 'SUM'|'MAX'|'MIN'|'COUNT'|'DISTINCT_COUNT'|'AVERAGE'|'MEDIAN'|'STDEV'|'STDEVP'|'VAR'|'VARP',
'ComparativeOrder': {
'UseOrdering': 'GREATER_IS_BETTER'|'LESSER_IS_BETTER'|'SPECIFIED',
'SpecifedOrder': [
'string',
],
'TreatUndefinedSpecifiedValues': 'LEAST'|'MOST'
},
'SemanticType': {
'TypeName': 'string',
'SubTypeName': 'string',
'TypeParameters': {
'string': 'string'
},
'TruthyCellValue': 'string',
'TruthyCellValueSynonyms': [
'string',
],
'FalseyCellValue': 'string',
'FalseyCellValueSynonyms': [
'string',
]
},
'AllowedAggregations': [
'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX'|'MEDIAN'|'SUM'|'AVERAGE'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE',
],
'NotAllowedAggregations': [
'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX'|'MEDIAN'|'SUM'|'AVERAGE'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE',
],
'NeverAggregateInFilter': True|False,
'CellValueSynonyms': [
{
'CellValue': 'string',
'Synonyms': [
'string',
]
},
],
'NonAdditive': True|False
},
],
'NamedEntities': [
{
'EntityName': 'string',
'EntityDescription': 'string',
'EntitySynonyms': [
'string',
],
'SemanticEntityType': {
'TypeName': 'string',
'SubTypeName': 'string',
'TypeParameters': {
'string': 'string'
}
},
'Definition': [
{
'FieldName': 'string',
'PropertyName': 'string',
'PropertyRole': 'PRIMARY'|'ID',
'PropertyUsage': 'INHERIT'|'DIMENSION'|'MEASURE',
'Metric': {
'Aggregation': 'SUM'|'MIN'|'MAX'|'COUNT'|'AVERAGE'|'DISTINCT_COUNT'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE'|'MEDIAN'|'CUSTOM',
'AggregationFunctionParameters': {
'string': 'string'
}
}
},
]
},
]
},
],
'ConfigOptions': {
'QBusinessInsightsEnabled': True|False
}
},
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) of the topic.
TopicId (string) --
The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
Topic (dict) --
The definition of a topic.
Name (string) --
The name of the topic.
Description (string) --
The description of the topic.
UserExperienceVersion (string) --
The user experience version of a topic.
DataSets (list) --
The data sets that the topic is associated with.
(dict) --
A structure that represents a dataset.
DatasetArn (string) --
The Amazon Resource Name (ARN) of the dataset.
DatasetName (string) --
The name of the dataset.
DatasetDescription (string) --
The description of the dataset.
DataAggregation (dict) --
The definition of a data aggregation.
DatasetRowDateGranularity (string) --
The level of time precision that is used to aggregate DateTime values.
DefaultDateColumnName (string) --
The column name for the default date.
Filters (list) --
The list of filter definitions.
(dict) --
A structure that represents a filter used to select items for a topic.
FilterDescription (string) --
A description of the filter used to select items for a topic.
FilterClass (string) --
The class of the filter. Valid values for this structure are ENFORCED_VALUE_FILTER , CONDITIONAL_VALUE_FILTER , and NAMED_VALUE_FILTER .
FilterName (string) --
The name of the filter.
FilterSynonyms (list) --
The other names or aliases for the filter.
(string) --
OperandFieldName (string) --
The name of the field that the filter operates on.
FilterType (string) --
The type of the filter. Valid values for this structure are CATEGORY_FILTER , NUMERIC_EQUALITY_FILTER , NUMERIC_RANGE_FILTER , DATE_RANGE_FILTER , and RELATIVE_DATE_FILTER .
CategoryFilter (dict) --
The category filter that is associated with this filter.
CategoryFilterFunction (string) --
The category filter function. Valid values for this structure are EXACT and CONTAINS .
CategoryFilterType (string) --
The category filter type. This element is used to specify whether a filter is a simple category filter or an inverse category filter.
Constant (dict) --
The constant used in a category filter.
ConstantType (string) --
The type of category filter constant. This element is used to specify whether a constant is a singular or collective. Valid values are SINGULAR and COLLECTIVE .
SingularConstant (string) --
A singular constant used in a category filter. This element is used to specify a single value for the constant.
CollectiveConstant (dict) --
A collective constant used in a category filter. This element is used to specify a list of values for the constant.
ValueList (list) --
A list of values for the collective constant.
(string) --
Inverse (boolean) --
A Boolean value that indicates if the filter is inverse.
NumericEqualityFilter (dict) --
The numeric equality filter.
Constant (dict) --
The constant used in a numeric equality filter.
ConstantType (string) --
The type of the singular filter constant. Valid values for this structure are SINGULAR .
SingularConstant (string) --
The value of the singular filter constant.
Aggregation (string) --
An aggregation function that specifies how to calculate the value of a numeric field for a topic. Valid values for this structure are NO_AGGREGATION , SUM , AVERAGE , COUNT , DISTINCT_COUNT , MAX , MEDIAN , MIN , STDEV , STDEVP , VAR , and VARP .
NumericRangeFilter (dict) --
The numeric range filter.
Inclusive (boolean) --
A Boolean value that indicates whether the endpoints of the numeric range are included in the filter. If set to true, topics whose numeric field value is equal to the endpoint values will be included in the filter. If set to false, topics whose numeric field value is equal to the endpoint values will be excluded from the filter.
Constant (dict) --
The constant used in a numeric range filter.
ConstantType (string) --
The data type of the constant value that is used in a range filter. Valid values for this structure are RANGE .
RangeConstant (dict) --
The value of the constant that is used to specify the endpoints of a range filter.
Minimum (string) --
The minimum value for a range constant.
Maximum (string) --
The maximum value for a range constant.
Aggregation (string) --
An aggregation function that specifies how to calculate the value of a numeric field for a topic, Valid values for this structure are NO_AGGREGATION , SUM , AVERAGE , COUNT , DISTINCT_COUNT , MAX , MEDIAN , MIN , STDEV , STDEVP , VAR , and VARP .
DateRangeFilter (dict) --
The date range filter.
Inclusive (boolean) --
A Boolean value that indicates whether the date range filter should include the boundary values. If set to true, the filter includes the start and end dates. If set to false, the filter excludes them.
Constant (dict) --
The constant used in a date range filter.
ConstantType (string) --
The data type of the constant value that is used in a range filter. Valid values for this structure are RANGE .
RangeConstant (dict) --
The value of the constant that is used to specify the endpoints of a range filter.
Minimum (string) --
The minimum value for a range constant.
Maximum (string) --
The maximum value for a range constant.
RelativeDateFilter (dict) --
The relative date filter.
TimeGranularity (string) --
The level of time precision that is used to aggregate DateTime values.
RelativeDateFilterFunction (string) --
The function to be used in a relative date filter to determine the range of dates to include in the results. Valid values for this structure are BEFORE , AFTER , and BETWEEN .
Constant (dict) --
The constant used in a relative date filter.
ConstantType (string) --
The type of the singular filter constant. Valid values for this structure are SINGULAR .
SingularConstant (string) --
The value of the singular filter constant.
Columns (list) --
The list of column definitions.
(dict) --
Represents a column in a dataset.
ColumnName (string) --
The name of the column.
ColumnFriendlyName (string) --
A user-friendly name for the column.
ColumnDescription (string) --
A description of the column and its contents.
ColumnSynonyms (list) --
The other names or aliases for the column.
(string) --
ColumnDataRole (string) --
The role of the column in the data. Valid values are DIMENSION and MEASURE .
Aggregation (string) --
The type of aggregation that is performed on the column data when it's queried.
IsIncludedInTopic (boolean) --
A Boolean value that indicates whether the column is included in the query results.
DisableIndexing (boolean) --
A Boolean value that indicates whether the column shows in the autocomplete functionality.
ComparativeOrder (dict) --
The order in which data is displayed for the column when it's used in a comparative context.
UseOrdering (string) --
The ordering type for a column. Valid values for this structure are GREATER_IS_BETTER , LESSER_IS_BETTER and SPECIFIED .
SpecifedOrder (list) --
The list of columns to be used in the ordering.
(string) --
TreatUndefinedSpecifiedValues (string) --
The treat of undefined specified values. Valid values for this structure are LEAST and MOST .
SemanticType (dict) --
The semantic type of data contained in the column.
TypeName (string) --
The semantic type name.
SubTypeName (string) --
The semantic type sub type name.
TypeParameters (dict) --
The semantic type parameters.
(string) --
(string) --
TruthyCellValue (string) --
The semantic type truthy cell value.
TruthyCellValueSynonyms (list) --
The other names or aliases for the true cell value.
(string) --
FalseyCellValue (string) --
The semantic type falsey cell value.
FalseyCellValueSynonyms (list) --
The other names or aliases for the false cell value.
(string) --
TimeGranularity (string) --
The level of time precision that is used to aggregate DateTime values.
AllowedAggregations (list) --
The list of aggregation types that are allowed for the column. Valid values for this structure are COUNT , DISTINCT_COUNT , MIN , MAX , MEDIAN , SUM , AVERAGE , STDEV , STDEVP , VAR , VARP , and PERCENTILE .
(string) --
NotAllowedAggregations (list) --
The list of aggregation types that are not allowed for the column. Valid values for this structure are COUNT , DISTINCT_COUNT , MIN , MAX , MEDIAN , SUM , AVERAGE , STDEV , STDEVP , VAR , VARP , and PERCENTILE .
(string) --
DefaultFormatting (dict) --
The default formatting used for values in the column.
DisplayFormat (string) --
The display format. Valid values for this structure are AUTO , PERCENT , CURRENCY , NUMBER , DATE , and STRING .
DisplayFormatOptions (dict) --
The additional options for display formatting.
UseBlankCellFormat (boolean) --
A Boolean value that indicates whether to use blank cell format.
BlankCellFormat (string) --
Determines the blank cell format.
DateFormat (string) --
Determines the DateTime format.
DecimalSeparator (string) --
Determines the decimal separator.
GroupingSeparator (string) --
Determines the grouping separator.
UseGrouping (boolean) --
A Boolean value that indicates whether to use grouping.
FractionDigits (integer) --
Determines the number of fraction digits.
Prefix (string) --
The prefix value for a display format.
Suffix (string) --
The suffix value for a display format.
UnitScaler (string) --
The unit scaler. Valid values for this structure are: NONE , AUTO , THOUSANDS , MILLIONS , BILLIONS , and TRILLIONS .
NegativeFormat (dict) --
The negative format.
Prefix (string) --
The prefix for a negative format.
Suffix (string) --
The suffix for a negative format.
CurrencySymbol (string) --
The currency symbol, such as USD .
NeverAggregateInFilter (boolean) --
A Boolean value that indicates whether to aggregate the column data when it's used in a filter context.
CellValueSynonyms (list) --
The other names or aliases for the column cell value.
(dict) --
A structure that represents the cell value synonym.
CellValue (string) --
The cell value.
Synonyms (list) --
Other names or aliases for the cell value.
(string) --
NonAdditive (boolean) --
The non additive value for the column.
CalculatedFields (list) --
The list of calculated field definitions.
(dict) --
A structure that represents a calculated field.
CalculatedFieldName (string) --
The calculated field name.
CalculatedFieldDescription (string) --
The calculated field description.
Expression (string) --
The calculated field expression.
CalculatedFieldSynonyms (list) --
The other names or aliases for the calculated field.
(string) --
IsIncludedInTopic (boolean) --
A boolean value that indicates if a calculated field is included in the topic.
DisableIndexing (boolean) --
A Boolean value that indicates if a calculated field is visible in the autocomplete.
ColumnDataRole (string) --
The column data role for a calculated field. Valid values for this structure are DIMENSION and MEASURE .
TimeGranularity (string) --
The level of time precision that is used to aggregate DateTime values.
DefaultFormatting (dict) --
The default formatting definition.
DisplayFormat (string) --
The display format. Valid values for this structure are AUTO , PERCENT , CURRENCY , NUMBER , DATE , and STRING .
DisplayFormatOptions (dict) --
The additional options for display formatting.
UseBlankCellFormat (boolean) --
A Boolean value that indicates whether to use blank cell format.
BlankCellFormat (string) --
Determines the blank cell format.
DateFormat (string) --
Determines the DateTime format.
DecimalSeparator (string) --
Determines the decimal separator.
GroupingSeparator (string) --
Determines the grouping separator.
UseGrouping (boolean) --
A Boolean value that indicates whether to use grouping.
FractionDigits (integer) --
Determines the number of fraction digits.
Prefix (string) --
The prefix value for a display format.
Suffix (string) --
The suffix value for a display format.
UnitScaler (string) --
The unit scaler. Valid values for this structure are: NONE , AUTO , THOUSANDS , MILLIONS , BILLIONS , and TRILLIONS .
NegativeFormat (dict) --
The negative format.
Prefix (string) --
The prefix for a negative format.
Suffix (string) --
The suffix for a negative format.
CurrencySymbol (string) --
The currency symbol, such as USD .
Aggregation (string) --
The default aggregation. Valid values for this structure are SUM , MAX , MIN , COUNT , DISTINCT_COUNT , and AVERAGE .
ComparativeOrder (dict) --
The order in which data is displayed for the calculated field when it's used in a comparative context.
UseOrdering (string) --
The ordering type for a column. Valid values for this structure are GREATER_IS_BETTER , LESSER_IS_BETTER and SPECIFIED .
SpecifedOrder (list) --
The list of columns to be used in the ordering.
(string) --
TreatUndefinedSpecifiedValues (string) --
The treat of undefined specified values. Valid values for this structure are LEAST and MOST .
SemanticType (dict) --
The semantic type.
TypeName (string) --
The semantic type name.
SubTypeName (string) --
The semantic type sub type name.
TypeParameters (dict) --
The semantic type parameters.
(string) --
(string) --
TruthyCellValue (string) --
The semantic type truthy cell value.
TruthyCellValueSynonyms (list) --
The other names or aliases for the true cell value.
(string) --
FalseyCellValue (string) --
The semantic type falsey cell value.
FalseyCellValueSynonyms (list) --
The other names or aliases for the false cell value.
(string) --
AllowedAggregations (list) --
The list of aggregation types that are allowed for the calculated field. Valid values for this structure are COUNT , DISTINCT_COUNT , MIN , MAX , MEDIAN , SUM , AVERAGE , STDEV , STDEVP , VAR , VARP , and PERCENTILE .
(string) --
NotAllowedAggregations (list) --
The list of aggregation types that are not allowed for the calculated field. Valid values for this structure are COUNT , DISTINCT_COUNT , MIN , MAX , MEDIAN , SUM , AVERAGE , STDEV , STDEVP , VAR , VARP , and PERCENTILE .
(string) --
NeverAggregateInFilter (boolean) --
A Boolean value that indicates whether to never aggregate calculated field in filters.
CellValueSynonyms (list) --
The other names or aliases for the calculated field cell value.
(dict) --
A structure that represents the cell value synonym.
CellValue (string) --
The cell value.
Synonyms (list) --
Other names or aliases for the cell value.
(string) --
NonAdditive (boolean) --
The non additive for the table style target.
NamedEntities (list) --
The list of named entities definitions.
(dict) --
A structure that represents a named entity.
EntityName (string) --
The name of the named entity.
EntityDescription (string) --
The description of the named entity.
EntitySynonyms (list) --
The other names or aliases for the named entity.
(string) --
SemanticEntityType (dict) --
The type of named entity that a topic represents.
TypeName (string) --
The semantic entity type name.
SubTypeName (string) --
The semantic entity sub type name.
TypeParameters (dict) --
The semantic entity type parameters.
(string) --
(string) --
Definition (list) --
The definition of a named entity.
(dict) --
A structure that represents a named entity.
FieldName (string) --
The name of the entity.
PropertyName (string) --
The property name to be used for the named entity.
PropertyRole (string) --
The property role. Valid values for this structure are PRIMARY and ID .
PropertyUsage (string) --
The property usage. Valid values for this structure are INHERIT , DIMENSION , and MEASURE .
Metric (dict) --
The definition of a metric.
Aggregation (string) --
The aggregation of a named entity. Valid values for this structure are SUM , MIN , MAX , COUNT , AVERAGE , DISTINCT_COUNT , STDEV , STDEVP , VAR , VARP , PERCENTILE , MEDIAN , and CUSTOM .
AggregationFunctionParameters (dict) --
The additional parameters for an aggregation function.
(string) --
(string) --
ConfigOptions (dict) --
Configuration options for a Topic .
QBusinessInsightsEnabled (boolean) --
Enables Amazon Q Business Insights for a Topic .
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'CloudFormationOverridePropertyConfiguration': {'Folders': [{'Arn': 'string',
'Properties': ['Name '
'| '
'ParentFolderArn']}]},
'IncludeFolderMembers': 'RECURSE | ONE_LEVEL | NONE',
'IncludeFolderMemberships': 'boolean'}
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',
]
},
],
'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': {'Folders': [{'FolderId': 'string',
'Name': 'string',
'ParentFolderArn': 'string'}]},
'OverridePermissions': {'Folders': [{'FolderIds': ['string'],
'Permissions': {'Actions': ['string'],
'Principals': ['string']}}]},
'OverrideTags': {'Folders': [{'FolderIds': ['string'],
'Tags': [{'Key': 'string',
'Value': 'string'}]}]}}
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'
},
'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'
},
'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'
},
'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'
},
],
'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 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 20 MB.
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.
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.
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.
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.
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.
{'Topic': {'ConfigOptions': {'QBusinessInsightsEnabled': 'boolean'}}}
Updates a topic.
See also: AWS API Documentation
Request Syntax
client.update_topic(
AwsAccountId='string',
TopicId='string',
Topic={
'Name': 'string',
'Description': 'string',
'UserExperienceVersion': 'LEGACY'|'NEW_READER_EXPERIENCE',
'DataSets': [
{
'DatasetArn': 'string',
'DatasetName': 'string',
'DatasetDescription': 'string',
'DataAggregation': {
'DatasetRowDateGranularity': 'SECOND'|'MINUTE'|'HOUR'|'DAY'|'WEEK'|'MONTH'|'QUARTER'|'YEAR',
'DefaultDateColumnName': 'string'
},
'Filters': [
{
'FilterDescription': 'string',
'FilterClass': 'ENFORCED_VALUE_FILTER'|'CONDITIONAL_VALUE_FILTER'|'NAMED_VALUE_FILTER',
'FilterName': 'string',
'FilterSynonyms': [
'string',
],
'OperandFieldName': 'string',
'FilterType': 'CATEGORY_FILTER'|'NUMERIC_EQUALITY_FILTER'|'NUMERIC_RANGE_FILTER'|'DATE_RANGE_FILTER'|'RELATIVE_DATE_FILTER',
'CategoryFilter': {
'CategoryFilterFunction': 'EXACT'|'CONTAINS',
'CategoryFilterType': 'CUSTOM_FILTER'|'CUSTOM_FILTER_LIST'|'FILTER_LIST',
'Constant': {
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'SingularConstant': 'string',
'CollectiveConstant': {
'ValueList': [
'string',
]
}
},
'Inverse': True|False
},
'NumericEqualityFilter': {
'Constant': {
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'SingularConstant': 'string'
},
'Aggregation': 'NO_AGGREGATION'|'SUM'|'AVERAGE'|'COUNT'|'DISTINCT_COUNT'|'MAX'|'MEDIAN'|'MIN'|'STDEV'|'STDEVP'|'VAR'|'VARP'
},
'NumericRangeFilter': {
'Inclusive': True|False,
'Constant': {
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'RangeConstant': {
'Minimum': 'string',
'Maximum': 'string'
}
},
'Aggregation': 'NO_AGGREGATION'|'SUM'|'AVERAGE'|'COUNT'|'DISTINCT_COUNT'|'MAX'|'MEDIAN'|'MIN'|'STDEV'|'STDEVP'|'VAR'|'VARP'
},
'DateRangeFilter': {
'Inclusive': True|False,
'Constant': {
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'RangeConstant': {
'Minimum': 'string',
'Maximum': 'string'
}
}
},
'RelativeDateFilter': {
'TimeGranularity': 'SECOND'|'MINUTE'|'HOUR'|'DAY'|'WEEK'|'MONTH'|'QUARTER'|'YEAR',
'RelativeDateFilterFunction': 'PREVIOUS'|'THIS'|'LAST'|'NEXT'|'NOW',
'Constant': {
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'SingularConstant': 'string'
}
}
},
],
'Columns': [
{
'ColumnName': 'string',
'ColumnFriendlyName': 'string',
'ColumnDescription': 'string',
'ColumnSynonyms': [
'string',
],
'ColumnDataRole': 'DIMENSION'|'MEASURE',
'Aggregation': 'SUM'|'MAX'|'MIN'|'COUNT'|'DISTINCT_COUNT'|'AVERAGE'|'MEDIAN'|'STDEV'|'STDEVP'|'VAR'|'VARP',
'IsIncludedInTopic': True|False,
'DisableIndexing': True|False,
'ComparativeOrder': {
'UseOrdering': 'GREATER_IS_BETTER'|'LESSER_IS_BETTER'|'SPECIFIED',
'SpecifedOrder': [
'string',
],
'TreatUndefinedSpecifiedValues': 'LEAST'|'MOST'
},
'SemanticType': {
'TypeName': 'string',
'SubTypeName': 'string',
'TypeParameters': {
'string': 'string'
},
'TruthyCellValue': 'string',
'TruthyCellValueSynonyms': [
'string',
],
'FalseyCellValue': 'string',
'FalseyCellValueSynonyms': [
'string',
]
},
'TimeGranularity': 'SECOND'|'MINUTE'|'HOUR'|'DAY'|'WEEK'|'MONTH'|'QUARTER'|'YEAR',
'AllowedAggregations': [
'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX'|'MEDIAN'|'SUM'|'AVERAGE'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE',
],
'NotAllowedAggregations': [
'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX'|'MEDIAN'|'SUM'|'AVERAGE'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE',
],
'DefaultFormatting': {
'DisplayFormat': 'AUTO'|'PERCENT'|'CURRENCY'|'NUMBER'|'DATE'|'STRING',
'DisplayFormatOptions': {
'UseBlankCellFormat': True|False,
'BlankCellFormat': 'string',
'DateFormat': 'string',
'DecimalSeparator': 'COMMA'|'DOT',
'GroupingSeparator': 'string',
'UseGrouping': True|False,
'FractionDigits': 123,
'Prefix': 'string',
'Suffix': 'string',
'UnitScaler': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeFormat': {
'Prefix': 'string',
'Suffix': 'string'
},
'CurrencySymbol': 'string'
}
},
'NeverAggregateInFilter': True|False,
'CellValueSynonyms': [
{
'CellValue': 'string',
'Synonyms': [
'string',
]
},
],
'NonAdditive': True|False
},
],
'CalculatedFields': [
{
'CalculatedFieldName': 'string',
'CalculatedFieldDescription': 'string',
'Expression': 'string',
'CalculatedFieldSynonyms': [
'string',
],
'IsIncludedInTopic': True|False,
'DisableIndexing': True|False,
'ColumnDataRole': 'DIMENSION'|'MEASURE',
'TimeGranularity': 'SECOND'|'MINUTE'|'HOUR'|'DAY'|'WEEK'|'MONTH'|'QUARTER'|'YEAR',
'DefaultFormatting': {
'DisplayFormat': 'AUTO'|'PERCENT'|'CURRENCY'|'NUMBER'|'DATE'|'STRING',
'DisplayFormatOptions': {
'UseBlankCellFormat': True|False,
'BlankCellFormat': 'string',
'DateFormat': 'string',
'DecimalSeparator': 'COMMA'|'DOT',
'GroupingSeparator': 'string',
'UseGrouping': True|False,
'FractionDigits': 123,
'Prefix': 'string',
'Suffix': 'string',
'UnitScaler': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeFormat': {
'Prefix': 'string',
'Suffix': 'string'
},
'CurrencySymbol': 'string'
}
},
'Aggregation': 'SUM'|'MAX'|'MIN'|'COUNT'|'DISTINCT_COUNT'|'AVERAGE'|'MEDIAN'|'STDEV'|'STDEVP'|'VAR'|'VARP',
'ComparativeOrder': {
'UseOrdering': 'GREATER_IS_BETTER'|'LESSER_IS_BETTER'|'SPECIFIED',
'SpecifedOrder': [
'string',
],
'TreatUndefinedSpecifiedValues': 'LEAST'|'MOST'
},
'SemanticType': {
'TypeName': 'string',
'SubTypeName': 'string',
'TypeParameters': {
'string': 'string'
},
'TruthyCellValue': 'string',
'TruthyCellValueSynonyms': [
'string',
],
'FalseyCellValue': 'string',
'FalseyCellValueSynonyms': [
'string',
]
},
'AllowedAggregations': [
'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX'|'MEDIAN'|'SUM'|'AVERAGE'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE',
],
'NotAllowedAggregations': [
'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX'|'MEDIAN'|'SUM'|'AVERAGE'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE',
],
'NeverAggregateInFilter': True|False,
'CellValueSynonyms': [
{
'CellValue': 'string',
'Synonyms': [
'string',
]
},
],
'NonAdditive': True|False
},
],
'NamedEntities': [
{
'EntityName': 'string',
'EntityDescription': 'string',
'EntitySynonyms': [
'string',
],
'SemanticEntityType': {
'TypeName': 'string',
'SubTypeName': 'string',
'TypeParameters': {
'string': 'string'
}
},
'Definition': [
{
'FieldName': 'string',
'PropertyName': 'string',
'PropertyRole': 'PRIMARY'|'ID',
'PropertyUsage': 'INHERIT'|'DIMENSION'|'MEASURE',
'Metric': {
'Aggregation': 'SUM'|'MIN'|'MAX'|'COUNT'|'AVERAGE'|'DISTINCT_COUNT'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE'|'MEDIAN'|'CUSTOM',
'AggregationFunctionParameters': {
'string': 'string'
}
}
},
]
},
]
},
],
'ConfigOptions': {
'QBusinessInsightsEnabled': True|False
}
}
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the topic that you want to update.
string
[REQUIRED]
The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
dict
[REQUIRED]
The definition of the topic that you want to update.
Name (string) --
The name of the topic.
Description (string) --
The description of the topic.
UserExperienceVersion (string) --
The user experience version of a topic.
DataSets (list) --
The data sets that the topic is associated with.
(dict) --
A structure that represents a dataset.
DatasetArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the dataset.
DatasetName (string) --
The name of the dataset.
DatasetDescription (string) --
The description of the dataset.
DataAggregation (dict) --
The definition of a data aggregation.
DatasetRowDateGranularity (string) --
The level of time precision that is used to aggregate DateTime values.
DefaultDateColumnName (string) --
The column name for the default date.
Filters (list) --
The list of filter definitions.
(dict) --
A structure that represents a filter used to select items for a topic.
FilterDescription (string) --
A description of the filter used to select items for a topic.
FilterClass (string) --
The class of the filter. Valid values for this structure are ENFORCED_VALUE_FILTER , CONDITIONAL_VALUE_FILTER , and NAMED_VALUE_FILTER .
FilterName (string) -- [REQUIRED]
The name of the filter.
FilterSynonyms (list) --
The other names or aliases for the filter.
(string) --
OperandFieldName (string) -- [REQUIRED]
The name of the field that the filter operates on.
FilterType (string) --
The type of the filter. Valid values for this structure are CATEGORY_FILTER , NUMERIC_EQUALITY_FILTER , NUMERIC_RANGE_FILTER , DATE_RANGE_FILTER , and RELATIVE_DATE_FILTER .
CategoryFilter (dict) --
The category filter that is associated with this filter.
CategoryFilterFunction (string) --
The category filter function. Valid values for this structure are EXACT and CONTAINS .
CategoryFilterType (string) --
The category filter type. This element is used to specify whether a filter is a simple category filter or an inverse category filter.
Constant (dict) --
The constant used in a category filter.
ConstantType (string) --
The type of category filter constant. This element is used to specify whether a constant is a singular or collective. Valid values are SINGULAR and COLLECTIVE .
SingularConstant (string) --
A singular constant used in a category filter. This element is used to specify a single value for the constant.
CollectiveConstant (dict) --
A collective constant used in a category filter. This element is used to specify a list of values for the constant.
ValueList (list) --
A list of values for the collective constant.
(string) --
Inverse (boolean) --
A Boolean value that indicates if the filter is inverse.
NumericEqualityFilter (dict) --
The numeric equality filter.
Constant (dict) --
The constant used in a numeric equality filter.
ConstantType (string) --
The type of the singular filter constant. Valid values for this structure are SINGULAR .
SingularConstant (string) --
The value of the singular filter constant.
Aggregation (string) --
An aggregation function that specifies how to calculate the value of a numeric field for a topic. Valid values for this structure are NO_AGGREGATION , SUM , AVERAGE , COUNT , DISTINCT_COUNT , MAX , MEDIAN , MIN , STDEV , STDEVP , VAR , and VARP .
NumericRangeFilter (dict) --
The numeric range filter.
Inclusive (boolean) --
A Boolean value that indicates whether the endpoints of the numeric range are included in the filter. If set to true, topics whose numeric field value is equal to the endpoint values will be included in the filter. If set to false, topics whose numeric field value is equal to the endpoint values will be excluded from the filter.
Constant (dict) --
The constant used in a numeric range filter.
ConstantType (string) --
The data type of the constant value that is used in a range filter. Valid values for this structure are RANGE .
RangeConstant (dict) --
The value of the constant that is used to specify the endpoints of a range filter.
Minimum (string) --
The minimum value for a range constant.
Maximum (string) --
The maximum value for a range constant.
Aggregation (string) --
An aggregation function that specifies how to calculate the value of a numeric field for a topic, Valid values for this structure are NO_AGGREGATION , SUM , AVERAGE , COUNT , DISTINCT_COUNT , MAX , MEDIAN , MIN , STDEV , STDEVP , VAR , and VARP .
DateRangeFilter (dict) --
The date range filter.
Inclusive (boolean) --
A Boolean value that indicates whether the date range filter should include the boundary values. If set to true, the filter includes the start and end dates. If set to false, the filter excludes them.
Constant (dict) --
The constant used in a date range filter.
ConstantType (string) --
The data type of the constant value that is used in a range filter. Valid values for this structure are RANGE .
RangeConstant (dict) --
The value of the constant that is used to specify the endpoints of a range filter.
Minimum (string) --
The minimum value for a range constant.
Maximum (string) --
The maximum value for a range constant.
RelativeDateFilter (dict) --
The relative date filter.
TimeGranularity (string) --
The level of time precision that is used to aggregate DateTime values.
RelativeDateFilterFunction (string) --
The function to be used in a relative date filter to determine the range of dates to include in the results. Valid values for this structure are BEFORE , AFTER , and BETWEEN .
Constant (dict) --
The constant used in a relative date filter.
ConstantType (string) --
The type of the singular filter constant. Valid values for this structure are SINGULAR .
SingularConstant (string) --
The value of the singular filter constant.
Columns (list) --
The list of column definitions.
(dict) --
Represents a column in a dataset.
ColumnName (string) -- [REQUIRED]
The name of the column.
ColumnFriendlyName (string) --
A user-friendly name for the column.
ColumnDescription (string) --
A description of the column and its contents.
ColumnSynonyms (list) --
The other names or aliases for the column.
(string) --
ColumnDataRole (string) --
The role of the column in the data. Valid values are DIMENSION and MEASURE .
Aggregation (string) --
The type of aggregation that is performed on the column data when it's queried.
IsIncludedInTopic (boolean) --
A Boolean value that indicates whether the column is included in the query results.
DisableIndexing (boolean) --
A Boolean value that indicates whether the column shows in the autocomplete functionality.
ComparativeOrder (dict) --
The order in which data is displayed for the column when it's used in a comparative context.
UseOrdering (string) --
The ordering type for a column. Valid values for this structure are GREATER_IS_BETTER , LESSER_IS_BETTER and SPECIFIED .
SpecifedOrder (list) --
The list of columns to be used in the ordering.
(string) --
TreatUndefinedSpecifiedValues (string) --
The treat of undefined specified values. Valid values for this structure are LEAST and MOST .
SemanticType (dict) --
The semantic type of data contained in the column.
TypeName (string) --
The semantic type name.
SubTypeName (string) --
The semantic type sub type name.
TypeParameters (dict) --
The semantic type parameters.
(string) --
(string) --
TruthyCellValue (string) --
The semantic type truthy cell value.
TruthyCellValueSynonyms (list) --
The other names or aliases for the true cell value.
(string) --
FalseyCellValue (string) --
The semantic type falsey cell value.
FalseyCellValueSynonyms (list) --
The other names or aliases for the false cell value.
(string) --
TimeGranularity (string) --
The level of time precision that is used to aggregate DateTime values.
AllowedAggregations (list) --
The list of aggregation types that are allowed for the column. Valid values for this structure are COUNT , DISTINCT_COUNT , MIN , MAX , MEDIAN , SUM , AVERAGE , STDEV , STDEVP , VAR , VARP , and PERCENTILE .
(string) --
NotAllowedAggregations (list) --
The list of aggregation types that are not allowed for the column. Valid values for this structure are COUNT , DISTINCT_COUNT , MIN , MAX , MEDIAN , SUM , AVERAGE , STDEV , STDEVP , VAR , VARP , and PERCENTILE .
(string) --
DefaultFormatting (dict) --
The default formatting used for values in the column.
DisplayFormat (string) --
The display format. Valid values for this structure are AUTO , PERCENT , CURRENCY , NUMBER , DATE , and STRING .
DisplayFormatOptions (dict) --
The additional options for display formatting.
UseBlankCellFormat (boolean) --
A Boolean value that indicates whether to use blank cell format.
BlankCellFormat (string) --
Determines the blank cell format.
DateFormat (string) --
Determines the DateTime format.
DecimalSeparator (string) --
Determines the decimal separator.
GroupingSeparator (string) --
Determines the grouping separator.
UseGrouping (boolean) --
A Boolean value that indicates whether to use grouping.
FractionDigits (integer) --
Determines the number of fraction digits.
Prefix (string) --
The prefix value for a display format.
Suffix (string) --
The suffix value for a display format.
UnitScaler (string) --
The unit scaler. Valid values for this structure are: NONE , AUTO , THOUSANDS , MILLIONS , BILLIONS , and TRILLIONS .
NegativeFormat (dict) --
The negative format.
Prefix (string) --
The prefix for a negative format.
Suffix (string) --
The suffix for a negative format.
CurrencySymbol (string) --
The currency symbol, such as USD .
NeverAggregateInFilter (boolean) --
A Boolean value that indicates whether to aggregate the column data when it's used in a filter context.
CellValueSynonyms (list) --
The other names or aliases for the column cell value.
(dict) --
A structure that represents the cell value synonym.
CellValue (string) --
The cell value.
Synonyms (list) --
Other names or aliases for the cell value.
(string) --
NonAdditive (boolean) --
The non additive value for the column.
CalculatedFields (list) --
The list of calculated field definitions.
(dict) --
A structure that represents a calculated field.
CalculatedFieldName (string) -- [REQUIRED]
The calculated field name.
CalculatedFieldDescription (string) --
The calculated field description.
Expression (string) -- [REQUIRED]
The calculated field expression.
CalculatedFieldSynonyms (list) --
The other names or aliases for the calculated field.
(string) --
IsIncludedInTopic (boolean) --
A boolean value that indicates if a calculated field is included in the topic.
DisableIndexing (boolean) --
A Boolean value that indicates if a calculated field is visible in the autocomplete.
ColumnDataRole (string) --
The column data role for a calculated field. Valid values for this structure are DIMENSION and MEASURE .
TimeGranularity (string) --
The level of time precision that is used to aggregate DateTime values.
DefaultFormatting (dict) --
The default formatting definition.
DisplayFormat (string) --
The display format. Valid values for this structure are AUTO , PERCENT , CURRENCY , NUMBER , DATE , and STRING .
DisplayFormatOptions (dict) --
The additional options for display formatting.
UseBlankCellFormat (boolean) --
A Boolean value that indicates whether to use blank cell format.
BlankCellFormat (string) --
Determines the blank cell format.
DateFormat (string) --
Determines the DateTime format.
DecimalSeparator (string) --
Determines the decimal separator.
GroupingSeparator (string) --
Determines the grouping separator.
UseGrouping (boolean) --
A Boolean value that indicates whether to use grouping.
FractionDigits (integer) --
Determines the number of fraction digits.
Prefix (string) --
The prefix value for a display format.
Suffix (string) --
The suffix value for a display format.
UnitScaler (string) --
The unit scaler. Valid values for this structure are: NONE , AUTO , THOUSANDS , MILLIONS , BILLIONS , and TRILLIONS .
NegativeFormat (dict) --
The negative format.
Prefix (string) --
The prefix for a negative format.
Suffix (string) --
The suffix for a negative format.
CurrencySymbol (string) --
The currency symbol, such as USD .
Aggregation (string) --
The default aggregation. Valid values for this structure are SUM , MAX , MIN , COUNT , DISTINCT_COUNT , and AVERAGE .
ComparativeOrder (dict) --
The order in which data is displayed for the calculated field when it's used in a comparative context.
UseOrdering (string) --
The ordering type for a column. Valid values for this structure are GREATER_IS_BETTER , LESSER_IS_BETTER and SPECIFIED .
SpecifedOrder (list) --
The list of columns to be used in the ordering.
(string) --
TreatUndefinedSpecifiedValues (string) --
The treat of undefined specified values. Valid values for this structure are LEAST and MOST .
SemanticType (dict) --
The semantic type.
TypeName (string) --
The semantic type name.
SubTypeName (string) --
The semantic type sub type name.
TypeParameters (dict) --
The semantic type parameters.
(string) --
(string) --
TruthyCellValue (string) --
The semantic type truthy cell value.
TruthyCellValueSynonyms (list) --
The other names or aliases for the true cell value.
(string) --
FalseyCellValue (string) --
The semantic type falsey cell value.
FalseyCellValueSynonyms (list) --
The other names or aliases for the false cell value.
(string) --
AllowedAggregations (list) --
The list of aggregation types that are allowed for the calculated field. Valid values for this structure are COUNT , DISTINCT_COUNT , MIN , MAX , MEDIAN , SUM , AVERAGE , STDEV , STDEVP , VAR , VARP , and PERCENTILE .
(string) --
NotAllowedAggregations (list) --
The list of aggregation types that are not allowed for the calculated field. Valid values for this structure are COUNT , DISTINCT_COUNT , MIN , MAX , MEDIAN , SUM , AVERAGE , STDEV , STDEVP , VAR , VARP , and PERCENTILE .
(string) --
NeverAggregateInFilter (boolean) --
A Boolean value that indicates whether to never aggregate calculated field in filters.
CellValueSynonyms (list) --
The other names or aliases for the calculated field cell value.
(dict) --
A structure that represents the cell value synonym.
CellValue (string) --
The cell value.
Synonyms (list) --
Other names or aliases for the cell value.
(string) --
NonAdditive (boolean) --
The non additive for the table style target.
NamedEntities (list) --
The list of named entities definitions.
(dict) --
A structure that represents a named entity.
EntityName (string) -- [REQUIRED]
The name of the named entity.
EntityDescription (string) --
The description of the named entity.
EntitySynonyms (list) --
The other names or aliases for the named entity.
(string) --
SemanticEntityType (dict) --
The type of named entity that a topic represents.
TypeName (string) --
The semantic entity type name.
SubTypeName (string) --
The semantic entity sub type name.
TypeParameters (dict) --
The semantic entity type parameters.
(string) --
(string) --
Definition (list) --
The definition of a named entity.
(dict) --
A structure that represents a named entity.
FieldName (string) --
The name of the entity.
PropertyName (string) --
The property name to be used for the named entity.
PropertyRole (string) --
The property role. Valid values for this structure are PRIMARY and ID .
PropertyUsage (string) --
The property usage. Valid values for this structure are INHERIT , DIMENSION , and MEASURE .
Metric (dict) --
The definition of a metric.
Aggregation (string) --
The aggregation of a named entity. Valid values for this structure are SUM , MIN , MAX , COUNT , AVERAGE , DISTINCT_COUNT , STDEV , STDEVP , VAR , VARP , PERCENTILE , MEDIAN , and CUSTOM .
AggregationFunctionParameters (dict) --
The additional parameters for an aggregation function.
(string) --
(string) --
ConfigOptions (dict) --
Configuration options for a Topic .
QBusinessInsightsEnabled (boolean) --
Enables Amazon Q Business Insights for a Topic .
dict
Response Syntax
{
'TopicId': 'string',
'Arn': 'string',
'RefreshArn': 'string',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
TopicId (string) --
The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
Arn (string) --
The Amazon Resource Name (ARN) of the topic.
RefreshArn (string) --
The Amazon Resource Name (ARN) of the topic refresh.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.