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

BatchDeleteDataTableValue

Deletes multiple values from a data table. API users may delete values at any time. When deletion is requested from the admin website, a warning is shown alerting the user of the most recent time the attribute and its values were accessed. System managed values are not deletable by customers.

Request Syntax


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

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

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.

Values

A list of value identifiers to delete, each specifying primary values, attribute name, and lock version information.

Type: Array of DataTableDeleteValueIdentifier objects

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Failed": [ 
      { 
         "AttributeName": "string",
         "Message": "string",
         "PrimaryValues": [ 
            { 
               "AttributeName": "string",
               "Value": "string"
            }
         ]
      }
   ],
   "Successful": [ 
      { 
         "AttributeName": "string",
         "LockVersion": { 
            "Attribute": "string",
            "DataTable": "string",
            "PrimaryValues": "string",
            "Value": "string"
         },
         "PrimaryValues": [ 
            { 
               "AttributeName": "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.

Failed

A list of values that failed to be deleted with error messages explaining the failure reason.

Type: Array of BatchDeleteDataTableValueFailureResult objects

Successful

A list of successfully deleted values with their identifiers and updated lock versions.

Type: Array of BatchDeleteDataTableValueSuccessResult objects

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