XRay / Client / get_sampling_statistic_summaries

get_sampling_statistic_summaries#

XRay.Client.get_sampling_statistic_summaries(**kwargs)#

Retrieves information about recent sampling results for all sampling rules.

See also: AWS API Documentation

Request Syntax

response = client.get_sampling_statistic_summaries(
    NextToken='string'
)
Parameters:

NextToken (string) – Pagination token.

Return type:

dict

Returns:

Response Syntax

{
    'SamplingStatisticSummaries': [
        {
            'RuleName': 'string',
            'Timestamp': datetime(2015, 1, 1),
            'RequestCount': 123,
            'BorrowCount': 123,
            'SampledCount': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • SamplingStatisticSummaries (list) –

      Information about the number of requests instrumented for each sampling rule.

      • (dict) –

        Aggregated request sampling data for a sampling rule across all services for a 10-second window.

        • RuleName (string) –

          The name of the sampling rule.

        • Timestamp (datetime) –

          The start time of the reporting window.

        • RequestCount (integer) –

          The number of requests that matched the rule.

        • BorrowCount (integer) –

          The number of requests recorded with borrowed reservoir quota.

        • SampledCount (integer) –

          The number of requests recorded.

    • NextToken (string) –

      Pagination token.

Exceptions

  • XRay.Client.exceptions.InvalidRequestException

  • XRay.Client.exceptions.ThrottledException