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.

CreateJobInput

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

type CreateJobInput struct { AbortConfig *AbortConfig `locationName:"abortConfig" type:"structure"` Description *string `locationName:"description" type:"string"` Document *string `locationName:"document" type:"string"` DocumentSource *string `locationName:"documentSource" min:"1" type:"string"` JobExecutionsRolloutConfig *JobExecutionsRolloutConfig `locationName:"jobExecutionsRolloutConfig" type:"structure"` JobId *string `location:"uri" locationName:"jobId" min:"1" type:"string" required:"true"` PresignedUrlConfig *PresignedUrlConfig `locationName:"presignedUrlConfig" type:"structure"` Tags []*Tag `locationName:"tags" type:"list"` TargetSelection *string `locationName:"targetSelection" type:"string" enum:"TargetSelection"` Targets []*string `locationName:"targets" min:"1" type:"list" required:"true"` TimeoutConfig *TimeoutConfig `locationName:"timeoutConfig" type:"structure"` }

AbortConfig

Details of abort criteria to abort the job.

Description

Type: *string

A short text description of the job.

Document

Type: *string

The job document.

If the job document resides in an S3 bucket, you must use a placeholder link when specifying the document.

The placeholder link is of the following form:

${aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key}

where bucket is your bucket name and key is the object in the bucket to which you are linking.

DocumentSource

Type: *string

An S3 link to the job document.

JobExecutionsRolloutConfig

Allows you to create a staged rollout of a job.

JobId

Type: *string

A job identifier which must be unique for your AWS account. We recommend using a UUID. Alpha-numeric characters, "-" and "_" are valid for use here.

JobId is a required field

PresignedUrlConfig

Configuration for pre-signed S3 URLs.

Tags

A set of key/value pairs that are used to manage the resource.

TargetSelection

Type: *string

Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group.

Targets

Type: []*string

A list of things and thing groups to which the job should be sent.

Targets is a required field

TimeoutConfig

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.

Method

GoString

func (s CreateJobInput) GoString() string

GoString returns the string representation

SetAbortConfig

func (s *CreateJobInput) SetAbortConfig(v *AbortConfig) *CreateJobInput

SetAbortConfig sets the AbortConfig field's value.

SetDescription

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

SetDescription sets the Description field's value.

SetDocument

func (s *CreateJobInput) SetDocument(v string) *CreateJobInput

SetDocument sets the Document field's value.

SetDocumentSource

func (s *CreateJobInput) SetDocumentSource(v string) *CreateJobInput

SetDocumentSource sets the DocumentSource field's value.

SetJobExecutionsRolloutConfig

func (s *CreateJobInput) SetJobExecutionsRolloutConfig(v *JobExecutionsRolloutConfig) *CreateJobInput

SetJobExecutionsRolloutConfig sets the JobExecutionsRolloutConfig field's value.

SetJobId

func (s *CreateJobInput) SetJobId(v string) *CreateJobInput

SetJobId sets the JobId field's value.

SetPresignedUrlConfig

func (s *CreateJobInput) SetPresignedUrlConfig(v *PresignedUrlConfig) *CreateJobInput

SetPresignedUrlConfig sets the PresignedUrlConfig field's value.

SetTags

func (s *CreateJobInput) SetTags(v []*Tag) *CreateJobInput

SetTags sets the Tags field's value.

SetTargetSelection

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

SetTargetSelection sets the TargetSelection field's value.

SetTargets

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

SetTargets sets the Targets field's value.

SetTimeoutConfig

func (s *CreateJobInput) SetTimeoutConfig(v *TimeoutConfig) *CreateJobInput

SetTimeoutConfig sets the TimeoutConfig field's value.

String

func (s CreateJobInput) String() string

String returns the string representation

Validate

func (s *CreateJobInput) Validate() error

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

On this page: