AWS API Changes

2018/05/25 - AWS IoT - 2 updated api methods

Changes Update iot client to latest version

DescribeJob (updated)

Link ¶
Changes (response)

{'job': {'status': {'DELETION_IN_PROGRESS'}}}

Describes a job.

See also: AWS API Documentation

Request Syntax

client.describe_job(
    jobId='string'
)

type jobId:

string

param jobId:

[REQUIRED]

The unique identifier you assigned to this job when it was created.

rtype:

dict

returns:

Response Syntax

{
    'documentSource': 'string',
    'job': {
        'jobArn': 'string',
        'jobId': 'string',
        'targetSelection': 'CONTINUOUS'|'SNAPSHOT',
        'status': 'IN_PROGRESS'|'CANCELED'|'COMPLETED'|'DELETION_IN_PROGRESS',
        'comment': 'string',
        'targets': [
            'string',
        ],
        'description': 'string',
        'presignedUrlConfig': {
            'roleArn': 'string',
            'expiresInSec': 123
        },
        'jobExecutionsRolloutConfig': {
            'maximumPerMinute': 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
        },
        'documentParameters': {
            'string': '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.
  - status (string) --
    
    The status of the job, one of IN_PROGRESS, CANCELED, or COMPLETED.
  - 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 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.
    - 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.
  - createdAt (datetime) --
    
    The time, in milliseconds since the epoch, when the job was created.
  - lastUpdatedAt (datetime) --
    
    The time, in milliseconds since the epoch, when the job was last updated.
  - completedAt (datetime) --
    
    The time, in milliseconds since the epoch, when the job was completed.
  - jobProcessDetails (dict) --
    
    Details about the job process.
    - processingTargets (list) --
      
      The devices on which the job is executing.
      - (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.
  - documentParameters (dict) --
    
    The parameters specified for the job document.
    - (string) --
      - (string) --

ListJobs (updated)

Link ¶
Changes (request, response)
Request

{'status': {'DELETION_IN_PROGRESS'}}

Response

{'jobs': {'status': {'DELETION_IN_PROGRESS'}}}

Lists jobs.

See also: AWS API Documentation

Request Syntax

client.list_jobs(
    status='IN_PROGRESS'|'CANCELED'|'COMPLETED'|'DELETION_IN_PROGRESS',
    targetSelection='CONTINUOUS'|'SNAPSHOT',
    maxResults=123,
    nextToken='string',
    thingGroupName='string',
    thingGroupId='string'
)

type status:

string

param status:

An optional filter that lets you search for jobs that have the specified status.

type targetSelection:

string

param targetSelection:

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 thing when the thing is added to a target group, even after the job was completed by all things originally in the group.

type maxResults:

integer

param maxResults:

The maximum number of results to return per request.

type nextToken:

string

param nextToken:

The token to retrieve the next set of results.

type thingGroupName:

string

param thingGroupName:

A filter that limits the returned jobs to those for the specified group.

type thingGroupId:

string

param thingGroupId:

A filter that limits the returned jobs to those for the specified group.

rtype:

dict

returns:

Response Syntax

{
    'jobs': [
        {
            'jobArn': 'string',
            'jobId': 'string',
            'thingGroupId': 'string',
            'targetSelection': 'CONTINUOUS'|'SNAPSHOT',
            'status': 'IN_PROGRESS'|'CANCELED'|'COMPLETED'|'DELETION_IN_PROGRESS',
            'createdAt': datetime(2015, 1, 1),
            'lastUpdatedAt': datetime(2015, 1, 1),
            'completedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- jobs (list) --
  
  A list of jobs.
  - (dict) --
    
    The job summary.
    - jobArn (string) --
      
      The job ARN.
    - jobId (string) --
      
      The unique identifier you assigned to this job when it was created.
    - thingGroupId (string) --
      
      The ID of the thing group.
    - 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 thing when the thing is added to a target group, even after the job was completed by all things originally in the group.
    - status (string) --
      
      The job summary status.
    - createdAt (datetime) --
      
      The time, in milliseconds since the epoch, when the job was created.
    - lastUpdatedAt (datetime) --
      
      The time, in milliseconds since the epoch, when the job was last updated.
    - completedAt (datetime) --
      
      The time, in milliseconds since the epoch, when the job completed.
- nextToken (string) --
  
  The token for the next set of results, or null if there are no additional results.