Batch / Client / update_compute_environment

update_compute_environment#

Batch.Client.update_compute_environment(**kwargs)#

Updates an Batch compute environment.

See also: AWS API Documentation

Request Syntax

response = client.update_compute_environment(
    computeEnvironment='string',
    state='ENABLED'|'DISABLED',
    unmanagedvCpus=123,
    computeResources={
        'minvCpus': 123,
        'maxvCpus': 123,
        'desiredvCpus': 123,
        'subnets': [
            'string',
        ],
        'securityGroupIds': [
            'string',
        ],
        'allocationStrategy': 'BEST_FIT_PROGRESSIVE'|'SPOT_CAPACITY_OPTIMIZED',
        'instanceTypes': [
            'string',
        ],
        'ec2KeyPair': 'string',
        'instanceRole': 'string',
        'tags': {
            'string': 'string'
        },
        'placementGroup': 'string',
        'bidPercentage': 123,
        'launchTemplate': {
            'launchTemplateId': 'string',
            'launchTemplateName': 'string',
            'version': 'string'
        },
        'ec2Configuration': [
            {
                'imageType': 'string',
                'imageIdOverride': 'string',
                'imageKubernetesVersion': 'string'
            },
        ],
        'updateToLatestImageVersion': True|False,
        'type': 'EC2'|'SPOT'|'FARGATE'|'FARGATE_SPOT',
        'imageId': 'string'
    },
    serviceRole='string',
    updatePolicy={
        'terminateJobsOnUpdate': True|False,
        'jobExecutionTimeoutMinutes': 123
    }
)
Parameters:

  • computeEnvironment (string) –

    [REQUIRED]

    The name or full Amazon Resource Name (ARN) of the compute environment to update.

  • state (string) –

    The state of the compute environment. Compute environments in the ENABLED state can accept jobs from a queue and scale in or out automatically based on the workload demand of its associated queues.

    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.

  • unmanagedvCpus (integer) – The maximum number of vCPUs expected to be used for an unmanaged compute environment. Don’t specify this parameter for a managed compute environment. This parameter is only used for fair share scheduling to reserve vCPU capacity for new share identifiers. If this parameter isn’t provided for a fair share job queue, no vCPU capacity is reserved.

  • computeResources (dict) –

    Details of the compute resources managed by the compute environment. Required for a managed compute environment. For more information, see Compute Environments in the Batch User Guide.

    • minvCpus (integer) –

      The minimum number of 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 an 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. That is, no more than a single instance from among those specified in your compute environment.

    • desiredvCpus (integer) –

      The desired number of 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.

      Note

      Batch doesn’t support changing the desired number of vCPUs of an existing compute environment. Don’t specify this parameter for compute environments using Amazon EKS clusters.

      Note

      When you update the desiredvCpus setting, the value must be between the minvCpus and maxvCpus values.

      Additionally, the updated desiredvCpus value must be greater than or equal to the current desiredvCpus value. For more information, see Troubleshooting Batch in the Batch User Guide.

    • subnets (list) –

      The VPC subnets where the compute resources are launched. Fargate compute resources can contain up to 16 subnets. For Fargate compute resources, providing an empty list will be handled as if this parameter wasn’t specified and no change is made. For EC2 compute resources, providing an empty list removes the VPC subnets from the compute resource. For more information, see VPCs and subnets in the Amazon VPC User Guide.

      When updating a compute environment, changing the VPC subnets requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch 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. This parameter is required for Fargate compute resources, where it can contain up to 5 security groups. For Fargate compute resources, providing an empty list is handled as if this parameter wasn’t specified and no change is made. For EC2 compute resources, providing an empty list removes the security groups from the compute resource.

      When updating a compute environment, changing the EC2 security groups requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.

      • (string) –

    • allocationStrategy (string) –

      The allocation strategy to use for the compute resource if there’s not enough instances of the best fitting instance type that 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.

      When updating a compute environment, changing the allocation strategy requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide. BEST_FIT isn’t supported when updating a compute environment.

      Note

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

      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.

    • 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.

      When updating a compute environment, changing this setting requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.

      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) –

    • 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. To remove the Amazon EC2 key pair, set this value to an empty string.

      When updating a compute environment, changing the EC2 key pair requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.

      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.

      When updating a compute environment, changing this setting requires an infrastructure update of the compute environment. For more information, see Updating compute environments 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. These tags aren’t seen when using the Batch ListTagsForResource API operation.

      When updating a compute environment, changing this setting requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.

      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.

      When updating a compute environment, changing the placement group requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.

      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%, 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. For most use cases, we recommend leaving this field empty.

      When updating a compute environment, changing the bid percentage requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.

      Note

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

    • launchTemplate (dict) –

      The updated launch template to use for your compute resources. 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. To remove the custom launch template and use the default launch template, set launchTemplateId or launchTemplateName member of the launch template specification to an empty string. Removing the launch template from a compute environment will not remove the AMI specified in the launch template. In order to update the AMI specified in a launch template, the updateToLatestImageVersion parameter must be set to true.

      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.

      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 used to select Amazon Machine Images (AMIs) for EC2 instances in the compute environment. If Ec2Configuration isn’t specified, the default is ECS_AL2.

      When updating a compute environment, changing this setting requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide. To remove the EC2 configuration and any custom AMI ID specified in imageIdOverride, set this value to an empty string.

      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) – [REQUIRED]

          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.

    • updateToLatestImageVersion (boolean) –

      Specifies whether the AMI ID is updated to the latest one that’s supported by Batch when the compute environment has an infrastructure update. The default value is false.

      Note

      An AMI ID can either be specified in the imageId or imageIdOverride parameters or be determined by the launch template that’s specified in the launchTemplate parameter. If an AMI ID is specified any of these ways, this parameter is ignored. For more information about to update AMI IDs during an infrastructure update, see Updating the AMI ID in the Batch User Guide.

      When updating a compute environment, changing this setting requires an infrastructure update of the compute environment. For more information, see Updating 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.

      When updating a compute environment, changing the type of a compute environment requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.

    • 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. To remove the custom AMI ID and use the default AMI ID, set this value to an empty string.

      When updating a compute environment, changing the AMI ID requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.

      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.

  • serviceRole (string) –

    The full Amazon Resource Name (ARN) of the IAM role that allows Batch to make calls to other Amazon Web Services services on your behalf. For more information, see Batch service IAM role in the Batch User Guide.

    Warning

    If the compute environment has a service-linked role, it can’t be changed to use a regular IAM role. Likewise, if the compute environment has a regular IAM role, it can’t be changed to use a service-linked role. To update the parameters for the compute environment that require an infrastructure update to change, the AWSServiceRoleForBatch service-linked role must be used. For more information, see Updating compute environments in the Batch User Guide.

    If your specified role has a path other than /, then you must either specify the full role ARN (recommended) or prefix the role name with the path.

    Note

    Depending on how you created your Batch service role, its ARN might contain the service-role path prefix. When you only specify the name of the service role, Batch assumes that your ARN doesn’t use the service-role path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.

  • updatePolicy (dict) –

    Specifies the updated 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.

Return type:

dict

Returns:

Response Syntax

{
    'computeEnvironmentName': 'string',
    'computeEnvironmentArn': 'string'
}

Response Structure

  • (dict) –

    • 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.

Exceptions

  • Batch.Client.exceptions.ClientException

  • Batch.Client.exceptions.ServerException

Examples

This example disables the P2OnDemand compute environment so it can be deleted.

response = client.update_compute_environment(
    computeEnvironment='P2OnDemand',
    state='DISABLED',
)

print(response)

Expected Output:

{
    'computeEnvironmentArn': 'arn:aws:batch:us-east-1:012345678910:compute-environment/P2OnDemand',
    'computeEnvironmentName': 'P2OnDemand',
    'ResponseMetadata': {
        '...': '...',
    },
}