QuickSight / Client / describe_theme

describe_theme

QuickSight.Client.describe_theme(**kwargs)

Describes a theme.

See also: AWS API Documentation

Request Syntax

response = client.describe_theme(
    AwsAccountId='string',
    ThemeId='string',
    VersionNumber=123,
    AliasName='string'
)

Parameters:

• AwsAccountId (string) –

  [REQUIRED]

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

• ThemeId (string) –

  [REQUIRED]

  The ID for the theme.

• VersionNumber (integer) – The version number for the version to describe. If a VersionNumber parameter value isn’t provided, the latest version of the theme is described.

• AliasName (string) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'Theme': {
        'Arn': 'string',
        'Name': 'string',
        'ThemeId': 'string',
        'Version': {
            'VersionNumber': 123,
            'Arn': 'string',
            'Description': 'string',
            'BaseThemeId': 'string',
            'CreatedTime': datetime(2015, 1, 1),
            'Configuration': {
                'DataColorPalette': {
                    'Colors': [
                        'string',
                    ],
                    'MinMaxGradient': [
                        'string',
                    ],
                    'EmptyFillColor': 'string'
                },
                'UIColorPalette': {
                    'PrimaryForeground': 'string',
                    'PrimaryBackground': 'string',
                    'SecondaryForeground': 'string',
                    'SecondaryBackground': 'string',
                    'Accent': 'string',
                    'AccentForeground': 'string',
                    'Danger': 'string',
                    'DangerForeground': 'string',
                    'Warning': 'string',
                    'WarningForeground': 'string',
                    'Success': 'string',
                    'SuccessForeground': 'string',
                    'Dimension': 'string',
                    'DimensionForeground': 'string',
                    'Measure': 'string',
                    'MeasureForeground': 'string'
                },
                'Sheet': {
                    'Tile': {
                        'Border': {
                            'Show': True|False
                        }
                    },
                    'TileLayout': {
                        'Gutter': {
                            'Show': True|False
                        },
                        'Margin': {
                            'Show': True|False
                        }
                    }
                },
                'Typography': {
                    'FontFamilies': [
                        {
                            'FontFamily': 'string'
                        },
                    ]
                }
            },
            'Errors': [
                {
                    'Type': 'INTERNAL_FAILURE',
                    'Message': 'string'
                },
            ],
            'Status': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED'
        },
        'CreatedTime': datetime(2015, 1, 1),
        'LastUpdatedTime': datetime(2015, 1, 1),
        'Type': 'QUICKSIGHT'|'CUSTOM'|'ALL'
    },
    'Status': 123,
    'RequestId': 'string'
}

Response Structure

• (dict) –

  • Theme (dict) –

    The information about the theme that you are describing.

    • Arn (string) –

      The Amazon Resource Name (ARN) of the theme.

    • Name (string) –

      The name that the user gives to the theme.

    • ThemeId (string) –

      The identifier that the user gives to the theme.

    • Version (dict) –

      A version of a theme.

      • VersionNumber (integer) –

        The version number of the theme.

      • Arn (string) –

        The Amazon Resource Name (ARN) of the resource.

      • Description (string) –

        The description of the theme.

      • BaseThemeId (string) –

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

      • CreatedTime (datetime) –

        The date and time that this theme version was created.

      • Configuration (dict) –

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

        • DataColorPalette (dict) –

          Color properties that apply to chart data colors.

          • Colors (list) –

            The hexadecimal codes for the colors.

            • (string) –

          • MinMaxGradient (list) –

            The minimum and maximum hexadecimal codes that describe a color gradient.

            • (string) –

          • EmptyFillColor (string) –

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

        • UIColorPalette (dict) –

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

          • PrimaryForeground (string) –

            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.

          • PrimaryBackground (string) –

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

          • SecondaryForeground (string) –

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

          • SecondaryBackground (string) –

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

          • Accent (string) –

            This color is that applies to selected states and buttons.

          • AccentForeground (string) –

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

          • Danger (string) –

            The color that applies to error messages.

          • DangerForeground (string) –

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

          • Warning (string) –

            This color that applies to warning and informational messages.

          • WarningForeground (string) –

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

          • Success (string) –

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

          • SuccessForeground (string) –

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

          • Dimension (string) –

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

          • DimensionForeground (string) –

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

          • Measure (string) –

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

          • MeasureForeground (string) –

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

        • Sheet (dict) –

          Display options related to sheets.

          • Tile (dict) –

            The display options for tiles.

            • Border (dict) –

              The border around a tile.

              • Show (boolean) –

                The option to enable display of borders for visuals.

          • TileLayout (dict) –

            The layout options for tiles.

            • Gutter (dict) –

              The gutter settings that apply between tiles.

              • Show (boolean) –

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

            • Margin (dict) –

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

              • Show (boolean) –

                This Boolean value controls whether to display sheet margins.

        • Typography (dict) –

          Determines the typography options.

          • FontFamilies (list) –

            Determines the list of font families.

            • (dict) –

              Determines the font settings.

              • FontFamily (string) –

                Determines the font family settings.

      • Errors (list) –

        Errors associated with the theme.

        • (dict) –

          Theme error.

          • Type (string) –

            The type of error.

          • Message (string) –

            The error message.

      • Status (string) –

        The status of the theme version.

    • CreatedTime (datetime) –

      The date and time that the theme was created.

    • LastUpdatedTime (datetime) –

      The date and time that the theme was last updated.

    • Type (string) –

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

  • Status (integer) –

    The HTTP status of the request.

  • RequestId (string) –

    The Amazon Web Services request ID for this operation.

Exceptions

• QuickSight.Client.exceptions.AccessDeniedException

• QuickSight.Client.exceptions.InvalidParameterValueException

• QuickSight.Client.exceptions.ResourceExistsException

• QuickSight.Client.exceptions.ResourceNotFoundException

• QuickSight.Client.exceptions.ThrottlingException

• QuickSight.Client.exceptions.UnsupportedUserEditionException

• QuickSight.Client.exceptions.InternalFailureException