Interface Iot1ClickProjectsAsyncClient
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
builder() method.The asynchronous client performs non-blocking I/O when configured with any
SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may
perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API
call.
The AWS IoT 1-Click Projects API Reference
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String -
Method Summary
Modifier and TypeMethodDescriptionassociateDeviceWithPlacement(Consumer<AssociateDeviceWithPlacementRequest.Builder> associateDeviceWithPlacementRequest) Associates a physical device with a placement.associateDeviceWithPlacement(AssociateDeviceWithPlacementRequest associateDeviceWithPlacementRequest) Associates a physical device with a placement.builder()Create a builder that can be used to configure and create aIot1ClickProjectsAsyncClient.static Iot1ClickProjectsAsyncClientcreate()Create aIot1ClickProjectsAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CompletableFuture<CreatePlacementResponse> createPlacement(Consumer<CreatePlacementRequest.Builder> createPlacementRequest) Creates an empty placement.default CompletableFuture<CreatePlacementResponse> createPlacement(CreatePlacementRequest createPlacementRequest) Creates an empty placement.default CompletableFuture<CreateProjectResponse> createProject(Consumer<CreateProjectRequest.Builder> createProjectRequest) Creates an empty project with a placement template.default CompletableFuture<CreateProjectResponse> createProject(CreateProjectRequest createProjectRequest) Creates an empty project with a placement template.default CompletableFuture<DeletePlacementResponse> deletePlacement(Consumer<DeletePlacementRequest.Builder> deletePlacementRequest) Deletes a placement.default CompletableFuture<DeletePlacementResponse> deletePlacement(DeletePlacementRequest deletePlacementRequest) Deletes a placement.default CompletableFuture<DeleteProjectResponse> deleteProject(Consumer<DeleteProjectRequest.Builder> deleteProjectRequest) Deletes a project.default CompletableFuture<DeleteProjectResponse> deleteProject(DeleteProjectRequest deleteProjectRequest) Deletes a project.describePlacement(Consumer<DescribePlacementRequest.Builder> describePlacementRequest) Describes a placement in a project.describePlacement(DescribePlacementRequest describePlacementRequest) Describes a placement in a project.default CompletableFuture<DescribeProjectResponse> describeProject(Consumer<DescribeProjectRequest.Builder> describeProjectRequest) Returns an object describing a project.default CompletableFuture<DescribeProjectResponse> describeProject(DescribeProjectRequest describeProjectRequest) Returns an object describing a project.disassociateDeviceFromPlacement(Consumer<DisassociateDeviceFromPlacementRequest.Builder> disassociateDeviceFromPlacementRequest) Removes a physical device from a placement.disassociateDeviceFromPlacement(DisassociateDeviceFromPlacementRequest disassociateDeviceFromPlacementRequest) Removes a physical device from a placement.getDevicesInPlacement(Consumer<GetDevicesInPlacementRequest.Builder> getDevicesInPlacementRequest) Returns an object enumerating the devices in a placement.getDevicesInPlacement(GetDevicesInPlacementRequest getDevicesInPlacementRequest) Returns an object enumerating the devices in a placement.default CompletableFuture<ListPlacementsResponse> listPlacements(Consumer<ListPlacementsRequest.Builder> listPlacementsRequest) Lists the placement(s) of a project.default CompletableFuture<ListPlacementsResponse> listPlacements(ListPlacementsRequest listPlacementsRequest) Lists the placement(s) of a project.default ListPlacementsPublisherlistPlacementsPaginator(Consumer<ListPlacementsRequest.Builder> listPlacementsRequest) This is a variant oflistPlacements(software.amazon.awssdk.services.iot1clickprojects.model.ListPlacementsRequest)operation.default ListPlacementsPublisherlistPlacementsPaginator(ListPlacementsRequest listPlacementsRequest) This is a variant oflistPlacements(software.amazon.awssdk.services.iot1clickprojects.model.ListPlacementsRequest)operation.default CompletableFuture<ListProjectsResponse> Lists the AWS IoT 1-Click project(s) associated with your AWS account and region.default CompletableFuture<ListProjectsResponse> listProjects(Consumer<ListProjectsRequest.Builder> listProjectsRequest) Lists the AWS IoT 1-Click project(s) associated with your AWS account and region.default CompletableFuture<ListProjectsResponse> listProjects(ListProjectsRequest listProjectsRequest) Lists the AWS IoT 1-Click project(s) associated with your AWS account and region.default ListProjectsPublisherThis is a variant oflistProjects(software.amazon.awssdk.services.iot1clickprojects.model.ListProjectsRequest)operation.default ListProjectsPublisherlistProjectsPaginator(Consumer<ListProjectsRequest.Builder> listProjectsRequest) This is a variant oflistProjects(software.amazon.awssdk.services.iot1clickprojects.model.ListProjectsRequest)operation.default ListProjectsPublisherlistProjectsPaginator(ListProjectsRequest listProjectsRequest) This is a variant oflistProjects(software.amazon.awssdk.services.iot1clickprojects.model.ListProjectsRequest)operation.listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags (metadata key/value pairs) which you have assigned to the resource.listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags (metadata key/value pairs) which you have assigned to the resource.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationdefault CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Creates or modifies tags for a resource.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest) Creates or modifies tags for a resource.default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes one or more tags (metadata key/value pairs) from a resource.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes one or more tags (metadata key/value pairs) from a resource.default CompletableFuture<UpdatePlacementResponse> updatePlacement(Consumer<UpdatePlacementRequest.Builder> updatePlacementRequest) Updates a placement with the given attributes.default CompletableFuture<UpdatePlacementResponse> updatePlacement(UpdatePlacementRequest updatePlacementRequest) Updates a placement with the given attributes.default CompletableFuture<UpdateProjectResponse> updateProject(Consumer<UpdateProjectRequest.Builder> updateProjectRequest) Updates a project associated with your AWS account and region.default CompletableFuture<UpdateProjectResponse> updateProject(UpdateProjectRequest updateProjectRequest) Updates a project associated with your AWS account and region.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
closeMethods 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
-
associateDeviceWithPlacement
default CompletableFuture<AssociateDeviceWithPlacementResponse> associateDeviceWithPlacement(AssociateDeviceWithPlacementRequest associateDeviceWithPlacementRequest) Associates a physical device with a placement.
- Parameters:
associateDeviceWithPlacementRequest-- Returns:
- A Java Future containing the result of the AssociateDeviceWithPlacement operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalFailureException
- InvalidRequestException
- ResourceConflictException
- ResourceNotFoundException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Iot1ClickProjectsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
associateDeviceWithPlacement
default CompletableFuture<AssociateDeviceWithPlacementResponse> associateDeviceWithPlacement(Consumer<AssociateDeviceWithPlacementRequest.Builder> associateDeviceWithPlacementRequest) Associates a physical device with a placement.
This is a convenience which creates an instance of the
AssociateDeviceWithPlacementRequest.Builderavoiding the need to create one manually viaAssociateDeviceWithPlacementRequest.builder()- Parameters:
associateDeviceWithPlacementRequest- AConsumerthat will call methods onAssociateDeviceWithPlacementRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the AssociateDeviceWithPlacement operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalFailureException
- InvalidRequestException
- ResourceConflictException
- ResourceNotFoundException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Iot1ClickProjectsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createPlacement
default CompletableFuture<CreatePlacementResponse> createPlacement(CreatePlacementRequest createPlacementRequest) Creates an empty placement.
- Parameters:
createPlacementRequest-- Returns:
- A Java Future containing the result of the CreatePlacement operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalFailureException
- InvalidRequestException
- ResourceConflictException
- ResourceNotFoundException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Iot1ClickProjectsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createPlacement
default CompletableFuture<CreatePlacementResponse> createPlacement(Consumer<CreatePlacementRequest.Builder> createPlacementRequest) Creates an empty placement.
This is a convenience which creates an instance of the
CreatePlacementRequest.Builderavoiding the need to create one manually viaCreatePlacementRequest.builder()- Parameters:
createPlacementRequest- AConsumerthat will call methods onCreatePlacementRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreatePlacement operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalFailureException
- InvalidRequestException
- ResourceConflictException
- ResourceNotFoundException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Iot1ClickProjectsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createProject
default CompletableFuture<CreateProjectResponse> createProject(CreateProjectRequest createProjectRequest) Creates an empty project with a placement template. A project contains zero or more placements that adhere to the placement template defined in the project.
- Parameters:
createProjectRequest-- Returns:
- A Java Future containing the result of the CreateProject operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalFailureException
- InvalidRequestException
- ResourceConflictException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Iot1ClickProjectsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createProject
default CompletableFuture<CreateProjectResponse> createProject(Consumer<CreateProjectRequest.Builder> createProjectRequest) Creates an empty project with a placement template. A project contains zero or more placements that adhere to the placement template defined in the project.
This is a convenience which creates an instance of the
CreateProjectRequest.Builderavoiding the need to create one manually viaCreateProjectRequest.builder()- Parameters:
createProjectRequest- AConsumerthat will call methods onCreateProjectRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateProject operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalFailureException
- InvalidRequestException
- ResourceConflictException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Iot1ClickProjectsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deletePlacement
default CompletableFuture<DeletePlacementResponse> deletePlacement(DeletePlacementRequest deletePlacementRequest) Deletes a placement. To delete a placement, it must not have any devices associated with it.
When you delete a placement, all associated data becomes irretrievable.
- Parameters:
deletePlacementRequest-- Returns:
- A Java Future containing the result of the DeletePlacement operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalFailureException
- InvalidRequestException
- ResourceNotFoundException
- TooManyRequestsException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Iot1ClickProjectsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deletePlacement
default CompletableFuture<DeletePlacementResponse> deletePlacement(Consumer<DeletePlacementRequest.Builder> deletePlacementRequest) Deletes a placement. To delete a placement, it must not have any devices associated with it.
When you delete a placement, all associated data becomes irretrievable.
This is a convenience which creates an instance of the
DeletePlacementRequest.Builderavoiding the need to create one manually viaDeletePlacementRequest.builder()- Parameters:
deletePlacementRequest- AConsumerthat will call methods onDeletePlacementRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeletePlacement operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalFailureException
- InvalidRequestException
- ResourceNotFoundException
- TooManyRequestsException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Iot1ClickProjectsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteProject
default CompletableFuture<DeleteProjectResponse> deleteProject(DeleteProjectRequest deleteProjectRequest) Deletes a project. To delete a project, it must not have any placements associated with it.
When you delete a project, all associated data becomes irretrievable.
- Parameters:
deleteProjectRequest-- Returns:
- A Java Future containing the result of the DeleteProject operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalFailureException
- InvalidRequestException
- ResourceNotFoundException
- TooManyRequestsException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Iot1ClickProjectsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteProject
default CompletableFuture<DeleteProjectResponse> deleteProject(Consumer<DeleteProjectRequest.Builder> deleteProjectRequest) Deletes a project. To delete a project, it must not have any placements associated with it.
When you delete a project, all associated data becomes irretrievable.
This is a convenience which creates an instance of the
DeleteProjectRequest.Builderavoiding the need to create one manually viaDeleteProjectRequest.builder()- Parameters:
deleteProjectRequest- AConsumerthat will call methods onDeleteProjectRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteProject operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalFailureException
- InvalidRequestException
- ResourceNotFoundException
- TooManyRequestsException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Iot1ClickProjectsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describePlacement
default CompletableFuture<DescribePlacementResponse> describePlacement(DescribePlacementRequest describePlacementRequest) Describes a placement in a project.
- Parameters:
describePlacementRequest-- Returns:
- A Java Future containing the result of the DescribePlacement operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalFailureException
- InvalidRequestException
- ResourceNotFoundException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Iot1ClickProjectsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describePlacement
default CompletableFuture<DescribePlacementResponse> describePlacement(Consumer<DescribePlacementRequest.Builder> describePlacementRequest) Describes a placement in a project.
This is a convenience which creates an instance of the
DescribePlacementRequest.Builderavoiding the need to create one manually viaDescribePlacementRequest.builder()- Parameters:
describePlacementRequest- AConsumerthat will call methods onDescribePlacementRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribePlacement operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalFailureException
- InvalidRequestException
- ResourceNotFoundException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Iot1ClickProjectsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeProject
default CompletableFuture<DescribeProjectResponse> describeProject(DescribeProjectRequest describeProjectRequest) Returns an object describing a project.
- Parameters:
describeProjectRequest-- Returns:
- A Java Future containing the result of the DescribeProject operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalFailureException
- InvalidRequestException
- ResourceNotFoundException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Iot1ClickProjectsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeProject
default CompletableFuture<DescribeProjectResponse> describeProject(Consumer<DescribeProjectRequest.Builder> describeProjectRequest) Returns an object describing a project.
This is a convenience which creates an instance of the
DescribeProjectRequest.Builderavoiding the need to create one manually viaDescribeProjectRequest.builder()- Parameters:
describeProjectRequest- AConsumerthat will call methods onDescribeProjectRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeProject operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalFailureException
- InvalidRequestException
- ResourceNotFoundException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Iot1ClickProjectsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disassociateDeviceFromPlacement
default CompletableFuture<DisassociateDeviceFromPlacementResponse> disassociateDeviceFromPlacement(DisassociateDeviceFromPlacementRequest disassociateDeviceFromPlacementRequest) Removes a physical device from a placement.
- Parameters:
disassociateDeviceFromPlacementRequest-- Returns:
- A Java Future containing the result of the DisassociateDeviceFromPlacement operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalFailureException
- InvalidRequestException
- ResourceNotFoundException
- TooManyRequestsException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Iot1ClickProjectsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disassociateDeviceFromPlacement
default CompletableFuture<DisassociateDeviceFromPlacementResponse> disassociateDeviceFromPlacement(Consumer<DisassociateDeviceFromPlacementRequest.Builder> disassociateDeviceFromPlacementRequest) Removes a physical device from a placement.
This is a convenience which creates an instance of the
DisassociateDeviceFromPlacementRequest.Builderavoiding the need to create one manually viaDisassociateDeviceFromPlacementRequest.builder()- Parameters:
disassociateDeviceFromPlacementRequest- AConsumerthat will call methods onDisassociateDeviceFromPlacementRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DisassociateDeviceFromPlacement operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalFailureException
- InvalidRequestException
- ResourceNotFoundException
- TooManyRequestsException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Iot1ClickProjectsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDevicesInPlacement
default CompletableFuture<GetDevicesInPlacementResponse> getDevicesInPlacement(GetDevicesInPlacementRequest getDevicesInPlacementRequest) Returns an object enumerating the devices in a placement.
- Parameters:
getDevicesInPlacementRequest-- Returns:
- A Java Future containing the result of the GetDevicesInPlacement operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalFailureException
- InvalidRequestException
- ResourceNotFoundException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Iot1ClickProjectsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDevicesInPlacement
default CompletableFuture<GetDevicesInPlacementResponse> getDevicesInPlacement(Consumer<GetDevicesInPlacementRequest.Builder> getDevicesInPlacementRequest) Returns an object enumerating the devices in a placement.
This is a convenience which creates an instance of the
GetDevicesInPlacementRequest.Builderavoiding the need to create one manually viaGetDevicesInPlacementRequest.builder()- Parameters:
getDevicesInPlacementRequest- AConsumerthat will call methods onGetDevicesInPlacementRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetDevicesInPlacement operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalFailureException
- InvalidRequestException
- ResourceNotFoundException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Iot1ClickProjectsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPlacements
default CompletableFuture<ListPlacementsResponse> listPlacements(ListPlacementsRequest listPlacementsRequest) Lists the placement(s) of a project.
- Parameters:
listPlacementsRequest-- Returns:
- A Java Future containing the result of the ListPlacements operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalFailureException
- InvalidRequestException
- ResourceNotFoundException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Iot1ClickProjectsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPlacements
default CompletableFuture<ListPlacementsResponse> listPlacements(Consumer<ListPlacementsRequest.Builder> listPlacementsRequest) Lists the placement(s) of a project.
This is a convenience which creates an instance of the
ListPlacementsRequest.Builderavoiding the need to create one manually viaListPlacementsRequest.builder()- Parameters:
listPlacementsRequest- AConsumerthat will call methods onListPlacementsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListPlacements operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalFailureException
- InvalidRequestException
- ResourceNotFoundException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Iot1ClickProjectsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPlacementsPaginator
default ListPlacementsPublisher listPlacementsPaginator(ListPlacementsRequest listPlacementsRequest) This is a variant of
listPlacements(software.amazon.awssdk.services.iot1clickprojects.model.ListPlacementsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.iot1clickprojects.paginators.ListPlacementsPublisher publisher = client.listPlacementsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.iot1clickprojects.paginators.ListPlacementsPublisher publisher = client.listPlacementsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot1clickprojects.model.ListPlacementsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot1clickprojects.model.ListPlacementsResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPlacements(software.amazon.awssdk.services.iot1clickprojects.model.ListPlacementsRequest)operation.- Parameters:
listPlacementsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalFailureException
- InvalidRequestException
- ResourceNotFoundException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Iot1ClickProjectsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPlacementsPaginator
default ListPlacementsPublisher listPlacementsPaginator(Consumer<ListPlacementsRequest.Builder> listPlacementsRequest) This is a variant of
listPlacements(software.amazon.awssdk.services.iot1clickprojects.model.ListPlacementsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.iot1clickprojects.paginators.ListPlacementsPublisher publisher = client.listPlacementsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.iot1clickprojects.paginators.ListPlacementsPublisher publisher = client.listPlacementsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot1clickprojects.model.ListPlacementsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot1clickprojects.model.ListPlacementsResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPlacements(software.amazon.awssdk.services.iot1clickprojects.model.ListPlacementsRequest)operation.
This is a convenience which creates an instance of the
ListPlacementsRequest.Builderavoiding the need to create one manually viaListPlacementsRequest.builder()- Parameters:
listPlacementsRequest- AConsumerthat will call methods onListPlacementsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalFailureException
- InvalidRequestException
- ResourceNotFoundException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Iot1ClickProjectsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listProjects
default CompletableFuture<ListProjectsResponse> listProjects(ListProjectsRequest listProjectsRequest) Lists the AWS IoT 1-Click project(s) associated with your AWS account and region.
- Parameters:
listProjectsRequest-- Returns:
- A Java Future containing the result of the ListProjects operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalFailureException
- InvalidRequestException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Iot1ClickProjectsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listProjects
default CompletableFuture<ListProjectsResponse> listProjects(Consumer<ListProjectsRequest.Builder> listProjectsRequest) Lists the AWS IoT 1-Click project(s) associated with your AWS account and region.
This is a convenience which creates an instance of the
ListProjectsRequest.Builderavoiding the need to create one manually viaListProjectsRequest.builder()- Parameters:
listProjectsRequest- AConsumerthat will call methods onListProjectsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListProjects operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalFailureException
- InvalidRequestException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Iot1ClickProjectsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listProjects
Lists the AWS IoT 1-Click project(s) associated with your AWS account and region.
- Returns:
- A Java Future containing the result of the ListProjects operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalFailureException
- InvalidRequestException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Iot1ClickProjectsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listProjectsPaginator
This is a variant of
listProjects(software.amazon.awssdk.services.iot1clickprojects.model.ListProjectsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.iot1clickprojects.paginators.ListProjectsPublisher publisher = client.listProjectsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.iot1clickprojects.paginators.ListProjectsPublisher publisher = client.listProjectsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot1clickprojects.model.ListProjectsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot1clickprojects.model.ListProjectsResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProjects(software.amazon.awssdk.services.iot1clickprojects.model.ListProjectsRequest)operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalFailureException
- InvalidRequestException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Iot1ClickProjectsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listProjectsPaginator
This is a variant of
listProjects(software.amazon.awssdk.services.iot1clickprojects.model.ListProjectsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.iot1clickprojects.paginators.ListProjectsPublisher publisher = client.listProjectsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.iot1clickprojects.paginators.ListProjectsPublisher publisher = client.listProjectsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot1clickprojects.model.ListProjectsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot1clickprojects.model.ListProjectsResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProjects(software.amazon.awssdk.services.iot1clickprojects.model.ListProjectsRequest)operation.- Parameters:
listProjectsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalFailureException
- InvalidRequestException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Iot1ClickProjectsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listProjectsPaginator
default ListProjectsPublisher listProjectsPaginator(Consumer<ListProjectsRequest.Builder> listProjectsRequest) This is a variant of
listProjects(software.amazon.awssdk.services.iot1clickprojects.model.ListProjectsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.iot1clickprojects.paginators.ListProjectsPublisher publisher = client.listProjectsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.iot1clickprojects.paginators.ListProjectsPublisher publisher = client.listProjectsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot1clickprojects.model.ListProjectsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot1clickprojects.model.ListProjectsResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProjects(software.amazon.awssdk.services.iot1clickprojects.model.ListProjectsRequest)operation.
This is a convenience which creates an instance of the
ListProjectsRequest.Builderavoiding the need to create one manually viaListProjectsRequest.builder()- Parameters:
listProjectsRequest- AConsumerthat will call methods onListProjectsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalFailureException
- InvalidRequestException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Iot1ClickProjectsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags (metadata key/value pairs) which you have assigned to the resource.
- Parameters:
listTagsForResourceRequest-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalFailureException
- InvalidRequestException
- ResourceNotFoundException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Iot1ClickProjectsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags (metadata key/value pairs) which you have assigned to the resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalFailureException
- InvalidRequestException
- ResourceNotFoundException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Iot1ClickProjectsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
Creates or modifies tags for a resource. Tags are key/value pairs (metadata) that can be used to manage a resource. For more information, see AWS Tagging Strategies.
- Parameters:
tagResourceRequest-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalFailureException
- InvalidRequestException
- ResourceNotFoundException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Iot1ClickProjectsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Creates or modifies tags for a resource. Tags are key/value pairs (metadata) that can be used to manage a resource. For more information, see AWS Tagging Strategies.
This is a convenience which creates an instance of the
TagResourceRequest.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalFailureException
- InvalidRequestException
- ResourceNotFoundException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Iot1ClickProjectsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes one or more tags (metadata key/value pairs) from a resource.
- Parameters:
untagResourceRequest-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalFailureException
- InvalidRequestException
- ResourceNotFoundException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Iot1ClickProjectsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes one or more tags (metadata key/value pairs) from a resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalFailureException
- InvalidRequestException
- ResourceNotFoundException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Iot1ClickProjectsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updatePlacement
default CompletableFuture<UpdatePlacementResponse> updatePlacement(UpdatePlacementRequest updatePlacementRequest) Updates a placement with the given attributes. To clear an attribute, pass an empty value (i.e., "").
- Parameters:
updatePlacementRequest-- Returns:
- A Java Future containing the result of the UpdatePlacement operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalFailureException
- InvalidRequestException
- ResourceNotFoundException
- TooManyRequestsException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Iot1ClickProjectsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updatePlacement
default CompletableFuture<UpdatePlacementResponse> updatePlacement(Consumer<UpdatePlacementRequest.Builder> updatePlacementRequest) Updates a placement with the given attributes. To clear an attribute, pass an empty value (i.e., "").
This is a convenience which creates an instance of the
UpdatePlacementRequest.Builderavoiding the need to create one manually viaUpdatePlacementRequest.builder()- Parameters:
updatePlacementRequest- AConsumerthat will call methods onUpdatePlacementRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdatePlacement operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalFailureException
- InvalidRequestException
- ResourceNotFoundException
- TooManyRequestsException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Iot1ClickProjectsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateProject
default CompletableFuture<UpdateProjectResponse> updateProject(UpdateProjectRequest updateProjectRequest) Updates a project associated with your AWS account and region. With the exception of device template names, you can pass just the values that need to be updated because the update request will change only the values that are provided. To clear a value, pass the empty string (i.e.,
"").- Parameters:
updateProjectRequest-- Returns:
- A Java Future containing the result of the UpdateProject operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalFailureException
- InvalidRequestException
- ResourceNotFoundException
- TooManyRequestsException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Iot1ClickProjectsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateProject
default CompletableFuture<UpdateProjectResponse> updateProject(Consumer<UpdateProjectRequest.Builder> updateProjectRequest) Updates a project associated with your AWS account and region. With the exception of device template names, you can pass just the values that need to be updated because the update request will change only the values that are provided. To clear a value, pass the empty string (i.e.,
"").
This is a convenience which creates an instance of the
UpdateProjectRequest.Builderavoiding the need to create one manually viaUpdateProjectRequest.builder()- Parameters:
updateProjectRequest- AConsumerthat will call methods onUpdateProjectRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateProject operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalFailureException
- InvalidRequestException
- ResourceNotFoundException
- TooManyRequestsException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Iot1ClickProjectsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-
create
Create aIot1ClickProjectsAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aIot1ClickProjectsAsyncClient.
-