XRay / Paginator / GetSamplingStatisticSummaries


class XRay.Paginator.GetSamplingStatisticSummaries#
paginator = client.get_paginator('get_sampling_statistic_summaries')

Creates an iterator that will paginate through responses from XRay.Client.get_sampling_statistic_summaries().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'StartingToken': 'string'

PaginationConfig (dict) –

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:



Response Syntax

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


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.