IoTTwinMaker

import { IoTTwinMaker } from "https://aws-api-bqtgftz736ft.deno.dev/v0.5/services/iottwinmaker.ts?docs=full";

class IoTTwinMaker {

constructor(apiFactory: client.ApiFactory);

async batchPutPropertyValues(params: BatchPutPropertyValuesRequest, opts?: client.RequestOptions): Promise<BatchPutPropertyValuesResponse>;

async cancelMetadataTransferJob(params: CancelMetadataTransferJobRequest, opts?: client.RequestOptions): Promise<CancelMetadataTransferJobResponse>;

async createComponentType(params: CreateComponentTypeRequest, opts?: client.RequestOptions): Promise<CreateComponentTypeResponse>;

async createEntity(params: CreateEntityRequest, opts?: client.RequestOptions): Promise<CreateEntityResponse>;

async createMetadataTransferJob(params: CreateMetadataTransferJobRequest, opts?: client.RequestOptions): Promise<CreateMetadataTransferJobResponse>;

async createScene(params: CreateSceneRequest, opts?: client.RequestOptions): Promise<CreateSceneResponse>;

async createSyncJob(params: CreateSyncJobRequest, opts?: client.RequestOptions): Promise<CreateSyncJobResponse>;

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 deleteSyncJob(params: DeleteSyncJobRequest, opts?: client.RequestOptions): Promise<DeleteSyncJobResponse>;

async deleteWorkspace(params: DeleteWorkspaceRequest, opts?: client.RequestOptions): Promise<DeleteWorkspaceResponse>;

async executeQuery(params: ExecuteQueryRequest, opts?: client.RequestOptions): Promise<ExecuteQueryResponse>;

async getComponentType(params: GetComponentTypeRequest, opts?: client.RequestOptions): Promise<GetComponentTypeResponse>;

async getEntity(params: GetEntityRequest, opts?: client.RequestOptions): Promise<GetEntityResponse>;

async getMetadataTransferJob(params: GetMetadataTransferJobRequest, opts?: client.RequestOptions): Promise<GetMetadataTransferJobResponse>;

async getPricingPlan(opts?: client.RequestOptions): Promise<GetPricingPlanResponse>;

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 getSyncJob(params: GetSyncJobRequest, opts?: client.RequestOptions): Promise<GetSyncJobResponse>;

async getWorkspace(params: GetWorkspaceRequest, opts?: client.RequestOptions): Promise<GetWorkspaceResponse>;

async listComponents(params: ListComponentsRequest, opts?: client.RequestOptions): Promise<ListComponentsResponse>;

async listComponentTypes(params: ListComponentTypesRequest, opts?: client.RequestOptions): Promise<ListComponentTypesResponse>;

async listEntities(params: ListEntitiesRequest, opts?: client.RequestOptions): Promise<ListEntitiesResponse>;

async listMetadataTransferJobs(params: ListMetadataTransferJobsRequest, opts?: client.RequestOptions): Promise<ListMetadataTransferJobsResponse>;

async listProperties(params: ListPropertiesRequest, opts?: client.RequestOptions): Promise<ListPropertiesResponse>;

async listScenes(params: ListScenesRequest, opts?: client.RequestOptions): Promise<ListScenesResponse>;

async listSyncJobs(params: ListSyncJobsRequest, opts?: client.RequestOptions): Promise<ListSyncJobsResponse>;

async listSyncResources(params: ListSyncResourcesRequest, opts?: client.RequestOptions): Promise<ListSyncResourcesResponse>;

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 updatePricingPlan(params: UpdatePricingPlanRequest, opts?: client.RequestOptions): Promise<UpdatePricingPlanResponse>;

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.

cancelMetadataTransferJob(params: CancelMetadataTransferJobRequest, opts?: client.RequestOptions): Promise<CancelMetadataTransferJobResponse>

[src]

Cancels the metadata transfer job.

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

[src]

Creates a component type.

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

[src]

Creates an entity.

createMetadataTransferJob(params: CreateMetadataTransferJobRequest, opts?: client.RequestOptions): Promise<CreateMetadataTransferJobResponse>

[src]

Creates a new metadata transfer job.

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

[src]

Creates a scene.

createSyncJob(params: CreateSyncJobRequest, opts?: client.RequestOptions): Promise<CreateSyncJobResponse>

[src]

This action creates a SyncJob.

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.

deleteSyncJob(params: DeleteSyncJobRequest, opts?: client.RequestOptions): Promise<DeleteSyncJobResponse>

[src]

Delete the SyncJob.

deleteWorkspace(params: DeleteWorkspaceRequest, opts?: client.RequestOptions): Promise<DeleteWorkspaceResponse>

[src]

Deletes a workspace.

executeQuery(params: ExecuteQueryRequest, opts?: client.RequestOptions): Promise<ExecuteQueryResponse>

[src]

Run queries to access information from your knowledge graph of entities within individual workspaces.

Note: The ExecuteQuery action only works with Amazon Web Services Java SDK2. ExecuteQuery will not work with any Amazon Web Services Java SDK version < 2.x.

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.

getMetadataTransferJob(params: GetMetadataTransferJobRequest, opts?: client.RequestOptions): Promise<GetMetadataTransferJobResponse>

[src]

Gets a nmetadata transfer job.

getPricingPlan(opts?: client.RequestOptions): Promise<GetPricingPlanResponse>

[src]

Gets the pricing plan.

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.

getSyncJob(params: GetSyncJobRequest, opts?: client.RequestOptions): Promise<GetSyncJobResponse>

[src]

Gets the SyncJob.

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

[src]

Retrieves information about a workspace.

listComponents(params: ListComponentsRequest, opts?: client.RequestOptions): Promise<ListComponentsResponse>

[src]

This API lists the components of an entity.

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.

listMetadataTransferJobs(params: ListMetadataTransferJobsRequest, opts?: client.RequestOptions): Promise<ListMetadataTransferJobsResponse>

[src]

Lists the metadata transfer jobs.

listProperties(params: ListPropertiesRequest, opts?: client.RequestOptions): Promise<ListPropertiesResponse>

[src]

This API lists the properties of a component.

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

[src]

Lists all scenes in a workspace.

listSyncJobs(params: ListSyncJobsRequest, opts?: client.RequestOptions): Promise<ListSyncJobsResponse>

[src]

List all SyncJobs.

listSyncResources(params: ListSyncResourcesRequest, opts?: client.RequestOptions): Promise<ListSyncResourcesResponse>

[src]

Lists the sync resources.

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.

updatePricingPlan(params: UpdatePricingPlanRequest, opts?: client.RequestOptions): Promise<UpdatePricingPlanResponse>

[src]

Update the pricing plan.

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

ApiMetadata: client.ApiMetadata

[src]