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

IoTTwinMaker

import { IoTTwinMaker } from "https://aws-api.deno.dev/v0.3/services/iottwinmaker.ts?docs=full";
class IoTTwinMaker {
constructor(apiFactory: client.ApiFactory);
async batchPutPropertyValues(params: BatchPutPropertyValuesRequest, opts?: client.RequestOptions): Promise<BatchPutPropertyValuesResponse>;
async createComponentType(params: CreateComponentTypeRequest, opts?: client.RequestOptions): Promise<CreateComponentTypeResponse>;
async createEntity(params: CreateEntityRequest, opts?: client.RequestOptions): Promise<CreateEntityResponse>;
async createScene(params: CreateSceneRequest, opts?: client.RequestOptions): Promise<CreateSceneResponse>;
async createWorkspace(params: CreateWorkspaceRequest, opts?: client.RequestOptions): Promise<CreateWorkspaceResponse>;
async deleteComponentType(params: DeleteComponentTypeRequest, opts?: client.RequestOptions): Promise<DeleteComponentTypeResponse>;
async deleteEntity(params: DeleteEntityRequest, opts?: client.RequestOptions): Promise<DeleteEntityResponse>;
async deleteScene(params: DeleteSceneRequest, opts?: client.RequestOptions): Promise<void>;
async deleteWorkspace(params: DeleteWorkspaceRequest, opts?: client.RequestOptions): Promise<void>;
async getComponentType(params: GetComponentTypeRequest, opts?: client.RequestOptions): Promise<GetComponentTypeResponse>;
async getEntity(params: GetEntityRequest, opts?: client.RequestOptions): Promise<GetEntityResponse>;
async getPropertyValue(params: GetPropertyValueRequest, opts?: client.RequestOptions): Promise<GetPropertyValueResponse>;
async getPropertyValueHistory(params: GetPropertyValueHistoryRequest, opts?: client.RequestOptions): Promise<GetPropertyValueHistoryResponse>;
async getScene(params: GetSceneRequest, opts?: client.RequestOptions): Promise<GetSceneResponse>;
async getWorkspace(params: GetWorkspaceRequest, opts?: client.RequestOptions): Promise<GetWorkspaceResponse>;
async listComponentTypes(params: ListComponentTypesRequest, opts?: client.RequestOptions): Promise<ListComponentTypesResponse>;
async listEntities(params: ListEntitiesRequest, opts?: client.RequestOptions): Promise<ListEntitiesResponse>;
async listScenes(params: ListScenesRequest, opts?: client.RequestOptions): Promise<ListScenesResponse>;
async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;
async listWorkspaces(params?: ListWorkspacesRequest, opts?: client.RequestOptions): Promise<ListWorkspacesResponse>;
async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;
async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;
async updateComponentType(params: UpdateComponentTypeRequest, opts?: client.RequestOptions): Promise<UpdateComponentTypeResponse>;
async updateEntity(params: UpdateEntityRequest, opts?: client.RequestOptions): Promise<UpdateEntityResponse>;
async updateScene(params: UpdateSceneRequest, opts?: client.RequestOptions): Promise<UpdateSceneResponse>;
async updateWorkspace(params: UpdateWorkspaceRequest, opts?: client.RequestOptions): Promise<UpdateWorkspaceResponse>;
 
static ApiMetadata: client.ApiMetadata;
}

§Constructors

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

§Methods

§
batchPutPropertyValues(params: BatchPutPropertyValuesRequest, opts?: client.RequestOptions): Promise<BatchPutPropertyValuesResponse>
[src]

Sets values for multiple time series properties.

§
createComponentType(params: CreateComponentTypeRequest, opts?: client.RequestOptions): Promise<CreateComponentTypeResponse>
[src]

Creates a component type.

! IMPORTANT: ! TwinMaker is in public preview and is subject to change.

§
createEntity(params: CreateEntityRequest, opts?: client.RequestOptions): Promise<CreateEntityResponse>
[src]

Creates an entity.

§
createScene(params: CreateSceneRequest, opts?: client.RequestOptions): Promise<CreateSceneResponse>
[src]

Creates a scene.

§
createWorkspace(params: CreateWorkspaceRequest, opts?: client.RequestOptions): Promise<CreateWorkspaceResponse>
[src]

Creates a workplace.

§
deleteComponentType(params: DeleteComponentTypeRequest, opts?: client.RequestOptions): Promise<DeleteComponentTypeResponse>
[src]

Deletes a component type.

§
deleteEntity(params: DeleteEntityRequest, opts?: client.RequestOptions): Promise<DeleteEntityResponse>
[src]

Deletes an entity.

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

Deletes a scene.

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

Deletes a workspace.

§
getComponentType(params: GetComponentTypeRequest, opts?: client.RequestOptions): Promise<GetComponentTypeResponse>
[src]

Retrieves information about a component type.

§
getEntity(params: GetEntityRequest, opts?: client.RequestOptions): Promise<GetEntityResponse>
[src]

Retrieves information about an entity.

§
getPropertyValue(params: GetPropertyValueRequest, opts?: client.RequestOptions): Promise<GetPropertyValueResponse>
[src]

Gets the property values for a component, component type, entity, or workspace.

You must specify a value for either componentName, componentTypeId, entityId, or workspaceId.

§
getPropertyValueHistory(params: GetPropertyValueHistoryRequest, opts?: client.RequestOptions): Promise<GetPropertyValueHistoryResponse>
[src]

Retrieves information about the history of a time series property value for a component, component type, entity, or workspace.

You must specify a value for workspaceId. For entity-specific queries, specify values for componentName and entityId. For cross-entity quries, specify a value for componentTypeId.

§
getScene(params: GetSceneRequest, opts?: client.RequestOptions): Promise<GetSceneResponse>
[src]

Retrieves information about a scene.

§
getWorkspace(params: GetWorkspaceRequest, opts?: client.RequestOptions): Promise<GetWorkspaceResponse>
[src]

Retrieves information about a workspace.

§
listComponentTypes(params: ListComponentTypesRequest, opts?: client.RequestOptions): Promise<ListComponentTypesResponse>
[src]

Lists all component types in a workspace.

§
listEntities(params: ListEntitiesRequest, opts?: client.RequestOptions): Promise<ListEntitiesResponse>
[src]

Lists all entities in a workspace.

§
listScenes(params: ListScenesRequest, opts?: client.RequestOptions): Promise<ListScenesResponse>
[src]

Lists all scenes in a workspace.

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

Lists all tags associated with a resource.

§
listWorkspaces(params?: ListWorkspacesRequest, opts?: client.RequestOptions): Promise<ListWorkspacesResponse>
[src]

Retrieves information about workspaces in the current account.

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

Adds tags to a resource.

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

Removes tags from a resource.

§
updateComponentType(params: UpdateComponentTypeRequest, opts?: client.RequestOptions): Promise<UpdateComponentTypeResponse>
[src]

Updates information in a component type.

§
updateEntity(params: UpdateEntityRequest, opts?: client.RequestOptions): Promise<UpdateEntityResponse>
[src]

Updates an entity.

§
updateScene(params: UpdateSceneRequest, opts?: client.RequestOptions): Promise<UpdateSceneResponse>
[src]

Updates a scene.

§
updateWorkspace(params: UpdateWorkspaceRequest, opts?: client.RequestOptions): Promise<UpdateWorkspaceResponse>
[src]

Updates a workspace.

§Static Properties