Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

IoT1ClickProjects

import { IoT1ClickProjects } from "https://aws-api.deno.dev/v0.4/services/iot1clickprojects.ts?docs=full";
class IoT1ClickProjects {
constructor(apiFactory: client.ApiFactory);
async associateDeviceWithPlacement(params: AssociateDeviceWithPlacementRequest, opts?: client.RequestOptions): Promise<void>;
async createPlacement(params: CreatePlacementRequest, opts?: client.RequestOptions): Promise<void>;
async createProject(params: CreateProjectRequest, opts?: client.RequestOptions): Promise<void>;
async deletePlacement(params: DeletePlacementRequest, opts?: client.RequestOptions): Promise<void>;
async deleteProject(params: DeleteProjectRequest, opts?: client.RequestOptions): Promise<void>;
async describePlacement(params: DescribePlacementRequest, opts?: client.RequestOptions): Promise<DescribePlacementResponse>;
async describeProject(params: DescribeProjectRequest, opts?: client.RequestOptions): Promise<DescribeProjectResponse>;
async disassociateDeviceFromPlacement(params: DisassociateDeviceFromPlacementRequest, opts?: client.RequestOptions): Promise<void>;
async getDevicesInPlacement(params: GetDevicesInPlacementRequest, opts?: client.RequestOptions): Promise<GetDevicesInPlacementResponse>;
async listPlacements(params: ListPlacementsRequest, opts?: client.RequestOptions): Promise<ListPlacementsResponse>;
async listProjects(params?: ListProjectsRequest, opts?: client.RequestOptions): Promise<ListProjectsResponse>;
async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;
async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;
async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;
async updatePlacement(params: UpdatePlacementRequest, opts?: client.RequestOptions): Promise<void>;
async updateProject(params: UpdateProjectRequest, opts?: client.RequestOptions): Promise<void>;
 
static ApiMetadata: client.ApiMetadata;
}

§Constructors

§
new IoT1ClickProjects(apiFactory: client.ApiFactory)
[src]

§Methods

§
associateDeviceWithPlacement(params: AssociateDeviceWithPlacementRequest, opts?: client.RequestOptions): Promise<void>
[src]

Associates a physical device with a placement.

§
createPlacement(params: CreatePlacementRequest, opts?: client.RequestOptions): Promise<void>
[src]

Creates an empty placement.

§
createProject(params: CreateProjectRequest, opts?: client.RequestOptions): Promise<void>
[src]

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.

§
deletePlacement(params: DeletePlacementRequest, opts?: client.RequestOptions): Promise<void>
[src]

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

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

§
deleteProject(params: DeleteProjectRequest, opts?: client.RequestOptions): Promise<void>
[src]

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

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

§
describePlacement(params: DescribePlacementRequest, opts?: client.RequestOptions): Promise<DescribePlacementResponse>
[src]

Describes a placement in a project.

§
describeProject(params: DescribeProjectRequest, opts?: client.RequestOptions): Promise<DescribeProjectResponse>
[src]

Returns an object describing a project.

§
disassociateDeviceFromPlacement(params: DisassociateDeviceFromPlacementRequest, opts?: client.RequestOptions): Promise<void>
[src]

Removes a physical device from a placement.

§
getDevicesInPlacement(params: GetDevicesInPlacementRequest, opts?: client.RequestOptions): Promise<GetDevicesInPlacementResponse>
[src]

Returns an object enumerating the devices in a placement.

§
listPlacements(params: ListPlacementsRequest, opts?: client.RequestOptions): Promise<ListPlacementsResponse>
[src]

Lists the placement(s) of a project.

§
listProjects(params?: ListProjectsRequest, opts?: client.RequestOptions): Promise<ListProjectsResponse>
[src]

Lists the AWS IoT 1-Click project(s) associated with your AWS account and region.

§
listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>
[src]

Lists the tags (metadata key/value pairs) which you have assigned to the resource.

§
tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>
[src]

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.

§
untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>
[src]

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

§
updatePlacement(params: UpdatePlacementRequest, opts?: client.RequestOptions): Promise<void>
[src]

Updates a placement with the given attributes. To clear an attribute, pass an empty value (i.e., "").

§
updateProject(params: UpdateProjectRequest, opts?: client.RequestOptions): Promise<void>
[src]

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., "").

§Static Properties