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

**********************
DescribeCapacityBlocks
**********************



.. py:class:: EC2.Paginator.DescribeCapacityBlocks

  ::

    
    paginator = client.get_paginator('describe_capacity_blocks')

  
  

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

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

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          CapacityBlockIds=[
              'string',
          ],
          Filters=[
              {
                  'Name': 'string',
                  'Values': [
                      'string',
                  ]
              },
          ],
          DryRun=True|False,
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type CapacityBlockIds: list
    :param CapacityBlockIds: 

      The IDs of the Capacity Blocks.

      

    
      - *(string) --* 

      
  
    :type Filters: list
    :param Filters: 

      One or more filters.

       

      
      * ``capacity-block-id`` - The ID of the Capacity Block.
       
      * ``ultraserver-type`` - The Capacity Block type. The type can be ``instances`` or ``ultraservers``.
       
      * ``availability-zone`` - The Availability Zone of the Capacity Block.
       
      * ``start-date`` - The date and time at which the Capacity Block was started.
       
      * ``end-date`` - The date and time at which the Capacity Block expires. When a Capacity Block expires, all instances in the Capacity Block are terminated.
       
      * ``create-date`` - The date and time at which the Capacity Block was created.
       
      * ``state`` - The state of the Capacity Block ( ``active`` | ``expired`` | ``unavailable`` | ``cancelled`` | ``failed`` | ``scheduled`` | ``payment-pending`` | ``payment-failed``).
       
      * ``tags`` - The tags assigned to the Capacity Block.
      

      

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

      
      ::

        {
            'CapacityBlocks': [
                {
                    'CapacityBlockId': 'string',
                    'UltraserverType': 'string',
                    'AvailabilityZone': 'string',
                    'AvailabilityZoneId': 'string',
                    'CapacityReservationIds': [
                        'string',
                    ],
                    'StartDate': datetime(2015, 1, 1),
                    'EndDate': datetime(2015, 1, 1),
                    'CreateDate': datetime(2015, 1, 1),
                    'State': 'active'|'expired'|'unavailable'|'cancelled'|'failed'|'scheduled'|'payment-pending'|'payment-failed',
                    'Tags': [
                        {
                            'Key': 'string',
                            'Value': 'string'
                        },
                    ]
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **CapacityBlocks** *(list) --* 

          The Capacity Blocks.

          
          

          - *(dict) --* 

            Reserve powerful GPU instances on a future date to support your short duration machine learning (ML) workloads. Instances that run inside a Capacity Block are automatically placed close together inside `Amazon EC2 UltraClusters <http://aws.amazon.com/ec2/ultraclusters/>`__, for low-latency, petabit-scale, non-blocking networking.

             

            You can also reserve Amazon EC2 UltraServers. UltraServers connect multiple EC2 instances using a low-latency, high-bandwidth accelerator interconnect (NeuronLink). They are built to tackle very large-scale AI/ML workloads that require significant processing power. For more information, see Amazon EC2 UltraServers.

            
            

            - **CapacityBlockId** *(string) --* 

              The ID of the Capacity Block.

              
            

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

              The EC2 UltraServer type of the Capacity Block.

              
            

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

              The Availability Zone of the Capacity Block.

              
            

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

              The Availability Zone ID of the Capacity Block.

              
            

            - **CapacityReservationIds** *(list) --* 

              The ID of the Capacity Reservation.

              
              

              - *(string) --* 
          
            

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

              The date and time at which the Capacity Block was started.

              
            

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

              The date and time at which the Capacity Block expires. When a Capacity Block expires, all instances in the Capacity Block are terminated.

              
            

            - **CreateDate** *(datetime) --* 

              The date and time at which the Capacity Block was created.

              
            

            - **State** *(string) --* 

              The state of the Capacity Block.

              
            

            - **Tags** *(list) --* 

              The tags assigned to the Capacity Block.

              
              

              - *(dict) --* 

                Describes a tag.

                
                

                - **Key** *(string) --* 

                  The key of the tag.

                   

                  Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with ``aws:``.

                  
                

                - **Value** *(string) --* 

                  The value of the tag.

                   

                  Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

                  
            
          
        
      
    