CloudWatchOmni / Client / list_telemetry_fields

list_telemetry_fields

CloudWatchOmni.Client.list_telemetry_fields(**kwargs)

Lists fields available for telemetry queries.

Returns a list of fields included in the specified dataset, granular to telemetry type. Returned field names reflect the exact stored casing and are case-sensitive when referenced in query expressions; the query engine does not normalize identifier case.

See also: AWS API Documentation

Request Syntax

response = client.list_telemetry_fields(
    dataSetName='string',
    telemetryType='LOGS'|'TRACES',
    startTime=datetime(2015, 1, 1),
    endTime=datetime(2015, 1, 1),
    nextToken='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.

  • nextToken (string) – A token to retrieve the next page of results. Reserved for future pagination; the service does not paginate at this time and returns null.

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 retrieve the next page of results, or null if there are no more results.

Exceptions