func JobExecutionStatus_Values() []string
JobExecutionStatus_Values returns all elements of the JobExecutionStatus enum
type CertificateValidationException struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
// Additional information about the exception.
Message_ *string `locationName:"message" type:"string"`
// contains filtered or unexported fields
}
The certificate is invalid.
func (s *CertificateValidationException) Code() string
Code returns the exception type name.
func (s *CertificateValidationException) Error() string
func (s CertificateValidationException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CertificateValidationException) Message() string
Message returns the exception's message.
func (s *CertificateValidationException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *CertificateValidationException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *CertificateValidationException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s CertificateValidationException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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 (s DescribeJobExecutionInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeJobExecutionInput) SetExecutionNumber(v int64) *DescribeJobExecutionInput
SetExecutionNumber sets the ExecutionNumber field's value.
func (s *DescribeJobExecutionInput) SetIncludeJobDocument(v bool) *DescribeJobExecutionInput
SetIncludeJobDocument sets the IncludeJobDocument field's value.
func (s *DescribeJobExecutionInput) SetJobId(v string) *DescribeJobExecutionInput
SetJobId sets the JobId field's value.
func (s *DescribeJobExecutionInput) SetThingName(v string) *DescribeJobExecutionInput
SetThingName sets the ThingName field's value.
func (s DescribeJobExecutionInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeJobExecutionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeJobExecutionOutput struct {
// Contains data about a job execution.
Execution *JobExecution `locationName:"execution" type:"structure"`
// contains filtered or unexported fields
}
func (s DescribeJobExecutionOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeJobExecutionOutput) SetExecution(v *JobExecution) *DescribeJobExecutionOutput
SetExecution sets the Execution field's value.
func (s DescribeJobExecutionOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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 (s GetPendingJobExecutionsInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetPendingJobExecutionsInput) SetThingName(v string) *GetPendingJobExecutionsInput
SetThingName sets the ThingName field's value.
func (s GetPendingJobExecutionsInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetPendingJobExecutionsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (s GetPendingJobExecutionsOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetPendingJobExecutionsOutput) SetInProgressJobs(v []*JobExecutionSummary) *GetPendingJobExecutionsOutput
SetInProgressJobs sets the InProgressJobs field's value.
func (s *GetPendingJobExecutionsOutput) SetQueuedJobs(v []*JobExecutionSummary) *GetPendingJobExecutionsOutput
SetQueuedJobs sets the QueuedJobs field's value.
func (s GetPendingJobExecutionsOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type InvalidRequestException struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
// 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 (s *InvalidRequestException) Code() string
Code returns the exception type name.
func (s *InvalidRequestException) Error() string
func (s InvalidRequestException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *InvalidRequestException) Message() string
Message returns the exception's message.
func (s *InvalidRequestException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *InvalidRequestException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *InvalidRequestException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s InvalidRequestException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type InvalidStateTransitionException struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
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 (s *InvalidStateTransitionException) Code() string
Code returns the exception type name.
func (s *InvalidStateTransitionException) Error() string
func (s InvalidStateTransitionException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *InvalidStateTransitionException) Message() string
Message returns the exception's message.
func (s *InvalidStateTransitionException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *InvalidStateTransitionException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *InvalidStateTransitionException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s InvalidStateTransitionException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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(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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 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 (s JobExecution) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *JobExecution) SetApproximateSecondsBeforeTimedOut(v int64) *JobExecution
SetApproximateSecondsBeforeTimedOut sets the ApproximateSecondsBeforeTimedOut field's value.
func (s *JobExecution) SetExecutionNumber(v int64) *JobExecution
SetExecutionNumber sets the ExecutionNumber field's value.
func (s *JobExecution) SetJobDocument(v string) *JobExecution
SetJobDocument sets the JobDocument field's value.
func (s *JobExecution) SetJobId(v string) *JobExecution
SetJobId sets the JobId field's value.
func (s *JobExecution) SetLastUpdatedAt(v int64) *JobExecution
SetLastUpdatedAt sets the LastUpdatedAt field's value.
func (s *JobExecution) SetQueuedAt(v int64) *JobExecution
SetQueuedAt sets the QueuedAt field's value.
func (s *JobExecution) SetStartedAt(v int64) *JobExecution
SetStartedAt sets the StartedAt field's value.
func (s *JobExecution) SetStatus(v string) *JobExecution
SetStatus sets the Status field's value.
func (s *JobExecution) SetStatusDetails(v map[string]*string) *JobExecution
SetStatusDetails sets the StatusDetails field's value.
func (s *JobExecution) SetThingName(v string) *JobExecution
SetThingName sets the ThingName field's value.
func (s *JobExecution) SetVersionNumber(v int64) *JobExecution
SetVersionNumber sets the VersionNumber field's value.
func (s JobExecution) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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 (s JobExecutionState) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *JobExecutionState) SetStatus(v string) *JobExecutionState
SetStatus sets the Status field's value.
func (s *JobExecutionState) SetStatusDetails(v map[string]*string) *JobExecutionState
SetStatusDetails sets the StatusDetails field's value.
func (s *JobExecutionState) SetVersionNumber(v int64) *JobExecutionState
SetVersionNumber sets the VersionNumber field's value.
func (s JobExecutionState) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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 (s JobExecutionSummary) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *JobExecutionSummary) SetExecutionNumber(v int64) *JobExecutionSummary
SetExecutionNumber sets the ExecutionNumber field's value.
func (s *JobExecutionSummary) SetJobId(v string) *JobExecutionSummary
SetJobId sets the JobId field's value.
func (s *JobExecutionSummary) SetLastUpdatedAt(v int64) *JobExecutionSummary
SetLastUpdatedAt sets the LastUpdatedAt field's value.
func (s *JobExecutionSummary) SetQueuedAt(v int64) *JobExecutionSummary
SetQueuedAt sets the QueuedAt field's value.
func (s *JobExecutionSummary) SetStartedAt(v int64) *JobExecutionSummary
SetStartedAt sets the StartedAt field's value.
func (s *JobExecutionSummary) SetVersionNumber(v int64) *JobExecutionSummary
SetVersionNumber sets the VersionNumber field's value.
func (s JobExecutionSummary) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ResourceNotFoundException struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
// The message for the exception.
Message_ *string `locationName:"message" type:"string"`
// contains filtered or unexported fields
}
The specified resource does not exist.
func (s *ResourceNotFoundException) Code() string
Code returns the exception type name.
func (s *ResourceNotFoundException) Error() string
func (s ResourceNotFoundException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ResourceNotFoundException) Message() string
Message returns the exception's message.
func (s *ResourceNotFoundException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ResourceNotFoundException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ResourceNotFoundException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s ResourceNotFoundException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ServiceUnavailableException struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
// The message for the exception.
Message_ *string `locationName:"message" type:"string"`
// contains filtered or unexported fields
}
The service is temporarily unavailable.
func (s *ServiceUnavailableException) Code() string
Code returns the exception type name.
func (s *ServiceUnavailableException) Error() string
func (s ServiceUnavailableException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ServiceUnavailableException) Message() string
Message returns the exception's message.
func (s *ServiceUnavailableException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ServiceUnavailableException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ServiceUnavailableException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s ServiceUnavailableException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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 (s StartNextPendingJobExecutionInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *StartNextPendingJobExecutionInput) SetStatusDetails(v map[string]*string) *StartNextPendingJobExecutionInput
SetStatusDetails sets the StatusDetails field's value.
func (s *StartNextPendingJobExecutionInput) SetStepTimeoutInMinutes(v int64) *StartNextPendingJobExecutionInput
SetStepTimeoutInMinutes sets the StepTimeoutInMinutes field's value.
func (s *StartNextPendingJobExecutionInput) SetThingName(v string) *StartNextPendingJobExecutionInput
SetThingName sets the ThingName field's value.
func (s StartNextPendingJobExecutionInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *StartNextPendingJobExecutionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type StartNextPendingJobExecutionOutput struct {
// A JobExecution object.
Execution *JobExecution `locationName:"execution" type:"structure"`
// contains filtered or unexported fields
}
func (s StartNextPendingJobExecutionOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *StartNextPendingJobExecutionOutput) SetExecution(v *JobExecution) *StartNextPendingJobExecutionOutput
SetExecution sets the Execution field's value.
func (s StartNextPendingJobExecutionOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type TerminalStateException struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"message" type:"string"`
// contains filtered or unexported fields
}
The job is in a terminal state.
func (s *TerminalStateException) Code() string
Code returns the exception type name.
func (s *TerminalStateException) Error() string
func (s TerminalStateException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *TerminalStateException) Message() string
Message returns the exception's message.
func (s *TerminalStateException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *TerminalStateException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *TerminalStateException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s TerminalStateException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ThrottlingException struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
// 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 (s *ThrottlingException) Code() string
Code returns the exception type name.
func (s *ThrottlingException) Error() string
func (s ThrottlingException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ThrottlingException) Message() string
Message returns the exception's message.
func (s *ThrottlingException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ThrottlingException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ThrottlingException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s ThrottlingException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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 (s UpdateJobExecutionInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *UpdateJobExecutionInput) SetExecutionNumber(v int64) *UpdateJobExecutionInput
SetExecutionNumber sets the ExecutionNumber field's value.
func (s *UpdateJobExecutionInput) SetExpectedVersion(v int64) *UpdateJobExecutionInput
SetExpectedVersion sets the ExpectedVersion field's value.
func (s *UpdateJobExecutionInput) SetIncludeJobDocument(v bool) *UpdateJobExecutionInput
SetIncludeJobDocument sets the IncludeJobDocument field's value.
func (s *UpdateJobExecutionInput) SetIncludeJobExecutionState(v bool) *UpdateJobExecutionInput
SetIncludeJobExecutionState sets the IncludeJobExecutionState field's value.
func (s *UpdateJobExecutionInput) SetJobId(v string) *UpdateJobExecutionInput
SetJobId sets the JobId field's value.
func (s *UpdateJobExecutionInput) SetStatus(v string) *UpdateJobExecutionInput
SetStatus sets the Status field's value.
func (s *UpdateJobExecutionInput) SetStatusDetails(v map[string]*string) *UpdateJobExecutionInput
SetStatusDetails sets the StatusDetails field's value.
func (s *UpdateJobExecutionInput) SetStepTimeoutInMinutes(v int64) *UpdateJobExecutionInput
SetStepTimeoutInMinutes sets the StepTimeoutInMinutes field's value.
func (s *UpdateJobExecutionInput) SetThingName(v string) *UpdateJobExecutionInput
SetThingName sets the ThingName field's value.
func (s UpdateJobExecutionInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *UpdateJobExecutionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (s UpdateJobExecutionOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *UpdateJobExecutionOutput) SetExecutionState(v *JobExecutionState) *UpdateJobExecutionOutput
SetExecutionState sets the ExecutionState field's value.
func (s *UpdateJobExecutionOutput) SetJobDocument(v string) *UpdateJobExecutionOutput
SetJobDocument sets the JobDocument field's value.
func (s UpdateJobExecutionOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".