Table Of Contents

Feedback

User Guide

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

[ aws . iot ]

get-ota-update

Description

Gets an OTA update.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  get-ota-update
--ota-update-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--ota-update-id (string)

The OTA update ID.

--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.

Output

otaUpdateInfo -> (structure)

The OTA update info.

otaUpdateId -> (string)

The OTA update ID.

otaUpdateArn -> (string)

The OTA update ARN.

creationDate -> (timestamp)

The date when the OTA update was created.

lastModifiedDate -> (timestamp)

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)

awsJobExecutionsRolloutConfig -> (structure)

Configuration for the rollout of OTA updates.

maximumPerMinute -> (integer)

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

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.

(structure)

Describes a file to be associated with an OTA update.

fileName -> (string)

The name of the file.

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)

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

Error information associated with the OTA update.

code -> (string)

The error code.

message -> (string)

The error message.

additionalParameters -> (map)

A collection of name/value pairs

key -> (string)

value -> (string)