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

UpdateDataTablePrimaryValues

Updates the primary values for a record. This operation affects all existing values that are currently associated to the record and its primary values. Users that have restrictions on attributes and/or primary values are not authorized to use this endpoint. The combination of new primary values must be unique within the table.

Request Syntax


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

{
   "LockVersion": { 
      "Attribute": "string",
      "DataTable": "string",
      "PrimaryValues": "string",
      "Value": "string"
   },
   "NewPrimaryValues": [ 
      { 
         "AttributeName": "string",
         "Value": "string"
      }
   ],
   "PrimaryValues": [ 
      { 
         "AttributeName": "string",
         "Value": "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 one of the two available system managed aliases, $SAVED or $LATEST.

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.

LockVersion

The lock version information required for optimistic locking to prevent concurrent modifications.

Type: DataTableLockVersion object

Required: Yes

NewPrimaryValues

The new primary values for the record. Required and must include values for all primary attributes. The combination must be unique within the table.

Type: Array of PrimaryValue objects

Required: Yes

PrimaryValues

The current primary values for the record. Required and must include values for all primary attributes. Fails if the table has primary attributes and some primary values are omitted.

Type: Array of PrimaryValue objects

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 updated lock version information for the data table and affected components after the primary values change.

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

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