Retrieves all sampling rules.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
get-sampling-rules
is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate
argument.
When using --output text
and the --query
argument on a paginated response, the --query
argument must extract data from the results of the following query expressions: SamplingRuleRecords
get-sampling-rules
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml
.
--starting-token
(string)
A token to specify where to start paginating. This is the
NextToken
from a previously truncated response.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--max-items
(integer)
The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a
NextToken
is provided in the command’s output. To resume pagination, provide theNextToken
value in thestarting-token
argument of a subsequent command. Do not use theNextToken
response element directly outside of the AWS CLI.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
To retrieve all sampling rules
The following get-sampling-rules
example displays details for all available sampling rules.:
aws xray get-sampling-rules
Output:
{
"SamplingRuleRecords": [
{
"SamplingRule": {
"RuleName": "Default",
"RuleARN": "arn:aws:xray:us-east-1::sampling-rule/Default",
"ResourceARN": "*",
"Priority": 10000,
"FixedRate": 0.01,
"ReservoirSize": 0,
"ServiceName": "*",
"ServiceType": "*",
"Host": "*",
"HTTPMethod": "*",
"URLPath": "*",
"Version": 1,
"Attributes": {}
},
"CreatedAt": 0.0,
"ModifiedAt": 1530558121.0
},
{
"SamplingRule": {
"RuleName": "base-scorekeep",
"RuleARN": "arn:aws:xray:us-east-1::sampling-rule/base-scorekeep",
"ResourceARN": "*",
"Priority": 9000,
"FixedRate": 0.1,
"ReservoirSize": 2,
"ServiceName": "Scorekeep",
"ServiceType": "*",
"Host": "*",
"HTTPMethod": "*",
"URLPath": "*",
"Version": 1,
"Attributes": {}
},
"CreatedAt": 1530573954.0,
"ModifiedAt": 1530920505.0
},
{
"SamplingRule": {
"RuleName": "polling-scorekeep",
"RuleARN": "arn:aws:xray:us-east-1::sampling-rule/polling-scorekeep",
"ResourceARN": "*",
"Priority": 5000,
"FixedRate": 0.003,
"ReservoirSize": 0,
"ServiceName": "Scorekeep",
"ServiceType": "*",
"Host": "*",
"HTTPMethod": "GET",
"URLPath": "/api/state/*",
"Version": 1,
"Attributes": {}
},
"CreatedAt": 1530918163.0,
"ModifiedAt": 1530918163.0
}
]
}
For more information, see Using Sampling Rules with the X-Ray API in the AWS X-Ray Developer Guide.
SamplingRuleRecords -> (list)
Rule definitions and metadata.
(structure)
A SamplingRule and its metadata.
SamplingRule -> (structure)
The sampling rule.
RuleName -> (string)
The name of the sampling rule. Specify a rule by either name or ARN, but not both.
RuleARN -> (string)
The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.
ResourceARN -> (string)
Matches the ARN of the Amazon Web Services resource on which the service runs.
Priority -> (integer)
The priority of the sampling rule.
FixedRate -> (double)
The percentage of matching requests to instrument, after the reservoir is exhausted.
ReservoirSize -> (integer)
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.
ServiceName -> (string)
Matches the
name
that the service uses to identify itself in segments.ServiceType -> (string)
Matches the
origin
that the service uses to identify its type in segments.Host -> (string)
Matches the hostname from a request URL.
HTTPMethod -> (string)
Matches the HTTP method of a request.
URLPath -> (string)
Matches the path from a request URL.
Version -> (integer)
The version of the sampling rule format (
1
).Attributes -> (map)
Matches attributes derived from the request.
key -> (string)
value -> (string)
CreatedAt -> (timestamp)
When the rule was created.
ModifiedAt -> (timestamp)
When the rule was last modified.
NextToken -> (string)
Pagination token.