Skip to content

CloudFront KeyValueStore  >  Operations  >  list_keys

list_keys

Operation

list_keys async

list_keys(request: ListKeysInput | ListKeysInputDict, /, *, plugins: list[Plugin] | None = None) -> ListKeysOutput
list_keys(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListKeysInputDict]) -> ListKeysOutput

Returns a list of key value pairs.

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
ListKeysOutput

An instance of ListKeysOutput.

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

ListKeysInput dataclass

Bases: _SerdeShape

Dataclass for ListKeysInput structure.

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

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

max_results class-attribute instance-attribute
max_results: int = ...

Maximum number of results that are returned per call. The default is 10 and maximum allowed page is 50.

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

If nextToken is returned in the response, there are more results available. Make the next call using the returned token to retrieve the next page.

Dictionaries

ListKeysInputDict

Bases: TypedDict

Dictionary form of ListKeysInput.

Attributes
kvs_arn instance-attribute
kvs_arn: Required[str]

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

max_results instance-attribute
max_results: int | None

Maximum number of results that are returned per call. The default is 10 and maximum allowed page is 50.

next_token instance-attribute
next_token: str | None

If nextToken is returned in the response, there are more results available. Make the next call using the returned token to retrieve the next page.

Output

ListKeysOutput dataclass

Bases: _SerdeShape

Dataclass for ListKeysOutput structure.

Attributes

items class-attribute instance-attribute
items: list[ListKeysResponseListItem] | None = ...

Key value pairs

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

If nextToken is returned in the response, there are more results available. Make the next call using the returned token to retrieve the next page.

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.