Note:
You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.
update-workspace-theme¶
Description¶
Updates the theme configuration for a workspace, including colors and styling.
See also: AWS API Documentation
Synopsis¶
update-workspace-theme
--instance-id <value>
--workspace-id <value>
[--theme <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--v2-debug]
Options¶
--instance-id (string)
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
--workspace-id (string)
The identifier of the workspace.
--theme (structure)
The theme configuration, including color schemes and visual styles.
Light -> (structure)
The theme configuration for light mode.
Palette -> (structure)
The color palette configuration for the workspace theme.
Header -> (structure)
The color configuration for the header area.
Background -> (string)
The background color of the header.Text -> (string)
The text color in the header.TextHover -> (string)
The text color when hovering over header elements.InvertActionsColors -> (boolean)
Whether to invert the colors of action buttons in the header.Navigation -> (structure)
The color configuration for the navigation area.
Background -> (string)
The background color of the navigation area.TextBackgroundHover -> (string)
The background color when hovering over navigation text.TextBackgroundActive -> (string)
The background color for active navigation items.Text -> (string)
The text color in the navigation area.TextHover -> (string)
The text color when hovering over navigation items.TextActive -> (string)
The text color for active navigation items.InvertActionsColors -> (boolean)
Whether to invert the colors of action buttons in the navigation area.Canvas -> (structure)
The color configuration for the canvas area.
ContainerBackground -> (string)
The background color for container elements.PageBackground -> (string)
The background color for page elements.ActiveBackground -> (string)
The background color for active elements.Primary -> (structure)
The primary color configuration used throughout the workspace.
Default -> (string)
The default primary color used throughout the workspace.Active -> (string)
The primary color used for active states.ContrastText -> (string)
The text color that contrasts with the primary color for readability.Images -> (structure)
The image assets used in the workspace theme.
Logo -> (structure)
The logo images used in the workspace.
Default -> (string)
The default logo image displayed in the workspace.Favicon -> (string)
The favicon image displayed in the browser tab.Typography -> (structure)
The typography configuration for the workspace theme.
FontFamily -> (structure)
The font family configuration for text in the workspace.
Default -> (string)
The default font family to use in the workspace theme.Dark -> (structure)
The theme configuration for dark mode.
Palette -> (structure)
The color palette configuration for the workspace theme.
Header -> (structure)
The color configuration for the header area.
Background -> (string)
The background color of the header.Text -> (string)
The text color in the header.TextHover -> (string)
The text color when hovering over header elements.InvertActionsColors -> (boolean)
Whether to invert the colors of action buttons in the header.Navigation -> (structure)
The color configuration for the navigation area.
Background -> (string)
The background color of the navigation area.TextBackgroundHover -> (string)
The background color when hovering over navigation text.TextBackgroundActive -> (string)
The background color for active navigation items.Text -> (string)
The text color in the navigation area.TextHover -> (string)
The text color when hovering over navigation items.TextActive -> (string)
The text color for active navigation items.InvertActionsColors -> (boolean)
Whether to invert the colors of action buttons in the navigation area.Canvas -> (structure)
The color configuration for the canvas area.
ContainerBackground -> (string)
The background color for container elements.PageBackground -> (string)
The background color for page elements.ActiveBackground -> (string)
The background color for active elements.Primary -> (structure)
The primary color configuration used throughout the workspace.
Default -> (string)
The default primary color used throughout the workspace.Active -> (string)
The primary color used for active states.ContrastText -> (string)
The text color that contrasts with the primary color for readability.Images -> (structure)
The image assets used in the workspace theme.
Logo -> (structure)
The logo images used in the workspace.
Default -> (string)
The default logo image displayed in the workspace.Favicon -> (string)
The favicon image displayed in the browser tab.Typography -> (structure)
The typography configuration for the workspace theme.
FontFamily -> (structure)
The font family configuration for text in the workspace.
Default -> (string)
The default font family to use in the workspace theme.
JSON Syntax:
{
"Light": {
"Palette": {
"Header": {
"Background": "string",
"Text": "string",
"TextHover": "string",
"InvertActionsColors": true|false
},
"Navigation": {
"Background": "string",
"TextBackgroundHover": "string",
"TextBackgroundActive": "string",
"Text": "string",
"TextHover": "string",
"TextActive": "string",
"InvertActionsColors": true|false
},
"Canvas": {
"ContainerBackground": "string",
"PageBackground": "string",
"ActiveBackground": "string"
},
"Primary": {
"Default": "string",
"Active": "string",
"ContrastText": "string"
}
},
"Images": {
"Logo": {
"Default": "string",
"Favicon": "string"
}
},
"Typography": {
"FontFamily": {
"Default": "Arial"|"Courier New"|"Georgia"|"Times New Roman"|"Trebuchet"|"Verdana"
}
}
},
"Dark": {
"Palette": {
"Header": {
"Background": "string",
"Text": "string",
"TextHover": "string",
"InvertActionsColors": true|false
},
"Navigation": {
"Background": "string",
"TextBackgroundHover": "string",
"TextBackgroundActive": "string",
"Text": "string",
"TextHover": "string",
"TextActive": "string",
"InvertActionsColors": true|false
},
"Canvas": {
"ContainerBackground": "string",
"PageBackground": "string",
"ActiveBackground": "string"
},
"Primary": {
"Default": "string",
"Active": "string",
"ContrastText": "string"
}
},
"Images": {
"Logo": {
"Default": "string",
"Favicon": "string"
}
},
"Typography": {
"FontFamily": {
"Default": "Arial"|"Courier New"|"Georgia"|"Times New Roman"|"Trebuchet"|"Verdana"
}
}
}
}
--cli-input-json (string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
Global Options¶
--debug (boolean)
Turn on debug logging.
--endpoint-url (string)
Override command’s default URL with the given URL.
--no-verify-ssl (boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate (boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output (string)
The formatting style for command output.
- json
- text
- table
--query (string)
A JMESPath query to use in filtering the response data.
--profile (string)
Use a specific profile from your credential file.
--region (string)
The region to use. Overrides config/env settings.
--version (string)
Display the version of this tool.
--color (string)
Turn on/off color output.
- on
- off
- auto
--no-sign-request (boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle (string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout (int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout (int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--v2-debug (boolean)
Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.
Output¶
None