describe-workspace¶

Description¶

Retrieves details about a workspace, including its configuration and metadata.

Synopsis¶

  describe-workspace
--instance-id <value>
--workspace-id <value>
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options¶

--instance-id (string) [required]

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Constraints:

min: 1

max: 100

--workspace-id (string) [required]

The identifier of the workspace.

Constraints:

min: 1

max: 256

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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
yaml
yaml-stream

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output¶

Workspace -> (structure)

Information about the workspace.

Visibility -> (string)

Controls who can access the workspace. Valid values are: ALL (all users), ASSIGNED (only assigned users and routing profiles), and NONE (not visible).

Possible values:

ALL

ASSIGNED

NONE

Id -> (string) [required]

The unique identifier of the workspace.

Constraints:

min: 1

max: 256

Name -> (string) [required]

The name of the workspace.

Constraints:

min: 1

max: 127

pattern: .*\\S.*

Arn -> (string) [required]

The Amazon Resource Name (ARN) of the workspace.

Description -> (string)

The description of the workspace.

Constraints:

min: 0

max: 500

pattern: ^[\\P{C}\r\n\t]*$

Theme -> (structure)

The theme configuration for the workspace, including colors and styling.

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.

Constraints:

min: 1

max: 127

pattern: .*\\S.*

Text -> (string)

The text color in the header.

Constraints:

min: 1

max: 127

pattern: .*\\S.*

TextHover -> (string)

The text color when hovering over header elements.

Constraints:

min: 1

max: 127

pattern: .*\\S.*

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.

Constraints:

min: 1

max: 127

pattern: .*\\S.*

TextBackgroundHover -> (string)

The background color when hovering over navigation text.

Constraints:

min: 1

max: 127

pattern: .*\\S.*

TextBackgroundActive -> (string)

The background color for active navigation items.

Constraints:

min: 1

max: 127

pattern: .*\\S.*

Text -> (string)

The text color in the navigation area.

Constraints:

min: 1

max: 127

pattern: .*\\S.*

TextHover -> (string)

The text color when hovering over navigation items.

Constraints:

min: 1

max: 127

pattern: .*\\S.*

TextActive -> (string)

The text color for active navigation items.

Constraints:

min: 1

max: 127

pattern: .*\\S.*

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.

Constraints:

min: 1

max: 127

pattern: .*\\S.*

PageBackground -> (string)

The background color for page elements.

Constraints:

min: 1

max: 127

pattern: .*\\S.*

ActiveBackground -> (string)

The background color for active elements.

Constraints:

min: 1

max: 127

pattern: .*\\S.*

Primary -> (structure)

The primary color configuration used throughout the workspace.

Default -> (string)

The default primary color used throughout the workspace.

Constraints:

min: 1

max: 127

pattern: .*\\S.*

Active -> (string)

The primary color used for active states.

Constraints:

min: 1

max: 127

pattern: .*\\S.*

ContrastText -> (string)

The text color that contrasts with the primary color for readability.

Constraints:

min: 1

max: 127

pattern: .*\\S.*

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.

Constraints:

min: 1

max: 254

pattern: .*\\S.*

Favicon -> (string)

The favicon image displayed in the browser tab.

Constraints:

min: 1

max: 254

pattern: .*\\S.*

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.

Possible values:

Arial

Courier New

Georgia

Times New Roman

Trebuchet

Verdana

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.

Constraints:

min: 1

max: 127

pattern: .*\\S.*

Text -> (string)

The text color in the header.

Constraints:

min: 1

max: 127

pattern: .*\\S.*

TextHover -> (string)

The text color when hovering over header elements.

Constraints:

min: 1

max: 127

pattern: .*\\S.*

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.

Constraints:

min: 1

max: 127

pattern: .*\\S.*

TextBackgroundHover -> (string)

The background color when hovering over navigation text.

Constraints:

min: 1

max: 127

pattern: .*\\S.*

TextBackgroundActive -> (string)

The background color for active navigation items.

Constraints:

min: 1

max: 127

pattern: .*\\S.*

Text -> (string)

The text color in the navigation area.

Constraints:

min: 1

max: 127

pattern: .*\\S.*

TextHover -> (string)

The text color when hovering over navigation items.

Constraints:

min: 1

max: 127

pattern: .*\\S.*

TextActive -> (string)

The text color for active navigation items.

Constraints:

min: 1

max: 127

pattern: .*\\S.*

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.

Constraints:

min: 1

max: 127

pattern: .*\\S.*

PageBackground -> (string)

The background color for page elements.

Constraints:

min: 1

max: 127

pattern: .*\\S.*

ActiveBackground -> (string)

The background color for active elements.

Constraints:

min: 1

max: 127

pattern: .*\\S.*

Primary -> (structure)

The primary color configuration used throughout the workspace.

Default -> (string)

The default primary color used throughout the workspace.

Constraints:

min: 1

max: 127

pattern: .*\\S.*

Active -> (string)

The primary color used for active states.

Constraints:

min: 1

max: 127

pattern: .*\\S.*

ContrastText -> (string)

The text color that contrasts with the primary color for readability.

Constraints:

min: 1

max: 127

pattern: .*\\S.*

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.

Constraints:

min: 1

max: 254

pattern: .*\\S.*

Favicon -> (string)

The favicon image displayed in the browser tab.

Constraints:

min: 1

max: 254

pattern: .*\\S.*

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.

Possible values:

Arial

Courier New

Georgia

Times New Roman

Trebuchet

Verdana

Title -> (string)

The title displayed for the workspace.

Constraints:

min: 0

max: 127

pattern: ^[\\P{C}]*$

LastModifiedTime -> (timestamp) [required]

The timestamp when the workspace was last modified.

LastModifiedRegion -> (string)

The AWS Region where the workspace was last modified.

Constraints:

pattern: [a-z]{2}(-[a-z]+){1,2}(-[0-9])?

Tags -> (map)

The tags used to organize, track, or control access for the workspace.

Constraints:

min: 1

max: 50

key -> (string)

Constraints:

min: 1

max: 128

pattern: ^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$

value -> (string)

Constraints:

max: 256

Table of Contents

Feedback

User Guide