AppStream / Client / describe_theme_for_stack

describe_theme_for_stack#

AppStream.Client.describe_theme_for_stack(**kwargs)#

Retrieves a list that describes the theme for a specified stack. A theme is custom branding that customizes the appearance of the streaming application catalog page.

See also: AWS API Documentation

Request Syntax

response = client.describe_theme_for_stack(
    StackName='string'
)
Parameters:

StackName (string) –

[REQUIRED]

The name of the stack for the theme.

Return type:

dict

Returns:

Response Syntax

{
    'Theme': {
        'StackName': 'string',
        'State': 'ENABLED'|'DISABLED',
        'ThemeTitleText': 'string',
        'ThemeStyling': 'LIGHT_BLUE'|'BLUE'|'PINK'|'RED',
        'ThemeFooterLinks': [
            {
                'DisplayName': 'string',
                'FooterLinkURL': 'string'
            },
        ],
        'ThemeOrganizationLogoURL': 'string',
        'ThemeFaviconURL': 'string',
        'CreatedTime': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) –

    • Theme (dict) –

      The theme object that contains the metadata of the custom branding.

      • StackName (string) –

        The stack that has the custom branding theme.

      • State (string) –

        The state of the theme.

      • ThemeTitleText (string) –

        The browser tab page title.

      • ThemeStyling (string) –

        The color that is used for the website links, text, buttons, and catalog page background.

      • ThemeFooterLinks (list) –

        The website links that display in the catalog page footer.

        • (dict) –

          The website links that display in the catalog page footer.

          • DisplayName (string) –

            The name of the websites that display in the catalog page footer.

          • FooterLinkURL (string) –

            The URL of the websites that display in the catalog page footer.

      • ThemeOrganizationLogoURL (string) –

        The URL of the logo that displays in the catalog page header.

      • ThemeFaviconURL (string) –

        The URL of the icon that displays at the top of a user’s browser tab during streaming sessions.

      • CreatedTime (datetime) –

        The time the theme was created.

Exceptions