Skip to content

CreateServiceEnvironmentRequest

Source code in docs_src/capo_batch/types/create_service_environment_request.py
class CreateServiceEnvironmentRequest(TypedDict, closed=True):
    service_environment_name: NotRequired["capo_batch.types.string.String"]
    """<p>The name for the service environment. It can be up to 128 characters long and can contain letters, numbers, hyphens (-), and underscores (_).</p>"""
    service_environment_type: NotRequired[
        "capo_batch.types.service_environment_type.ServiceEnvironmentType"
    ]
    """<p>The type of service environment. For SageMaker Training jobs, specify <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>. The default value is <code>ENABLED</code>.</p>"""
    capacity_limits: NotRequired["capo_batch.types.capacity_limits.CapacityLimits"]
    """<p>The capacity limits for the service environment. The number of instances a job consumes is the total number of instances requested in the submit training job request resource configuration.</p>"""
    tags: NotRequired["capo_batch.types.tagris_tags_map.TagrisTagsMap"]
    """<p>The tags that you apply to the service environment to help you categorize and organize your resources. 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. The number of instances a job consumes is the total number of instances requested in the submit training job request resource configuration.

service_environment_name instance-attribute

service_environment_name: NotRequired[String]

The name for the service environment. It can be up to 128 characters long and can contain letters, numbers, hyphens (-), and underscores (_).

service_environment_type instance-attribute

service_environment_type: NotRequired[ServiceEnvironmentType]

The type of service environment. For SageMaker Training jobs, specify SAGEMAKER_TRAINING.

state instance-attribute

state: NotRequired[ServiceEnvironmentState]

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

tags instance-attribute

tags: NotRequired[TagrisTagsMap]

The tags that you apply to the service environment to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging your Batch resources.