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

***************************
DescribeServiceEnvironments
***************************



.. py:class:: Batch.Paginator.DescribeServiceEnvironments

  ::

    
    paginator = client.get_paginator('describe_service_environments')

  
  

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

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

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


    **Request Syntax**
    ::

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

      An array of service environment names or ARN entries.

      

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

      
      ::

        {
            'serviceEnvironments': [
                {
                    'serviceEnvironmentName': 'string',
                    'serviceEnvironmentArn': 'string',
                    'serviceEnvironmentType': 'SAGEMAKER_TRAINING',
                    'state': 'ENABLED'|'DISABLED',
                    'status': 'CREATING'|'UPDATING'|'DELETING'|'DELETED'|'VALID'|'INVALID',
                    'capacityLimits': [
                        {
                            'maxCapacity': 123,
                            'capacityUnit': 'string'
                        },
                    ],
                    'tags': {
                        'string': 'string'
                    }
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **serviceEnvironments** *(list) --* 

          The list of service environments that match the request.

          
          

          - *(dict) --* 

            Detailed information about a service environment, including its configuration, state, and capacity limits.

            
            

            - **serviceEnvironmentName** *(string) --* 

              The name of the service environment.

              
            

            - **serviceEnvironmentArn** *(string) --* 

              The Amazon Resource Name (ARN) of the service environment.

              
            

            - **serviceEnvironmentType** *(string) --* 

              The type of service environment. For SageMaker Training jobs, this value is ``SAGEMAKER_TRAINING``.

              
            

            - **state** *(string) --* 

              The state of the service environment. Valid values are ``ENABLED`` and ``DISABLED``.

              
            

            - **status** *(string) --* 

              The current status of the service environment.

              
            

            - **capacityLimits** *(list) --* 

              The capacity limits for the service environment. This defines the maximum resources that can be used by service jobs in this environment.

              
              

              - *(dict) --* 

                Defines the capacity limit for a service environment. This structure specifies the maximum amount of resources that can be used by service jobs in the environment.

                
                

                - **maxCapacity** *(integer) --* 

                  The maximum capacity available for the service environment. This value represents the maximum amount of resources that can be allocated to service jobs.

                   

                  For example, ``maxCapacity=50``, ``capacityUnit=NUM_INSTANCES``. This indicates that the maximum number of instances that can be run on this service environment is 50. You could then run 5 SageMaker Training jobs that each use 10 instances. However, if you submit another job that requires 10 instances, it will wait in the queue.

                  
                

                - **capacityUnit** *(string) --* 

                  The unit of measure for the capacity limit. This defines how the maxCapacity value should be interpreted. For ``SAGEMAKER_TRAINING`` jobs, use ``NUM_INSTANCES``.

                  
            
          
            

            - **tags** *(dict) --* 

              The tags associated with the service environment. Each tag consists of a key and an optional value. For more information, see `Tagging your Batch resources <https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html>`__.

              
              

              - *(string) --* 
                

                - *(string) --* 
          
        
        
      
        

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

          A token to resume pagination.

          
    