*
* 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 *
*/ @ThreadSafe @Generated("com.amazonaws:aws-java-sdk-code-generator") public class AWSIoTJobsDataPlaneClient extends AmazonWebServiceClient implements AWSIoTJobsDataPlane { /** Provider for AWS credentials. */ private final AWSCredentialsProvider awsCredentialsProvider; private static final Log log = LogFactory.getLog(AWSIoTJobsDataPlane.class); /** Default signing name for the service. */ private static final String DEFAULT_SIGNING_NAME = "iot-jobs-data"; /** Client configuration factory providing ClientConfigurations tailored to this client */ protected static final ClientConfigurationFactory configFactory = new ClientConfigurationFactory(); private final AdvancedConfig advancedConfig; private static final com.amazonaws.protocol.json.SdkJsonProtocolFactory protocolFactory = new com.amazonaws.protocol.json.SdkJsonProtocolFactory( new JsonClientMetadata() .withProtocolVersion("1.1") .withSupportsCbor(false) .withSupportsIon(false) .withContentTypeOverride("application/json") .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("InvalidStateTransitionException").withExceptionUnmarshaller( com.amazonaws.services.iotjobsdataplane.model.transform.InvalidStateTransitionExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("TerminalStateException").withExceptionUnmarshaller( com.amazonaws.services.iotjobsdataplane.model.transform.TerminalStateExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ServiceUnavailableException").withExceptionUnmarshaller( com.amazonaws.services.iotjobsdataplane.model.transform.ServiceUnavailableExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("InvalidRequestException").withExceptionUnmarshaller( com.amazonaws.services.iotjobsdataplane.model.transform.InvalidRequestExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ThrottlingException").withExceptionUnmarshaller( com.amazonaws.services.iotjobsdataplane.model.transform.ThrottlingExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("CertificateValidationException").withExceptionUnmarshaller( com.amazonaws.services.iotjobsdataplane.model.transform.CertificateValidationExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ResourceNotFoundException").withExceptionUnmarshaller( com.amazonaws.services.iotjobsdataplane.model.transform.ResourceNotFoundExceptionUnmarshaller.getInstance())) .withBaseServiceExceptionClass(com.amazonaws.services.iotjobsdataplane.model.AWSIoTJobsDataPlaneException.class)); public static AWSIoTJobsDataPlaneClientBuilder builder() { return AWSIoTJobsDataPlaneClientBuilder.standard(); } /** * Constructs a new client to invoke service methods on AWS IoT Jobs Data Plane using the specified parameters. * ** All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param clientParams * Object providing client parameters. */ AWSIoTJobsDataPlaneClient(AwsSyncClientParams clientParams) { this(clientParams, false); } /** * Constructs a new client to invoke service methods on AWS IoT Jobs Data Plane using the specified parameters. * *
* All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param clientParams * Object providing client parameters. */ AWSIoTJobsDataPlaneClient(AwsSyncClientParams clientParams, boolean endpointDiscoveryEnabled) { super(clientParams); this.awsCredentialsProvider = clientParams.getCredentialsProvider(); this.advancedConfig = clientParams.getAdvancedConfig(); init(); } private void init() { setServiceNameIntern(DEFAULT_SIGNING_NAME); setEndpointPrefix(ENDPOINT_PREFIX); // calling this.setEndPoint(...) will also modify the signer accordingly setEndpoint("data.jobs.iot.us-east-1.amazonaws.com"); HandlerChainFactory chainFactory = new HandlerChainFactory(); requestHandler2s.addAll(chainFactory.newRequestHandlerChain("/com/amazonaws/services/iotjobsdataplane/request.handlers")); requestHandler2s.addAll(chainFactory.newRequestHandler2Chain("/com/amazonaws/services/iotjobsdataplane/request.handler2s")); requestHandler2s.addAll(chainFactory.getGlobalHandlers()); } /** *
* Gets details of a job execution. *
* * @param describeJobExecutionRequest * @return 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. * @throws ResourceNotFoundException * The specified resource does not exist. * @throws ThrottlingException * The rate exceeds the limit. * @throws ServiceUnavailableException * The service is temporarily unavailable. * @throws CertificateValidationException * The certificate is invalid. * @throws TerminalStateException * The job is in a terminal state. * @sample AWSIoTJobsDataPlane.DescribeJobExecution * @see AWS API Documentation */ @Override public DescribeJobExecutionResult describeJobExecution(DescribeJobExecutionRequest request) { request = beforeClientExecution(request); return executeDescribeJobExecution(request); } @SdkInternalApi final DescribeJobExecutionResult executeDescribeJobExecution(DescribeJobExecutionRequest describeJobExecutionRequest) { ExecutionContext executionContext = createExecutionContext(describeJobExecutionRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Gets the list of all jobs for a thing that are not in a terminal status. *
* * @param getPendingJobExecutionsRequest * @return 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. * @throws ResourceNotFoundException * The specified resource does not exist. * @throws ThrottlingException * The rate exceeds the limit. * @throws ServiceUnavailableException * The service is temporarily unavailable. * @throws CertificateValidationException * The certificate is invalid. * @sample AWSIoTJobsDataPlane.GetPendingJobExecutions * @see AWS API Documentation */ @Override public GetPendingJobExecutionsResult getPendingJobExecutions(GetPendingJobExecutionsRequest request) { request = beforeClientExecution(request); return executeGetPendingJobExecutions(request); } @SdkInternalApi final GetPendingJobExecutionsResult executeGetPendingJobExecutions(GetPendingJobExecutionsRequest getPendingJobExecutionsRequest) { ExecutionContext executionContext = createExecutionContext(getPendingJobExecutionsRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Gets and starts the next pending (status IN_PROGRESS or QUEUED) job execution for a thing. *
* * @param startNextPendingJobExecutionRequest * @return 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. * @throws ResourceNotFoundException * The specified resource does not exist. * @throws ThrottlingException * The rate exceeds the limit. * @throws ServiceUnavailableException * The service is temporarily unavailable. * @throws CertificateValidationException * The certificate is invalid. * @sample AWSIoTJobsDataPlane.StartNextPendingJobExecution * @see AWS API Documentation */ @Override public StartNextPendingJobExecutionResult startNextPendingJobExecution(StartNextPendingJobExecutionRequest request) { request = beforeClientExecution(request); return executeStartNextPendingJobExecution(request); } @SdkInternalApi final StartNextPendingJobExecutionResult executeStartNextPendingJobExecution(StartNextPendingJobExecutionRequest startNextPendingJobExecutionRequest) { ExecutionContext executionContext = createExecutionContext(startNextPendingJobExecutionRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Updates the status of a job execution. *
* * @param updateJobExecutionRequest * @return 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. * @throws ResourceNotFoundException * The specified resource does not exist. * @throws ThrottlingException * The rate exceeds the limit. * @throws ServiceUnavailableException * The service is temporarily unavailable. * @throws CertificateValidationException * The certificate is invalid. * @throws 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. * @sample AWSIoTJobsDataPlane.UpdateJobExecution * @see AWS API Documentation */ @Override public UpdateJobExecutionResult updateJobExecution(UpdateJobExecutionRequest request) { request = beforeClientExecution(request); return executeUpdateJobExecution(request); } @SdkInternalApi final UpdateJobExecutionResult executeUpdateJobExecution(UpdateJobExecutionRequest updateJobExecutionRequest) { ExecutionContext executionContext = createExecutionContext(updateJobExecutionRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request
* 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 the request.
*
* @param request
* The originally executed request
*
* @return The response metadata for the specified request, or null if none is available.
*/
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request) {
return client.getResponseMetadataForRequest(request);
}
/**
* Normal invoke with authentication. Credentials are required and may be overriden at the request level.
**/
private