UpdateKeys - Amazon CloudFront
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

UpdateKeys

Puts or deletes multiple key-value pairs in a single, all-or-nothing operation.

Request Syntax

POST /key-value-stores/KvsARN/keys HTTP/1.1 If-Match: IfMatch Content-type: application/json { "Deletes": [ { "Key": "string" } ], "Puts": [ { "Key": "string", "Value": "string" } ] }

URI Request Parameters

The request uses the following URI parameters.

IfMatch

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

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 accepts the following data in JSON format.

Deletes

List of keys to delete.

Type: Array of DeleteKeyRequestListItem objects

Required: No

Puts

List of key-value pairs to put.

Type: Array of PutKeyRequestListItem objects

Required: No

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

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

Type: Integer

TotalSizeInBytes

Total size of the key value store after the successful update, 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

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: