AWS IoT

2020/10/28 - AWS IoT - 8 updated api methods

Changes  This release adds support for GG-Managed Job Namespace

AssociateTargetsWithJob (updated) Link ¶
Changes (request)
{'namespaceId': 'string'}

Associates a group with a continuous job. The following criteria must be met:

  • The job must have been created with the targetSelection field set to "CONTINUOUS".

  • The job status must currently be "IN_PROGRESS".

  • The total number of targets associated with a job must not exceed 100.

See also: AWS API Documentation

Request Syntax

client.associate_targets_with_job(
    targets=[
        'string',
    ],
    jobId='string',
    comment='string',
    namespaceId='string'
)
type targets

list

param targets

[REQUIRED]

A list of thing group ARNs that define the targets of the job.

  • (string) --

type jobId

string

param jobId

[REQUIRED]

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

type comment

string

param comment

An optional comment string describing why the job was associated with the targets.

type namespaceId

string

param namespaceId

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, AWS 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 in public preview.

rtype

dict

returns

Response Syntax

{
    'jobArn': 'string',
    'jobId': 'string',
    'description': 'string'
}

Response Structure

  • (dict) --

    • jobArn (string) --

      An ARN identifying the job.

    • jobId (string) --

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

    • description (string) --

      A short text description of the job.

CreateJob (updated) Link ¶
Changes (request)
{'namespaceId': 'string'}

Creates a job.

See also: AWS API Documentation

Request Syntax

client.create_job(
    jobId='string',
    targets=[
        'string',
    ],
    documentSource='string',
    document='string',
    description='string',
    presignedUrlConfig={
        'roleArn': 'string',
        'expiresInSec': 123
    },
    targetSelection='CONTINUOUS'|'SNAPSHOT',
    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
            },
        ]
    },
    timeoutConfig={
        'inProgressTimeoutInMinutes': 123
    },
    tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    namespaceId='string'
)
type jobId

string

param jobId

[REQUIRED]

A job identifier which must be unique for your AWS account. We recommend using a UUID. Alpha-numeric characters, "-" and "_" are valid for use here.

type targets

list

param targets

[REQUIRED]

A list of things and thing groups to which the job should be sent.

  • (string) --

type documentSource

string

param documentSource

An S3 link to the job document.

type document

string

param document

The job document.

Note

If the job document resides in an S3 bucket, you must use a placeholder link when specifying the document.

The placeholder link is of the following form:

${aws:iot:s3-presigned-url:https://s3.amazonaws.com/*bucket* /*key* }

where bucket is your bucket name and key is the object in the bucket to which you are linking.

type description

string

param description

A short text description of the job.

type presignedUrlConfig

dict

param presignedUrlConfig

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

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 jobExecutionsRolloutConfig

dict

param jobExecutionsRolloutConfig

Allows you to create a staged rollout of the 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) -- [REQUIRED]

      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) -- [REQUIRED]

      The exponential factor to increase the rate of rollout for a job.

      AWS IoT supports up to one digit after the decimal (for example, 1.5, but not 1.55).

    • rateIncreaseCriteria (dict) -- [REQUIRED]

      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.

type abortConfig

dict

param abortConfig

Allows you to create criteria to abort a job.

  • criteriaList (list) -- [REQUIRED]

    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) -- [REQUIRED]

        The type of job execution failures that can initiate a job abort.

      • action (string) -- [REQUIRED]

        The type of job action to take to initiate the job abort.

      • thresholdPercentage (float) -- [REQUIRED]

        The minimum percentage of job execution failures that must occur to initiate the job abort.

        AWS IoT supports up to two digits after the decimal (for example, 10.9 and 10.99, but not 10.999).

      • minNumberOfExecutedThings (integer) -- [REQUIRED]

        The minimum number of things which must receive job execution notifications before the job can be aborted.

type timeoutConfig

dict

param timeoutConfig

Specifies the amount of time each device has to finish its execution of the job. The 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 time 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.

type tags

list

param tags

Metadata which can be used to manage the job.

  • (dict) --

    A set of key/value pairs that are used to manage the resource.

    • Key (string) -- [REQUIRED]

      The tag's key.

    • Value (string) --

      The tag's value.

type namespaceId

string

param namespaceId

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, AWS 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 in public preview.

rtype

dict

returns

Response Syntax

{
    'jobArn': 'string',
    'jobId': 'string',
    'description': 'string'
}

Response Structure

  • (dict) --

    • jobArn (string) --

      The job ARN.

    • jobId (string) --

      The unique identifier you assigned to this job.

    • description (string) --

      The job description.

DeleteJob (updated) Link ¶
Changes (request)
{'namespaceId': 'string'}

Deletes a job and its related job executions.

Deleting a job may take time, depending on the number of job executions created for the job and various other factors. While the job is being deleted, the status of the job will be shown as "DELETION_IN_PROGRESS". Attempting to delete or cancel a job whose status is already "DELETION_IN_PROGRESS" will result in an error.

Only 10 jobs may have status "DELETION_IN_PROGRESS" at the same time, or a LimitExceededException will occur.

See also: AWS API Documentation

Request Syntax

client.delete_job(
    jobId='string',
    force=True|False,
    namespaceId='string'
)
type jobId

string

param jobId

[REQUIRED]

The ID of the job to be deleted.

After a job deletion is completed, you may reuse this jobId when you create a new job. However, this is not recommended, and you must ensure that your devices are not using the jobId to refer to the deleted job.

type force

boolean

param force

(Optional) When true, you can delete a job which is "IN_PROGRESS". Otherwise, you can only delete a job which is in a terminal state ("COMPLETED" or "CANCELED") or an exception will occur. The default is false.

Note

Deleting a job which is "IN_PROGRESS", will cause a device which is executing the job to be unable to access job information or update the job execution status. Use caution and ensure that each device executing a job which is deleted is able to recover to a valid state.

type namespaceId

string

param namespaceId

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, AWS 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 in public preview.

returns

None

DeleteJobExecution (updated) Link ¶
Changes (request)
{'namespaceId': 'string'}

Deletes a job execution.

See also: AWS API Documentation

Request Syntax

client.delete_job_execution(
    jobId='string',
    thingName='string',
    executionNumber=123,
    force=True|False,
    namespaceId='string'
)
type jobId

string

param jobId

[REQUIRED]

The ID of the job whose execution on a particular device will be deleted.

type thingName

string

param thingName

[REQUIRED]

The name of the thing whose job execution will be deleted.

type executionNumber

integer

param executionNumber

[REQUIRED]

The ID of the job execution to be deleted. The executionNumber refers to the execution of a particular job on a particular device.

Note that once a job execution is deleted, the executionNumber may be reused by IoT, so be sure you get and use the correct value here.

type force

boolean

param force

(Optional) When true, you can delete a job execution which is "IN_PROGRESS". Otherwise, you can only delete a job execution which is in a terminal state ("SUCCEEDED", "FAILED", "REJECTED", "REMOVED" or "CANCELED") or an exception will occur. The default is false.

Note

Deleting a job execution which is "IN_PROGRESS", will cause the device to be unable to access job information or update the job execution status. Use caution and ensure that the device is able to recover to a valid state.

type namespaceId

string

param namespaceId

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, AWS 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 in public preview.

returns

None

DescribeJob (updated) Link ¶
Changes (response)
{'job': {'namespaceId': 'string'}}

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',
        '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'
    }
}

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

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

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

              AWS IoT 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, AWS 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 in public preview.

ListJobExecutionsForThing (updated) Link ¶
Changes (request)
{'namespaceId': 'string'}

Lists the job executions for the specified thing.

See also: AWS API Documentation

Request Syntax

client.list_job_executions_for_thing(
    thingName='string',
    status='QUEUED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'TIMED_OUT'|'REJECTED'|'REMOVED'|'CANCELED',
    namespaceId='string',
    maxResults=123,
    nextToken='string'
)
type thingName

string

param thingName

[REQUIRED]

The thing name.

type status

string

param status

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

type namespaceId

string

param namespaceId

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, AWS 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 in public preview.

type maxResults

integer

param maxResults

The maximum number of results to be returned per request.

type nextToken

string

param nextToken

The token to retrieve the next set of results.

rtype

dict

returns

Response Syntax

{
    'executionSummaries': [
        {
            'jobId': 'string',
            'jobExecutionSummary': {
                'status': 'QUEUED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'TIMED_OUT'|'REJECTED'|'REMOVED'|'CANCELED',
                'queuedAt': datetime(2015, 1, 1),
                'startedAt': datetime(2015, 1, 1),
                'lastUpdatedAt': datetime(2015, 1, 1),
                'executionNumber': 123
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • executionSummaries (list) --

      A list of job execution summaries.

      • (dict) --

        The job execution summary for a thing.

        • jobId (string) --

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

        • jobExecutionSummary (dict) --

          Contains a subset of information about a job execution.

          • status (string) --

            The status of the job execution.

          • queuedAt (datetime) --

            The time, in seconds since the epoch, when the job execution was queued.

          • startedAt (datetime) --

            The time, in seconds since the epoch, when the job execution started.

          • lastUpdatedAt (datetime) --

            The time, in seconds since the epoch, when the job execution was last updated.

          • executionNumber (integer) --

            A string (consisting of the digits "0" through "9") which identifies this particular job execution on this particular device. It can be used later in commands which return or update job execution information.

    • nextToken (string) --

      The token for the next set of results, or null if there are no additional results.

ListJobs (updated) Link ¶
Changes (request)
{'namespaceId': 'string'}

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',
    namespaceId='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.

type namespaceId

string

param namespaceId

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, AWS 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 in public preview.

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

    • nextToken (string) --

      The token for the next set of results, or null if there are no additional results.

UpdateJob (updated) Link ¶
Changes (request)
{'namespaceId': 'string'}

Updates supported fields of the specified job.

See also: AWS API Documentation

Request Syntax

client.update_job(
    jobId='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
            },
        ]
    },
    timeoutConfig={
        'inProgressTimeoutInMinutes': 123
    },
    namespaceId='string'
)
type jobId

string

param jobId

[REQUIRED]

The ID of the job to be updated.

type description

string

param description

A short text description of the job.

type presignedUrlConfig

dict

param presignedUrlConfig

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

type jobExecutionsRolloutConfig

dict

param jobExecutionsRolloutConfig

Allows you to create a staged rollout of the 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) -- [REQUIRED]

      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) -- [REQUIRED]

      The exponential factor to increase the rate of rollout for a job.

      AWS IoT supports up to one digit after the decimal (for example, 1.5, but not 1.55).

    • rateIncreaseCriteria (dict) -- [REQUIRED]

      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.

type abortConfig

dict

param abortConfig

Allows you to create criteria to abort a job.

  • criteriaList (list) -- [REQUIRED]

    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) -- [REQUIRED]

        The type of job execution failures that can initiate a job abort.

      • action (string) -- [REQUIRED]

        The type of job action to take to initiate the job abort.

      • thresholdPercentage (float) -- [REQUIRED]

        The minimum percentage of job execution failures that must occur to initiate the job abort.

        AWS IoT supports up to two digits after the decimal (for example, 10.9 and 10.99, but not 10.999).

      • minNumberOfExecutedThings (integer) -- [REQUIRED]

        The minimum number of things which must receive job execution notifications before the job can be aborted.

type timeoutConfig

dict

param timeoutConfig

Specifies the amount of time each device has to finish its execution of the job. The 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 time 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.

type namespaceId

string

param namespaceId

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, AWS 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 in public preview.

returns

None