Interface Iot1ClickProjectsClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
The AWS IoT 1-Click Projects API Reference
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value 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 aIot1ClickProjectsClient
.static Iot1ClickProjectsClient
create()
Create aIot1ClickProjectsClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreatePlacementResponse
createPlacement
(Consumer<CreatePlacementRequest.Builder> createPlacementRequest) Creates an empty placement.default CreatePlacementResponse
createPlacement
(CreatePlacementRequest createPlacementRequest) Creates an empty placement.default CreateProjectResponse
createProject
(Consumer<CreateProjectRequest.Builder> createProjectRequest) Creates an empty project with a placement template.default CreateProjectResponse
createProject
(CreateProjectRequest createProjectRequest) Creates an empty project with a placement template.default DeletePlacementResponse
deletePlacement
(Consumer<DeletePlacementRequest.Builder> deletePlacementRequest) Deletes a placement.default DeletePlacementResponse
deletePlacement
(DeletePlacementRequest deletePlacementRequest) Deletes a placement.default DeleteProjectResponse
deleteProject
(Consumer<DeleteProjectRequest.Builder> deleteProjectRequest) Deletes a project.default DeleteProjectResponse
deleteProject
(DeleteProjectRequest deleteProjectRequest) Deletes a project.default DescribePlacementResponse
describePlacement
(Consumer<DescribePlacementRequest.Builder> describePlacementRequest) Describes a placement in a project.default DescribePlacementResponse
describePlacement
(DescribePlacementRequest describePlacementRequest) Describes a placement in a project.default DescribeProjectResponse
describeProject
(Consumer<DescribeProjectRequest.Builder> describeProjectRequest) Returns an object describing a project.default 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.default GetDevicesInPlacementResponse
getDevicesInPlacement
(Consumer<GetDevicesInPlacementRequest.Builder> getDevicesInPlacementRequest) Returns an object enumerating the devices in a placement.default GetDevicesInPlacementResponse
getDevicesInPlacement
(GetDevicesInPlacementRequest getDevicesInPlacementRequest) Returns an object enumerating the devices in a placement.default ListPlacementsResponse
listPlacements
(Consumer<ListPlacementsRequest.Builder> listPlacementsRequest) Lists the placement(s) of a project.default ListPlacementsResponse
listPlacements
(ListPlacementsRequest listPlacementsRequest) Lists the placement(s) of a project.default ListPlacementsIterable
listPlacementsPaginator
(Consumer<ListPlacementsRequest.Builder> listPlacementsRequest) This is a variant oflistPlacements(software.amazon.awssdk.services.iot1clickprojects.model.ListPlacementsRequest)
operation.default ListPlacementsIterable
listPlacementsPaginator
(ListPlacementsRequest listPlacementsRequest) This is a variant oflistPlacements(software.amazon.awssdk.services.iot1clickprojects.model.ListPlacementsRequest)
operation.default ListProjectsResponse
Lists the AWS IoT 1-Click project(s) associated with your AWS account and region.default ListProjectsResponse
listProjects
(Consumer<ListProjectsRequest.Builder> listProjectsRequest) Lists the AWS IoT 1-Click project(s) associated with your AWS account and region.default ListProjectsResponse
listProjects
(ListProjectsRequest listProjectsRequest) Lists the AWS IoT 1-Click project(s) associated with your AWS account and region.default ListProjectsIterable
This is a variant oflistProjects(software.amazon.awssdk.services.iot1clickprojects.model.ListProjectsRequest)
operation.default ListProjectsIterable
listProjectsPaginator
(Consumer<ListProjectsRequest.Builder> listProjectsRequest) This is a variant oflistProjects(software.amazon.awssdk.services.iot1clickprojects.model.ListProjectsRequest)
operation.default ListProjectsIterable
listProjectsPaginator
(ListProjectsRequest listProjectsRequest) This is a variant oflistProjects(software.amazon.awssdk.services.iot1clickprojects.model.ListProjectsRequest)
operation.default ListTagsForResourceResponse
listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags (metadata key/value pairs) which you have assigned to the resource.default ListTagsForResourceResponse
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., ClientOverrideConfigurationstatic ServiceMetadata
default TagResourceResponse
tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Creates or modifies tags for a resource.default TagResourceResponse
tagResource
(TagResourceRequest tagResourceRequest) Creates or modifies tags for a resource.default UntagResourceResponse
untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes one or more tags (metadata key/value pairs) from a resource.default UntagResourceResponse
untagResource
(UntagResourceRequest untagResourceRequest) Removes one or more tags (metadata key/value pairs) from a resource.default UpdatePlacementResponse
updatePlacement
(Consumer<UpdatePlacementRequest.Builder> updatePlacementRequest) Updates a placement with the given attributes.default UpdatePlacementResponse
updatePlacement
(UpdatePlacementRequest updatePlacementRequest) Updates a placement with the given attributes.default UpdateProjectResponse
updateProject
(Consumer<UpdateProjectRequest.Builder> updateProjectRequest) Updates a project associated with your AWS account and region.default UpdateProjectResponse
updateProject
(UpdateProjectRequest updateProjectRequest) Updates a project associated with your AWS account and region.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
-
associateDeviceWithPlacement
default AssociateDeviceWithPlacementResponse associateDeviceWithPlacement(AssociateDeviceWithPlacementRequest associateDeviceWithPlacementRequest) throws InternalFailureException, InvalidRequestException, ResourceConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, Iot1ClickProjectsException Associates a physical device with a placement.
- Parameters:
associateDeviceWithPlacementRequest
-- Returns:
- Result of the AssociateDeviceWithPlacement operation returned by the service.
- See Also:
-
associateDeviceWithPlacement
default AssociateDeviceWithPlacementResponse associateDeviceWithPlacement(Consumer<AssociateDeviceWithPlacementRequest.Builder> associateDeviceWithPlacementRequest) throws InternalFailureException, InvalidRequestException, ResourceConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, Iot1ClickProjectsException Associates a physical device with a placement.
This is a convenience which creates an instance of the
AssociateDeviceWithPlacementRequest.Builder
avoiding the need to create one manually viaAssociateDeviceWithPlacementRequest.builder()
- Parameters:
associateDeviceWithPlacementRequest
- AConsumer
that will call methods onAssociateDeviceWithPlacementRequest.Builder
to create a request.- Returns:
- Result of the AssociateDeviceWithPlacement operation returned by the service.
- See Also:
-
createPlacement
default CreatePlacementResponse createPlacement(CreatePlacementRequest createPlacementRequest) throws InternalFailureException, InvalidRequestException, ResourceConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, Iot1ClickProjectsException Creates an empty placement.
- Parameters:
createPlacementRequest
-- Returns:
- Result of the CreatePlacement operation returned by the service.
- See Also:
-
createPlacement
default CreatePlacementResponse createPlacement(Consumer<CreatePlacementRequest.Builder> createPlacementRequest) throws InternalFailureException, InvalidRequestException, ResourceConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, Iot1ClickProjectsException Creates an empty placement.
This is a convenience which creates an instance of the
CreatePlacementRequest.Builder
avoiding the need to create one manually viaCreatePlacementRequest.builder()
- Parameters:
createPlacementRequest
- AConsumer
that will call methods onCreatePlacementRequest.Builder
to create a request.- Returns:
- Result of the CreatePlacement operation returned by the service.
- See Also:
-
createProject
default CreateProjectResponse createProject(CreateProjectRequest createProjectRequest) throws InternalFailureException, InvalidRequestException, ResourceConflictException, AwsServiceException, SdkClientException, Iot1ClickProjectsException 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:
- Result of the CreateProject operation returned by the service.
- See Also:
-
createProject
default CreateProjectResponse createProject(Consumer<CreateProjectRequest.Builder> createProjectRequest) throws InternalFailureException, InvalidRequestException, ResourceConflictException, AwsServiceException, SdkClientException, Iot1ClickProjectsException 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.Builder
avoiding the need to create one manually viaCreateProjectRequest.builder()
- Parameters:
createProjectRequest
- AConsumer
that will call methods onCreateProjectRequest.Builder
to create a request.- Returns:
- Result of the CreateProject operation returned by the service.
- See Also:
-
deletePlacement
default DeletePlacementResponse deletePlacement(DeletePlacementRequest deletePlacementRequest) throws InternalFailureException, InvalidRequestException, ResourceNotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, Iot1ClickProjectsException 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:
- Result of the DeletePlacement operation returned by the service.
- See Also:
-
deletePlacement
default DeletePlacementResponse deletePlacement(Consumer<DeletePlacementRequest.Builder> deletePlacementRequest) throws InternalFailureException, InvalidRequestException, ResourceNotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, Iot1ClickProjectsException 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.Builder
avoiding the need to create one manually viaDeletePlacementRequest.builder()
- Parameters:
deletePlacementRequest
- AConsumer
that will call methods onDeletePlacementRequest.Builder
to create a request.- Returns:
- Result of the DeletePlacement operation returned by the service.
- See Also:
-
deleteProject
default DeleteProjectResponse deleteProject(DeleteProjectRequest deleteProjectRequest) throws InternalFailureException, InvalidRequestException, ResourceNotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, Iot1ClickProjectsException 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:
- Result of the DeleteProject operation returned by the service.
- See Also:
-
deleteProject
default DeleteProjectResponse deleteProject(Consumer<DeleteProjectRequest.Builder> deleteProjectRequest) throws InternalFailureException, InvalidRequestException, ResourceNotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, Iot1ClickProjectsException 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.Builder
avoiding the need to create one manually viaDeleteProjectRequest.builder()
- Parameters:
deleteProjectRequest
- AConsumer
that will call methods onDeleteProjectRequest.Builder
to create a request.- Returns:
- Result of the DeleteProject operation returned by the service.
- See Also:
-
describePlacement
default DescribePlacementResponse describePlacement(DescribePlacementRequest describePlacementRequest) throws InternalFailureException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, Iot1ClickProjectsException Describes a placement in a project.
- Parameters:
describePlacementRequest
-- Returns:
- Result of the DescribePlacement operation returned by the service.
- See Also:
-
describePlacement
default DescribePlacementResponse describePlacement(Consumer<DescribePlacementRequest.Builder> describePlacementRequest) throws InternalFailureException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, Iot1ClickProjectsException Describes a placement in a project.
This is a convenience which creates an instance of the
DescribePlacementRequest.Builder
avoiding the need to create one manually viaDescribePlacementRequest.builder()
- Parameters:
describePlacementRequest
- AConsumer
that will call methods onDescribePlacementRequest.Builder
to create a request.- Returns:
- Result of the DescribePlacement operation returned by the service.
- See Also:
-
describeProject
default DescribeProjectResponse describeProject(DescribeProjectRequest describeProjectRequest) throws InternalFailureException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, Iot1ClickProjectsException Returns an object describing a project.
- Parameters:
describeProjectRequest
-- Returns:
- Result of the DescribeProject operation returned by the service.
- See Also:
-
describeProject
default DescribeProjectResponse describeProject(Consumer<DescribeProjectRequest.Builder> describeProjectRequest) throws InternalFailureException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, Iot1ClickProjectsException Returns an object describing a project.
This is a convenience which creates an instance of the
DescribeProjectRequest.Builder
avoiding the need to create one manually viaDescribeProjectRequest.builder()
- Parameters:
describeProjectRequest
- AConsumer
that will call methods onDescribeProjectRequest.Builder
to create a request.- Returns:
- Result of the DescribeProject operation returned by the service.
- See Also:
-
disassociateDeviceFromPlacement
default DisassociateDeviceFromPlacementResponse disassociateDeviceFromPlacement(DisassociateDeviceFromPlacementRequest disassociateDeviceFromPlacementRequest) throws InternalFailureException, InvalidRequestException, ResourceNotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, Iot1ClickProjectsException Removes a physical device from a placement.
- Parameters:
disassociateDeviceFromPlacementRequest
-- Returns:
- Result of the DisassociateDeviceFromPlacement operation returned by the service.
- See Also:
-
disassociateDeviceFromPlacement
default DisassociateDeviceFromPlacementResponse disassociateDeviceFromPlacement(Consumer<DisassociateDeviceFromPlacementRequest.Builder> disassociateDeviceFromPlacementRequest) throws InternalFailureException, InvalidRequestException, ResourceNotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, Iot1ClickProjectsException Removes a physical device from a placement.
This is a convenience which creates an instance of the
DisassociateDeviceFromPlacementRequest.Builder
avoiding the need to create one manually viaDisassociateDeviceFromPlacementRequest.builder()
- Parameters:
disassociateDeviceFromPlacementRequest
- AConsumer
that will call methods onDisassociateDeviceFromPlacementRequest.Builder
to create a request.- Returns:
- Result of the DisassociateDeviceFromPlacement operation returned by the service.
- See Also:
-
getDevicesInPlacement
default GetDevicesInPlacementResponse getDevicesInPlacement(GetDevicesInPlacementRequest getDevicesInPlacementRequest) throws InternalFailureException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, Iot1ClickProjectsException Returns an object enumerating the devices in a placement.
- Parameters:
getDevicesInPlacementRequest
-- Returns:
- Result of the GetDevicesInPlacement operation returned by the service.
- See Also:
-
getDevicesInPlacement
default GetDevicesInPlacementResponse getDevicesInPlacement(Consumer<GetDevicesInPlacementRequest.Builder> getDevicesInPlacementRequest) throws InternalFailureException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, Iot1ClickProjectsException Returns an object enumerating the devices in a placement.
This is a convenience which creates an instance of the
GetDevicesInPlacementRequest.Builder
avoiding the need to create one manually viaGetDevicesInPlacementRequest.builder()
- Parameters:
getDevicesInPlacementRequest
- AConsumer
that will call methods onGetDevicesInPlacementRequest.Builder
to create a request.- Returns:
- Result of the GetDevicesInPlacement operation returned by the service.
- See Also:
-
listPlacements
default ListPlacementsResponse listPlacements(ListPlacementsRequest listPlacementsRequest) throws InternalFailureException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, Iot1ClickProjectsException Lists the placement(s) of a project.
- Parameters:
listPlacementsRequest
-- Returns:
- Result of the ListPlacements operation returned by the service.
- See Also:
-
listPlacements
default ListPlacementsResponse listPlacements(Consumer<ListPlacementsRequest.Builder> listPlacementsRequest) throws InternalFailureException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, Iot1ClickProjectsException Lists the placement(s) of a project.
This is a convenience which creates an instance of the
ListPlacementsRequest.Builder
avoiding the need to create one manually viaListPlacementsRequest.builder()
- Parameters:
listPlacementsRequest
- AConsumer
that will call methods onListPlacementsRequest.Builder
to create a request.- Returns:
- Result of the ListPlacements operation returned by the service.
- See Also:
-
listPlacementsPaginator
default ListPlacementsIterable listPlacementsPaginator(ListPlacementsRequest listPlacementsRequest) throws InternalFailureException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, Iot1ClickProjectsException This is a variant of
listPlacements(software.amazon.awssdk.services.iot1clickprojects.model.ListPlacementsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot1clickprojects.paginators.ListPlacementsIterable responses = client.listPlacementsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot1clickprojects.paginators.ListPlacementsIterable responses = client .listPlacementsPaginator(request); for (software.amazon.awssdk.services.iot1clickprojects.model.ListPlacementsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot1clickprojects.paginators.ListPlacementsIterable responses = client.listPlacementsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listPlacementsPaginator
default ListPlacementsIterable listPlacementsPaginator(Consumer<ListPlacementsRequest.Builder> listPlacementsRequest) throws InternalFailureException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, Iot1ClickProjectsException This is a variant of
listPlacements(software.amazon.awssdk.services.iot1clickprojects.model.ListPlacementsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot1clickprojects.paginators.ListPlacementsIterable responses = client.listPlacementsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot1clickprojects.paginators.ListPlacementsIterable responses = client .listPlacementsPaginator(request); for (software.amazon.awssdk.services.iot1clickprojects.model.ListPlacementsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot1clickprojects.paginators.ListPlacementsIterable responses = client.listPlacementsPaginator(request); responses.iterator().forEachRemaining(....);
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.Builder
avoiding the need to create one manually viaListPlacementsRequest.builder()
- Parameters:
listPlacementsRequest
- AConsumer
that will call methods onListPlacementsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listProjects
default ListProjectsResponse listProjects(ListProjectsRequest listProjectsRequest) throws InternalFailureException, InvalidRequestException, AwsServiceException, SdkClientException, Iot1ClickProjectsException Lists the AWS IoT 1-Click project(s) associated with your AWS account and region.
- Parameters:
listProjectsRequest
-- Returns:
- Result of the ListProjects operation returned by the service.
- See Also:
-
listProjects
default ListProjectsResponse listProjects(Consumer<ListProjectsRequest.Builder> listProjectsRequest) throws InternalFailureException, InvalidRequestException, AwsServiceException, SdkClientException, Iot1ClickProjectsException 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.Builder
avoiding the need to create one manually viaListProjectsRequest.builder()
- Parameters:
listProjectsRequest
- AConsumer
that will call methods onListProjectsRequest.Builder
to create a request.- Returns:
- Result of the ListProjects operation returned by the service.
- See Also:
-
listProjects
default ListProjectsResponse listProjects() throws InternalFailureException, InvalidRequestException, AwsServiceException, SdkClientException, Iot1ClickProjectsExceptionLists the AWS IoT 1-Click project(s) associated with your AWS account and region.
- Returns:
- Result of the ListProjects operation returned by the service.
- See Also:
-
listProjectsPaginator
default ListProjectsIterable listProjectsPaginator() throws InternalFailureException, InvalidRequestException, AwsServiceException, SdkClientException, Iot1ClickProjectsExceptionThis is a variant of
listProjects(software.amazon.awssdk.services.iot1clickprojects.model.ListProjectsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot1clickprojects.paginators.ListProjectsIterable responses = client.listProjectsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot1clickprojects.paginators.ListProjectsIterable responses = client .listProjectsPaginator(request); for (software.amazon.awssdk.services.iot1clickprojects.model.ListProjectsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot1clickprojects.paginators.ListProjectsIterable responses = client.listProjectsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listProjectsPaginator
default ListProjectsIterable listProjectsPaginator(ListProjectsRequest listProjectsRequest) throws InternalFailureException, InvalidRequestException, AwsServiceException, SdkClientException, Iot1ClickProjectsException This is a variant of
listProjects(software.amazon.awssdk.services.iot1clickprojects.model.ListProjectsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot1clickprojects.paginators.ListProjectsIterable responses = client.listProjectsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot1clickprojects.paginators.ListProjectsIterable responses = client .listProjectsPaginator(request); for (software.amazon.awssdk.services.iot1clickprojects.model.ListProjectsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot1clickprojects.paginators.ListProjectsIterable responses = client.listProjectsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listProjectsPaginator
default ListProjectsIterable listProjectsPaginator(Consumer<ListProjectsRequest.Builder> listProjectsRequest) throws InternalFailureException, InvalidRequestException, AwsServiceException, SdkClientException, Iot1ClickProjectsException This is a variant of
listProjects(software.amazon.awssdk.services.iot1clickprojects.model.ListProjectsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot1clickprojects.paginators.ListProjectsIterable responses = client.listProjectsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot1clickprojects.paginators.ListProjectsIterable responses = client .listProjectsPaginator(request); for (software.amazon.awssdk.services.iot1clickprojects.model.ListProjectsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot1clickprojects.paginators.ListProjectsIterable responses = client.listProjectsPaginator(request); responses.iterator().forEachRemaining(....);
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.Builder
avoiding the need to create one manually viaListProjectsRequest.builder()
- Parameters:
listProjectsRequest
- AConsumer
that will call methods onListProjectsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InternalFailureException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, Iot1ClickProjectsException Lists the tags (metadata key/value pairs) which you have assigned to the resource.
- Parameters:
listTagsForResourceRequest
-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InternalFailureException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, Iot1ClickProjectsException 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.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InternalFailureException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, Iot1ClickProjectsException 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:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws InternalFailureException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, Iot1ClickProjectsException 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.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InternalFailureException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, Iot1ClickProjectsException Removes one or more tags (metadata key/value pairs) from a resource.
- Parameters:
untagResourceRequest
-- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws InternalFailureException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, Iot1ClickProjectsException Removes one or more tags (metadata key/value pairs) from a resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updatePlacement
default UpdatePlacementResponse updatePlacement(UpdatePlacementRequest updatePlacementRequest) throws InternalFailureException, InvalidRequestException, ResourceNotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, Iot1ClickProjectsException Updates a placement with the given attributes. To clear an attribute, pass an empty value (i.e., "").
- Parameters:
updatePlacementRequest
-- Returns:
- Result of the UpdatePlacement operation returned by the service.
- See Also:
-
updatePlacement
default UpdatePlacementResponse updatePlacement(Consumer<UpdatePlacementRequest.Builder> updatePlacementRequest) throws InternalFailureException, InvalidRequestException, ResourceNotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, Iot1ClickProjectsException 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.Builder
avoiding the need to create one manually viaUpdatePlacementRequest.builder()
- Parameters:
updatePlacementRequest
- AConsumer
that will call methods onUpdatePlacementRequest.Builder
to create a request.- Returns:
- Result of the UpdatePlacement operation returned by the service.
- See Also:
-
updateProject
default UpdateProjectResponse updateProject(UpdateProjectRequest updateProjectRequest) throws InternalFailureException, InvalidRequestException, ResourceNotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, Iot1ClickProjectsException 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:
- Result of the UpdateProject operation returned by the service.
- See Also:
-
updateProject
default UpdateProjectResponse updateProject(Consumer<UpdateProjectRequest.Builder> updateProjectRequest) throws InternalFailureException, InvalidRequestException, ResourceNotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, Iot1ClickProjectsException 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.Builder
avoiding the need to create one manually viaUpdateProjectRequest.builder()
- Parameters:
updateProjectRequest
- AConsumer
that will call methods onUpdateProjectRequest.Builder
to create a request.- Returns:
- Result of the UpdateProject operation returned by the service.
- See Also:
-
create
Create aIot1ClickProjectsClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aIot1ClickProjectsClient
. -
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
-