Batch / Client / describe_compute_environments

describe_compute_environments

Batch.Client.describe_compute_environments(**kwargs)

Describes one or more of your compute environments.

If you’re using an unmanaged compute environment, you can use the DescribeComputeEnvironment operation to determine the ecsClusterArn that you launch your Amazon ECS container instances into.

See also: AWS API Documentation

Request Syntax

response = client.describe_compute_environments(
    computeEnvironments=[
        'string',
    ],
    maxResults=123,
    nextToken='string'
)

Parameters:

• computeEnvironments (list) –

  A list of up to 100 compute environment names or full Amazon Resource Name (ARN) entries.

  • (string) –

• maxResults (integer) – The maximum number of cluster results returned by DescribeComputeEnvironments in paginated output. When this parameter is used, DescribeComputeEnvironments only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeComputeEnvironments request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn’t used, then DescribeComputeEnvironments returns up to 100 results and a nextToken value if applicable.

• nextToken (string) –

  The nextToken value returned from a previous paginated DescribeComputeEnvironments request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

  Note

  Treat this token as an opaque identifier that’s only used to retrieve the next items in a list and not for other programmatic purposes.

Return type:

dict

Returns:

Response Syntax

{
    'computeEnvironments': [
        {
            'computeEnvironmentName': 'string',
            'computeEnvironmentArn': 'string',
            'unmanagedvCpus': 123,
            'ecsClusterArn': 'string',
            'tags': {
                'string': 'string'
            },
            'type': 'MANAGED'|'UNMANAGED',
            'state': 'ENABLED'|'DISABLED',
            'status': 'CREATING'|'UPDATING'|'DELETING'|'DELETED'|'VALID'|'INVALID',
            'statusReason': 'string',
            'computeResources': {
                'type': 'EC2'|'SPOT'|'FARGATE'|'FARGATE_SPOT',
                'allocationStrategy': 'BEST_FIT'|'BEST_FIT_PROGRESSIVE'|'SPOT_CAPACITY_OPTIMIZED',
                'minvCpus': 123,
                'maxvCpus': 123,
                'desiredvCpus': 123,
                'instanceTypes': [
                    'string',
                ],
                'imageId': 'string',
                'subnets': [
                    'string',
                ],
                'securityGroupIds': [
                    'string',
                ],
                'ec2KeyPair': 'string',
                'instanceRole': 'string',
                'tags': {
                    'string': 'string'
                },
                'placementGroup': 'string',
                'bidPercentage': 123,
                'spotIamFleetRole': 'string',
                'launchTemplate': {
                    'launchTemplateId': 'string',
                    'launchTemplateName': 'string',
                    'version': 'string'
                },
                'ec2Configuration': [
                    {
                        'imageType': 'string',
                        'imageIdOverride': 'string',
                        'imageKubernetesVersion': 'string'
                    },
                ]
            },
            'serviceRole': 'string',
            'updatePolicy': {
                'terminateJobsOnUpdate': True|False,
                'jobExecutionTimeoutMinutes': 123
            },
            'eksConfiguration': {
                'eksClusterArn': 'string',
                'kubernetesNamespace': 'string'
            },
            'containerOrchestrationType': 'ECS'|'EKS',
            'uuid': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) –

  • computeEnvironments (list) –

    The list of compute environments.

    • (dict) –

      An object that represents an Batch compute environment.

      • computeEnvironmentName (string) –

        The name of the compute environment. It can be up to 128 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

      • computeEnvironmentArn (string) –

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

      • unmanagedvCpus (integer) –

        The maximum number of VCPUs expected to be used for an unmanaged compute environment.

      • ecsClusterArn (string) –

        The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster that the compute environment uses.

      • tags (dict) –

        The tags applied to the compute environment.

        • (string) –

          • (string) –

      • type (string) –

        The type of the compute environment: MANAGED or UNMANAGED. For more information, see Compute environments in the Batch User Guide.

      • state (string) –

        The state of the compute environment. The valid values are ENABLED or DISABLED.

        If the state is ENABLED, then the Batch scheduler can attempt to place jobs from an associated job queue on the compute resources within the environment. If the compute environment is managed, then it can scale its instances out or in automatically based on the job queue demand.

        If the state is DISABLED, then the Batch scheduler doesn’t attempt to place jobs within the environment. Jobs in a STARTING or RUNNING state continue to progress normally. Managed compute environments in the DISABLED state don’t scale out.

        Note

        Compute environments in a DISABLED state may continue to incur billing charges. To prevent additional charges, turn off and then delete the compute environment. For more information, see State in the Batch User Guide.

        When an instance is idle, the instance scales down to the minvCpus value. However, the instance size doesn’t change. For example, consider a c5.8xlarge instance with a minvCpus value of 4 and a desiredvCpus value of 36. This instance doesn’t scale down to a c5.large instance.

      • status (string) –

        The current status of the compute environment (for example, CREATING or VALID).

      • statusReason (string) –

        A short, human-readable string to provide additional details for the current status of the compute environment.

      • computeResources (dict) –

        The compute resources defined for the compute environment. For more information, see Compute environments in the Batch User Guide.

        • type (string) –

          The type of compute environment: EC2, SPOT, FARGATE, or FARGATE_SPOT. For more information, see Compute environments in the Batch User Guide.

          If you choose SPOT, you must also specify an Amazon EC2 Spot Fleet role with the spotIamFleetRole parameter. For more information, see Amazon EC2 spot fleet role in the Batch User Guide.

        • allocationStrategy (string) –

          The allocation strategy to use for the compute resource if not enough instances of the best fitting instance type can be allocated. This might be because of availability of the instance type in the Region or Amazon EC2 service limits. For more information, see Allocation strategies in the Batch User Guide.

          Note

          This parameter isn’t applicable to jobs that are running on Fargate resources. Don’t specify it.

          BEST_FIT (default)

          Batch selects an instance type that best fits the needs of the jobs with a preference for the lowest-cost instance type. If additional instances of the selected instance type aren’t available, Batch waits for the additional instances to be available. If there aren’t enough instances available or the user is reaching Amazon EC2 service limits, additional jobs aren’t run until the currently running jobs are completed. This allocation strategy keeps costs lower but can limit scaling. If you’re using Spot Fleets with BEST_FIT, the Spot Fleet IAM Role must be specified. Compute resources that use a BEST_FIT allocation strategy don’t support infrastructure updates and can’t update some parameters. For more information, see Updating compute environments in the Batch User Guide.

          BEST_FIT_PROGRESSIVE

          Batch selects additional instance types that are large enough to meet the requirements of the jobs in the queue. Its preference is for instance types with lower cost vCPUs. If additional instances of the previously selected instance types aren’t available, Batch selects new instance types.

          SPOT_CAPACITY_OPTIMIZED

          Batch selects one or more instance types that are large enough to meet the requirements of the jobs in the queue. Its preference is for instance types that are less likely to be interrupted. This allocation strategy is only available for Spot Instance compute resources.

          With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED strategies using On-Demand or Spot Instances, and the BEST_FIT strategy using Spot Instances, Batch might need to exceed maxvCpus to meet your capacity requirements. In this event, Batch never exceeds maxvCpus by more than a single instance.

        • minvCpus (integer) –

          The minimum number of Amazon EC2 vCPUs that an environment should maintain (even if the compute environment is DISABLED).

          Note

          This parameter isn’t applicable to jobs that are running on Fargate resources. Don’t specify it.

        • maxvCpus (integer) –

          The maximum number of Amazon EC2 vCPUs that a compute environment can reach.

          Note

          With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED allocation strategies using On-Demand or Spot Instances, and the BEST_FIT strategy using Spot Instances, Batch might need to exceed maxvCpus to meet your capacity requirements. In this event, Batch never exceeds maxvCpus by more than a single instance. For example, no more than a single instance from among those specified in your compute environment is allocated.

        • desiredvCpus (integer) –

          The desired number of Amazon EC2 vCPUS in the compute environment. Batch modifies this value between the minimum and maximum values based on job queue demand.

          Note

          This parameter isn’t applicable to jobs that are running on Fargate resources. Don’t specify it.

        • instanceTypes (list) –

          The instances types that can be launched. You can specify instance families to launch any instance type within those families (for example, c5 or p3), or you can specify specific sizes within a family (such as c5.8xlarge). You can also choose optimal to select instance types (from the C4, M4, and R4 instance families) that match the demand of your job queues.

          Note

          This parameter isn’t applicable to jobs that are running on Fargate resources. Don’t specify it.

          Note

          When you create a compute environment, the instance types that you select for the compute environment must share the same architecture. For example, you can’t mix x86 and ARM instances in the same compute environment.

          Note

          Currently, optimal uses instance types from the C4, M4, and R4 instance families. In Regions that don’t have instance types from those instance families, instance types from the C5, M5, and R5 instance families are used.

          • (string) –

        • imageId (string) –

          The Amazon Machine Image (AMI) ID used for instances launched in the compute environment. This parameter is overridden by the imageIdOverride member of the Ec2Configuration structure.

          Note

          This parameter isn’t applicable to jobs that are running on Fargate resources. Don’t specify it.

          Note

          The AMI that you choose for a compute environment must match the architecture of the instance types that you intend to use for that compute environment. For example, if your compute environment uses A1 instance types, the compute resource AMI that you choose must support ARM instances. Amazon ECS vends both x86 and ARM versions of the Amazon ECS-optimized Amazon Linux 2 AMI. For more information, see Amazon ECS-optimized Amazon Linux 2 AMI in the Amazon Elastic Container Service Developer Guide.

        • subnets (list) –

          The VPC subnets where the compute resources are launched. These subnets must be within the same VPC. Fargate compute resources can contain up to 16 subnets. For more information, see VPCs and subnets in the Amazon VPC User Guide.

          Note

          Batch on Amazon EC2 and Batch on Amazon EKS support Local Zones. For more information, see Local Zones in the Amazon EC2 User Guide for Linux Instances, Amazon EKS and Amazon Web Services Local Zones in the Amazon EKS User Guide and Amazon ECS clusters in Local Zones, Wavelength Zones, and Amazon Web Services Outposts in the Amazon ECS Developer Guide.

          Batch on Fargate doesn’t currently support Local Zones.

          • (string) –

        • securityGroupIds (list) –

          The Amazon EC2 security groups that are associated with instances launched in the compute environment. One or more security groups must be specified, either in securityGroupIds or using a launch template referenced in launchTemplate. This parameter is required for jobs that are running on Fargate resources and must contain at least one security group. Fargate doesn’t support launch templates. If security groups are specified using both securityGroupIds and launchTemplate, the values in securityGroupIds are used.

          • (string) –

        • ec2KeyPair (string) –

          The Amazon EC2 key pair that’s used for instances launched in the compute environment. You can use this key pair to log in to your instances with SSH.

          Note

          This parameter isn’t applicable to jobs that are running on Fargate resources. Don’t specify it.

        • instanceRole (string) –

          The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. You can specify the short name or full Amazon Resource Name (ARN) of an instance profile. For example, ``ecsInstanceRole ``or ``arn:aws:iam::<aws_account_id>:instance-profile/ecsInstanceRole ``. For more information, see Amazon ECS instance role in the Batch User Guide.

          Note

          This parameter isn’t applicable to jobs that are running on Fargate resources. Don’t specify it.

        • tags (dict) –

          Key-value pair tags to be applied to EC2 resources that are launched in the compute environment. For Batch, these take the form of "String1": "String2", where String1 is the tag key and String2 is the tag value-for example, { "Name": "Batch Instance - C4OnDemand" }. This is helpful for recognizing your Batch instances in the Amazon EC2 console. Updating these tags requires an infrastructure update to the compute environment. For more information, see Updating compute environments in the Batch User Guide. These tags aren’t seen when using the Batch ListTagsForResource API operation.

          Note

          This parameter isn’t applicable to jobs that are running on Fargate resources. Don’t specify it.

          • (string) –

            • (string) –

        • placementGroup (string) –

          The Amazon EC2 placement group to associate with your compute resources. If you intend to submit multi-node parallel jobs to your compute environment, you should consider creating a cluster placement group and associate it with your compute resources. This keeps your multi-node parallel job on a logical grouping of instances within a single Availability Zone with high network flow potential. For more information, see Placement groups in the Amazon EC2 User Guide for Linux Instances.

          Note

          This parameter isn’t applicable to jobs that are running on Fargate resources. Don’t specify it.

        • bidPercentage (integer) –

          The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that instance type before instances are launched. For example, if your maximum percentage is 20%, then the Spot price must be less than 20% of the current On-Demand price for that Amazon EC2 instance. You always pay the lowest (market) price and never more than your maximum percentage. If you leave this field empty, the default value is 100% of the On-Demand price. For most use cases, we recommend leaving this field empty.

          Note

          This parameter isn’t applicable to jobs that are running on Fargate resources. Don’t specify it.

        • spotIamFleetRole (string) –

          The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a SPOT compute environment. This role is required if the allocation strategy set to BEST_FIT or if the allocation strategy isn’t specified. For more information, see Amazon EC2 spot fleet role in the Batch User Guide.

          Note

          This parameter isn’t applicable to jobs that are running on Fargate resources. Don’t specify it.

          Warning

          To tag your Spot Instances on creation, the Spot Fleet IAM role specified here must use the newer AmazonEC2SpotFleetTaggingRole managed policy. The previously recommended AmazonEC2SpotFleetRole managed policy doesn’t have the required permissions to tag Spot Instances. For more information, see Spot instances not tagged on creation in the Batch User Guide.

        • launchTemplate (dict) –

          The launch template to use for your compute resources. Any other compute resource parameters that you specify in a CreateComputeEnvironment API operation override the same parameters in the launch template. You must specify either the launch template ID or launch template name in the request, but not both. For more information, see Launch template support in the Batch User Guide.

          Note

          This parameter isn’t applicable to jobs that are running on Fargate resources. Don’t specify it.

          • launchTemplateId (string) –

            The ID of the launch template.

          • launchTemplateName (string) –

            The name of the launch template.

          • version (string) –

            The version number of the launch template, $Latest, or $Default.

            If the value is $Latest, the latest version of the launch template is used. If the value is $Default, the default version of the launch template is used.

            Warning

            If the AMI ID that’s used in a compute environment is from the launch template, the AMI isn’t changed when the compute environment is updated. It’s only changed if the updateToLatestImageVersion parameter for the compute environment is set to true. During an infrastructure update, if either $Latest or $Default is specified, Batch re-evaluates the launch template version, and it might use a different version of the launch template. This is the case even if the launch template isn’t specified in the update. When updating a compute environment, changing the launch template requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.

            Default: $Default.

        • ec2Configuration (list) –

          Provides information that’s used to select Amazon Machine Images (AMIs) for EC2 instances in the compute environment. If Ec2Configuration isn’t specified, the default is ECS_AL2.

          One or two values can be provided.

          Note

          This parameter isn’t applicable to jobs that are running on Fargate resources. Don’t specify it.

          • (dict) –

            Provides information used to select Amazon Machine Images (AMIs) for instances in the compute environment. If Ec2Configuration isn’t specified, the default is ECS_AL2 ( Amazon Linux 2).

            Note

            This object isn’t applicable to jobs that are running on Fargate resources.

            • imageType (string) –

              The image type to match with the instance type to select an AMI. The supported values are different for ECS and EKS resources.

              ECS

              If the imageIdOverride parameter isn’t specified, then a recent Amazon ECS-optimized Amazon Linux 2 AMI ( ECS_AL2) is used. If a new image type is specified in an update, but neither an imageId nor a imageIdOverride parameter is specified, then the latest Amazon ECS optimized AMI for that image type that’s supported by Batch is used.

              ECS_AL2

              Amazon Linux 2: Default for all non-GPU instance families.

              ECS_AL2_NVIDIA

              Amazon Linux 2 (GPU): Default for all GPU instance families (for example P4 and G4) and can be used for all non Amazon Web Services Graviton-based instance types.

              ECS_AL1

              Amazon Linux. Amazon Linux has reached the end-of-life of standard support. For more information, see Amazon Linux AMI.

              EKS

              If the imageIdOverride parameter isn’t specified, then a recent Amazon EKS-optimized Amazon Linux AMI ( EKS_AL2) is used. If a new image type is specified in an update, but neither an imageId nor a imageIdOverride parameter is specified, then the latest Amazon EKS optimized AMI for that image type that Batch supports is used.

              EKS_AL2

              Amazon Linux 2: Default for all non-GPU instance families.

              EKS_AL2_NVIDIA

              Amazon Linux 2 (accelerated): Default for all GPU instance families (for example, P4 and G4) and can be used for all non Amazon Web Services Graviton-based instance types.

            • imageIdOverride (string) –

              The AMI ID used for instances launched in the compute environment that match the image type. This setting overrides the imageId set in the computeResource object.

              Note

              The AMI that you choose for a compute environment must match the architecture of the instance types that you intend to use for that compute environment. For example, if your compute environment uses A1 instance types, the compute resource AMI that you choose must support ARM instances. Amazon ECS vends both x86 and ARM versions of the Amazon ECS-optimized Amazon Linux 2 AMI. For more information, see Amazon ECS-optimized Amazon Linux 2 AMI in the Amazon Elastic Container Service Developer Guide.

            • imageKubernetesVersion (string) –

              The Kubernetes version for the compute environment. If you don’t specify a value, the latest version that Batch supports is used.

      • serviceRole (string) –

        The service role that’s associated with the compute environment that allows Batch to make calls to Amazon Web Services API operations on your behalf. For more information, see Batch service IAM role in the Batch User Guide.

      • updatePolicy (dict) –

        Specifies the infrastructure update policy for the compute environment. For more information about infrastructure updates, see Updating compute environments in the Batch User Guide.

        • terminateJobsOnUpdate (boolean) –

          Specifies whether jobs are automatically terminated when the computer environment infrastructure is updated. The default value is false.

        • jobExecutionTimeoutMinutes (integer) –

          Specifies the job timeout (in minutes) when the compute environment infrastructure is updated. The default value is 30.

      • eksConfiguration (dict) –

        The configuration for the Amazon EKS cluster that supports the Batch compute environment. Only specify this parameter if the containerOrchestrationType is EKS.

        • eksClusterArn (string) –

          The Amazon Resource Name (ARN) of the Amazon EKS cluster. An example is ``arn:aws:eks:us-east-1:123456789012:cluster/ClusterForBatch ``.

        • kubernetesNamespace (string) –

          The namespace of the Amazon EKS cluster. Batch manages pods in this namespace. The value can’t left empty or null. It must be fewer than 64 characters long, can’t be set to default, can’t start with “ kube-,” and must match this regular expression: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$. For more information, see Namespaces in the Kubernetes documentation.

      • containerOrchestrationType (string) –

        The orchestration type of the compute environment. The valid values are ECS (default) or EKS.

      • uuid (string) –

        Unique identifier for the compute environment.

  • nextToken (string) –

    The nextToken value to include in a future DescribeComputeEnvironments request. When the results of a DescribeComputeEnvironments request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

Exceptions

• Batch.Client.exceptions.ClientException

• Batch.Client.exceptions.ServerException

Examples

This example describes the P2OnDemand compute environment.

response = client.describe_compute_environments(
    computeEnvironments=[
        'P2OnDemand',
    ],
)

print(response)

Expected Output:

{
    'computeEnvironments': [
        {
            'type': 'MANAGED',
            'computeEnvironmentArn': 'arn:aws:batch:us-east-1:012345678910:compute-environment/P2OnDemand',
            'computeEnvironmentName': 'P2OnDemand',
            'computeResources': {
                'type': 'EC2',
                'desiredvCpus': 48,
                'ec2KeyPair': 'id_rsa',
                'instanceRole': 'ecsInstanceRole',
                'instanceTypes': [
                    'p2',
                ],
                'maxvCpus': 128,
                'minvCpus': 0,
                'securityGroupIds': [
                    'sg-cf5093b2',
                ],
                'subnets': [
                    'subnet-220c0e0a',
                    'subnet-1a95556d',
                    'subnet-978f6dce',
                ],
                'tags': {
                    'Name': 'Batch Instance - P2OnDemand',
                },
            },
            'ecsClusterArn': 'arn:aws:ecs:us-east-1:012345678910:cluster/P2OnDemand_Batch_2c06f29d-d1fe-3a49-879d-42394c86effc',
            'serviceRole': 'arn:aws:iam::012345678910:role/AWSBatchServiceRole',
            'state': 'ENABLED',
            'status': 'VALID',
            'statusReason': 'ComputeEnvironment Healthy',
        },
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}