Batch / Client / describe_service_job

describe_service_job¶

Batch.Client.describe_service_job(**kwargs)¶

The details of a service job.

Request Syntax

response = client.describe_service_job(
    jobId='string'
)

Parameters:

jobId (string) –

[REQUIRED]

The job ID for the service job to describe.

Return type:

dict

Returns:

Response Syntax

{
    'attempts': [
        {
            'serviceResourceId': {
                'name': 'TrainingJobArn',
                'value': 'string'
            },
            'startedAt': 123,
            'stoppedAt': 123,
            'statusReason': 'string'
        },
    ],
    'capacityUsage': [
        {
            'capacityUnit': 'string',
            'quantity': 123.0
        },
    ],
    'createdAt': 123,
    'isTerminated': True|False,
    'jobArn': 'string',
    'jobId': 'string',
    'jobName': 'string',
    'jobQueue': 'string',
    'latestAttempt': {
        'serviceResourceId': {
            'name': 'TrainingJobArn',
            'value': 'string'
        }
    },
    'retryStrategy': {
        'attempts': 123,
        'evaluateOnExit': [
            {
                'action': 'RETRY'|'EXIT',
                'onStatusReason': 'string'
            },
        ]
    },
    'scheduledAt': 123,
    'schedulingPriority': 123,
    'serviceRequestPayload': 'string',
    'serviceJobType': 'SAGEMAKER_TRAINING',
    'shareIdentifier': 'string',
    'startedAt': 123,
    'status': 'SUBMITTED'|'PENDING'|'RUNNABLE'|'SCHEDULED'|'STARTING'|'RUNNING'|'SUCCEEDED'|'FAILED',
    'statusReason': 'string',
    'stoppedAt': 123,
    'tags': {
        'string': 'string'
    },
    'timeoutConfig': {
        'attemptDurationSeconds': 123
    }
}

Response Structure

(dict) –
- attempts (list) –
  
  A list of job attempts associated with the service job.
  - (dict) –
    
    Detailed information about an attempt to run a service job.
    - serviceResourceId (dict) –
      
      The service resource identifier associated with the service job attempt.
      - name (string) –
        
        The name of the resource identifier.
      - value (string) –
        
        The value of the resource identifier.
    - startedAt (integer) –
      
      The Unix timestamp (in milliseconds) for when the service job attempt was started.
    - stoppedAt (integer) –
      
      The Unix timestamp (in milliseconds) for when the service job attempt stopped running.
    - statusReason (string) –
      
      A string that provides additional details for the current status of the service job attempt.
- capacityUsage (list) –
  
  The configured capacity for the service job, such as the number of instances. The number of instances should be the same value as the serviceRequestPayload.InstanceCount field.
  - (dict) –
    
    The capacity usage for a service job, including the unit of measure and quantity of resources being consumed.
    - capacityUnit (string) –
      
      The unit of measure for the service job capacity usage. For service jobs, this is NUM_INSTANCES.
    - quantity (float) –
      
      The quantity of capacity being used by the service job, measured in the units specified by capacityUnit.
- createdAt (integer) –
  
  The Unix timestamp (in milliseconds) for when the service job was created.
- isTerminated (boolean) –
  
  Indicates whether the service job has been terminated.
- jobArn (string) –
  
  The Amazon Resource Name (ARN) of the service job.
- jobId (string) –
  
  The job ID for the service job.
- jobName (string) –
  
  The name of the service job.
- jobQueue (string) –
  
  The ARN of the job queue that the service job is associated with.
- latestAttempt (dict) –
  
  The latest attempt associated with the service job.
  - serviceResourceId (dict) –
    
    The service resource identifier associated with the service job attempt.
    - name (string) –
      
      The name of the resource identifier.
    - value (string) –
      
      The value of the resource identifier.
- retryStrategy (dict) –
  
  The retry strategy to use for failed service jobs that are submitted with this service job.
  - 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.
    - (dict) –
      
      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.
- scheduledAt (integer) –
  
  The Unix timestamp (in milliseconds) for when the service job was scheduled. This represents when the service job was dispatched to SageMaker and the service job transitioned to the SCHEDULED state.
- schedulingPriority (integer) –
  
  The scheduling priority of the service job.
- serviceRequestPayload (string) –
  
  The request, in JSON, for the service that the SubmitServiceJob operation is queueing.
- serviceJobType (string) –
  
  The type of service job. For SageMaker Training jobs, this value is SAGEMAKER_TRAINING.
- shareIdentifier (string) –
  
  The share identifier for the service job. This is used for fair-share scheduling.
- startedAt (integer) –
  
  The Unix timestamp (in milliseconds) for when the service job was started.
- status (string) –
  
  The current status of the service job.
- statusReason (string) –
  
  A short, human-readable string to provide more details for the current status of the service job.
- stoppedAt (integer) –
  
  The Unix timestamp (in milliseconds) for when the service job stopped running.
- tags (dict) –
  
  The tags that are associated with the service job. Each tag consists of a key and an optional value. For more information, see Tagging your Batch resources.
  - (string) –
    - (string) –
- timeoutConfig (dict) –
  
  The timeout configuration for the service 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.

describe_service_job¶

Request Syntax

Response Syntax

Response Structure

Exceptions