Updates custom branding that customizes the appearance of the streaming application catalog page.
Request Syntax
{
"AttributesToDelete": [ "string" ],
"FaviconS3Location": {
"S3Bucket": "string",
"S3Key": "string"
},
"FooterLinks": [
{
"DisplayName": "string",
"FooterLinkURL": "string"
}
],
"OrganizationLogoS3Location": {
"S3Bucket": "string",
"S3Key": "string"
},
"StackName": "string",
"State": "string",
"ThemeStyling": "string",
"TitleText": "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.
- AttributesToDelete
-
The attributes to delete.
Type: Array of strings
Valid Values:
FOOTER_LINKSRequired: No
- FaviconS3Location
-
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.
Type: S3Location object
Required: No
-
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.
Type: Array of ThemeFooterLink objects
Required: No
- OrganizationLogoS3Location
-
The organization logo that appears on the streaming application catalog page.
Type: S3Location object
Required: No
- StackName
-
The name of the stack for the theme.
Type: String
Pattern:
^[a-zA-Z0-9][a-zA-Z0-9_.-]{0,100}$Required: Yes
- State
-
Specifies whether custom branding should be applied to catalog page or not.
Type: String
Valid Values:
ENABLED | DISABLEDRequired: No
- ThemeStyling
-
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.
Type: String
Valid Values:
LIGHT_BLUE | BLUE | PINK | REDRequired: No
- TitleText
-
The title that is displayed at the top of the browser tab during users' application streaming sessions.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 300.
Pattern:
^[-@./#&+\w\s]*$Required: No
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.
Errors
For information about the errors that are common to all actions, see Common Errors.
- ConcurrentModificationException
-
An API error occurred. Wait a few minutes and try again.
HTTP Status Code: 400
- InvalidAccountStatusException
-
The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.
HTTP Status Code: 400
- InvalidParameterCombinationException
-
Indicates an incorrect combination of parameters, or a missing parameter.
HTTP Status Code: 400
- LimitExceededException
-
The requested limit exceeds the permitted limit for an account.
HTTP Status Code: 400
- 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:
