2019/12/17 - AWS IoT - 2 updated api methods
Changes Update iot client to latest version
{'awsJobPresignedUrlConfig': {'expiresInSec': 'long'},
'protocols': ['MQTT | HTTP']}
Creates an AWS IoT OTAUpdate on a target group of things or groups.
See also: AWS API Documentation
Request Syntax
client.create_ota_update(
otaUpdateId='string',
description='string',
targets=[
'string',
],
protocols=[
'MQTT'|'HTTP',
],
targetSelection='CONTINUOUS'|'SNAPSHOT',
awsJobExecutionsRolloutConfig={
'maximumPerMinute': 123
},
awsJobPresignedUrlConfig={
'expiresInSec': 123
},
files=[
{
'fileName': 'string',
'fileVersion': 'string',
'fileLocation': {
'stream': {
'streamId': 'string',
'fileId': 123
},
's3Location': {
'bucket': 'string',
'key': 'string',
'version': 'string'
}
},
'codeSigning': {
'awsSignerJobId': 'string',
'startSigningJobParameter': {
'signingProfileParameter': {
'certificateArn': 'string',
'platform': 'string',
'certificatePathOnDevice': 'string'
},
'signingProfileName': 'string',
'destination': {
's3Destination': {
'bucket': 'string',
'prefix': 'string'
}
}
},
'customCodeSigning': {
'signature': {
'inlineDocument': b'bytes'
},
'certificateChain': {
'certificateName': 'string',
'inlineDocument': 'string'
},
'hashAlgorithm': 'string',
'signatureAlgorithm': 'string'
}
},
'attributes': {
'string': 'string'
}
},
],
roleArn='string',
additionalParameters={
'string': 'string'
},
tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The ID of the OTA update to be created.
string
The description of the OTA update.
list
[REQUIRED]
The targeted devices to receive OTA updates.
(string) --
list
The protocol used to transfer the OTA update image. Valid values are [HTTP], [MQTT], [HTTP, MQTT]. When both HTTP and MQTT are specified, the target device can choose the protocol.
(string) --
string
Specifies whether the update will continue to run (CONTINUOUS), or will be complete after all the things specified as targets have completed the update (SNAPSHOT). If continuous, the update may also be run on a thing when a change is detected in a target. For example, an update will run on a thing when the thing is added to a target group, even after the update was completed by all things originally in the group. Valid values: CONTINUOUS | SNAPSHOT.
dict
Configuration for the rollout of OTA updates.
maximumPerMinute (integer) --
The maximum number of OTA update job executions started per minute.
dict
Configuration information for pre-signed URLs.
expiresInSec (integer) --
How long (in seconds) pre-signed URLs are valid. Valid values are 60 - 3600, the default value is 1800 seconds. Pre-signed URLs are generated when a request for the job document is received.
list
[REQUIRED]
The files to be streamed by the OTA update.
(dict) --
Describes a file to be associated with an OTA update.
fileName (string) --
The name of the file.
fileVersion (string) --
The file version.
fileLocation (dict) --
The location of the updated firmware.
stream (dict) --
The stream that contains the OTA update.
streamId (string) --
The stream ID.
fileId (integer) --
The ID of a file associated with a stream.
s3Location (dict) --
The location of the updated firmware in S3.
bucket (string) --
The S3 bucket.
key (string) --
The S3 key.
version (string) --
The S3 bucket version.
codeSigning (dict) --
The code signing method of the file.
awsSignerJobId (string) --
The ID of the AWSSignerJob which was created to sign the file.
startSigningJobParameter (dict) --
Describes the code-signing job.
signingProfileParameter (dict) --
Describes the code-signing profile.
certificateArn (string) --
Certificate ARN.
platform (string) --
The hardware platform of your device.
certificatePathOnDevice (string) --
The location of the code-signing certificate on your device.
signingProfileName (string) --
The code-signing profile name.
destination (dict) --
The location to write the code-signed file.
s3Destination (dict) --
Describes the location in S3 of the updated firmware.
bucket (string) --
The S3 bucket that contains the updated firmware.
prefix (string) --
The S3 prefix.
customCodeSigning (dict) --
A custom method for code signing a file.
signature (dict) --
The signature for the file.
inlineDocument (bytes) --
A base64 encoded binary representation of the code signing signature.
certificateChain (dict) --
The certificate chain.
certificateName (string) --
The name of the certificate.
inlineDocument (string) --
A base64 encoded binary representation of the code signing certificate chain.
hashAlgorithm (string) --
The hash algorithm used to code sign the file.
signatureAlgorithm (string) --
The signature algorithm used to code sign the file.
attributes (dict) --
A list of name/attribute pairs.
(string) --
(string) --
string
[REQUIRED]
The IAM role that allows access to the AWS IoT Jobs service.
dict
A list of additional OTA update parameters which are name-value pairs.
(string) --
(string) --
list
Metadata which can be used to manage updates.
(dict) --
A set of key/value pairs that are used to manage the resource.
Key (string) --
The tag's key.
Value (string) --
The tag's value.
dict
Response Syntax
{
'otaUpdateId': 'string',
'awsIotJobId': 'string',
'otaUpdateArn': 'string',
'awsIotJobArn': 'string',
'otaUpdateStatus': 'CREATE_PENDING'|'CREATE_IN_PROGRESS'|'CREATE_COMPLETE'|'CREATE_FAILED'
}
Response Structure
(dict) --
otaUpdateId (string) --
The OTA update ID.
awsIotJobId (string) --
The AWS IoT job ID associated with the OTA update.
otaUpdateArn (string) --
The OTA update ARN.
awsIotJobArn (string) --
The AWS IoT job ARN associated with the OTA update.
otaUpdateStatus (string) --
The OTA update status.
{'otaUpdateInfo': {'awsJobPresignedUrlConfig': {'expiresInSec': 'long'},
'protocols': ['MQTT | HTTP']}}
Gets an OTA update.
See also: AWS API Documentation
Request Syntax
client.get_ota_update(
otaUpdateId='string'
)
string
[REQUIRED]
The OTA update ID.
dict
Response Syntax
{
'otaUpdateInfo': {
'otaUpdateId': 'string',
'otaUpdateArn': 'string',
'creationDate': datetime(2015, 1, 1),
'lastModifiedDate': datetime(2015, 1, 1),
'description': 'string',
'targets': [
'string',
],
'protocols': [
'MQTT'|'HTTP',
],
'awsJobExecutionsRolloutConfig': {
'maximumPerMinute': 123
},
'awsJobPresignedUrlConfig': {
'expiresInSec': 123
},
'targetSelection': 'CONTINUOUS'|'SNAPSHOT',
'otaUpdateFiles': [
{
'fileName': 'string',
'fileVersion': 'string',
'fileLocation': {
'stream': {
'streamId': 'string',
'fileId': 123
},
's3Location': {
'bucket': 'string',
'key': 'string',
'version': 'string'
}
},
'codeSigning': {
'awsSignerJobId': 'string',
'startSigningJobParameter': {
'signingProfileParameter': {
'certificateArn': 'string',
'platform': 'string',
'certificatePathOnDevice': 'string'
},
'signingProfileName': 'string',
'destination': {
's3Destination': {
'bucket': 'string',
'prefix': 'string'
}
}
},
'customCodeSigning': {
'signature': {
'inlineDocument': b'bytes'
},
'certificateChain': {
'certificateName': 'string',
'inlineDocument': 'string'
},
'hashAlgorithm': 'string',
'signatureAlgorithm': 'string'
}
},
'attributes': {
'string': 'string'
}
},
],
'otaUpdateStatus': 'CREATE_PENDING'|'CREATE_IN_PROGRESS'|'CREATE_COMPLETE'|'CREATE_FAILED',
'awsIotJobId': 'string',
'awsIotJobArn': 'string',
'errorInfo': {
'code': 'string',
'message': 'string'
},
'additionalParameters': {
'string': 'string'
}
}
}
Response Structure
(dict) --
otaUpdateInfo (dict) --
The OTA update info.
otaUpdateId (string) --
The OTA update ID.
otaUpdateArn (string) --
The OTA update ARN.
creationDate (datetime) --
The date when the OTA update was created.
lastModifiedDate (datetime) --
The date when the OTA update was last updated.
description (string) --
A description of the OTA update.
targets (list) --
The targets of the OTA update.
(string) --
protocols (list) --
The protocol used to transfer the OTA update image. Valid values are [HTTP], [MQTT], [HTTP, MQTT]. When both HTTP and MQTT are specified, the target device can choose the protocol.
(string) --
awsJobExecutionsRolloutConfig (dict) --
Configuration for the rollout of OTA updates.
maximumPerMinute (integer) --
The maximum number of OTA update job executions started per minute.
awsJobPresignedUrlConfig (dict) --
Configuration information for pre-signed URLs. Valid when protocols contains HTTP.
expiresInSec (integer) --
How long (in seconds) pre-signed URLs are valid. Valid values are 60 - 3600, the default value is 1800 seconds. Pre-signed URLs are generated when a request for the job document is received.
targetSelection (string) --
Specifies whether the OTA update will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the OTA update (SNAPSHOT). If continuous, the OTA update may also be run on a thing when a change is detected in a target. For example, an OTA update will run on a thing when the thing is added to a target group, even after the OTA update was completed by all things originally in the group.
otaUpdateFiles (list) --
A list of files associated with the OTA update.
(dict) --
Describes a file to be associated with an OTA update.
fileName (string) --
The name of the file.
fileVersion (string) --
The file version.
fileLocation (dict) --
The location of the updated firmware.
stream (dict) --
The stream that contains the OTA update.
streamId (string) --
The stream ID.
fileId (integer) --
The ID of a file associated with a stream.
s3Location (dict) --
The location of the updated firmware in S3.
bucket (string) --
The S3 bucket.
key (string) --
The S3 key.
version (string) --
The S3 bucket version.
codeSigning (dict) --
The code signing method of the file.
awsSignerJobId (string) --
The ID of the AWSSignerJob which was created to sign the file.
startSigningJobParameter (dict) --
Describes the code-signing job.
signingProfileParameter (dict) --
Describes the code-signing profile.
certificateArn (string) --
Certificate ARN.
platform (string) --
The hardware platform of your device.
certificatePathOnDevice (string) --
The location of the code-signing certificate on your device.
signingProfileName (string) --
The code-signing profile name.
destination (dict) --
The location to write the code-signed file.
s3Destination (dict) --
Describes the location in S3 of the updated firmware.
bucket (string) --
The S3 bucket that contains the updated firmware.
prefix (string) --
The S3 prefix.
customCodeSigning (dict) --
A custom method for code signing a file.
signature (dict) --
The signature for the file.
inlineDocument (bytes) --
A base64 encoded binary representation of the code signing signature.
certificateChain (dict) --
The certificate chain.
certificateName (string) --
The name of the certificate.
inlineDocument (string) --
A base64 encoded binary representation of the code signing certificate chain.
hashAlgorithm (string) --
The hash algorithm used to code sign the file.
signatureAlgorithm (string) --
The signature algorithm used to code sign the file.
attributes (dict) --
A list of name/attribute pairs.
(string) --
(string) --
otaUpdateStatus (string) --
The status of the OTA update.
awsIotJobId (string) --
The AWS IoT job ID associated with the OTA update.
awsIotJobArn (string) --
The AWS IoT job ARN associated with the OTA update.
errorInfo (dict) --
Error information associated with the OTA update.
code (string) --
The error code.
message (string) --
The error message.
additionalParameters (dict) --
A collection of name/value pairs
(string) --
(string) --