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

DeleteSamplingRule

Deletes a sampling rule.

Request Syntax

POST /DeleteSamplingRule HTTP/1.1 Content-type: application/json { "RuleARN": "string", "RuleName": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

RuleARN

The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.

Type: String

Required: No

RuleName

The name of the sampling rule. Specify a rule by either name or ARN, but not both.

Type: String

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "SamplingRuleRecord": { "CreatedAt": number, "ModifiedAt": number, "SamplingRule": { "Attributes": { "string" : "string" }, "FixedRate": number, "Host": "string", "HTTPMethod": "string", "Priority": number, "ReservoirSize": number, "ResourceARN": "string", "RuleARN": "string", "RuleName": "string", "ServiceName": "string", "ServiceType": "string", "URLPath": "string", "Version": number } } }

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.

SamplingRuleRecord

The deleted rule definition and metadata.

Type: SamplingRuleRecord object

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: