IoT / Client / describe_job

describe_job#

IoT.Client.describe_job(**kwargs)#

Describes a job.

Requires permission to access the DescribeJob action.

Request Syntax

response = client.describe_job(
    jobId='string',
    beforeSubstitution=True|False
)

Parameters:

jobId (string) –
[REQUIRED]

The unique identifier you assigned to this job when it was created.
beforeSubstitution (boolean) – A flag that provides a view of the job document before and after the substitution parameters have been resolved with their exact values.

Return type:

dict

Returns:

Response Syntax

{
    'documentSource': 'string',
    'job': {
        'jobArn': 'string',
        'jobId': 'string',
        'targetSelection': 'CONTINUOUS'|'SNAPSHOT',
        'status': 'IN_PROGRESS'|'CANCELED'|'COMPLETED'|'DELETION_IN_PROGRESS'|'SCHEDULED',
        'forceCanceled': True|False,
        'reasonCode': 'string',
        'comment': 'string',
        'targets': [
            'string',
        ],
        'description': 'string',
        'presignedUrlConfig': {
            'roleArn': 'string',
            'expiresInSec': 123
        },
        'jobExecutionsRolloutConfig': {
            'maximumPerMinute': 123,
            'exponentialRate': {
                'baseRatePerMinute': 123,
                'incrementFactor': 123.0,
                'rateIncreaseCriteria': {
                    'numberOfNotifiedThings': 123,
                    'numberOfSucceededThings': 123
                }
            }
        },
        'abortConfig': {
            'criteriaList': [
                {
                    'failureType': 'FAILED'|'REJECTED'|'TIMED_OUT'|'ALL',
                    'action': 'CANCEL',
                    'thresholdPercentage': 123.0,
                    'minNumberOfExecutedThings': 123
                },
            ]
        },
        'createdAt': datetime(2015, 1, 1),
        'lastUpdatedAt': datetime(2015, 1, 1),
        'completedAt': datetime(2015, 1, 1),
        'jobProcessDetails': {
            'processingTargets': [
                'string',
            ],
            'numberOfCanceledThings': 123,
            'numberOfSucceededThings': 123,
            'numberOfFailedThings': 123,
            'numberOfRejectedThings': 123,
            'numberOfQueuedThings': 123,
            'numberOfInProgressThings': 123,
            'numberOfRemovedThings': 123,
            'numberOfTimedOutThings': 123
        },
        'timeoutConfig': {
            'inProgressTimeoutInMinutes': 123
        },
        'namespaceId': 'string',
        'jobTemplateArn': 'string',
        'jobExecutionsRetryConfig': {
            'criteriaList': [
                {
                    'failureType': 'FAILED'|'TIMED_OUT'|'ALL',
                    'numberOfRetries': 123
                },
            ]
        },
        'documentParameters': {
            'string': 'string'
        },
        'isConcurrent': True|False,
        'schedulingConfig': {
            'startTime': 'string',
            'endTime': 'string',
            'endBehavior': 'STOP_ROLLOUT'|'CANCEL'|'FORCE_CANCEL',
            'maintenanceWindows': [
                {
                    'startTime': 'string',
                    'durationInMinutes': 123
                },
            ]
        },
        'scheduledJobRollouts': [
            {
                'startTime': 'string'
            },
        ],
        'destinationPackageVersions': [
            'string',
        ]
    }
}

Response Structure

(dict) –
- documentSource (string) –
  
  An S3 link to the job document.
- job (dict) –
  
  Information about the job.
  - jobArn (string) –
    
    An ARN identifying the job with format “arn:aws:iot:region:account:job/jobId”.
  - jobId (string) –
    
    The unique identifier you assigned to this job when it was created.
  - targetSelection (string) –
    
    Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a device when the thing representing the device is added to a target group, even after the job was completed by all things originally in the group.
    
    Note
    We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets. By using continuous jobs, devices that join the group receive the job execution even after the job has been created.
  - status (string) –
    
    The status of the job, one of IN_PROGRESS, CANCELED, DELETION_IN_PROGRESS or COMPLETED.
  - forceCanceled (boolean) –
    
    Will be true if the job was canceled with the optional force parameter set to true.
  - reasonCode (string) –
    
    If the job was updated, provides the reason code for the update.
  - comment (string) –
    
    If the job was updated, describes the reason for the update.
  - targets (list) –
    
    A list of IoT things and thing groups to which the job should be sent.
    - (string) –
  - description (string) –
    
    A short text description of the job.
  - presignedUrlConfig (dict) –
    
    Configuration for pre-signed S3 URLs.
    - roleArn (string) –
      
      The ARN of an IAM role that grants permission to download files from the S3 bucket where the job data/updates are stored. The role must also grant permission for IoT to download the files.
      
      Warning
      For information about addressing the confused deputy problem, see cross-service confused deputy prevention in the Amazon Web Services IoT Core developer guide.
    - expiresInSec (integer) –
      
      How long (in seconds) pre-signed URLs are valid. Valid values are 60 - 3600, the default value is 3600 seconds. Pre-signed URLs are generated when Jobs receives an MQTT request for the job document.
  - jobExecutionsRolloutConfig (dict) –
    
    Allows you to create a staged rollout of a job.
    - maximumPerMinute (integer) –
      
      The maximum number of things that will be notified of a pending job, per minute. This parameter allows you to create a staged rollout.
    - exponentialRate (dict) –
      
      The rate of increase for a job rollout. This parameter allows you to define an exponential rate for a job rollout.
      - baseRatePerMinute (integer) –
        
        The minimum number of things that will be notified of a pending job, per minute at the start of job rollout. This parameter allows you to define the initial rate of rollout.
      - incrementFactor (float) –
        
        The exponential factor to increase the rate of rollout for a job.
        
        Amazon Web Services IoT Core supports up to one digit after the decimal (for example, 1.5, but not 1.55).
      - rateIncreaseCriteria (dict) –
        
        The criteria to initiate the increase in rate of rollout for a job.
        
        numberOfNotifiedThings (integer) –
        
        The threshold for number of notified things that will initiate the increase in rate of rollout.
        
        numberOfSucceededThings (integer) –
        
        The threshold for number of succeeded things that will initiate the increase in rate of rollout.
  - abortConfig (dict) –
    
    Configuration for criteria to abort the job.
    - criteriaList (list) –
      
      The list of criteria that determine when and how to abort the job.
      - (dict) –
        
        The criteria that determine when and how a job abort takes place.
        
        failureType (string) –
        
        The type of job execution failures that can initiate a job abort.
        
        action (string) –
        
        The type of job action to take to initiate the job abort.
        
        thresholdPercentage (float) –
        
        The minimum percentage of job execution failures that must occur to initiate the job abort.
        
        Amazon Web Services IoT Core supports up to two digits after the decimal (for example, 10.9 and 10.99, but not 10.999).
        
        minNumberOfExecutedThings (integer) –
        
        The minimum number of things which must receive job execution notifications before the job can be aborted.
  - createdAt (datetime) –
    
    The time, in seconds since the epoch, when the job was created.
  - lastUpdatedAt (datetime) –
    
    The time, in seconds since the epoch, when the job was last updated.
  - completedAt (datetime) –
    
    The time, in seconds since the epoch, when the job was completed.
  - jobProcessDetails (dict) –
    
    Details about the job process.
    - processingTargets (list) –
      
      The target devices to which the job execution is being rolled out. This value will be null after the job execution has finished rolling out to all the target devices.
      - (string) –
    - numberOfCanceledThings (integer) –
      
      The number of things that cancelled the job.
    - numberOfSucceededThings (integer) –
      
      The number of things which successfully completed the job.
    - numberOfFailedThings (integer) –
      
      The number of things that failed executing the job.
    - numberOfRejectedThings (integer) –
      
      The number of things that rejected the job.
    - numberOfQueuedThings (integer) –
      
      The number of things that are awaiting execution of the job.
    - numberOfInProgressThings (integer) –
      
      The number of things currently executing the job.
    - numberOfRemovedThings (integer) –
      
      The number of things that are no longer scheduled to execute the job because they have been deleted or have been removed from the group that was a target of the job.
    - numberOfTimedOutThings (integer) –
      
      The number of things whose job execution status is TIMED_OUT.
  - timeoutConfig (dict) –
    
    Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.
    - inProgressTimeoutInMinutes (integer) –
      
      Specifies the amount of time, in minutes, this device has to finish execution of this job. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The in progress timer can’t be updated and will apply to all job executions for the job. Whenever a job execution remains in the IN_PROGRESS status for longer than this interval, the job execution will fail and switch to the terminal TIMED_OUT status.
  - namespaceId (string) –
    
    The namespace used to indicate that a job is a customer-managed job.
    
    When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.
    
    $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/
    
    Note
    The namespaceId feature is only supported by IoT Greengrass at this time. For more information, see Setting up IoT Greengrass core devices.
  - jobTemplateArn (string) –
    
    The ARN of the job template used to create the job.
  - jobExecutionsRetryConfig (dict) –
    
    The configuration for the criteria to retry the job.
    - criteriaList (list) –
      
      The list of criteria that determines how many retries are allowed for each failure type for a job.
      - (dict) –
        
        The criteria that determines how many retries are allowed for each failure type for a job.
        
        failureType (string) –
        
        The type of job execution failures that can initiate a job retry.
        
        numberOfRetries (integer) –
        
        The number of retries allowed for a failure type for the job.
  - documentParameters (dict) –
    
    A key-value map that pairs the patterns that need to be replaced in a managed template job document schema. You can use the description of each key as a guidance to specify the inputs during runtime when creating a job.
    
    Note
    documentParameters can only be used when creating jobs from Amazon Web Services managed templates. This parameter can’t be used with custom job templates or to create jobs from them.
    - (string) –
      - (string) –
  - isConcurrent (boolean) –
    
    Indicates whether a job is concurrent. Will be true when a job is rolling out new job executions or canceling previously created executions, otherwise false.
  - schedulingConfig (dict) –
    
    The configuration that allows you to schedule a job for a future date and time in addition to specifying the end behavior for each job execution.
    - startTime (string) –
      
      The time a job will begin rollout of the job document to all devices in the target group for a job. The startTime can be scheduled up to a year in advance and must be scheduled a minimum of thirty minutes from the current time. The date and time format for the startTime is YYYY-MM-DD for the date and HH:MM for the time.
      
      For more information on the syntax for startTime when using an API command or the Command Line Interface, see Timestamp.
    - endTime (string) –
      
      The time a job will stop rollout of the job document to all devices in the target group for a job. The endTime must take place no later than two years from the current time and be scheduled a minimum of thirty minutes from the current time. The minimum duration between startTime and endTime is thirty minutes. The maximum duration between startTime and endTime is two years. The date and time format for the endTime is YYYY-MM-DD for the date and HH:MM for the time.
      
      For more information on the syntax for endTime when using an API command or the Command Line Interface, see Timestamp.
    - endBehavior (string) –
      
      Specifies the end behavior for all job executions after a job reaches the selected endTime. If endTime is not selected when creating the job, then endBehavior does not apply.
    - maintenanceWindows (list) –
      
      An optional configuration within the SchedulingConfig to setup a recurring maintenance window with a predetermined start time and duration for the rollout of a job document to all devices in a target group for a job.
      - (dict) –
        
        An optional configuration within the SchedulingConfig to setup a recurring maintenance window with a predetermined start time and duration for the rollout of a job document to all devices in a target group for a job.
        
        startTime (string) –
        
        Displays the start time of the next maintenance window.
        
        durationInMinutes (integer) –
        
        Displays the duration of the next maintenance window.
  - scheduledJobRollouts (list) –
    
    Displays the next seven maintenance window occurrences and their start times.
    - (dict) –
      
      Displays the next seven maintenance window occurrences and their start times.
      - startTime (string) –
        
        Displays the start times of the next seven maintenance window occurrences.
  - destinationPackageVersions (list) –
    
    The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes. The package version must be in either the Published or Deprecated state when the job deploys. For more information, see Package version lifecycle.The package version must be in either the Published or Deprecated state when the job deploys. For more information, see Package version lifecycle.
    
    **Note:**The following Length Constraints relates to a single ARN. Up to 25 package version ARNs are allowed.
    - (string) –

Exceptions

IoT.Client.exceptions.InvalidRequestException
IoT.Client.exceptions.ResourceNotFoundException
IoT.Client.exceptions.ThrottlingException
IoT.Client.exceptions.ServiceUnavailableException