NAME
Paws::XRay::SamplingRule
USAGE
This class represents one of two things:
Arguments in a call to a service
Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.
As an example, if Att1 is expected to be a Paws::XRay::SamplingRule object:
$service_obj->Method(Att1 => { Attributes => $value, ..., Version => $value });
Results returned from an API call
Use accessors for each attribute. If Att1 is expected to be an Paws::XRay::SamplingRule object:
$result = $service_obj->Method(...);
$result->Att1->Attributes
DESCRIPTION
A sampling rule that services use to decide whether to instrument a request. Rule fields can match properties of the service, or properties of a request. The service can ignore rules that don't match its properties.
ATTRIBUTES
Attributes => Paws::XRay::AttributeMap
Matches attributes derived from the request.
REQUIRED FixedRate => Num
The percentage of matching requests to instrument, after the reservoir is exhausted.
REQUIRED Host => Str
Matches the hostname from a request URL.
REQUIRED HTTPMethod => Str
Matches the HTTP method of a request.
REQUIRED Priority => Int
The priority of the sampling rule.
REQUIRED ReservoirSize => Int
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.
REQUIRED ResourceARN => Str
Matches the ARN of the AWS resource on which the service runs.
RuleARN => Str
The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.
RuleName => Str
The name of the sampling rule. Specify a rule by either name or ARN, but not both.
REQUIRED ServiceName => Str
Matches the name
that the service uses to identify itself in segments.
REQUIRED ServiceType => Str
Matches the origin
that the service uses to identify its type in segments.
REQUIRED URLPath => Str
Matches the path from a request URL.
REQUIRED Version => Int
The version of the sampling rule format (1
).
SEE ALSO
This class forms part of Paws, describing an object used in Paws::XRay
BUGS and CONTRIBUTIONS
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues