CloudWatchLogs / Client / describe_field_indexes

describe_field_indexes#

CloudWatchLogs.Client.describe_field_indexes(**kwargs)#

Returns a list of field indexes listed in the field index policies of one or more log groups. For more information about field index policies, see PutIndexPolicy.

See also: AWS API Documentation

Request Syntax

response = client.describe_field_indexes(
    logGroupIdentifiers=[
        'string',
    ],
    nextToken='string'
)
Parameters:

  • logGroupIdentifiers (list) –

    [REQUIRED]

    An array containing the names or ARNs of the log groups that you want to retrieve field indexes for.

    • (string) –

  • nextToken (string) – The token for the next set of items to return. The token expires after 24 hours.

Return type:

dict

Returns:

Response Syntax

{
    'fieldIndexes': [
        {
            'logGroupIdentifier': 'string',
            'fieldIndexName': 'string',
            'lastScanTime': 123,
            'firstEventTime': 123,
            'lastEventTime': 123
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • fieldIndexes (list) –

      An array containing the field index information.

      • (dict) –

        This structure describes one log event field that is used as an index in at least one index policy in this account.

        • logGroupIdentifier (string) –

          If this field index appears in an index policy that applies only to a single log group, the ARN of that log group is displayed here.

        • fieldIndexName (string) –

          The string that this field index matches.

        • lastScanTime (integer) –

          The most recent time that CloudWatch Logs scanned ingested log events to search for this field index to improve the speed of future CloudWatch Logs Insights queries that search for this field index.

        • firstEventTime (integer) –

          The time and date of the earliest log event that matches this field index, after the index policy that contains it was created.

        • lastEventTime (integer) –

          The time and date of the most recent log event that matches this field index.

    • nextToken (string) –

      The token for the next set of items to return. The token expires after 24 hours.

Exceptions

  • CloudWatchLogs.Client.exceptions.InvalidParameterException

  • CloudWatchLogs.Client.exceptions.ResourceNotFoundException

  • CloudWatchLogs.Client.exceptions.LimitExceededException

  • CloudWatchLogs.Client.exceptions.OperationAbortedException

  • CloudWatchLogs.Client.exceptions.ServiceUnavailableException