AWS SDK Version 4 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Creates a rule to control sampling behavior for instrumented applications. Services retrieve rules with GetSamplingRules, and evaluate each rule in ascending order of priority for each request. If a rule matches, the service records a trace, borrowing it from the reservoir size. After 10 seconds, the service reports back to X-Ray with GetSamplingTargets to get updated versions of each in-use rule. The updated rule contains a trace quota that the service can use instead of borrowing from the reservoir.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.7.2 or higher.

Namespace: Amazon.XRay
Assembly: AWSSDK.XRay.dll
Version: 3.x.y.z

Syntax

C#
public virtual Task<CreateSamplingRuleResponse> CreateSamplingRuleAsync(
         CreateSamplingRuleRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.XRay.Model.CreateSamplingRuleRequest

Container for the necessary parameters to execute the CreateSamplingRule service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the CreateSamplingRule service method, as returned by XRay.

Exceptions

ExceptionCondition
InvalidRequestException The request is missing required parameters or has invalid parameters.
RuleLimitExceededException You have reached the maximum number of sampling rules.
ThrottledException The request exceeds the maximum number of requests per second.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer

See Also