[ aws . sagemaker ]

describe-job

Description

Returns detailed information about a job, including its current status, secondary status, configuration, and timestamps. Use SecondaryStatus for granular progress tracking and SecondaryStatusTransitions to see the full history of status changes with timestamps.

The following operations are related to DescribeJob :

• CreateJob
• ListJobs
• StopJob
• DeleteJob

See also: AWS API Documentation

Synopsis

  describe-job
--job-name <value>
--job-category <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]
[--cli-error-format <value>]

Options

--job-name (string) [required]

The name of the job to describe.

Constraints:

• min: 1
• max: 63
• pattern: [a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}

--job-category (string) [required]

The category of the job.

Possible values:

• AgentRFT
• AgentRFTEvaluation

--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
• off

--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.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

• legacy
• json
• yaml
• text
• table
• enhanced

Output

JobName -> (string)

The name of the job.

Constraints:

• min: 1
• max: 63
• pattern: [a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}

JobArn -> (string)

The Amazon Resource Name (ARN) of the job.

Constraints:

• min: 0
• max: 256
• pattern: arn:(aws[a-z\-]*):sagemaker:[a-z0-9\-]+:[0-9]{12}:job/[a-zA-Z0-9]+/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}

RoleArn -> (string)

The ARN of the IAM role associated with the job.

Constraints:

• min: 20
• max: 2048
• pattern: arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+

JobCategory -> (string)

The category of the job.

Possible values:

• AgentRFT
• AgentRFTEvaluation

JobConfigSchemaVersion -> (string)

The schema version used for the job configuration document.

Constraints:

• min: 5
• max: 16
• pattern: \d+\.\d+\.\d+

JobConfigDocument -> (string)

The JSON configuration document for the job.

Constraints:

• min: 1
• max: 262144

CreationTime -> (timestamp)

The date and time that the job was created.

LastModifiedTime -> (timestamp)

The date and time that the job was last modified.

EndTime -> (timestamp)

The date and time that the job ended.

JobStatus -> (string)

The current status of the job.

Possible values:

• InProgress
• Completed
• Failed
• Stopping
• Stopped
• Deleting
• DeleteFailed

SecondaryStatus -> (string)

The detailed secondary status of the job, providing more granular information about the job’s progress. Secondary statuses may change between releases.

Possible values:

• Starting
• Downloading
• Training
• Uploading
• Stopping
• Stopped
• MaxRuntimeExceeded
• Interrupted
• Failed
• Completed
• Restarting
• Pending
• Evaluating
• Deleting
• DeleteFailed

SecondaryStatusTransitions -> (list)

A list of secondary status transitions for the job, with timestamps and optional status messages.

Constraints:

• min: 0
• max: 100

(structure)

Represents a secondary status transition for a job. Jobs progress through multiple secondary statuses during execution. Each transition records the status, start time, optional end time, and an optional message with additional details.

Status -> (string) [required]

The secondary status of the job at this transition point.

Possible values:

• Starting
• Downloading
• Training
• Uploading
• Stopping
• Stopped
• MaxRuntimeExceeded
• Interrupted
• Failed
• Completed
• Restarting
• Pending
• Evaluating
• Deleting
• DeleteFailed

StartTime -> (timestamp) [required]

The date and time that the status transition started.

EndTime -> (timestamp)

The date and time that the status transition ended.

StatusMessage -> (string)

A detailed message about the status transition.

FailureReason -> (string)

If the job failed, the reason it failed.

Constraints:

• min: 0
• max: 1024

Tags -> (list)

The tags associated with the job.

Constraints:

• min: 0
• max: 50

(structure)

A tag object that consists of a key and an optional value, used to manage metadata for SageMaker Amazon Web Services resources.

You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see AddTags .

For more information on adding metadata to your Amazon Web Services resources with tagging, see Tagging Amazon Web Services resources . For advice on best practices for managing Amazon Web Services resources with tagging, see Tagging Best Practices: Implement an Effective Amazon Web Services Resource Tagging Strategy .

Key -> (string) [required]

The tag key. Tag keys must be unique per resource.

Constraints:

• min: 1
• max: 128
• pattern: ([\p{L}\p{Z}\p{N}_.:/=+\-@]*)

Value -> (string) [required]

The tag value.

Constraints:

• min: 0
• max: 256
• pattern: ([\p{L}\p{Z}\p{N}_.:/=+\-@]*)