Skip to content

ComputeEnvironmentDetail

Source code in docs_src/capo_batch/types/compute_environment_detail.py
class ComputeEnvironmentDetail(TypedDict, closed=True):
    compute_environment_name: NotRequired["capo_batch.types.string.String"]
    """<p>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 (_).</p>"""
    compute_environment_arn: NotRequired["capo_batch.types.string.String"]
    """<p>The Amazon Resource Name (ARN) of the compute environment.</p>"""
    unmanagedv_cpus: NotRequired["capo_batch.types.integer.Integer"]
    """<p>The maximum number of VCPUs expected to be used for an unmanaged compute environment.</p>"""
    ecs_cluster_arn: NotRequired["capo_batch.types.string.String"]
    """<p>The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster that the compute environment uses.</p>"""
    tags: NotRequired["capo_batch.types.tagris_tags_map.TagrisTagsMap"]
    """<p>The tags applied to the compute environment.</p>"""
    type: NotRequired["capo_batch.types.ce_type.CEType"]
    """<p>The type of the compute environment: <code>MANAGED</code> or <code>UNMANAGED</code>. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html">Compute environments</a> in the <i>Batch User Guide</i>.</p>"""
    state: NotRequired["capo_batch.types.ce_state.CEState"]
    """<p>The state of the compute environment. The valid values are <code>ENABLED</code> or <code>DISABLED</code>.</p> <p>If the state is <code>ENABLED</code>, 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.</p> <p>If the state is <code>DISABLED</code>, then the Batch scheduler doesn't attempt to place jobs within the environment. Jobs in a <code>STARTING</code> or <code>RUNNING</code> state continue to progress normally. Managed compute environments in the <code>DISABLED</code> state don't scale out. </p> <note> <p>Compute environments in a <code>DISABLED</code> 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 <code>minvCpus</code> setting. To prevent additional charges, disable and delete the compute environment.</p> </note> <p>When an instance is idle, the instance scales down to the <code>minvCpus</code> value. However, the instance size doesn't change. For example, consider a <code>c5.8xlarge</code> instance with a <code>minvCpus</code> value of <code>4</code> and a <code>desiredvCpus</code> value of <code>36</code>. This instance doesn't scale down to a <code>c5.large</code> instance.</p>"""
    status: NotRequired["capo_batch.types.ce_status.CEStatus"]
    """<p>The current status of the compute environment (for example, <code>CREATING</code> or <code>VALID</code>).</p>"""
    status_reason: NotRequired["capo_batch.types.string.String"]
    """<p>A short, human-readable string to provide additional details for the current status of the compute environment.</p>"""
    compute_resources: NotRequired["capo_batch.types.compute_resource.ComputeResource"]
    """<p>The compute resources defined for the compute environment. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html">Compute environments</a> in the <i>Batch User Guide</i>.</p>"""
    service_role: NotRequired["capo_batch.types.string.String"]
    """<p>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 <a href="https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html">Batch service IAM role</a> in the <i>Batch User Guide</i>.</p>"""
    update_policy: NotRequired["capo_batch.types.update_policy.UpdatePolicy"]
    """<p>Specifies the infrastructure update policy for the compute environment. For more information about infrastructure updates, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html">Updating compute environments</a> in the <i>Batch User Guide</i>.</p>"""
    eks_configuration: NotRequired[
        "capo_batch.types.eks_configuration.EksConfiguration"
    ]
    """<p>The configuration for the Amazon EKS cluster that supports the Batch compute environment. Only specify this parameter if the <code>containerOrchestrationType</code> is <code>EKS</code>.</p>"""
    container_orchestration_type: NotRequired[
        "capo_batch.types.orchestration_type.OrchestrationType"
    ]
    """<p>The orchestration type of the compute environment. The valid values are <code>ECS</code> (default) or <code>EKS</code>.</p>"""
    uuid: NotRequired["capo_batch.types.string.String"]
    """<p>Unique identifier for the compute environment.</p>"""
    context: NotRequired["capo_batch.types.string.String"]
    """<p>Reserved.</p>"""
    ecs_settings: NotRequired["capo_batch.types.ecs_settings.EcsSettings"]
    """<p>The Amazon ECS settings for the compute environment. These settings control CloudWatch Container Insights collection.</p>"""

compute_environment_arn instance-attribute

compute_environment_arn: NotRequired[String]

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

compute_environment_name instance-attribute

compute_environment_name: NotRequired[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 (_).

compute_resources instance-attribute

compute_resources: NotRequired[ComputeResource]

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

container_orchestration_type instance-attribute

container_orchestration_type: NotRequired[OrchestrationType]

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

context instance-attribute

context: NotRequired[String]

Reserved.

ecs_cluster_arn instance-attribute

ecs_cluster_arn: NotRequired[String]

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

ecs_settings instance-attribute

ecs_settings: NotRequired[EcsSettings]

The Amazon ECS settings for the compute environment. These settings control CloudWatch Container Insights collection.

eks_configuration instance-attribute

eks_configuration: NotRequired[EksConfiguration]

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

service_role instance-attribute

service_role: NotRequired[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.

state instance-attribute

state: NotRequired[CEState]

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.

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.

status instance-attribute

status: NotRequired[CEStatus]

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

status_reason instance-attribute

status_reason: NotRequired[String]

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

tags instance-attribute

tags: NotRequired[TagrisTagsMap]

The tags applied to the compute environment.

type instance-attribute

type: NotRequired[CEType]

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

unmanagedv_cpus instance-attribute

unmanagedv_cpus: NotRequired[Integer]

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

update_policy instance-attribute

update_policy: NotRequired[UpdatePolicy]

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

uuid instance-attribute

uuid: NotRequired[String]

Unique identifier for the compute environment.