2023/06/06 - AWS IoT - 12 new 4 updated api methods
Changes Adding IoT Device Management Software Package Catalog APIs to register, store, and report system software packages, along with their versions and metadata in a centralized location.
Gets information about the specified software package's configuration.
Requires permission to access the GetPackageConfiguration action.
See also: AWS API Documentation
Request Syntax
client.get_package_configuration()
dict
Response Syntax
{
'versionUpdateByJobsConfig': {
'enabled': True|False,
'roleArn': 'string'
}
}
Response Structure
(dict) --
versionUpdateByJobsConfig (dict) --
The version that is associated to a specific job.
enabled (boolean) --
Indicates whether the Job is enabled or not.
roleArn (string) --
The Amazon Resource Name (ARN) of the role that grants permission to the IoT jobs service to update the reserved named shadow when the job successfully completes.
Creates a new version for an existing IoT software package.
Requires permission to access the CreatePackageVersion and GetIndexingConfiguration actions.
See also: AWS API Documentation
Request Syntax
client.create_package_version(
packageName='string',
versionName='string',
description='string',
attributes={
'string': 'string'
},
tags={
'string': 'string'
},
clientToken='string'
)
string
[REQUIRED]
The name of the associated package.
string
[REQUIRED]
The name of the new package version.
string
A summary of the package version being created. This can be used to outline the package's contents or purpose.
dict
Metadata that can be used to define a package version’s configuration. For example, the S3 file location, configuration options that are being sent to the device or fleet.
The combined size of all the attributes on a package version is limited to 3KB.
(string) --
(string) --
dict
Metadata that can be used to manage the package version.
(string) --
(string) --
string
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
This field is autopopulated if not provided.
dict
Response Syntax
{
'packageVersionArn': 'string',
'packageName': 'string',
'versionName': 'string',
'description': 'string',
'attributes': {
'string': 'string'
},
'status': 'DRAFT'|'PUBLISHED'|'DEPRECATED',
'errorReason': 'string'
}
Response Structure
(dict) --
packageVersionArn (string) --
The Amazon Resource Name (ARN) for the package.
packageName (string) --
The name of the associated package.
versionName (string) --
The name of the new package version.
description (string) --
The package version description.
attributes (dict) --
Metadata that were added to the package version that can be used to define a package version’s configuration.
(string) --
(string) --
status (string) --
The status of the package version. For more information, see Package version lifecycle .
errorReason (string) --
Error reason for a package version failure during creation or update.
Gets information about the specified package version.
Requires permission to access the GetPackageVersion action.
See also: AWS API Documentation
Request Syntax
client.get_package_version(
packageName='string',
versionName='string'
)
string
[REQUIRED]
The name of the associated package.
string
[REQUIRED]
The name of the target package version.
dict
Response Syntax
{
'packageVersionArn': 'string',
'packageName': 'string',
'versionName': 'string',
'description': 'string',
'attributes': {
'string': 'string'
},
'status': 'DRAFT'|'PUBLISHED'|'DEPRECATED',
'errorReason': 'string',
'creationDate': datetime(2015, 1, 1),
'lastModifiedDate': datetime(2015, 1, 1)
}
Response Structure
(dict) --
packageVersionArn (string) --
The ARN for the package version.
packageName (string) --
The name of the package.
versionName (string) --
The name of the package version.
description (string) --
The package version description.
attributes (dict) --
Metadata that were added to the package version that can be used to define a package version’s configuration.
(string) --
(string) --
status (string) --
The status associated to the package version. For more information, see Package version lifecycle .
errorReason (string) --
Error reason for a package version failure during creation or update.
creationDate (datetime) --
The date when the package version was created.
lastModifiedDate (datetime) --
The date when the package version was last updated.
Updates the supported fields for a specific package version.
Requires permission to access the UpdatePackageVersion and GetIndexingConfiguration actions.
See also: AWS API Documentation
Request Syntax
client.update_package_version(
packageName='string',
versionName='string',
description='string',
attributes={
'string': 'string'
},
action='PUBLISH'|'DEPRECATE',
clientToken='string'
)
string
[REQUIRED]
The name of the associated software package.
string
[REQUIRED]
The name of the target package version.
string
The package version description.
dict
Metadata that can be used to define a package version’s configuration. For example, the S3 file location, configuration options that are being sent to the device or fleet.
Note: Attributes can be updated only when the package version is in a draft state.
The combined size of all the attributes on a package version is limited to 3KB.
(string) --
(string) --
string
The status that the package version should be assigned. For more information, see Package version lifecycle .
string
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
This field is autopopulated if not provided.
dict
Response Syntax
{}
Response Structure
(dict) --
Gets information about the specified software package.
Requires permission to access the GetPackage action.
See also: AWS API Documentation
Request Syntax
client.get_package(
packageName='string'
)
string
[REQUIRED]
The name of the target package.
dict
Response Syntax
{
'packageName': 'string',
'packageArn': 'string',
'description': 'string',
'defaultVersionName': 'string',
'creationDate': datetime(2015, 1, 1),
'lastModifiedDate': datetime(2015, 1, 1)
}
Response Structure
(dict) --
packageName (string) --
The name of the package.
packageArn (string) --
The ARN for the package.
description (string) --
The package description.
defaultVersionName (string) --
The name of the default package version.
creationDate (datetime) --
The date the package was created.
lastModifiedDate (datetime) --
The date when the package was last updated.
Deletes a specific version from a software package.
Note: If a package version is designated as default, you must remove the designation from the package using the UpdatePackage action.
See also: AWS API Documentation
Request Syntax
client.delete_package_version(
packageName='string',
versionName='string',
clientToken='string'
)
string
[REQUIRED]
The name of the associated package.
string
[REQUIRED]
The name of the target package version.
string
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
This field is autopopulated if not provided.
dict
Response Syntax
{}
Response Structure
(dict) --
Updates the supported fields for a specific package.
Requires permission to access the UpdatePackage and GetIndexingConfiguration actions.
See also: AWS API Documentation
Request Syntax
client.update_package(
packageName='string',
description='string',
defaultVersionName='string',
unsetDefaultVersion=True|False,
clientToken='string'
)
string
[REQUIRED]
The name of the target package.
string
The package description.
string
The name of the default package version.
Note: You cannot name a defaultVersion and set unsetDefaultVersion equal to true at the same time.
boolean
Indicates whether you want to remove the named default package version from the software package. Set as true to remove the default package version.
Note: You cannot name a defaultVersion and set unsetDefaultVersion equal to true at the same time.
string
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
This field is autopopulated if not provided.
dict
Response Syntax
{}
Response Structure
(dict) --
Creates an IoT software package that can be deployed to your fleet.
Requires permission to access the CreatePackage and GetIndexingConfiguration actions.
See also: AWS API Documentation
Request Syntax
client.create_package(
packageName='string',
description='string',
tags={
'string': 'string'
},
clientToken='string'
)
string
[REQUIRED]
The name of the new package.
string
A summary of the package being created. This can be used to outline the package's contents or purpose.
dict
Metadata that can be used to manage the package.
(string) --
(string) --
string
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
This field is autopopulated if not provided.
dict
Response Syntax
{
'packageName': 'string',
'packageArn': 'string',
'description': 'string'
}
Response Structure
(dict) --
packageName (string) --
The name of the package.
packageArn (string) --
The Amazon Resource Name (ARN) for the package.
description (string) --
The package description.
Deletes a specific version from a software package.
Note: All package versions must be deleted before deleting the software package.
Requires permission to access the DeletePackageVersion action.
See also: AWS API Documentation
Request Syntax
client.delete_package(
packageName='string',
clientToken='string'
)
string
[REQUIRED]
The name of the target package.
string
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
This field is autopopulated if not provided.
dict
Response Syntax
{}
Response Structure
(dict) --
Updates the package configuration.
Requires permission to access the UpdatePackageConfiguration and iam:PassRole actions.
See also: AWS API Documentation
Request Syntax
client.update_package_configuration(
versionUpdateByJobsConfig={
'enabled': True|False,
'roleArn': 'string'
},
clientToken='string'
)
dict
Configuration to manage job's package version reporting. This updates the thing's reserved named shadow that the job targets.
enabled (boolean) --
Indicates whether the Job is enabled or not.
roleArn (string) --
The Amazon Resource Name (ARN) of the role that grants permission to the IoT jobs service to update the reserved named shadow when the job successfully completes.
string
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
This field is autopopulated if not provided.
dict
Response Syntax
{}
Response Structure
(dict) --
Lists the software package versions associated to the account.
Requires permission to access the ListPackageVersions action.
See also: AWS API Documentation
Request Syntax
client.list_package_versions(
packageName='string',
status='DRAFT'|'PUBLISHED'|'DEPRECATED',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The name of the target package.
string
The status of the package version. For more information, see Package version lifecycle .
integer
The maximum number of results to return at one time.
string
The token for the next set of results.
dict
Response Syntax
{
'packageVersionSummaries': [
{
'packageName': 'string',
'versionName': 'string',
'status': 'DRAFT'|'PUBLISHED'|'DEPRECATED',
'creationDate': datetime(2015, 1, 1),
'lastModifiedDate': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
packageVersionSummaries (list) --
Lists the package versions associated to the package.
(dict) --
A summary of information about a package version.
packageName (string) --
The name of the associated software package.
versionName (string) --
The name of the target package version.
status (string) --
The status of the package version. For more information, see Package version lifecycle .
creationDate (datetime) --
The date that the package version was created.
lastModifiedDate (datetime) --
The date that the package version was last updated.
nextToken (string) --
The token for the next set of results.
Lists the software packages associated to the account.
Requires permission to access the ListPackages action.
See also: AWS API Documentation
Request Syntax
client.list_packages(
maxResults=123,
nextToken='string'
)
integer
The maximum number of results returned at one time.
string
The token for the next set of results.
dict
Response Syntax
{
'packageSummaries': [
{
'packageName': 'string',
'defaultVersionName': 'string',
'creationDate': datetime(2015, 1, 1),
'lastModifiedDate': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
packageSummaries (list) --
The software package summary.
(dict) --
A summary of information about a software package.
packageName (string) --
The name for the target package.
defaultVersionName (string) --
The name of the default package version.
creationDate (datetime) --
The date that the package was created.
lastModifiedDate (datetime) --
The date that the package was last updated.
nextToken (string) --
The token for the next set of results.
{'destinationPackageVersions': ['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',
jobExecutionsRetryConfig={
'criteriaList': [
{
'failureType': 'FAILED'|'TIMED_OUT'|'ALL',
'numberOfRetries': 123
},
]
},
documentParameters={
'string': 'string'
},
schedulingConfig={
'startTime': 'string',
'endTime': 'string',
'endBehavior': 'STOP_ROLLOUT'|'CANCEL'|'FORCE_CANCEL',
'maintenanceWindows': [
{
'startTime': 'string',
'durationInMinutes': 123
},
]
},
destinationPackageVersions=[
'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, or S3 object URL, to the job document. The link is an Amazon S3 object URL and is required if you don't specify a value for document .
For example, --document-source https://s3.*region-code* .amazonaws.com/example-firmware/device-firmware.1.0
For more information, see Methods for accessing a bucket .
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 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.
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.
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.
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 the 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
Allows you to create the criteria to retry a job.
criteriaList (list) -- [REQUIRED]
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) -- [REQUIRED]
The type of job execution failures that can initiate a job retry.
numberOfRetries (integer) -- [REQUIRED]
The number of retries allowed for a failure type for the job.
dict
Parameters of an Amazon Web Services managed template that you can specify to create the job document.
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) --
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.
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.
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) -- [REQUIRED]
Displays the start time of the next maintenance window.
durationInMinutes (integer) -- [REQUIRED]
Displays the duration of the next maintenance window.
list
The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes.
Note: The following Length Constraints relates to a single string. Up to five strings are allowed.
(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.
{'destinationPackageVersions': ['string']}
Creates a job template.
Requires permission to access the CreateJobTemplate action.
See also: AWS API Documentation
Request Syntax
client.create_job_template(
jobTemplateId='string',
jobArn='string',
documentSource='string',
document='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
},
tags=[
{
'Key': 'string',
'Value': 'string'
},
],
jobExecutionsRetryConfig={
'criteriaList': [
{
'failureType': 'FAILED'|'TIMED_OUT'|'ALL',
'numberOfRetries': 123
},
]
},
maintenanceWindows=[
{
'startTime': 'string',
'durationInMinutes': 123
},
],
destinationPackageVersions=[
'string',
]
)
string
[REQUIRED]
A unique identifier for the job template. We recommend using a UUID. Alpha-numeric characters, "-", and "_" are valid for use here.
string
The ARN of the job to use as the basis for the job template.
string
An S3 link to the job document to use in the template. 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
[REQUIRED]
A description of the job document.
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.
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) -- [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
The criteria that determine when and how a job abort takes place.
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. 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.
list
Metadata that can be used to manage the job template.
(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.
dict
Allows you to create the criteria to retry a job.
criteriaList (list) -- [REQUIRED]
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) -- [REQUIRED]
The type of job execution failures that can initiate a job retry.
numberOfRetries (integer) -- [REQUIRED]
The number of retries allowed for a failure type for the job.
list
Allows you to configure an optional maintenance window for the rollout of a job document to all devices in the 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) -- [REQUIRED]
Displays the start time of the next maintenance window.
durationInMinutes (integer) -- [REQUIRED]
Displays the duration of the next maintenance window.
list
The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes.
Note: The following Length Constraints relates to a single string. Up to five strings are allowed.
(string) --
dict
Response Syntax
{
'jobTemplateArn': 'string',
'jobTemplateId': 'string'
}
Response Structure
(dict) --
jobTemplateArn (string) --
The ARN of the job template.
jobTemplateId (string) --
The unique identifier of the job template.
{'job': {'destinationPackageVersions': ['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'|'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 in public preview.
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.
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.
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.
Note: The following Length Constraints relates to a single string. Up to five strings are allowed.
(string) --
{'destinationPackageVersions': ['string']}
Returns information about a job template.
See also: AWS API Documentation
Request Syntax
client.describe_job_template(
jobTemplateId='string'
)
string
[REQUIRED]
The unique identifier of the job template.
dict
Response Syntax
{
'jobTemplateArn': 'string',
'jobTemplateId': 'string',
'description': 'string',
'documentSource': 'string',
'document': 'string',
'createdAt': datetime(2015, 1, 1),
'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
},
'jobExecutionsRetryConfig': {
'criteriaList': [
{
'failureType': 'FAILED'|'TIMED_OUT'|'ALL',
'numberOfRetries': 123
},
]
},
'maintenanceWindows': [
{
'startTime': 'string',
'durationInMinutes': 123
},
],
'destinationPackageVersions': [
'string',
]
}
Response Structure
(dict) --
jobTemplateArn (string) --
The ARN of the job template.
jobTemplateId (string) --
The unique identifier of the job template.
description (string) --
A description of the job template.
documentSource (string) --
An S3 link to the job document.
document (string) --
The job document.
createdAt (datetime) --
The time, in seconds since the epoch, when the job template was created.
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) --
The criteria that determine when and how a job abort takes place.
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.
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.
jobExecutionsRetryConfig (dict) --
The configuration that determines how many retries are allowed for each failure type for a 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.
maintenanceWindows (list) --
Allows you to configure an optional maintenance window for the rollout of a job document to all devices in the 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.
destinationPackageVersions (list) --
The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes.
Note: The following Length Constraints relates to a single string. Up to five strings are allowed.
(string) --