CloudFrontKeyValueStore / Client / list_keys

list_keys#

CloudFrontKeyValueStore.Client.list_keys(**kwargs)#

Returns a list of key value pairs.

See also: AWS API Documentation

Request Syntax

response = client.list_keys(
    KvsARN='string',
    NextToken='string',
    MaxResults=123
)
Parameters:

  • KvsARN (string) –

    [REQUIRED]

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

  • NextToken (string) – 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.

  • MaxResults (integer) – Maximum number of results that are returned per call. The default is 10 and maximum allowed page is 50.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'Items': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • NextToken (string) –

      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.

    • Items (list) –

      Key value pairs

      • (dict) –

        A key value pair.

        • Key (string) –

          The key of the key value pair.

        • Value (string) –

          The value of the key value pair.

Exceptions

  • CloudFrontKeyValueStore.Client.exceptions.ConflictException

  • CloudFrontKeyValueStore.Client.exceptions.ValidationException

  • CloudFrontKeyValueStore.Client.exceptions.InternalServerException

  • CloudFrontKeyValueStore.Client.exceptions.ResourceNotFoundException

  • CloudFrontKeyValueStore.Client.exceptions.AccessDeniedException