AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the CreateOTAUpdate operation. Creates an IoT OTA update on a target group of things or groups.

Requires permission to access the CreateOTAUpdate action.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.IoT.AmazonIoTRequest
      Amazon.IoT.Model.CreateOTAUpdateRequest

Namespace: Amazon.IoT.Model
Assembly: AWSSDK.IoT.dll
Version: 3.x.y.z

Syntax

C#
public class CreateOTAUpdateRequest : AmazonIoTRequest
         IAmazonWebServiceRequest

The CreateOTAUpdateRequest type exposes the following members

Constructors

NameDescription
Public Method CreateOTAUpdateRequest()

Properties

NameTypeDescription
Public Property AdditionalParameters System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property AdditionalParameters.

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

Public Property AwsJobAbortConfig Amazon.IoT.Model.AwsJobAbortConfig

Gets and sets the property AwsJobAbortConfig.

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

Public Property AwsJobExecutionsRolloutConfig Amazon.IoT.Model.AwsJobExecutionsRolloutConfig

Gets and sets the property AwsJobExecutionsRolloutConfig.

Configuration for the rollout of OTA updates.

Public Property AwsJobPresignedUrlConfig Amazon.IoT.Model.AwsJobPresignedUrlConfig

Gets and sets the property AwsJobPresignedUrlConfig.

Configuration information for pre-signed URLs.

Public Property AwsJobTimeoutConfig Amazon.IoT.Model.AwsJobTimeoutConfig

Gets and sets the property AwsJobTimeoutConfig.

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.

Public Property Description System.String

Gets and sets the property Description.

The description of the OTA update.

Public Property Files System.Collections.Generic.List<Amazon.IoT.Model.OTAUpdateFile>

Gets and sets the property Files.

The files to be streamed by the OTA update.

Public Property OtaUpdateId System.String

Gets and sets the property OtaUpdateId.

The ID of the OTA update to be created.

Public Property Protocols System.Collections.Generic.List<System.String>

Gets and sets the property Protocols.

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.

Public Property RoleArn System.String

Gets and sets the property RoleArn.

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.

Public Property Tags System.Collections.Generic.List<Amazon.IoT.Model.Tag>

Gets and sets the property Tags.

Metadata which can be used to manage updates.

Public Property Targets System.Collections.Generic.List<System.String>

Gets and sets the property Targets.

The devices targeted to receive OTA updates.

Public Property TargetSelection Amazon.IoT.TargetSelection

Gets and sets the property TargetSelection.

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.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5