:doc:`Batch <../../batch>` / Paginator / ListConsumableResources

***********************
ListConsumableResources
***********************



.. py:class:: Batch.Paginator.ListConsumableResources

  ::

    
    paginator = client.get_paginator('list_consumable_resources')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`Batch.Client.list_consumable_resources`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ListConsumableResources>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          filters=[
              {
                  'name': 'string',
                  'values': [
                      'string',
                  ]
              },
          ],
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type filters: list
    :param filters: 

      The filters to apply to the consumable resource list query. If used, only those consumable resources that match the filter are listed. Filter names and values can be:

       

      
      * name: ``CONSUMABLE_RESOURCE_NAME`` values: case-insensitive matches for the consumable resource name. If a filter value ends with an asterisk (*), it matches any consumable resource name that begins with the string before the '*'.
      

      

    
      - *(dict) --* 

        A filter name and value pair that's used to return a more specific list of results from a ``ListJobs`` or ``ListJobsByConsumableResource`` API operation.

        

      
        - **name** *(string) --* 

          The name of the filter. Filter names are case sensitive.

          

        
        - **values** *(list) --* 

          The filter values.

          

        
          - *(string) --* 

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

      
      ::

        {
            'consumableResources': [
                {
                    'consumableResourceArn': 'string',
                    'consumableResourceName': 'string',
                    'totalQuantity': 123,
                    'inUseQuantity': 123,
                    'resourceType': 'string'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **consumableResources** *(list) --* 

          A list of consumable resources that match the request.

          
          

          - *(dict) --* 

            Current information about a consumable resource.

            
            

            - **consumableResourceArn** *(string) --* 

              The Amazon Resource Name (ARN) of the consumable resource.

              
            

            - **consumableResourceName** *(string) --* 

              The name of the consumable resource.

              
            

            - **totalQuantity** *(integer) --* 

              The total amount of the consumable resource that is available.

              
            

            - **inUseQuantity** *(integer) --* 

              The amount of the consumable resource that is currently in use.

              
            

            - **resourceType** *(string) --* 

              Indicates whether the resource is available to be re-used after a job completes. Can be one of:

               

              
              * ``REPLENISHABLE``
               
              * ``NON_REPLENISHABLE``
              

              
        
      
        

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

          A token to resume pagination.

          
    