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

UpdateDataTableAttribute

Updates all properties for an attribute using all properties from CreateDataTableAttribute. There are no other granular update endpoints. It does not act as a patch operation - all properties must be provided. System managed attributes are not mutable by customers. Changing an attribute's validation does not invalidate existing values since validation only runs when values are created or updated.

Request Syntax


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

{
   "Description": "string",
   "Name": "string",
   "Primary": boolean,
   "Validation": { 
      "Enum": { 
         "Strict": boolean,
         "Values": [ "string" ]
      },
      "ExclusiveMaximum": number,
      "ExclusiveMinimum": number,
      "IgnoreCase": boolean,
      "Maximum": number,
      "MaxLength": number,
      "MaxValues": number,
      "Minimum": number,
      "MinLength": number,
      "MinValues": number,
      "MultipleOf": number
   },
   "ValueType": "string"
}

URI Request Parameters

The request uses the following URI parameters.

AttributeName

The current name of the attribute to update. Used as an identifier since attribute names can be changed.

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

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

Required: Yes

DataTableId

The unique identifier for the data table. Must also accept the table ARN with or without a version alias.

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

Type: String

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

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

Required: No

Name

The new name for the attribute. Must conform to Connect human readable string specification and be unique within the data table.

Type: String

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

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

Required: Yes

Primary

Whether the attribute should be treated as a primary key. Converting to primary attribute requires existing values to maintain uniqueness.

Type: Boolean

Required: No

Validation

The updated validation rules for the attribute. Changes do not affect existing values until they are modified.

Type: Validation object

Required: No

ValueType

The updated value type for the attribute. When changing value types, existing values are not deleted but may return default values if incompatible.

Type: String

Valid Values: TEXT | NUMBER | BOOLEAN | TEXT_LIST | NUMBER_LIST

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "LockVersion": { 
      "Attribute": "string",
      "DataTable": "string",
      "PrimaryValues": "string",
      "Value": "string"
   },
   "Name": "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 attribute after the update.

Type: DataTableLockVersion object

Name

The trimmed name and identifier for the updated attribute.

Type: String

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

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

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

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

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