Skip to content

create_theme_for_stack

create_theme_for_stack(
    *,
    config_overrides: Optional[AppStreamClientConfig] = None,
    stack_name: Optional[Name] = None,
    footer_links: Optional[ThemeFooterLinks] = None,
    title_text: Optional[ThemeTitleText] = None,
    theme_styling: Optional[ThemeStyling] = None,
    organization_logo_s3_location: Optional[S3Location] = None,
    favicon_s3_location: Optional[S3Location] = None,
) -> CreateThemeForStackResult

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

Parameters:

  • stack_name (Optional[Name], default: None ) –

    The name of the stack for the theme.

  • footer_links (Optional[ThemeFooterLinks], default: None ) –

    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.

  • title_text (Optional[ThemeTitleText], default: None ) –

    The title that is displayed at the top of the browser tab during users' application streaming sessions.

  • theme_styling (Optional[ThemeStyling], default: None ) –

    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.

  • organization_logo_s3_location (Optional[S3Location], default: None ) –

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

  • favicon_s3_location (Optional[S3Location], default: None ) –

    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.

Raises:

Source code in docs_src/capo_appstream/_services/app_stream.py
def create_theme_for_stack(
    self,
    *,
    config_overrides: Optional[AppStreamClientConfig] = None,
    stack_name: Optional["capo_appstream.types.name.Name"] = None,
    footer_links: Optional[
        "capo_appstream.types.theme_footer_links.ThemeFooterLinks"
    ] = None,
    title_text: Optional[
        "capo_appstream.types.theme_title_text.ThemeTitleText"
    ] = None,
    theme_styling: Optional[
        "capo_appstream.types.theme_styling.ThemeStyling"
    ] = None,
    organization_logo_s3_location: Optional[
        "capo_appstream.types.s3_location.S3Location"
    ] = None,
    favicon_s3_location: Optional[
        "capo_appstream.types.s3_location.S3Location"
    ] = None,
) -> "capo_appstream.types.create_theme_for_stack_result.CreateThemeForStackResult":
    """<p>Creates custom branding that customizes the appearance of the streaming application catalog page.</p>

    Args:
        stack_name: <p>The name of the stack for the theme.</p>
        footer_links: <p>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.</p>
        title_text: <p>The title that is displayed at the top of the browser tab during users' application streaming sessions.</p>
        theme_styling: <p>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.</p>
        organization_logo_s3_location: <p>The organization logo that appears on the streaming application catalog page.</p>
        favicon_s3_location: <p>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.</p>

    Raises:
        capo_appstream.errors.concurrent_modification_exception.ConcurrentModificationException: <p>An API error occurred. Wait a few minutes and try again.</p>
        capo_appstream.errors.invalid_account_status_exception.InvalidAccountStatusException: <p>The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support. </p>
        capo_appstream.errors.limit_exceeded_exception.LimitExceededException: <p>The requested limit exceeds the permitted limit for an account.</p>
        capo_appstream.errors.operation_not_permitted_exception.OperationNotPermittedException: <p>The attempted operation is not permitted.</p>
        capo_appstream.errors.resource_already_exists_exception.ResourceAlreadyExistsException: <p>The specified resource already exists.</p>
        capo_appstream.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found.</p>
        capo_appstream.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_appstream.types.create_theme_for_stack_request.CreateThemeForStackRequest]",
    ) -> OperationResponse[
        "capo_appstream.types.create_theme_for_stack_result.CreateThemeForStackResult"
    ]:
        import capo_appstream._operations.photon_admin_proxy_service.create_theme_for_stack

        output, http_response = (
            capo_appstream._operations.photon_admin_proxy_service.create_theme_for_stack.create_theme_for_stack(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateThemeForStack")
    )
    input_: capo_appstream.types.create_theme_for_stack_request.CreateThemeForStackRequest = {}
    if stack_name is not None:
        input_["stack_name"] = stack_name
    if footer_links is not None:
        input_["footer_links"] = footer_links
    if title_text is not None:
        input_["title_text"] = title_text
    if theme_styling is not None:
        input_["theme_styling"] = theme_styling
    if organization_logo_s3_location is not None:
        input_["organization_logo_s3_location"] = organization_logo_s3_location
    if favicon_s3_location is not None:
        input_["favicon_s3_location"] = favicon_s3_location

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output