CloudWatchLogs / Client / describe_lookup_tables

describe_lookup_tables¶

CloudWatchLogs.Client.describe_lookup_tables(**kwargs)¶

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

response = client.describe_lookup_tables(
    lookupTableNamePrefix='string',
    maxResults=123,
    nextToken='string'
)

Parameters:

lookupTableNamePrefix (string) – 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.
maxResults (integer) – The maximum number of lookup tables to return in the response. The default value is 50 and the maximum value is 100.
nextToken (string) – The token for the next set of items to return. (You received this token from a previous call.)

Return type:

dict

Returns:

Response Syntax

{
    'lookupTables': [
        {
            'lookupTableArn': 'string',
            'lookupTableName': 'string',
            'description': 'string',
            'tableFields': [
                'string',
            ],
            'recordsCount': 123,
            'sizeBytes': 123,
            'lastUpdatedTime': 123,
            'kmsKeyId': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- lookupTables (list) –
  
  An array of structures, where each structure contains metadata about one lookup table.
  - (dict) –
    
    Contains metadata about a lookup table returned by DescribeLookupTables.
    - lookupTableArn (string) –
      
      The ARN of the lookup table.
    - lookupTableName (string) –
      
      The name of the lookup table.
    - description (string) –
      
      The description of the lookup table.
    - tableFields (list) –
      
      The column headers from the first row of the CSV file.
      - (string) –
    - recordsCount (integer) –
      
      The number of data rows in the lookup table, excluding the header row.
    - sizeBytes (integer) –
      
      The size of the lookup table in bytes.
    - lastUpdatedTime (integer) –
      
      The time when the lookup table was last updated, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
    - kmsKeyId (string) –
      
      The ARN of the KMS key used to encrypt the lookup table data, if applicable.
- nextToken (string) –
  
  The token to use when requesting the next set of items.

Exceptions

CloudWatchLogs.Client.exceptions.InvalidParameterException
CloudWatchLogs.Client.exceptions.ResourceNotFoundException
CloudWatchLogs.Client.exceptions.AccessDeniedException
CloudWatchLogs.Client.exceptions.ServiceUnavailableException