describe-data-set¶

Description¶

Describes a dataset. This operation doesn’t support datasets that include uploaded files as a source.

Synopsis¶

  describe-data-set
--aws-account-id <value>
--data-set-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options¶

--aws-account-id (string) [required]

The Amazon Web Services account ID.

Constraints:

min: 12

max: 12

pattern: ^[0-9]{12}$

--data-set-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.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output¶

DataSet -> (structure)

Information on the dataset.

Arn -> (string)

The Amazon Resource Name (ARN) of the resource.

DataSetId -> (string)

The ID of the dataset. Limited to 96 characters.

Name -> (string)

A display name for the dataset.

Constraints:

min: 1

max: 128

CreatedTime -> (timestamp)

The time that this dataset was created.

LastUpdatedTime -> (timestamp)

The last time that this dataset was updated.

PhysicalTableMap -> (map)

Declares the physical tables that are available in the underlying data sources.

Constraints:

min: 0

max: 32

key -> (string)

Constraints:

min: 1

max: 64

pattern: [0-9a-zA-Z-]*

value -> (structure)

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 -> (structure)

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.

Constraints:

max: 256

Schema -> (string)

The schema name. This name applies to certain relational database engines.

Constraints:

max: 256

Name -> (string) [required]

The name of the relational table.

Constraints:

min: 1

max: 256

InputColumns -> (list) [required]

The column schema of the table.

Constraints:

min: 1

max: 2048

(structure)

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.

Constraints:

min: 1

max: 128

Type -> (string) [required]

The data type of the column.

Possible values:

STRING

INTEGER

DECIMAL

DATETIME

BIT

BOOLEAN

JSON

SubType -> (string)

The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset.

Possible values:

FLOAT

FIXED

CustomSql -> (structure)

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.

Constraints:

min: 1

max: 64

SqlQuery -> (string) [required]

The SQL query.

Constraints:

min: 1

max: 168000

Columns -> (list)

The column schema from the SQL query result set.

Constraints:

min: 1

max: 2048

(structure)

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.

Constraints:

min: 1

max: 128

Type -> (string) [required]

The data type of the column.

Possible values:

STRING

INTEGER

DECIMAL

DATETIME

BIT

BOOLEAN

JSON

SubType -> (string)

The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset.

Possible values:

FLOAT

FIXED

S3Source -> (structure)

A physical table type for as S3 data source.

DataSourceArn -> (string) [required]

The Amazon Resource Name (ARN) for the data source.

UploadSettings -> (structure)

Information about the format for the S3 source file or files.

Format -> (string)

File format.

Possible values:

CSV

TSV

CLF

ELF

XLSX

JSON

StartFromRow -> (integer)

A row number to start reading data from.

Constraints:

min: 1

ContainsHeader -> (boolean)

Whether the file has a header row, or the files each have a header row.

TextQualifier -> (string)

Text qualifier.

Possible values:

DOUBLE_QUOTE

SINGLE_QUOTE

Delimiter -> (string)

The delimiter between values in the file.

Constraints:

min: 1

max: 1

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.

Constraints:

min: 1

max: 2048

(structure)

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.

Constraints:

min: 1

max: 128

Type -> (string) [required]

The data type of the column.

Possible values:

STRING

INTEGER

DECIMAL

DATETIME

BIT

BOOLEAN

JSON

SubType -> (string)

The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset.

Possible values:

FLOAT

FIXED

LogicalTableMap -> (map)

Configures the combination and transformation of the data from the physical tables.

Constraints:

min: 1

max: 64

key -> (string)

An identifier for the logical table that is defined in the dataset

Constraints:

min: 1

max: 64

pattern: [0-9a-zA-Z-]*

value -> (structure)

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.

Constraints:

min: 1

max: 64

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.

Constraints:

min: 1

max: 2048

(structure)

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 -> (structure)

An operation that projects columns. Operations that come after a projection can only refer to projected columns.

ProjectedColumns -> (list) [required]

Projected columns.

Constraints:

min: 1

max: 2000

(string)

FilterOperation -> (structure)

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.

Constraints:

min: 1

max: 4096

CreateColumnsOperation -> (structure)

An operation that creates calculated columns. Columns created in one such operation form a lexical closure.

Columns -> (list) [required]

Calculated columns to create.

Constraints:

min: 1

max: 128

(structure)

A calculated column for a dataset.

ColumnName -> (string) [required]

Column name.

Constraints:

min: 1

max: 128

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.

Constraints:

min: 1

max: 64

Expression -> (string) [required]

An expression that defines the calculated column.

Constraints:

min: 1

max: 250000

RenameColumnOperation -> (structure)

An operation that renames a column.

ColumnName -> (string) [required]

The name of the column to be renamed.

Constraints:

min: 1

max: 128

NewColumnName -> (string) [required]

The new name for the column.

Constraints:

min: 1

max: 128

CastColumnTypeOperation -> (structure)

A transform operation that casts a column to a different type.

ColumnName -> (string) [required]

Column name.

Constraints:

min: 1

max: 128

NewColumnType -> (string) [required]

New column data type.

Possible values:

STRING

INTEGER

DECIMAL

DATETIME

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.

Possible values:

FLOAT

FIXED

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.

Constraints:

max: 32

TagColumnOperation -> (structure)

An operation that tags a column with additional information.

ColumnName -> (string) [required]

The column that this operation acts on.

Constraints:

min: 1

max: 128

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.

Constraints:

min: 1

max: 16

(structure)

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.

Possible values:

COUNTRY

STATE

COUNTY

CITY

POSTCODE

LONGITUDE

LATITUDE

ColumnDescription -> (structure)

A description for a column.

Text -> (string)

The text of a description for a column.

Constraints:

min: 0

max: 500

UntagColumnOperation -> (structure)

A transform operation that removes tags associated with a column.

ColumnName -> (string) [required]

The column that this operation acts on.

Constraints:

min: 1

max: 128

TagNames -> (list) [required]

The column tags to remove from this column.

(string)

Possible values:

COLUMN_GEOGRAPHIC_ROLE

COLUMN_DESCRIPTION

OverrideDatasetParameterOperation -> (structure)

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.

Constraints:

min: 1

max: 2048

pattern: ^[a-zA-Z0-9]+$

NewParameterName -> (string)

The new name for the parameter.

Constraints:

min: 1

max: 2048

pattern: ^[a-zA-Z0-9]+$

NewDefaultValues -> (structure)

The new default values for the parameter.

StringStaticValues -> (list)

A list of static default values for a given string parameter.

Constraints:

min: 1

max: 32

(string)

The default value for the string parameter.

Constraints:

min: 0

max: 512

DecimalStaticValues -> (list)

A list of static default values for a given decimal parameter.

Constraints:

min: 1

max: 32

(double)

The default value for the decimal parameter.

DateTimeStaticValues -> (list)

A list of static default values for a given date time parameter.

Constraints:

min: 1

max: 32

(timestamp)

The default value for the date time parameter.

IntegerStaticValues -> (list)

A list of static default values for a given integer parameter.

Constraints:

min: 1

max: 32

(long)

The default value for the integer parameter.

Source -> (structure) [required]

Source of this logical table.

JoinInstruction -> (structure)

Specifies the result of a join of two logical tables.

LeftOperand -> (string) [required]

The operand on the left side of a join.

Constraints:

min: 1

max: 64

pattern: [0-9a-zA-Z-]*

RightOperand -> (string) [required]

The operand on the right side of a join.

Constraints:

min: 1

max: 64

pattern: [0-9a-zA-Z-]*

LeftJoinKeyProperties -> (structure)

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 QuickSight to optimize query performance.

RightJoinKeyProperties -> (structure)

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 QuickSight to optimize query performance.

Type -> (string) [required]

The type of join that it is.

Possible values:

INNER

OUTER

LEFT

RIGHT

OnClause -> (string) [required]

The join instructions provided in the ON clause of a join.

Constraints:

min: 1

max: 512

PhysicalTableId -> (string)

Physical table ID.

Constraints:

min: 1

max: 64

pattern: [0-9a-zA-Z-]*

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.

(structure)

Output column.

Name -> (string)

The display name of the column..

Constraints:

min: 1

max: 128

Description -> (string)

A description for a column.

Constraints:

min: 0

max: 500

Type -> (string)

The data type of the column.

Possible values:

STRING

INTEGER

DECIMAL

DATETIME

SubType -> (string)

The sub data type of the column.

Possible values:

FLOAT

FIXED

ImportMode -> (string)

A value that indicates whether you want to import the data into SPICE.

Possible values:

SPICE

DIRECT_QUERY

ConsumedSpiceCapacityInBytes -> (long)

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.

Constraints:

min: 1

max: 8

(structure)

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 -> (structure)

Geospatial column group that denotes a hierarchy.

Name -> (string) [required]

A display name for the hierarchy.

Constraints:

min: 1

max: 64

CountryCode -> (string)

Country code.

Possible values:

US

Columns -> (list) [required]

Columns in this hierarchy.

Constraints:

min: 1

max: 16

(string)

Constraints:

min: 1

max: 128

FieldFolders -> (map)

The folder that contains fields and nested subfolders for your dataset.

key -> (string)

Constraints:

min: 1

max: 1000

value -> (structure)

A FieldFolder element is a folder that contains fields and nested subfolders.

description -> (string)

The description for a field folder.

Constraints:

max: 500

columns -> (list)

A folder has a list of columns. A column can only be in one folder.

Constraints:

max: 5000

(string)

RowLevelPermissionDataSet -> (structure)

The row-level security configuration for the dataset.

Namespace -> (string)

The namespace associated with the dataset that contains permissions for RLS.

Constraints:

max: 64

pattern: ^[a-zA-Z0-9._-]*$

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.

Possible values:

GRANT_ACCESS

DENY_ACCESS

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.

Possible values:

VERSION_1

VERSION_2

Status -> (string)

The status of the row-level security permission dataset. If enabled, the status is ENABLED . If disabled, the status is DISABLED .

Possible values:

ENABLED

DISABLED

RowLevelPermissionTagConfiguration -> (structure)

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 .

Possible values:

ENABLED

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.

Constraints:

min: 1

max: 50

(structure)

A set of rules associated with a tag.

TagKey -> (string) [required]

The unique key for a tag.

Constraints:

min: 1

max: 128

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.

Constraints:

max: 10

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.

Constraints:

min: 1

max: 256

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.

Constraints:

min: 1

max: 50

(list)

Constraints:

min: 1

max: 50

(string)

Constraints:

min: 1

max: 128

ColumnLevelPermissionRules -> (list)

A set of one or more definitions of a `` ColumnLevelPermissionRule `` .

Constraints:

min: 1

(structure)

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 QuickSight users or groups.

Constraints:

min: 1

max: 100

(string)

ColumnNames -> (list)

An array of column names.

Constraints:

min: 1

(string)

DataSetUsageConfiguration -> (structure)

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.

Constraints:

min: 1

max: 32

(structure)

A parameter that is created in a dataset. The parameter can be a string, integer, decimal, or datetime data type.

StringDatasetParameter -> (structure)

A string parameter that is created in the dataset.

Id -> (string) [required]

An identifier for the string parameter that is created in the dataset.

Constraints:

min: 1

max: 128

pattern: ^[a-zA-Z0-9-]+$

Name -> (string) [required]

The name of the string parameter that is created in the dataset.

Constraints:

min: 1

max: 2048

pattern: ^[a-zA-Z0-9]+$

ValueType -> (string) [required]

The value type of the dataset parameter. Valid values are single value or multi value .

Possible values:

MULTI_VALUED

SINGLE_VALUED

DefaultValues -> (structure)

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.

Constraints:

min: 1

max: 32

(string)

The default value for the string parameter.

Constraints:

min: 0

max: 512

DecimalDatasetParameter -> (structure)

A decimal parameter that is created in the dataset.

Id -> (string) [required]

An identifier for the decimal parameter created in the dataset.

Constraints:

min: 1

max: 128

pattern: ^[a-zA-Z0-9-]+$

Name -> (string) [required]

The name of the decimal parameter that is created in the dataset.

Constraints:

min: 1

max: 2048

pattern: ^[a-zA-Z0-9]+$

ValueType -> (string) [required]

The value type of the dataset parameter. Valid values are single value or multi value .

Possible values:

MULTI_VALUED

SINGLE_VALUED

DefaultValues -> (structure)

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.

Constraints:

min: 1

max: 32

(double)

The default value for the decimal parameter.

IntegerDatasetParameter -> (structure)

An integer parameter that is created in the dataset.

Id -> (string) [required]

An identifier for the integer parameter created in the dataset.

Constraints:

min: 1

max: 128

pattern: ^[a-zA-Z0-9-]+$

Name -> (string) [required]

The name of the integer parameter that is created in the dataset.

Constraints:

min: 1

max: 2048

pattern: ^[a-zA-Z0-9]+$

ValueType -> (string) [required]

The value type of the dataset parameter. Valid values are single value or multi value .

Possible values:

MULTI_VALUED

SINGLE_VALUED

DefaultValues -> (structure)

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.

Constraints:

min: 1

max: 32

(long)

The default value for the integer parameter.

DateTimeDatasetParameter -> (structure)

A date time parameter that is created in the dataset.

Id -> (string) [required]

An identifier for the parameter that is created in the dataset.

Constraints:

min: 1

max: 128

pattern: ^[a-zA-Z0-9-]+$

Name -> (string) [required]

The name of the date time parameter that is created in the dataset.

Constraints:

min: 1

max: 2048

pattern: ^[a-zA-Z0-9]+$

ValueType -> (string) [required]

The value type of the dataset parameter. Valid values are single value or multi value .

Possible values:

MULTI_VALUED

SINGLE_VALUED

TimeGranularity -> (string)

The time granularity of the date time parameter.

Possible values:

YEAR

QUARTER

MONTH

WEEK

DAY

HOUR

MINUTE

SECOND

MILLISECOND

DefaultValues -> (structure)

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.

Constraints:

min: 1

max: 32

(timestamp)

The default value for the date time parameter.

PerformanceConfiguration -> (structure)

The performance optimization configuration of a dataset.

UniqueKeys -> (list)

A UniqueKey configuration.

Constraints:

min: 1

max: 1

(structure)

A UniqueKey configuration that references a dataset column.

ColumnNames -> (list) [required]

The name of the column that is referenced in the UniqueKey configuration.

Constraints:

min: 1

max: 1

(string)

Constraints:

min: 1

max: 128

UseAs -> (string)

The usage of the dataset.

Possible values:

RLS_RULES

RequestId -> (string)

The Amazon Web Services request ID for this operation.

Status -> (integer)

The HTTP status of the request.

Table of Contents

Feedback

User Guide