AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

CreateOTAUpdateInput

import "github.com/aws/aws-sdk-go/service/iot"

type CreateOTAUpdateInput struct { AdditionalParameters map[string]*string `locationName:"additionalParameters" type:"map"` AwsJobExecutionsRolloutConfig *AwsJobExecutionsRolloutConfig `locationName:"awsJobExecutionsRolloutConfig" type:"structure"` Description *string `locationName:"description" type:"string"` Files []*OTAUpdateFile `locationName:"files" min:"1" type:"list" required:"true"` OtaUpdateId *string `location:"uri" locationName:"otaUpdateId" min:"1" type:"string" required:"true"` RoleArn *string `locationName:"roleArn" min:"20" type:"string" required:"true"` TargetSelection *string `locationName:"targetSelection" type:"string" enum:"TargetSelection"` Targets []*string `locationName:"targets" min:"1" type:"list" required:"true"` }

AdditionalParameters

Type: map[string]*string

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

AwsJobExecutionsRolloutConfig

Configuration for the rollout of OTA updates.

Description

Type: *string

The description of the OTA update.

Files

Describes a file to be associated with an OTA update.

OtaUpdateId

Type: *string

The ID of the OTA update to be created.

OtaUpdateId is a required field

RoleArn

Type: *string

The IAM role that allows access to the AWS IoT Jobs service.

RoleArn is a required field

TargetSelection

Type: *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.

Targets

Type: []*string

The targeted devices to receive OTA updates.

Targets is a required field

Method

GoString

func (s CreateOTAUpdateInput) GoString() string

GoString returns the string representation

SetAdditionalParameters

func (s *CreateOTAUpdateInput) SetAdditionalParameters(v map[string]*string) *CreateOTAUpdateInput

SetAdditionalParameters sets the AdditionalParameters field's value.

SetAwsJobExecutionsRolloutConfig

func (s *CreateOTAUpdateInput) SetAwsJobExecutionsRolloutConfig(v *AwsJobExecutionsRolloutConfig) *CreateOTAUpdateInput

SetAwsJobExecutionsRolloutConfig sets the AwsJobExecutionsRolloutConfig field's value.

SetDescription

func (s *CreateOTAUpdateInput) SetDescription(v string) *CreateOTAUpdateInput

SetDescription sets the Description field's value.

SetFiles

func (s *CreateOTAUpdateInput) SetFiles(v []*OTAUpdateFile) *CreateOTAUpdateInput

SetFiles sets the Files field's value.

SetOtaUpdateId

func (s *CreateOTAUpdateInput) SetOtaUpdateId(v string) *CreateOTAUpdateInput

SetOtaUpdateId sets the OtaUpdateId field's value.

SetRoleArn

func (s *CreateOTAUpdateInput) SetRoleArn(v string) *CreateOTAUpdateInput

SetRoleArn sets the RoleArn field's value.

SetTargetSelection

func (s *CreateOTAUpdateInput) SetTargetSelection(v string) *CreateOTAUpdateInput

SetTargetSelection sets the TargetSelection field's value.

SetTargets

func (s *CreateOTAUpdateInput) SetTargets(v []*string) *CreateOTAUpdateInput

SetTargets sets the Targets field's value.

String

func (s CreateOTAUpdateInput) String() string

String returns the string representation

Validate

func (s *CreateOTAUpdateInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: