Skip to content
AWS for Query.Farm

aws.quicksight.describe_data_set

Example SQL Queries

SELECT * FROM
aws.quicksight.describe_data_set
WHERE
"aws_account_id" = 'VALUE'
AND "data_set_id" = 'VALUE';

Description

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

Table Definition

Column NameColumn Data Type
aws_account_id Required Input Column

The Amazon Web Services account ID.

VARCHAR
data_set_id Required Input Column

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.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
data_set

Information on the dataset.

STRUCT(
    "arn" VARCHAR,
    "data_set_id" VARCHAR,
    "name" VARCHAR,
    "created_time" TIMESTAMP_S,
    "last_updated_time" TIMESTAMP_S,
    "physical_table_map" MAP(VARCHAR, STRUCT(
            "relational_table" STRUCT(
                "data_source_arn" VARCHAR,
                "catalog" VARCHAR,
                "schema" VARCHAR,
                "name" VARCHAR,
                "input_columns" STRUCT(
                    "name" VARCHAR,
                    "type" VARCHAR,
                    "sub_type" VARCHAR
                )[]
            ),
            "custom_sql" STRUCT(
                "data_source_arn" VARCHAR,
                "name" VARCHAR,
                "sql_query" VARCHAR,
                "columns" STRUCT(
                    "name" VARCHAR,
                    "type" VARCHAR,
                    "sub_type" VARCHAR
                )[]
            ),
            "s3_source" STRUCT(
                "data_source_arn" VARCHAR,
                "upload_settings" STRUCT(
                    "format" VARCHAR,
                    "start_from_row" BIGINT,
                    "contains_header" BOOLEAN,
                    "text_qualifier" VARCHAR,
                    "delimiter" VARCHAR
                ),
                "input_columns" STRUCT(
                    "name" VARCHAR,
                    "type" VARCHAR,
                    "sub_type" VARCHAR
                )[]
            )
        )),
    "logical_table_map" MAP(VARCHAR, STRUCT(
            "alias" VARCHAR,
            "data_transforms" STRUCT(
                "project_operation" STRUCT(
                    "projected_columns" VARCHAR[]
                ),
                "filter_operation" STRUCT(
                    "condition_expression" VARCHAR
                ),
                "create_columns_operation" STRUCT(
                    "columns" STRUCT(
                        "column_name" VARCHAR,
                        "column_id" VARCHAR,
                        "expression" VARCHAR
                    )[]
                ),
                "rename_column_operation" STRUCT(
                    "column_name" VARCHAR,
                    "new_column_name" VARCHAR
                ),
                "cast_column_type_operation" STRUCT(
                    "column_name" VARCHAR,
                    "new_column_type" VARCHAR,
                    "sub_type" VARCHAR,
                    "format" VARCHAR
                ),
                "tag_column_operation" STRUCT(
                    "column_name" VARCHAR,
                    "tags" STRUCT(
                        "column_geographic_role" VARCHAR,
                        "column_description" STRUCT(
                            "text" VARCHAR
                        )
                    )[]
                ),
                "untag_column_operation" STRUCT(
                    "column_name" VARCHAR,
                    "tag_names" VARCHAR[]
                ),
                "override_dataset_parameter_operation" STRUCT(
                    "parameter_name" VARCHAR,
                    "new_parameter_name" VARCHAR,
                    "new_default_values" STRUCT(
                        "string_static_values" VARCHAR[],
                        "decimal_static_values" DOUBLE[],
                        "date_time_static_values" TIMESTAMP_S[],
                        "integer_static_values" BIGINT[]
                    )
                )
            )[],
            "source" STRUCT(
                "join_instruction" STRUCT(
                    "left_operand" VARCHAR,
                    "right_operand" VARCHAR,
                    "left_join_key_properties" STRUCT(
                        "unique_key" BOOLEAN
                    ),
                    "right_join_key_properties" STRUCT(
                        "unique_key" BOOLEAN
                    ),
                    "type" VARCHAR,
                    "on_clause" VARCHAR
                ),
                "physical_table_id" VARCHAR,
                "data_set_arn" VARCHAR
            )
        )),
    "output_columns" STRUCT(
        "name" VARCHAR,
        "description" VARCHAR,
        "type" VARCHAR,
        "sub_type" VARCHAR
    )[],
    "import_mode" VARCHAR,
    "consumed_spice_capacity_in_bytes" BIGINT,
    "column_groups" STRUCT(
        "geo_spatial_column_group" STRUCT(
            "name" VARCHAR,
            "country_code" VARCHAR,
            "columns" VARCHAR[]
        )
    )[],
    "field_folders" MAP(VARCHAR, STRUCT(
            "description" VARCHAR,
            "columns" VARCHAR[]
        )),
    "row_level_permission_data_set" STRUCT(
        "namespace" VARCHAR,
        "arn" VARCHAR,
        "permission_policy" VARCHAR,
        "format_version" VARCHAR,
        "status" VARCHAR
    ),
    "row_level_permission_tag_configuration" STRUCT(
        "status" VARCHAR,
        "tag_rules" STRUCT(
            "tag_key" VARCHAR,
            "column_name" VARCHAR,
            "tag_multi_value_delimiter" VARCHAR,
            "match_all_value" VARCHAR
        )[],
        "tag_rule_configurations" VARCHAR[][]
    ),
    "column_level_permission_rules" STRUCT(
        "principals" VARCHAR[],
        "column_names" VARCHAR[]
    )[],
    "data_set_usage_configuration" STRUCT(
        "disable_use_as_direct_query_source" BOOLEAN,
        "disable_use_as_imported_source" BOOLEAN
    ),
    "dataset_parameters" STRUCT(
        "string_dataset_parameter" STRUCT(
            "id" VARCHAR,
            "name" VARCHAR,
            "value_type" VARCHAR,
            "default_values" STRUCT(
                "static_values" VARCHAR[]
            )
        ),
        "decimal_dataset_parameter" STRUCT(
            "id" VARCHAR,
            "name" VARCHAR,
            "value_type" VARCHAR,
            "default_values" STRUCT(
                "static_values" DOUBLE[]
            )
        ),
        "integer_dataset_parameter" STRUCT(
            "id" VARCHAR,
            "name" VARCHAR,
            "value_type" VARCHAR,
            "default_values" STRUCT(
                "static_values" BIGINT[]
            )
        ),
        "date_time_dataset_parameter" STRUCT(
            "id" VARCHAR,
            "name" VARCHAR,
            "value_type" VARCHAR,
            "time_granularity" VARCHAR,
            "default_values" STRUCT(
                "static_values" TIMESTAMP_S[]
            )
        )
    )[]
)
Show child fields
data_set.arn

The Amazon Resource Name (ARN) of the resource.

data_set.column_groups[]
Show child fields
data_set.column_groups[].geo_spatial_column_group

Geospatial column group that denotes a hierarchy.

Show child fields
data_set.column_groups[].geo_spatial_column_group.columns[]
data_set.column_groups[].geo_spatial_column_group.country_code

Country code.

data_set.column_groups[].geo_spatial_column_group.name

A display name for the hierarchy.

data_set.column_level_permission_rules[]
Show child fields
data_set.column_level_permission_rules[].column_names[]
data_set.column_level_permission_rules[].principals[]
data_set.consumed_spice_capacity_in_bytes

The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't imported into SPICE.

data_set.created_time

The time that this dataset was created.

data_set.data_set_id

The ID of the dataset.

data_set.data_set_usage_configuration

The usage configuration to apply to child datasets that reference this dataset as a source.

Show child fields
data_set.data_set_usage_configuration.disable_use_as_direct_query_source

An option that controls whether a child dataset of a direct query can use this dataset as a source.

data_set.data_set_usage_configuration.disable_use_as_imported_source

An option that controls whether a child dataset that's stored in QuickSight can use this dataset as a source.

data_set.dataset_parameters[]
Show child fields
data_set.dataset_parameters[].date_time_dataset_parameter

A date time parameter that is created in the dataset.

Show child fields
data_set.dataset_parameters[].date_time_dataset_parameter.default_values

A list of default values for a given date time parameter. This structure only accepts static values.

Show child fields
data_set.dataset_parameters[].date_time_dataset_parameter.default_values.static_values[]
data_set.dataset_parameters[].date_time_dataset_parameter.id

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

data_set.dataset_parameters[].date_time_dataset_parameter.name

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

data_set.dataset_parameters[].date_time_dataset_parameter.time_granularity

The time granularity of the date time parameter.

data_set.dataset_parameters[].date_time_dataset_parameter.value_type

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

data_set.dataset_parameters[].decimal_dataset_parameter

A decimal parameter that is created in the dataset.

Show child fields
data_set.dataset_parameters[].decimal_dataset_parameter.default_values

A list of default values for a given decimal parameter. This structure only accepts static values.

Show child fields
data_set.dataset_parameters[].decimal_dataset_parameter.default_values.static_values[]
data_set.dataset_parameters[].decimal_dataset_parameter.id

An identifier for the decimal parameter created in the dataset.

data_set.dataset_parameters[].decimal_dataset_parameter.name

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

data_set.dataset_parameters[].decimal_dataset_parameter.value_type

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

data_set.dataset_parameters[].integer_dataset_parameter

An integer parameter that is created in the dataset.

Show child fields
data_set.dataset_parameters[].integer_dataset_parameter.default_values

A list of default values for a given integer parameter. This structure only accepts static values.

Show child fields
data_set.dataset_parameters[].integer_dataset_parameter.default_values.static_values[]
data_set.dataset_parameters[].integer_dataset_parameter.id

An identifier for the integer parameter created in the dataset.

data_set.dataset_parameters[].integer_dataset_parameter.name

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

data_set.dataset_parameters[].integer_dataset_parameter.value_type

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

data_set.dataset_parameters[].string_dataset_parameter

A string parameter that is created in the dataset.

Show child fields
data_set.dataset_parameters[].string_dataset_parameter.default_values

A list of default values for a given string dataset parameter type. This structure only accepts static values.

Show child fields
data_set.dataset_parameters[].string_dataset_parameter.default_values.static_values[]
data_set.dataset_parameters[].string_dataset_parameter.id

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

data_set.dataset_parameters[].string_dataset_parameter.name

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

data_set.dataset_parameters[].string_dataset_parameter.value_type

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

data_set.field_folders

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

data_set.import_mode

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

data_set.last_updated_time

The last time that this dataset was updated.

data_set.logical_table_map

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

data_set.name

A display name for the dataset.

data_set.output_columns[]
Show child fields
data_set.output_columns[].description

A description for a column.

data_set.output_columns[].name

The display name of the column..

data_set.output_columns[].sub_type

The sub data type of the column.

data_set.output_columns[].type

The data type of the column.

data_set.physical_table_map

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

data_set.row_level_permission_data_set

The row-level security configuration for the dataset.

Show child fields
data_set.row_level_permission_data_set.arn

The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.

data_set.row_level_permission_data_set.format_version

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.

data_set.row_level_permission_data_set.namespace

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

data_set.row_level_permission_data_set.permission_policy

The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS is included for backward compatibility only.

data_set.row_level_permission_data_set.status

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

data_set.row_level_permission_tag_configuration

The element you can use to define tags for row-level security.

Show child fields
data_set.row_level_permission_tag_configuration.status

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

data_set.row_level_permission_tag_configuration.tag_rule_configurations[][]
data_set.row_level_permission_tag_configuration.tag_rules[]
Show child fields
data_set.row_level_permission_tag_configuration.tag_rules[].column_name

The column name that a tag key is assigned to.

data_set.row_level_permission_tag_configuration.tag_rules[].match_all_value

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.

data_set.row_level_permission_tag_configuration.tag_rules[].tag_key

The unique key for a tag.

data_set.row_level_permission_tag_configuration.tag_rules[].tag_multi_value_delimiter

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.

request_id

The Amazon Web Services request ID for this operation.

VARCHAR
status

The HTTP status of the request.

BIGINT