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

Specifies the key value store and its configuration.

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

Specifies the key value store and its configuration.

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

name instance-attribute
name: Required[str]

The name of the key value store.

DescribeKeyValueStoreInput dataclass

Bases: _SerdeShape

Dataclass for DescribeKeyValueStoreInput structure.

Attributes

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

The name of the key value store.

Output

DescribeKeyValueStoreOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeKeyValueStoreOutput structure.

Attributes

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

The ETag of the resulting key value store.

key_value_store class-attribute instance-attribute
key_value_store: KeyValueStore | None = ...

The resulting key value store.

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.