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

******************************
DescribeCapacityBlockOfferings
******************************



.. py:class:: EC2.Paginator.DescribeCapacityBlockOfferings

  ::

    
    paginator = client.get_paginator('describe_capacity_block_offerings')

  
  

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

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

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          DryRun=True|False,
          InstanceType='string',
          InstanceCount=123,
          StartDateRange=datetime(2015, 1, 1),
          EndDateRange=datetime(2015, 1, 1),
          CapacityDurationHours=123,
          UltraserverType='string',
          UltraserverCount=123,
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': '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 InstanceType: string
    :param InstanceType: 

      The type of instance for which the Capacity Block offering reserves capacity.

      

    
    :type InstanceCount: integer
    :param InstanceCount: 

      The number of instances for which to reserve capacity. Each Capacity Block can have up to 64 instances, and you can have up to 256 instances across Capacity Blocks.

      

    
    :type StartDateRange: datetime
    :param StartDateRange: 

      The earliest start date for the Capacity Block offering.

      

    
    :type EndDateRange: datetime
    :param EndDateRange: 

      The latest end date for the Capacity Block offering.

      

    
    :type CapacityDurationHours: integer
    :param CapacityDurationHours: **[REQUIRED]** 

      The reservation duration for the Capacity Block, in hours. You must specify the duration in 1-day increments up 14 days, and in 7-day increments up to 182 days.

      

    
    :type UltraserverType: string
    :param UltraserverType: 

      The EC2 UltraServer type of the Capacity Block offerings.

      

    
    :type UltraserverCount: integer
    :param UltraserverCount: 

      The number of EC2 UltraServers in the offerings.

      

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

      
      ::

        {
            'CapacityBlockOfferings': [
                {
                    'CapacityBlockOfferingId': 'string',
                    'InstanceType': 'string',
                    'AvailabilityZone': 'string',
                    'InstanceCount': 123,
                    'StartDate': datetime(2015, 1, 1),
                    'EndDate': datetime(2015, 1, 1),
                    'CapacityBlockDurationHours': 123,
                    'UpfrontFee': 'string',
                    'CurrencyCode': 'string',
                    'Tenancy': 'default'|'dedicated',
                    'UltraserverType': 'string',
                    'UltraserverCount': 123,
                    'CapacityBlockDurationMinutes': 123
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **CapacityBlockOfferings** *(list) --* 

          The recommended Capacity Block offering for the dates specified.

          
          

          - *(dict) --* 

            The recommended Capacity Block that fits your search requirements.

            
            

            - **CapacityBlockOfferingId** *(string) --* 

              The ID of the Capacity Block offering.

              
            

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

              The instance type of the Capacity Block offering.

              
            

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

              The Availability Zone of the Capacity Block offering.

              
            

            - **InstanceCount** *(integer) --* 

              The number of instances in the Capacity Block offering.

              
            

            - **StartDate** *(datetime) --* 

              The start date of the Capacity Block offering.

              
            

            - **EndDate** *(datetime) --* 

              The end date of the Capacity Block offering.

              
            

            - **CapacityBlockDurationHours** *(integer) --* 

              The number of hours (in addition to ``capacityBlockDurationMinutes``) for the duration of the Capacity Block reservation. For example, if a Capacity Block starts at **04:55** and ends at **11:30**, the hours field would be **6**.

              
            

            - **UpfrontFee** *(string) --* 

              The total price to be paid up front.

              
            

            - **CurrencyCode** *(string) --* 

              The currency of the payment for the Capacity Block.

              
            

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

              The tenancy of the Capacity Block.

              
            

            - **UltraserverType** *(string) --* 

              The EC2 UltraServer type of the Capacity Block offering.

              
            

            - **UltraserverCount** *(integer) --* 

              The number of EC2 UltraServers in the offering.

              
            

            - **CapacityBlockDurationMinutes** *(integer) --* 

              The number of minutes (in addition to ``capacityBlockDurationHours``) for the duration of the Capacity Block reservation. For example, if a Capacity Block starts at **08:55** and ends at **11:30**, the minutes field would be **35**.

              
        
      
    