2023/11/02 - Amazon QuickSight - 15 updated api methods
Changes Got confirmed from qmeixua@ about custom week features, and tested locally with aws cli and java sdk that the subtypes are showing up.
{'Definition': {'Options': {'Timezone': 'string',
'WeekStart': 'SUNDAY | MONDAY | TUESDAY | '
'WEDNESDAY | THURSDAY | FRIDAY | '
'SATURDAY'}}}
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': {'Options': {'Timezone': 'string',
'WeekStart': 'SUNDAY | MONDAY | TUESDAY | '
'WEDNESDAY | THURSDAY | FRIDAY | '
'SATURDAY'}}}
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.
{'LogicalTableMap': {'DataTransforms': {'CastColumnTypeOperation': {'SubType': 'FLOAT '
'| '
'FIXED'}}},
'PhysicalTableMap': {'CustomSql': {'Columns': {'SubType': 'FLOAT | FIXED'}},
'RelationalTable': {'InputColumns': {'SubType': 'FLOAT | '
'FIXED'}},
'S3Source': {'InputColumns': {'SubType': 'FLOAT | '
'FIXED'}}}}
Creates a dataset. This operation doesn't support datasets that include uploaded files as a source.
See also: AWS API Documentation
Request Syntax
client.create_data_set(
AwsAccountId='string',
DataSetId='string',
Name='string',
PhysicalTableMap={
'string': {
'RelationalTable': {
'DataSourceArn': 'string',
'Catalog': 'string',
'Schema': 'string',
'Name': 'string',
'InputColumns': [
{
'Name': 'string',
'Type': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME'|'BIT'|'BOOLEAN'|'JSON',
'SubType': 'FLOAT'|'FIXED'
},
]
},
'CustomSql': {
'DataSourceArn': 'string',
'Name': 'string',
'SqlQuery': 'string',
'Columns': [
{
'Name': 'string',
'Type': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME'|'BIT'|'BOOLEAN'|'JSON',
'SubType': 'FLOAT'|'FIXED'
},
]
},
'S3Source': {
'DataSourceArn': 'string',
'UploadSettings': {
'Format': 'CSV'|'TSV'|'CLF'|'ELF'|'XLSX'|'JSON',
'StartFromRow': 123,
'ContainsHeader': True|False,
'TextQualifier': 'DOUBLE_QUOTE'|'SINGLE_QUOTE',
'Delimiter': 'string'
},
'InputColumns': [
{
'Name': 'string',
'Type': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME'|'BIT'|'BOOLEAN'|'JSON',
'SubType': 'FLOAT'|'FIXED'
},
]
}
}
},
LogicalTableMap={
'string': {
'Alias': 'string',
'DataTransforms': [
{
'ProjectOperation': {
'ProjectedColumns': [
'string',
]
},
'FilterOperation': {
'ConditionExpression': 'string'
},
'CreateColumnsOperation': {
'Columns': [
{
'ColumnName': 'string',
'ColumnId': 'string',
'Expression': 'string'
},
]
},
'RenameColumnOperation': {
'ColumnName': 'string',
'NewColumnName': 'string'
},
'CastColumnTypeOperation': {
'ColumnName': 'string',
'NewColumnType': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME',
'SubType': 'FLOAT'|'FIXED',
'Format': 'string'
},
'TagColumnOperation': {
'ColumnName': 'string',
'Tags': [
{
'ColumnGeographicRole': 'COUNTRY'|'STATE'|'COUNTY'|'CITY'|'POSTCODE'|'LONGITUDE'|'LATITUDE',
'ColumnDescription': {
'Text': 'string'
}
},
]
},
'UntagColumnOperation': {
'ColumnName': 'string',
'TagNames': [
'COLUMN_GEOGRAPHIC_ROLE'|'COLUMN_DESCRIPTION',
]
},
'OverrideDatasetParameterOperation': {
'ParameterName': 'string',
'NewParameterName': 'string',
'NewDefaultValues': {
'StringStaticValues': [
'string',
],
'DecimalStaticValues': [
123.0,
],
'DateTimeStaticValues': [
datetime(2015, 1, 1),
],
'IntegerStaticValues': [
123,
]
}
}
},
],
'Source': {
'JoinInstruction': {
'LeftOperand': 'string',
'RightOperand': 'string',
'LeftJoinKeyProperties': {
'UniqueKey': True|False
},
'RightJoinKeyProperties': {
'UniqueKey': True|False
},
'Type': 'INNER'|'OUTER'|'LEFT'|'RIGHT',
'OnClause': 'string'
},
'PhysicalTableId': 'string',
'DataSetArn': 'string'
}
}
},
ImportMode='SPICE'|'DIRECT_QUERY',
ColumnGroups=[
{
'GeoSpatialColumnGroup': {
'Name': 'string',
'CountryCode': 'US',
'Columns': [
'string',
]
}
},
],
FieldFolders={
'string': {
'description': 'string',
'columns': [
'string',
]
}
},
Permissions=[
{
'Principal': 'string',
'Actions': [
'string',
]
},
],
RowLevelPermissionDataSet={
'Namespace': 'string',
'Arn': 'string',
'PermissionPolicy': 'GRANT_ACCESS'|'DENY_ACCESS',
'FormatVersion': 'VERSION_1'|'VERSION_2',
'Status': 'ENABLED'|'DISABLED'
},
RowLevelPermissionTagConfiguration={
'Status': 'ENABLED'|'DISABLED',
'TagRules': [
{
'TagKey': 'string',
'ColumnName': 'string',
'TagMultiValueDelimiter': 'string',
'MatchAllValue': 'string'
},
],
'TagRuleConfigurations': [
[
'string',
],
]
},
ColumnLevelPermissionRules=[
{
'Principals': [
'string',
],
'ColumnNames': [
'string',
]
},
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
DataSetUsageConfiguration={
'DisableUseAsDirectQuerySource': True|False,
'DisableUseAsImportedSource': True|False
},
DatasetParameters=[
{
'StringDatasetParameter': {
'Id': 'string',
'Name': 'string',
'ValueType': 'MULTI_VALUED'|'SINGLE_VALUED',
'DefaultValues': {
'StaticValues': [
'string',
]
}
},
'DecimalDatasetParameter': {
'Id': 'string',
'Name': 'string',
'ValueType': 'MULTI_VALUED'|'SINGLE_VALUED',
'DefaultValues': {
'StaticValues': [
123.0,
]
}
},
'IntegerDatasetParameter': {
'Id': 'string',
'Name': 'string',
'ValueType': 'MULTI_VALUED'|'SINGLE_VALUED',
'DefaultValues': {
'StaticValues': [
123,
]
}
},
'DateTimeDatasetParameter': {
'Id': 'string',
'Name': 'string',
'ValueType': 'MULTI_VALUED'|'SINGLE_VALUED',
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'DefaultValues': {
'StaticValues': [
datetime(2015, 1, 1),
]
}
}
},
],
FolderArns=[
'string',
]
)
string
[REQUIRED]
The Amazon Web Services account ID.
string
[REQUIRED]
An ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
string
[REQUIRED]
The display name for the dataset.
dict
[REQUIRED]
Declares the physical tables that are available in the underlying data sources.
(string) --
(dict) --
A view of a data source that contains information about the shape of the data in the underlying source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
RelationalTable (dict) --
A physical table type for relational data sources.
DataSourceArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the data source.
Catalog (string) --
The catalog associated with a table.
Schema (string) --
The schema name. This name applies to certain relational database engines.
Name (string) -- [REQUIRED]
The name of the relational table.
InputColumns (list) -- [REQUIRED]
The column schema of the table.
(dict) --
Metadata for a column that is used as the input of a transform operation.
Name (string) -- [REQUIRED]
The name of this column in the underlying data source.
Type (string) -- [REQUIRED]
The data type of the column.
SubType (string) --
The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset.
CustomSql (dict) --
A physical table type built from the results of the custom SQL query.
DataSourceArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the data source.
Name (string) -- [REQUIRED]
A display name for the SQL query result.
SqlQuery (string) -- [REQUIRED]
The SQL query.
Columns (list) --
The column schema from the SQL query result set.
(dict) --
Metadata for a column that is used as the input of a transform operation.
Name (string) -- [REQUIRED]
The name of this column in the underlying data source.
Type (string) -- [REQUIRED]
The data type of the column.
SubType (string) --
The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset.
S3Source (dict) --
A physical table type for as S3 data source.
DataSourceArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the data source.
UploadSettings (dict) --
Information about the format for the S3 source file or files.
Format (string) --
File format.
StartFromRow (integer) --
A row number to start reading data from.
ContainsHeader (boolean) --
Whether the file has a header row, or the files each have a header row.
TextQualifier (string) --
Text qualifier.
Delimiter (string) --
The delimiter between values in the file.
InputColumns (list) -- [REQUIRED]
A physical table type for an S3 data source.
Note
For files that aren't JSON, only STRING data types are supported in input columns.
(dict) --
Metadata for a column that is used as the input of a transform operation.
Name (string) -- [REQUIRED]
The name of this column in the underlying data source.
Type (string) -- [REQUIRED]
The data type of the column.
SubType (string) --
The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset.
dict
Configures the combination and transformation of the data from the physical tables.
(string) --
An identifier for the logical table that is defined in the dataset
(dict) --
A logical table is a unit that joins and that data transformations operate on. A logical table has a source, which can be either a physical table or result of a join. When a logical table points to a physical table, the logical table acts as a mutable copy of that physical table through transform operations.
Alias (string) -- [REQUIRED]
A display name for the logical table.
DataTransforms (list) --
Transform operations that act on this logical table. For this structure to be valid, only one of the attributes can be non-null.
(dict) --
A data transformation on a logical table. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
ProjectOperation (dict) --
An operation that projects columns. Operations that come after a projection can only refer to projected columns.
ProjectedColumns (list) -- [REQUIRED]
Projected columns.
(string) --
FilterOperation (dict) --
An operation that filters rows based on some condition.
ConditionExpression (string) -- [REQUIRED]
An expression that must evaluate to a Boolean value. Rows for which the expression evaluates to true are kept in the dataset.
CreateColumnsOperation (dict) --
An operation that creates calculated columns. Columns created in one such operation form a lexical closure.
Columns (list) -- [REQUIRED]
Calculated columns to create.
(dict) --
A calculated column for a dataset.
ColumnName (string) -- [REQUIRED]
Column name.
ColumnId (string) -- [REQUIRED]
A unique ID to identify a calculated column. During a dataset update, if the column ID of a calculated column matches that of an existing calculated column, Amazon QuickSight preserves the existing calculated column.
Expression (string) -- [REQUIRED]
An expression that defines the calculated column.
RenameColumnOperation (dict) --
An operation that renames a column.
ColumnName (string) -- [REQUIRED]
The name of the column to be renamed.
NewColumnName (string) -- [REQUIRED]
The new name for the column.
CastColumnTypeOperation (dict) --
A transform operation that casts a column to a different type.
ColumnName (string) -- [REQUIRED]
Column name.
NewColumnType (string) -- [REQUIRED]
New column data type.
SubType (string) --
The sub data type of the new column. Sub types are only available for decimal columns that are part of a SPICE dataset.
Format (string) --
When casting a column from string to datetime type, you can supply a string in a format supported by Amazon QuickSight to denote the source data format.
TagColumnOperation (dict) --
An operation that tags a column with additional information.
ColumnName (string) -- [REQUIRED]
The column that this operation acts on.
Tags (list) -- [REQUIRED]
The dataset column tag, currently only used for geospatial type tagging.
Note
This is not tags for the Amazon Web Services tagging feature.
(dict) --
A tag for a column in a TagColumnOperation structure. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
ColumnGeographicRole (string) --
A geospatial role for a column.
ColumnDescription (dict) --
A description for a column.
Text (string) --
The text of a description for a column.
UntagColumnOperation (dict) --
A transform operation that removes tags associated with a column.
ColumnName (string) -- [REQUIRED]
The column that this operation acts on.
TagNames (list) -- [REQUIRED]
The column tags to remove from this column.
(string) --
OverrideDatasetParameterOperation (dict) --
A transform operation that overrides the dataset parameter values that are defined in another dataset.
ParameterName (string) -- [REQUIRED]
The name of the parameter to be overridden with different values.
NewParameterName (string) --
The new name for the parameter.
NewDefaultValues (dict) --
The new default values for the parameter.
StringStaticValues (list) --
A list of static default values for a given string parameter.
(string) --
The default value for the string parameter.
DecimalStaticValues (list) --
A list of static default values for a given decimal parameter.
(float) --
The default value for the decimal parameter.
DateTimeStaticValues (list) --
A list of static default values for a given date time parameter.
(datetime) --
The default value for the date time parameter.
IntegerStaticValues (list) --
A list of static default values for a given integer parameter.
(integer) --
The default value for the integer parameter.
Source (dict) -- [REQUIRED]
Source of this logical table.
JoinInstruction (dict) --
Specifies the result of a join of two logical tables.
LeftOperand (string) -- [REQUIRED]
The operand on the left side of a join.
RightOperand (string) -- [REQUIRED]
The operand on the right side of a join.
LeftJoinKeyProperties (dict) --
Join key properties of the left operand.
UniqueKey (boolean) --
A value that indicates that a row in a table is uniquely identified by the columns in a join key. This is used by Amazon QuickSight to optimize query performance.
RightJoinKeyProperties (dict) --
Join key properties of the right operand.
UniqueKey (boolean) --
A value that indicates that a row in a table is uniquely identified by the columns in a join key. This is used by Amazon QuickSight to optimize query performance.
Type (string) -- [REQUIRED]
The type of join that it is.
OnClause (string) -- [REQUIRED]
The join instructions provided in the ON clause of a join.
PhysicalTableId (string) --
Physical table ID.
DataSetArn (string) --
The Amazon Resource Number (ARN) of the parent dataset.
string
[REQUIRED]
Indicates whether you want to import the data into SPICE.
list
Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.
(dict) --
Groupings of columns that work together in certain Amazon QuickSight features. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
GeoSpatialColumnGroup (dict) --
Geospatial column group that denotes a hierarchy.
Name (string) -- [REQUIRED]
A display name for the hierarchy.
CountryCode (string) --
Country code.
Columns (list) -- [REQUIRED]
Columns in this hierarchy.
(string) --
dict
The folder that contains fields and nested subfolders for your dataset.
(string) --
(dict) --
A FieldFolder element is a folder that contains fields and nested subfolders.
description (string) --
The description for a field folder.
columns (list) --
A folder has a list of columns. A column can only be in one folder.
(string) --
list
A list of resource permissions on the dataset.
(dict) --
Permission for the resource.
Principal (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the principal. This can be one of the following:
The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)
The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)
The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.)
Actions (list) -- [REQUIRED]
The IAM action to grant or revoke permissions on.
(string) --
dict
The row-level security configuration for the data that you want to create.
Namespace (string) --
The namespace associated with the dataset that contains permissions for RLS.
Arn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.
PermissionPolicy (string) -- [REQUIRED]
The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS is included for backward compatibility only.
FormatVersion (string) --
The user or group rules associated with the dataset that contains permissions for RLS.
By default, FormatVersion is VERSION_1 . When FormatVersion is VERSION_1 , UserName and GroupName are required. When FormatVersion is VERSION_2 , UserARN and GroupARN are required, and Namespace must not exist.
Status (string) --
The status of the row-level security permission dataset. If enabled, the status is ENABLED . If disabled, the status is DISABLED .
dict
The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only.
Status (string) --
The status of row-level security tags. If enabled, the status is ENABLED . If disabled, the status is DISABLED .
TagRules (list) -- [REQUIRED]
A set of rules associated with row-level security, such as the tag names and columns that they are assigned to.
(dict) --
A set of rules associated with a tag.
TagKey (string) -- [REQUIRED]
The unique key for a tag.
ColumnName (string) -- [REQUIRED]
The column name that a tag key is assigned to.
TagMultiValueDelimiter (string) --
A string that you want to use to delimit the values when you pass the values at run time. For example, you can delimit the values with a comma.
MatchAllValue (string) --
A string that you want to use to filter by all the values in a column in the dataset and don’t want to list the values one by one. For example, you can use an asterisk as your match all value.
TagRuleConfigurations (list) --
A list of tag configuration rules to apply to a dataset. All tag configurations have the OR condition. Tags within each tile will be joined (AND). At least one rule in this structure must have all tag values assigned to it to apply Row-level security (RLS) to the dataset.
(list) --
(string) --
list
A set of one or more definitions of a ColumnLevelPermissionRule .
(dict) --
A rule defined to grant access on one or more restricted columns. Each dataset can have multiple rules. To create a restricted column, you add it to one or more rules. Each rule must contain at least one column and at least one user or group. To be able to see a restricted column, a user or group needs to be added to a rule for that column.
Principals (list) --
An array of Amazon Resource Names (ARNs) for Amazon QuickSight users or groups.
(string) --
ColumnNames (list) --
An array of column names.
(string) --
list
Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) -- [REQUIRED]
Tag key.
Value (string) -- [REQUIRED]
Tag value.
dict
The usage configuration to apply to child datasets that reference this dataset as a source.
DisableUseAsDirectQuerySource (boolean) --
An option that controls whether a child dataset of a direct query can use this dataset as a source.
DisableUseAsImportedSource (boolean) --
An option that controls whether a child dataset that's stored in QuickSight can use this dataset as a source.
list
The parameter declarations of the dataset.
(dict) --
A dataset parameter.
StringDatasetParameter (dict) --
A string parameter that is created in the dataset.
Id (string) -- [REQUIRED]
An identifier for the string parameter that is created in the dataset.
Name (string) -- [REQUIRED]
The name of the string parameter that is created in the dataset.
ValueType (string) -- [REQUIRED]
The value type of the dataset parameter. Valid values are single value or multi value .
DefaultValues (dict) --
A list of default values for a given string dataset parameter type. This structure only accepts static values.
StaticValues (list) --
A list of static default values for a given string parameter.
(string) --
The default value for the string parameter.
DecimalDatasetParameter (dict) --
A decimal parameter that is created in the dataset.
Id (string) -- [REQUIRED]
An identifier for the decimal parameter created in the dataset.
Name (string) -- [REQUIRED]
The name of the decimal parameter that is created in the dataset.
ValueType (string) -- [REQUIRED]
The value type of the dataset parameter. Valid values are single value or multi value .
DefaultValues (dict) --
A list of default values for a given decimal parameter. This structure only accepts static values.
StaticValues (list) --
A list of static default values for a given decimal parameter.
(float) --
The default value for the decimal parameter.
IntegerDatasetParameter (dict) --
An integer parameter that is created in the dataset.
Id (string) -- [REQUIRED]
An identifier for the integer parameter created in the dataset.
Name (string) -- [REQUIRED]
The name of the integer parameter that is created in the dataset.
ValueType (string) -- [REQUIRED]
The value type of the dataset parameter. Valid values are single value or multi value .
DefaultValues (dict) --
A list of default values for a given integer parameter. This structure only accepts static values.
StaticValues (list) --
A list of static default values for a given integer parameter.
(integer) --
The default value for the integer parameter.
DateTimeDatasetParameter (dict) --
A date time parameter that is created in the dataset.
Id (string) -- [REQUIRED]
An identifier for the parameter that is created in the dataset.
Name (string) -- [REQUIRED]
The name of the date time parameter that is created in the dataset.
ValueType (string) -- [REQUIRED]
The value type of the dataset parameter. Valid values are single value or multi value .
TimeGranularity (string) --
The time granularity of the date time parameter.
DefaultValues (dict) --
A list of default values for a given date time parameter. This structure only accepts static values.
StaticValues (list) --
A list of static default values for a given date time parameter.
(datetime) --
The default value for the date time parameter.
list
When you create the dataset, Amazon QuickSight adds the dataset to these folders.
(string) --
dict
Response Syntax
{
'Arn': 'string',
'DataSetId': 'string',
'IngestionArn': 'string',
'IngestionId': 'string',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) of the dataset.
DataSetId (string) --
The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
IngestionArn (string) --
The ARN for the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.
IngestionId (string) --
The ID of the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'Definition': {'Options': {'Timezone': 'string',
'WeekStart': 'SUNDAY | MONDAY | TUESDAY | '
'WEDNESDAY | THURSDAY | FRIDAY | '
'SATURDAY'}}}
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.
{'Analysis': {'Options': {'Timezone': 'string',
'WeekStart': 'SUNDAY | MONDAY | TUESDAY | WEDNESDAY '
'| THURSDAY | FRIDAY | SATURDAY'}}}
Provides a summary of the metadata for an analysis.
See also: AWS API Documentation
Request Syntax
client.describe_analysis(
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
{
'Analysis': {
'AnalysisId': 'string',
'Arn': 'string',
'Name': 'string',
'Status': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'Errors': [
{
'Type': 'ACCESS_DENIED'|'SOURCE_NOT_FOUND'|'DATA_SET_NOT_FOUND'|'INTERNAL_FAILURE'|'PARAMETER_VALUE_INCOMPATIBLE'|'PARAMETER_TYPE_INVALID'|'PARAMETER_NOT_FOUND'|'COLUMN_TYPE_MISMATCH'|'COLUMN_GEOGRAPHIC_ROLE_MISMATCH'|'COLUMN_REPLACEMENT_MISSING',
'Message': 'string',
'ViolatedEntities': [
{
'Path': 'string'
},
]
},
],
'DataSetArns': [
'string',
],
'ThemeArn': 'string',
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'Sheets': [
{
'SheetId': 'string',
'Name': 'string'
},
],
'Options': {
'Timezone': 'string',
'WeekStart': 'SUNDAY'|'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY'
}
},
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
Analysis (dict) --
A metadata structure that contains summary information for the analysis that you're describing.
AnalysisId (string) --
The ID of the analysis.
Arn (string) --
The Amazon Resource Name (ARN) of the analysis.
Name (string) --
The descriptive name of the analysis.
Status (string) --
Status associated with the analysis.
Errors (list) --
Errors associated with the analysis.
(dict) --
Analysis error.
Type (string) --
The type of the analysis error.
Message (string) --
The message associated with the analysis error.
ViolatedEntities (list) --
Lists the violated entities that caused the analysis error
(dict) --
An object, structure, or sub-structure of an analysis, template, or dashboard.
Path (string) --
The hierarchical path of the entity within the analysis, template, or dashboard definition tree.
DataSetArns (list) --
The ARNs of the datasets of the analysis.
(string) --
ThemeArn (string) --
The ARN of the theme of the analysis.
CreatedTime (datetime) --
The time that the analysis was created.
LastUpdatedTime (datetime) --
The time that the analysis was last updated.
Sheets (list) --
A list of the associated sheets with the unique identifier and name of each sheet.
(dict) --
A sheet , which is an object that contains a set of visuals that are viewed together on one page in Amazon QuickSight. Every analysis and dashboard contains at least one sheet. Each sheet contains at least one visualization widget, for example a chart, pivot table, or narrative insight. Sheets can be associated with other components, such as controls, filters, and so on.
SheetId (string) --
The unique identifier associated with a sheet.
Name (string) --
The name of a sheet. This name is displayed on the sheet's tab in the Amazon QuickSight console.
Options (dict) --
An array of analysis level configurations.
Timezone (string) --
Determines the timezone for the analysis.
WeekStart (string) --
Determines the week start day for an analysis.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'Definition': {'Options': {'Timezone': 'string',
'WeekStart': 'SUNDAY | MONDAY | TUESDAY | '
'WEDNESDAY | THURSDAY | FRIDAY | '
'SATURDAY'}}}
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.
{'Dashboard': {'Version': {'Options': {'Timezone': 'string',
'WeekStart': 'SUNDAY | MONDAY | TUESDAY '
'| WEDNESDAY | THURSDAY | '
'FRIDAY | SATURDAY'}}}}
Provides a summary for a dashboard.
See also: AWS API Documentation
Request Syntax
client.describe_dashboard(
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
{
'Dashboard': {
'DashboardId': 'string',
'Arn': 'string',
'Name': 'string',
'Version': {
'CreatedTime': datetime(2015, 1, 1),
'Errors': [
{
'Type': 'ACCESS_DENIED'|'SOURCE_NOT_FOUND'|'DATA_SET_NOT_FOUND'|'INTERNAL_FAILURE'|'PARAMETER_VALUE_INCOMPATIBLE'|'PARAMETER_TYPE_INVALID'|'PARAMETER_NOT_FOUND'|'COLUMN_TYPE_MISMATCH'|'COLUMN_GEOGRAPHIC_ROLE_MISMATCH'|'COLUMN_REPLACEMENT_MISSING',
'Message': 'string',
'ViolatedEntities': [
{
'Path': 'string'
},
]
},
],
'VersionNumber': 123,
'Status': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'Arn': 'string',
'SourceEntityArn': 'string',
'DataSetArns': [
'string',
],
'Description': 'string',
'ThemeArn': 'string',
'Sheets': [
{
'SheetId': 'string',
'Name': 'string'
},
],
'Options': {
'Timezone': 'string',
'WeekStart': 'SUNDAY'|'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY'
}
},
'CreatedTime': datetime(2015, 1, 1),
'LastPublishedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1)
},
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
Dashboard (dict) --
Information about the dashboard.
DashboardId (string) --
Dashboard ID.
Arn (string) --
The Amazon Resource Name (ARN) of the resource.
Name (string) --
A display name for the dashboard.
Version (dict) --
Version.
CreatedTime (datetime) --
The time that this dashboard version was created.
Errors (list) --
Errors associated with this dashboard version.
(dict) --
Dashboard error.
Type (string) --
Type.
Message (string) --
Message.
ViolatedEntities (list) --
Lists the violated entities that caused the dashboard error.
(dict) --
An object, structure, or sub-structure of an analysis, template, or dashboard.
Path (string) --
The hierarchical path of the entity within the analysis, template, or dashboard definition tree.
VersionNumber (integer) --
Version number for this version of the dashboard.
Status (string) --
The HTTP status of the request.
Arn (string) --
The Amazon Resource Name (ARN) of the resource.
SourceEntityArn (string) --
Source entity ARN.
DataSetArns (list) --
The Amazon Resource Numbers (ARNs) for the datasets that are associated with this version of the dashboard.
(string) --
Description (string) --
Description.
ThemeArn (string) --
The ARN of the theme associated with a version of the dashboard.
Sheets (list) --
A list of the associated sheets with the unique identifier and name of each sheet.
(dict) --
A sheet , which is an object that contains a set of visuals that are viewed together on one page in Amazon QuickSight. Every analysis and dashboard contains at least one sheet. Each sheet contains at least one visualization widget, for example a chart, pivot table, or narrative insight. Sheets can be associated with other components, such as controls, filters, and so on.
SheetId (string) --
The unique identifier associated with a sheet.
Name (string) --
The name of a sheet. This name is displayed on the sheet's tab in the Amazon QuickSight console.
Options (dict) --
An array of analysis level configurations.
Timezone (string) --
Determines the timezone for the analysis.
WeekStart (string) --
Determines the week start day for an analysis.
CreatedTime (datetime) --
The time that this dashboard was created.
LastPublishedTime (datetime) --
The last time that this dashboard was published.
LastUpdatedTime (datetime) --
The last time that this dashboard was updated.
Status (integer) --
The HTTP status of this request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'Definition': {'Options': {'Timezone': 'string',
'WeekStart': 'SUNDAY | MONDAY | TUESDAY | '
'WEDNESDAY | THURSDAY | FRIDAY | '
'SATURDAY'}}}
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.
{'DataSet': {'LogicalTableMap': {'DataTransforms': {'CastColumnTypeOperation': {'SubType': 'FLOAT '
'| '
'FIXED'}}},
'OutputColumns': {'SubType': 'FLOAT | FIXED'},
'PhysicalTableMap': {'CustomSql': {'Columns': {'SubType': 'FLOAT '
'| '
'FIXED'}},
'RelationalTable': {'InputColumns': {'SubType': 'FLOAT '
'| '
'FIXED'}},
'S3Source': {'InputColumns': {'SubType': 'FLOAT '
'| '
'FIXED'}}}}}
Describes a dataset. This operation doesn't support datasets that include uploaded files as a source.
See also: AWS API Documentation
Request Syntax
client.describe_data_set(
AwsAccountId='string',
DataSetId='string'
)
string
[REQUIRED]
The Amazon Web Services account ID.
string
[REQUIRED]
The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
dict
Response Syntax
{
'DataSet': {
'Arn': 'string',
'DataSetId': 'string',
'Name': 'string',
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'PhysicalTableMap': {
'string': {
'RelationalTable': {
'DataSourceArn': 'string',
'Catalog': 'string',
'Schema': 'string',
'Name': 'string',
'InputColumns': [
{
'Name': 'string',
'Type': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME'|'BIT'|'BOOLEAN'|'JSON',
'SubType': 'FLOAT'|'FIXED'
},
]
},
'CustomSql': {
'DataSourceArn': 'string',
'Name': 'string',
'SqlQuery': 'string',
'Columns': [
{
'Name': 'string',
'Type': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME'|'BIT'|'BOOLEAN'|'JSON',
'SubType': 'FLOAT'|'FIXED'
},
]
},
'S3Source': {
'DataSourceArn': 'string',
'UploadSettings': {
'Format': 'CSV'|'TSV'|'CLF'|'ELF'|'XLSX'|'JSON',
'StartFromRow': 123,
'ContainsHeader': True|False,
'TextQualifier': 'DOUBLE_QUOTE'|'SINGLE_QUOTE',
'Delimiter': 'string'
},
'InputColumns': [
{
'Name': 'string',
'Type': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME'|'BIT'|'BOOLEAN'|'JSON',
'SubType': 'FLOAT'|'FIXED'
},
]
}
}
},
'LogicalTableMap': {
'string': {
'Alias': 'string',
'DataTransforms': [
{
'ProjectOperation': {
'ProjectedColumns': [
'string',
]
},
'FilterOperation': {
'ConditionExpression': 'string'
},
'CreateColumnsOperation': {
'Columns': [
{
'ColumnName': 'string',
'ColumnId': 'string',
'Expression': 'string'
},
]
},
'RenameColumnOperation': {
'ColumnName': 'string',
'NewColumnName': 'string'
},
'CastColumnTypeOperation': {
'ColumnName': 'string',
'NewColumnType': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME',
'SubType': 'FLOAT'|'FIXED',
'Format': 'string'
},
'TagColumnOperation': {
'ColumnName': 'string',
'Tags': [
{
'ColumnGeographicRole': 'COUNTRY'|'STATE'|'COUNTY'|'CITY'|'POSTCODE'|'LONGITUDE'|'LATITUDE',
'ColumnDescription': {
'Text': 'string'
}
},
]
},
'UntagColumnOperation': {
'ColumnName': 'string',
'TagNames': [
'COLUMN_GEOGRAPHIC_ROLE'|'COLUMN_DESCRIPTION',
]
},
'OverrideDatasetParameterOperation': {
'ParameterName': 'string',
'NewParameterName': 'string',
'NewDefaultValues': {
'StringStaticValues': [
'string',
],
'DecimalStaticValues': [
123.0,
],
'DateTimeStaticValues': [
datetime(2015, 1, 1),
],
'IntegerStaticValues': [
123,
]
}
}
},
],
'Source': {
'JoinInstruction': {
'LeftOperand': 'string',
'RightOperand': 'string',
'LeftJoinKeyProperties': {
'UniqueKey': True|False
},
'RightJoinKeyProperties': {
'UniqueKey': True|False
},
'Type': 'INNER'|'OUTER'|'LEFT'|'RIGHT',
'OnClause': 'string'
},
'PhysicalTableId': 'string',
'DataSetArn': 'string'
}
}
},
'OutputColumns': [
{
'Name': 'string',
'Description': 'string',
'Type': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME',
'SubType': 'FLOAT'|'FIXED'
},
],
'ImportMode': 'SPICE'|'DIRECT_QUERY',
'ConsumedSpiceCapacityInBytes': 123,
'ColumnGroups': [
{
'GeoSpatialColumnGroup': {
'Name': 'string',
'CountryCode': 'US',
'Columns': [
'string',
]
}
},
],
'FieldFolders': {
'string': {
'description': 'string',
'columns': [
'string',
]
}
},
'RowLevelPermissionDataSet': {
'Namespace': 'string',
'Arn': 'string',
'PermissionPolicy': 'GRANT_ACCESS'|'DENY_ACCESS',
'FormatVersion': 'VERSION_1'|'VERSION_2',
'Status': 'ENABLED'|'DISABLED'
},
'RowLevelPermissionTagConfiguration': {
'Status': 'ENABLED'|'DISABLED',
'TagRules': [
{
'TagKey': 'string',
'ColumnName': 'string',
'TagMultiValueDelimiter': 'string',
'MatchAllValue': 'string'
},
],
'TagRuleConfigurations': [
[
'string',
],
]
},
'ColumnLevelPermissionRules': [
{
'Principals': [
'string',
],
'ColumnNames': [
'string',
]
},
],
'DataSetUsageConfiguration': {
'DisableUseAsDirectQuerySource': True|False,
'DisableUseAsImportedSource': True|False
},
'DatasetParameters': [
{
'StringDatasetParameter': {
'Id': 'string',
'Name': 'string',
'ValueType': 'MULTI_VALUED'|'SINGLE_VALUED',
'DefaultValues': {
'StaticValues': [
'string',
]
}
},
'DecimalDatasetParameter': {
'Id': 'string',
'Name': 'string',
'ValueType': 'MULTI_VALUED'|'SINGLE_VALUED',
'DefaultValues': {
'StaticValues': [
123.0,
]
}
},
'IntegerDatasetParameter': {
'Id': 'string',
'Name': 'string',
'ValueType': 'MULTI_VALUED'|'SINGLE_VALUED',
'DefaultValues': {
'StaticValues': [
123,
]
}
},
'DateTimeDatasetParameter': {
'Id': 'string',
'Name': 'string',
'ValueType': 'MULTI_VALUED'|'SINGLE_VALUED',
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'DefaultValues': {
'StaticValues': [
datetime(2015, 1, 1),
]
}
}
},
]
},
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
DataSet (dict) --
Information on the dataset.
Arn (string) --
The Amazon Resource Name (ARN) of the resource.
DataSetId (string) --
The ID of the dataset.
Name (string) --
A display name for the dataset.
CreatedTime (datetime) --
The time that this dataset was created.
LastUpdatedTime (datetime) --
The last time that this dataset was updated.
PhysicalTableMap (dict) --
Declares the physical tables that are available in the underlying data sources.
(string) --
(dict) --
A view of a data source that contains information about the shape of the data in the underlying source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
RelationalTable (dict) --
A physical table type for relational data sources.
DataSourceArn (string) --
The Amazon Resource Name (ARN) for the data source.
Catalog (string) --
The catalog associated with a table.
Schema (string) --
The schema name. This name applies to certain relational database engines.
Name (string) --
The name of the relational table.
InputColumns (list) --
The column schema of the table.
(dict) --
Metadata for a column that is used as the input of a transform operation.
Name (string) --
The name of this column in the underlying data source.
Type (string) --
The data type of the column.
SubType (string) --
The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset.
CustomSql (dict) --
A physical table type built from the results of the custom SQL query.
DataSourceArn (string) --
The Amazon Resource Name (ARN) of the data source.
Name (string) --
A display name for the SQL query result.
SqlQuery (string) --
The SQL query.
Columns (list) --
The column schema from the SQL query result set.
(dict) --
Metadata for a column that is used as the input of a transform operation.
Name (string) --
The name of this column in the underlying data source.
Type (string) --
The data type of the column.
SubType (string) --
The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset.
S3Source (dict) --
A physical table type for as S3 data source.
DataSourceArn (string) --
The Amazon Resource Name (ARN) for the data source.
UploadSettings (dict) --
Information about the format for the S3 source file or files.
Format (string) --
File format.
StartFromRow (integer) --
A row number to start reading data from.
ContainsHeader (boolean) --
Whether the file has a header row, or the files each have a header row.
TextQualifier (string) --
Text qualifier.
Delimiter (string) --
The delimiter between values in the file.
InputColumns (list) --
A physical table type for an S3 data source.
Note
For files that aren't JSON, only STRING data types are supported in input columns.
(dict) --
Metadata for a column that is used as the input of a transform operation.
Name (string) --
The name of this column in the underlying data source.
Type (string) --
The data type of the column.
SubType (string) --
The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset.
LogicalTableMap (dict) --
Configures the combination and transformation of the data from the physical tables.
(string) --
An identifier for the logical table that is defined in the dataset
(dict) --
A logical table is a unit that joins and that data transformations operate on. A logical table has a source, which can be either a physical table or result of a join. When a logical table points to a physical table, the logical table acts as a mutable copy of that physical table through transform operations.
Alias (string) --
A display name for the logical table.
DataTransforms (list) --
Transform operations that act on this logical table. For this structure to be valid, only one of the attributes can be non-null.
(dict) --
A data transformation on a logical table. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
ProjectOperation (dict) --
An operation that projects columns. Operations that come after a projection can only refer to projected columns.
ProjectedColumns (list) --
Projected columns.
(string) --
FilterOperation (dict) --
An operation that filters rows based on some condition.
ConditionExpression (string) --
An expression that must evaluate to a Boolean value. Rows for which the expression evaluates to true are kept in the dataset.
CreateColumnsOperation (dict) --
An operation that creates calculated columns. Columns created in one such operation form a lexical closure.
Columns (list) --
Calculated columns to create.
(dict) --
A calculated column for a dataset.
ColumnName (string) --
Column name.
ColumnId (string) --
A unique ID to identify a calculated column. During a dataset update, if the column ID of a calculated column matches that of an existing calculated column, Amazon QuickSight preserves the existing calculated column.
Expression (string) --
An expression that defines the calculated column.
RenameColumnOperation (dict) --
An operation that renames a column.
ColumnName (string) --
The name of the column to be renamed.
NewColumnName (string) --
The new name for the column.
CastColumnTypeOperation (dict) --
A transform operation that casts a column to a different type.
ColumnName (string) --
Column name.
NewColumnType (string) --
New column data type.
SubType (string) --
The sub data type of the new column. Sub types are only available for decimal columns that are part of a SPICE dataset.
Format (string) --
When casting a column from string to datetime type, you can supply a string in a format supported by Amazon QuickSight to denote the source data format.
TagColumnOperation (dict) --
An operation that tags a column with additional information.
ColumnName (string) --
The column that this operation acts on.
Tags (list) --
The dataset column tag, currently only used for geospatial type tagging.
Note
This is not tags for the Amazon Web Services tagging feature.
(dict) --
A tag for a column in a TagColumnOperation structure. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
ColumnGeographicRole (string) --
A geospatial role for a column.
ColumnDescription (dict) --
A description for a column.
Text (string) --
The text of a description for a column.
UntagColumnOperation (dict) --
A transform operation that removes tags associated with a column.
ColumnName (string) --
The column that this operation acts on.
TagNames (list) --
The column tags to remove from this column.
(string) --
OverrideDatasetParameterOperation (dict) --
A transform operation that overrides the dataset parameter values that are defined in another dataset.
ParameterName (string) --
The name of the parameter to be overridden with different values.
NewParameterName (string) --
The new name for the parameter.
NewDefaultValues (dict) --
The new default values for the parameter.
StringStaticValues (list) --
A list of static default values for a given string parameter.
(string) --
The default value for the string parameter.
DecimalStaticValues (list) --
A list of static default values for a given decimal parameter.
(float) --
The default value for the decimal parameter.
DateTimeStaticValues (list) --
A list of static default values for a given date time parameter.
(datetime) --
The default value for the date time parameter.
IntegerStaticValues (list) --
A list of static default values for a given integer parameter.
(integer) --
The default value for the integer parameter.
Source (dict) --
Source of this logical table.
JoinInstruction (dict) --
Specifies the result of a join of two logical tables.
LeftOperand (string) --
The operand on the left side of a join.
RightOperand (string) --
The operand on the right side of a join.
LeftJoinKeyProperties (dict) --
Join key properties of the left operand.
UniqueKey (boolean) --
A value that indicates that a row in a table is uniquely identified by the columns in a join key. This is used by Amazon QuickSight to optimize query performance.
RightJoinKeyProperties (dict) --
Join key properties of the right operand.
UniqueKey (boolean) --
A value that indicates that a row in a table is uniquely identified by the columns in a join key. This is used by Amazon QuickSight to optimize query performance.
Type (string) --
The type of join that it is.
OnClause (string) --
The join instructions provided in the ON clause of a join.
PhysicalTableId (string) --
Physical table ID.
DataSetArn (string) --
The Amazon Resource Number (ARN) of the parent dataset.
OutputColumns (list) --
The list of columns after all transforms. These columns are available in templates, analyses, and dashboards.
(dict) --
Output column.
Name (string) --
The display name of the column..
Description (string) --
A description for a column.
Type (string) --
The data type of the column.
SubType (string) --
The sub data type of the column.
ImportMode (string) --
A value that indicates whether you want to import the data into SPICE.
ConsumedSpiceCapacityInBytes (integer) --
The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't imported into SPICE.
ColumnGroups (list) --
Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.
(dict) --
Groupings of columns that work together in certain Amazon QuickSight features. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
GeoSpatialColumnGroup (dict) --
Geospatial column group that denotes a hierarchy.
Name (string) --
A display name for the hierarchy.
CountryCode (string) --
Country code.
Columns (list) --
Columns in this hierarchy.
(string) --
FieldFolders (dict) --
The folder that contains fields and nested subfolders for your dataset.
(string) --
(dict) --
A FieldFolder element is a folder that contains fields and nested subfolders.
description (string) --
The description for a field folder.
columns (list) --
A folder has a list of columns. A column can only be in one folder.
(string) --
RowLevelPermissionDataSet (dict) --
The row-level security configuration for the dataset.
Namespace (string) --
The namespace associated with the dataset that contains permissions for RLS.
Arn (string) --
The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.
PermissionPolicy (string) --
The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS is included for backward compatibility only.
FormatVersion (string) --
The user or group rules associated with the dataset that contains permissions for RLS.
By default, FormatVersion is VERSION_1 . When FormatVersion is VERSION_1 , UserName and GroupName are required. When FormatVersion is VERSION_2 , UserARN and GroupARN are required, and Namespace must not exist.
Status (string) --
The status of the row-level security permission dataset. If enabled, the status is ENABLED . If disabled, the status is DISABLED .
RowLevelPermissionTagConfiguration (dict) --
The element you can use to define tags for row-level security.
Status (string) --
The status of row-level security tags. If enabled, the status is ENABLED . If disabled, the status is DISABLED .
TagRules (list) --
A set of rules associated with row-level security, such as the tag names and columns that they are assigned to.
(dict) --
A set of rules associated with a tag.
TagKey (string) --
The unique key for a tag.
ColumnName (string) --
The column name that a tag key is assigned to.
TagMultiValueDelimiter (string) --
A string that you want to use to delimit the values when you pass the values at run time. For example, you can delimit the values with a comma.
MatchAllValue (string) --
A string that you want to use to filter by all the values in a column in the dataset and don’t want to list the values one by one. For example, you can use an asterisk as your match all value.
TagRuleConfigurations (list) --
A list of tag configuration rules to apply to a dataset. All tag configurations have the OR condition. Tags within each tile will be joined (AND). At least one rule in this structure must have all tag values assigned to it to apply Row-level security (RLS) to the dataset.
(list) --
(string) --
ColumnLevelPermissionRules (list) --
A set of one or more definitions of a ColumnLevelPermissionRule .
(dict) --
A rule defined to grant access on one or more restricted columns. Each dataset can have multiple rules. To create a restricted column, you add it to one or more rules. Each rule must contain at least one column and at least one user or group. To be able to see a restricted column, a user or group needs to be added to a rule for that column.
Principals (list) --
An array of Amazon Resource Names (ARNs) for Amazon QuickSight users or groups.
(string) --
ColumnNames (list) --
An array of column names.
(string) --
DataSetUsageConfiguration (dict) --
The usage configuration to apply to child datasets that reference this dataset as a source.
DisableUseAsDirectQuerySource (boolean) --
An option that controls whether a child dataset of a direct query can use this dataset as a source.
DisableUseAsImportedSource (boolean) --
An option that controls whether a child dataset that's stored in QuickSight can use this dataset as a source.
DatasetParameters (list) --
The parameters that are declared in a dataset.
(dict) --
A dataset parameter.
StringDatasetParameter (dict) --
A string parameter that is created in the dataset.
Id (string) --
An identifier for the string parameter that is created in the dataset.
Name (string) --
The name of the string parameter that is created in the dataset.
ValueType (string) --
The value type of the dataset parameter. Valid values are single value or multi value .
DefaultValues (dict) --
A list of default values for a given string dataset parameter type. This structure only accepts static values.
StaticValues (list) --
A list of static default values for a given string parameter.
(string) --
The default value for the string parameter.
DecimalDatasetParameter (dict) --
A decimal parameter that is created in the dataset.
Id (string) --
An identifier for the decimal parameter created in the dataset.
Name (string) --
The name of the decimal parameter that is created in the dataset.
ValueType (string) --
The value type of the dataset parameter. Valid values are single value or multi value .
DefaultValues (dict) --
A list of default values for a given decimal parameter. This structure only accepts static values.
StaticValues (list) --
A list of static default values for a given decimal parameter.
(float) --
The default value for the decimal parameter.
IntegerDatasetParameter (dict) --
An integer parameter that is created in the dataset.
Id (string) --
An identifier for the integer parameter created in the dataset.
Name (string) --
The name of the integer parameter that is created in the dataset.
ValueType (string) --
The value type of the dataset parameter. Valid values are single value or multi value .
DefaultValues (dict) --
A list of default values for a given integer parameter. This structure only accepts static values.
StaticValues (list) --
A list of static default values for a given integer parameter.
(integer) --
The default value for the integer parameter.
DateTimeDatasetParameter (dict) --
A date time parameter that is created in the dataset.
Id (string) --
An identifier for the parameter that is created in the dataset.
Name (string) --
The name of the date time parameter that is created in the dataset.
ValueType (string) --
The value type of the dataset parameter. Valid values are single value or multi value .
TimeGranularity (string) --
The time granularity of the date time parameter.
DefaultValues (dict) --
A list of default values for a given date time parameter. This structure only accepts static values.
StaticValues (list) --
A list of static default values for a given date time parameter.
(datetime) --
The default value for the date time parameter.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'Template': {'Version': {'Options': {'Timezone': 'string',
'WeekStart': 'SUNDAY | MONDAY | TUESDAY '
'| WEDNESDAY | THURSDAY | '
'FRIDAY | SATURDAY'}}}}
Describes a template's metadata.
See also: AWS API Documentation
Request Syntax
client.describe_template(
AwsAccountId='string',
TemplateId='string',
VersionNumber=123,
AliasName='string'
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the template that you're describing.
string
[REQUIRED]
The ID for the template.
integer
(Optional) The number for the version to describe. If a VersionNumber parameter value isn't provided, the latest version of the template is described.
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
{
'Template': {
'Arn': 'string',
'Name': 'string',
'Version': {
'CreatedTime': datetime(2015, 1, 1),
'Errors': [
{
'Type': 'SOURCE_NOT_FOUND'|'DATA_SET_NOT_FOUND'|'INTERNAL_FAILURE'|'ACCESS_DENIED',
'Message': 'string',
'ViolatedEntities': [
{
'Path': 'string'
},
]
},
],
'VersionNumber': 123,
'Status': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'DataSetConfigurations': [
{
'Placeholder': 'string',
'DataSetSchema': {
'ColumnSchemaList': [
{
'Name': 'string',
'DataType': 'string',
'GeographicRole': 'string'
},
]
},
'ColumnGroupSchemaList': [
{
'Name': 'string',
'ColumnGroupColumnSchemaList': [
{
'Name': 'string'
},
]
},
]
},
],
'Description': 'string',
'SourceEntityArn': 'string',
'ThemeArn': 'string',
'Sheets': [
{
'SheetId': 'string',
'Name': 'string'
},
],
'Options': {
'Timezone': 'string',
'WeekStart': 'SUNDAY'|'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY'
}
},
'TemplateId': 'string',
'LastUpdatedTime': datetime(2015, 1, 1),
'CreatedTime': datetime(2015, 1, 1)
},
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
Template (dict) --
The template structure for the object you want to describe.
Arn (string) --
The Amazon Resource Name (ARN) of the template.
Name (string) --
The display name of the template.
Version (dict) --
A structure describing the versions of the template.
CreatedTime (datetime) --
The time that this template version was created.
Errors (list) --
Errors associated with this template version.
(dict) --
List of errors that occurred when the template version creation failed.
Type (string) --
Type of error.
Message (string) --
Description of the error type.
ViolatedEntities (list) --
An error path that shows which entities caused the template error.
(dict) --
An object, structure, or sub-structure of an analysis, template, or dashboard.
Path (string) --
The hierarchical path of the entity within the analysis, template, or dashboard definition tree.
VersionNumber (integer) --
The version number of the template version.
Status (string) --
The status that is associated with the template.
CREATION_IN_PROGRESS
CREATION_SUCCESSFUL
CREATION_FAILED
UPDATE_IN_PROGRESS
UPDATE_SUCCESSFUL
UPDATE_FAILED
DELETED
DataSetConfigurations (list) --
Schema of the dataset identified by the placeholder. Any dashboard created from this template should be bound to new datasets matching the same schema described through this API operation.
(dict) --
Dataset configuration.
Placeholder (string) --
Placeholder.
DataSetSchema (dict) --
Dataset schema.
ColumnSchemaList (list) --
A structure containing the list of column schemas.
(dict) --
The column schema.
Name (string) --
The name of the column schema.
DataType (string) --
The data type of the column schema.
GeographicRole (string) --
The geographic role of the column schema.
ColumnGroupSchemaList (list) --
A structure containing the list of column group schemas.
(dict) --
The column group schema.
Name (string) --
The name of the column group schema.
ColumnGroupColumnSchemaList (list) --
A structure containing the list of schemas for column group columns.
(dict) --
A structure describing the name, data type, and geographic role of the columns.
Name (string) --
The name of the column group's column schema.
Description (string) --
The description of the template.
SourceEntityArn (string) --
The Amazon Resource Name (ARN) of an analysis or template that was used to create this template.
ThemeArn (string) --
The ARN of the theme associated with this version of the template.
Sheets (list) --
A list of the associated sheets with the unique identifier and name of each sheet.
(dict) --
A sheet , which is an object that contains a set of visuals that are viewed together on one page in Amazon QuickSight. Every analysis and dashboard contains at least one sheet. Each sheet contains at least one visualization widget, for example a chart, pivot table, or narrative insight. Sheets can be associated with other components, such as controls, filters, and so on.
SheetId (string) --
The unique identifier associated with a sheet.
Name (string) --
The name of a sheet. This name is displayed on the sheet's tab in the Amazon QuickSight console.
Options (dict) --
An array of analysis level configurations.
Timezone (string) --
Determines the timezone for the analysis.
WeekStart (string) --
Determines the week start day for an analysis.
TemplateId (string) --
The ID for the template. This is unique per Amazon Web Services Region for each Amazon Web Services account.
LastUpdatedTime (datetime) --
Time when this was last updated.
CreatedTime (datetime) --
Time when this was created.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'Definition': {'Options': {'Timezone': 'string',
'WeekStart': 'SUNDAY | MONDAY | TUESDAY | '
'WEDNESDAY | THURSDAY | FRIDAY | '
'SATURDAY'}}}
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.
{'Definition': {'Options': {'Timezone': 'string',
'WeekStart': 'SUNDAY | MONDAY | TUESDAY | '
'WEDNESDAY | THURSDAY | FRIDAY | '
'SATURDAY'}}}
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': {'Options': {'Timezone': 'string',
'WeekStart': 'SUNDAY | MONDAY | TUESDAY | '
'WEDNESDAY | THURSDAY | FRIDAY | '
'SATURDAY'}}}
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.
{'LogicalTableMap': {'DataTransforms': {'CastColumnTypeOperation': {'SubType': 'FLOAT '
'| '
'FIXED'}}},
'PhysicalTableMap': {'CustomSql': {'Columns': {'SubType': 'FLOAT | FIXED'}},
'RelationalTable': {'InputColumns': {'SubType': 'FLOAT | '
'FIXED'}},
'S3Source': {'InputColumns': {'SubType': 'FLOAT | '
'FIXED'}}}}
Updates a dataset. This operation doesn't support datasets that include uploaded files as a source. Partial updates are not supported by this operation.
See also: AWS API Documentation
Request Syntax
client.update_data_set(
AwsAccountId='string',
DataSetId='string',
Name='string',
PhysicalTableMap={
'string': {
'RelationalTable': {
'DataSourceArn': 'string',
'Catalog': 'string',
'Schema': 'string',
'Name': 'string',
'InputColumns': [
{
'Name': 'string',
'Type': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME'|'BIT'|'BOOLEAN'|'JSON',
'SubType': 'FLOAT'|'FIXED'
},
]
},
'CustomSql': {
'DataSourceArn': 'string',
'Name': 'string',
'SqlQuery': 'string',
'Columns': [
{
'Name': 'string',
'Type': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME'|'BIT'|'BOOLEAN'|'JSON',
'SubType': 'FLOAT'|'FIXED'
},
]
},
'S3Source': {
'DataSourceArn': 'string',
'UploadSettings': {
'Format': 'CSV'|'TSV'|'CLF'|'ELF'|'XLSX'|'JSON',
'StartFromRow': 123,
'ContainsHeader': True|False,
'TextQualifier': 'DOUBLE_QUOTE'|'SINGLE_QUOTE',
'Delimiter': 'string'
},
'InputColumns': [
{
'Name': 'string',
'Type': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME'|'BIT'|'BOOLEAN'|'JSON',
'SubType': 'FLOAT'|'FIXED'
},
]
}
}
},
LogicalTableMap={
'string': {
'Alias': 'string',
'DataTransforms': [
{
'ProjectOperation': {
'ProjectedColumns': [
'string',
]
},
'FilterOperation': {
'ConditionExpression': 'string'
},
'CreateColumnsOperation': {
'Columns': [
{
'ColumnName': 'string',
'ColumnId': 'string',
'Expression': 'string'
},
]
},
'RenameColumnOperation': {
'ColumnName': 'string',
'NewColumnName': 'string'
},
'CastColumnTypeOperation': {
'ColumnName': 'string',
'NewColumnType': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME',
'SubType': 'FLOAT'|'FIXED',
'Format': 'string'
},
'TagColumnOperation': {
'ColumnName': 'string',
'Tags': [
{
'ColumnGeographicRole': 'COUNTRY'|'STATE'|'COUNTY'|'CITY'|'POSTCODE'|'LONGITUDE'|'LATITUDE',
'ColumnDescription': {
'Text': 'string'
}
},
]
},
'UntagColumnOperation': {
'ColumnName': 'string',
'TagNames': [
'COLUMN_GEOGRAPHIC_ROLE'|'COLUMN_DESCRIPTION',
]
},
'OverrideDatasetParameterOperation': {
'ParameterName': 'string',
'NewParameterName': 'string',
'NewDefaultValues': {
'StringStaticValues': [
'string',
],
'DecimalStaticValues': [
123.0,
],
'DateTimeStaticValues': [
datetime(2015, 1, 1),
],
'IntegerStaticValues': [
123,
]
}
}
},
],
'Source': {
'JoinInstruction': {
'LeftOperand': 'string',
'RightOperand': 'string',
'LeftJoinKeyProperties': {
'UniqueKey': True|False
},
'RightJoinKeyProperties': {
'UniqueKey': True|False
},
'Type': 'INNER'|'OUTER'|'LEFT'|'RIGHT',
'OnClause': 'string'
},
'PhysicalTableId': 'string',
'DataSetArn': 'string'
}
}
},
ImportMode='SPICE'|'DIRECT_QUERY',
ColumnGroups=[
{
'GeoSpatialColumnGroup': {
'Name': 'string',
'CountryCode': 'US',
'Columns': [
'string',
]
}
},
],
FieldFolders={
'string': {
'description': 'string',
'columns': [
'string',
]
}
},
RowLevelPermissionDataSet={
'Namespace': 'string',
'Arn': 'string',
'PermissionPolicy': 'GRANT_ACCESS'|'DENY_ACCESS',
'FormatVersion': 'VERSION_1'|'VERSION_2',
'Status': 'ENABLED'|'DISABLED'
},
RowLevelPermissionTagConfiguration={
'Status': 'ENABLED'|'DISABLED',
'TagRules': [
{
'TagKey': 'string',
'ColumnName': 'string',
'TagMultiValueDelimiter': 'string',
'MatchAllValue': 'string'
},
],
'TagRuleConfigurations': [
[
'string',
],
]
},
ColumnLevelPermissionRules=[
{
'Principals': [
'string',
],
'ColumnNames': [
'string',
]
},
],
DataSetUsageConfiguration={
'DisableUseAsDirectQuerySource': True|False,
'DisableUseAsImportedSource': True|False
},
DatasetParameters=[
{
'StringDatasetParameter': {
'Id': 'string',
'Name': 'string',
'ValueType': 'MULTI_VALUED'|'SINGLE_VALUED',
'DefaultValues': {
'StaticValues': [
'string',
]
}
},
'DecimalDatasetParameter': {
'Id': 'string',
'Name': 'string',
'ValueType': 'MULTI_VALUED'|'SINGLE_VALUED',
'DefaultValues': {
'StaticValues': [
123.0,
]
}
},
'IntegerDatasetParameter': {
'Id': 'string',
'Name': 'string',
'ValueType': 'MULTI_VALUED'|'SINGLE_VALUED',
'DefaultValues': {
'StaticValues': [
123,
]
}
},
'DateTimeDatasetParameter': {
'Id': 'string',
'Name': 'string',
'ValueType': 'MULTI_VALUED'|'SINGLE_VALUED',
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'DefaultValues': {
'StaticValues': [
datetime(2015, 1, 1),
]
}
}
},
]
)
string
[REQUIRED]
The Amazon Web Services account ID.
string
[REQUIRED]
The ID for the dataset that you want to update. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
string
[REQUIRED]
The display name for the dataset.
dict
[REQUIRED]
Declares the physical tables that are available in the underlying data sources.
(string) --
(dict) --
A view of a data source that contains information about the shape of the data in the underlying source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
RelationalTable (dict) --
A physical table type for relational data sources.
DataSourceArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the data source.
Catalog (string) --
The catalog associated with a table.
Schema (string) --
The schema name. This name applies to certain relational database engines.
Name (string) -- [REQUIRED]
The name of the relational table.
InputColumns (list) -- [REQUIRED]
The column schema of the table.
(dict) --
Metadata for a column that is used as the input of a transform operation.
Name (string) -- [REQUIRED]
The name of this column in the underlying data source.
Type (string) -- [REQUIRED]
The data type of the column.
SubType (string) --
The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset.
CustomSql (dict) --
A physical table type built from the results of the custom SQL query.
DataSourceArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the data source.
Name (string) -- [REQUIRED]
A display name for the SQL query result.
SqlQuery (string) -- [REQUIRED]
The SQL query.
Columns (list) --
The column schema from the SQL query result set.
(dict) --
Metadata for a column that is used as the input of a transform operation.
Name (string) -- [REQUIRED]
The name of this column in the underlying data source.
Type (string) -- [REQUIRED]
The data type of the column.
SubType (string) --
The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset.
S3Source (dict) --
A physical table type for as S3 data source.
DataSourceArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the data source.
UploadSettings (dict) --
Information about the format for the S3 source file or files.
Format (string) --
File format.
StartFromRow (integer) --
A row number to start reading data from.
ContainsHeader (boolean) --
Whether the file has a header row, or the files each have a header row.
TextQualifier (string) --
Text qualifier.
Delimiter (string) --
The delimiter between values in the file.
InputColumns (list) -- [REQUIRED]
A physical table type for an S3 data source.
Note
For files that aren't JSON, only STRING data types are supported in input columns.
(dict) --
Metadata for a column that is used as the input of a transform operation.
Name (string) -- [REQUIRED]
The name of this column in the underlying data source.
Type (string) -- [REQUIRED]
The data type of the column.
SubType (string) --
The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset.
dict
Configures the combination and transformation of the data from the physical tables.
(string) --
An identifier for the logical table that is defined in the dataset
(dict) --
A logical table is a unit that joins and that data transformations operate on. A logical table has a source, which can be either a physical table or result of a join. When a logical table points to a physical table, the logical table acts as a mutable copy of that physical table through transform operations.
Alias (string) -- [REQUIRED]
A display name for the logical table.
DataTransforms (list) --
Transform operations that act on this logical table. For this structure to be valid, only one of the attributes can be non-null.
(dict) --
A data transformation on a logical table. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
ProjectOperation (dict) --
An operation that projects columns. Operations that come after a projection can only refer to projected columns.
ProjectedColumns (list) -- [REQUIRED]
Projected columns.
(string) --
FilterOperation (dict) --
An operation that filters rows based on some condition.
ConditionExpression (string) -- [REQUIRED]
An expression that must evaluate to a Boolean value. Rows for which the expression evaluates to true are kept in the dataset.
CreateColumnsOperation (dict) --
An operation that creates calculated columns. Columns created in one such operation form a lexical closure.
Columns (list) -- [REQUIRED]
Calculated columns to create.
(dict) --
A calculated column for a dataset.
ColumnName (string) -- [REQUIRED]
Column name.
ColumnId (string) -- [REQUIRED]
A unique ID to identify a calculated column. During a dataset update, if the column ID of a calculated column matches that of an existing calculated column, Amazon QuickSight preserves the existing calculated column.
Expression (string) -- [REQUIRED]
An expression that defines the calculated column.
RenameColumnOperation (dict) --
An operation that renames a column.
ColumnName (string) -- [REQUIRED]
The name of the column to be renamed.
NewColumnName (string) -- [REQUIRED]
The new name for the column.
CastColumnTypeOperation (dict) --
A transform operation that casts a column to a different type.
ColumnName (string) -- [REQUIRED]
Column name.
NewColumnType (string) -- [REQUIRED]
New column data type.
SubType (string) --
The sub data type of the new column. Sub types are only available for decimal columns that are part of a SPICE dataset.
Format (string) --
When casting a column from string to datetime type, you can supply a string in a format supported by Amazon QuickSight to denote the source data format.
TagColumnOperation (dict) --
An operation that tags a column with additional information.
ColumnName (string) -- [REQUIRED]
The column that this operation acts on.
Tags (list) -- [REQUIRED]
The dataset column tag, currently only used for geospatial type tagging.
Note
This is not tags for the Amazon Web Services tagging feature.
(dict) --
A tag for a column in a TagColumnOperation structure. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
ColumnGeographicRole (string) --
A geospatial role for a column.
ColumnDescription (dict) --
A description for a column.
Text (string) --
The text of a description for a column.
UntagColumnOperation (dict) --
A transform operation that removes tags associated with a column.
ColumnName (string) -- [REQUIRED]
The column that this operation acts on.
TagNames (list) -- [REQUIRED]
The column tags to remove from this column.
(string) --
OverrideDatasetParameterOperation (dict) --
A transform operation that overrides the dataset parameter values that are defined in another dataset.
ParameterName (string) -- [REQUIRED]
The name of the parameter to be overridden with different values.
NewParameterName (string) --
The new name for the parameter.
NewDefaultValues (dict) --
The new default values for the parameter.
StringStaticValues (list) --
A list of static default values for a given string parameter.
(string) --
The default value for the string parameter.
DecimalStaticValues (list) --
A list of static default values for a given decimal parameter.
(float) --
The default value for the decimal parameter.
DateTimeStaticValues (list) --
A list of static default values for a given date time parameter.
(datetime) --
The default value for the date time parameter.
IntegerStaticValues (list) --
A list of static default values for a given integer parameter.
(integer) --
The default value for the integer parameter.
Source (dict) -- [REQUIRED]
Source of this logical table.
JoinInstruction (dict) --
Specifies the result of a join of two logical tables.
LeftOperand (string) -- [REQUIRED]
The operand on the left side of a join.
RightOperand (string) -- [REQUIRED]
The operand on the right side of a join.
LeftJoinKeyProperties (dict) --
Join key properties of the left operand.
UniqueKey (boolean) --
A value that indicates that a row in a table is uniquely identified by the columns in a join key. This is used by Amazon QuickSight to optimize query performance.
RightJoinKeyProperties (dict) --
Join key properties of the right operand.
UniqueKey (boolean) --
A value that indicates that a row in a table is uniquely identified by the columns in a join key. This is used by Amazon QuickSight to optimize query performance.
Type (string) -- [REQUIRED]
The type of join that it is.
OnClause (string) -- [REQUIRED]
The join instructions provided in the ON clause of a join.
PhysicalTableId (string) --
Physical table ID.
DataSetArn (string) --
The Amazon Resource Number (ARN) of the parent dataset.
string
[REQUIRED]
Indicates whether you want to import the data into SPICE.
list
Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.
(dict) --
Groupings of columns that work together in certain Amazon QuickSight features. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
GeoSpatialColumnGroup (dict) --
Geospatial column group that denotes a hierarchy.
Name (string) -- [REQUIRED]
A display name for the hierarchy.
CountryCode (string) --
Country code.
Columns (list) -- [REQUIRED]
Columns in this hierarchy.
(string) --
dict
The folder that contains fields and nested subfolders for your dataset.
(string) --
(dict) --
A FieldFolder element is a folder that contains fields and nested subfolders.
description (string) --
The description for a field folder.
columns (list) --
A folder has a list of columns. A column can only be in one folder.
(string) --
dict
The row-level security configuration for the data you want to create.
Namespace (string) --
The namespace associated with the dataset that contains permissions for RLS.
Arn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.
PermissionPolicy (string) -- [REQUIRED]
The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS is included for backward compatibility only.
FormatVersion (string) --
The user or group rules associated with the dataset that contains permissions for RLS.
By default, FormatVersion is VERSION_1 . When FormatVersion is VERSION_1 , UserName and GroupName are required. When FormatVersion is VERSION_2 , UserARN and GroupARN are required, and Namespace must not exist.
Status (string) --
The status of the row-level security permission dataset. If enabled, the status is ENABLED . If disabled, the status is DISABLED .
dict
The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only.
Status (string) --
The status of row-level security tags. If enabled, the status is ENABLED . If disabled, the status is DISABLED .
TagRules (list) -- [REQUIRED]
A set of rules associated with row-level security, such as the tag names and columns that they are assigned to.
(dict) --
A set of rules associated with a tag.
TagKey (string) -- [REQUIRED]
The unique key for a tag.
ColumnName (string) -- [REQUIRED]
The column name that a tag key is assigned to.
TagMultiValueDelimiter (string) --
A string that you want to use to delimit the values when you pass the values at run time. For example, you can delimit the values with a comma.
MatchAllValue (string) --
A string that you want to use to filter by all the values in a column in the dataset and don’t want to list the values one by one. For example, you can use an asterisk as your match all value.
TagRuleConfigurations (list) --
A list of tag configuration rules to apply to a dataset. All tag configurations have the OR condition. Tags within each tile will be joined (AND). At least one rule in this structure must have all tag values assigned to it to apply Row-level security (RLS) to the dataset.
(list) --
(string) --
list
A set of one or more definitions of a ColumnLevelPermissionRule .
(dict) --
A rule defined to grant access on one or more restricted columns. Each dataset can have multiple rules. To create a restricted column, you add it to one or more rules. Each rule must contain at least one column and at least one user or group. To be able to see a restricted column, a user or group needs to be added to a rule for that column.
Principals (list) --
An array of Amazon Resource Names (ARNs) for Amazon QuickSight users or groups.
(string) --
ColumnNames (list) --
An array of column names.
(string) --
dict
The usage configuration to apply to child datasets that reference this dataset as a source.
DisableUseAsDirectQuerySource (boolean) --
An option that controls whether a child dataset of a direct query can use this dataset as a source.
DisableUseAsImportedSource (boolean) --
An option that controls whether a child dataset that's stored in QuickSight can use this dataset as a source.
list
The parameter declarations of the dataset.
(dict) --
A dataset parameter.
StringDatasetParameter (dict) --
A string parameter that is created in the dataset.
Id (string) -- [REQUIRED]
An identifier for the string parameter that is created in the dataset.
Name (string) -- [REQUIRED]
The name of the string parameter that is created in the dataset.
ValueType (string) -- [REQUIRED]
The value type of the dataset parameter. Valid values are single value or multi value .
DefaultValues (dict) --
A list of default values for a given string dataset parameter type. This structure only accepts static values.
StaticValues (list) --
A list of static default values for a given string parameter.
(string) --
The default value for the string parameter.
DecimalDatasetParameter (dict) --
A decimal parameter that is created in the dataset.
Id (string) -- [REQUIRED]
An identifier for the decimal parameter created in the dataset.
Name (string) -- [REQUIRED]
The name of the decimal parameter that is created in the dataset.
ValueType (string) -- [REQUIRED]
The value type of the dataset parameter. Valid values are single value or multi value .
DefaultValues (dict) --
A list of default values for a given decimal parameter. This structure only accepts static values.
StaticValues (list) --
A list of static default values for a given decimal parameter.
(float) --
The default value for the decimal parameter.
IntegerDatasetParameter (dict) --
An integer parameter that is created in the dataset.
Id (string) -- [REQUIRED]
An identifier for the integer parameter created in the dataset.
Name (string) -- [REQUIRED]
The name of the integer parameter that is created in the dataset.
ValueType (string) -- [REQUIRED]
The value type of the dataset parameter. Valid values are single value or multi value .
DefaultValues (dict) --
A list of default values for a given integer parameter. This structure only accepts static values.
StaticValues (list) --
A list of static default values for a given integer parameter.
(integer) --
The default value for the integer parameter.
DateTimeDatasetParameter (dict) --
A date time parameter that is created in the dataset.
Id (string) -- [REQUIRED]
An identifier for the parameter that is created in the dataset.
Name (string) -- [REQUIRED]
The name of the date time parameter that is created in the dataset.
ValueType (string) -- [REQUIRED]
The value type of the dataset parameter. Valid values are single value or multi value .
TimeGranularity (string) --
The time granularity of the date time parameter.
DefaultValues (dict) --
A list of default values for a given date time parameter. This structure only accepts static values.
StaticValues (list) --
A list of static default values for a given date time parameter.
(datetime) --
The default value for the date time parameter.
dict
Response Syntax
{
'Arn': 'string',
'DataSetId': 'string',
'IngestionArn': 'string',
'IngestionId': 'string',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) of the dataset.
DataSetId (string) --
The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
IngestionArn (string) --
The ARN for the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.
IngestionId (string) --
The ID of the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'Definition': {'Options': {'Timezone': 'string',
'WeekStart': 'SUNDAY | MONDAY | TUESDAY | '
'WEDNESDAY | THURSDAY | FRIDAY | '
'SATURDAY'}}}
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.