Skip to content

Create Workspace

connect_create_workspace R Documentation

Creates a workspace that defines the user experience by mapping views to pages

Description

Creates a workspace that defines the user experience by mapping views to pages. Workspaces can be assigned to users or routing profiles.

Usage

connect_create_workspace(InstanceId, Name, Description, Theme, Title,
  Tags)

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.

Name

[required] The name of the workspace. Must be unique within the instance and can contain 1-127 characters.

Description

The description of the workspace. Maximum length is 250 characters.

Theme

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

Title

The title displayed for the workspace.

Tags

The tags used to organize, track, or control access for this resource. For example, ⁠{ "Tags": {"key1":"value1", "key2":"value2"} }⁠.

Value

A list with the following syntax:

list(
  WorkspaceId = "string",
  WorkspaceArn = "string"
)

Request syntax

svc$create_workspace(
  InstanceId = "string",
  Name = "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",
  Tags = list(
    "string"
  )
)