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

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

SamplingRuleUpdate

A document specifying changes to a sampling rule's configuration.

Contents

Attributes

Matches attributes derived from the request.

Type: String to string map

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

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

Required: No

FixedRate

The percentage of matching requests to instrument, after the reservoir is exhausted.

Type: Double

Required: No

Host

Matches the hostname from a request URL.

Type: String

Length Constraints: Maximum length of 64.

Required: No

HTTPMethod

Matches the HTTP method of a request.

Type: String

Length Constraints: Maximum length of 10.

Required: No

Priority

The priority of the sampling rule.

Type: Integer

Required: No

ReservoirSize

A fixed number of matching requests to instrument per second, prior to applying the fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively.

Type: Integer

Required: No

ResourceARN

Matches the ARN of the AWS resource on which the service runs.

Type: String

Length Constraints: Maximum length of 500.

Required: No

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

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

Required: No

ServiceName

Matches the name that the service uses to identify itself in segments.

Type: String

Length Constraints: Maximum length of 64.

Required: No

ServiceType

Matches the origin that the service uses to identify its type in segments.

Type: String

Length Constraints: Maximum length of 64.

Required: No

URLPath

Matches the path from a request URL.

Type: String

Length Constraints: Maximum length of 128.

Required: No

See Also

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

On this page: