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

***************************************
DescribeCapacityBlockExtensionOfferings
***************************************



.. py:class:: EC2.Paginator.DescribeCapacityBlockExtensionOfferings

  ::

    
    paginator = client.get_paginator('describe_capacity_block_extension_offerings')

  
  

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

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

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          DryRun=True|False,
          CapacityBlockExtensionDurationHours=123,
          CapacityReservationId='string',
          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 CapacityBlockExtensionDurationHours: integer
    :param CapacityBlockExtensionDurationHours: **[REQUIRED]** 

      The duration of the Capacity Block extension offering in hours.

      

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

      The ID of the Capacity reservation to be extended.

      

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

      
      ::

        {
            'CapacityBlockExtensionOfferings': [
                {
                    'CapacityBlockExtensionOfferingId': 'string',
                    'InstanceType': 'string',
                    'InstanceCount': 123,
                    'AvailabilityZone': 'string',
                    'AvailabilityZoneId': 'string',
                    'StartDate': datetime(2015, 1, 1),
                    'CapacityBlockExtensionStartDate': datetime(2015, 1, 1),
                    'CapacityBlockExtensionEndDate': datetime(2015, 1, 1),
                    'CapacityBlockExtensionDurationHours': 123,
                    'UpfrontFee': 'string',
                    'CurrencyCode': 'string',
                    'Tenancy': 'default'|'dedicated'
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **CapacityBlockExtensionOfferings** *(list) --* 

          The recommended Capacity Block extension offerings for the dates specified.

          
          

          - *(dict) --* 

            The recommended Capacity Block extension that fits your search requirements.

            
            

            - **CapacityBlockExtensionOfferingId** *(string) --* 

              The ID of the Capacity Block extension offering.

              
            

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

              The instance type of the Capacity Block that will be extended.

              
            

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

              The number of instances in the Capacity Block extension offering.

              
            

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

              The Availability Zone of the Capacity Block that will be extended.

              
            

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

              The Availability Zone ID of the Capacity Block that will be extended.

              
            

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

              The start date of the Capacity Block that will be extended.

              
            

            - **CapacityBlockExtensionStartDate** *(datetime) --* 

              The date and time at which the Capacity Block extension will start. This date is also the same as the end date of the Capacity Block that will be extended.

              
            

            - **CapacityBlockExtensionEndDate** *(datetime) --* 

              The date and time at which the Capacity Block extension expires. When a Capacity Block expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Block's state changes to ``expired`` when it reaches its end date

              
            

            - **CapacityBlockExtensionDurationHours** *(integer) --* 

              The amount of time of the Capacity Block extension offering in hours.

              
            

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

              The total price of the Capacity Block extension offering, to be paid up front.

              
            

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

              The currency of the payment for the Capacity Block extension offering.

              
            

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

              Indicates the tenancy of the Capacity Block extension offering. A Capacity Block can have one of the following tenancy settings:

               

              
              * ``default`` - The Capacity Block is created on hardware that is shared with other Amazon Web Services accounts.
               
              * ``dedicated`` - The Capacity Block is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.
              

              
        
      
    