Skip to content

ServiceEnvironmentDetail

Source code in docs_src/capo_batch/types/service_environment_detail.py
class ServiceEnvironmentDetail(TypedDict, closed=True):
    service_environment_name: NotRequired["capo_batch.types.string.String"]
    """<p>The name of the service environment.</p>"""
    service_environment_arn: NotRequired["capo_batch.types.string.String"]
    """<p>The Amazon Resource Name (ARN) of the service environment.</p>"""
    service_environment_type: NotRequired[
        "capo_batch.types.service_environment_type.ServiceEnvironmentType"
    ]
    """<p>The type of service environment. For SageMaker Training jobs, this value is <code>SAGEMAKER_TRAINING</code>.</p>"""
    state: NotRequired[
        "capo_batch.types.service_environment_state.ServiceEnvironmentState"
    ]
    """<p>The state of the service environment. Valid values are <code>ENABLED</code> and <code>DISABLED</code>.</p>"""
    status: NotRequired[
        "capo_batch.types.service_environment_status.ServiceEnvironmentStatus"
    ]
    """<p>The current status of the service environment.</p>"""
    capacity_limits: NotRequired["capo_batch.types.capacity_limits.CapacityLimits"]
    """<p>The capacity limits for the service environment. This defines the maximum resources that can be used by service jobs in this environment.</p>"""
    tags: NotRequired["capo_batch.types.tagris_tags_map.TagrisTagsMap"]
    """<p>The tags associated with the service environment. Each tag consists of a key and an optional value. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html">Tagging your Batch resources</a>.</p>"""

capacity_limits instance-attribute

capacity_limits: NotRequired[CapacityLimits]

The capacity limits for the service environment. This defines the maximum resources that can be used by service jobs in this environment.

service_environment_arn instance-attribute

service_environment_arn: NotRequired[String]

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

service_environment_name instance-attribute

service_environment_name: NotRequired[String]

The name of the service environment.

service_environment_type instance-attribute

service_environment_type: NotRequired[ServiceEnvironmentType]

The type of service environment. For SageMaker Training jobs, this value is SAGEMAKER_TRAINING.

state instance-attribute

state: NotRequired[ServiceEnvironmentState]

The state of the service environment. Valid values are ENABLED and DISABLED.

status instance-attribute

status: NotRequired[ServiceEnvironmentStatus]

The current status of the service environment.

tags instance-attribute

tags: NotRequired[TagrisTagsMap]

The tags associated with the service environment. Each tag consists of a key and an optional value. For more information, see Tagging your Batch resources.