2023/08/11 - Amazon QuickSight - 18 updated api methods
Changes New Authentication method for Account subscription - IAM Identity Center. Hierarchy layout support, default column width support and related style properties for pivot table visuals. Non-additive topic field aggregations for Topic API
{'AuthenticationMethod': {'IAM_IDENTITY_CENTER'}}
Creates an Amazon QuickSight account, or subscribes to Amazon QuickSight Q.
The Amazon Web Services Region for the account is derived from what is configured in the CLI or SDK. This operation isn't supported in the US East (Ohio) Region, South America (Sao Paulo) Region, or Asia Pacific (Singapore) Region.
Before you use this operation, make sure that you can connect to an existing Amazon Web Services account. If you don't have an Amazon Web Services account, see Sign up for Amazon Web Services in the Amazon QuickSight User Guide . The person who signs up for Amazon QuickSight needs to have the correct Identity and Access Management (IAM) permissions. For more information, see IAM Policy Examples for Amazon QuickSight in the Amazon QuickSight User Guide .
If your IAM policy includes both the Subscribe and CreateAccountSubscription actions, make sure that both actions are set to Allow . If either action is set to Deny , the Deny action prevails and your API call fails.
You can't pass an existing IAM role to access other Amazon Web Services services using this API operation. To pass your existing IAM role to Amazon QuickSight, see Passing IAM roles to Amazon QuickSight in the Amazon QuickSight User Guide .
You can't set default resource access on the new account from the Amazon QuickSight API. Instead, add default resource access from the Amazon QuickSight console. For more information about setting default resource access to Amazon Web Services services, see Setting default resource access to Amazon Web Services services in the Amazon QuickSight User Guide .
See also: AWS API Documentation
Request Syntax
client.create_account_subscription(
Edition='STANDARD'|'ENTERPRISE'|'ENTERPRISE_AND_Q',
AuthenticationMethod='IAM_AND_QUICKSIGHT'|'IAM_ONLY'|'ACTIVE_DIRECTORY'|'IAM_IDENTITY_CENTER',
AwsAccountId='string',
AccountName='string',
NotificationEmail='string',
ActiveDirectoryName='string',
Realm='string',
DirectoryId='string',
AdminGroup=[
'string',
],
AuthorGroup=[
'string',
],
ReaderGroup=[
'string',
],
FirstName='string',
LastName='string',
EmailAddress='string',
ContactNumber='string'
)
string
[REQUIRED]
The edition of Amazon QuickSight that you want your account to have. Currently, you can choose from ENTERPRISE or ENTERPRISE_AND_Q .
If you choose ENTERPRISE_AND_Q , the following parameters are required:
FirstName
LastName
EmailAddress
ContactNumber
string
[REQUIRED]
The method that you want to use to authenticate your Amazon QuickSight account. Currently, the valid values for this parameter are IAM_AND_QUICKSIGHT , IAM_ONLY , and ACTIVE_DIRECTORY .
If you choose ACTIVE_DIRECTORY , provide an ActiveDirectoryName and an AdminGroup associated with your Active Directory.
string
[REQUIRED]
The Amazon Web Services account ID of the account that you're using to create your Amazon QuickSight account.
string
[REQUIRED]
The name of your Amazon QuickSight account. This name is unique over all of Amazon Web Services, and it appears only when users sign in. You can't change AccountName value after the Amazon QuickSight account is created.
string
[REQUIRED]
The email address that you want Amazon QuickSight to send notifications to regarding your Amazon QuickSight account or Amazon QuickSight subscription.
string
The name of your Active Directory. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Amazon QuickSight account.
string
The realm of the Active Directory that is associated with your Amazon QuickSight account. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Amazon QuickSight account.
string
The ID of the Active Directory that is associated with your Amazon QuickSight account.
list
The admin group associated with your Active Directory. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Amazon QuickSight account. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.
(string) --
list
The author group associated with your Active Directory. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.
(string) --
list
The reader group associated with your Active Direcrtory. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide .
(string) --
string
The first name of the author of the Amazon QuickSight account to use for future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition of the new Amazon QuickSight account.
string
The last name of the author of the Amazon QuickSight account to use for future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition of the new Amazon QuickSight account.
string
The email address of the author of the Amazon QuickSight account to use for future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition of the new Amazon QuickSight account.
string
A 10-digit phone number for the author of the Amazon QuickSight account to use for future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition of the new Amazon QuickSight account.
dict
Response Syntax
{
'SignupResponse': {
'IAMUser': True|False,
'userLoginName': 'string',
'accountName': 'string',
'directoryType': 'string'
},
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
SignupResponse (dict) --
A SignupResponse object that returns information about a newly created Amazon QuickSight account.
IAMUser (boolean) --
A Boolean that is TRUE if the Amazon QuickSight uses IAM as an authentication method.
userLoginName (string) --
The user login name for your Amazon QuickSight account.
accountName (string) --
The name of your Amazon QuickSight account.
directoryType (string) --
The type of Active Directory that is being used to authenticate the Amazon QuickSight account. Valid values are SIMPLE_AD , AD_CONNECTOR , and MICROSOFT_AD .
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'Definition': {'Sheets': {'Visuals': {'PivotTableVisual': {'ChartConfiguration': {'TableOptions': {'CellStyle': {'VerticalTextAlignment': {'AUTO'}},
'ColumnHeaderStyle': {'VerticalTextAlignment': {'AUTO'}},
'DefaultCellWidth': 'string',
'RowAlternateColorOptions': {'UsePrimaryBackgroundColor': 'ENABLED '
'| '
'DISABLED'},
'RowFieldNamesStyle': {'VerticalTextAlignment': {'AUTO'}},
'RowHeaderStyle': {'VerticalTextAlignment': {'AUTO'}},
'RowsLabelOptions': {'CustomLabel': 'string',
'Visibility': 'HIDDEN '
'| '
'VISIBLE'},
'RowsLayout': 'TABULAR '
'| '
'HIERARCHY'},
'TotalOptions': {'ColumnSubtotalOptions': {'MetricHeaderCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'StyleTargets': [{'CellType': 'TOTAL '
'| '
'METRIC_HEADER '
'| '
'VALUE'}],
'TotalCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'ValueCellStyle': {'VerticalTextAlignment': {'AUTO'}}},
'ColumnTotalOptions': {'MetricHeaderCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'TotalCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'ValueCellStyle': {'VerticalTextAlignment': {'AUTO'}}},
'RowSubtotalOptions': {'MetricHeaderCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'StyleTargets': [{'CellType': 'TOTAL '
'| '
'METRIC_HEADER '
'| '
'VALUE'}],
'TotalCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'ValueCellStyle': {'VerticalTextAlignment': {'AUTO'}}},
'RowTotalOptions': {'MetricHeaderCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'TotalCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'ValueCellStyle': {'VerticalTextAlignment': {'AUTO'}}}}}},
'TableVisual': {'ChartConfiguration': {'TableOptions': {'CellStyle': {'VerticalTextAlignment': {'AUTO'}},
'HeaderStyle': {'VerticalTextAlignment': {'AUTO'}},
'RowAlternateColorOptions': {'UsePrimaryBackgroundColor': 'ENABLED '
'| '
'DISABLED'}},
'TotalOptions': {'TotalCellStyle': {'VerticalTextAlignment': {'AUTO'}}}}}}}}}
Creates an analysis in Amazon QuickSight. Analyses can be created either from a template or from an AnalysisDefinition .
See also: AWS API Documentation
Request Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.Parameters
# This section is too large to render. # Please see the AWS API Documentation linked below.
dict
Response Syntax
{
'Arn': 'string',
'AnalysisId': 'string',
'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
Arn (string) --
The ARN for the analysis.
AnalysisId (string) --
The ID of the analysis.
CreationStatus (string) --
The status of the creation of the analysis.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'Definition': {'Sheets': {'Visuals': {'PivotTableVisual': {'ChartConfiguration': {'TableOptions': {'CellStyle': {'VerticalTextAlignment': {'AUTO'}},
'ColumnHeaderStyle': {'VerticalTextAlignment': {'AUTO'}},
'DefaultCellWidth': 'string',
'RowAlternateColorOptions': {'UsePrimaryBackgroundColor': 'ENABLED '
'| '
'DISABLED'},
'RowFieldNamesStyle': {'VerticalTextAlignment': {'AUTO'}},
'RowHeaderStyle': {'VerticalTextAlignment': {'AUTO'}},
'RowsLabelOptions': {'CustomLabel': 'string',
'Visibility': 'HIDDEN '
'| '
'VISIBLE'},
'RowsLayout': 'TABULAR '
'| '
'HIERARCHY'},
'TotalOptions': {'ColumnSubtotalOptions': {'MetricHeaderCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'StyleTargets': [{'CellType': 'TOTAL '
'| '
'METRIC_HEADER '
'| '
'VALUE'}],
'TotalCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'ValueCellStyle': {'VerticalTextAlignment': {'AUTO'}}},
'ColumnTotalOptions': {'MetricHeaderCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'TotalCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'ValueCellStyle': {'VerticalTextAlignment': {'AUTO'}}},
'RowSubtotalOptions': {'MetricHeaderCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'StyleTargets': [{'CellType': 'TOTAL '
'| '
'METRIC_HEADER '
'| '
'VALUE'}],
'TotalCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'ValueCellStyle': {'VerticalTextAlignment': {'AUTO'}}},
'RowTotalOptions': {'MetricHeaderCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'TotalCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'ValueCellStyle': {'VerticalTextAlignment': {'AUTO'}}}}}},
'TableVisual': {'ChartConfiguration': {'TableOptions': {'CellStyle': {'VerticalTextAlignment': {'AUTO'}},
'HeaderStyle': {'VerticalTextAlignment': {'AUTO'}},
'RowAlternateColorOptions': {'UsePrimaryBackgroundColor': 'ENABLED '
'| '
'DISABLED'}},
'TotalOptions': {'TotalCellStyle': {'VerticalTextAlignment': {'AUTO'}}}}}}}}}
Creates a dashboard from either a template or directly with a DashboardDefinition . To first create a template, see the CreateTemplate API operation.
A dashboard is an entity in Amazon QuickSight that identifies Amazon QuickSight reports, created from analyses. You can share Amazon QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.Parameters
# This section is too large to render. # Please see the AWS API Documentation linked below.
dict
Response Syntax
{
'Arn': 'string',
'VersionArn': 'string',
'DashboardId': 'string',
'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
Arn (string) --
The ARN of the dashboard.
VersionArn (string) --
The ARN of the dashboard, including the version number of the first version that is created.
DashboardId (string) --
The ID for the dashboard.
CreationStatus (string) --
The status of the dashboard creation request.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'Definition': {'Sheets': {'Visuals': {'PivotTableVisual': {'ChartConfiguration': {'TableOptions': {'CellStyle': {'VerticalTextAlignment': {'AUTO'}},
'ColumnHeaderStyle': {'VerticalTextAlignment': {'AUTO'}},
'DefaultCellWidth': 'string',
'RowAlternateColorOptions': {'UsePrimaryBackgroundColor': 'ENABLED '
'| '
'DISABLED'},
'RowFieldNamesStyle': {'VerticalTextAlignment': {'AUTO'}},
'RowHeaderStyle': {'VerticalTextAlignment': {'AUTO'}},
'RowsLabelOptions': {'CustomLabel': 'string',
'Visibility': 'HIDDEN '
'| '
'VISIBLE'},
'RowsLayout': 'TABULAR '
'| '
'HIERARCHY'},
'TotalOptions': {'ColumnSubtotalOptions': {'MetricHeaderCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'StyleTargets': [{'CellType': 'TOTAL '
'| '
'METRIC_HEADER '
'| '
'VALUE'}],
'TotalCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'ValueCellStyle': {'VerticalTextAlignment': {'AUTO'}}},
'ColumnTotalOptions': {'MetricHeaderCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'TotalCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'ValueCellStyle': {'VerticalTextAlignment': {'AUTO'}}},
'RowSubtotalOptions': {'MetricHeaderCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'StyleTargets': [{'CellType': 'TOTAL '
'| '
'METRIC_HEADER '
'| '
'VALUE'}],
'TotalCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'ValueCellStyle': {'VerticalTextAlignment': {'AUTO'}}},
'RowTotalOptions': {'MetricHeaderCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'TotalCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'ValueCellStyle': {'VerticalTextAlignment': {'AUTO'}}}}}},
'TableVisual': {'ChartConfiguration': {'TableOptions': {'CellStyle': {'VerticalTextAlignment': {'AUTO'}},
'HeaderStyle': {'VerticalTextAlignment': {'AUTO'}},
'RowAlternateColorOptions': {'UsePrimaryBackgroundColor': 'ENABLED '
'| '
'DISABLED'}},
'TotalOptions': {'TotalCellStyle': {'VerticalTextAlignment': {'AUTO'}}}}}}}}}
Creates a template either from a TemplateDefinition or from an existing Amazon QuickSight analysis or template. You can use the resulting template to create additional dashboards, templates, or analyses.
A template is an entity in Amazon QuickSight that encapsulates the metadata required to create an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.
See also: AWS API Documentation
Request Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.Parameters
# This section is too large to render. # Please see the AWS API Documentation linked below.
dict
Response Syntax
{
'Arn': 'string',
'VersionArn': 'string',
'TemplateId': 'string',
'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
Arn (string) --
The ARN for the template.
VersionArn (string) --
The ARN for the template, including the version information of the first version.
TemplateId (string) --
The ID of the template.
CreationStatus (string) --
The template creation status.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'Topic': {'DataSets': {'CalculatedFields': {'Aggregation': {'MEDIAN',
'STDEV',
'STDEVP',
'VAR',
'VARP'},
'NonAdditive': 'boolean'},
'Columns': {'Aggregation': {'MEDIAN',
'STDEV',
'STDEVP',
'VAR',
'VARP'},
'NonAdditive': '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',
'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'
}
}
},
]
},
]
},
]
},
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.
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) --
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.
{'AccountInfo': {'IAMIdentityCenterInstanceArn': 'string'}}
Use the DescribeAccountSubscription operation to receive a description of an Amazon QuickSight account's subscription. A successful API call returns an AccountInfo object that includes an account's name, subscription status, authentication type, edition, and notification email address.
See also: AWS API Documentation
Request Syntax
client.describe_account_subscription(
AwsAccountId='string'
)
string
[REQUIRED]
The Amazon Web Services account ID associated with your Amazon QuickSight account.
dict
Response Syntax
{
'AccountInfo': {
'AccountName': 'string',
'Edition': 'STANDARD'|'ENTERPRISE'|'ENTERPRISE_AND_Q',
'NotificationEmail': 'string',
'AuthenticationType': 'string',
'AccountSubscriptionStatus': 'string',
'IAMIdentityCenterInstanceArn': 'string'
},
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
AccountInfo (dict) --
A structure that contains the following elements:
Your Amazon QuickSight account name.
The edition of Amazon QuickSight that your account is using.
The notification email address that is associated with the Amazon QuickSight account.
The authentication type of the Amazon QuickSight account.
The status of the Amazon QuickSight account's subscription.
AccountName (string) --
The account name that you provided for the Amazon QuickSight subscription in your Amazon Web Services account. You create this name when you sign up for Amazon QuickSight. It's unique over all of Amazon Web Services, and it appears only when users sign in.
Edition (string) --
The edition of your Amazon QuickSight account.
NotificationEmail (string) --
The email address that will be used for Amazon QuickSight to send notifications regarding your Amazon Web Services account or Amazon QuickSight subscription.
AuthenticationType (string) --
The way that your Amazon QuickSight account is authenticated.
AccountSubscriptionStatus (string) --
The status of your account subscription.
IAMIdentityCenterInstanceArn (string) --
The Amazon Resource Name (ARN) for the IAM Identity Center instance.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'Definition': {'Sheets': {'Visuals': {'PivotTableVisual': {'ChartConfiguration': {'TableOptions': {'CellStyle': {'VerticalTextAlignment': {'AUTO'}},
'ColumnHeaderStyle': {'VerticalTextAlignment': {'AUTO'}},
'DefaultCellWidth': 'string',
'RowAlternateColorOptions': {'UsePrimaryBackgroundColor': 'ENABLED '
'| '
'DISABLED'},
'RowFieldNamesStyle': {'VerticalTextAlignment': {'AUTO'}},
'RowHeaderStyle': {'VerticalTextAlignment': {'AUTO'}},
'RowsLabelOptions': {'CustomLabel': 'string',
'Visibility': 'HIDDEN '
'| '
'VISIBLE'},
'RowsLayout': 'TABULAR '
'| '
'HIERARCHY'},
'TotalOptions': {'ColumnSubtotalOptions': {'MetricHeaderCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'StyleTargets': [{'CellType': 'TOTAL '
'| '
'METRIC_HEADER '
'| '
'VALUE'}],
'TotalCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'ValueCellStyle': {'VerticalTextAlignment': {'AUTO'}}},
'ColumnTotalOptions': {'MetricHeaderCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'TotalCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'ValueCellStyle': {'VerticalTextAlignment': {'AUTO'}}},
'RowSubtotalOptions': {'MetricHeaderCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'StyleTargets': [{'CellType': 'TOTAL '
'| '
'METRIC_HEADER '
'| '
'VALUE'}],
'TotalCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'ValueCellStyle': {'VerticalTextAlignment': {'AUTO'}}},
'RowTotalOptions': {'MetricHeaderCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'TotalCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'ValueCellStyle': {'VerticalTextAlignment': {'AUTO'}}}}}},
'TableVisual': {'ChartConfiguration': {'TableOptions': {'CellStyle': {'VerticalTextAlignment': {'AUTO'}},
'HeaderStyle': {'VerticalTextAlignment': {'AUTO'}},
'RowAlternateColorOptions': {'UsePrimaryBackgroundColor': 'ENABLED '
'| '
'DISABLED'}},
'TotalOptions': {'TotalCellStyle': {'VerticalTextAlignment': {'AUTO'}}}}}}}}}
Provides a detailed description of the definition of an analysis.
Note
If you do not need to know details about the content of an Analysis, for instance if you are trying to check the status of a recently created or updated Analysis, use the DescribeAnalysis instead.
See also: AWS API Documentation
Request Syntax
client.describe_analysis_definition(
AwsAccountId='string',
AnalysisId='string'
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the analysis. You must be using the Amazon Web Services account that the analysis is in.
string
[REQUIRED]
The ID of the analysis that you're describing. The ID is part of the URL of the analysis.
dict
Response Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.
Response Structure
# This section is too large to render. # Please see the AWS API Documentation linked below.
{'Definition': {'Sheets': {'Visuals': {'PivotTableVisual': {'ChartConfiguration': {'TableOptions': {'CellStyle': {'VerticalTextAlignment': {'AUTO'}},
'ColumnHeaderStyle': {'VerticalTextAlignment': {'AUTO'}},
'DefaultCellWidth': 'string',
'RowAlternateColorOptions': {'UsePrimaryBackgroundColor': 'ENABLED '
'| '
'DISABLED'},
'RowFieldNamesStyle': {'VerticalTextAlignment': {'AUTO'}},
'RowHeaderStyle': {'VerticalTextAlignment': {'AUTO'}},
'RowsLabelOptions': {'CustomLabel': 'string',
'Visibility': 'HIDDEN '
'| '
'VISIBLE'},
'RowsLayout': 'TABULAR '
'| '
'HIERARCHY'},
'TotalOptions': {'ColumnSubtotalOptions': {'MetricHeaderCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'StyleTargets': [{'CellType': 'TOTAL '
'| '
'METRIC_HEADER '
'| '
'VALUE'}],
'TotalCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'ValueCellStyle': {'VerticalTextAlignment': {'AUTO'}}},
'ColumnTotalOptions': {'MetricHeaderCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'TotalCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'ValueCellStyle': {'VerticalTextAlignment': {'AUTO'}}},
'RowSubtotalOptions': {'MetricHeaderCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'StyleTargets': [{'CellType': 'TOTAL '
'| '
'METRIC_HEADER '
'| '
'VALUE'}],
'TotalCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'ValueCellStyle': {'VerticalTextAlignment': {'AUTO'}}},
'RowTotalOptions': {'MetricHeaderCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'TotalCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'ValueCellStyle': {'VerticalTextAlignment': {'AUTO'}}}}}},
'TableVisual': {'ChartConfiguration': {'TableOptions': {'CellStyle': {'VerticalTextAlignment': {'AUTO'}},
'HeaderStyle': {'VerticalTextAlignment': {'AUTO'}},
'RowAlternateColorOptions': {'UsePrimaryBackgroundColor': 'ENABLED '
'| '
'DISABLED'}},
'TotalOptions': {'TotalCellStyle': {'VerticalTextAlignment': {'AUTO'}}}}}}}}}
Provides a detailed description of the definition of a dashboard.
Note
If you do not need to know details about the content of a dashboard, for instance if you are trying to check the status of a recently created or updated dashboard, use the DescribeDashboard instead.
See also: AWS API Documentation
Request Syntax
client.describe_dashboard_definition(
AwsAccountId='string',
DashboardId='string',
VersionNumber=123,
AliasName='string'
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the dashboard that you're describing.
string
[REQUIRED]
The ID for the dashboard.
integer
The version number for the dashboard. If a version number isn't passed, the latest published dashboard version is described.
string
The alias name.
dict
Response Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.
Response Structure
# This section is too large to render. # Please see the AWS API Documentation linked below.
{'Definition': {'Sheets': {'Visuals': {'PivotTableVisual': {'ChartConfiguration': {'TableOptions': {'CellStyle': {'VerticalTextAlignment': {'AUTO'}},
'ColumnHeaderStyle': {'VerticalTextAlignment': {'AUTO'}},
'DefaultCellWidth': 'string',
'RowAlternateColorOptions': {'UsePrimaryBackgroundColor': 'ENABLED '
'| '
'DISABLED'},
'RowFieldNamesStyle': {'VerticalTextAlignment': {'AUTO'}},
'RowHeaderStyle': {'VerticalTextAlignment': {'AUTO'}},
'RowsLabelOptions': {'CustomLabel': 'string',
'Visibility': 'HIDDEN '
'| '
'VISIBLE'},
'RowsLayout': 'TABULAR '
'| '
'HIERARCHY'},
'TotalOptions': {'ColumnSubtotalOptions': {'MetricHeaderCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'StyleTargets': [{'CellType': 'TOTAL '
'| '
'METRIC_HEADER '
'| '
'VALUE'}],
'TotalCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'ValueCellStyle': {'VerticalTextAlignment': {'AUTO'}}},
'ColumnTotalOptions': {'MetricHeaderCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'TotalCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'ValueCellStyle': {'VerticalTextAlignment': {'AUTO'}}},
'RowSubtotalOptions': {'MetricHeaderCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'StyleTargets': [{'CellType': 'TOTAL '
'| '
'METRIC_HEADER '
'| '
'VALUE'}],
'TotalCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'ValueCellStyle': {'VerticalTextAlignment': {'AUTO'}}},
'RowTotalOptions': {'MetricHeaderCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'TotalCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'ValueCellStyle': {'VerticalTextAlignment': {'AUTO'}}}}}},
'TableVisual': {'ChartConfiguration': {'TableOptions': {'CellStyle': {'VerticalTextAlignment': {'AUTO'}},
'HeaderStyle': {'VerticalTextAlignment': {'AUTO'}},
'RowAlternateColorOptions': {'UsePrimaryBackgroundColor': 'ENABLED '
'| '
'DISABLED'}},
'TotalOptions': {'TotalCellStyle': {'VerticalTextAlignment': {'AUTO'}}}}}}}}}
Provides a detailed description of the definition of a template.
Note
If you do not need to know details about the content of a template, for instance if you are trying to check the status of a recently created or updated template, use the DescribeTemplate instead.
See also: AWS API Documentation
Request Syntax
client.describe_template_definition(
AwsAccountId='string',
TemplateId='string',
VersionNumber=123,
AliasName='string'
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the template. You must be using the Amazon Web Services account that the template is in.
string
[REQUIRED]
The ID of the template that you're describing.
integer
The version number of the template.
string
The alias of the template that you want to describe. If you name a specific alias, you describe the version that the alias points to. You can specify the latest version of the template by providing the keyword $LATEST in the AliasName parameter. The keyword $PUBLISHED doesn't apply to templates.
dict
Response Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.
Response Structure
# This section is too large to render. # Please see the AWS API Documentation linked below.
{'Topic': {'DataSets': {'CalculatedFields': {'Aggregation': {'MEDIAN',
'STDEV',
'STDEVP',
'VAR',
'VARP'},
'NonAdditive': 'boolean'},
'Columns': {'Aggregation': {'MEDIAN',
'STDEV',
'STDEVP',
'VAR',
'VARP'},
'NonAdditive': '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',
'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'
}
}
},
]
},
]
},
]
},
'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.
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) --
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'User': {'IdentityType': {'IAM_IDENTITY_CENTER'}}}
Returns information about a user, given the user name.
See also: AWS API Documentation
Request Syntax
client.describe_user(
UserName='string',
AwsAccountId='string',
Namespace='string'
)
string
[REQUIRED]
The name of the user that you want to describe.
string
[REQUIRED]
The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
string
[REQUIRED]
The namespace. Currently, you should set this to default .
dict
Response Syntax
{
'User': {
'Arn': 'string',
'UserName': 'string',
'Email': 'string',
'Role': 'ADMIN'|'AUTHOR'|'READER'|'RESTRICTED_AUTHOR'|'RESTRICTED_READER',
'IdentityType': 'IAM'|'QUICKSIGHT'|'IAM_IDENTITY_CENTER',
'Active': True|False,
'PrincipalId': 'string',
'CustomPermissionsName': 'string',
'ExternalLoginFederationProviderType': 'string',
'ExternalLoginFederationProviderUrl': 'string',
'ExternalLoginId': 'string'
},
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
User (dict) --
The user name.
Arn (string) --
The Amazon Resource Name (ARN) for the user.
UserName (string) --
The user's user name. This value is required if you are registering a user that will be managed in Amazon QuickSight. In the output, the value for UserName is N/A when the value for IdentityType is IAM and the corresponding IAM user is deleted.
Email (string) --
The user's email address.
Role (string) --
The Amazon QuickSight role for the user. The user role can be one of the following:.
READER : A user who has read-only access to dashboards.
AUTHOR : A user who can create data sources, datasets, analyses, and dashboards.
ADMIN : A user who is an author, who can also manage Amazon Amazon QuickSight settings.
RESTRICTED_READER : This role isn't currently available for use.
RESTRICTED_AUTHOR : This role isn't currently available for use.
IdentityType (string) --
The type of identity authentication used by the user.
Active (boolean) --
The active status of user. When you create an Amazon QuickSight user that's not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a password.
PrincipalId (string) --
The principal ID of the user.
CustomPermissionsName (string) --
The custom permissions profile associated with this user.
ExternalLoginFederationProviderType (string) --
The type of supported external login provider that provides identity to let the user federate into Amazon QuickSight with an associated IAM role. The type can be one of the following.
COGNITO : Amazon Cognito. The provider URL is cognito-identity.amazonaws.com.
CUSTOM_OIDC : Custom OpenID Connect (OIDC) provider.
ExternalLoginFederationProviderUrl (string) --
The URL of the external login provider.
ExternalLoginId (string) --
The identity ID for the user in the external login provider.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'UserList': {'IdentityType': {'IAM_IDENTITY_CENTER'}}}
Returns a list of all of the Amazon QuickSight users belonging to this account.
See also: AWS API Documentation
Request Syntax
client.list_users(
AwsAccountId='string',
NextToken='string',
MaxResults=123,
Namespace='string'
)
string
[REQUIRED]
The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
string
A pagination token that can be used in a subsequent request.
integer
The maximum number of results to return from this request.
string
[REQUIRED]
The namespace. Currently, you should set this to default .
dict
Response Syntax
{
'UserList': [
{
'Arn': 'string',
'UserName': 'string',
'Email': 'string',
'Role': 'ADMIN'|'AUTHOR'|'READER'|'RESTRICTED_AUTHOR'|'RESTRICTED_READER',
'IdentityType': 'IAM'|'QUICKSIGHT'|'IAM_IDENTITY_CENTER',
'Active': True|False,
'PrincipalId': 'string',
'CustomPermissionsName': 'string',
'ExternalLoginFederationProviderType': 'string',
'ExternalLoginFederationProviderUrl': 'string',
'ExternalLoginId': 'string'
},
],
'NextToken': 'string',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
UserList (list) --
The list of users.
(dict) --
A registered user of Amazon QuickSight.
Arn (string) --
The Amazon Resource Name (ARN) for the user.
UserName (string) --
The user's user name. This value is required if you are registering a user that will be managed in Amazon QuickSight. In the output, the value for UserName is N/A when the value for IdentityType is IAM and the corresponding IAM user is deleted.
Email (string) --
The user's email address.
Role (string) --
The Amazon QuickSight role for the user. The user role can be one of the following:.
READER : A user who has read-only access to dashboards.
AUTHOR : A user who can create data sources, datasets, analyses, and dashboards.
ADMIN : A user who is an author, who can also manage Amazon Amazon QuickSight settings.
RESTRICTED_READER : This role isn't currently available for use.
RESTRICTED_AUTHOR : This role isn't currently available for use.
IdentityType (string) --
The type of identity authentication used by the user.
Active (boolean) --
The active status of user. When you create an Amazon QuickSight user that's not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a password.
PrincipalId (string) --
The principal ID of the user.
CustomPermissionsName (string) --
The custom permissions profile associated with this user.
ExternalLoginFederationProviderType (string) --
The type of supported external login provider that provides identity to let the user federate into Amazon QuickSight with an associated IAM role. The type can be one of the following.
COGNITO : Amazon Cognito. The provider URL is cognito-identity.amazonaws.com.
CUSTOM_OIDC : Custom OpenID Connect (OIDC) provider.
ExternalLoginFederationProviderUrl (string) --
The URL of the external login provider.
ExternalLoginId (string) --
The identity ID for the user in the external login provider.
NextToken (string) --
A pagination token that can be used in a subsequent request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'IdentityType': {'IAM_IDENTITY_CENTER'}}
Response {'User': {'IdentityType': {'IAM_IDENTITY_CENTER'}}}
Creates an Amazon QuickSight user whose identity is associated with the Identity and Access Management (IAM) identity or role specified in the request. When you register a new user from the Amazon QuickSight API, Amazon QuickSight generates a registration URL. The user accesses this registration URL to create their account. Amazon QuickSight doesn't send a registration email to users who are registered from the Amazon QuickSight API. If you want new users to receive a registration email, then add those users in the Amazon QuickSight console. For more information on registering a new user in the Amazon QuickSight console, see Inviting users to access Amazon QuickSight.
See also: AWS API Documentation
Request Syntax
client.register_user(
IdentityType='IAM'|'QUICKSIGHT'|'IAM_IDENTITY_CENTER',
Email='string',
UserRole='ADMIN'|'AUTHOR'|'READER'|'RESTRICTED_AUTHOR'|'RESTRICTED_READER',
IamArn='string',
SessionName='string',
AwsAccountId='string',
Namespace='string',
UserName='string',
CustomPermissionsName='string',
ExternalLoginFederationProviderType='string',
CustomFederationProviderUrl='string',
ExternalLoginId='string'
)
string
[REQUIRED]
Amazon QuickSight supports several ways of managing the identity of users. This parameter accepts two values:
IAM : A user whose identity maps to an existing IAM user or role.
QUICKSIGHT : A user whose identity is owned and managed internally by Amazon QuickSight.
string
[REQUIRED]
The email address of the user that you want to register.
string
[REQUIRED]
The Amazon QuickSight role for the user. The user role can be one of the following:
READER : A user who has read-only access to dashboards.
AUTHOR : A user who can create data sources, datasets, analyses, and dashboards.
ADMIN : A user who is an author, who can also manage Amazon QuickSight settings.
RESTRICTED_READER : This role isn't currently available for use.
RESTRICTED_AUTHOR : This role isn't currently available for use.
string
The ARN of the IAM user or role that you are registering with Amazon QuickSight.
string
You need to use this parameter only when you register one or more users using an assumed IAM role. You don't need to provide the session name for other scenarios, for example when you are registering an IAM user or an Amazon QuickSight user. You can register multiple users using the same IAM role if each user has a different session name. For more information on assuming IAM roles, see assume-role in the CLI Reference.
string
[REQUIRED]
The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
string
[REQUIRED]
The namespace. Currently, you should set this to default .
string
The Amazon QuickSight user name that you want to create for the user you are registering.
string
(Enterprise edition only) The name of the custom permissions profile that you want to assign to this user. Customized permissions allows you to control a user's access by restricting access the following operations:
Create and update data sources
Create and update datasets
Create and update email reports
Subscribe to email reports
To add custom permissions to an existing user, use UpdateUser instead.
A set of custom permissions includes any combination of these restrictions. Currently, you need to create the profile names for custom permission sets by using the Amazon QuickSight console. Then, you use the RegisterUser API operation to assign the named set of permissions to a Amazon QuickSight user.
Amazon QuickSight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning Amazon QuickSight users to one of the default security cohorts in Amazon QuickSight (admin, author, reader).
This feature is available only to Amazon QuickSight Enterprise edition subscriptions.
string
The type of supported external login provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. The type of supported external login provider can be one of the following.
COGNITO : Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the COGNITO provider type, don’t use the "CustomFederationProviderUrl" parameter which is only needed when the external provider is custom.
CUSTOM_OIDC : Custom OpenID Connect (OIDC) provider. When choosing CUSTOM_OIDC type, use the CustomFederationProviderUrl parameter to provide the custom OIDC provider URL.
string
The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. This parameter should only be used when ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC .
string
The identity ID for a user in the external login provider.
dict
Response Syntax
{
'User': {
'Arn': 'string',
'UserName': 'string',
'Email': 'string',
'Role': 'ADMIN'|'AUTHOR'|'READER'|'RESTRICTED_AUTHOR'|'RESTRICTED_READER',
'IdentityType': 'IAM'|'QUICKSIGHT'|'IAM_IDENTITY_CENTER',
'Active': True|False,
'PrincipalId': 'string',
'CustomPermissionsName': 'string',
'ExternalLoginFederationProviderType': 'string',
'ExternalLoginFederationProviderUrl': 'string',
'ExternalLoginId': 'string'
},
'UserInvitationUrl': 'string',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
User (dict) --
The user's user name.
Arn (string) --
The Amazon Resource Name (ARN) for the user.
UserName (string) --
The user's user name. This value is required if you are registering a user that will be managed in Amazon QuickSight. In the output, the value for UserName is N/A when the value for IdentityType is IAM and the corresponding IAM user is deleted.
Email (string) --
The user's email address.
Role (string) --
The Amazon QuickSight role for the user. The user role can be one of the following:.
READER : A user who has read-only access to dashboards.
AUTHOR : A user who can create data sources, datasets, analyses, and dashboards.
ADMIN : A user who is an author, who can also manage Amazon Amazon QuickSight settings.
RESTRICTED_READER : This role isn't currently available for use.
RESTRICTED_AUTHOR : This role isn't currently available for use.
IdentityType (string) --
The type of identity authentication used by the user.
Active (boolean) --
The active status of user. When you create an Amazon QuickSight user that's not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a password.
PrincipalId (string) --
The principal ID of the user.
CustomPermissionsName (string) --
The custom permissions profile associated with this user.
ExternalLoginFederationProviderType (string) --
The type of supported external login provider that provides identity to let the user federate into Amazon QuickSight with an associated IAM role. The type can be one of the following.
COGNITO : Amazon Cognito. The provider URL is cognito-identity.amazonaws.com.
CUSTOM_OIDC : Custom OpenID Connect (OIDC) provider.
ExternalLoginFederationProviderUrl (string) --
The URL of the external login provider.
ExternalLoginId (string) --
The identity ID for the user in the external login provider.
UserInvitationUrl (string) --
The URL the user visits to complete registration and provide a password. This is returned only for users with an identity type of QUICKSIGHT .
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'Definition': {'Sheets': {'Visuals': {'PivotTableVisual': {'ChartConfiguration': {'TableOptions': {'CellStyle': {'VerticalTextAlignment': {'AUTO'}},
'ColumnHeaderStyle': {'VerticalTextAlignment': {'AUTO'}},
'DefaultCellWidth': 'string',
'RowAlternateColorOptions': {'UsePrimaryBackgroundColor': 'ENABLED '
'| '
'DISABLED'},
'RowFieldNamesStyle': {'VerticalTextAlignment': {'AUTO'}},
'RowHeaderStyle': {'VerticalTextAlignment': {'AUTO'}},
'RowsLabelOptions': {'CustomLabel': 'string',
'Visibility': 'HIDDEN '
'| '
'VISIBLE'},
'RowsLayout': 'TABULAR '
'| '
'HIERARCHY'},
'TotalOptions': {'ColumnSubtotalOptions': {'MetricHeaderCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'StyleTargets': [{'CellType': 'TOTAL '
'| '
'METRIC_HEADER '
'| '
'VALUE'}],
'TotalCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'ValueCellStyle': {'VerticalTextAlignment': {'AUTO'}}},
'ColumnTotalOptions': {'MetricHeaderCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'TotalCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'ValueCellStyle': {'VerticalTextAlignment': {'AUTO'}}},
'RowSubtotalOptions': {'MetricHeaderCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'StyleTargets': [{'CellType': 'TOTAL '
'| '
'METRIC_HEADER '
'| '
'VALUE'}],
'TotalCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'ValueCellStyle': {'VerticalTextAlignment': {'AUTO'}}},
'RowTotalOptions': {'MetricHeaderCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'TotalCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'ValueCellStyle': {'VerticalTextAlignment': {'AUTO'}}}}}},
'TableVisual': {'ChartConfiguration': {'TableOptions': {'CellStyle': {'VerticalTextAlignment': {'AUTO'}},
'HeaderStyle': {'VerticalTextAlignment': {'AUTO'}},
'RowAlternateColorOptions': {'UsePrimaryBackgroundColor': 'ENABLED '
'| '
'DISABLED'}},
'TotalOptions': {'TotalCellStyle': {'VerticalTextAlignment': {'AUTO'}}}}}}}}}
Updates an analysis in Amazon QuickSight
See also: AWS API Documentation
Request Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.Parameters
# This section is too large to render. # Please see the AWS API Documentation linked below.
dict
Response Syntax
{
'Arn': 'string',
'AnalysisId': 'string',
'UpdateStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
Arn (string) --
The ARN of the analysis that you're updating.
AnalysisId (string) --
The ID of the analysis.
UpdateStatus (string) --
The update status of the last update that was made to the analysis.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'Definition': {'Sheets': {'Visuals': {'PivotTableVisual': {'ChartConfiguration': {'TableOptions': {'CellStyle': {'VerticalTextAlignment': {'AUTO'}},
'ColumnHeaderStyle': {'VerticalTextAlignment': {'AUTO'}},
'DefaultCellWidth': 'string',
'RowAlternateColorOptions': {'UsePrimaryBackgroundColor': 'ENABLED '
'| '
'DISABLED'},
'RowFieldNamesStyle': {'VerticalTextAlignment': {'AUTO'}},
'RowHeaderStyle': {'VerticalTextAlignment': {'AUTO'}},
'RowsLabelOptions': {'CustomLabel': 'string',
'Visibility': 'HIDDEN '
'| '
'VISIBLE'},
'RowsLayout': 'TABULAR '
'| '
'HIERARCHY'},
'TotalOptions': {'ColumnSubtotalOptions': {'MetricHeaderCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'StyleTargets': [{'CellType': 'TOTAL '
'| '
'METRIC_HEADER '
'| '
'VALUE'}],
'TotalCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'ValueCellStyle': {'VerticalTextAlignment': {'AUTO'}}},
'ColumnTotalOptions': {'MetricHeaderCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'TotalCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'ValueCellStyle': {'VerticalTextAlignment': {'AUTO'}}},
'RowSubtotalOptions': {'MetricHeaderCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'StyleTargets': [{'CellType': 'TOTAL '
'| '
'METRIC_HEADER '
'| '
'VALUE'}],
'TotalCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'ValueCellStyle': {'VerticalTextAlignment': {'AUTO'}}},
'RowTotalOptions': {'MetricHeaderCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'TotalCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'ValueCellStyle': {'VerticalTextAlignment': {'AUTO'}}}}}},
'TableVisual': {'ChartConfiguration': {'TableOptions': {'CellStyle': {'VerticalTextAlignment': {'AUTO'}},
'HeaderStyle': {'VerticalTextAlignment': {'AUTO'}},
'RowAlternateColorOptions': {'UsePrimaryBackgroundColor': 'ENABLED '
'| '
'DISABLED'}},
'TotalOptions': {'TotalCellStyle': {'VerticalTextAlignment': {'AUTO'}}}}}}}}}
Updates a dashboard in an Amazon Web Services account.
Note
Updating a Dashboard creates a new dashboard version but does not immediately publish the new version. You can update the published version of a dashboard by using the UpdateDashboardPublishedVersion API operation.
See also: AWS API Documentation
Request Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.Parameters
# This section is too large to render. # Please see the AWS API Documentation linked below.
dict
Response Syntax
{
'Arn': 'string',
'VersionArn': 'string',
'DashboardId': 'string',
'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) of the resource.
VersionArn (string) --
The ARN of the dashboard, including the version number.
DashboardId (string) --
The ID for the dashboard.
CreationStatus (string) --
The creation status of the request.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'Definition': {'Sheets': {'Visuals': {'PivotTableVisual': {'ChartConfiguration': {'TableOptions': {'CellStyle': {'VerticalTextAlignment': {'AUTO'}},
'ColumnHeaderStyle': {'VerticalTextAlignment': {'AUTO'}},
'DefaultCellWidth': 'string',
'RowAlternateColorOptions': {'UsePrimaryBackgroundColor': 'ENABLED '
'| '
'DISABLED'},
'RowFieldNamesStyle': {'VerticalTextAlignment': {'AUTO'}},
'RowHeaderStyle': {'VerticalTextAlignment': {'AUTO'}},
'RowsLabelOptions': {'CustomLabel': 'string',
'Visibility': 'HIDDEN '
'| '
'VISIBLE'},
'RowsLayout': 'TABULAR '
'| '
'HIERARCHY'},
'TotalOptions': {'ColumnSubtotalOptions': {'MetricHeaderCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'StyleTargets': [{'CellType': 'TOTAL '
'| '
'METRIC_HEADER '
'| '
'VALUE'}],
'TotalCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'ValueCellStyle': {'VerticalTextAlignment': {'AUTO'}}},
'ColumnTotalOptions': {'MetricHeaderCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'TotalCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'ValueCellStyle': {'VerticalTextAlignment': {'AUTO'}}},
'RowSubtotalOptions': {'MetricHeaderCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'StyleTargets': [{'CellType': 'TOTAL '
'| '
'METRIC_HEADER '
'| '
'VALUE'}],
'TotalCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'ValueCellStyle': {'VerticalTextAlignment': {'AUTO'}}},
'RowTotalOptions': {'MetricHeaderCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'TotalCellStyle': {'VerticalTextAlignment': {'AUTO'}},
'ValueCellStyle': {'VerticalTextAlignment': {'AUTO'}}}}}},
'TableVisual': {'ChartConfiguration': {'TableOptions': {'CellStyle': {'VerticalTextAlignment': {'AUTO'}},
'HeaderStyle': {'VerticalTextAlignment': {'AUTO'}},
'RowAlternateColorOptions': {'UsePrimaryBackgroundColor': 'ENABLED '
'| '
'DISABLED'}},
'TotalOptions': {'TotalCellStyle': {'VerticalTextAlignment': {'AUTO'}}}}}}}}}
Updates a template from an existing Amazon QuickSight analysis or another template.
See also: AWS API Documentation
Request Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.Parameters
# This section is too large to render. # Please see the AWS API Documentation linked below.
dict
Response Syntax
{
'TemplateId': 'string',
'Arn': 'string',
'VersionArn': 'string',
'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
TemplateId (string) --
The ID for the template.
Arn (string) --
The Amazon Resource Name (ARN) for the template.
VersionArn (string) --
The ARN for the template, including the version information of the first version.
CreationStatus (string) --
The creation status of the template.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'Topic': {'DataSets': {'CalculatedFields': {'Aggregation': {'MEDIAN',
'STDEV',
'STDEVP',
'VAR',
'VARP'},
'NonAdditive': 'boolean'},
'Columns': {'Aggregation': {'MEDIAN',
'STDEV',
'STDEVP',
'VAR',
'VARP'},
'NonAdditive': 'boolean'}}}}
Updates a topic.
See also: AWS API Documentation
Request Syntax
client.update_topic(
AwsAccountId='string',
TopicId='string',
Topic={
'Name': 'string',
'Description': 'string',
'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'
}
}
},
]
},
]
},
]
}
)
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.
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) --
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.
{'User': {'IdentityType': {'IAM_IDENTITY_CENTER'}}}
Updates an Amazon QuickSight user.
See also: AWS API Documentation
Request Syntax
client.update_user(
UserName='string',
AwsAccountId='string',
Namespace='string',
Email='string',
Role='ADMIN'|'AUTHOR'|'READER'|'RESTRICTED_AUTHOR'|'RESTRICTED_READER',
CustomPermissionsName='string',
UnapplyCustomPermissions=True|False,
ExternalLoginFederationProviderType='string',
CustomFederationProviderUrl='string',
ExternalLoginId='string'
)
string
[REQUIRED]
The Amazon QuickSight user name that you want to update.
string
[REQUIRED]
The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
string
[REQUIRED]
The namespace. Currently, you should set this to default .
string
[REQUIRED]
The email address of the user that you want to update.
string
[REQUIRED]
The Amazon QuickSight role of the user. The role can be one of the following default security cohorts:
READER : A user who has read-only access to dashboards.
AUTHOR : A user who can create data sources, datasets, analyses, and dashboards.
ADMIN : A user who is an author, who can also manage Amazon QuickSight settings.
The name of the Amazon QuickSight role is invisible to the user except for the console screens dealing with permissions.
string
(Enterprise edition only) The name of the custom permissions profile that you want to assign to this user. Customized permissions allows you to control a user's access by restricting access the following operations:
Create and update data sources
Create and update datasets
Create and update email reports
Subscribe to email reports
A set of custom permissions includes any combination of these restrictions. Currently, you need to create the profile names for custom permission sets by using the Amazon QuickSight console. Then, you use the RegisterUser API operation to assign the named set of permissions to a Amazon QuickSight user.
Amazon QuickSight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning Amazon QuickSight users to one of the default security cohorts in Amazon QuickSight (admin, author, reader).
This feature is available only to Amazon QuickSight Enterprise edition subscriptions.
boolean
A flag that you use to indicate that you want to remove all custom permissions from this user. Using this parameter resets the user to the state it was in before a custom permissions profile was applied. This parameter defaults to NULL and it doesn't accept any other value.
string
The type of supported external login provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. The type of supported external login provider can be one of the following.
COGNITO : Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the COGNITO provider type, don’t use the "CustomFederationProviderUrl" parameter which is only needed when the external provider is custom.
CUSTOM_OIDC : Custom OpenID Connect (OIDC) provider. When choosing CUSTOM_OIDC type, use the CustomFederationProviderUrl parameter to provide the custom OIDC provider URL.
NONE : This clears all the previously saved external login information for a user. Use the DescribeUser API operation to check the external login information.
string
The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. This parameter should only be used when ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC .
string
The identity ID for a user in the external login provider.
dict
Response Syntax
{
'User': {
'Arn': 'string',
'UserName': 'string',
'Email': 'string',
'Role': 'ADMIN'|'AUTHOR'|'READER'|'RESTRICTED_AUTHOR'|'RESTRICTED_READER',
'IdentityType': 'IAM'|'QUICKSIGHT'|'IAM_IDENTITY_CENTER',
'Active': True|False,
'PrincipalId': 'string',
'CustomPermissionsName': 'string',
'ExternalLoginFederationProviderType': 'string',
'ExternalLoginFederationProviderUrl': 'string',
'ExternalLoginId': 'string'
},
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
User (dict) --
The Amazon QuickSight user.
Arn (string) --
The Amazon Resource Name (ARN) for the user.
UserName (string) --
The user's user name. This value is required if you are registering a user that will be managed in Amazon QuickSight. In the output, the value for UserName is N/A when the value for IdentityType is IAM and the corresponding IAM user is deleted.
Email (string) --
The user's email address.
Role (string) --
The Amazon QuickSight role for the user. The user role can be one of the following:.
READER : A user who has read-only access to dashboards.
AUTHOR : A user who can create data sources, datasets, analyses, and dashboards.
ADMIN : A user who is an author, who can also manage Amazon Amazon QuickSight settings.
RESTRICTED_READER : This role isn't currently available for use.
RESTRICTED_AUTHOR : This role isn't currently available for use.
IdentityType (string) --
The type of identity authentication used by the user.
Active (boolean) --
The active status of user. When you create an Amazon QuickSight user that's not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a password.
PrincipalId (string) --
The principal ID of the user.
CustomPermissionsName (string) --
The custom permissions profile associated with this user.
ExternalLoginFederationProviderType (string) --
The type of supported external login provider that provides identity to let the user federate into Amazon QuickSight with an associated IAM role. The type can be one of the following.
COGNITO : Amazon Cognito. The provider URL is cognito-identity.amazonaws.com.
CUSTOM_OIDC : Custom OpenID Connect (OIDC) provider.
ExternalLoginFederationProviderUrl (string) --
The URL of the external login provider.
ExternalLoginId (string) --
The identity ID for the user in the external login provider.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.