com.amazonaws.services.iotjobsdataplane

Interface AWSIoTJobsDataPlaneAsync

All Superinterfaces:

AWSIoTJobsDataPlane

All Known Implementing Classes:

AbstractAWSIoTJobsDataPlaneAsync, AWSIoTJobsDataPlaneAsyncClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSIoTJobsDataPlaneAsync
extends AWSIoTJobsDataPlane

Interface for accessing AWS IoT Jobs Data Plane asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation completes.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSIoTJobsDataPlaneAsync instead.

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

Field Summary

Fields inherited from interface com.amazonaws.services.iotjobsdataplane.AWSIoTJobsDataPlane

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
Future<DescribeJobExecutionResult>	describeJobExecutionAsync(DescribeJobExecutionRequest describeJobExecutionRequest) Gets details of a job execution.
Future<DescribeJobExecutionResult>	describeJobExecutionAsync(DescribeJobExecutionRequest describeJobExecutionRequest, AsyncHandler<DescribeJobExecutionRequest,DescribeJobExecutionResult> asyncHandler) Gets details of a job execution.
Future<GetPendingJobExecutionsResult>	getPendingJobExecutionsAsync(GetPendingJobExecutionsRequest getPendingJobExecutionsRequest) Gets the list of all jobs for a thing that are not in a terminal status.
Future<GetPendingJobExecutionsResult>	getPendingJobExecutionsAsync(GetPendingJobExecutionsRequest getPendingJobExecutionsRequest, AsyncHandler<GetPendingJobExecutionsRequest,GetPendingJobExecutionsResult> asyncHandler) Gets the list of all jobs for a thing that are not in a terminal status.
Future<StartNextPendingJobExecutionResult>	startNextPendingJobExecutionAsync(StartNextPendingJobExecutionRequest startNextPendingJobExecutionRequest) Gets and starts the next pending (status IN_PROGRESS or QUEUED) job execution for a thing.
Future<StartNextPendingJobExecutionResult>	startNextPendingJobExecutionAsync(StartNextPendingJobExecutionRequest startNextPendingJobExecutionRequest, AsyncHandler<StartNextPendingJobExecutionRequest,StartNextPendingJobExecutionResult> asyncHandler) Gets and starts the next pending (status IN_PROGRESS or QUEUED) job execution for a thing.
Future<UpdateJobExecutionResult>	updateJobExecutionAsync(UpdateJobExecutionRequest updateJobExecutionRequest) Updates the status of a job execution.
Future<UpdateJobExecutionResult>	updateJobExecutionAsync(UpdateJobExecutionRequest updateJobExecutionRequest, AsyncHandler<UpdateJobExecutionRequest,UpdateJobExecutionResult> asyncHandler) Updates the status of a job execution.

Methods inherited from interface com.amazonaws.services.iotjobsdataplane.AWSIoTJobsDataPlane

describeJobExecution, getCachedResponseMetadata, getPendingJobExecutions, shutdown, startNextPendingJobExecution, updateJobExecution

Method Detail

describeJobExecutionAsync

Future<DescribeJobExecutionResult> describeJobExecutionAsync(DescribeJobExecutionRequest describeJobExecutionRequest)

Gets details of a job execution.

Parameters:

describeJobExecutionRequest -

Returns:

A Java Future containing the result of the DescribeJobExecution operation returned by the service.

See Also:

AWS API Documentation

describeJobExecutionAsync

Future<DescribeJobExecutionResult> describeJobExecutionAsync(DescribeJobExecutionRequest describeJobExecutionRequest,
                                                             AsyncHandler<DescribeJobExecutionRequest,DescribeJobExecutionResult> asyncHandler)

Gets details of a job execution.

Parameters:

describeJobExecutionRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DescribeJobExecution operation returned by the service.

See Also:

AWS API Documentation

getPendingJobExecutionsAsync

Future<GetPendingJobExecutionsResult> getPendingJobExecutionsAsync(GetPendingJobExecutionsRequest getPendingJobExecutionsRequest)

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

Parameters:

getPendingJobExecutionsRequest -

Returns:

A Java Future containing the result of the GetPendingJobExecutions operation returned by the service.

See Also:

AWS API Documentation

getPendingJobExecutionsAsync

Future<GetPendingJobExecutionsResult> getPendingJobExecutionsAsync(GetPendingJobExecutionsRequest getPendingJobExecutionsRequest,
                                                                   AsyncHandler<GetPendingJobExecutionsRequest,GetPendingJobExecutionsResult> asyncHandler)

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

Parameters:

getPendingJobExecutionsRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the GetPendingJobExecutions operation returned by the service.

See Also:

AWS API Documentation

startNextPendingJobExecutionAsync

Future<StartNextPendingJobExecutionResult> startNextPendingJobExecutionAsync(StartNextPendingJobExecutionRequest startNextPendingJobExecutionRequest)

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

Parameters:

startNextPendingJobExecutionRequest -

Returns:

A Java Future containing the result of the StartNextPendingJobExecution operation returned by the service.

See Also:

AWS API Documentation

startNextPendingJobExecutionAsync

Future<StartNextPendingJobExecutionResult> startNextPendingJobExecutionAsync(StartNextPendingJobExecutionRequest startNextPendingJobExecutionRequest,
                                                                             AsyncHandler<StartNextPendingJobExecutionRequest,StartNextPendingJobExecutionResult> asyncHandler)

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

Parameters:

startNextPendingJobExecutionRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the StartNextPendingJobExecution operation returned by the service.

See Also:

AWS API Documentation

updateJobExecutionAsync

Future<UpdateJobExecutionResult> updateJobExecutionAsync(UpdateJobExecutionRequest updateJobExecutionRequest)

Updates the status of a job execution.

Parameters:

updateJobExecutionRequest -

Returns:

A Java Future containing the result of the UpdateJobExecution operation returned by the service.

See Also:

AWS API Documentation

updateJobExecutionAsync

Future<UpdateJobExecutionResult> updateJobExecutionAsync(UpdateJobExecutionRequest updateJobExecutionRequest,
                                                         AsyncHandler<UpdateJobExecutionRequest,UpdateJobExecutionResult> asyncHandler)

Updates the status of a job execution.

Parameters:

updateJobExecutionRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the UpdateJobExecution operation returned by the service.

See Also:

AWS API Documentation