:doc:`XRay <../../xray>` / Paginator / GetSamplingStatisticSummaries

*****************************
GetSamplingStatisticSummaries
*****************************



.. py:class:: XRay.Paginator.GetSamplingStatisticSummaries

  ::

    
    paginator = client.get_paginator('get_sampling_statistic_summaries')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`XRay.Client.get_sampling_statistic_summaries`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetSamplingStatisticSummaries>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          PaginationConfig={
              'MaxItems': 123,
              'StartingToken': 'string'
          }
      )
      
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **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.

              
        
      
    