class Aws::IoT::Types::CreateOTAUpdateRequest

@return [Array<Types::Tag>]
Metadata which can be used to manage updates.
@!attribute [rw] tags
@return [Hash<String,String>]
pairs.
A list of additional OTA update parameters which are name-value
@!attribute [rw] additional_parameters
@return [String]
jobs and AWS Code Signing resources to create an OTA update job.
The IAM role that grants AWS IoT access to the Amazon S3, AWS IoT
@!attribute [rw] role_arn
@return [Array<Types::OTAUpdateFile>]
The files to be streamed by the OTA update.
@!attribute [rw] files
@return [Types::AwsJobTimeoutConfig]
set to ‘TIMED_OUT`.
terminal state before the timer expires, it will be automatically
to `IN_PROGRESS`. If the job execution status is not set to another
of the job. A timer is started when the job execution status is set
Specifies the amount of time each device has to finish its execution
@!attribute [rw] aws_job_timeout_config
@return [Types::AwsJobAbortConfig]
The criteria that determine when and how a job abort takes place.
@!attribute [rw] aws_job_abort_config
@return [Types::AwsJobPresignedUrlConfig]
Configuration information for pre-signed URLs.
@!attribute [rw] aws_job_presigned_url_config
@return [Types::AwsJobExecutionsRolloutConfig]
Configuration for the rollout of OTA updates.
@!attribute [rw] aws_job_executions_rollout_config
@return [String]
originally in the group. Valid values: CONTINUOUS | SNAPSHOT.
target group, even after the update was completed by all things
example, an update will run on a thing when the thing is added to a
be run on a thing when a change is detected in a target. For
completed the update (SNAPSHOT). If continuous, the update may also
will be complete after all the things specified as targets have
Specifies whether the update will continue to run (CONTINUOUS), or
@!attribute [rw] target_selection
@return [Array<String>]
specified, the target device can choose the protocol.<br>, [MQTT], [HTTP, MQTT]. When both HTTP and MQTT are
The protocol used to transfer the OTA update image. Valid values are
@!attribute [rw] protocols
@return [Array<String>]
The devices targeted to receive OTA updates.
@!attribute [rw] targets
@return [String]
The description of the OTA update.
@!attribute [rw] description
@return [String]
The ID of the OTA update to be created.
@!attribute [rw] ota_update_id
}
],
},
value: “TagValue”,
key: “TagKey”, # required
{
tags: [
},
“AttributeKey” => “Value”,
additional_parameters: {
role_arn: “RoleArn”, # required
],
},
},
“AttributeKey” => “Value”,
attributes: {
},
},
signature_algorithm: “SignatureAlgorithm”,
hash_algorithm: “HashAlgorithm”,
},
inline_document: “InlineDocument”,
certificate_name: “CertificateName”,
certificate_chain: {
},
inline_document: “data”,
signature: {
custom_code_signing: {
},
},
},
prefix: “Prefix”,
bucket: “S3Bucket”,
s3_destination: {
destination: {
signing_profile_name: “SigningProfileName”,
},
certificate_path_on_device: “CertificatePathOnDevice”,
platform: “Platform”,
certificate_arn: “CertificateArn”,
signing_profile_parameter: {
start_signing_job_parameter: {
aws_signer_job_id: “SigningJobId”,
code_signing: {
},
},
version: “S3Version”,
key: “S3Key”,
bucket: “S3Bucket”,
s3_location: {
},
file_id: 1,
stream_id: “StreamId”,
stream: {
file_location: {
file_version: “OTAUpdateFileVersion”,
file_type: 1,
file_name: “FileName”,
{
files: [ # required
},
in_progress_timeout_in_minutes: 1,
aws_job_timeout_config: {
},
],
},
min_number_of_executed_things: 1, # required
threshold_percentage: 1.0, # required
action: “CANCEL”, # required, accepts CANCEL
failure_type: “FAILED”, # required, accepts FAILED, REJECTED, TIMED_OUT, ALL
{
abort_criteria_list: [ # required
aws_job_abort_config: {
},
expires_in_sec: 1,
aws_job_presigned_url_config: {
},
},
},
number_of_succeeded_things: 1,
number_of_notified_things: 1,
rate_increase_criteria: { # required
increment_factor: 1.0, # required
base_rate_per_minute: 1, # required
exponential_rate: {
maximum_per_minute: 1,
aws_job_executions_rollout_config: {
target_selection: “CONTINUOUS”, # accepts CONTINUOUS, SNAPSHOT
protocols: [“MQTT”], # accepts MQTT, HTTP
targets: [“Target”], # required
description: “OTAUpdateDescription”,
ota_update_id: “OTAUpdateId”, # required
{
data as a hash:
@note When making an API call, you may pass CreateOTAUpdateRequest