Skip to content

CloudFront KeyValueStore  >  Operations  >  delete_key

delete_key

Operation

delete_key async 

delete_key(input: DeleteKeyInput, plugins: list[Plugin] | None = None) -> DeleteKeyOutput

Deletes the key value pair specified by the key.

Parameters:

Name Type Description Default
input DeleteKeyInput

An instance of DeleteKeyInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
DeleteKeyOutput

An instance of DeleteKeyOutput.

Input

DeleteKeyInput dataclass

Bases: _SerdeShape

Dataclass for DeleteKeyInput structure.

Attributes

if_match class-attribute instance-attribute 
if_match: str | None = ...

The current version (ETag) of the Key Value Store that you are deleting keys from, which you can get using DescribeKeyValueStore.

key class-attribute instance-attribute 
key: str | None = ...

The key to delete.

kvs_arn class-attribute instance-attribute 
kvs_arn: str | None = ...

The Amazon Resource Name (ARN) of the Key Value Store.

Output

DeleteKeyOutput dataclass

Bases: _SerdeShape

Metadata information about a Key Value Store.

Attributes

e_tag instance-attribute 
e_tag: str

The current version identifier of the Key Value Store after the successful delete.

item_count instance-attribute 
item_count: int

Number of key value pairs in the Key Value Store after the successful delete.

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

total_size_in_bytes instance-attribute 
total_size_in_bytes: int

Total size of the Key Value Store after the successful delete, in bytes.