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

DeleteKey

Deletes the key-value pair specified by the key.

Request Syntax


DELETE /key-value-stores/KvsARN/keys/Key HTTP/1.1
If-Match: IfMatch

URI Request Parameters

The request uses the following URI parameters.

IfMatch

The current version (ETag) of the key value store that you are deleting keys from, which you can get by using the DescribeKeyValueStore API operation.

Required: Yes

Key

The key to delete.

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

Required: Yes

KvsARN

The Amazon Resource Name (ARN) of the key value store.

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

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
ETag: ETag
Content-type: application/json

{
   "ItemCount": number,
   "TotalSizeInBytes": number
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The response returns the following HTTP headers.

ETag: The current version identifier of the key value store after the successful delete.

The following data is returned in JSON format by the service.

ItemCount

Number of key-value pairs in the key value store after the successful delete.

Type: Integer

TotalSizeInBytes

Total size of the key value store after the successful delete, in bytes.

Type: Long

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

Access denied.

HTTP Status Code: 403

ConflictException

Resource is not in expected state.

HTTP Status Code: 409

InternalServerException

Internal server error.

HTTP Status Code: 500

ResourceNotFoundException

Resource was not found.

HTTP Status Code: 404

ServiceQuotaExceededException

Limit exceeded.

HTTP Status Code: 402

ValidationException

Validation failed.

HTTP Status Code: 400