Skip to content

get_key

Operation

get_key

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

Returns a key value pair.

Parameters:

Name Type Description Default
request GetKeyInput | GetKeyInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[GetKeyInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetKeyOutput

An instance of GetKeyOutput.

get_key async

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

Returns a key value pair.

Parameters:

Name Type Description Default
request GetKeyInput | GetKeyInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[GetKeyInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetKeyOutput

An instance of GetKeyOutput.

Input

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

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.

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.

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.