Batch / Paginator / DescribeServiceEnvironments

DescribeServiceEnvironments

class Batch.Paginator.DescribeServiceEnvironments

paginator = client.get_paginator('describe_service_environments')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Batch.Client.describe_service_environments().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• serviceEnvironments (list) –

  An array of service environment names or ARN entries.

  • (string) –

• PaginationConfig (dict) –

  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.

Return type:

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 type and maximum quantity of resources that can be allocated to service jobs in a service environment.

          • maxCapacity (integer) –

            The maximum capacity available for the service environment. For a quota management enabled service environment, this value represents the maximum quantity of a particular resource type (specified by capacityUnit) that can be allocated to service jobs. For other service environments, this value represents the maximum quantity of all resources that can be allocated to service jobs.

            For example, if maxCapacity=50 and capacityUnit=NUM_INSTANCES, you can run up to 50 instances concurrently. If you run 5 SageMaker Training jobs that each use 10 instances, a subsequent job requiring 10 instances waits in the queue until capacity is available. In a quota management enabled service environment with capacityUnit=ml.m5.large, only ml.m5.large instances count against this limit, and jobs requiring other instance types wait until a matching capacity limit is configured.

          • capacityUnit (string) –

            The unit of measure for the capacity limit, which defines how maxCapacity is interpreted. For SAGEMAKER_TRAINING jobs in a quota management enabled service environment, specify the instance type (for example, ml.m5.large). Otherwise, 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.

        • (string) –

          • (string) –

  • NextToken (string) –

    A token to resume pagination.