Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListKeys

Returns a list of key-value pairs.

Request Syntax


GET /key-value-stores/KvsARN/keys?MaxResults=MaxResults&NextToken=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

KvsARN

The Amazon Resource Name (ARN) of the key value store.

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: Yes

MaxResults

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

Valid Range: Minimum value of 1. Maximum value of 50.

NextToken

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.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

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

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Items

The key-value pairs.

Type: Array of ListKeysResponseListItem objects

NextToken

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.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

Access denied.

HTTP Status Code: 403

ConflictException

Resource is not in expected state.

HTTP Status Code: 409

InternalServerException

Internal server error.

HTTP Status Code: 500

ResourceNotFoundException

Resource was not found.

HTTP Status Code: 404

ValidationException

Validation failed.

HTTP Status Code: 400