:doc:`Outposts <../../outposts>` / Paginator / ListBlockingInstancesForCapacityTask

************************************
ListBlockingInstancesForCapacityTask
************************************



.. py:class:: Outposts.Paginator.ListBlockingInstancesForCapacityTask

  ::

    
    paginator = client.get_paginator('list_blocking_instances_for_capacity_task')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`Outposts.Client.list_blocking_instances_for_capacity_task`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/outposts-2019-12-03/ListBlockingInstancesForCapacityTask>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          OutpostIdentifier='string',
          CapacityTaskId='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type OutpostIdentifier: string
    :param OutpostIdentifier: **[REQUIRED]** 

      The ID or ARN of the Outpost associated with the specified capacity task.

      

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

      The ID of the capacity task.

      

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

      
      ::

        {
            'BlockingInstances': [
                {
                    'InstanceId': 'string',
                    'AccountId': 'string',
                    'AwsServiceName': 'AWS'|'EC2'|'ELASTICACHE'|'ELB'|'RDS'|'ROUTE53'
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **BlockingInstances** *(list) --* 

          A list of all running Amazon EC2 instances on the Outpost. Stopping one or more of these instances can free up the capacity needed to run the capacity task.

          
          

          - *(dict) --* 

            A running Amazon EC2 instance that can be stopped to free up capacity needed to run the capacity task.

            
            

            - **InstanceId** *(string) --* 

              The ID of the blocking instance.

              
            

            - **AccountId** *(string) --* 

              The ID of the Amazon Web Services account.

              
            

            - **AwsServiceName** *(string) --* 

              The Amazon Web Services service name that owns the specified blocking instance.

              
        
      
    