SageMaker / Client / describe_job

describe_job

SageMaker.Client.describe_job(**kwargs)

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

Request Syntax

response = client.describe_job(
    JobName='string',
    JobCategory='AgentRFT'|'AgentRFTEvaluation'
)
Parameters:

  • JobName (string) –

    [REQUIRED]

    The name of the job to describe.

  • JobCategory (string) –

    [REQUIRED]

    The category of the job.

Return type:

dict

Returns:

Response Syntax

{
    'JobName': 'string',
    'JobArn': 'string',
    'RoleArn': 'string',
    'JobCategory': 'AgentRFT'|'AgentRFTEvaluation',
    'JobConfigSchemaVersion': 'string',
    'JobConfigDocument': 'string',
    'CreationTime': datetime(2015, 1, 1),
    'LastModifiedTime': datetime(2015, 1, 1),
    'EndTime': datetime(2015, 1, 1),
    'JobStatus': 'InProgress'|'Completed'|'Failed'|'Stopping'|'Stopped'|'Deleting'|'DeleteFailed',
    'SecondaryStatus': 'Starting'|'Downloading'|'Training'|'Uploading'|'Stopping'|'Stopped'|'MaxRuntimeExceeded'|'Interrupted'|'Failed'|'Completed'|'Restarting'|'Pending'|'Evaluating'|'Deleting'|'DeleteFailed',
    'SecondaryStatusTransitions': [
        {
            'Status': 'Starting'|'Downloading'|'Training'|'Uploading'|'Stopping'|'Stopped'|'MaxRuntimeExceeded'|'Interrupted'|'Failed'|'Completed'|'Restarting'|'Pending'|'Evaluating'|'Deleting'|'DeleteFailed',
            'StartTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1),
            'StatusMessage': 'string'
        },
    ],
    'FailureReason': 'string',
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • JobName (string) –

      The name of the job.

    • JobArn (string) –

      The Amazon Resource Name (ARN) of the job.

    • RoleArn (string) –

      The ARN of the IAM role associated with the job.

    • JobCategory (string) –

      The category of the job.

    • JobConfigSchemaVersion (string) –

      The schema version used for the job configuration document.

    • JobConfigDocument (string) –

      The JSON configuration document for the job.

    • CreationTime (datetime) –

      The date and time that the job was created.

    • LastModifiedTime (datetime) –

      The date and time that the job was last modified.

    • EndTime (datetime) –

      The date and time that the job ended.

    • JobStatus (string) –

      The current status of the job.

    • SecondaryStatus (string) –

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

    • SecondaryStatusTransitions (list) –

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

      • (dict) –

        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) –

          The secondary status of the job at this transition point.

        • StartTime (datetime) –

          The date and time that the status transition started.

        • EndTime (datetime) –

          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.

    • Tags (list) –

      The tags associated with the job.

      • (dict) –

        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) –

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

        • Value (string) –

          The tag value.

Exceptions