iotjobsdataplane

package
v1.29.33 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 26, 2020 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

Package iotjobsdataplane provides the client and types for making API requests to AWS IoT Jobs Data Plane.

AWS IoT Jobs is a service that allows you to define a set of jobs — remote operations that are sent to and executed on one or more devices connected to AWS IoT. For example, you can define a job that instructs a set of devices to download and install application or firmware updates, reboot, rotate certificates, or perform remote troubleshooting operations.

To create a job, you make a job document which is a description of the remote operations to be performed, and you specify a list of targets that should perform the operations. The targets can be individual things, thing groups or both.

AWS IoT Jobs sends a message to inform the targets that a job is available. The target starts the execution of the job by downloading the job document, performing the operations it specifies, and reporting its progress to AWS IoT. The Jobs service provides commands to track the progress of a job on a specific target and for all the targets of the job

See https://docs.aws.amazon.com/goto/WebAPI/iot-jobs-data-2017-09-29 for more information on this service.

See iotjobsdataplane package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/iotjobsdataplane/

Using the Client

To contact AWS IoT Jobs Data Plane with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AWS IoT Jobs Data Plane client IoTJobsDataPlane for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/iotjobsdataplane/#New

Index

Constants

View Source 
const (
	// JobExecutionStatusQueued is a JobExecutionStatus enum value
	JobExecutionStatusQueued = "QUEUED"

	// JobExecutionStatusInProgress is a JobExecutionStatus enum value
	JobExecutionStatusInProgress = "IN_PROGRESS"

	// JobExecutionStatusSucceeded is a JobExecutionStatus enum value
	JobExecutionStatusSucceeded = "SUCCEEDED"

	// JobExecutionStatusFailed is a JobExecutionStatus enum value
	JobExecutionStatusFailed = "FAILED"

	// JobExecutionStatusTimedOut is a JobExecutionStatus enum value
	JobExecutionStatusTimedOut = "TIMED_OUT"

	// JobExecutionStatusRejected is a JobExecutionStatus enum value
	JobExecutionStatusRejected = "REJECTED"

	// JobExecutionStatusRemoved is a JobExecutionStatus enum value
	JobExecutionStatusRemoved = "REMOVED"

	// JobExecutionStatusCanceled is a JobExecutionStatus enum value
	JobExecutionStatusCanceled = "CANCELED"
)
View Source 
const (

	// ErrCodeCertificateValidationException for service response error code
	// "CertificateValidationException".
	//
	// The certificate is invalid.
	ErrCodeCertificateValidationException = "CertificateValidationException"

	// ErrCodeInvalidRequestException for service response error code
	// "InvalidRequestException".
	//
	// The contents of the request were invalid. For example, this code is returned
	// when an UpdateJobExecution request contains invalid status details. The message
	// contains details about the error.
	ErrCodeInvalidRequestException = "InvalidRequestException"

	// ErrCodeInvalidStateTransitionException for service response error code
	// "InvalidStateTransitionException".
	//
	// An update attempted to change the job execution to a state that is invalid
	// because of the job execution's current state (for example, an attempt to
	// change a request in state SUCCESS to state IN_PROGRESS). In this case, the
	// body of the error message also contains the executionState field.
	ErrCodeInvalidStateTransitionException = "InvalidStateTransitionException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The specified resource does not exist.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeServiceUnavailableException for service response error code
	// "ServiceUnavailableException".
	//
	// The service is temporarily unavailable.
	ErrCodeServiceUnavailableException = "ServiceUnavailableException"

	// ErrCodeTerminalStateException for service response error code
	// "TerminalStateException".
	//
	// The job is in a terminal state.
	ErrCodeTerminalStateException = "TerminalStateException"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	//
	// The rate exceeds the limit.
	ErrCodeThrottlingException = "ThrottlingException"
)
View Source 
const (
	ServiceName = "data.jobs.iot"       // Name of service.
	EndpointsID = ServiceName           // ID to lookup a service endpoint with.
	ServiceID   = "IoT Jobs Data Plane" // ServiceID is a unique identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

This section is empty.

Types

type CertificateValidationException 

type CertificateValidationException struct {

	// Additional information about the exception.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The certificate is invalid.

func (CertificateValidationException) Code 

func (s CertificateValidationException) Code() string

Code returns the exception type name.

func (CertificateValidationException) Error 

func (s CertificateValidationException) Error() string

func (CertificateValidationException) GoString 

func (s CertificateValidationException) GoString() string

GoString returns the string representation

func (CertificateValidationException) Message 

func (s CertificateValidationException) Message() string

Message returns the exception's message.

func (CertificateValidationException) OrigErr 

func (s CertificateValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (CertificateValidationException) RequestID 

func (s CertificateValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (CertificateValidationException) StatusCode 

func (s CertificateValidationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (CertificateValidationException) String 

func (s CertificateValidationException) String() string

String returns the string representation

type DescribeJobExecutionInput 

type DescribeJobExecutionInput struct {

	// Optional. A number that identifies a particular job execution on a particular
	// device. If not specified, the latest job execution is returned.
	ExecutionNumber *int64 `location:"querystring" locationName:"executionNumber" type:"long"`

	// Optional. When set to true, the response contains the job document. The default
	// is false.
	IncludeJobDocument *bool `location:"querystring" locationName:"includeJobDocument" type:"boolean"`

	// The unique identifier assigned to this job when it was created.
	//
	// JobId is a required field
	JobId *string `location:"uri" locationName:"jobId" type:"string" required:"true"`

	// The thing name associated with the device the job execution is running on.
	//
	// ThingName is a required field
	ThingName *string `location:"uri" locationName:"thingName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeJobExecutionInput) GoString 

func (s DescribeJobExecutionInput) GoString() string

GoString returns the string representation

func (*DescribeJobExecutionInput) SetExecutionNumber 

func (s *DescribeJobExecutionInput) SetExecutionNumber(v int64) *DescribeJobExecutionInput

SetExecutionNumber sets the ExecutionNumber field's value.

func (*DescribeJobExecutionInput) SetIncludeJobDocument 

func (s *DescribeJobExecutionInput) SetIncludeJobDocument(v bool) *DescribeJobExecutionInput

SetIncludeJobDocument sets the IncludeJobDocument field's value.

func (*DescribeJobExecutionInput) SetJobId 

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

SetJobId sets the JobId field's value.

func (*DescribeJobExecutionInput) SetThingName 

func (s *DescribeJobExecutionInput) SetThingName(v string) *DescribeJobExecutionInput

SetThingName sets the ThingName field's value.

func (DescribeJobExecutionInput) String 

func (s DescribeJobExecutionInput) String() string

String returns the string representation

func (*DescribeJobExecutionInput) Validate 

func (s *DescribeJobExecutionInput) Validate() error

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

type DescribeJobExecutionOutput 

type DescribeJobExecutionOutput struct {

	// Contains data about a job execution.
	Execution *JobExecution `locationName:"execution" type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeJobExecutionOutput) GoString 

func (s DescribeJobExecutionOutput) GoString() string

GoString returns the string representation

func (*DescribeJobExecutionOutput) SetExecution 

func (s *DescribeJobExecutionOutput) SetExecution(v *JobExecution) *DescribeJobExecutionOutput

SetExecution sets the Execution field's value.

func (DescribeJobExecutionOutput) String 

func (s DescribeJobExecutionOutput) String() string

String returns the string representation

type GetPendingJobExecutionsInput 

type GetPendingJobExecutionsInput struct {

	// The name of the thing that is executing the job.
	//
	// ThingName is a required field
	ThingName *string `location:"uri" locationName:"thingName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetPendingJobExecutionsInput) GoString 

func (s GetPendingJobExecutionsInput) GoString() string

GoString returns the string representation

func (*GetPendingJobExecutionsInput) SetThingName 

func (s *GetPendingJobExecutionsInput) SetThingName(v string) *GetPendingJobExecutionsInput

SetThingName sets the ThingName field's value.

func (GetPendingJobExecutionsInput) String 

func (s GetPendingJobExecutionsInput) String() string

String returns the string representation

func (*GetPendingJobExecutionsInput) Validate 

func (s *GetPendingJobExecutionsInput) Validate() error

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

type GetPendingJobExecutionsOutput 

type GetPendingJobExecutionsOutput struct {

	// A list of JobExecutionSummary objects with status IN_PROGRESS.
	InProgressJobs []*JobExecutionSummary `locationName:"inProgressJobs" type:"list"`

	// A list of JobExecutionSummary objects with status QUEUED.
	QueuedJobs []*JobExecutionSummary `locationName:"queuedJobs" type:"list"`
	// contains filtered or unexported fields
}

func (GetPendingJobExecutionsOutput) GoString 

func (s GetPendingJobExecutionsOutput) GoString() string

GoString returns the string representation

func (*GetPendingJobExecutionsOutput) SetInProgressJobs 

func (s *GetPendingJobExecutionsOutput) SetInProgressJobs(v []*JobExecutionSummary) *GetPendingJobExecutionsOutput

SetInProgressJobs sets the InProgressJobs field's value.

func (*GetPendingJobExecutionsOutput) SetQueuedJobs 

func (s *GetPendingJobExecutionsOutput) SetQueuedJobs(v []*JobExecutionSummary) *GetPendingJobExecutionsOutput

SetQueuedJobs sets the QueuedJobs field's value.

func (GetPendingJobExecutionsOutput) String 

func (s GetPendingJobExecutionsOutput) String() string

String returns the string representation

type InvalidRequestException 

type InvalidRequestException struct {

	// The message for the exception.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The contents of the request were invalid. For example, this code is returned when an UpdateJobExecution request contains invalid status details. The message contains details about the error.

func (InvalidRequestException) Code 

func (s InvalidRequestException) Code() string

Code returns the exception type name.

func (InvalidRequestException) Error 

func (s InvalidRequestException) Error() string

func (InvalidRequestException) GoString 

func (s InvalidRequestException) GoString() string

GoString returns the string representation

func (InvalidRequestException) Message 

func (s InvalidRequestException) Message() string

Message returns the exception's message.

func (InvalidRequestException) OrigErr 

func (s InvalidRequestException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (InvalidRequestException) RequestID 

func (s InvalidRequestException) RequestID() string

RequestID returns the service's response RequestID for request.

func (InvalidRequestException) StatusCode 

func (s InvalidRequestException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidRequestException) String 

func (s InvalidRequestException) String() string

String returns the string representation

type InvalidStateTransitionException 

type InvalidStateTransitionException struct {
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

An update attempted to change the job execution to a state that is invalid because of the job execution's current state (for example, an attempt to change a request in state SUCCESS to state IN_PROGRESS). In this case, the body of the error message also contains the executionState field.

func (InvalidStateTransitionException) Code 

func (s InvalidStateTransitionException) Code() string

Code returns the exception type name.

func (InvalidStateTransitionException) Error 

func (s InvalidStateTransitionException) Error() string

func (InvalidStateTransitionException) GoString 

func (s InvalidStateTransitionException) GoString() string

GoString returns the string representation

func (InvalidStateTransitionException) Message 

func (s InvalidStateTransitionException) Message() string

Message returns the exception's message.

func (InvalidStateTransitionException) OrigErr 

func (s InvalidStateTransitionException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (InvalidStateTransitionException) RequestID 

func (s InvalidStateTransitionException) RequestID() string

RequestID returns the service's response RequestID for request.

func (InvalidStateTransitionException) StatusCode 

func (s InvalidStateTransitionException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidStateTransitionException) String 

func (s InvalidStateTransitionException) String() string

String returns the string representation

type IoTJobsDataPlane 

type IoTJobsDataPlane struct {
	*client.Client
}

IoTJobsDataPlane provides the API operation methods for making requests to AWS IoT Jobs Data Plane. See this package's package overview docs for details on the service.

IoTJobsDataPlane methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *IoTJobsDataPlane

New creates a new instance of the IoTJobsDataPlane client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

mySession := session.Must(session.NewSession())

// Create a IoTJobsDataPlane client from just a session.
svc := iotjobsdataplane.New(mySession)

// Create a IoTJobsDataPlane client with additional configuration
svc := iotjobsdataplane.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*IoTJobsDataPlane) DescribeJobExecution 

func (c *IoTJobsDataPlane) DescribeJobExecution(input *DescribeJobExecutionInput) (*DescribeJobExecutionOutput, error)

DescribeJobExecution API operation for AWS IoT Jobs Data Plane.

Gets details of a job execution.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Jobs Data Plane's API operation DescribeJobExecution for usage and error information.

Returned Error Types:

  • InvalidRequestException The contents of the request were invalid. For example, this code is returned when an UpdateJobExecution request contains invalid status details. The message contains details about the error.

  • ResourceNotFoundException The specified resource does not exist.

  • ThrottlingException The rate exceeds the limit.

  • ServiceUnavailableException The service is temporarily unavailable.

  • CertificateValidationException The certificate is invalid.

  • TerminalStateException The job is in a terminal state.

See also, https://docs.aws.amazon.com/goto/WebAPI/iot-jobs-data-2017-09-29/DescribeJobExecution

func (*IoTJobsDataPlane) DescribeJobExecutionRequest 

func (c *IoTJobsDataPlane) DescribeJobExecutionRequest(input *DescribeJobExecutionInput) (req *request.Request, output *DescribeJobExecutionOutput)

DescribeJobExecutionRequest generates a "aws/request.Request" representing the client's request for the DescribeJobExecution operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeJobExecution for more information on using the DescribeJobExecution API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeJobExecutionRequest method.
req, resp := client.DescribeJobExecutionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iot-jobs-data-2017-09-29/DescribeJobExecution

func (*IoTJobsDataPlane) DescribeJobExecutionWithContext 

func (c *IoTJobsDataPlane) DescribeJobExecutionWithContext(ctx aws.Context, input *DescribeJobExecutionInput, opts ...request.Option) (*DescribeJobExecutionOutput, error)

DescribeJobExecutionWithContext is the same as DescribeJobExecution with the addition of the ability to pass a context and additional request options.

See DescribeJobExecution for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTJobsDataPlane) GetPendingJobExecutions 

func (c *IoTJobsDataPlane) GetPendingJobExecutions(input *GetPendingJobExecutionsInput) (*GetPendingJobExecutionsOutput, error)

GetPendingJobExecutions API operation for AWS IoT Jobs Data Plane.

Gets the list of all jobs for a thing that are not in a terminal status.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Jobs Data Plane's API operation GetPendingJobExecutions for usage and error information.

Returned Error Types:

  • InvalidRequestException The contents of the request were invalid. For example, this code is returned when an UpdateJobExecution request contains invalid status details. The message contains details about the error.

  • ResourceNotFoundException The specified resource does not exist.

  • ThrottlingException The rate exceeds the limit.

  • ServiceUnavailableException The service is temporarily unavailable.

  • CertificateValidationException The certificate is invalid.

See also, https://docs.aws.amazon.com/goto/WebAPI/iot-jobs-data-2017-09-29/GetPendingJobExecutions

func (*IoTJobsDataPlane) GetPendingJobExecutionsRequest 

func (c *IoTJobsDataPlane) GetPendingJobExecutionsRequest(input *GetPendingJobExecutionsInput) (req *request.Request, output *GetPendingJobExecutionsOutput)

GetPendingJobExecutionsRequest generates a "aws/request.Request" representing the client's request for the GetPendingJobExecutions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetPendingJobExecutions for more information on using the GetPendingJobExecutions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetPendingJobExecutionsRequest method.
req, resp := client.GetPendingJobExecutionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iot-jobs-data-2017-09-29/GetPendingJobExecutions

func (*IoTJobsDataPlane) GetPendingJobExecutionsWithContext 

func (c *IoTJobsDataPlane) GetPendingJobExecutionsWithContext(ctx aws.Context, input *GetPendingJobExecutionsInput, opts ...request.Option) (*GetPendingJobExecutionsOutput, error)

GetPendingJobExecutionsWithContext is the same as GetPendingJobExecutions with the addition of the ability to pass a context and additional request options.

See GetPendingJobExecutions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTJobsDataPlane) StartNextPendingJobExecution 

func (c *IoTJobsDataPlane) StartNextPendingJobExecution(input *StartNextPendingJobExecutionInput) (*StartNextPendingJobExecutionOutput, error)

StartNextPendingJobExecution API operation for AWS IoT Jobs Data Plane.

Gets and starts the next pending (status IN_PROGRESS or QUEUED) job execution for a thing.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Jobs Data Plane's API operation StartNextPendingJobExecution for usage and error information.

Returned Error Types:

  • InvalidRequestException The contents of the request were invalid. For example, this code is returned when an UpdateJobExecution request contains invalid status details. The message contains details about the error.

  • ResourceNotFoundException The specified resource does not exist.

  • ThrottlingException The rate exceeds the limit.

  • ServiceUnavailableException The service is temporarily unavailable.

  • CertificateValidationException The certificate is invalid.

See also, https://docs.aws.amazon.com/goto/WebAPI/iot-jobs-data-2017-09-29/StartNextPendingJobExecution

func (*IoTJobsDataPlane) StartNextPendingJobExecutionRequest 

func (c *IoTJobsDataPlane) StartNextPendingJobExecutionRequest(input *StartNextPendingJobExecutionInput) (req *request.Request, output *StartNextPendingJobExecutionOutput)

StartNextPendingJobExecutionRequest generates a "aws/request.Request" representing the client's request for the StartNextPendingJobExecution operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartNextPendingJobExecution for more information on using the StartNextPendingJobExecution API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the StartNextPendingJobExecutionRequest method.
req, resp := client.StartNextPendingJobExecutionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iot-jobs-data-2017-09-29/StartNextPendingJobExecution

func (*IoTJobsDataPlane) StartNextPendingJobExecutionWithContext 

func (c *IoTJobsDataPlane) StartNextPendingJobExecutionWithContext(ctx aws.Context, input *StartNextPendingJobExecutionInput, opts ...request.Option) (*StartNextPendingJobExecutionOutput, error)

StartNextPendingJobExecutionWithContext is the same as StartNextPendingJobExecution with the addition of the ability to pass a context and additional request options.

See StartNextPendingJobExecution for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTJobsDataPlane) UpdateJobExecution 

func (c *IoTJobsDataPlane) UpdateJobExecution(input *UpdateJobExecutionInput) (*UpdateJobExecutionOutput, error)

UpdateJobExecution API operation for AWS IoT Jobs Data Plane.

Updates the status of a job execution.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Jobs Data Plane's API operation UpdateJobExecution for usage and error information.

Returned Error Types:

  • InvalidRequestException The contents of the request were invalid. For example, this code is returned when an UpdateJobExecution request contains invalid status details. The message contains details about the error.

  • ResourceNotFoundException The specified resource does not exist.

  • ThrottlingException The rate exceeds the limit.

  • ServiceUnavailableException The service is temporarily unavailable.

  • CertificateValidationException The certificate is invalid.

  • InvalidStateTransitionException An update attempted to change the job execution to a state that is invalid because of the job execution's current state (for example, an attempt to change a request in state SUCCESS to state IN_PROGRESS). In this case, the body of the error message also contains the executionState field.

See also, https://docs.aws.amazon.com/goto/WebAPI/iot-jobs-data-2017-09-29/UpdateJobExecution

func (*IoTJobsDataPlane) UpdateJobExecutionRequest 

func (c *IoTJobsDataPlane) UpdateJobExecutionRequest(input *UpdateJobExecutionInput) (req *request.Request, output *UpdateJobExecutionOutput)

UpdateJobExecutionRequest generates a "aws/request.Request" representing the client's request for the UpdateJobExecution operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateJobExecution for more information on using the UpdateJobExecution API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateJobExecutionRequest method.
req, resp := client.UpdateJobExecutionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iot-jobs-data-2017-09-29/UpdateJobExecution

func (*IoTJobsDataPlane) UpdateJobExecutionWithContext 

func (c *IoTJobsDataPlane) UpdateJobExecutionWithContext(ctx aws.Context, input *UpdateJobExecutionInput, opts ...request.Option) (*UpdateJobExecutionOutput, error)

UpdateJobExecutionWithContext is the same as UpdateJobExecution with the addition of the ability to pass a context and additional request options.

See UpdateJobExecution for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type JobExecution 

type JobExecution struct {

	// The estimated number of seconds that remain before the job execution status
	// will be changed to TIMED_OUT.
	ApproximateSecondsBeforeTimedOut *int64 `locationName:"approximateSecondsBeforeTimedOut" type:"long"`

	// A number that identifies a particular job execution on a particular device.
	// It can be used later in commands that return or update job execution information.
	ExecutionNumber *int64 `locationName:"executionNumber" type:"long"`

	// The content of the job document.
	JobDocument *string `locationName:"jobDocument" type:"string"`

	// The unique identifier you assigned to this job when it was created.
	JobId *string `locationName:"jobId" min:"1" type:"string"`

	// The time, in milliseconds since the epoch, when the job execution was last
	// updated.
	LastUpdatedAt *int64 `locationName:"lastUpdatedAt" type:"long"`

	// The time, in milliseconds since the epoch, when the job execution was enqueued.
	QueuedAt *int64 `locationName:"queuedAt" type:"long"`

	// The time, in milliseconds since the epoch, when the job execution was started.
	StartedAt *int64 `locationName:"startedAt" type:"long"`

	// The status of the job execution. Can be one of: "QUEUED", "IN_PROGRESS",
	// "FAILED", "SUCCESS", "CANCELED", "REJECTED", or "REMOVED".
	Status *string `locationName:"status" type:"string" enum:"JobExecutionStatus"`

	// A collection of name/value pairs that describe the status of the job execution.
	StatusDetails map[string]*string `locationName:"statusDetails" type:"map"`

	// The name of the thing that is executing the job.
	ThingName *string `locationName:"thingName" min:"1" type:"string"`

	// The version of the job execution. Job execution versions are incremented
	// each time they are updated by a device.
	VersionNumber *int64 `locationName:"versionNumber" type:"long"`
	// contains filtered or unexported fields
}

Contains data about a job execution.

func (JobExecution) GoString 

func (s JobExecution) GoString() string

GoString returns the string representation

func (*JobExecution) SetApproximateSecondsBeforeTimedOut 

func (s *JobExecution) SetApproximateSecondsBeforeTimedOut(v int64) *JobExecution

SetApproximateSecondsBeforeTimedOut sets the ApproximateSecondsBeforeTimedOut field's value.

func (*JobExecution) SetExecutionNumber 

func (s *JobExecution) SetExecutionNumber(v int64) *JobExecution

SetExecutionNumber sets the ExecutionNumber field's value.

func (*JobExecution) SetJobDocument 

func (s *JobExecution) SetJobDocument(v string) *JobExecution

SetJobDocument sets the JobDocument field's value.

func (*JobExecution) SetJobId 

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

SetJobId sets the JobId field's value.

func (*JobExecution) SetLastUpdatedAt 

func (s *JobExecution) SetLastUpdatedAt(v int64) *JobExecution

SetLastUpdatedAt sets the LastUpdatedAt field's value.

func (*JobExecution) SetQueuedAt 

func (s *JobExecution) SetQueuedAt(v int64) *JobExecution

SetQueuedAt sets the QueuedAt field's value.

func (*JobExecution) SetStartedAt 

func (s *JobExecution) SetStartedAt(v int64) *JobExecution

SetStartedAt sets the StartedAt field's value.

func (*JobExecution) SetStatus 

func (s *JobExecution) SetStatus(v string) *JobExecution

SetStatus sets the Status field's value.

func (*JobExecution) SetStatusDetails 

func (s *JobExecution) SetStatusDetails(v map[string]*string) *JobExecution

SetStatusDetails sets the StatusDetails field's value.

func (*JobExecution) SetThingName 

func (s *JobExecution) SetThingName(v string) *JobExecution

SetThingName sets the ThingName field's value.

func (*JobExecution) SetVersionNumber 

func (s *JobExecution) SetVersionNumber(v int64) *JobExecution

SetVersionNumber sets the VersionNumber field's value.

func (JobExecution) String 

func (s JobExecution) String() string

String returns the string representation

type JobExecutionState 

type JobExecutionState struct {

	// The status of the job execution. Can be one of: "QUEUED", "IN_PROGRESS",
	// "FAILED", "SUCCESS", "CANCELED", "REJECTED", or "REMOVED".
	Status *string `locationName:"status" type:"string" enum:"JobExecutionStatus"`

	// A collection of name/value pairs that describe the status of the job execution.
	StatusDetails map[string]*string `locationName:"statusDetails" type:"map"`

	// The version of the job execution. Job execution versions are incremented
	// each time they are updated by a device.
	VersionNumber *int64 `locationName:"versionNumber" type:"long"`
	// contains filtered or unexported fields
}

Contains data about the state of a job execution.

func (JobExecutionState) GoString 

func (s JobExecutionState) GoString() string

GoString returns the string representation

func (*JobExecutionState) SetStatus 

func (s *JobExecutionState) SetStatus(v string) *JobExecutionState

SetStatus sets the Status field's value.

func (*JobExecutionState) SetStatusDetails 

func (s *JobExecutionState) SetStatusDetails(v map[string]*string) *JobExecutionState

SetStatusDetails sets the StatusDetails field's value.

func (*JobExecutionState) SetVersionNumber 

func (s *JobExecutionState) SetVersionNumber(v int64) *JobExecutionState

SetVersionNumber sets the VersionNumber field's value.

func (JobExecutionState) String 

func (s JobExecutionState) String() string

String returns the string representation

type JobExecutionSummary 

type JobExecutionSummary struct {

	// A number that identifies a particular job execution on a particular device.
	ExecutionNumber *int64 `locationName:"executionNumber" type:"long"`

	// The unique identifier you assigned to this job when it was created.
	JobId *string `locationName:"jobId" min:"1" type:"string"`

	// The time, in milliseconds since the epoch, when the job execution was last
	// updated.
	LastUpdatedAt *int64 `locationName:"lastUpdatedAt" type:"long"`

	// The time, in milliseconds since the epoch, when the job execution was enqueued.
	QueuedAt *int64 `locationName:"queuedAt" type:"long"`

	// The time, in milliseconds since the epoch, when the job execution started.
	StartedAt *int64 `locationName:"startedAt" type:"long"`

	// The version of the job execution. Job execution versions are incremented
	// each time AWS IoT Jobs receives an update from a device.
	VersionNumber *int64 `locationName:"versionNumber" type:"long"`
	// contains filtered or unexported fields
}

Contains a subset of information about a job execution.

func (JobExecutionSummary) GoString 

func (s JobExecutionSummary) GoString() string

GoString returns the string representation

func (*JobExecutionSummary) SetExecutionNumber 

func (s *JobExecutionSummary) SetExecutionNumber(v int64) *JobExecutionSummary

SetExecutionNumber sets the ExecutionNumber field's value.

func (*JobExecutionSummary) SetJobId 

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

SetJobId sets the JobId field's value.

func (*JobExecutionSummary) SetLastUpdatedAt 

func (s *JobExecutionSummary) SetLastUpdatedAt(v int64) *JobExecutionSummary

SetLastUpdatedAt sets the LastUpdatedAt field's value.

func (*JobExecutionSummary) SetQueuedAt 

func (s *JobExecutionSummary) SetQueuedAt(v int64) *JobExecutionSummary

SetQueuedAt sets the QueuedAt field's value.

func (*JobExecutionSummary) SetStartedAt 

func (s *JobExecutionSummary) SetStartedAt(v int64) *JobExecutionSummary

SetStartedAt sets the StartedAt field's value.

func (*JobExecutionSummary) SetVersionNumber 

func (s *JobExecutionSummary) SetVersionNumber(v int64) *JobExecutionSummary

SetVersionNumber sets the VersionNumber field's value.

func (JobExecutionSummary) String 

func (s JobExecutionSummary) String() string

String returns the string representation

type ResourceNotFoundException 

type ResourceNotFoundException struct {

	// The message for the exception.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The specified resource does not exist.

func (ResourceNotFoundException) Code 

func (s ResourceNotFoundException) Code() string

Code returns the exception type name.

func (ResourceNotFoundException) Error 

func (s ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString 

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation

func (ResourceNotFoundException) Message 

func (s ResourceNotFoundException) Message() string

Message returns the exception's message.

func (ResourceNotFoundException) OrigErr 

func (s ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (ResourceNotFoundException) RequestID 

func (s ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (ResourceNotFoundException) StatusCode 

func (s ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String 

func (s ResourceNotFoundException) String() string

String returns the string representation

type ServiceUnavailableException 

type ServiceUnavailableException struct {

	// The message for the exception.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The service is temporarily unavailable.

func (ServiceUnavailableException) Code 

func (s ServiceUnavailableException) Code() string

Code returns the exception type name.

func (ServiceUnavailableException) Error 

func (s ServiceUnavailableException) Error() string

func (ServiceUnavailableException) GoString 

func (s ServiceUnavailableException) GoString() string

GoString returns the string representation

func (ServiceUnavailableException) Message 

func (s ServiceUnavailableException) Message() string

Message returns the exception's message.

func (ServiceUnavailableException) OrigErr 

func (s ServiceUnavailableException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (ServiceUnavailableException) RequestID 

func (s ServiceUnavailableException) RequestID() string

RequestID returns the service's response RequestID for request.

func (ServiceUnavailableException) StatusCode 

func (s ServiceUnavailableException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ServiceUnavailableException) String 

func (s ServiceUnavailableException) String() string

String returns the string representation

type StartNextPendingJobExecutionInput 

type StartNextPendingJobExecutionInput struct {

	// A collection of name/value pairs that describe the status of the job execution.
	// If not specified, the statusDetails are unchanged.
	StatusDetails map[string]*string `locationName:"statusDetails" type:"map"`

	// Specifies the amount of time this device has to finish execution of this
	// job. If the job execution status is not set to a terminal state before this
	// timer expires, or before the timer is reset (by calling UpdateJobExecution,
	// setting the status to IN_PROGRESS and specifying a new timeout value in field
	// stepTimeoutInMinutes) the job execution status will be automatically set
	// to TIMED_OUT. Note that setting this timeout has no effect on that job execution
	// timeout which may have been specified when the job was created (CreateJob
	// using field timeoutConfig).
	StepTimeoutInMinutes *int64 `locationName:"stepTimeoutInMinutes" type:"long"`

	// The name of the thing associated with the device.
	//
	// ThingName is a required field
	ThingName *string `location:"uri" locationName:"thingName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StartNextPendingJobExecutionInput) GoString 

func (s StartNextPendingJobExecutionInput) GoString() string

GoString returns the string representation

func (*StartNextPendingJobExecutionInput) SetStatusDetails 

func (s *StartNextPendingJobExecutionInput) SetStatusDetails(v map[string]*string) *StartNextPendingJobExecutionInput

SetStatusDetails sets the StatusDetails field's value.

func (*StartNextPendingJobExecutionInput) SetStepTimeoutInMinutes 

func (s *StartNextPendingJobExecutionInput) SetStepTimeoutInMinutes(v int64) *StartNextPendingJobExecutionInput

SetStepTimeoutInMinutes sets the StepTimeoutInMinutes field's value.

func (*StartNextPendingJobExecutionInput) SetThingName 

func (s *StartNextPendingJobExecutionInput) SetThingName(v string) *StartNextPendingJobExecutionInput

SetThingName sets the ThingName field's value.

func (StartNextPendingJobExecutionInput) String 

func (s StartNextPendingJobExecutionInput) String() string

String returns the string representation

func (*StartNextPendingJobExecutionInput) Validate 

func (s *StartNextPendingJobExecutionInput) Validate() error

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

type StartNextPendingJobExecutionOutput 

type StartNextPendingJobExecutionOutput struct {

	// A JobExecution object.
	Execution *JobExecution `locationName:"execution" type:"structure"`
	// contains filtered or unexported fields
}

func (StartNextPendingJobExecutionOutput) GoString 

func (s StartNextPendingJobExecutionOutput) GoString() string

GoString returns the string representation

func (*StartNextPendingJobExecutionOutput) SetExecution 

func (s *StartNextPendingJobExecutionOutput) SetExecution(v *JobExecution) *StartNextPendingJobExecutionOutput

SetExecution sets the Execution field's value.

func (StartNextPendingJobExecutionOutput) String 

func (s StartNextPendingJobExecutionOutput) String() string

String returns the string representation

type TerminalStateException 

type TerminalStateException struct {
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The job is in a terminal state.

func (TerminalStateException) Code 

func (s TerminalStateException) Code() string

Code returns the exception type name.

func (TerminalStateException) Error 

func (s TerminalStateException) Error() string

func (TerminalStateException) GoString 

func (s TerminalStateException) GoString() string

GoString returns the string representation

func (TerminalStateException) Message 

func (s TerminalStateException) Message() string

Message returns the exception's message.

func (TerminalStateException) OrigErr 

func (s TerminalStateException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (TerminalStateException) RequestID 

func (s TerminalStateException) RequestID() string

RequestID returns the service's response RequestID for request.

func (TerminalStateException) StatusCode 

func (s TerminalStateException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (TerminalStateException) String 

func (s TerminalStateException) String() string

String returns the string representation

type ThrottlingException 

type ThrottlingException struct {

	// The message associated with the exception.
	Message_ *string `locationName:"message" type:"string"`

	// The payload associated with the exception.
	//
	// Payload is automatically base64 encoded/decoded by the SDK.
	Payload []byte `locationName:"payload" type:"blob"`
	// contains filtered or unexported fields
}

The rate exceeds the limit.

func (ThrottlingException) Code 

func (s ThrottlingException) Code() string

Code returns the exception type name.

func (ThrottlingException) Error 

func (s ThrottlingException) Error() string

func (ThrottlingException) GoString 

func (s ThrottlingException) GoString() string

GoString returns the string representation

func (ThrottlingException) Message 

func (s ThrottlingException) Message() string

Message returns the exception's message.

func (ThrottlingException) OrigErr 

func (s ThrottlingException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (ThrottlingException) RequestID 

func (s ThrottlingException) RequestID() string

RequestID returns the service's response RequestID for request.

func (ThrottlingException) StatusCode 

func (s ThrottlingException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ThrottlingException) String 

func (s ThrottlingException) String() string

String returns the string representation

type UpdateJobExecutionInput 

type UpdateJobExecutionInput struct {

	// Optional. A number that identifies a particular job execution on a particular
	// device.
	ExecutionNumber *int64 `locationName:"executionNumber" type:"long"`

	// Optional. The expected current version of the job execution. Each time you
	// update the job execution, its version is incremented. If the version of the
	// job execution stored in Jobs does not match, the update is rejected with
	// a VersionMismatch error, and an ErrorResponse that contains the current job
	// execution status data is returned. (This makes it unnecessary to perform
	// a separate DescribeJobExecution request in order to obtain the job execution
	// status data.)
	ExpectedVersion *int64 `locationName:"expectedVersion" type:"long"`

	// Optional. When set to true, the response contains the job document. The default
	// is false.
	IncludeJobDocument *bool `locationName:"includeJobDocument" type:"boolean"`

	// Optional. When included and set to true, the response contains the JobExecutionState
	// data. The default is false.
	IncludeJobExecutionState *bool `locationName:"includeJobExecutionState" type:"boolean"`

	// The unique identifier assigned to this job when it was created.
	//
	// JobId is a required field
	JobId *string `location:"uri" locationName:"jobId" min:"1" type:"string" required:"true"`

	// The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED).
	// This must be specified on every update.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"JobExecutionStatus"`

	// Optional. A collection of name/value pairs that describe the status of the
	// job execution. If not specified, the statusDetails are unchanged.
	StatusDetails map[string]*string `locationName:"statusDetails" type:"map"`

	// Specifies the amount of time this device has to finish execution of this
	// job. If the job execution status is not set to a terminal state before this
	// timer expires, or before the timer is reset (by again calling UpdateJobExecution,
	// setting the status to IN_PROGRESS and specifying a new timeout value in this
	// field) the job execution status will be automatically set to TIMED_OUT. Note
	// that setting or resetting this timeout has no effect on that job execution
	// timeout which may have been specified when the job was created (CreateJob
	// using field timeoutConfig).
	StepTimeoutInMinutes *int64 `locationName:"stepTimeoutInMinutes" type:"long"`

	// The name of the thing associated with the device.
	//
	// ThingName is a required field
	ThingName *string `location:"uri" locationName:"thingName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateJobExecutionInput) GoString 

func (s UpdateJobExecutionInput) GoString() string

GoString returns the string representation

func (*UpdateJobExecutionInput) SetExecutionNumber 

func (s *UpdateJobExecutionInput) SetExecutionNumber(v int64) *UpdateJobExecutionInput

SetExecutionNumber sets the ExecutionNumber field's value.

func (*UpdateJobExecutionInput) SetExpectedVersion 

func (s *UpdateJobExecutionInput) SetExpectedVersion(v int64) *UpdateJobExecutionInput

SetExpectedVersion sets the ExpectedVersion field's value.

func (*UpdateJobExecutionInput) SetIncludeJobDocument 

func (s *UpdateJobExecutionInput) SetIncludeJobDocument(v bool) *UpdateJobExecutionInput

SetIncludeJobDocument sets the IncludeJobDocument field's value.

func (*UpdateJobExecutionInput) SetIncludeJobExecutionState 

func (s *UpdateJobExecutionInput) SetIncludeJobExecutionState(v bool) *UpdateJobExecutionInput

SetIncludeJobExecutionState sets the IncludeJobExecutionState field's value.

func (*UpdateJobExecutionInput) SetJobId 

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

SetJobId sets the JobId field's value.

func (*UpdateJobExecutionInput) SetStatus 

func (s *UpdateJobExecutionInput) SetStatus(v string) *UpdateJobExecutionInput

SetStatus sets the Status field's value.

func (*UpdateJobExecutionInput) SetStatusDetails 

func (s *UpdateJobExecutionInput) SetStatusDetails(v map[string]*string) *UpdateJobExecutionInput

SetStatusDetails sets the StatusDetails field's value.

func (*UpdateJobExecutionInput) SetStepTimeoutInMinutes 

func (s *UpdateJobExecutionInput) SetStepTimeoutInMinutes(v int64) *UpdateJobExecutionInput

SetStepTimeoutInMinutes sets the StepTimeoutInMinutes field's value.

func (*UpdateJobExecutionInput) SetThingName 

func (s *UpdateJobExecutionInput) SetThingName(v string) *UpdateJobExecutionInput

SetThingName sets the ThingName field's value.

func (UpdateJobExecutionInput) String 

func (s UpdateJobExecutionInput) String() string

String returns the string representation

func (*UpdateJobExecutionInput) Validate 

func (s *UpdateJobExecutionInput) Validate() error

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

type UpdateJobExecutionOutput 

type UpdateJobExecutionOutput struct {

	// A JobExecutionState object.
	ExecutionState *JobExecutionState `locationName:"executionState" type:"structure"`

	// The contents of the Job Documents.
	JobDocument *string `locationName:"jobDocument" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateJobExecutionOutput) GoString 

func (s UpdateJobExecutionOutput) GoString() string

GoString returns the string representation

func (*UpdateJobExecutionOutput) SetExecutionState 

func (s *UpdateJobExecutionOutput) SetExecutionState(v *JobExecutionState) *UpdateJobExecutionOutput

SetExecutionState sets the ExecutionState field's value.

func (*UpdateJobExecutionOutput) SetJobDocument 

func (s *UpdateJobExecutionOutput) SetJobDocument(v string) *UpdateJobExecutionOutput

SetJobDocument sets the JobDocument field's value.

func (UpdateJobExecutionOutput) String 

func (s UpdateJobExecutionOutput) String() string

String returns the string representation

Source Files

View all Source files

Directories

Path Synopsis
Package iotjobsdataplaneiface provides an interface to enable mocking the AWS IoT Jobs Data Plane service client for testing your code.
 Package iotjobsdataplaneiface provides an interface to enable mocking the AWS IoT Jobs Data Plane service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.