AWS CLI Command Reference

[ aws . batch ]

submit-service-job

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.

See also: AWS API Documentation

Synopsis

  submit-service-job
--job-name <value>
--job-queue <value>
[--retry-strategy <value>]
[--scheduling-priority <value>]
--service-request-payload <value>
--service-job-type <value>
[--share-identifier <value>]
[--timeout-config <value>]
[--tags <value>]
[--client-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--job-name (string)

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 (_).

--job-queue (string)

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 .

--retry-strategy (structure)

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

attempts -> (integer)

The number of times to move a service job to RUNNABLE status. You can specify between 1 and 10 attempts.

evaluateOnExit -> (list)

Array of ServiceJobEvaluateOnExit objects that specify conditions under which the service job should be retried or failed.

(structure)

Specifies conditions for when to exit or retry a service job based on the exit status or status reason.

action -> (string)

The action to take if the service job exits with the specified condition. Valid values are RETRY and EXIT .

onStatusReason -> (string)

Contains a glob pattern to match against the StatusReason returned for a job. The pattern can contain up to 512 characters and can contain all printable characters. It can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.

Shorthand Syntax:

attempts=integer,evaluateOnExit=[{action=string,onStatusReason=string},{action=string,onStatusReason=string}]

JSON Syntax:

{
  "attempts": integer,
  "evaluateOnExit": [
    {
      "action": "RETRY"|"EXIT",
      "onStatusReason": "string"
    }
    ...
  ]
}

--scheduling-priority (integer)

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

--service-request-payload (string)

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

--service-job-type (string)

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

Possible values:

  • SAGEMAKER_TRAINING

--share-identifier (string)

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.

--timeout-config (structure)

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

attemptDurationSeconds -> (integer)

The maximum duration in seconds that a service job attempt can run. After this time is reached, Batch terminates the service job attempt.

Shorthand Syntax:

attemptDurationSeconds=integer

JSON Syntax:

{
  "attemptDurationSeconds": integer
}

--tags (map)

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 .

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--client-token (string)

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 clientToken s are received, these requests are considered the same request and the second request is rejected.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

jobArn -> (string)

The Amazon Resource Name (ARN) for the service job.

jobName -> (string)

The name of the service job.

jobId -> (string)

The unique identifier for the service job.
© Copyright 2025, Amazon Web Services. Created using Sphinx.