Skip to content
AWS for Query.Farm

aws.quicksight.describe_theme

Example SQL Queries

SELECT * FROM
aws.quicksight.describe_theme
WHERE
"aws_account_id" = 'VALUE'
AND "theme_id" = 'VALUE';

Description

Describes a theme.

Table Definition

Column NameColumn Data Type
aws_account_id Required Input Column

The ID of the Amazon Web Services account that contains the theme that you're describing.

VARCHAR
theme_id Required Input Column

The ID for the theme.

VARCHAR
alias_name Input Column

The alias of the theme that you want to describe. If you name a specific alias, you describe the version that the alias points to. You can specify the latest version of the theme by providing the keyword $LATEST in the AliasName parameter. The keyword $PUBLISHED doesn't apply to themes.

VARCHAR
version_number Input Column

The version number for the version to describe. If a VersionNumber parameter value isn't provided, the latest version of the theme is described.

BIGINT
_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
request_id

The Amazon Web Services request ID for this operation.

VARCHAR
status

The HTTP status of the request.

BIGINT
theme

The information about the theme that you are describing.

STRUCT(
    "arn" VARCHAR,
    "name" VARCHAR,
    "theme_id" VARCHAR,
    "version" STRUCT(
        "version_number" BIGINT,
        "arn" VARCHAR,
        "description" VARCHAR,
        "base_theme_id" VARCHAR,
        "created_time" TIMESTAMP_S,
        "configuration" STRUCT(
            "data_color_palette" STRUCT(
                "colors" VARCHAR[],
                "min_max_gradient" VARCHAR[],
                "empty_fill_color" VARCHAR
            ),
            "ui_color_palette" STRUCT(
                "primary_foreground" VARCHAR,
                "primary_background" VARCHAR,
                "secondary_foreground" VARCHAR,
                "secondary_background" VARCHAR,
                "accent" VARCHAR,
                "accent_foreground" VARCHAR,
                "danger" VARCHAR,
                "danger_foreground" VARCHAR,
                "warning" VARCHAR,
                "warning_foreground" VARCHAR,
                "success" VARCHAR,
                "success_foreground" VARCHAR,
                "dimension" VARCHAR,
                "dimension_foreground" VARCHAR,
                "measure" VARCHAR,
                "measure_foreground" VARCHAR
            ),
            "sheet" STRUCT(
                "tile" STRUCT(
                    "border" STRUCT(
                        "show" BOOLEAN
                    )
                ),
                "tile_layout" STRUCT(
                    "gutter" STRUCT(
                        "show" BOOLEAN
                    ),
                    "margin" STRUCT(
                        "show" BOOLEAN
                    )
                )
            ),
            "typography" STRUCT(
                "font_families" STRUCT(
                    "font_family" VARCHAR
                )[]
            )
        ),
        "errors" STRUCT(
            "type" VARCHAR,
            "message" VARCHAR
        )[],
        "status" VARCHAR
    ),
    "created_time" TIMESTAMP_S,
    "last_updated_time" TIMESTAMP_S,
    "type" VARCHAR
)
Show child fields
theme.arn

The Amazon Resource Name (ARN) of the theme.

theme.created_time

The date and time that the theme was created.

theme.last_updated_time

The date and time that the theme was last updated.

theme.name

The name that the user gives to the theme.

theme.theme_id

The identifier that the user gives to the theme.

theme.type

The type of theme, based on how it was created. Valid values include: QUICKSIGHT and CUSTOM.

theme.version

A version of a theme.

Show child fields
theme.version.arn

The Amazon Resource Name (ARN) of the resource.

theme.version.base_theme_id

The Amazon QuickSight-defined ID of the theme that a custom theme inherits from. All themes initially inherit from a default Amazon QuickSight theme.

theme.version.configuration

The theme configuration, which contains all the theme display properties.

Show child fields
theme.version.configuration.data_color_palette

Color properties that apply to chart data colors.

Show child fields
theme.version.configuration.data_color_palette.colors[]
theme.version.configuration.data_color_palette.empty_fill_color

The hexadecimal code of a color that applies to charts where a lack of data is highlighted.

theme.version.configuration.data_color_palette.min_max_gradient[]
theme.version.configuration.sheet

Display options related to sheets.

Show child fields
theme.version.configuration.sheet.tile

The display options for tiles.

Show child fields
theme.version.configuration.sheet.tile.border

The border around a tile.

Show child fields
theme.version.configuration.sheet.tile.border.show

The option to enable display of borders for visuals.

theme.version.configuration.sheet.tile_layout

The layout options for tiles.

Show child fields
theme.version.configuration.sheet.tile_layout.gutter

The gutter settings that apply between tiles.

Show child fields
theme.version.configuration.sheet.tile_layout.gutter.show

This Boolean value controls whether to display a gutter space between sheet tiles.

theme.version.configuration.sheet.tile_layout.margin

The margin settings that apply around the outside edge of sheets.

Show child fields
theme.version.configuration.sheet.tile_layout.margin.show

This Boolean value controls whether to display sheet margins.

theme.version.configuration.typography

Determines the typography options.

Show child fields
theme.version.configuration.typography.font_families[]
Show child fields
theme.version.configuration.typography.font_families[].font_family

Determines the font family settings.

theme.version.configuration.ui_color_palette

Color properties that apply to the UI and to charts, excluding the colors that apply to data.

Show child fields
theme.version.configuration.ui_color_palette.accent

This color is that applies to selected states and buttons.

theme.version.configuration.ui_color_palette.accent_foreground

The foreground color that applies to any text or other elements that appear over the accent color.

theme.version.configuration.ui_color_palette.danger

The color that applies to error messages.

theme.version.configuration.ui_color_palette.danger_foreground

The foreground color that applies to any text or other elements that appear over the error color.

theme.version.configuration.ui_color_palette.dimension

The color that applies to the names of fields that are identified as dimensions.

theme.version.configuration.ui_color_palette.dimension_foreground

The foreground color that applies to any text or other elements that appear over the dimension color.

theme.version.configuration.ui_color_palette.measure

The color that applies to the names of fields that are identified as measures.

theme.version.configuration.ui_color_palette.measure_foreground

The foreground color that applies to any text or other elements that appear over the measure color.

theme.version.configuration.ui_color_palette.primary_background

The background color that applies to visuals and other high emphasis UI.

theme.version.configuration.ui_color_palette.primary_foreground

The color of text and other foreground elements that appear over the primary background regions, such as grid lines, borders, table banding, icons, and so on.

theme.version.configuration.ui_color_palette.secondary_background

The background color that applies to the sheet background and sheet controls.

theme.version.configuration.ui_color_palette.secondary_foreground

The foreground color that applies to any sheet title, sheet control text, or UI that appears over the secondary background.

theme.version.configuration.ui_color_palette.success

The color that applies to success messages, for example the check mark for a successful download.

theme.version.configuration.ui_color_palette.success_foreground

The foreground color that applies to any text or other elements that appear over the success color.

theme.version.configuration.ui_color_palette.warning

This color that applies to warning and informational messages.

theme.version.configuration.ui_color_palette.warning_foreground

The foreground color that applies to any text or other elements that appear over the warning color.

theme.version.created_time

The date and time that this theme version was created.

theme.version.description

The description of the theme.

theme.version.errors[]
Show child fields
theme.version.errors[].message

The error message.

theme.version.errors[].type

The type of error.

theme.version.status

The status of the theme version.

theme.version.version_number

The version number of the theme.