ComputeEnvironmentDetail - Amazon Batch
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

ComputeEnvironmentDetail

An object representing an Amazon 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. It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

Type: String

Required: Yes

computeResources

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

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: No

serviceRole

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

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 Amazon 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 Amazon 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. However, they scale in to minvCpus value after 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

tags

The tags applied to the compute environment.

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Maximum length of 256.

Required: No

type

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

Type: String

Valid Values: MANAGED | UNMANAGED

Required: No

unmanagedvCpus

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

Type: Integer

Required: No

updatePolicy

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

Type: UpdatePolicy object

Required: No

See Also

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