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

GetSamplingTargets

Requests a sampling quota for rules that the service is using to sample requests.

Request Syntax

POST /SamplingTargets HTTP/1.1 Content-type: application/json { "SamplingStatisticsDocuments": [ { "BorrowCount": number, "ClientID": "string", "RequestCount": number, "RuleName": "string", "SampledCount": number, "Timestamp": number } ] }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

SamplingStatisticsDocuments

Information about rules that the service is using to sample requests.

Type: Array of SamplingStatisticsDocument objects

Array Members: Maximum number of 25 items.

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "LastRuleModification": number, "SamplingTargetDocuments": [ { "FixedRate": number, "Interval": number, "ReservoirQuota": number, "ReservoirQuotaTTL": number, "RuleName": "string" } ], "UnprocessedStatistics": [ { "ErrorCode": "string", "Message": "string", "RuleName": "string" } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

LastRuleModification

The last time a user changed the sampling rule configuration, in Unix time seconds. If the sampling rule configuration changed since the service last retrieved it, the service should call GetSamplingRules to get the latest version.

Type: Timestamp

SamplingTargetDocuments

Updated rules that the service should use to sample requests.

Type: Array of SamplingTargetDocument objects

UnprocessedStatistics

Information about SamplingStatisticsDocument that X-Ray could not process.

Type: Array of UnprocessedStatistics objects

Errors

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

InvalidRequestException

The request is missing required parameters or has invalid parameters.

HTTP Status Code: 400

ThrottledException

The request exceeds the maximum number of requests per second.

HTTP Status Code: 429

See Also

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