Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeLookupTables

Retrieves metadata about lookup tables in your account. You can optionally filter the results by table name prefix. Results are sorted by table name in ascending order.

Request Syntax


{
   "lookupTableNamePrefix": "string",
   "maxResults": number,
   "nextToken": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

lookupTableNamePrefix

A prefix to filter lookup tables by name. Only tables whose names start with this prefix are returned. If you don't specify a prefix, all tables in the account and Region are returned.

Type: String

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

Pattern: ^[a-zA-Z0-9_]+$

Required: No

maxResults

The maximum number of lookup tables to return in the response. The default value is 50 and the maximum value is 100.

Type: Integer

Valid Range: Maximum value of 100.

Required: No

nextToken

The token for the next set of items to return. (You received this token from a previous call.)

Type: String

Length Constraints: Minimum length of 1.

Required: No

Response Syntax


{
   "lookupTables": [ 
      { 
         "description": "string",
         "kmsKeyId": "string",
         "lastUpdatedTime": number,
         "lookupTableArn": "string",
         "lookupTableName": "string",
         "recordsCount": number,
         "sizeBytes": number,
         "tableFields": [ "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.

lookupTables

An array of structures, where each structure contains metadata about one lookup table.

Type: Array of LookupTable objects

nextToken

The token to use when requesting the next set of items.

Type: String

Length Constraints: Minimum length of 1.

Errors

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

AccessDeniedException

You don't have sufficient permissions to perform this action.

HTTP Status Code: 400

InvalidParameterException

A parameter is specified incorrectly.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource does not exist.

HTTP Status Code: 400

ServiceUnavailableException

The service cannot complete the request.

HTTP Status Code: 500