com.amazonaws.services.iot1clickprojects

Interface AWSIoT1ClickProjects

All Known Subinterfaces:

AWSIoT1ClickProjectsAsync

All Known Implementing Classes:

AbstractAWSIoT1ClickProjects, AbstractAWSIoT1ClickProjectsAsync, AWSIoT1ClickProjectsAsyncClient, AWSIoT1ClickProjectsClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSIoT1ClickProjects

Interface for accessing AWS IoT 1-Click Projects.

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

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.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

associateDeviceWithPlacement

AssociateDeviceWithPlacementResult associateDeviceWithPlacement(AssociateDeviceWithPlacementRequest associateDeviceWithPlacementRequest)

Associates a physical device with a placement.

Parameters:

associateDeviceWithPlacementRequest -

Returns:

Result of the AssociateDeviceWithPlacement operation returned by the service.

Throws:

InternalFailureException

InvalidRequestException

ResourceConflictException

ResourceNotFoundException

See Also:

AWS API Documentation

createPlacement

CreatePlacementResult createPlacement(CreatePlacementRequest createPlacementRequest)

Creates an empty placement.

Parameters:

createPlacementRequest -

Returns:

Result of the CreatePlacement operation returned by the service.

Throws:

InternalFailureException

InvalidRequestException

ResourceConflictException

ResourceNotFoundException

See Also:

AWS API Documentation

createProject

CreateProjectResult createProject(CreateProjectRequest createProjectRequest)

Creates an empty project with a placement template. A project contains zero or more placements that adhere to the placement template defined in the project.

Parameters:

createProjectRequest -

Returns:

Result of the CreateProject operation returned by the service.

Throws:

InternalFailureException

InvalidRequestException

ResourceConflictException

See Also:

AWS API Documentation

deletePlacement

DeletePlacementResult deletePlacement(DeletePlacementRequest deletePlacementRequest)

Deletes a placement. To delete a placement, it must not have any devices associated with it.

When you delete a placement, all associated data becomes irretrievable.

Parameters:

deletePlacementRequest -

Returns:

Result of the DeletePlacement operation returned by the service.

Throws:

InternalFailureException

InvalidRequestException

ResourceNotFoundException

TooManyRequestsException

See Also:

AWS API Documentation

deleteProject

DeleteProjectResult deleteProject(DeleteProjectRequest deleteProjectRequest)

Deletes a project. To delete a project, it must not have any placements associated with it.

When you delete a project, all associated data becomes irretrievable.

Parameters:

deleteProjectRequest -

Returns:

Result of the DeleteProject operation returned by the service.

Throws:

InternalFailureException

InvalidRequestException

ResourceNotFoundException

TooManyRequestsException

See Also:

AWS API Documentation

describePlacement

DescribePlacementResult describePlacement(DescribePlacementRequest describePlacementRequest)

Describes a placement in a project.

Parameters:

describePlacementRequest -

Returns:

Result of the DescribePlacement operation returned by the service.

Throws:

InternalFailureException

InvalidRequestException

ResourceNotFoundException

See Also:

AWS API Documentation

describeProject

DescribeProjectResult describeProject(DescribeProjectRequest describeProjectRequest)

Returns an object describing a project.

Parameters:

describeProjectRequest -

Returns:

Result of the DescribeProject operation returned by the service.

Throws:

InternalFailureException

InvalidRequestException

ResourceNotFoundException

See Also:

AWS API Documentation

disassociateDeviceFromPlacement

DisassociateDeviceFromPlacementResult disassociateDeviceFromPlacement(DisassociateDeviceFromPlacementRequest disassociateDeviceFromPlacementRequest)

Removes a physical device from a placement.

Parameters:

disassociateDeviceFromPlacementRequest -

Returns:

Result of the DisassociateDeviceFromPlacement operation returned by the service.

Throws:

InternalFailureException

InvalidRequestException

ResourceNotFoundException

TooManyRequestsException

See Also:

AWS API Documentation

getDevicesInPlacement

GetDevicesInPlacementResult getDevicesInPlacement(GetDevicesInPlacementRequest getDevicesInPlacementRequest)

Returns an object enumerating the devices in a placement.

Parameters:

getDevicesInPlacementRequest -

Returns:

Result of the GetDevicesInPlacement operation returned by the service.

Throws:

InternalFailureException

InvalidRequestException

ResourceNotFoundException

See Also:

AWS API Documentation

listPlacements

ListPlacementsResult listPlacements(ListPlacementsRequest listPlacementsRequest)

Lists the placement(s) of a project.

Parameters:

listPlacementsRequest -

Returns:

Result of the ListPlacements operation returned by the service.

Throws:

InternalFailureException

InvalidRequestException

ResourceNotFoundException

See Also:

AWS API Documentation

listProjects

ListProjectsResult listProjects(ListProjectsRequest listProjectsRequest)

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.

Throws:

InternalFailureException

InvalidRequestException

See Also:

AWS API Documentation

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

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.

Throws:

InternalFailureException

InvalidRequestException

ResourceNotFoundException

See Also:

AWS API Documentation

tagResource

TagResourceResult 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.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

InternalFailureException

InvalidRequestException

ResourceNotFoundException

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Removes one or more tags (metadata key/value pairs) from a resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

InternalFailureException

InvalidRequestException

ResourceNotFoundException

See Also:

AWS API Documentation

updatePlacement

UpdatePlacementResult updatePlacement(UpdatePlacementRequest updatePlacementRequest)

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.

Throws:

InternalFailureException

InvalidRequestException

ResourceNotFoundException

TooManyRequestsException

See Also:

AWS API Documentation

updateProject

UpdateProjectResult updateProject(UpdateProjectRequest updateProjectRequest)

Updates a project associated with your AWS account and region. With the exception of device template names, you can pass just the values that need to be updated because the update request will change only the values that are provided. To clear a value, pass the empty string (i.e., "").

Parameters:

updateProjectRequest -

Returns:

Result of the UpdateProject operation returned by the service.

Throws:

InternalFailureException

InvalidRequestException

ResourceNotFoundException

TooManyRequestsException

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

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.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.