@Generated(value="software.amazon.awssdk:codegen") public interface Iot1ClickProjectsAsyncClient extends SdkClient
builder()
method.
The AWS IoT 1-Click Project API Reference
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
serviceName
close
static final String SERVICE_NAME
static Iot1ClickProjectsAsyncClient create()
Iot1ClickProjectsAsyncClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static Iot1ClickProjectsAsyncClientBuilder builder()
Iot1ClickProjectsAsyncClient
.default CompletableFuture<AssociateDeviceWithPlacementResponse> associateDeviceWithPlacement(AssociateDeviceWithPlacementRequest associateDeviceWithPlacementRequest)
Associates a physical device with a placement.
associateDeviceWithPlacementRequest
- 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.Builder
avoiding the need to create one manually via AssociateDeviceWithPlacementRequest.builder()
associateDeviceWithPlacementRequest
- A Consumer
that will call methods on AssociateDeviceWithPlacementRequest.Builder
to create
a request.default CompletableFuture<CreatePlacementResponse> createPlacement(CreatePlacementRequest createPlacementRequest)
Creates an empty placement.
createPlacementRequest
- default CompletableFuture<CreatePlacementResponse> createPlacement(Consumer<CreatePlacementRequest.Builder> createPlacementRequest)
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()
createPlacementRequest
- A Consumer
that will call methods on CreatePlacementRequest.Builder
to create a request.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.
createProjectRequest
- 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.Builder
avoiding the need to
create one manually via CreateProjectRequest.builder()
createProjectRequest
- A Consumer
that will call methods on CreateProjectRequest.Builder
to create a request.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.
deletePlacementRequest
- 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.Builder
avoiding the need
to create one manually via DeletePlacementRequest.builder()
deletePlacementRequest
- A Consumer
that will call methods on DeletePlacementRequest.Builder
to create a request.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.
deleteProjectRequest
- 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.Builder
avoiding the need to
create one manually via DeleteProjectRequest.builder()
deleteProjectRequest
- A Consumer
that will call methods on DeleteProjectRequest.Builder
to create a request.default CompletableFuture<DescribePlacementResponse> describePlacement(DescribePlacementRequest describePlacementRequest)
Describes a placement in a project.
describePlacementRequest
- 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.Builder
avoiding the need
to create one manually via DescribePlacementRequest.builder()
describePlacementRequest
- A Consumer
that will call methods on DescribePlacementRequest.Builder
to create a request.default CompletableFuture<DescribeProjectResponse> describeProject(DescribeProjectRequest describeProjectRequest)
Returns an object describing a project.
describeProjectRequest
- 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.Builder
avoiding the need
to create one manually via DescribeProjectRequest.builder()
describeProjectRequest
- A Consumer
that will call methods on DescribeProjectRequest.Builder
to create a request.default CompletableFuture<DisassociateDeviceFromPlacementResponse> disassociateDeviceFromPlacement(DisassociateDeviceFromPlacementRequest disassociateDeviceFromPlacementRequest)
Removes a physical device from a placement.
disassociateDeviceFromPlacementRequest
- 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.Builder
avoiding the need to create one manually via DisassociateDeviceFromPlacementRequest.builder()
disassociateDeviceFromPlacementRequest
- A Consumer
that will call methods on DisassociateDeviceFromPlacementRequest.Builder
to
create a request.default CompletableFuture<GetDevicesInPlacementResponse> getDevicesInPlacement(GetDevicesInPlacementRequest getDevicesInPlacementRequest)
Returns an object enumerating the devices in a placement.
getDevicesInPlacementRequest
- 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.Builder
avoiding the
need to create one manually via GetDevicesInPlacementRequest.builder()
getDevicesInPlacementRequest
- A Consumer
that will call methods on GetDevicesInPlacementRequest.Builder
to create a
request.default CompletableFuture<ListPlacementsResponse> listPlacements(ListPlacementsRequest listPlacementsRequest)
Lists the placement(s) of a project.
listPlacementsRequest
- 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.Builder
avoiding the need to
create one manually via ListPlacementsRequest.builder()
listPlacementsRequest
- A Consumer
that will call methods on ListPlacementsRequest.Builder
to create a request.default CompletableFuture<ListProjectsResponse> listProjects(ListProjectsRequest listProjectsRequest)
Lists the AWS IoT 1-Click project(s) associated with your AWS account and region.
listProjectsRequest
- 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.Builder
avoiding the need to
create one manually via ListProjectsRequest.builder()
listProjectsRequest
- A Consumer
that will call methods on ListProjectsRequest.Builder
to create a request.default CompletableFuture<ListProjectsResponse> listProjects()
Lists the AWS IoT 1-Click project(s) associated with your AWS account and region.
default CompletableFuture<UpdatePlacementResponse> updatePlacement(UpdatePlacementRequest updatePlacementRequest)
Updates a placement with the given attributes. To clear an attribute, pass an empty value (i.e., "").
updatePlacementRequest
- 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.Builder
avoiding the need
to create one manually via UpdatePlacementRequest.builder()
updatePlacementRequest
- A Consumer
that will call methods on UpdatePlacementRequest.Builder
to create a request.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., ""
).
updateProjectRequest
- 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.Builder
avoiding the need to
create one manually via UpdateProjectRequest.builder()
updateProjectRequest
- A Consumer
that will call methods on UpdateProjectRequest.Builder
to create a request.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.