Submit Service Job

batch_submit_service_job

R Documentation

Submits a service job to a specified job queue to run on SageMaker AI¶

Description¶

Submits a service job to a specified job queue to run on SageMaker AI. A service job is a unit of work that you submit to Batch for execution on SageMaker AI.

Usage¶

batch_submit_service_job(jobName, jobQueue, retryStrategy,
  schedulingPriority, serviceRequestPayload, serviceJobType,
  shareIdentifier, quotaShareName, preemptionConfiguration, timeoutConfig,
  tags, clientToken)

Arguments¶

jobName

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

jobQueue

[required] The job queue into which the service job is submitted. You can specify either the name or the ARN of the queue. The job queue must have the type SAGEMAKER_TRAINING.

retryStrategy

The retry strategy to use for failed service jobs that are submitted with this service job request.

schedulingPriority

The scheduling priority of the service job. Valid values are integers between 0 and 9999.

serviceRequestPayload

[required] The request, in JSON, for the service that the SubmitServiceJob operation is queueing.

serviceJobType

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

shareIdentifier

The share identifier for the service job. Don't specify this parameter if the job queue doesn't have a fair-share scheduling policy. If the job queue has a fair-share scheduling policy, then this parameter must be specified.

quotaShareName

The quota share for the service job. Don't specify this parameter if the job queue doesn't have a quota share scheduling policy. If the job queue has a quota share scheduling policy, then this parameter must be specified.

preemptionConfiguration

Specifies the service job behavior when preempted.

timeoutConfig

The timeout configuration for the service job. If none is specified, Batch defers to the default timeout of the underlying service handling the job.

tags

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

clientToken

A unique identifier for the request. This token is used to ensure idempotency of requests. If this parameter is specified and two submit requests with identical payloads and clientTokens are received, these requests are considered the same request and the second request is rejected.

Value¶

A list with the following syntax:

list(
  jobArn = "string",
  jobName = "string",
  jobId = "string"
)

Request syntax¶

svc$submit_service_job(
  jobName = "string",
  jobQueue = "string",
  retryStrategy = list(
    attempts = 123,
    evaluateOnExit = list(
      list(
        action = "RETRY"|"EXIT",
        onStatusReason = "string"
      )
    )
  ),
  schedulingPriority = 123,
  serviceRequestPayload = "string",
  serviceJobType = "SAGEMAKER_TRAINING",
  shareIdentifier = "string",
  quotaShareName = "string",
  preemptionConfiguration = list(
    preemptionRetriesBeforeTermination = 123
  ),
  timeoutConfig = list(
    attemptDurationSeconds = 123
  ),
  tags = list(
    "string"
  ),
  clientToken = "string"
)