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

CreateView

Creates a new view with the possible status of SAVED or PUBLISHED.

The views will have a unique name for each connect instance.

It performs basic content validation if the status is SAVED or full content validation if the status is set to PUBLISHED. An error is returned if validation fails. It associates either the $SAVED qualifier or both of the $SAVED and $LATEST qualifiers with the provided view content based on the status. The view is idempotent if ClientToken is provided.

Request Syntax


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

{
   "ClientToken": "string",
   "Content": { 
      "Actions": [ "string" ],
      "Template": "string"
   },
   "Description": "string",
   "Name": "string",
   "Status": "string",
   "Tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request uses the following URI parameters.

InstanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

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

Pattern: ^[a-zA-Z0-9\_\-:\/]+$

Required: Yes

Request Body

The request accepts the following data in JSON format.

ClientToken

A unique Id for each create view request to avoid duplicate view creation. For example, the view is idempotent ClientToken is provided.

Type: String

Length Constraints: Maximum length of 500.

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

Required: No

Content

View content containing all content necessary to render a view except for runtime input data.

The total uncompressed content has a maximum file size of 400kB.

Type: ViewInputContent object

Required: Yes

Description

The description of the view.

Type: String

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

Pattern: ^([\p{L}\p{N}_.:\/=+\-@,()']+[\p{L}\p{Z}\p{N}_.:\/=+\-@,()']*)$

Required: No

Name

The name of the view.

Type: String

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

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

Required: Yes

Status

Indicates the view status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content.

Type: String

Valid Values: PUBLISHED | SAVED

Required: Yes

Tags

The tags associated with the view resource (not specific to view version).These tags can be 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

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "View": { 
      "Arn": "string",
      "Content": { 
         "Actions": [ "string" ],
         "InputSchema": "string",
         "Template": "string"
      },
      "CreatedTime": number,
      "Description": "string",
      "Id": "string",
      "LastModifiedTime": number,
      "Name": "string",
      "Status": "string",
      "Tags": { 
         "string" : "string" 
      },
      "Type": "string",
      "Version": number,
      "VersionDescription": "string",
      "ViewContentSha256": "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.

View

A view resource object. Contains metadata and content necessary to render the view.

Type: View object

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.

HTTP Status Code: 500

InvalidParameterException

One or more of the specified parameters are not valid.

HTTP Status Code: 400

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

ResourceInUseException

That resource is already in use. Please try another.

HTTP Status Code: 409

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 404

ServiceQuotaExceededException

The service quota has been exceeded.

HTTP Status Code: 402

TooManyRequestsException

Displayed when rate-related API limits are exceeded.

HTTP Status Code: 429