Interface IotJobsDataPlaneClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
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 Amazon Web Services IoT Core. 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.
Find the endpoint address for actions in the IoT jobs data plane by running this CLI command:
aws iot describe-endpoint --endpoint-type iot:Jobs
The service name used by Amazon Web Services Signature Version 4 to sign requests is: iot-jobs-data.
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.
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 Amazon Web Services IoT Core. 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
FieldsModifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Create a builder that can be used to configure and create aIotJobsDataPlaneClient
.static IotJobsDataPlaneClient
create()
Create aIotJobsDataPlaneClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default DescribeJobExecutionResponse
describeJobExecution
(Consumer<DescribeJobExecutionRequest.Builder> describeJobExecutionRequest) Gets details of a job execution.default DescribeJobExecutionResponse
describeJobExecution
(DescribeJobExecutionRequest describeJobExecutionRequest) Gets details of a job execution.default GetPendingJobExecutionsResponse
getPendingJobExecutions
(Consumer<GetPendingJobExecutionsRequest.Builder> getPendingJobExecutionsRequest) Gets the list of all jobs for a thing that are not in a terminal status.default GetPendingJobExecutionsResponse
getPendingJobExecutions
(GetPendingJobExecutionsRequest getPendingJobExecutionsRequest) Gets the list of all jobs for a thing that are not in a terminal status.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
default StartCommandExecutionResponse
startCommandExecution
(Consumer<StartCommandExecutionRequest.Builder> startCommandExecutionRequest) Using the command created with theCreateCommand
API, start a command execution on a specific device.default StartCommandExecutionResponse
startCommandExecution
(StartCommandExecutionRequest startCommandExecutionRequest) Using the command created with theCreateCommand
API, start a command execution on a specific device.startNextPendingJobExecution
(Consumer<StartNextPendingJobExecutionRequest.Builder> startNextPendingJobExecutionRequest) Gets and starts the next pending (status IN_PROGRESS or QUEUED) job execution for a thing.startNextPendingJobExecution
(StartNextPendingJobExecutionRequest startNextPendingJobExecutionRequest) Gets and starts the next pending (status IN_PROGRESS or QUEUED) job execution for a thing.default UpdateJobExecutionResponse
updateJobExecution
(Consumer<UpdateJobExecutionRequest.Builder> updateJobExecutionRequest) Updates the status of a job execution.default UpdateJobExecutionResponse
updateJobExecution
(UpdateJobExecutionRequest updateJobExecutionRequest) Updates the status of a job execution.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
describeJobExecution
default DescribeJobExecutionResponse describeJobExecution(DescribeJobExecutionRequest describeJobExecutionRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, ServiceUnavailableException, CertificateValidationException, TerminalStateException, AwsServiceException, SdkClientException, IotJobsDataPlaneException Gets details of a job execution.
Requires permission to access the DescribeJobExecution action.
- Parameters:
describeJobExecutionRequest
-- Returns:
- Result of the DescribeJobExecution operation returned by the service.
- See Also:
-
describeJobExecution
default DescribeJobExecutionResponse describeJobExecution(Consumer<DescribeJobExecutionRequest.Builder> describeJobExecutionRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, ServiceUnavailableException, CertificateValidationException, TerminalStateException, AwsServiceException, SdkClientException, IotJobsDataPlaneException Gets details of a job execution.
Requires permission to access the DescribeJobExecution action.
This is a convenience which creates an instance of the
DescribeJobExecutionRequest.Builder
avoiding the need to create one manually viaDescribeJobExecutionRequest.builder()
- Parameters:
describeJobExecutionRequest
- AConsumer
that will call methods onDescribeJobExecutionRequest.Builder
to create a request.- Returns:
- Result of the DescribeJobExecution operation returned by the service.
- See Also:
-
getPendingJobExecutions
default GetPendingJobExecutionsResponse getPendingJobExecutions(GetPendingJobExecutionsRequest getPendingJobExecutionsRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, ServiceUnavailableException, CertificateValidationException, AwsServiceException, SdkClientException, IotJobsDataPlaneException Gets the list of all jobs for a thing that are not in a terminal status.
Requires permission to access the GetPendingJobExecutions action.
- Parameters:
getPendingJobExecutionsRequest
-- Returns:
- Result of the GetPendingJobExecutions operation returned by the service.
- See Also:
-
getPendingJobExecutions
default GetPendingJobExecutionsResponse getPendingJobExecutions(Consumer<GetPendingJobExecutionsRequest.Builder> getPendingJobExecutionsRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, ServiceUnavailableException, CertificateValidationException, AwsServiceException, SdkClientException, IotJobsDataPlaneException Gets the list of all jobs for a thing that are not in a terminal status.
Requires permission to access the GetPendingJobExecutions action.
This is a convenience which creates an instance of the
GetPendingJobExecutionsRequest.Builder
avoiding the need to create one manually viaGetPendingJobExecutionsRequest.builder()
- Parameters:
getPendingJobExecutionsRequest
- AConsumer
that will call methods onGetPendingJobExecutionsRequest.Builder
to create a request.- Returns:
- Result of the GetPendingJobExecutions operation returned by the service.
- See Also:
-
startCommandExecution
default StartCommandExecutionResponse startCommandExecution(StartCommandExecutionRequest startCommandExecutionRequest) throws ValidationException, ResourceNotFoundException, ConflictException, ThrottlingException, ServiceQuotaExceededException, InternalServerException, AwsServiceException, SdkClientException, IotJobsDataPlaneException Using the command created with the
CreateCommand
API, start a command execution on a specific device.- Parameters:
startCommandExecutionRequest
-- Returns:
- Result of the StartCommandExecution operation returned by the service.
- See Also:
-
startCommandExecution
default StartCommandExecutionResponse startCommandExecution(Consumer<StartCommandExecutionRequest.Builder> startCommandExecutionRequest) throws ValidationException, ResourceNotFoundException, ConflictException, ThrottlingException, ServiceQuotaExceededException, InternalServerException, AwsServiceException, SdkClientException, IotJobsDataPlaneException Using the command created with the
CreateCommand
API, start a command execution on a specific device.
This is a convenience which creates an instance of the
StartCommandExecutionRequest.Builder
avoiding the need to create one manually viaStartCommandExecutionRequest.builder()
- Parameters:
startCommandExecutionRequest
- AConsumer
that will call methods onStartCommandExecutionRequest.Builder
to create a request.- Returns:
- Result of the StartCommandExecution operation returned by the service.
- See Also:
-
startNextPendingJobExecution
default StartNextPendingJobExecutionResponse startNextPendingJobExecution(StartNextPendingJobExecutionRequest startNextPendingJobExecutionRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, ServiceUnavailableException, CertificateValidationException, AwsServiceException, SdkClientException, IotJobsDataPlaneException Gets and starts the next pending (status IN_PROGRESS or QUEUED) job execution for a thing.
Requires permission to access the StartNextPendingJobExecution action.
- Parameters:
startNextPendingJobExecutionRequest
-- Returns:
- Result of the StartNextPendingJobExecution operation returned by the service.
- See Also:
-
startNextPendingJobExecution
default StartNextPendingJobExecutionResponse startNextPendingJobExecution(Consumer<StartNextPendingJobExecutionRequest.Builder> startNextPendingJobExecutionRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, ServiceUnavailableException, CertificateValidationException, AwsServiceException, SdkClientException, IotJobsDataPlaneException Gets and starts the next pending (status IN_PROGRESS or QUEUED) job execution for a thing.
Requires permission to access the StartNextPendingJobExecution action.
This is a convenience which creates an instance of the
StartNextPendingJobExecutionRequest.Builder
avoiding the need to create one manually viaStartNextPendingJobExecutionRequest.builder()
- Parameters:
startNextPendingJobExecutionRequest
- AConsumer
that will call methods onStartNextPendingJobExecutionRequest.Builder
to create a request.- Returns:
- Result of the StartNextPendingJobExecution operation returned by the service.
- See Also:
-
updateJobExecution
default UpdateJobExecutionResponse updateJobExecution(UpdateJobExecutionRequest updateJobExecutionRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, ServiceUnavailableException, CertificateValidationException, InvalidStateTransitionException, AwsServiceException, SdkClientException, IotJobsDataPlaneException Updates the status of a job execution.
Requires permission to access the UpdateJobExecution action.
- Parameters:
updateJobExecutionRequest
-- Returns:
- Result of the UpdateJobExecution operation returned by the service.
- See Also:
-
updateJobExecution
default UpdateJobExecutionResponse updateJobExecution(Consumer<UpdateJobExecutionRequest.Builder> updateJobExecutionRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, ServiceUnavailableException, CertificateValidationException, InvalidStateTransitionException, AwsServiceException, SdkClientException, IotJobsDataPlaneException Updates the status of a job execution.
Requires permission to access the UpdateJobExecution action.
This is a convenience which creates an instance of the
UpdateJobExecutionRequest.Builder
avoiding the need to create one manually viaUpdateJobExecutionRequest.builder()
- Parameters:
updateJobExecutionRequest
- AConsumer
that will call methods onUpdateJobExecutionRequest.Builder
to create a request.- Returns:
- Result of the UpdateJobExecution operation returned by the service.
- See Also:
-
create
Create aIotJobsDataPlaneClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aIotJobsDataPlaneClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-