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

UpdateViewMetadata

Updates the view metadata. Note that either Name or Description must be provided.

Request Syntax


POST /views/InstanceId/ViewId/metadata HTTP/1.1
Content-type: application/json

{
   "Description": "string",
   "Name": "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.

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: 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.

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

TooManyRequestsException

Displayed when rate-related API limits are exceeded.

HTTP Status Code: 429