AWS X-Ray
API Reference (API Version 2016-04-12)

SamplingStatisticsDocument

Request sampling results for a single rule from a service. Results are for the last 10 seconds unless the service has been assigned a longer reporting interval after a previous call to GetSamplingTargets.

Contents

BorrowCount

The number of requests recorded with borrowed reservoir quota.

Type: Integer

Valid Range: Minimum value of 0.

Required: No

ClientID

A unique identifier for the service in hexadecimal.

Type: String

Length Constraints: Fixed length of 24.

Required: Yes

RequestCount

The number of requests that matched the rule.

Type: Integer

Valid Range: Minimum value of 0.

Required: Yes

RuleName

The name of the sampling rule.

Type: String

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

Required: Yes

SampledCount

The number of requests recorded.

Type: Integer

Valid Range: Minimum value of 0.

Required: Yes

Timestamp

The current time, in ISO-8601 format (YYYY-MM-DDThh:mm:ss).

Type: Timestamp

Required: Yes

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: