AppStream / Client / update_theme_for_stack

update_theme_for_stack#

AppStream.Client.update_theme_for_stack(**kwargs)#

Updates custom branding that customizes the appearance of the streaming application catalog page.

See also: AWS API Documentation

Request Syntax

response = client.update_theme_for_stack(
    StackName='string',
    FooterLinks=[
        {
            'DisplayName': 'string',
            'FooterLinkURL': 'string'
        },
    ],
    TitleText='string',
    ThemeStyling='LIGHT_BLUE'|'BLUE'|'PINK'|'RED',
    OrganizationLogoS3Location={
        'S3Bucket': 'string',
        'S3Key': 'string'
    },
    FaviconS3Location={
        'S3Bucket': 'string',
        'S3Key': 'string'
    },
    State='ENABLED'|'DISABLED',
    AttributesToDelete=[
        'FOOTER_LINKS',
    ]
)
Parameters:

  • StackName (string) –

    [REQUIRED]

    The name of the stack for the theme.

  • FooterLinks (list) –

    The links that are displayed in the footer of the streaming application catalog page. These links are helpful resources for users, such as the organization’s IT support and product marketing sites.

    • (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.

  • TitleText (string) – The title that is displayed at the top of the browser tab during users’ application streaming sessions.

  • ThemeStyling (string) – The color theme that is applied to website links, text, and buttons. These colors are also applied as accents in the background for the streaming application catalog page.

  • OrganizationLogoS3Location (dict) –

    The organization logo that appears on the streaming application catalog page.

    • S3Bucket (string) – [REQUIRED]

      The S3 bucket of the S3 object.

    • S3Key (string) –

      The S3 key of the S3 object.

      This is required when used for the following:

      • IconS3Location (Actions: CreateApplication and UpdateApplication)

      • SessionScriptS3Location (Actions: CreateFleet and UpdateFleet)

      • ScriptDetails (Actions: CreateAppBlock)

      • SourceS3Location when creating an app block with CUSTOM PackagingType (Actions: CreateAppBlock)

      • SourceS3Location when creating an app block with APPSTREAM2 PackagingType, and using an existing application package (VHD file). In this case, S3Key refers to the VHD file. If a new application package is required, then S3Key is not required. (Actions: CreateAppBlock)

  • FaviconS3Location (dict) –

    The S3 location of the favicon. The favicon enables users to recognize their application streaming site in a browser full of tabs or bookmarks. It is displayed at the top of the browser tab for the application streaming site during users’ streaming sessions.

    • S3Bucket (string) – [REQUIRED]

      The S3 bucket of the S3 object.

    • S3Key (string) –

      The S3 key of the S3 object.

      This is required when used for the following:

      • IconS3Location (Actions: CreateApplication and UpdateApplication)

      • SessionScriptS3Location (Actions: CreateFleet and UpdateFleet)

      • ScriptDetails (Actions: CreateAppBlock)

      • SourceS3Location when creating an app block with CUSTOM PackagingType (Actions: CreateAppBlock)

      • SourceS3Location when creating an app block with APPSTREAM2 PackagingType, and using an existing application package (VHD file). In this case, S3Key refers to the VHD file. If a new application package is required, then S3Key is not required. (Actions: CreateAppBlock)

  • State (string) – Specifies whether custom branding should be applied to catalog page or not.

  • AttributesToDelete (list) –

    The attributes to delete.

    • (string) –

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