Skip to content

describe_key_value_store

Operation

describe_key_value_store

describe_key_value_store(request: DescribeKeyValueStoreInput | DescribeKeyValueStoreInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeKeyValueStoreInputDict]) -> DescribeKeyValueStoreOutput

Returns metadata information about Key Value Store.

Parameters:

Name Type Description Default
request DescribeKeyValueStoreInput | DescribeKeyValueStoreInputDict | 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[DescribeKeyValueStoreInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeKeyValueStoreOutput

An instance of DescribeKeyValueStoreOutput.

describe_key_value_store async

describe_key_value_store(request: DescribeKeyValueStoreInput | DescribeKeyValueStoreInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeKeyValueStoreInputDict]) -> DescribeKeyValueStoreOutput

Returns metadata information about Key Value Store.

Parameters:

Name Type Description Default
request DescribeKeyValueStoreInput | DescribeKeyValueStoreInputDict | 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[DescribeKeyValueStoreInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeKeyValueStoreOutput

An instance of DescribeKeyValueStoreOutput.

Input

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

DescribeKeyValueStoreInputDict

Bases: TypedDict

Dictionary form of DescribeKeyValueStoreInput.

Attributes

kvs_arn instance-attribute
kvs_arn: Required[str]

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

DescribeKeyValueStoreInput dataclass

Bases: _SerdeShape

Dataclass for DescribeKeyValueStoreInput structure.

Attributes

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

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

Output

DescribeKeyValueStoreOutput dataclass

Bases: _SerdeShape

Metadata information about a Key Value Store.

Attributes

created instance-attribute
created: datetime

Date and time when the Key Value Store was created.

e_tag instance-attribute
e_tag: str

The version identifier for the current version of the Key Value Store.

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

The reason for Key Value Store creation failure.

item_count instance-attribute
item_count: int

Number of key value pairs in the Key Value Store.

kvs_arn instance-attribute
kvs_arn: str

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

last_modified class-attribute instance-attribute
last_modified: datetime | None = ...

Date and time when the key value pairs in the Key Value Store was last modified.

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.

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

The current status of the Key Value Store.

total_size_in_bytes instance-attribute
total_size_in_bytes: int

Total size of the Key Value Store in bytes.