Skip to content

CloudFront KeyValueStore  >  Operations  >  get_key

get_key

Operation

get_key async

get_key(request: GetKeyInput | GetKeyInputDict, /, *, plugins: list[Plugin] | None = None) -> GetKeyOutput
get_key(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetKeyInputDict]) -> GetKeyOutput

Returns a key value pair.

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
GetKeyOutput

An instance of GetKeyOutput.

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

GetKeyInput dataclass

Bases: _SerdeShape

Dataclass for GetKeyInput structure.

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

The key to get.

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

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

Dictionaries

GetKeyInputDict

Bases: TypedDict

Dictionary form of GetKeyInput.

Attributes
key instance-attribute
key: Required[str]

The key to get.

kvs_arn instance-attribute
kvs_arn: Required[str]

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

Output

GetKeyOutput dataclass

Bases: _SerdeShape

A key value pair.

Attributes

item_count instance-attribute
item_count: int

Number of key value pairs in the Key Value Store.

key instance-attribute
key: str

The key of the key value pair.

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

value instance-attribute
value: str

The value of the key value pair.