# update-compute-environment ## Description Updates an Batch compute environment. See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/UpdateComputeEnvironment) ## Synopsis ``` update-compute-environment --compute-environment [--state ] [--unmanagedv-cpus ] [--compute-resources ] [--service-role ] [--update-policy ] [--context ] [--ecs-settings ] [--eks-configuration ] [--cli-input-json | --cli-input-yaml] [--generate-cli-skeleton ] [--debug] [--endpoint-url ] [--no-verify-ssl] [--no-paginate] [--output ] [--query ] [--profile ] [--region ] [--version ] [--color ] [--no-sign-request] [--ca-bundle ] [--cli-read-timeout ] [--cli-connect-timeout ] [--cli-binary-format ] [--no-cli-pager] [--cli-auto-prompt] [--no-cli-auto-prompt] [--cli-error-format ] ``` ## Options `--compute-environment` (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, for example, if they have running instances due to jobs that are still executing or a non-zero `minvCpus` setting. To prevent additional charges, disable and delete the compute environment. > 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. > Possible values: > * `ENABLED` > * `DISABLED` `--unmanagedv-cpus` (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. `--compute-resources` (structure) > Details of the compute resources managed by the compute environment. Required for a managed compute environment. For more information, see [Compute Environments](https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html) 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 any allocation strategy except `BEST_FIT` using On-Demand (`EC2` ) compute resources, Batch might need to exceed `maxvCpus` to meet your capacity requirements. In this event, Batch never exceeds `maxvCpus` by more than a single instance. > 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](https://docs.aws.amazon.com/batch/latest/userguide/troubleshooting.html#error-desired-vcpus-update) 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 Amazon EC2 compute resources, providing an empty list removes the VPC subnets from the compute resource. For more information, see [VPCs and subnets](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html) 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](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) in the *Batch User Guide* . > > #### NOTE > > Batch on Amazon EC2 and Batch on Amazon EKS support Local Zones. For more information, see [Local Zones](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-local-zones) in the *Amazon EC2 User Guide for Linux Instances* , [Amazon EKS and Amazon Web Services Local Zones](https://docs.aws.amazon.com/eks/latest/userguide/local-zones.html) in the *Amazon EKS User Guide* and [Amazon ECS clusters in Local Zones, Wavelength Zones, and Amazon Web Services Outposts](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-regions-zones.html#clusters-local-zones) 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 Amazon EC2 compute resources, providing an empty list removes the security groups from the compute resource. > > When updating a compute environment, changing the Amazon EC2 security groups requires an infrastructure update of the compute environment. For more information, see [Updating compute environments](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) 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](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-resource-limits.html) . For more information, see [Allocation strategies](https://docs.aws.amazon.com/batch/latest/userguide/allocation-strategies.html) 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](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) 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. > > > BEST_FIT_PROGRESSIVE_ORDERED > > #### WARNING > > This is an advanced allocation strategy only for customers who want to control which instance types are preferred during scaling. > > Placing large instance types at the top of the list may result in **over-provisioning** for small jobs. Placing small instance types at the top may cause the compute environment to reach Amazon EC2 instance count limits before reaching `maxvCpus` . > > Batch selects instance types in the order they appear in the `instanceTypes` list. When an instance family is specified, sizes within that family are expanded using `BEST_FIT_PROGRESSIVE` logic—preferring sizes that best fit the jobs, with larger sizes as fallback. Instance types that cannot meet the resource requirements of the jobs are skipped. This strategy is only available for On-Demand Instance (`EC2` ) compute resources. > > If an instance family and an explicit instance type from that family both appear in `instanceTypes` , the explicit type takes its listed position and is excluded from the family expansion. For example, in `["m7a.4xlarge", "m7a", "m6a"]` , `m7a.4xlarge` is always placed first and is excluded from the `m7a` family expansion. > > > 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. > > > SPOT_PRICE_CAPACITY_OPTIMIZED > > The price and capacity optimized allocation strategy looks at both price and capacity to select the Spot Instance pools that are the least likely to be interrupted and have the lowest possible price. This allocation strategy is only available for Spot Instance compute resources. > > > SPOT_CAPACITY_OPTIMIZED_PRIORITIZED > > #### WARNING > > This is an advanced allocation strategy for customers who want to influence instance type selection during scaling. This strategy optimizes for **capacity first** , and honors instance type priorities on a best-effort basis (priorities are honored when they do not significantly reduce available Spot capacity). > > Placing large instance types at the top of the list may result in **over-provisioning** for small jobs. Placing small instance types at the top may cause the compute environment to reach Amazon EC2 instance count limits before reaching `maxvCpus` . > > Batch selects instance types in the order they appear in the `instanceTypes` list, but **optimizes for capacity first** . The customer-defined priority is honored on a best-effort basis. When Spot Instance capacity pools are similarly available, priority order is respected. When capacity is constrained, Batch selects from the most available pools regardless of priority to minimize the likelihood of Spot Instance interruptions. This strategy is only available for Spot Instance compute resources. > > With any allocation strategy except `BEST_FIT` using On-Demand (`EC2` ) compute resources, Batch might need to exceed `maxvCpus` to meet your capacity requirements. In this event, Batch never exceeds `maxvCpus` by more than a single instance. > > Possible values: > > * `BEST_FIT_PROGRESSIVE` > > * `BEST_FIT_PROGRESSIVE_ORDERED` > > * `SPOT_CAPACITY_OPTIMIZED` > > * `SPOT_PRICE_CAPACITY_OPTIMIZED` > > * `SPOT_CAPACITY_OPTIMIZED_PRIORITIZED` > 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` ). > > Batch can select the instance type for you if you choose one of the following: > > * `optimal` to select instance types (from the `c4` , `m4` , `r4` , `c5` , `m5` , and `r5` instance families) that match the demand of your job queues. > > * `default_x86_64` to choose x86 based instance types (from the `m6i` , `c6i` , `r6i` , and `c7i` instance families) that matches the resource demands of the job queue. > > * `default_arm64` to choose x86 based instance types (from the `m6g` , `c6g` , `r6g` , and `c7g` instance families) that matches the resource demands of the job queue. > > #### NOTE > > Starting on 11/01/2025 the behavior of `optimal` is going to be changed to match `default_x86_64` . During the change your instance families could be updated to a newer generation. You do not need to perform any actions for the upgrade to happen. For more information about change, see [Optimal instance type configuration to receive automatic instance family updates](https://docs.aws.amazon.com/batch/latest/userguide/optimal-default-instance-troubleshooting.html) . > > #### NOTE > > Instance family availability varies by Amazon Web Services Region. For example, some Amazon Web Services Regions may not have any fourth generation instance families but have fifth and sixth generation instance families. > > When using `default_x86_64` or `default_arm64` instance bundles, Batch selects instance families based on a balance of cost-effectiveness and performance. While newer generation instances often provide better price-performance, Batch may choose an earlier generation instance family if it provides the optimal combination of availability, cost, and performance for your workload. For example, in an Amazon Web Services Region where both c6i and c7i instances are available, Batch might select c6i instances if they offer better cost-effectiveness for your specific job requirements. For more information on Batch instance types and Amazon Web Services Region availability, see [Instance type compute table](https://docs.aws.amazon.com/batch/latest/userguide/instance-type-compute-table.html) in the *Batch User Guide* . > > Batch periodically updates your instances in default bundles to newer, more cost-effective options. Updates happen automatically without requiring any action from you. Your workloads continue running during updates with no interruption > > #### 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. > > (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 Amazon EC2 key pair requires an infrastructure update of the compute environment. For more information, see [Updating compute environments](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) 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. Required for Amazon EC2 instances. You can specify the short name or full Amazon Resource Name (ARN) of an instance profile. For example, \`\` *ecsInstanceRole* \`\` or \`\`arn:aws:iam:: ** :instance-profile/*ecsInstanceRole* \`\` . For more information, see [Amazon ECS instance role](https://docs.aws.amazon.com/batch/latest/userguide/instance_IAM_role.html) 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](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) in the *Batch User Guide* . > > #### NOTE > > This parameter isn’t applicable to jobs that are running on Fargate resources. Don’t specify it. > tags -> (map) > > Key-value pair tags to be applied to Amazon 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](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) in the *Batch User Guide* . > > #### NOTE > > This parameter isn’t applicable to jobs that are running on Fargate resources. Don’t specify it. > > key -> (string) > > value -> (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](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) 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](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) 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](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) in the *Batch User Guide* . > > #### NOTE > > This parameter isn’t applicable to jobs that are running on Fargate resources. Don’t specify it. > launchTemplate -> (structure) > > 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](https://docs.aws.amazon.com/batch/latest/userguide/launch-templates.html) 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](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) 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, `$Default` , or `$Latest` . > > > If the value is `$Default` , the default version of the launch template is used. If the value is `$Latest` , the latest 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 `$Default` or `$Latest` 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](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) in the *Batch User Guide* . > > > Default: `$Default` > > > Latest: `$Latest` > > overrides -> (list) > > > A launch template to use in place of the default launch template. You must specify either the launch template ID or launch template name in the request, but not both. > > > You can specify up to ten (10) launch template overrides that are associated to unique instance types or families for each compute environment. > > > #### NOTE > > > To unset all override templates for a compute environment, you can pass an empty array to the [UpdateComputeEnvironment.overrides](https://docs.aws.amazon.com/batch/latest/APIReference/API_UpdateComputeEnvironment.html) parameter, or not include the `overrides` parameter when submitting the `UpdateComputeEnvironment` API operation. > > > (structure) > > > > An object that represents a launch template to use in place of the default launch template. You must specify either the launch template ID or launch template name in the request, but not both. > > > > If security groups are specified using both the `securityGroupIds` parameter of `CreateComputeEnvironment` and the launch template, the values in the `securityGroupIds` parameter of `CreateComputeEnvironment` will be used. > > > > You can define up to ten (10) overrides for each compute environment. > > > > #### NOTE > > > > This object isn’t applicable to jobs that are running on Fargate resources. > > > > #### NOTE > > > > To unset all override templates for a compute environment, you can pass an empty array to the [UpdateComputeEnvironment.overrides](https://docs.aws.amazon.com/batch/latest/APIReference/API_UpdateComputeEnvironment.html) parameter, or not include the `overrides` parameter when submitting the `UpdateComputeEnvironment` API operation. > > > > launchTemplateId -> (string) > > > > > The ID of the launch template. > > > > > > **Note:** If you specify the `launchTemplateId` you can’t specify the `launchTemplateName` as well. > > > > launchTemplateName -> (string) > > > > > The name of the launch template. > > > > > > **Note:** If you specify the `launchTemplateName` you can’t specify the `launchTemplateId` as well. > > > > version -> (string) > > > > > The version number of the launch template, `$Default` , or `$Latest` . > > > > > If the value is `$Default` , the default version of the launch template is used. If the value is `$Latest` , the latest 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 `$Default` or `$Latest` 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](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) in the *Batch User Guide* . > > > > > Default: `$Default` > > > > > Latest: `$Latest` > > > > targetInstanceTypes -> (list) > > > > > The instance type or family that this override launch template should be applied to. > > > > > This parameter is required when defining a launch template override. > > > > > Information included in this parameter must meet the following requirements: > > > > > * Must be a valid Amazon EC2 instance type or family. > > > > > * The following Batch `InstanceTypes` are not allowed: `optimal` , `default_x86_64` , and `default_arm64` . > > > > > * `targetInstanceTypes` can target only instance types and families that are included within the \` `ComputeResource.instanceTypes` [https://docs.aws.amazon.com/batch/latest/APIReference/API_ComputeResource.html#Batch-Type-ComputeResource](https://docs.aws.amazon.com/batch/latest/APIReference/API_ComputeResource.html#Batch-Type-ComputeResource)-instanceTypes\`_\_ set. `targetInstanceTypes` doesn’t need to include all of the instances from the `instanceType` set, but at least a subset. For example, if `ComputeResource.instanceTypes` includes `[m5, g5]` , `targetInstanceTypes` can include `[m5.2xlarge]` and `[m5.large]` but not `[c5.large]` . > > > > > * `targetInstanceTypes` included within the same launch template override or across launch template overrides can’t overlap for the same compute environment. For example, you can’t define one launch template override to target an instance family and another define an instance type within this same family. > > > > > (string) > > > > userdataType -> (string) > > > > > The EKS node initialization process to use. You only need to specify this value if you are using a custom AMI. The default value is `EKS_BOOTSTRAP_SH` . If *imageType* is a custom AMI based on EKS_AL2023 or EKS_AL2023_NVIDIA then you must choose `EKS_NODEADM` . > > > > > Possible values: > > > > > * `EKS_BOOTSTRAP_SH` > > > > > * `EKS_NODEADM` > > userdataType -> (string) > > > The EKS node initialization process to use. You only need to specify this value if you are using a custom AMI. The default value is `EKS_BOOTSTRAP_SH` . If *imageType* is a custom AMI based on EKS_AL2023 or EKS_AL2023_NVIDIA then you must choose `EKS_NODEADM` . > > > Possible values: > > > * `EKS_BOOTSTRAP_SH` > > > * `EKS_NODEADM` > ec2Configuration -> (list) > > Provides information used to select Amazon Machine Images (AMIs) for Amazon EC2 instances in the compute environment. If `Ec2Configuration` isn’t specified, the default is `ECS_AL2023` for EC2 (ECS) compute environments and `EKS_AL2023` for EKS compute environments. > > When updating a compute environment, changing this setting requires an infrastructure update of the compute environment. For more information, see [Updating compute environments](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) in the *Batch User Guide* . To remove the Amazon 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. > > (structure) > > > Provides information used to select Amazon Machine Images (AMIs) for instances in the compute environment. If `Ec2Configuration` isn’t specified, the default is `ECS_AL2023` ([Amazon ECS-optimized Amazon Linux 2023](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) ) for EC2 (ECS) compute environments and `EKS_AL2023` ([Amazon EKS-optimized Amazon Linux 2023 AMI](https://docs.aws.amazon.com/eks/latest/userguide/eks-optimized-ami.html) ) for EKS compute environments. > > > #### 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 2023 AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) (`ECS_AL2023` ) 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. > > > > #### WARNING > > > > > Amazon Web Services is ending support for Amazon ECS Amazon Linux 2-optimized and accelerated AMIs on June 30, 2026. On January 12, 2026, Batch changed the default AMI for new Amazon ECS compute environments from Amazon Linux 2 to Amazon Linux 2023. Effective June 30, 2026, Batch will block creation of new Amazon ECS compute environments using Batch-provided Amazon Linux 2 AMIs. We strongly recommend migrating your existing Batch Amazon ECS compute environments to Amazon Linux 2023 prior to June 30, 2026. For more information on upgrading from AL2 to AL2023, see [How to migrate from ECS AL2 to ECS AL2023](https://docs.aws.amazon.com/batch/latest/userguide/ecs-migration-2023.html) in the *Batch User Guide* . > > > > > ECS_AL2 > > > > [Amazon Linux 2](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) : Used for non-GPU instance families. > > > > > ECS_AL2_NVIDIA > > > > [Amazon Linux 2 (GPU)](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#gpuami) : Used for GPU instance families (for example `P4` and `G4` ) and non Amazon Web Services Graviton-based instance types. > > > > > ECS_AL2023 > > > > [Amazon Linux 2023](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) : Default for all non-GPU instance families. > > > > #### NOTE > > > > > Amazon Linux 2023 does not support `A1` instances. > > > > > ECS_AL2023_NVIDIA > > > > [Amazon Linux 2023 (GPU)](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#gpuami) : Default for all GPU instance families and can be used for all non Amazon Web Services Graviton-based instance types. > > > > #### NOTE > > > > ECS_AL2023_NVIDIA doesn’t support `p3` and `g3` instance types. > > > > > EKS > > > > If the `imageIdOverride` parameter isn’t specified, then a recent [Amazon EKS-optimized Amazon Linux 2023 AMI](https://docs.aws.amazon.com/eks/latest/userguide/eks-optimized-ami.html) (`EKS_AL2023` ) 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. > > > > #### WARNING > > > > > Amazon Linux 2023 AMIs are the default on Batch for Amazon EKS. > > > > > Amazon Web Services ended support for Amazon EKS AL2-optimized and AL2-accelerated AMIs on November 26, 2025. Batch Amazon EKS compute environments using Amazon Linux 2 will no longer receive software updates, security patches, or bug fixes from Amazon Web Services. We recommend migrating to Amazon Linux 2023. For more information on upgrading from AL2 to AL2023, see [How to upgrade from EKS AL2 to EKS AL2023](https://docs.aws.amazon.com/batch/latest/userguide/eks-migration-2023.html) in the *Batch User Guide* . > > > > > EKS_AL2 > > > > [Amazon Linux 2](https://docs.aws.amazon.com/eks/latest/userguide/eks-optimized-ami.html) : Used for non-GPU instance families. > > > > > EKS_AL2_NVIDIA > > > > [Amazon Linux 2 (accelerated)](https://docs.aws.amazon.com/eks/latest/userguide/eks-optimized-ami.html) : Used for GPU instance families (for example, `P4` and `G4` ) and can be used for all non Amazon Web Services Graviton-based instance types. > > > > > EKS_AL2023 > > > > [Amazon Linux 2023](https://docs.aws.amazon.com/eks/latest/userguide/eks-optimized-ami.html) : Default for non-GPU instance families. > > > > #### NOTE > > > > > Amazon Linux 2023 does not support `A1` instances. > > > > > EKS_AL2023_NVIDIA > > > > [Amazon Linux 2023 (accelerated)](https://docs.aws.amazon.com/eks/latest/userguide/eks-optimized-ami.html) : Default for GPU instance families and can be used for all non Amazon Web Services Graviton-based instance types. > > > > Constraints: > > > > * min: `1` > > > > * max: `256` > > > 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 2023 AMI. For more information, see [Amazon ECS-optimized Amazon Linux 2023 AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#ecs-optimized-ami-linux-variants.html) in the *Amazon Elastic Container Service Developer Guide* . > > > > Constraints: > > > > * min: `1` > > > > * max: `256` > > > batchImageStatus -> (string) > > > > The status of the Batch-provided default AMIs associated with the `imageType` . > > > > The field only appears after the compute environment has begun scaling instances using the `imageType` . The field is not present when an image is specified in `ComputeResources.imageId` (deprecated), the default launch template, or `Ec2Configuration.imageIdOverride` . The field is also not present when the compute environment has a launch template override. For more information on image selection, see [AMI selection order](https://docs.aws.amazon.com/batch/latest/userguide/ami-selection-order.html) . > > > > #### NOTE > > > > This field is read-only and only appears in the [DescribeComputeEnvironments](https://docs.aws.amazon.com/batch/latest/APIReference/API_DescribeComputeEnvironments.html) response. > > > > * `LATEST` − Using the most recent AMI supported > > > > * `UPDATE_AVAILABLE` − An updated AMI is available > > > > * If a compute environment has multiple AMIs for the `imageType` and any one AMI has `UPDATE_AVAILABLE` , the status shows `UPDATE_AVAILABLE` . > > > > * For compute environments that use `BEST_FIT` as their allocation strategy, you can perform a [blue/green update](https://docs.aws.amazon.com/batch/latest/userguide/blue-green-updates.html) to update the AMI. > > > > * For all other compute environments, you can perform an [AMI version update](https://docs.aws.amazon.com/batch/latest/userguide/managing-ami-versions.html#updating-ami-versions) to update the AMI to the latest version. > > > imageKubernetesVersion -> (string) > > > > The Kubernetes version for the compute environment. If you don’t specify a value, the latest version that Batch supports is used. > > > > Constraints: > > > > * min: `1` > > > > * max: `256` > 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](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html#updating-compute-environments-ami) 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](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) in the *Batch User Guide* . > type -> (string) > > The type of compute environment: `EC2` , `SPOT` , `FARGATE` , `FARGATE_SPOT` , or `ECS_MANAGED_INSTANCES` . For more information, see [Compute environments](https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html) 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](https://docs.aws.amazon.com/batch/latest/userguide/spot_fleet_IAM_role.html) 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](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) in the *Batch User Guide* . > > You cannot change the type to or from `ECS_MANAGED_INSTANCES` . > > Possible values: > > * `EC2` > > * `SPOT` > > * `FARGATE` > > * `FARGATE_SPOT` > > * `ECS_MANAGED_INSTANCES` > 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](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) 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 2023 AMI. For more information, see [Amazon ECS-optimized Amazon Linux 2023 AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#ecs-optimized-ami-linux-variants.html) in the *Amazon Elastic Container Service Developer Guide* . > scalingPolicy -> (structure) > > The scaling policy configuration for the compute environment. > > #### NOTE > > This parameter isn’t applicable to jobs that are running on Fargate resources. Don’t specify it. > > minScaleDownDelayMinutes -> (integer) > > > The minimum time (in minutes) that Batch keeps instances running in the compute environment after their jobs complete. For each instance, the delay period begins when the last job finishes. If no new jobs are placed on the instance during this delay, Batch terminates the instance once the delay expires. > > > Valid Range: Minimum value of 20. Maximum value of 10080. Use 0 to unset and disable the scale down delay. > > > #### NOTE > > > Idle instances retained during the scale-down delay period are billable at standard EC2 pricing. > > > #### NOTE > > > The scale down delay does not apply to: > > > * Instances being replaced during infrastructure updates > > > * Newly launched instances that have not yet run any jobs > > > * Spot instances reclaimed due to interruption > managedInstancesProvider -> (structure) > > The updated configuration for the Amazon ECS Managed Instances capacity provider. This parameter is only valid when the compute environment type is `ECS_MANAGED_INSTANCES` . You cannot change `capacityOptionType` or `fipsEnabled` on update. > > propagateTags -> (string) > > > Specifies whether tags on the capacity provider are propagated to the Amazon EC2 instances it launches. Valid values: > > > * `CAPACITY_PROVIDER` — Propagates tags to instances. > > > * `NONE` — Does not propagate tags to instances. > > infrastructureRoleArn -> (string) > > > The updated Amazon Resource Name (ARN) of the IAM role that Amazon ECS assumes to manage Amazon EC2 instances on your behalf. > > instanceLaunchTemplate -> (structure) > > > The updated instance launch configuration for the Amazon ECS Managed Instances capacity provider. > > > ec2InstanceProfileArn -> (string) > > > > The updated Amazon Resource Name (ARN) of the Amazon EC2 instance profile for the managed instances. > > > networkConfiguration -> (structure) > > > > The updated network configuration for the managed instances. > > > > subnets -> (list) [required] > > > > > The VPC subnets where managed instances are launched. If your subnets don’t provide public IP addresses, they must have a NAT gateway for outbound internet access. > > > > > (string) > > > > securityGroups -> (list) [required] > > > > > The VPC security groups to associate with the managed instances. > > > > > (string) > > > instanceRequirements -> (structure) > > > > The updated instance type requirements for the capacity provider. > > > > allowedInstanceTypes -> (list) > > > > > A list of specific instance types or instance families that Amazon ECS can launch (for example, `m5.large` or `g5` ). When specified, only these instance types are used. > > > > > (string) > > > storageConfiguration -> (structure) > > > > The updated storage configuration for the managed instances. > > > > storageSizeGiB -> (integer) > > > > > The size of the root EBS volume in GiB for the managed instances. > > > monitoring -> (string) > > > > The updated monitoring level. Valid values are `BASIC` and `DETAILED` . > > > capacityReservations -> (structure) > > > > The updated capacity reservation configuration. > > > > reservationGroupArn -> (string) > > > > > The Amazon Resource Name (ARN) of the capacity reservation group to target. > > > > reservationPreference -> (string) > > > > > The capacity reservation preference. Valid values: > > > > > * `RESERVATIONS_ONLY` — Use only capacity reservations. > > > > > * `RESERVATIONS_FIRST` — Prefer capacity reservations but fall back to On-Demand if unavailable. > > > > > * `RESERVATIONS_EXCLUDED` — Do not use capacity reservations. > > > instanceMetadataTagsPropagation -> (boolean) > > > > Specifies whether instance tags are accessible from the instance metadata service (IMDS). > > > localStorageConfiguration -> (structure) > > > > The updated local storage configuration. > > > > useLocalStorage -> (boolean) > > > > > Specifies whether instance store volumes (local NVMe SSDs) are available to containers. When enabled, containers can use the instance store for high-performance temporary storage. > > infrastructureOptimization -> (structure) > > > The updated infrastructure optimization configuration. > > > scaleInAfter -> (integer) > > > > The number of seconds an instance can remain idle before it is terminated. Valid values are `-1` or `0` to `3600` . Use `-1` as a special value to disable scale-in (instances are never terminated for being idle). If not specified, a default value applies. > capacityTags -> (map) > > The updated tags to apply to the Amazon ECS capacity provider and Amazon EC2 instances. This parameter is only valid for `ECS_MANAGED_INSTANCES` compute environments. You must have the `batch:SetCapacityTags` permission on the compute environment resource to use this parameter. > > Constraints: > > * min: `1` > > * max: `50` > > key -> (string) > > > Constraints: > > > * min: `1` > > > * max: `128` > > value -> (string) > > > Constraints: > > > * max: `256` JSON Syntax: ```json { "minvCpus": integer, "maxvCpus": integer, "desiredvCpus": integer, "subnets": ["string", ...], "securityGroupIds": ["string", ...], "allocationStrategy": "BEST_FIT_PROGRESSIVE"|"BEST_FIT_PROGRESSIVE_ORDERED"|"SPOT_CAPACITY_OPTIMIZED"|"SPOT_PRICE_CAPACITY_OPTIMIZED"|"SPOT_CAPACITY_OPTIMIZED_PRIORITIZED", "instanceTypes": ["string", ...], "ec2KeyPair": "string", "instanceRole": "string", "tags": {"string": "string" ...}, "placementGroup": "string", "bidPercentage": integer, "launchTemplate": { "launchTemplateId": "string", "launchTemplateName": "string", "version": "string", "overrides": [ { "launchTemplateId": "string", "launchTemplateName": "string", "version": "string", "targetInstanceTypes": ["string", ...], "userdataType": "EKS_BOOTSTRAP_SH"|"EKS_NODEADM" } ... ], "userdataType": "EKS_BOOTSTRAP_SH"|"EKS_NODEADM" }, "ec2Configuration": [ { "imageType": "string", "imageIdOverride": "string", "batchImageStatus": "string", "imageKubernetesVersion": "string" } ... ], "updateToLatestImageVersion": true|false, "type": "EC2"|"SPOT"|"FARGATE"|"FARGATE_SPOT"|"ECS_MANAGED_INSTANCES", "imageId": "string", "scalingPolicy": { "minScaleDownDelayMinutes": integer }, "managedInstancesProvider": { "propagateTags": "string", "infrastructureRoleArn": "string", "instanceLaunchTemplate": { "ec2InstanceProfileArn": "string", "networkConfiguration": { "subnets": ["string", ...], "securityGroups": ["string", ...] }, "instanceRequirements": { "allowedInstanceTypes": ["string", ...] }, "storageConfiguration": { "storageSizeGiB": integer }, "monitoring": "string", "capacityReservations": { "reservationGroupArn": "string", "reservationPreference": "string" }, "instanceMetadataTagsPropagation": true|false, "localStorageConfiguration": { "useLocalStorage": true|false } }, "infrastructureOptimization": { "scaleInAfter": integer } }, "capacityTags": {"string": "string" ...} } ``` `--service-role` (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](https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html) 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](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) 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. `--update-policy` (structure) > Specifies the updated infrastructure update policy for the compute environment. For more information about infrastructure updates, see [Updating compute environments](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) in the *Batch User Guide* . > terminateJobsOnUpdate -> (boolean) > > Specifies whether jobs are automatically terminated when the compute environment infrastructure is updated. The default value is `false` . > jobExecutionTimeoutMinutes -> (long) > > Specifies the job timeout (in minutes) when the compute environment infrastructure is updated. The default value is 30. The maximum value is 7200. > > #### NOTE > > Increasing `jobExecutionTimeoutMinutes` during infrastructure updates delays the replacement of instances with new instances that include updates such as security patches, but provides more time for jobs to execute. Consider the security implications of this tradeoff when setting timeout values. > > Constraints: > > * min: `1` > > * max: `7200` Shorthand Syntax: ``` terminateJobsOnUpdate=boolean,jobExecutionTimeoutMinutes=long ``` JSON Syntax: ```json { "terminateJobsOnUpdate": true|false, "jobExecutionTimeoutMinutes": long } ``` `--context` (string) > Reserved. `--ecs-settings` (structure) > The Amazon ECS settings for the compute environment. These settings control CloudWatch Container Insights collection for the compute environment. > containerInsights -> (string) > > Specifies the CloudWatch Container Insights mode for the compute environment. Valid values are: > > > ENABLED > > Turns on standard Container Insights, which collects CPU, memory, disk, and network utilization metrics for the compute environment. > > > ENHANCED > > Turns on enhanced Container Insights, which collects the standard metrics along with additional per-task observability metrics. > > > DISABLED > > Turns off Container Insights for the compute environment. > > If you don’t specify a value, the default is `DISABLED` . For more information, see [Container Insights](https://docs.aws.amazon.com/batch/latest/userguide/cloudwatch-container-insights.html) in the *Batch User Guide* . > > Possible values: > > * `ENABLED` > > * `ENHANCED` > > * `DISABLED` Shorthand Syntax: ``` containerInsights=string ``` JSON Syntax: ```json { "containerInsights": "ENABLED"|"ENHANCED"|"DISABLED" } ``` `--eks-configuration` (structure) > Updates the Amazon EKS configuration for the compute environment. Only specify this parameter if the compute environment’s `containerOrchestrationType` is `EKS` . Currently, the `accessEntry` setting is the only Amazon EKS configuration that you can change after the compute environment is created. For more information, see [Amazon EKS access entry authentication](https://docs.aws.amazon.com/batch/latest/userguide/eks-access-entries.html) in the *Batch User Guide* . > accessEntry -> (structure) > > The updated access entry configuration for the compute environment. Set `desiredState` to declare whether Batch will manage an access entry on the cluster. For the accepted values, see \` `EksAccessEntry` [https://docs.aws.amazon.com/batch/latest/APIReference/API_EksAccessEntry](https://docs.aws.amazon.com/batch/latest/APIReference/API_EksAccessEntry).html\`_\_ . > > desiredState -> (string) [required] > > > The desired access entry state for the compute environment. Valid values: > > > > ENABLED > > > Batch manages an access entry on the cluster for the compute environment. > > > > DISABLED > > > Batch deletes the Batch-managed access entry for the cluster. This value is rejected if the cluster’s `authenticationMode` is `API` , because such a cluster doesn’t support the `aws-auth` ConfigMap. > > > > INHERIT_FROM_CLUSTER > > > Batch defers to the cluster’s current access entry `status` . On a cluster whose authentication mode is `API` , Batch creates and manages an access entry. On a cluster whose authentication mode is `API_AND_CONFIG_MAP` or `CONFIG_MAP` , Batch neither adds nor removes an access entry. > > > Possible values: > > > * `ENABLED` > > > * `DISABLED` > > > * `INHERIT_FROM_CLUSTER` > > status -> (string) > > > The observed state of the access entry on the cluster. `ACTIVE` means that an access entry for the compute environment exists on the cluster and takes precedence over the `aws-auth` ConfigMap. `INACTIVE` means that no Batch-managed access entry is present. This is a read-only field returned by `DescribeComputeEnvironments` . > > > Possible values: > > > * `ACTIVE` > > > * `INACTIVE` Shorthand Syntax: ``` accessEntry={desiredState=string,status=string} ``` JSON Syntax: ```json { "accessEntry": { "desiredState": "ENABLED"|"DISABLED"|"INHERIT_FROM_CLUSTER", "status": "ACTIVE"|"INACTIVE" } } ``` `--cli-input-json` | `--cli-input-yaml` (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by `--generate-cli-skeleton`. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with `--cli-input-yaml`. `--generate-cli-skeleton` (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value `input`, prints a sample input JSON that can be used as an argument for `--cli-input-json`. Similarly, if provided `yaml-input` it will print a sample input YAML that can be used with `--cli-input-yaml`. If provided with the value `output`, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated. ## Global Options `--debug` (boolean) Turn on debug logging. `--endpoint-url` (string) Override command’s default URL with the given URL. `--no-verify-ssl` (boolean) By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates. `--no-paginate` (boolean) Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results. `--output` (string) The formatting style for command output. * json * text * table * yaml * yaml-stream * off `--query` (string) A JMESPath query to use in filtering the response data. `--profile` (string) Use a specific profile from your credential file. `--region` (string) The region to use. Overrides config/env settings. `--version` (string) Display the version of this tool. `--color` (string) Turn on/off color output. * on * off * auto `--no-sign-request` (boolean) Do not sign requests. Credentials will not be loaded if this argument is provided. `--ca-bundle` (string) The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings. `--cli-read-timeout` (int) The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds. `--cli-connect-timeout` (int) The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds. `--cli-binary-format` (string) The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob `fileb://` will always be treated as binary and use the file contents directly regardless of the `cli-binary-format` setting. When using `file://` the file contents will need to properly formatted for the configured `cli-binary-format`. * base64 * raw-in-base64-out `--no-cli-pager` (boolean) Disable cli pager for output. `--cli-auto-prompt` (boolean) Automatically prompt for CLI input parameters. `--no-cli-auto-prompt` (boolean) Disable automatically prompt for CLI input parameters. `--cli-error-format` (string) The formatting style for error output. By default, errors are displayed in enhanced format. * legacy * json * yaml * text * table * enhanced ## Examples #### NOTE To use the following examples, you must have the AWS CLI installed and configured. See the [Getting started guide](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html) in the *AWS CLI User Guide* for more information. Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See [Using quotation marks with strings](https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-quoting-strings.html) in the *AWS CLI User Guide* . **To update a compute environment** The following `update-compute-environment` example disables the P2OnDemand compute environment so it can be deleted. ```bash aws batch update-compute-environment \ --compute-environment P2OnDemand \ --state DISABLED ``` Output: ```json { "computeEnvironmentName": "P2OnDemand", "computeEnvironmentArn": "arn:aws:batch:us-west-2:123456789012:compute-environment/P2OnDemand" } ``` For more information, see [Update a compute environment in AWS Batch](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) in the *AWS Batch User Guide*. ## Output 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.