DescribeThemeForStack - Amazon AppStream 2.0

DescribeThemeForStack

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.

Request Syntax

{ "StackName": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

StackName

The name of the stack for the theme.

Type: String

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]{0,100}$

Required: Yes

Response Syntax

{ "Theme": { "CreatedTime": number, "StackName": "string", "State": "string", "ThemeFaviconURL": "string", "ThemeFooterLinks": [ { "DisplayName": "string", "FooterLinkURL": "string" } ], "ThemeOrganizationLogoURL": "string", "ThemeStyling": "string", "ThemeTitleText": "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Theme

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

Type: Theme object

Errors

For information about the errors that are common to all actions, see Common Errors.

OperationNotPermittedException

The attempted operation is not permitted.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: