AWS SDK for Go (PILOT)
API Reference

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

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

IoTJobsDataPlane

import "github.com/aws/aws-sdk-go/service/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.

Client

Type: *client.Client

Method

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 Codes:

  • ErrCodeInvalidRequestException "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.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

  • ErrCodeCertificateValidationException "CertificateValidationException" The certificate is invalid.

  • ErrCodeTerminalStateException "TerminalStateException" The job is in a terminal state.

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

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

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.

See Also

For more information about using this API, see AWS API Documentation.

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 Codes:

  • ErrCodeInvalidRequestException "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.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

  • ErrCodeCertificateValidationException "CertificateValidationException" The certificate is invalid.

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

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

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.

See Also

For more information about using this API, see AWS API Documentation.

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 Codes:

  • ErrCodeInvalidRequestException "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.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

  • ErrCodeCertificateValidationException "CertificateValidationException" The certificate is invalid.

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

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

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.

See Also

For more information about using this API, see AWS API Documentation.

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 Codes:

  • ErrCodeInvalidRequestException "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.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

  • ErrCodeThrottlingException "ThrottlingException" The rate exceeds the limit.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is temporarily unavailable.

  • ErrCodeCertificateValidationException "CertificateValidationException" The certificate is invalid.

  • ErrCodeInvalidStateTransitionException "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

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

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.

See Also

For more information about using this API, see AWS API Documentation.

On this page: