AWS Batch
API Reference (API Version 2016-08-10)

ComputeEnvironmentDetail

An object representing an AWS Batch compute environment.

Contents

computeEnvironmentArn

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

Type: String

Required: Yes

computeEnvironmentName

The name of the compute environment.

Type: String

Required: Yes

computeResources

The compute resources defined for the compute environment.

Type: ComputeResource object

Required: No

ecsClusterArn

The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster used by the compute environment.

Type: String

Required: Yes

serviceRole

The service role associated with the compute environment that allows AWS Batch to make calls to AWS API operations on your behalf.

Type: String

Required: No

state

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

If the state is ENABLED, then the AWS 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 job queue demand.

If the state is DISABLED, then the AWS Batch scheduler does not 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 do not scale out; however, they scale in to minvCpus value once instances become idle.

Type: String

Valid Values: ENABLED | DISABLED

Required: No

status

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

Type: String

Valid Values: CREATING | UPDATING | DELETING | DELETED | VALID | INVALID

Required: No

statusReason

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

Type: String

Required: No

type

The type of the compute environment.

Type: String

Valid Values: MANAGED | UNMANAGED

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: