2021/11/23 - AWS IoT - 2 new 2 updated api methods
Changes This release introduces a new feature, Managed Job Template, for AWS IoT Jobs Service. Customers can now use service provided managed job templates to easily create jobs for supported standard job actions.
Returns a list of managed job templates.
See also: AWS API Documentation
Request Syntax
client.list_managed_job_templates(
templateName='string',
maxResults=123,
nextToken='string'
)
string
An optional parameter for template name. If specified, only the versions of the managed job templates that have the specified template name will be returned.
integer
Maximum number of entries that can be returned.
string
The token to retrieve the next set of results.
dict
Response Syntax
{
'managedJobTemplates': [
{
'templateArn': 'string',
'templateName': 'string',
'description': 'string',
'environments': [
'string',
],
'templateVersion': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
managedJobTemplates (list) --
A list of managed job templates that are returned.
(dict) --
An object that contains information about the managed template.
templateArn (string) --
The Amazon Resource Name (ARN) for a managed template.
templateName (string) --
The unique Name for a managed template.
description (string) --
The description for a managed template.
environments (list) --
A list of environments that are supported with the managed job template.
(string) --
templateVersion (string) --
The version for a managed template.
nextToken (string) --
The token to retrieve the next set of results.
View details of a managed job template.
See also: AWS API Documentation
Request Syntax
client.describe_managed_job_template(
templateName='string',
templateVersion='string'
)
string
[REQUIRED]
The unique name of a managed job template, which is required.
string
An optional parameter to specify version of a managed template. If not specified, the pre-defined default version is returned.
dict
Response Syntax
{
'templateName': 'string',
'templateArn': 'string',
'description': 'string',
'templateVersion': 'string',
'environments': [
'string',
],
'documentParameters': [
{
'key': 'string',
'description': 'string',
'regex': 'string',
'example': 'string',
'optional': True|False
},
],
'document': 'string'
}
Response Structure
(dict) --
templateName (string) --
The unique name of a managed template, such as AWS-Reboot .
templateArn (string) --
The unique Amazon Resource Name (ARN) of the managed template.
description (string) --
The unique description of a managed template.
templateVersion (string) --
The version for a managed template.
environments (list) --
A list of environments that are supported with the managed job template.
(string) --
documentParameters (list) --
A map of key-value pairs that you can use as guidance to specify the inputs for creating a job from a managed template.
(dict) --
A map of key-value pairs containing 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.
key (string) --
Key of the map field containing the patterns that need to be replaced in a managed template job document schema.
description (string) --
Description of the map field containing the patterns that need to be replaced in a managed template job document schema.
regex (string) --
A regular expression of the patterns that need to be replaced in a managed template job document schema.
example (string) --
An example illustrating a pattern that need to be replaced in a managed template job document schema.
optional (boolean) --
Specifies whether a pattern that needs to be replaced in a managed template job document schema is optional or required.
document (string) --
The document schema for a managed job template.
{'documentParameters': {'string': 'string'}}
Creates a job.
Requires permission to access the CreateJob action.
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',
jobTemplateArn='string',
documentParameters={
'string': 'string'
}
)
string
[REQUIRED]
A job identifier which must be unique for your Amazon Web Services account. We recommend using a UUID. Alpha-numeric characters, "-" and "_" are valid for use here.
list
[REQUIRED]
A list of things and thing groups to which the job should be sent.
(string) --
string
An S3 link to the job document. Required if you don't specify a value for 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.
string
The job document. Required if you don't specify a value for documentSource .
string
A short text description of the job.
dict
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.
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.
dict
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.
Amazon Web Services IoT Core 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.
dict
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.
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) -- [REQUIRED]
The minimum number of things which must receive job execution notifications before the job can be aborted.
dict
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.
list
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.
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 in public preview.
string
The ARN of the job template used to create the job.
dict
Parameters of a managed template that you can specify to create the job document.
(string) --
(string) --
dict
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.
{'job': {'documentParameters': {'string': 'string'}}}
Describes a job.
Requires permission to access the DescribeJob action.
See also: AWS API Documentation
Request Syntax
client.describe_job(
jobId='string'
)
string
[REQUIRED]
The unique identifier you assigned to this job when it was created.
dict
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',
'jobTemplateArn': 'string',
'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 , 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.
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 in public preview.
jobTemplateArn (string) --
The ARN of the job template used to create 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.
(string) --
(string) --