Skip to content

CloudFront KeyValueStore  >  Operations  >  update_keys

update_keys

Operation

update_keys async

update_keys(request: UpdateKeysInput | UpdateKeysInputDict, /, *, plugins: list[Plugin] | None = None) -> UpdateKeysOutput
update_keys(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateKeysInputDict]) -> UpdateKeysOutput

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

Parameters:

Name Type Description Default
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
UpdateKeysOutput

An instance of UpdateKeysOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

UpdateKeysInput dataclass

Bases: _SerdeShape

Dataclass for UpdateKeysInput structure.

Attributes
deletes class-attribute instance-attribute
deletes: list[DeleteKeyRequestListItem] | None = ...

List of keys to delete.

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

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

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

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

puts class-attribute instance-attribute
puts: list[PutKeyRequestListItem] | None = ...

List of key value pairs to put.

Dictionaries

UpdateKeysInputDict

Bases: TypedDict

Dictionary form of UpdateKeysInput.

Attributes
deletes instance-attribute

List of keys to delete.

if_match instance-attribute
if_match: Required[str]

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

kvs_arn instance-attribute
kvs_arn: Required[str]

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

puts instance-attribute

List of key value pairs to put.

Output

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

item_count instance-attribute
item_count: int

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

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 update, in bytes.