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

CreateWorkspacePage

Associates a view with a page in a workspace, defining what users see when they navigate to that page.

Request Syntax


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

{
   "InputData": "string",
   "Page": "string",
   "ResourceArn": "string",
   "Slug": "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

WorkspaceId

The identifier of the workspace.

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

InputData

A JSON string containing input parameters for the view, validated against the view's input schema.

Type: String

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

Required: No

Page

The page identifier. Valid system pages include HOME and AGENT_EXPERIENCE. Custom pages cannot use the aws: or connect: prefixes.

Type: String

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

Pattern: ^(?!\\.$)(?!\\.\\.$)[\\p{L}\\p{Z}\\p{N}\\-_.:=@'|]+$

Required: Yes

ResourceArn

The Amazon Resource Name (ARN) of the view to associate with the page.

Type: String

Required: Yes

Slug

The URL-friendly identifier for the page.

Type: String

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

Pattern: ^$|^[\\p{L}\\p{Z}\\p{N}\\-_.:=@'|]{3,}$

Required: No

Response Syntax


HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

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

ResourceConflictException

A resource already has that name.

HTTP Status Code: 409

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