com.amazonaws.services.iotjobsdataplane

Interface AWSIoTJobsDataPlane

All Known Subinterfaces:

AWSIoTJobsDataPlaneAsync

All Known Implementing Classes:

AbstractAWSIoTJobsDataPlane, AbstractAWSIoTJobsDataPlaneAsync, AWSIoTJobsDataPlaneAsyncClient, AWSIoTJobsDataPlaneClient

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

Interface for accessing AWS IoT Jobs Data Plane.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSIoTJobsDataPlane 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

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
DescribeJobExecutionResult	describeJobExecution(DescribeJobExecutionRequest describeJobExecutionRequest) Gets details of a job execution.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetPendingJobExecutionsResult	getPendingJobExecutions(GetPendingJobExecutionsRequest getPendingJobExecutionsRequest) Gets the list of all jobs for a thing that are not in a terminal status.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartNextPendingJobExecutionResult	startNextPendingJobExecution(StartNextPendingJobExecutionRequest startNextPendingJobExecutionRequest) Gets and starts the next pending (status IN_PROGRESS or QUEUED) job execution for a thing.
UpdateJobExecutionResult	updateJobExecution(UpdateJobExecutionRequest updateJobExecutionRequest) Updates the status of a job execution.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

describeJobExecution

DescribeJobExecutionResult describeJobExecution(DescribeJobExecutionRequest describeJobExecutionRequest)

Gets details of a job execution.

Parameters:

describeJobExecutionRequest -

Returns:

Result of the DescribeJobExecution operation returned by the service.

Throws:

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:

AWS API Documentation

getPendingJobExecutions

GetPendingJobExecutionsResult getPendingJobExecutions(GetPendingJobExecutionsRequest getPendingJobExecutionsRequest)

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

Parameters:

getPendingJobExecutionsRequest -

Returns:

Result of the GetPendingJobExecutions operation returned by the service.

Throws:

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:

AWS API Documentation

startNextPendingJobExecution

StartNextPendingJobExecutionResult startNextPendingJobExecution(StartNextPendingJobExecutionRequest startNextPendingJobExecutionRequest)

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

Parameters:

startNextPendingJobExecutionRequest -

Returns:

Result of the StartNextPendingJobExecution operation returned by the service.

Throws:

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:

AWS API Documentation

updateJobExecution

UpdateJobExecutionResult updateJobExecution(UpdateJobExecutionRequest updateJobExecutionRequest)

Updates the status of a job execution.

Parameters:

updateJobExecutionRequest -

Returns:

Result of the UpdateJobExecution operation returned by the service.

Throws:

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:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.