CloudWatchOmni / Paginator / ListTelemetryFields

ListTelemetryFields

class CloudWatchOmni.Paginator.ListTelemetryFields

paginator = client.get_paginator('list_telemetry_fields')

paginate(**kwargs)

Creates an iterator that will paginate through responses from CloudWatchOmni.Client.list_telemetry_fields().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    dataSetName='string',
    telemetryType='LOGS'|'TRACES',
    startTime=datetime(2015, 1, 1),
    endTime=datetime(2015, 1, 1),
    PaginationConfig={
        'MaxItems': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• dataSetName (string) –

  [REQUIRED]

  The name of the dataset to list fields for.

• telemetryType (string) – The type of telemetry to filter fields by.

• startTime (datetime) – Inclusive start of the lookback window. When omitted, the service defaults to the configured lookback before endTime.

• endTime (datetime) – Inclusive end of the lookback window. When omitted, the service defaults to the current time.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'fields': [
        {
            'name': 'string',
            'children': [
                {'... recursive ...'},
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • fields (list) –

    The list of fields available for queries.

    • (dict) –

      A telemetry field available for use in query expressions.

      • name (string) –

        The name of the field. Field names are case-sensitive and must be used exactly as returned when referencing them in query expressions.

      • children (list) –

        Child fields nested under this field.

        • (dict) –

          A telemetry field available for use in query expressions.

  • NextToken (string) –

    A token to resume pagination.