:doc:`EC2 <../../ec2>` / Client / describe_capacity_block_status

******************************
describe_capacity_block_status
******************************



.. py:method:: EC2.Client.describe_capacity_block_status(**kwargs)

  

  Describes the availability of capacity for the specified Capacity blocks, or all of your Capacity Blocks.

  

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


  **Request Syntax**
  ::

    response = client.describe_capacity_block_status(
        CapacityBlockIds=[
            'string',
        ],
        NextToken='string',
        MaxResults=123,
        Filters=[
            {
                'Name': 'string',
                'Values': [
                    'string',
                ]
            },
        ],
        DryRun=True|False
    )
    
  :type CapacityBlockIds: list
  :param CapacityBlockIds: 

    The ID of the Capacity Block.

    

  
    - *(string) --* 

    

  :type NextToken: string
  :param NextToken: 

    The token to use to retrieve the next page of results.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see `Pagination <https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination>`__.

    

  
  :type Filters: list
  :param Filters: 

    One or more filters.

     

    
    * ``interconnect-status`` - The status of the interconnect for the Capacity Block ( ``ok`` | ``impaired`` | ``insufficient-data``).
    

    

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

    

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

    
    ::

      {
          'CapacityBlockStatuses': [
              {
                  'CapacityBlockId': 'string',
                  'InterconnectStatus': 'ok'|'impaired'|'insufficient-data',
                  'TotalCapacity': 123,
                  'TotalAvailableCapacity': 123,
                  'TotalUnavailableCapacity': 123,
                  'CapacityReservationStatuses': [
                      {
                          'CapacityReservationId': 'string',
                          'TotalCapacity': 123,
                          'TotalAvailableCapacity': 123,
                          'TotalUnavailableCapacity': 123
                      },
                  ]
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **CapacityBlockStatuses** *(list) --* 

        The availability of capacity for a Capacity Block.

        
        

        - *(dict) --* 

          Describes the availability of capacity for a Capacity Block.

          
          

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

            The ID of the Capacity Block.

            
          

          - **InterconnectStatus** *(string) --* 

            The status of the high-bandwidth accelerator interconnect. Possible states include:

             

            
            * ``ok`` the accelerator interconnect is healthy.
             
            * ``impaired`` - accelerator interconnect communication is impaired.
             
            * ``insufficient-data`` - insufficient data to determine accelerator interconnect status.
            

            
          

          - **TotalCapacity** *(integer) --* 

            The combined amount of ``Available`` and ``Unavailable`` capacity in the Capacity Block.

            
          

          - **TotalAvailableCapacity** *(integer) --* 

            The remaining capacity. Indicates the number of resources that can be launched into the Capacity Block.

            
          

          - **TotalUnavailableCapacity** *(integer) --* 

            The unavailable capacity. Indicates the instance capacity that is unavailable for use due to a system status check failure.

            
          

          - **CapacityReservationStatuses** *(list) --* 

            The availability of capacity for the Capacity Block reservations.

            
            

            - *(dict) --* 

              Describes the availability of capacity for a Capacity Reservation.

              
              

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

                The ID of the Capacity Reservation.

                
              

              - **TotalCapacity** *(integer) --* 

                The combined amount of ``Available`` and ``Unavailable`` capacity in the Capacity Reservation.

                
              

              - **TotalAvailableCapacity** *(integer) --* 

                The remaining capacity. Indicates the amount of resources that can be launched into the Capacity Reservation.

                
              

              - **TotalUnavailableCapacity** *(integer) --* 

                The used capacity. Indicates that the capacity is in use by resources that are running in the Capacity Reservation.

                
          
        
      
    
      

      - **NextToken** *(string) --* 

        The token to use to retrieve the next page of results. This value is ``null`` when there are no more results to return.

        
  