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

CreateViewVersion

Publishes a new version of the view identifier.

Versions are immutable and monotonically increasing.

It returns the highest version if there is no change in content compared to that version. An error is displayed if the supplied ViewContentSha256 is different from the ViewContentSha256 of the $LATEST alias.

Request Syntax


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

{
   "VersionDescription": "string",
   "ViewContentSha256": "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

ViewId

The identifier of the view. Both ViewArn and ViewId can be used.

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

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

VersionDescription

The description for the version being published.

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

ViewContentSha256

Indicates the checksum value of the latest published view content.

Type: String

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

Pattern: ^[a-zA-Z0-9]$

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

All view data is contained within the View object.

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

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