Request Parameters Response Elements Errors Examples See Also

ListTelemetryFields

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.

Request Parameters

dataSetName

The name of the dataset to list fields for.

Type: String

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

Required: Yes

endTime

Inclusive end of the lookback window. When omitted, the service defaults to the current time.

Type: Timestamp

Required: No

nextToken

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

Type: String

Required: No

startTime

Inclusive start of the lookback window. When omitted, the service defaults to the configured lookback before endTime.

Type: Timestamp

Required: No

telemetryType

The type of telemetry to filter fields by.

Type: String

Valid Values: LOGS | TRACES

Required: No

Response Elements

The following elements are returned by the service.

fields

The list of fields available for queries.

Type: Array of Field objects

nextToken

A token to retrieve the next page of results, or null if there are no more results.

Type: String

Errors

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

InternalServerException

An unexpected error occurred while processing the request.

errorCode: The error code associated with the internal error.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource does not exist.

errorCode: The error code associated with the failure.
resourceId: The identifier of the resource that could not be found. Not always present.
resourceType: The type of the resource that could not be found. Not always present.

HTTP Status Code: 404

ThrottlingException

The request was throttled due to exceeding the allowed request rate.

retryAfterSeconds: The number of seconds to wait before retrying the request. Not always present.

HTTP Status Code: 429

ValidationException

A parameter is specified incorrectly.

errorCode: The error code associated with the validation failure.

HTTP Status Code: 400

Examples

List fields for a dataset

The following example lists the log fields available in the specified dataset. Payloads are shown as JSON; on the wire they are CBOR-encoded.

Sample Request


{
  "dataSetName": "default",
  "telemetryType": "LOGS"
}

Sample Response


{
  "fields": [
    {
      "name": "@timestamp"
    },
    {
      "name": "@message"
    },
    {
      "children": [
        {
          "name": "http.method"
        },
        {
          "name": "http.status_code"
        }
      ],
      "name": "attributes"
    }
  ]
}