Request Parameters Response Elements Errors Examples See Also

GetTelemetryQueryResults

Returns the results for the specified query.

Request Parameters

maxResults

The maximum number of result rows to return per page.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 1000.

Required: No

nextToken

A token to retrieve the next page of results.

Type: String

Required: No

queryId

The unique ID of the query.

Type: String

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

Pattern: [a-z0-9-]+

Required: Yes

Response Elements

The following elements are returned by the service.

nextToken

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

Type: String

rows

The result rows returned by the query.

Type: Array of string to string maps

statistics

Statistics about the query execution.

Type: QueryStatistics object

status

The current execution status of the query.

Type: String

Valid Values: Running | Failed | Complete | Cancelled

Errors

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

AccessDeniedException

The caller is not authorized to perform this action.

HTTP Status Code: 403

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

Get telemetry query results

The following example retrieves a page of results for a completed query, along with execution statistics. Payloads are shown as JSON; on the wire they are CBOR-encoded.

Sample Request


{
  "maxResults": 100,
  "queryId": "3b2a1c0d-7e6f-4a5b-8c9d-0e1f2a3b4c5d"
}

Sample Response


{
  "rows": [
    {
      "error_count": "42",
      "service.name": "checkout-service"
    },
    {
      "error_count": "7",
      "service.name": "payments-service"
    }
  ],
  "statistics": {
    "bytesScanned": 1048576.0,
    "partialResults": {
      "partialResultsDetected": false
    },
    "percentComplete": 100,
    "recordsMatched": 49,
    "recordsScanned": 20000
  },
  "status": "Complete"
}