awscc.quicksight_dataset¶
Filters¶
event
reduce
value
Actions¶
delete¶
Parent base class for filters and actions.
properties:
type:
enum:
- delete
required:
- type
Permissions - quicksight:DescribeDataSet, quicksight:DeleteDataSet, quicksight:ListTagsForResource, quicksight:DescribeIngestion
update¶
Parent base class for filters and actions.
definitions:
CalculatedColumn:
description: <p>A calculated column for a dataset.</p>
properties:
ColumnId:
description: "<p>A unique ID to identify a calculated column. During a dataset\
\ update, if the column ID\n of a calculated column matches that\
\ of an existing calculated column, Amazon QuickSight\n preserves\
\ the existing calculated column.</p>"
maxLength: 64
minLength: 1
type: string
ColumnName:
description: <p>Column name.</p>
maxLength: 128
minLength: 1
type: string
Expression:
description: <p>An expression that defines the calculated column.</p>
maxLength: 4096
minLength: 1
type: string
required:
- ColumnId
- ColumnName
- Expression
type: object
CastColumnTypeOperation:
description: <p>A transform operation that casts a column to a different type.</p>
properties:
ColumnName:
description: <p>Column name.</p>
maxLength: 128
minLength: 1
type: string
Format:
description: "<p>When casting a column from string to datetime type, you can\
\ supply a string in a\n format supported by Amazon QuickSight\
\ to denote the source data format.</p>"
maxLength: 32
minLength: 0
type: string
NewColumnType:
enum:
- STRING
- INTEGER
- DECIMAL
- DATETIME
type: string
required:
- ColumnName
- NewColumnType
type: object
ColumnDataType:
enum:
- STRING
- INTEGER
- DECIMAL
- DATETIME
type: string
ColumnDescription:
description: <p>Metadata that contains a description for a column.</p>
properties:
Text:
description: <p>The text of a description for a column.</p>
maxLength: 500
minLength: 0
type: string
type: object
ColumnGroup:
description: "<p>Groupings of columns that work together in certain Amazon QuickSight\
\ features. This is\n a variant type structure. For this structure\
\ to be valid, only one of the attributes can\n be non-null.</p>"
properties:
GeoSpatialColumnGroup:
description: <p>Geospatial column group that denotes a hierarchy.</p>
properties:
Columns:
description: <p>Columns in this hierarchy.</p>
items:
maxLength: 128
minLength: 1
type: string
maxItems: 16
minItems: 1
type: array
CountryCode:
enum:
- US
type: string
Name:
description: <p>A display name for the hierarchy.</p>
maxLength: 64
minLength: 1
type: string
required:
- Columns
- Name
type: object
type: object
ColumnLevelPermissionRule:
properties:
ColumnNames:
items:
type: string
minItems: 1
type: array
Principals:
items:
type: string
maxItems: 100
minItems: 1
type: array
type: object
ColumnTag:
description: "<p>A tag for a column in a <a>TagColumnOperation</a> structure.\
\ This is a\n variant type structure. For this structure to be valid,\
\ only one of the attributes can\n be non-null.</p>"
properties:
ColumnDescription:
description: <p>Metadata that contains a description for a column.</p>
properties:
Text:
description: <p>The text of a description for a column.</p>
maxLength: 500
minLength: 0
type: string
type: object
ColumnGeographicRole:
enum:
- COUNTRY
- STATE
- COUNTY
- CITY
- POSTCODE
- LONGITUDE
- LATITUDE
- POLITICAL1
type: string
type: object
CreateColumnsOperation:
description: "<p>A transform operation that creates calculated columns. Columns\
\ created in one such\n operation form a lexical closure.</p>"
properties:
Columns:
description: <p>Calculated columns to create.</p>
items:
description: <p>A calculated column for a dataset.</p>
properties:
ColumnId:
description: "<p>A unique ID to identify a calculated column. During\
\ a dataset update, if the column ID\n of a calculated\
\ column matches that of an existing calculated column, Amazon QuickSight\n\
\ preserves the existing calculated column.</p>"
maxLength: 64
minLength: 1
type: string
ColumnName:
description: <p>Column name.</p>
maxLength: 128
minLength: 1
type: string
Expression:
description: <p>An expression that defines the calculated column.</p>
maxLength: 4096
minLength: 1
type: string
required:
- ColumnId
- ColumnName
- Expression
type: object
maxItems: 128
minItems: 1
type: array
required:
- Columns
type: object
CustomSql:
description: <p>A physical table type built from the results of the custom SQL
query.</p>
properties:
Columns:
description: <p>The column schema from the SQL query result set.</p>
items:
description: <p>Metadata for a column that is used as the input of a transform
operation.</p>
properties:
Name:
description: <p>The name of this column in the underlying data source.</p>
maxLength: 128
minLength: 1
type: string
Type:
enum:
- STRING
- INTEGER
- DECIMAL
- DATETIME
- BIT
- BOOLEAN
- JSON
type: string
required:
- Name
- Type
type: object
maxItems: 2048
minItems: 1
type: array
DataSourceArn:
description: <p>The Amazon Resource Name (ARN) of the data source.</p>
type: string
Name:
description: <p>A display name for the SQL query result.</p>
maxLength: 128
minLength: 1
type: string
SqlQuery:
description: <p>The SQL query.</p>
maxLength: 65536
minLength: 1
type: string
required:
- Columns
- DataSourceArn
- Name
- SqlQuery
type: object
DataSetImportMode:
enum:
- SPICE
- DIRECT_QUERY
type: string
FieldFolder:
properties:
Columns:
items:
type: string
maxItems: 5000
minItems: 0
type: array
Description:
maxLength: 500
minLength: 0
type: string
type: object
FieldFolderMap:
patternProperties:
.+:
properties:
Columns:
items:
type: string
maxItems: 5000
minItems: 0
type: array
Description:
maxLength: 500
minLength: 0
type: string
type: object
type: object
FileFormat:
enum:
- CSV
- TSV
- CLF
- ELF
- XLSX
- JSON
type: string
FilterOperation:
description: <p>A transform operation that filters rows based on a condition.</p>
properties:
ConditionExpression:
description: "<p>An expression that must evaluate to a Boolean value. Rows\
\ for which the expression\n evaluates to true are kept in the\
\ dataset.</p>"
maxLength: 4096
minLength: 1
type: string
required:
- ConditionExpression
type: object
GeoSpatialColumnGroup:
description: <p>Geospatial column group that denotes a hierarchy.</p>
properties:
Columns:
description: <p>Columns in this hierarchy.</p>
items:
maxLength: 128
minLength: 1
type: string
maxItems: 16
minItems: 1
type: array
CountryCode:
enum:
- US
type: string
Name:
description: <p>A display name for the hierarchy.</p>
maxLength: 64
minLength: 1
type: string
required:
- Columns
- Name
type: object
GeoSpatialCountryCode:
enum:
- US
type: string
GeoSpatialDataRole:
enum:
- COUNTRY
- STATE
- COUNTY
- CITY
- POSTCODE
- LONGITUDE
- LATITUDE
- POLITICAL1
type: string
IngestionWaitPolicy:
description: <p>Wait policy to use when creating/updating dataset. Default is
to wait for SPICE ingestion to finish with timeout of 36 hours.</p>
properties:
IngestionWaitTimeInHours:
default: 36
description: "<p>The maximum time (in hours) to wait for Ingestion to complete.\
\ Default timeout is 36 hours.\n Applicable only when DataSetImportMode\
\ mode is set to SPICE and WaitForSpiceIngestion is set to true.</p>"
maximum: 36
minimum: 1
type: number
WaitForSpiceIngestion:
default: true
description: "<p>Wait for SPICE ingestion to finish to mark dataset creation/update\
\ successful. Default (true).\n Applicable only when DataSetImportMode\
\ mode is set to SPICE.</p>"
type: boolean
type: object
InputColumn:
description: <p>Metadata for a column that is used as the input of a transform
operation.</p>
properties:
Name:
description: <p>The name of this column in the underlying data source.</p>
maxLength: 128
minLength: 1
type: string
Type:
enum:
- STRING
- INTEGER
- DECIMAL
- DATETIME
- BIT
- BOOLEAN
- JSON
type: string
required:
- Name
- Type
type: object
InputColumnDataType:
enum:
- STRING
- INTEGER
- DECIMAL
- DATETIME
- BIT
- BOOLEAN
- JSON
type: string
JoinInstruction:
description: <p>Join instruction.</p>
properties:
LeftJoinKeyProperties:
properties:
UniqueKey:
type: boolean
type: object
LeftOperand:
description: <p>Left operand.</p>
maxLength: 64
minLength: 1
pattern: '[0-9a-zA-Z-]*'
type: string
OnClause:
description: <p>On Clause.</p>
maxLength: 512
minLength: 1
type: string
RightJoinKeyProperties:
properties:
UniqueKey:
type: boolean
type: object
RightOperand:
description: <p>Right operand.</p>
maxLength: 64
minLength: 1
pattern: '[0-9a-zA-Z-]*'
type: string
Type:
enum:
- INNER
- OUTER
- LEFT
- RIGHT
type: string
required:
- LeftOperand
- OnClause
- RightOperand
- Type
type: object
JoinKeyProperties:
properties:
UniqueKey:
type: boolean
type: object
JoinType:
enum:
- INNER
- OUTER
- LEFT
- RIGHT
type: string
LogicalTable:
description: "<p>A <i>logical table</i> is a unit that joins and that data\n \
\ transformations operate on. A logical table has a source, which\
\ can be either a physical\n table or result of a join. When a logical\
\ table points to a physical table, the logical\n table acts as a\
\ mutable copy of that physical table through transform operations.</p>"
properties:
Alias:
description: <p>A display name for the logical table.</p>
maxLength: 64
minLength: 1
type: string
DataTransforms:
description: <p>Transform operations that act on this logical table.</p>
items:
description: "<p>A data transformation on a logical table. This is a variant\
\ type structure. For this\n structure to be valid, only one\
\ of the attributes can be non-null.</p>"
properties:
CastColumnTypeOperation:
description: <p>A transform operation that casts a column to a different
type.</p>
properties:
ColumnName:
description: <p>Column name.</p>
maxLength: 128
minLength: 1
type: string
Format:
description: "<p>When casting a column from string to datetime type,\
\ you can supply a string in a\n format supported by\
\ Amazon QuickSight to denote the source data format.</p>"
maxLength: 32
minLength: 0
type: string
NewColumnType:
enum:
- STRING
- INTEGER
- DECIMAL
- DATETIME
type: string
required:
- ColumnName
- NewColumnType
type: object
CreateColumnsOperation:
description: "<p>A transform operation that creates calculated columns.\
\ Columns created in one such\n operation form a lexical\
\ closure.</p>"
properties:
Columns:
description: <p>Calculated columns to create.</p>
items:
description: <p>A calculated column for a dataset.</p>
properties:
ColumnId:
description: "<p>A unique ID to identify a calculated column.\
\ During a dataset update, if the column ID\n \
\ of a calculated column matches that of an existing calculated\
\ column, Amazon QuickSight\n preserves the existing\
\ calculated column.</p>"
maxLength: 64
minLength: 1
type: string
ColumnName:
description: <p>Column name.</p>
maxLength: 128
minLength: 1
type: string
Expression:
description: <p>An expression that defines the calculated
column.</p>
maxLength: 4096
minLength: 1
type: string
required:
- ColumnId
- ColumnName
- Expression
type: object
maxItems: 128
minItems: 1
type: array
required:
- Columns
type: object
FilterOperation:
description: <p>A transform operation that filters rows based on a condition.</p>
properties:
ConditionExpression:
description: "<p>An expression that must evaluate to a Boolean value.\
\ Rows for which the expression\n evaluates to true\
\ are kept in the dataset.</p>"
maxLength: 4096
minLength: 1
type: string
required:
- ConditionExpression
type: object
ProjectOperation:
description: "<p>A transform operation that projects columns. Operations\
\ that come after a projection\n can only refer to projected\
\ columns.</p>"
properties:
ProjectedColumns:
description: <p>Projected columns.</p>
items:
type: string
maxItems: 2000
minItems: 1
type: array
required:
- ProjectedColumns
type: object
RenameColumnOperation:
description: <p>A transform operation that renames a column.</p>
properties:
ColumnName:
description: <p>The name of the column to be renamed.</p>
maxLength: 128
minLength: 1
type: string
NewColumnName:
description: <p>The new name for the column.</p>
maxLength: 128
minLength: 1
type: string
required:
- ColumnName
- NewColumnName
type: object
TagColumnOperation:
description: <p>A transform operation that tags a column with additional
information.</p>
properties:
ColumnName:
description: <p>The column that this operation acts on.</p>
maxLength: 128
minLength: 1
type: string
Tags:
description: "<p>The dataset column tag, currently only used for\
\ geospatial type tagging. .</p>\n <note>\n \
\ <p>This is not tags for the AWS tagging feature. .</p>\n \
\ </note>"
items:
description: "<p>A tag for a column in a <a>TagColumnOperation</a>\
\ structure. This is a\n variant type structure.\
\ For this structure to be valid, only one of the attributes\
\ can\n be non-null.</p>"
properties:
ColumnDescription:
description: <p>Metadata that contains a description for a
column.</p>
properties:
Text:
description: <p>The text of a description for a column.</p>
maxLength: 500
minLength: 0
type: string
type: object
ColumnGeographicRole:
enum:
- COUNTRY
- STATE
- COUNTY
- CITY
- POSTCODE
- LONGITUDE
- LATITUDE
- POLITICAL1
type: string
type: object
maxItems: 16
minItems: 1
type: array
required:
- ColumnName
- Tags
type: object
type: object
maxItems: 2048
minItems: 1
type: array
Source:
description: "<p>Information about the source of a logical table. This is\
\ a variant type structure. For\n this structure to be valid,\
\ only one of the attributes can be non-null.</p>"
properties:
JoinInstruction:
description: <p>Join instruction.</p>
properties:
LeftJoinKeyProperties:
properties:
UniqueKey:
type: boolean
type: object
LeftOperand:
description: <p>Left operand.</p>
maxLength: 64
minLength: 1
pattern: '[0-9a-zA-Z-]*'
type: string
OnClause:
description: <p>On Clause.</p>
maxLength: 512
minLength: 1
type: string
RightJoinKeyProperties:
properties:
UniqueKey:
type: boolean
type: object
RightOperand:
description: <p>Right operand.</p>
maxLength: 64
minLength: 1
pattern: '[0-9a-zA-Z-]*'
type: string
Type:
enum:
- INNER
- OUTER
- LEFT
- RIGHT
type: string
required:
- LeftOperand
- OnClause
- RightOperand
- Type
type: object
PhysicalTableId:
description: <p>Physical table ID.</p>
maxLength: 64
minLength: 1
pattern: '[0-9a-zA-Z-]*'
type: string
type: object
required:
- Alias
- Source
type: object
LogicalTableMap:
maxProperties: 64
minProperties: 1
patternProperties:
'[0-9a-zA-Z-]*':
description: "<p>A <i>logical table</i> is a unit that joins and that data\n\
\ transformations operate on. A logical table has a source, which\
\ can be either a physical\n table or result of a join. When\
\ a logical table points to a physical table, the logical\n table\
\ acts as a mutable copy of that physical table through transform operations.</p>"
properties:
Alias:
description: <p>A display name for the logical table.</p>
maxLength: 64
minLength: 1
type: string
DataTransforms:
description: <p>Transform operations that act on this logical table.</p>
items:
description: "<p>A data transformation on a logical table. This is a\
\ variant type structure. For this\n structure to be valid,\
\ only one of the attributes can be non-null.</p>"
properties:
CastColumnTypeOperation:
description: <p>A transform operation that casts a column to a different
type.</p>
properties:
ColumnName:
description: <p>Column name.</p>
maxLength: 128
minLength: 1
type: string
Format:
description: "<p>When casting a column from string to datetime\
\ type, you can supply a string in a\n format supported\
\ by Amazon QuickSight to denote the source data format.</p>"
maxLength: 32
minLength: 0
type: string
NewColumnType:
enum:
- STRING
- INTEGER
- DECIMAL
- DATETIME
type: string
required:
- ColumnName
- NewColumnType
type: object
CreateColumnsOperation:
description: "<p>A transform operation that creates calculated columns.\
\ Columns created in one such\n operation form a lexical\
\ closure.</p>"
properties:
Columns:
description: <p>Calculated columns to create.</p>
items:
description: <p>A calculated column for a dataset.</p>
properties:
ColumnId:
description: "<p>A unique ID to identify a calculated\
\ column. During a dataset update, if the column ID\n\
\ of a calculated column matches that of\
\ an existing calculated column, Amazon QuickSight\n\
\ preserves the existing calculated column.</p>"
maxLength: 64
minLength: 1
type: string
ColumnName:
description: <p>Column name.</p>
maxLength: 128
minLength: 1
type: string
Expression:
description: <p>An expression that defines the calculated
column.</p>
maxLength: 4096
minLength: 1
type: string
required:
- ColumnId
- ColumnName
- Expression
type: object
maxItems: 128
minItems: 1
type: array
required:
- Columns
type: object
FilterOperation:
description: <p>A transform operation that filters rows based on
a condition.</p>
properties:
ConditionExpression:
description: "<p>An expression that must evaluate to a Boolean\
\ value. Rows for which the expression\n evaluates\
\ to true are kept in the dataset.</p>"
maxLength: 4096
minLength: 1
type: string
required:
- ConditionExpression
type: object
ProjectOperation:
description: "<p>A transform operation that projects columns. Operations\
\ that come after a projection\n can only refer to\
\ projected columns.</p>"
properties:
ProjectedColumns:
description: <p>Projected columns.</p>
items:
type: string
maxItems: 2000
minItems: 1
type: array
required:
- ProjectedColumns
type: object
RenameColumnOperation:
description: <p>A transform operation that renames a column.</p>
properties:
ColumnName:
description: <p>The name of the column to be renamed.</p>
maxLength: 128
minLength: 1
type: string
NewColumnName:
description: <p>The new name for the column.</p>
maxLength: 128
minLength: 1
type: string
required:
- ColumnName
- NewColumnName
type: object
TagColumnOperation:
description: <p>A transform operation that tags a column with additional
information.</p>
properties:
ColumnName:
description: <p>The column that this operation acts on.</p>
maxLength: 128
minLength: 1
type: string
Tags:
description: "<p>The dataset column tag, currently only used\
\ for geospatial type tagging. .</p>\n <note>\n \
\ <p>This is not tags for the AWS tagging feature.\
\ .</p>\n </note>"
items:
description: "<p>A tag for a column in a <a>TagColumnOperation</a>\
\ structure. This is a\n variant type structure.\
\ For this structure to be valid, only one of the attributes\
\ can\n be non-null.</p>"
properties:
ColumnDescription:
description: <p>Metadata that contains a description for
a column.</p>
properties:
Text:
description: <p>The text of a description for a column.</p>
maxLength: 500
minLength: 0
type: string
type: object
ColumnGeographicRole:
enum:
- COUNTRY
- STATE
- COUNTY
- CITY
- POSTCODE
- LONGITUDE
- LATITUDE
- POLITICAL1
type: string
type: object
maxItems: 16
minItems: 1
type: array
required:
- ColumnName
- Tags
type: object
type: object
maxItems: 2048
minItems: 1
type: array
Source:
description: "<p>Information about the source of a logical table. This\
\ is a variant type structure. For\n this structure to be\
\ valid, only one of the attributes can be non-null.</p>"
properties:
JoinInstruction:
description: <p>Join instruction.</p>
properties:
LeftJoinKeyProperties:
properties:
UniqueKey:
type: boolean
type: object
LeftOperand:
description: <p>Left operand.</p>
maxLength: 64
minLength: 1
pattern: '[0-9a-zA-Z-]*'
type: string
OnClause:
description: <p>On Clause.</p>
maxLength: 512
minLength: 1
type: string
RightJoinKeyProperties:
properties:
UniqueKey:
type: boolean
type: object
RightOperand:
description: <p>Right operand.</p>
maxLength: 64
minLength: 1
pattern: '[0-9a-zA-Z-]*'
type: string
Type:
enum:
- INNER
- OUTER
- LEFT
- RIGHT
type: string
required:
- LeftOperand
- OnClause
- RightOperand
- Type
type: object
PhysicalTableId:
description: <p>Physical table ID.</p>
maxLength: 64
minLength: 1
pattern: '[0-9a-zA-Z-]*'
type: string
type: object
required:
- Alias
- Source
type: object
type: object
LogicalTableSource:
description: "<p>Information about the source of a logical table. This is a variant\
\ type structure. For\n this structure to be valid, only one of the\
\ attributes can be non-null.</p>"
properties:
JoinInstruction:
description: <p>Join instruction.</p>
properties:
LeftJoinKeyProperties:
properties:
UniqueKey:
type: boolean
type: object
LeftOperand:
description: <p>Left operand.</p>
maxLength: 64
minLength: 1
pattern: '[0-9a-zA-Z-]*'
type: string
OnClause:
description: <p>On Clause.</p>
maxLength: 512
minLength: 1
type: string
RightJoinKeyProperties:
properties:
UniqueKey:
type: boolean
type: object
RightOperand:
description: <p>Right operand.</p>
maxLength: 64
minLength: 1
pattern: '[0-9a-zA-Z-]*'
type: string
Type:
enum:
- INNER
- OUTER
- LEFT
- RIGHT
type: string
required:
- LeftOperand
- OnClause
- RightOperand
- Type
type: object
PhysicalTableId:
description: <p>Physical table ID.</p>
maxLength: 64
minLength: 1
pattern: '[0-9a-zA-Z-]*'
type: string
type: object
OutputColumn:
description: <p>Output column.</p>
properties:
Description:
description: <p>A description for a column.</p>
maxLength: 500
minLength: 0
type: string
Name:
description: <p>A display name for the dataset.</p>
maxLength: 128
minLength: 1
type: string
Type:
enum:
- STRING
- INTEGER
- DECIMAL
- DATETIME
type: string
type: object
PhysicalTable:
description: "<p>A view of a data source that contains information about the shape\
\ of the data in the\n underlying source. This is a variant type\
\ structure. For this structure to be valid,\n only one of the attributes\
\ can be non-null.</p>"
properties:
CustomSql:
description: <p>A physical table type built from the results of the custom
SQL query.</p>
properties:
Columns:
description: <p>The column schema from the SQL query result set.</p>
items:
description: <p>Metadata for a column that is used as the input of a
transform operation.</p>
properties:
Name:
description: <p>The name of this column in the underlying data source.</p>
maxLength: 128
minLength: 1
type: string
Type:
enum:
- STRING
- INTEGER
- DECIMAL
- DATETIME
- BIT
- BOOLEAN
- JSON
type: string
required:
- Name
- Type
type: object
maxItems: 2048
minItems: 1
type: array
DataSourceArn:
description: <p>The Amazon Resource Name (ARN) of the data source.</p>
type: string
Name:
description: <p>A display name for the SQL query result.</p>
maxLength: 128
minLength: 1
type: string
SqlQuery:
description: <p>The SQL query.</p>
maxLength: 65536
minLength: 1
type: string
required:
- Columns
- DataSourceArn
- Name
- SqlQuery
type: object
RelationalTable:
description: <p>A physical table type for relational data sources.</p>
properties:
Catalog:
description: <p>The catalog associated with a table.</p>
maxLength: 256
minLength: 0
type: string
DataSourceArn:
description: <p>The Amazon Resource Name (ARN) for the data source.</p>
type: string
InputColumns:
description: <p>The column schema of the table.</p>
items:
description: <p>Metadata for a column that is used as the input of a
transform operation.</p>
properties:
Name:
description: <p>The name of this column in the underlying data source.</p>
maxLength: 128
minLength: 1
type: string
Type:
enum:
- STRING
- INTEGER
- DECIMAL
- DATETIME
- BIT
- BOOLEAN
- JSON
type: string
required:
- Name
- Type
type: object
maxItems: 2048
minItems: 1
type: array
Name:
description: <p>The name of the relational table.</p>
maxLength: 64
minLength: 1
type: string
Schema:
description: <p>The schema name. This name applies to certain relational
database engines.</p>
maxLength: 64
minLength: 0
type: string
required:
- DataSourceArn
- InputColumns
- Name
type: object
S3Source:
description: <p>A physical table type for as S3 data source.</p>
properties:
DataSourceArn:
description: <p>The amazon Resource Name (ARN) for the data source.</p>
type: string
InputColumns:
description: <p>A physical table type for as S3 data source.</p>
items:
description: <p>Metadata for a column that is used as the input of a
transform operation.</p>
properties:
Name:
description: <p>The name of this column in the underlying data source.</p>
maxLength: 128
minLength: 1
type: string
Type:
enum:
- STRING
- INTEGER
- DECIMAL
- DATETIME
- BIT
- BOOLEAN
- JSON
type: string
required:
- Name
- Type
type: object
maxItems: 2048
minItems: 1
type: array
UploadSettings:
description: <p>Information about the format for a source file or files.</p>
properties:
ContainsHeader:
description: <p>Whether the file has a header row, or the files each
have a header row.</p>
type: boolean
Delimiter:
description: <p>The delimiter between values in the file.</p>
maxLength: 1
minLength: 1
type: string
Format:
enum:
- CSV
- TSV
- CLF
- ELF
- XLSX
- JSON
type: string
StartFromRow:
description: <p>A row number to start reading data from.</p>
minimum: 1
type: number
TextQualifier:
enum:
- DOUBLE_QUOTE
- SINGLE_QUOTE
type: string
type: object
required:
- DataSourceArn
- InputColumns
type: object
type: object
PhysicalTableMap:
maxProperties: 32
minProperties: 1
patternProperties:
'[0-9a-zA-Z-]*':
description: "<p>A view of a data source that contains information about the\
\ shape of the data in the\n underlying source. This is a variant\
\ type structure. For this structure to be valid,\n only one\
\ of the attributes can be non-null.</p>"
properties:
CustomSql:
description: <p>A physical table type built from the results of the custom
SQL query.</p>
properties:
Columns:
description: <p>The column schema from the SQL query result set.</p>
items:
description: <p>Metadata for a column that is used as the input
of a transform operation.</p>
properties:
Name:
description: <p>The name of this column in the underlying data
source.</p>
maxLength: 128
minLength: 1
type: string
Type:
enum:
- STRING
- INTEGER
- DECIMAL
- DATETIME
- BIT
- BOOLEAN
- JSON
type: string
required:
- Name
- Type
type: object
maxItems: 2048
minItems: 1
type: array
DataSourceArn:
description: <p>The Amazon Resource Name (ARN) of the data source.</p>
type: string
Name:
description: <p>A display name for the SQL query result.</p>
maxLength: 128
minLength: 1
type: string
SqlQuery:
description: <p>The SQL query.</p>
maxLength: 65536
minLength: 1
type: string
required:
- Columns
- DataSourceArn
- Name
- SqlQuery
type: object
RelationalTable:
description: <p>A physical table type for relational data sources.</p>
properties:
Catalog:
description: <p>The catalog associated with a table.</p>
maxLength: 256
minLength: 0
type: string
DataSourceArn:
description: <p>The Amazon Resource Name (ARN) for the data source.</p>
type: string
InputColumns:
description: <p>The column schema of the table.</p>
items:
description: <p>Metadata for a column that is used as the input
of a transform operation.</p>
properties:
Name:
description: <p>The name of this column in the underlying data
source.</p>
maxLength: 128
minLength: 1
type: string
Type:
enum:
- STRING
- INTEGER
- DECIMAL
- DATETIME
- BIT
- BOOLEAN
- JSON
type: string
required:
- Name
- Type
type: object
maxItems: 2048
minItems: 1
type: array
Name:
description: <p>The name of the relational table.</p>
maxLength: 64
minLength: 1
type: string
Schema:
description: <p>The schema name. This name applies to certain relational
database engines.</p>
maxLength: 64
minLength: 0
type: string
required:
- DataSourceArn
- InputColumns
- Name
type: object
S3Source:
description: <p>A physical table type for as S3 data source.</p>
properties:
DataSourceArn:
description: <p>The amazon Resource Name (ARN) for the data source.</p>
type: string
InputColumns:
description: <p>A physical table type for as S3 data source.</p>
items:
description: <p>Metadata for a column that is used as the input
of a transform operation.</p>
properties:
Name:
description: <p>The name of this column in the underlying data
source.</p>
maxLength: 128
minLength: 1
type: string
Type:
enum:
- STRING
- INTEGER
- DECIMAL
- DATETIME
- BIT
- BOOLEAN
- JSON
type: string
required:
- Name
- Type
type: object
maxItems: 2048
minItems: 1
type: array
UploadSettings:
description: <p>Information about the format for a source file or
files.</p>
properties:
ContainsHeader:
description: <p>Whether the file has a header row, or the files
each have a header row.</p>
type: boolean
Delimiter:
description: <p>The delimiter between values in the file.</p>
maxLength: 1
minLength: 1
type: string
Format:
enum:
- CSV
- TSV
- CLF
- ELF
- XLSX
- JSON
type: string
StartFromRow:
description: <p>A row number to start reading data from.</p>
minimum: 1
type: number
TextQualifier:
enum:
- DOUBLE_QUOTE
- SINGLE_QUOTE
type: string
type: object
required:
- DataSourceArn
- InputColumns
type: object
type: object
type: object
ProjectOperation:
description: "<p>A transform operation that projects columns. Operations that\
\ come after a projection\n can only refer to projected columns.</p>"
properties:
ProjectedColumns:
description: <p>Projected columns.</p>
items:
type: string
maxItems: 2000
minItems: 1
type: array
required:
- ProjectedColumns
type: object
RelationalTable:
description: <p>A physical table type for relational data sources.</p>
properties:
Catalog:
description: <p>The catalog associated with a table.</p>
maxLength: 256
minLength: 0
type: string
DataSourceArn:
description: <p>The Amazon Resource Name (ARN) for the data source.</p>
type: string
InputColumns:
description: <p>The column schema of the table.</p>
items:
description: <p>Metadata for a column that is used as the input of a transform
operation.</p>
properties:
Name:
description: <p>The name of this column in the underlying data source.</p>
maxLength: 128
minLength: 1
type: string
Type:
enum:
- STRING
- INTEGER
- DECIMAL
- DATETIME
- BIT
- BOOLEAN
- JSON
type: string
required:
- Name
- Type
type: object
maxItems: 2048
minItems: 1
type: array
Name:
description: <p>The name of the relational table.</p>
maxLength: 64
minLength: 1
type: string
Schema:
description: <p>The schema name. This name applies to certain relational database
engines.</p>
maxLength: 64
minLength: 0
type: string
required:
- DataSourceArn
- InputColumns
- Name
type: object
RenameColumnOperation:
description: <p>A transform operation that renames a column.</p>
properties:
ColumnName:
description: <p>The name of the column to be renamed.</p>
maxLength: 128
minLength: 1
type: string
NewColumnName:
description: <p>The new name for the column.</p>
maxLength: 128
minLength: 1
type: string
required:
- ColumnName
- NewColumnName
type: object
ResourcePermission:
description: <p>Permission for the resource.</p>
properties:
Actions:
description: <p>The IAM action to grant or revoke permissions on.</p>
items:
type: string
maxItems: 16
minItems: 1
type: array
Principal:
description: "<p>The Amazon Resource Name (ARN) of the principal. This can\
\ be one of the\n following:</p>\n <ul>\n <li>\n\
\ <p>The ARN of an Amazon QuickSight user or group associated\
\ with a data source or dataset. (This is common.)</p>\n </li>\n\
\ <li>\n <p>The ARN of an Amazon QuickSight user,\
\ group, or namespace associated with an analysis, dashboard, template,\
\ or theme. (This is common.)</p>\n </li>\n <li>\n\
\ <p>The ARN of an AWS account root: This is an IAM ARN rather\
\ than a QuickSight\n ARN. Use this option only to share\
\ resources (templates) across AWS accounts.\n (This\
\ is less common.) </p>\n </li>\n </ul>"
maxLength: 256
minLength: 1
type: string
required:
- Actions
- Principal
type: object
RowLevelPermissionDataSet:
description: <p>The row-level security configuration for the dataset.</p>
properties:
Arn:
description: <p>The Amazon Resource Name (ARN) of the permission dataset.</p>
type: string
FormatVersion:
enum:
- VERSION_1
- VERSION_2
type: string
Namespace:
description: <p>The namespace associated with the row-level permissions dataset.</p>
maxLength: 64
minLength: 0
pattern: ^[a-zA-Z0-9._-]*$
type: string
PermissionPolicy:
enum:
- GRANT_ACCESS
- DENY_ACCESS
type: string
required:
- Arn
- PermissionPolicy
type: object
RowLevelPermissionFormatVersion:
enum:
- VERSION_1
- VERSION_2
type: string
RowLevelPermissionPolicy:
enum:
- GRANT_ACCESS
- DENY_ACCESS
type: string
S3Source:
description: <p>A physical table type for as S3 data source.</p>
properties:
DataSourceArn:
description: <p>The amazon Resource Name (ARN) for the data source.</p>
type: string
InputColumns:
description: <p>A physical table type for as S3 data source.</p>
items:
description: <p>Metadata for a column that is used as the input of a transform
operation.</p>
properties:
Name:
description: <p>The name of this column in the underlying data source.</p>
maxLength: 128
minLength: 1
type: string
Type:
enum:
- STRING
- INTEGER
- DECIMAL
- DATETIME
- BIT
- BOOLEAN
- JSON
type: string
required:
- Name
- Type
type: object
maxItems: 2048
minItems: 1
type: array
UploadSettings:
description: <p>Information about the format for a source file or files.</p>
properties:
ContainsHeader:
description: <p>Whether the file has a header row, or the files each have
a header row.</p>
type: boolean
Delimiter:
description: <p>The delimiter between values in the file.</p>
maxLength: 1
minLength: 1
type: string
Format:
enum:
- CSV
- TSV
- CLF
- ELF
- XLSX
- JSON
type: string
StartFromRow:
description: <p>A row number to start reading data from.</p>
minimum: 1
type: number
TextQualifier:
enum:
- DOUBLE_QUOTE
- SINGLE_QUOTE
type: string
type: object
required:
- DataSourceArn
- InputColumns
type: object
Tag:
description: "<p>The key or keys of the key-value pairs for the resource tag or\
\ tags assigned to the\n resource.</p>"
properties:
Key:
description: <p>Tag key.</p>
maxLength: 128
minLength: 1
type: string
Value:
description: <p>Tag value.</p>
maxLength: 256
minLength: 1
type: string
required:
- Key
- Value
type: object
TagColumnOperation:
description: <p>A transform operation that tags a column with additional information.</p>
properties:
ColumnName:
description: <p>The column that this operation acts on.</p>
maxLength: 128
minLength: 1
type: string
Tags:
description: "<p>The dataset column tag, currently only used for geospatial\
\ type tagging. .</p>\n <note>\n <p>This is not tags for\
\ the AWS tagging feature. .</p>\n </note>"
items:
description: "<p>A tag for a column in a <a>TagColumnOperation</a> structure.\
\ This is a\n variant type structure. For this structure to\
\ be valid, only one of the attributes can\n be non-null.</p>"
properties:
ColumnDescription:
description: <p>Metadata that contains a description for a column.</p>
properties:
Text:
description: <p>The text of a description for a column.</p>
maxLength: 500
minLength: 0
type: string
type: object
ColumnGeographicRole:
enum:
- COUNTRY
- STATE
- COUNTY
- CITY
- POSTCODE
- LONGITUDE
- LATITUDE
- POLITICAL1
type: string
type: object
maxItems: 16
minItems: 1
type: array
required:
- ColumnName
- Tags
type: object
TextQualifier:
enum:
- DOUBLE_QUOTE
- SINGLE_QUOTE
type: string
TransformOperation:
description: "<p>A data transformation on a logical table. This is a variant type\
\ structure. For this\n structure to be valid, only one of the attributes\
\ can be non-null.</p>"
properties:
CastColumnTypeOperation:
description: <p>A transform operation that casts a column to a different type.</p>
properties:
ColumnName:
description: <p>Column name.</p>
maxLength: 128
minLength: 1
type: string
Format:
description: "<p>When casting a column from string to datetime type, you\
\ can supply a string in a\n format supported by Amazon QuickSight\
\ to denote the source data format.</p>"
maxLength: 32
minLength: 0
type: string
NewColumnType:
enum:
- STRING
- INTEGER
- DECIMAL
- DATETIME
type: string
required:
- ColumnName
- NewColumnType
type: object
CreateColumnsOperation:
description: "<p>A transform operation that creates calculated columns. Columns\
\ created in one such\n operation form a lexical closure.</p>"
properties:
Columns:
description: <p>Calculated columns to create.</p>
items:
description: <p>A calculated column for a dataset.</p>
properties:
ColumnId:
description: "<p>A unique ID to identify a calculated column. During\
\ a dataset update, if the column ID\n of a calculated\
\ column matches that of an existing calculated column, Amazon\
\ QuickSight\n preserves the existing calculated column.</p>"
maxLength: 64
minLength: 1
type: string
ColumnName:
description: <p>Column name.</p>
maxLength: 128
minLength: 1
type: string
Expression:
description: <p>An expression that defines the calculated column.</p>
maxLength: 4096
minLength: 1
type: string
required:
- ColumnId
- ColumnName
- Expression
type: object
maxItems: 128
minItems: 1
type: array
required:
- Columns
type: object
FilterOperation:
description: <p>A transform operation that filters rows based on a condition.</p>
properties:
ConditionExpression:
description: "<p>An expression that must evaluate to a Boolean value.\
\ Rows for which the expression\n evaluates to true are kept\
\ in the dataset.</p>"
maxLength: 4096
minLength: 1
type: string
required:
- ConditionExpression
type: object
ProjectOperation:
description: "<p>A transform operation that projects columns. Operations that\
\ come after a projection\n can only refer to projected columns.</p>"
properties:
ProjectedColumns:
description: <p>Projected columns.</p>
items:
type: string
maxItems: 2000
minItems: 1
type: array
required:
- ProjectedColumns
type: object
RenameColumnOperation:
description: <p>A transform operation that renames a column.</p>
properties:
ColumnName:
description: <p>The name of the column to be renamed.</p>
maxLength: 128
minLength: 1
type: string
NewColumnName:
description: <p>The new name for the column.</p>
maxLength: 128
minLength: 1
type: string
required:
- ColumnName
- NewColumnName
type: object
TagColumnOperation:
description: <p>A transform operation that tags a column with additional information.</p>
properties:
ColumnName:
description: <p>The column that this operation acts on.</p>
maxLength: 128
minLength: 1
type: string
Tags:
description: "<p>The dataset column tag, currently only used for geospatial\
\ type tagging. .</p>\n <note>\n <p>This is not tags\
\ for the AWS tagging feature. .</p>\n </note>"
items:
description: "<p>A tag for a column in a <a>TagColumnOperation</a> structure.\
\ This is a\n variant type structure. For this structure\
\ to be valid, only one of the attributes can\n be non-null.</p>"
properties:
ColumnDescription:
description: <p>Metadata that contains a description for a column.</p>
properties:
Text:
description: <p>The text of a description for a column.</p>
maxLength: 500
minLength: 0
type: string
type: object
ColumnGeographicRole:
enum:
- COUNTRY
- STATE
- COUNTY
- CITY
- POSTCODE
- LONGITUDE
- LATITUDE
- POLITICAL1
type: string
type: object
maxItems: 16
minItems: 1
type: array
required:
- ColumnName
- Tags
type: object
type: object
UploadSettings:
description: <p>Information about the format for a source file or files.</p>
properties:
ContainsHeader:
description: <p>Whether the file has a header row, or the files each have
a header row.</p>
type: boolean
Delimiter:
description: <p>The delimiter between values in the file.</p>
maxLength: 1
minLength: 1
type: string
Format:
enum:
- CSV
- TSV
- CLF
- ELF
- XLSX
- JSON
type: string
StartFromRow:
description: <p>A row number to start reading data from.</p>
minimum: 1
type: number
TextQualifier:
enum:
- DOUBLE_QUOTE
- SINGLE_QUOTE
type: string
type: object
properties:
ColumnGroups:
description: <p>Groupings of columns that work together in certain QuickSight
features. Currently, only geospatial hierarchy is supported.</p>
items:
description: "<p>Groupings of columns that work together in certain Amazon QuickSight\
\ features. This is\n a variant type structure. For this structure\
\ to be valid, only one of the attributes can\n be non-null.</p>"
properties:
GeoSpatialColumnGroup:
description: <p>Geospatial column group that denotes a hierarchy.</p>
properties:
Columns:
description: <p>Columns in this hierarchy.</p>
items:
maxLength: 128
minLength: 1
type: string
maxItems: 16
minItems: 1
type: array
CountryCode:
enum:
- US
type: string
Name:
description: <p>A display name for the hierarchy.</p>
maxLength: 64
minLength: 1
type: string
required:
- Columns
- Name
type: object
type: object
maxItems: 8
minItems: 1
type: array
ColumnLevelPermissionRules:
items:
properties:
ColumnNames:
items:
type: string
minItems: 1
type: array
Principals:
items:
type: string
maxItems: 100
minItems: 1
type: array
type: object
minItems: 1
type: array
FieldFolders:
patternProperties:
.+:
properties:
Columns:
items:
type: string
maxItems: 5000
minItems: 0
type: array
Description:
maxLength: 500
minLength: 0
type: string
type: object
type: object
ImportMode:
enum:
- SPICE
- DIRECT_QUERY
type: string
IngestionWaitPolicy:
description: <p>Wait policy to use when creating/updating dataset. Default is
to wait for SPICE ingestion to finish with timeout of 36 hours.</p>
properties:
IngestionWaitTimeInHours:
default: 36
description: "<p>The maximum time (in hours) to wait for Ingestion to complete.\
\ Default timeout is 36 hours.\n Applicable only when DataSetImportMode\
\ mode is set to SPICE and WaitForSpiceIngestion is set to true.</p>"
maximum: 36
minimum: 1
type: number
WaitForSpiceIngestion:
default: true
description: "<p>Wait for SPICE ingestion to finish to mark dataset creation/update\
\ successful. Default (true).\n Applicable only when DataSetImportMode\
\ mode is set to SPICE.</p>"
type: boolean
type: object
LogicalTableMap:
maxProperties: 64
minProperties: 1
patternProperties:
'[0-9a-zA-Z-]*':
description: "<p>A <i>logical table</i> is a unit that joins and that data\n\
\ transformations operate on. A logical table has a source, which\
\ can be either a physical\n table or result of a join. When\
\ a logical table points to a physical table, the logical\n table\
\ acts as a mutable copy of that physical table through transform operations.</p>"
properties:
Alias:
description: <p>A display name for the logical table.</p>
maxLength: 64
minLength: 1
type: string
DataTransforms:
description: <p>Transform operations that act on this logical table.</p>
items:
description: "<p>A data transformation on a logical table. This is a\
\ variant type structure. For this\n structure to be valid,\
\ only one of the attributes can be non-null.</p>"
properties:
CastColumnTypeOperation:
description: <p>A transform operation that casts a column to a different
type.</p>
properties:
ColumnName:
description: <p>Column name.</p>
maxLength: 128
minLength: 1
type: string
Format:
description: "<p>When casting a column from string to datetime\
\ type, you can supply a string in a\n format supported\
\ by Amazon QuickSight to denote the source data format.</p>"
maxLength: 32
minLength: 0
type: string
NewColumnType:
enum:
- STRING
- INTEGER
- DECIMAL
- DATETIME
type: string
required:
- ColumnName
- NewColumnType
type: object
CreateColumnsOperation:
description: "<p>A transform operation that creates calculated columns.\
\ Columns created in one such\n operation form a lexical\
\ closure.</p>"
properties:
Columns:
description: <p>Calculated columns to create.</p>
items:
description: <p>A calculated column for a dataset.</p>
properties:
ColumnId:
description: "<p>A unique ID to identify a calculated\
\ column. During a dataset update, if the column ID\n\
\ of a calculated column matches that of\
\ an existing calculated column, Amazon QuickSight\n\
\ preserves the existing calculated column.</p>"
maxLength: 64
minLength: 1
type: string
ColumnName:
description: <p>Column name.</p>
maxLength: 128
minLength: 1
type: string
Expression:
description: <p>An expression that defines the calculated
column.</p>
maxLength: 4096
minLength: 1
type: string
required:
- ColumnId
- ColumnName
- Expression
type: object
maxItems: 128
minItems: 1
type: array
required:
- Columns
type: object
FilterOperation:
description: <p>A transform operation that filters rows based on
a condition.</p>
properties:
ConditionExpression:
description: "<p>An expression that must evaluate to a Boolean\
\ value. Rows for which the expression\n evaluates\
\ to true are kept in the dataset.</p>"
maxLength: 4096
minLength: 1
type: string
required:
- ConditionExpression
type: object
ProjectOperation:
description: "<p>A transform operation that projects columns. Operations\
\ that come after a projection\n can only refer to\
\ projected columns.</p>"
properties:
ProjectedColumns:
description: <p>Projected columns.</p>
items:
type: string
maxItems: 2000
minItems: 1
type: array
required:
- ProjectedColumns
type: object
RenameColumnOperation:
description: <p>A transform operation that renames a column.</p>
properties:
ColumnName:
description: <p>The name of the column to be renamed.</p>
maxLength: 128
minLength: 1
type: string
NewColumnName:
description: <p>The new name for the column.</p>
maxLength: 128
minLength: 1
type: string
required:
- ColumnName
- NewColumnName
type: object
TagColumnOperation:
description: <p>A transform operation that tags a column with additional
information.</p>
properties:
ColumnName:
description: <p>The column that this operation acts on.</p>
maxLength: 128
minLength: 1
type: string
Tags:
description: "<p>The dataset column tag, currently only used\
\ for geospatial type tagging. .</p>\n <note>\n \
\ <p>This is not tags for the AWS tagging feature.\
\ .</p>\n </note>"
items:
description: "<p>A tag for a column in a <a>TagColumnOperation</a>\
\ structure. This is a\n variant type structure.\
\ For this structure to be valid, only one of the attributes\
\ can\n be non-null.</p>"
properties:
ColumnDescription:
description: <p>Metadata that contains a description for
a column.</p>
properties:
Text:
description: <p>The text of a description for a column.</p>
maxLength: 500
minLength: 0
type: string
type: object
ColumnGeographicRole:
enum:
- COUNTRY
- STATE
- COUNTY
- CITY
- POSTCODE
- LONGITUDE
- LATITUDE
- POLITICAL1
type: string
type: object
maxItems: 16
minItems: 1
type: array
required:
- ColumnName
- Tags
type: object
type: object
maxItems: 2048
minItems: 1
type: array
Source:
description: "<p>Information about the source of a logical table. This\
\ is a variant type structure. For\n this structure to be\
\ valid, only one of the attributes can be non-null.</p>"
properties:
JoinInstruction:
description: <p>Join instruction.</p>
properties:
LeftJoinKeyProperties:
properties:
UniqueKey:
type: boolean
type: object
LeftOperand:
description: <p>Left operand.</p>
maxLength: 64
minLength: 1
pattern: '[0-9a-zA-Z-]*'
type: string
OnClause:
description: <p>On Clause.</p>
maxLength: 512
minLength: 1
type: string
RightJoinKeyProperties:
properties:
UniqueKey:
type: boolean
type: object
RightOperand:
description: <p>Right operand.</p>
maxLength: 64
minLength: 1
pattern: '[0-9a-zA-Z-]*'
type: string
Type:
enum:
- INNER
- OUTER
- LEFT
- RIGHT
type: string
required:
- LeftOperand
- OnClause
- RightOperand
- Type
type: object
PhysicalTableId:
description: <p>Physical table ID.</p>
maxLength: 64
minLength: 1
pattern: '[0-9a-zA-Z-]*'
type: string
type: object
required:
- Alias
- Source
type: object
type: object
Name:
description: <p>The display name for the dataset.</p>
maxLength: 128
minLength: 1
type: string
Permissions:
description: <p>A list of resource permissions on the dataset.</p>
items:
description: <p>Permission for the resource.</p>
properties:
Actions:
description: <p>The IAM action to grant or revoke permissions on.</p>
items:
type: string
maxItems: 16
minItems: 1
type: array
Principal:
description: "<p>The Amazon Resource Name (ARN) of the principal. This can\
\ be one of the\n following:</p>\n <ul>\n \
\ <li>\n <p>The ARN of an Amazon QuickSight user or group\
\ associated with a data source or dataset. (This is common.)</p>\n \
\ </li>\n <li>\n <p>The ARN of an Amazon\
\ QuickSight user, group, or namespace associated with an analysis, dashboard,\
\ template, or theme. (This is common.)</p>\n </li>\n \
\ <li>\n <p>The ARN of an AWS account root: This\
\ is an IAM ARN rather than a QuickSight\n ARN. Use\
\ this option only to share resources (templates) across AWS accounts.\n\
\ (This is less common.) </p>\n </li>\n\
\ </ul>"
maxLength: 256
minLength: 1
type: string
required:
- Actions
- Principal
type: object
maxItems: 64
minItems: 1
type: array
PhysicalTableMap:
maxProperties: 32
minProperties: 1
patternProperties:
'[0-9a-zA-Z-]*':
description: "<p>A view of a data source that contains information about the\
\ shape of the data in the\n underlying source. This is a variant\
\ type structure. For this structure to be valid,\n only one\
\ of the attributes can be non-null.</p>"
properties:
CustomSql:
description: <p>A physical table type built from the results of the custom
SQL query.</p>
properties:
Columns:
description: <p>The column schema from the SQL query result set.</p>
items:
description: <p>Metadata for a column that is used as the input
of a transform operation.</p>
properties:
Name:
description: <p>The name of this column in the underlying data
source.</p>
maxLength: 128
minLength: 1
type: string
Type:
enum:
- STRING
- INTEGER
- DECIMAL
- DATETIME
- BIT
- BOOLEAN
- JSON
type: string
required:
- Name
- Type
type: object
maxItems: 2048
minItems: 1
type: array
DataSourceArn:
description: <p>The Amazon Resource Name (ARN) of the data source.</p>
type: string
Name:
description: <p>A display name for the SQL query result.</p>
maxLength: 128
minLength: 1
type: string
SqlQuery:
description: <p>The SQL query.</p>
maxLength: 65536
minLength: 1
type: string
required:
- Columns
- DataSourceArn
- Name
- SqlQuery
type: object
RelationalTable:
description: <p>A physical table type for relational data sources.</p>
properties:
Catalog:
description: <p>The catalog associated with a table.</p>
maxLength: 256
minLength: 0
type: string
DataSourceArn:
description: <p>The Amazon Resource Name (ARN) for the data source.</p>
type: string
InputColumns:
description: <p>The column schema of the table.</p>
items:
description: <p>Metadata for a column that is used as the input
of a transform operation.</p>
properties:
Name:
description: <p>The name of this column in the underlying data
source.</p>
maxLength: 128
minLength: 1
type: string
Type:
enum:
- STRING
- INTEGER
- DECIMAL
- DATETIME
- BIT
- BOOLEAN
- JSON
type: string
required:
- Name
- Type
type: object
maxItems: 2048
minItems: 1
type: array
Name:
description: <p>The name of the relational table.</p>
maxLength: 64
minLength: 1
type: string
Schema:
description: <p>The schema name. This name applies to certain relational
database engines.</p>
maxLength: 64
minLength: 0
type: string
required:
- DataSourceArn
- InputColumns
- Name
type: object
S3Source:
description: <p>A physical table type for as S3 data source.</p>
properties:
DataSourceArn:
description: <p>The amazon Resource Name (ARN) for the data source.</p>
type: string
InputColumns:
description: <p>A physical table type for as S3 data source.</p>
items:
description: <p>Metadata for a column that is used as the input
of a transform operation.</p>
properties:
Name:
description: <p>The name of this column in the underlying data
source.</p>
maxLength: 128
minLength: 1
type: string
Type:
enum:
- STRING
- INTEGER
- DECIMAL
- DATETIME
- BIT
- BOOLEAN
- JSON
type: string
required:
- Name
- Type
type: object
maxItems: 2048
minItems: 1
type: array
UploadSettings:
description: <p>Information about the format for a source file or
files.</p>
properties:
ContainsHeader:
description: <p>Whether the file has a header row, or the files
each have a header row.</p>
type: boolean
Delimiter:
description: <p>The delimiter between values in the file.</p>
maxLength: 1
minLength: 1
type: string
Format:
enum:
- CSV
- TSV
- CLF
- ELF
- XLSX
- JSON
type: string
StartFromRow:
description: <p>A row number to start reading data from.</p>
minimum: 1
type: number
TextQualifier:
enum:
- DOUBLE_QUOTE
- SINGLE_QUOTE
type: string
type: object
required:
- DataSourceArn
- InputColumns
type: object
type: object
type: object
RowLevelPermissionDataSet:
description: <p>The row-level security configuration for the dataset.</p>
properties:
Arn:
description: <p>The Amazon Resource Name (ARN) of the permission dataset.</p>
type: string
FormatVersion:
enum:
- VERSION_1
- VERSION_2
type: string
Namespace:
description: <p>The namespace associated with the row-level permissions dataset.</p>
maxLength: 64
minLength: 0
pattern: ^[a-zA-Z0-9._-]*$
type: string
PermissionPolicy:
enum:
- GRANT_ACCESS
- DENY_ACCESS
type: string
required:
- Arn
- PermissionPolicy
type: object
Tags:
description: <p>Contains a map of the key-value pairs for the resource tag or
tags assigned to the dataset.</p>
items:
description: "<p>The key or keys of the key-value pairs for the resource tag\
\ or tags assigned to the\n resource.</p>"
properties:
Key:
description: <p>Tag key.</p>
maxLength: 128
minLength: 1
type: string
Value:
description: <p>Tag value.</p>
maxLength: 256
minLength: 1
type: string
required:
- Key
- Value
type: object
maxItems: 200
minItems: 1
type: array
type:
enum:
- update
Permissions - quicksight:DescribeDataSet, quicksight:DescribeDataSetPermissions, quicksight:PassDataSource, quicksight:UpdateDataSet, quicksight:UpdateDataSetPermissions, quicksight:PassDataSet, quicksight:DescribeIngestion, quicksight:ListIngestions, quicksight:CancelIngestion, quicksight:TagResource, quicksight:UntagResource, quicksight:ListTagsForResource