Skip to content

Creates a service environment for running service jobs

Description

Creates a service environment for running service jobs. Service environments define capacity limits for specific service types such as SageMaker Training jobs.

Usage

batch_create_service_environment(serviceEnvironmentName,
  serviceEnvironmentType, state, capacityLimits, tags)

Arguments

  • serviceEnvironmentName

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

  • serviceEnvironmentType

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

  • state

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

  • capacityLimits

[required] 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.

  • tags

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.

Value

A list with the following syntax:

list(
  serviceEnvironmentName = "string",
  serviceEnvironmentArn = "string"
)

Request syntax

svc$create_service_environment(
  serviceEnvironmentName = "string",
  serviceEnvironmentType = "SAGEMAKER_TRAINING",
  state = "ENABLED"|"DISABLED",
  capacityLimits = list(
    list(
      maxCapacity = 123,
      capacityUnit = "string"
    )
  ),
  tags = list(
    "string"
  )
)