CloudFrontKeyValueStore / Client / delete_key
delete_key#
- CloudFrontKeyValueStore.Client.delete_key(**kwargs)#
Deletes the key value pair specified by the key.
See also: AWS API Documentation
Request Syntax
response = client.delete_key( KvsARN='string', Key='string', IfMatch='string' )
- Parameters:
KvsARN (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the Key Value Store.
Key (string) –
[REQUIRED]
The key to delete.
IfMatch (string) –
[REQUIRED]
The current version (ETag) of the Key Value Store that you are deleting keys from, which you can get using DescribeKeyValueStore.
- Return type:
dict
- Returns:
Response Syntax
{ 'ItemCount': 123, 'TotalSizeInBytes': 123, 'ETag': 'string' }
Response Structure
(dict) –
Metadata information about a Key Value Store.
ItemCount (integer) –
Number of key value pairs in the Key Value Store after the successful delete.
TotalSizeInBytes (integer) –
Total size of the Key Value Store after the successful delete, in bytes.
ETag (string) –
The current version identifier of the Key Value Store after the successful delete.
Exceptions
CloudFrontKeyValueStore.Client.exceptions.ConflictException
CloudFrontKeyValueStore.Client.exceptions.ValidationException
CloudFrontKeyValueStore.Client.exceptions.InternalServerException
CloudFrontKeyValueStore.Client.exceptions.ServiceQuotaExceededException
CloudFrontKeyValueStore.Client.exceptions.ResourceNotFoundException
CloudFrontKeyValueStore.Client.exceptions.AccessDeniedException