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

Description¶

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

Usage¶

connect_describe_workspace(InstanceId, WorkspaceId)

Arguments¶

InstanceId

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

WorkspaceId

[required] The identifier of the workspace.

Value¶

A list with the following syntax:

list(
  Workspace = list(
    Visibility = "ALL"|"ASSIGNED"|"NONE",
    Id = "string",
    Name = "string",
    Arn = "string",
    Description = "string",
    Theme = list(
      Light = list(
        Palette = list(
          Header = list(
            Background = "string",
            Text = "string",
            TextHover = "string",
            InvertActionsColors = TRUE|FALSE
          ),
          Navigation = list(
            Background = "string",
            TextBackgroundHover = "string",
            TextBackgroundActive = "string",
            Text = "string",
            TextHover = "string",
            TextActive = "string",
            InvertActionsColors = TRUE|FALSE
          ),
          Canvas = list(
            ContainerBackground = "string",
            PageBackground = "string",
            ActiveBackground = "string"
          ),
          Primary = list(
            Default = "string",
            Active = "string",
            ContrastText = "string"
          )
        ),
        Images = list(
          Logo = list(
            Default = "string",
            Favicon = "string"
          )
        ),
        Typography = list(
          FontFamily = list(
            Default = "Arial"|"Courier New"|"Georgia"|"Times New Roman"|"Trebuchet"|"Verdana"
          )
        )
      ),
      Dark = list(
        Palette = list(
          Header = list(
            Background = "string",
            Text = "string",
            TextHover = "string",
            InvertActionsColors = TRUE|FALSE
          ),
          Navigation = list(
            Background = "string",
            TextBackgroundHover = "string",
            TextBackgroundActive = "string",
            Text = "string",
            TextHover = "string",
            TextActive = "string",
            InvertActionsColors = TRUE|FALSE
          ),
          Canvas = list(
            ContainerBackground = "string",
            PageBackground = "string",
            ActiveBackground = "string"
          ),
          Primary = list(
            Default = "string",
            Active = "string",
            ContrastText = "string"
          )
        ),
        Images = list(
          Logo = list(
            Default = "string",
            Favicon = "string"
          )
        ),
        Typography = list(
          FontFamily = list(
            Default = "Arial"|"Courier New"|"Georgia"|"Times New Roman"|"Trebuchet"|"Verdana"
          )
        )
      )
    ),
    Title = "string",
    LastModifiedTime = as.POSIXct(
      "2015-01-01"
    ),
    LastModifiedRegion = "string",
    Tags = list(
      "string"
    )
  )
)

Request syntax¶

svc$describe_workspace(
  InstanceId = "string",
  WorkspaceId = "string"
)