Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . iot ]

create-ota-update

Description

Creates an IoT OTA update on a target group of things or groups.

Requires permission to access the CreateOTAUpdate action.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-ota-update
--ota-update-id <value>
[--description <value>]
--targets <value>
[--protocols <value>]
[--target-selection <value>]
[--aws-job-executions-rollout-config <value>]
[--aws-job-presigned-url-config <value>]
[--aws-job-abort-config <value>]
[--aws-job-timeout-config <value>]
--files <value>
--role-arn <value>
[--additional-parameters <value>]
[--tags <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--ota-update-id (string)

The ID of the OTA update to be created.

--description (string)

The description of the OTA update.

--targets (list)

The devices targeted to receive OTA updates.

(string)

Syntax:

"string" "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)

Syntax:

"string" "string" ...

Where valid values are:
  MQTT
  HTTP

--target-selection (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.

Possible values:

  • CONTINUOUS
  • SNAPSHOT

--aws-job-executions-rollout-config (structure)

Configuration for the rollout of OTA updates.

maximumPerMinute -> (integer)

The maximum number of OTA update job executions started per minute.

exponentialRate -> (structure)

The rate of increase for a job rollout. This parameter allows you to define an exponential rate increase 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 the job rollout. This is the initial rate of the rollout.

incrementFactor -> (double)

The rate of increase for a job rollout. The number of things notified is multiplied by this factor.

rateIncreaseCriteria -> (structure)

The criteria to initiate the increase in 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).

numberOfNotifiedThings -> (integer)

When this number of things have been notified, it will initiate an increase in the rollout rate.

numberOfSucceededThings -> (integer)

When this number of things have succeeded in their job execution, it will initiate an increase in the rollout rate.

Shorthand Syntax:

maximumPerMinute=integer,exponentialRate={baseRatePerMinute=integer,incrementFactor=double,rateIncreaseCriteria={numberOfNotifiedThings=integer,numberOfSucceededThings=integer}}

JSON Syntax:

{
  "maximumPerMinute": integer,
  "exponentialRate": {
    "baseRatePerMinute": integer,
    "incrementFactor": double,
    "rateIncreaseCriteria": {
      "numberOfNotifiedThings": integer,
      "numberOfSucceededThings": integer
    }
  }
}

--aws-job-presigned-url-config (structure)

Configuration information for pre-signed URLs.

expiresInSec -> (long)

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.

Shorthand Syntax:

expiresInSec=long

JSON Syntax:

{
  "expiresInSec": long
}

--aws-job-abort-config (structure)

The criteria that determine when and how a job abort takes place.

abortCriteriaList -> (list)

The list of criteria that determine when and how to abort the job.

(structure)

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 -> (double)

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.

Shorthand Syntax:

abortCriteriaList=[{failureType=string,action=string,thresholdPercentage=double,minNumberOfExecutedThings=integer},{failureType=string,action=string,thresholdPercentage=double,minNumberOfExecutedThings=integer}]

JSON Syntax:

{
  "abortCriteriaList": [
    {
      "failureType": "FAILED"|"REJECTED"|"TIMED_OUT"|"ALL",
      "action": "CANCEL",
      "thresholdPercentage": double,
      "minNumberOfExecutedThings": integer
    }
    ...
  ]
}

--aws-job-timeout-config (structure)

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 -> (long)

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.

Shorthand Syntax:

inProgressTimeoutInMinutes=long

JSON Syntax:

{
  "inProgressTimeoutInMinutes": long
}

--files (list)

The files to be streamed by the OTA update.

(structure)

Describes a file to be associated with an OTA update.

fileName -> (string)

The name of the file.

fileType -> (integer)

An integer value you can include in the job document to allow your devices to identify the type of file received from the cloud.

fileVersion -> (string)

The file version.

fileLocation -> (structure)

The location of the updated firmware.

stream -> (structure)

The stream that contains the OTA update.

streamId -> (string)

The stream ID.

fileId -> (integer)

The ID of a file associated with a stream.

s3Location -> (structure)

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 -> (structure)

The code signing method of the file.

awsSignerJobId -> (string)

The ID of the AWSSignerJob which was created to sign the file.

startSigningJobParameter -> (structure)

Describes the code-signing job.

signingProfileParameter -> (structure)

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 -> (structure)

The location to write the code-signed file.

s3Destination -> (structure)

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 -> (structure)

A custom method for code signing a file.

signature -> (structure)

The signature for the file.

inlineDocument -> (blob)

A base64 encoded binary representation of the code signing signature.

certificateChain -> (structure)

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 -> (map)

A list of name/attribute pairs.

key -> (string)

value -> (string)

JSON Syntax:

[
  {
    "fileName": "string",
    "fileType": integer,
    "fileVersion": "string",
    "fileLocation": {
      "stream": {
        "streamId": "string",
        "fileId": integer
      },
      "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": blob
        },
        "certificateChain": {
          "certificateName": "string",
          "inlineDocument": "string"
        },
        "hashAlgorithm": "string",
        "signatureAlgorithm": "string"
      }
    },
    "attributes": {"string": "string"
      ...}
  }
  ...
]

--role-arn (string)

The IAM role that grants Amazon Web Services IoT Core access to the Amazon S3, IoT jobs and Amazon Web Services Code Signing resources to create an OTA update job.

--additional-parameters (map)

A list of additional OTA update parameters which are name-value pairs.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--tags (list)

Metadata which can be used to manage updates.

(structure)

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.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To create an OTA update for use with Amazon FreeRTOS

The following create-ota-update example creates an AWS IoT OTAUpdate on a target group of things or groups. This is part of an Amazon FreeRTOS over-the-air update which makes it possible for you to deploy new firmware images to a single device or a group of devices.

aws iot create-ota-update \
    --cli-input-json file://create-ota-update.json

Contents of create-ota-update.json:

{
    "otaUpdateId": "ota12345",
    "description": "A critical update needed right away.",
    "targets": [
        "device1",
        "device2",
        "device3",
        "device4"
    ],
    "targetSelection": "SNAPSHOT",
    "awsJobExecutionsRolloutConfig": {
        "maximumPerMinute": 10
    },
    "files": [
        {
          "fileName": "firmware.bin",
          "fileLocation": {
            "stream": {
              "streamId": "004",
              "fileId":123
            }
          },
          "codeSigning": {
            "awsSignerJobId": "48c67f3c-63bb-4f92-a98a-4ee0fbc2bef6"
          }
        }
    ]
    "roleArn": "arn:aws:iam:123456789012:role/service-role/my_ota_role"
}

Output:

{
     "otaUpdateId": "ota12345",
     "awsIotJobId": "job54321",
     "otaUpdateArn": "arn:aws:iot:us-west-2:123456789012:otaupdate/itsaupdate",
     "awsIotJobArn": "arn:aws:iot:us-west-2:123456789012:job/itsajob",
     "otaUpdateStatus": "CREATE_IN_PROGRESS"
}

For more information, see CreateOTAUpdate in the AWS IoT API Reference.

Output

otaUpdateId -> (string)

The OTA update ID.

awsIotJobId -> (string)

The IoT job ID associated with the OTA update.

otaUpdateArn -> (string)

The OTA update ARN.

awsIotJobArn -> (string)

The IoT job ARN associated with the OTA update.

otaUpdateStatus -> (string)

The OTA update status.