:doc:`EC2 <../../ec2>` / Paginator / DescribeCapacityReservationBillingRequests

******************************************
DescribeCapacityReservationBillingRequests
******************************************



.. py:class:: EC2.Paginator.DescribeCapacityReservationBillingRequests

  ::

    
    paginator = client.get_paginator('describe_capacity_reservation_billing_requests')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`EC2.Client.describe_capacity_reservation_billing_requests`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/DescribeCapacityReservationBillingRequests>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          CapacityReservationIds=[
              'string',
          ],
          Role='odcr-owner'|'unused-reservation-billing-owner',
          Filters=[
              {
                  'Name': 'string',
                  'Values': [
                      'string',
                  ]
              },
          ],
          DryRun=True|False,
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type CapacityReservationIds: list
    :param CapacityReservationIds: 

      The ID of the Capacity Reservation.

      

    
      - *(string) --* 

      
  
    :type Role: string
    :param Role: **[REQUIRED]** 

      Specify one of the following:

       

      
      * ``odcr-owner`` - If you are the Capacity Reservation owner, specify this value to view requests that you have initiated. Not supported with the ``requested-by`` filter.
       
      * ``unused-reservation-billing-owner`` - If you are the consumer account, specify this value to view requests that have been sent to you. Not supported with the ``unused-reservation-billing-owner`` filter.
      

      

    
    :type Filters: list
    :param Filters: 

      One or more filters.

       

      
      * ``status`` - The state of the request ( ``pending`` | ``accepted`` | ``rejected`` | ``cancelled`` | ``revoked`` | ``expired``).
       
      * ``requested-by`` - The account ID of the Capacity Reservation owner that initiated the request. Not supported if you specify ``requested-by`` for **Role**.
       
      * ``unused-reservation-billing-owner`` - The ID of the consumer account to which the request was sent. Not supported if you specify ``unused-reservation-billing-owner`` for **Role**.
      

      

    
      - *(dict) --* 

        A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

         

        If you specify multiple filters, the filters are joined with an ``AND``, and the request returns only results that match all of the specified filters.

         

        For more information, see `List and filter using the CLI and API <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Filtering.html#Filtering_Resources_CLI>`__ in the *Amazon EC2 User Guide*.

        

      
        - **Name** *(string) --* 

          The name of the filter. Filter names are case-sensitive.

          

        
        - **Values** *(list) --* 

          The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an ``OR``, and the request returns all results that match any of the specified values.

          

        
          - *(string) --* 

          
      
      
  
    :type DryRun: boolean
    :param DryRun: 

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is ``DryRunOperation``. Otherwise, it is ``UnauthorizedOperation``.

      

    
    :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.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

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

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'CapacityReservationBillingRequests': [
                {
                    'CapacityReservationId': 'string',
                    'RequestedBy': 'string',
                    'UnusedReservationBillingOwnerId': 'string',
                    'LastUpdateTime': datetime(2015, 1, 1),
                    'Status': 'pending'|'accepted'|'rejected'|'cancelled'|'revoked'|'expired',
                    'StatusMessage': 'string',
                    'CapacityReservationInfo': {
                        'InstanceType': 'string',
                        'AvailabilityZone': 'string',
                        'Tenancy': 'default'|'dedicated',
                        'AvailabilityZoneId': 'string'
                    }
                },
            ]
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **CapacityReservationBillingRequests** *(list) --* 

          Information about the request.

          
          

          - *(dict) --* 

            Information about a request to assign billing of the unused capacity of a Capacity Reservation.

            
            

            - **CapacityReservationId** *(string) --* 

              The ID of the Capacity Reservation.

              
            

            - **RequestedBy** *(string) --* 

              The ID of the Amazon Web Services account that initiated the request.

              
            

            - **UnusedReservationBillingOwnerId** *(string) --* 

              The ID of the Amazon Web Services account to which the request was sent.

              
            

            - **LastUpdateTime** *(datetime) --* 

              The date and time, in UTC time format, at which the request was initiated.

              
            

            - **Status** *(string) --* 

              The status of the request. For more information, see `View billing assignment requests for a shared Amazon EC2 Capacity Reservation <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/view-billing-transfers.html>`__.

              
            

            - **StatusMessage** *(string) --* 

              Information about the status.

              
            

            - **CapacityReservationInfo** *(dict) --* 

              Information about the Capacity Reservation.

              
              

              - **InstanceType** *(string) --* 

                The instance type for the Capacity Reservation.

                
              

              - **AvailabilityZone** *(string) --* 

                The Availability Zone for the Capacity Reservation.

                
              

              - **Tenancy** *(string) --* 

                The tenancy of the Capacity Reservation.

                
              

              - **AvailabilityZoneId** *(string) --* 

                The ID of the Availability Zone.

                
          
        
      
    