Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateWorkspace

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

Request Syntax


PUT /workspaces/InstanceId HTTP/1.1
Content-type: application/json

{
   "Description": "string",
   "Name": "string",
   "Tags": { 
      "string" : "string" 
   },
   "Theme": { 
      "Dark": { 
         "Images": { 
            "Logo": { 
               "Default": "string",
               "Favicon": "string"
            }
         },
         "Palette": { 
            "Canvas": { 
               "ActiveBackground": "string",
               "ContainerBackground": "string",
               "PageBackground": "string"
            },
            "Header": { 
               "Background": "string",
               "InvertActionsColors": boolean,
               "Text": "string",
               "TextHover": "string"
            },
            "Navigation": { 
               "Background": "string",
               "InvertActionsColors": boolean,
               "Text": "string",
               "TextActive": "string",
               "TextBackgroundActive": "string",
               "TextBackgroundHover": "string",
               "TextHover": "string"
            },
            "Primary": { 
               "Active": "string",
               "ContrastText": "string",
               "Default": "string"
            }
         },
         "Typography": { 
            "FontFamily": { 
               "Default": "string"
            }
         }
      },
      "Light": { 
         "Images": { 
            "Logo": { 
               "Default": "string",
               "Favicon": "string"
            }
         },
         "Palette": { 
            "Canvas": { 
               "ActiveBackground": "string",
               "ContainerBackground": "string",
               "PageBackground": "string"
            },
            "Header": { 
               "Background": "string",
               "InvertActionsColors": boolean,
               "Text": "string",
               "TextHover": "string"
            },
            "Navigation": { 
               "Background": "string",
               "InvertActionsColors": boolean,
               "Text": "string",
               "TextActive": "string",
               "TextBackgroundActive": "string",
               "TextBackgroundHover": "string",
               "TextHover": "string"
            },
            "Primary": { 
               "Active": "string",
               "ContrastText": "string",
               "Default": "string"
            }
         },
         "Typography": { 
            "FontFamily": { 
               "Default": "string"
            }
         }
      }
   },
   "Title": "string"
}

URI Request Parameters

The request uses the following URI parameters.

InstanceId

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

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: Yes

Request Body

The request accepts the following data in JSON format.

Description

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 500.

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

Required: No

Name

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 127.

Pattern: .*\\S.*

Required: Yes

Tags

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

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

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

Value Length Constraints: Maximum length of 256.

Required: No

Theme

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

Type: WorkspaceTheme object

Required: No

Title

The title displayed for the workspace.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 127.

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

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "WorkspaceArn": "string",
   "WorkspaceId": "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.

WorkspaceArn

The Amazon Resource Name (ARN) of the workspace.

Type: String

WorkspaceId

The identifier of the workspace.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient permissions to perform this action.

HTTP Status Code: 403

DuplicateResourceException

A resource with the specified name already exists.

HTTP Status Code: 409

InternalServiceException

Request processing failed because of an error or failure with the service.

Message: The message.

HTTP Status Code: 500

InvalidParameterException

One or more of the specified parameters are not valid.

Message: The message about the parameters.

HTTP Status Code: 400

InvalidRequestException

The request is not valid.

Message: The message about the request.
Reason: Reason why the request was invalid.

HTTP Status Code: 400

LimitExceededException

The allowed limit for the resource has been exceeded.

Message: The message about the limit.

HTTP Status Code: 429

ResourceNotFoundException

The specified resource was not found.

Message: The message about the resource.

HTTP Status Code: 404

ServiceQuotaExceededException

The service quota has been exceeded.

Reason: The reason for the exception.

HTTP Status Code: 402

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429