Interface Iot1ClickProjectsClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface Iot1ClickProjectsClient
extends AwsClient

Service client for accessing AWS IoT 1-Click Projects. This can be created using the static builder() method.

The AWS IoT 1-Click Projects API Reference

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
default AssociateDeviceWithPlacementResponse	associateDeviceWithPlacement(Consumer<AssociateDeviceWithPlacementRequest.Builder> associateDeviceWithPlacementRequest)	Associates a physical device with a placement.
default AssociateDeviceWithPlacementResponse	associateDeviceWithPlacement(AssociateDeviceWithPlacementRequest associateDeviceWithPlacementRequest)	Associates a physical device with a placement.
static Iot1ClickProjectsClientBuilder	builder()	Create a builder that can be used to configure and create a Iot1ClickProjectsClient.
static Iot1ClickProjectsClient	create()	Create a Iot1ClickProjectsClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
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.
default DisassociateDeviceFromPlacementResponse	disassociateDeviceFromPlacement(Consumer<DisassociateDeviceFromPlacementRequest.Builder> disassociateDeviceFromPlacementRequest)	Removes a physical device from a placement.
default DisassociateDeviceFromPlacementResponse	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 of listPlacements(software.amazon.awssdk.services.iot1clickprojects.model.ListPlacementsRequest) operation.
default ListPlacementsIterable	listPlacementsPaginator(ListPlacementsRequest listPlacementsRequest)	This is a variant of listPlacements(software.amazon.awssdk.services.iot1clickprojects.model.ListPlacementsRequest) operation.
default ListProjectsResponse	listProjects()	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	listProjectsPaginator()	This is a variant of listProjects(software.amazon.awssdk.services.iot1clickprojects.model.ListProjectsRequest) operation.
default ListProjectsIterable	listProjectsPaginator(Consumer<ListProjectsRequest.Builder> listProjectsRequest)	This is a variant of listProjects(software.amazon.awssdk.services.iot1clickprojects.model.ListProjectsRequest) operation.
default ListProjectsIterable	listProjectsPaginator(ListProjectsRequest listProjectsRequest)	This is a variant of listProjects(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.
default Iot1ClickProjectsServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	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

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

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:

• AWS API Documentation

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 via AssociateDeviceWithPlacementRequest.builder()

Parameters:

associateDeviceWithPlacementRequest - A Consumer that will call methods on AssociateDeviceWithPlacementRequest.Builder to create a request.

Returns:

Result of the AssociateDeviceWithPlacement operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via CreatePlacementRequest.builder()

Parameters:

createPlacementRequest - A Consumer that will call methods on CreatePlacementRequest.Builder to create a request.

Returns:

Result of the CreatePlacement operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via CreateProjectRequest.builder()

Parameters:

createProjectRequest - A Consumer that will call methods on CreateProjectRequest.Builder to create a request.

Returns:

Result of the CreateProject operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via DeletePlacementRequest.builder()

Parameters:

deletePlacementRequest - A Consumer that will call methods on DeletePlacementRequest.Builder to create a request.

Returns:

Result of the DeletePlacement operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via DeleteProjectRequest.builder()

Parameters:

deleteProjectRequest - A Consumer that will call methods on DeleteProjectRequest.Builder to create a request.

Returns:

Result of the DeleteProject operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via DescribePlacementRequest.builder()

Parameters:

describePlacementRequest - A Consumer that will call methods on DescribePlacementRequest.Builder to create a request.

Returns:

Result of the DescribePlacement operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via DescribeProjectRequest.builder()

Parameters:

describeProjectRequest - A Consumer that will call methods on DescribeProjectRequest.Builder to create a request.

Returns:

Result of the DescribeProject operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via DisassociateDeviceFromPlacementRequest.builder()

Parameters:

disassociateDeviceFromPlacementRequest - A Consumer that will call methods on DisassociateDeviceFromPlacementRequest.Builder to create a request.

Returns:

Result of the DisassociateDeviceFromPlacement operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via GetDevicesInPlacementRequest.builder()

Parameters:

getDevicesInPlacementRequest - A Consumer that will call methods on GetDevicesInPlacementRequest.Builder to create a request.

Returns:

Result of the GetDevicesInPlacement operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via ListPlacementsRequest.builder()

Parameters:

listPlacementsRequest - A Consumer that will call methods on ListPlacementsRequest.Builder to create a request.

Returns:

Result of the ListPlacements operation returned by the service.

See Also:

• AWS API Documentation

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 Stream

 
 software.amazon.awssdk.services.iot1clickprojects.paginators.ListPlacementsIterable responses = client.listPlacementsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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:

• AWS API Documentation

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 Stream

 
 software.amazon.awssdk.services.iot1clickprojects.paginators.ListPlacementsIterable responses = client.listPlacementsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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 via ListPlacementsRequest.builder()

Parameters:

listPlacementsRequest - A Consumer that will call methods on ListPlacementsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via ListProjectsRequest.builder()

Parameters:

listProjectsRequest - A Consumer that will call methods on ListProjectsRequest.Builder to create a request.

Returns:

Result of the ListProjects operation returned by the service.

See Also:

• AWS API Documentation

listProjects

default ListProjectsResponse listProjects()
                                   throws InternalFailureException,
InvalidRequestException,
AwsServiceException,
SdkClientException,
Iot1ClickProjectsException

Lists 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:

• listProjects(ListProjectsRequest)
• AWS API Documentation

listProjectsPaginator

default ListProjectsIterable listProjectsPaginator()
                                            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 Stream

 
 software.amazon.awssdk.services.iot1clickprojects.paginators.ListProjectsIterable responses = client.listProjectsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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(ListProjectsRequest)
• AWS API Documentation

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 Stream

 
 software.amazon.awssdk.services.iot1clickprojects.paginators.ListProjectsIterable responses = client.listProjectsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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:

• AWS API Documentation

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 Stream

 
 software.amazon.awssdk.services.iot1clickprojects.paginators.ListProjectsIterable responses = client.listProjectsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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 via ListProjectsRequest.builder()

Parameters:

listProjectsRequest - A Consumer that will call methods on ListProjectsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via ListTagsForResourceRequest.builder()

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via TagResourceRequest.builder()

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via UntagResourceRequest.builder()

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via UpdatePlacementRequest.builder()

Parameters:

updatePlacementRequest - A Consumer that will call methods on UpdatePlacementRequest.Builder to create a request.

Returns:

Result of the UpdatePlacement operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via UpdateProjectRequest.builder()

Parameters:

updateProjectRequest - A Consumer that will call methods on UpdateProjectRequest.Builder to create a request.

Returns:

Result of the UpdateProject operation returned by the service.

See Also:

• AWS API Documentation

create

static Iot1ClickProjectsClient create()

Create a Iot1ClickProjectsClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static Iot1ClickProjectsClientBuilder builder()

Create a builder that can be used to configure and create a Iot1ClickProjectsClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default Iot1ClickProjectsServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration