@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSIoT1ClickProjects
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSIoT1ClickProjects instead.
The AWS IoT 1-Click Projects API Reference
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| Modifier and Type | Method and Description |
|---|---|
AssociateDeviceWithPlacementResult |
associateDeviceWithPlacement(AssociateDeviceWithPlacementRequest associateDeviceWithPlacementRequest)
Associates a physical device with a placement.
|
CreatePlacementResult |
createPlacement(CreatePlacementRequest createPlacementRequest)
Creates an empty placement.
|
CreateProjectResult |
createProject(CreateProjectRequest createProjectRequest)
Creates an empty project with a placement template.
|
DeletePlacementResult |
deletePlacement(DeletePlacementRequest deletePlacementRequest)
Deletes a placement.
|
DeleteProjectResult |
deleteProject(DeleteProjectRequest deleteProjectRequest)
Deletes a project.
|
DescribePlacementResult |
describePlacement(DescribePlacementRequest describePlacementRequest)
Describes a placement in a project.
|
DescribeProjectResult |
describeProject(DescribeProjectRequest describeProjectRequest)
Returns an object describing a project.
|
DisassociateDeviceFromPlacementResult |
disassociateDeviceFromPlacement(DisassociateDeviceFromPlacementRequest disassociateDeviceFromPlacementRequest)
Removes a physical device from a placement.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetDevicesInPlacementResult |
getDevicesInPlacement(GetDevicesInPlacementRequest getDevicesInPlacementRequest)
Returns an object enumerating the devices in a placement.
|
ListPlacementsResult |
listPlacements(ListPlacementsRequest listPlacementsRequest)
Lists the placement(s) of a project.
|
ListProjectsResult |
listProjects(ListProjectsRequest listProjectsRequest)
Lists the AWS IoT 1-Click project(s) associated with your AWS account and region.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags (metadata key/value pairs) which you have assigned to the resource.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
Creates or modifies tags for a resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Removes one or more tags (metadata key/value pairs) from a resource.
|
UpdatePlacementResult |
updatePlacement(UpdatePlacementRequest updatePlacementRequest)
Updates a placement with the given attributes.
|
UpdateProjectResult |
updateProject(UpdateProjectRequest updateProjectRequest)
Updates a project associated with your AWS account and region.
|
static final String ENDPOINT_PREFIX
AssociateDeviceWithPlacementResult associateDeviceWithPlacement(AssociateDeviceWithPlacementRequest associateDeviceWithPlacementRequest)
Associates a physical device with a placement.
associateDeviceWithPlacementRequest - InternalFailureExceptionInvalidRequestExceptionResourceConflictExceptionResourceNotFoundExceptionCreatePlacementResult createPlacement(CreatePlacementRequest createPlacementRequest)
Creates an empty placement.
createPlacementRequest - InternalFailureExceptionInvalidRequestExceptionResourceConflictExceptionResourceNotFoundExceptionCreateProjectResult 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 - InternalFailureExceptionInvalidRequestExceptionResourceConflictExceptionDeletePlacementResult 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 - InternalFailureExceptionInvalidRequestExceptionResourceNotFoundExceptionTooManyRequestsExceptionDeleteProjectResult 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 - InternalFailureExceptionInvalidRequestExceptionResourceNotFoundExceptionTooManyRequestsExceptionDescribePlacementResult describePlacement(DescribePlacementRequest describePlacementRequest)
Describes a placement in a project.
describePlacementRequest - InternalFailureExceptionInvalidRequestExceptionResourceNotFoundExceptionDescribeProjectResult describeProject(DescribeProjectRequest describeProjectRequest)
Returns an object describing a project.
describeProjectRequest - InternalFailureExceptionInvalidRequestExceptionResourceNotFoundExceptionDisassociateDeviceFromPlacementResult disassociateDeviceFromPlacement(DisassociateDeviceFromPlacementRequest disassociateDeviceFromPlacementRequest)
Removes a physical device from a placement.
disassociateDeviceFromPlacementRequest - InternalFailureExceptionInvalidRequestExceptionResourceNotFoundExceptionTooManyRequestsExceptionGetDevicesInPlacementResult getDevicesInPlacement(GetDevicesInPlacementRequest getDevicesInPlacementRequest)
Returns an object enumerating the devices in a placement.
getDevicesInPlacementRequest - InternalFailureExceptionInvalidRequestExceptionResourceNotFoundExceptionListPlacementsResult listPlacements(ListPlacementsRequest listPlacementsRequest)
Lists the placement(s) of a project.
listPlacementsRequest - InternalFailureExceptionInvalidRequestExceptionResourceNotFoundExceptionListProjectsResult listProjects(ListProjectsRequest listProjectsRequest)
Lists the AWS IoT 1-Click project(s) associated with your AWS account and region.
listProjectsRequest - InternalFailureExceptionInvalidRequestExceptionListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags (metadata key/value pairs) which you have assigned to the resource.
listTagsForResourceRequest - InternalFailureExceptionInvalidRequestExceptionResourceNotFoundExceptionTagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Creates or modifies tags for a resource. Tags are key/value pairs (metadata) that can be used to manage a resource. For more information, see AWS Tagging Strategies.
tagResourceRequest - InternalFailureExceptionInvalidRequestExceptionResourceNotFoundExceptionUntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Removes one or more tags (metadata key/value pairs) from a resource.
untagResourceRequest - InternalFailureExceptionInvalidRequestExceptionResourceNotFoundExceptionUpdatePlacementResult updatePlacement(UpdatePlacementRequest updatePlacementRequest)
Updates a placement with the given attributes. To clear an attribute, pass an empty value (i.e., "").
updatePlacementRequest - InternalFailureExceptionInvalidRequestExceptionResourceNotFoundExceptionTooManyRequestsExceptionUpdateProjectResult 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 - InternalFailureExceptionInvalidRequestExceptionResourceNotFoundExceptionTooManyRequestsExceptionvoid shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request - The originally executed request.