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

UpdateDataTableMetadata

Updates the metadata properties of a data table. Accepts all fields similar to CreateDataTable, except for fields and tags. There are no other granular update endpoints. It does not act as a patch operation - all properties must be provided or defaults will be used. Fields follow the same requirements as CreateDataTable.

Request Syntax


POST /data-tables/InstanceId/DataTableId HTTP/1.1
Content-type: application/json

{
   "Description": "string",
   "Name": "string",
   "TimeZone": "string",
   "ValueLockLevel": "string"
}

URI Request Parameters

The request uses the following URI parameters.

DataTableId

The unique identifier for the data table. Must also accept the table ARN with or without a version alias. If the version is provided as part of the identifier or ARN, the version must be $LATEST. Providing any other alias fails with an error.

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

Required: Yes

InstanceId

The unique identifier for the Amazon Connect 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 updated description for the data table. Must conform to Connect human readable string specification and have 0-250 characters.

Type: String

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

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

Required: No

Name

The updated name for the data table. Must conform to Connect human readable string specification and have 1-127 characters. Must be unique for the instance using case-insensitive comparison.

Type: String

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

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

Required: Yes

TimeZone

The updated IANA timezone identifier to use when resolving time based dynamic values.

Type: String

Required: Yes

ValueLockLevel

The updated value lock level for the data table. One of DATA_TABLE, PRIMARY_VALUE, ATTRIBUTE, VALUE, and NONE.

Type: String

Valid Values: NONE | DATA_TABLE | PRIMARY_VALUE | ATTRIBUTE | VALUE

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "LockVersion": { 
      "Attribute": "string",
      "DataTable": "string",
      "PrimaryValues": "string",
      "Value": "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.

LockVersion

The new lock version for the data table after the update.

Type: DataTableLockVersion 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

ConflictException

Operation cannot be performed at this time as there is a conflict with another operation or contact state.

HTTP Status Code: 409

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

ResourceNotFoundException

The specified resource was not found.

Message: The message about the resource.

HTTP Status Code: 404

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429