aws-sdk
Version:
AWS SDK for JavaScript
1,402 lines (1,401 loc) • 95 kB
TypeScript
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class IoTTwinMaker extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: IoTTwinMaker.Types.ClientConfiguration)
config: Config & IoTTwinMaker.Types.ClientConfiguration;
/**
* Sets values for multiple time series properties.
*/
batchPutPropertyValues(params: IoTTwinMaker.Types.BatchPutPropertyValuesRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.BatchPutPropertyValuesResponse) => void): Request<IoTTwinMaker.Types.BatchPutPropertyValuesResponse, AWSError>;
/**
* Sets values for multiple time series properties.
*/
batchPutPropertyValues(callback?: (err: AWSError, data: IoTTwinMaker.Types.BatchPutPropertyValuesResponse) => void): Request<IoTTwinMaker.Types.BatchPutPropertyValuesResponse, AWSError>;
/**
* Cancels the metadata transfer job.
*/
cancelMetadataTransferJob(params: IoTTwinMaker.Types.CancelMetadataTransferJobRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.CancelMetadataTransferJobResponse) => void): Request<IoTTwinMaker.Types.CancelMetadataTransferJobResponse, AWSError>;
/**
* Cancels the metadata transfer job.
*/
cancelMetadataTransferJob(callback?: (err: AWSError, data: IoTTwinMaker.Types.CancelMetadataTransferJobResponse) => void): Request<IoTTwinMaker.Types.CancelMetadataTransferJobResponse, AWSError>;
/**
* Creates a component type.
*/
createComponentType(params: IoTTwinMaker.Types.CreateComponentTypeRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.CreateComponentTypeResponse) => void): Request<IoTTwinMaker.Types.CreateComponentTypeResponse, AWSError>;
/**
* Creates a component type.
*/
createComponentType(callback?: (err: AWSError, data: IoTTwinMaker.Types.CreateComponentTypeResponse) => void): Request<IoTTwinMaker.Types.CreateComponentTypeResponse, AWSError>;
/**
* Creates an entity.
*/
createEntity(params: IoTTwinMaker.Types.CreateEntityRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.CreateEntityResponse) => void): Request<IoTTwinMaker.Types.CreateEntityResponse, AWSError>;
/**
* Creates an entity.
*/
createEntity(callback?: (err: AWSError, data: IoTTwinMaker.Types.CreateEntityResponse) => void): Request<IoTTwinMaker.Types.CreateEntityResponse, AWSError>;
/**
* Creates a new metadata transfer job.
*/
createMetadataTransferJob(params: IoTTwinMaker.Types.CreateMetadataTransferJobRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.CreateMetadataTransferJobResponse) => void): Request<IoTTwinMaker.Types.CreateMetadataTransferJobResponse, AWSError>;
/**
* Creates a new metadata transfer job.
*/
createMetadataTransferJob(callback?: (err: AWSError, data: IoTTwinMaker.Types.CreateMetadataTransferJobResponse) => void): Request<IoTTwinMaker.Types.CreateMetadataTransferJobResponse, AWSError>;
/**
* Creates a scene.
*/
createScene(params: IoTTwinMaker.Types.CreateSceneRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.CreateSceneResponse) => void): Request<IoTTwinMaker.Types.CreateSceneResponse, AWSError>;
/**
* Creates a scene.
*/
createScene(callback?: (err: AWSError, data: IoTTwinMaker.Types.CreateSceneResponse) => void): Request<IoTTwinMaker.Types.CreateSceneResponse, AWSError>;
/**
* This action creates a SyncJob.
*/
createSyncJob(params: IoTTwinMaker.Types.CreateSyncJobRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.CreateSyncJobResponse) => void): Request<IoTTwinMaker.Types.CreateSyncJobResponse, AWSError>;
/**
* This action creates a SyncJob.
*/
createSyncJob(callback?: (err: AWSError, data: IoTTwinMaker.Types.CreateSyncJobResponse) => void): Request<IoTTwinMaker.Types.CreateSyncJobResponse, AWSError>;
/**
* Creates a workplace.
*/
createWorkspace(params: IoTTwinMaker.Types.CreateWorkspaceRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.CreateWorkspaceResponse) => void): Request<IoTTwinMaker.Types.CreateWorkspaceResponse, AWSError>;
/**
* Creates a workplace.
*/
createWorkspace(callback?: (err: AWSError, data: IoTTwinMaker.Types.CreateWorkspaceResponse) => void): Request<IoTTwinMaker.Types.CreateWorkspaceResponse, AWSError>;
/**
* Deletes a component type.
*/
deleteComponentType(params: IoTTwinMaker.Types.DeleteComponentTypeRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.DeleteComponentTypeResponse) => void): Request<IoTTwinMaker.Types.DeleteComponentTypeResponse, AWSError>;
/**
* Deletes a component type.
*/
deleteComponentType(callback?: (err: AWSError, data: IoTTwinMaker.Types.DeleteComponentTypeResponse) => void): Request<IoTTwinMaker.Types.DeleteComponentTypeResponse, AWSError>;
/**
* Deletes an entity.
*/
deleteEntity(params: IoTTwinMaker.Types.DeleteEntityRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.DeleteEntityResponse) => void): Request<IoTTwinMaker.Types.DeleteEntityResponse, AWSError>;
/**
* Deletes an entity.
*/
deleteEntity(callback?: (err: AWSError, data: IoTTwinMaker.Types.DeleteEntityResponse) => void): Request<IoTTwinMaker.Types.DeleteEntityResponse, AWSError>;
/**
* Deletes a scene.
*/
deleteScene(params: IoTTwinMaker.Types.DeleteSceneRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.DeleteSceneResponse) => void): Request<IoTTwinMaker.Types.DeleteSceneResponse, AWSError>;
/**
* Deletes a scene.
*/
deleteScene(callback?: (err: AWSError, data: IoTTwinMaker.Types.DeleteSceneResponse) => void): Request<IoTTwinMaker.Types.DeleteSceneResponse, AWSError>;
/**
* Delete the SyncJob.
*/
deleteSyncJob(params: IoTTwinMaker.Types.DeleteSyncJobRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.DeleteSyncJobResponse) => void): Request<IoTTwinMaker.Types.DeleteSyncJobResponse, AWSError>;
/**
* Delete the SyncJob.
*/
deleteSyncJob(callback?: (err: AWSError, data: IoTTwinMaker.Types.DeleteSyncJobResponse) => void): Request<IoTTwinMaker.Types.DeleteSyncJobResponse, AWSError>;
/**
* Deletes a workspace.
*/
deleteWorkspace(params: IoTTwinMaker.Types.DeleteWorkspaceRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.DeleteWorkspaceResponse) => void): Request<IoTTwinMaker.Types.DeleteWorkspaceResponse, AWSError>;
/**
* Deletes a workspace.
*/
deleteWorkspace(callback?: (err: AWSError, data: IoTTwinMaker.Types.DeleteWorkspaceResponse) => void): Request<IoTTwinMaker.Types.DeleteWorkspaceResponse, AWSError>;
/**
* Run queries to access information from your knowledge graph of entities within individual workspaces. 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.
*/
executeQuery(params: IoTTwinMaker.Types.ExecuteQueryRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.ExecuteQueryResponse) => void): Request<IoTTwinMaker.Types.ExecuteQueryResponse, AWSError>;
/**
* Run queries to access information from your knowledge graph of entities within individual workspaces. 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.
*/
executeQuery(callback?: (err: AWSError, data: IoTTwinMaker.Types.ExecuteQueryResponse) => void): Request<IoTTwinMaker.Types.ExecuteQueryResponse, AWSError>;
/**
* Retrieves information about a component type.
*/
getComponentType(params: IoTTwinMaker.Types.GetComponentTypeRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.GetComponentTypeResponse) => void): Request<IoTTwinMaker.Types.GetComponentTypeResponse, AWSError>;
/**
* Retrieves information about a component type.
*/
getComponentType(callback?: (err: AWSError, data: IoTTwinMaker.Types.GetComponentTypeResponse) => void): Request<IoTTwinMaker.Types.GetComponentTypeResponse, AWSError>;
/**
* Retrieves information about an entity.
*/
getEntity(params: IoTTwinMaker.Types.GetEntityRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.GetEntityResponse) => void): Request<IoTTwinMaker.Types.GetEntityResponse, AWSError>;
/**
* Retrieves information about an entity.
*/
getEntity(callback?: (err: AWSError, data: IoTTwinMaker.Types.GetEntityResponse) => void): Request<IoTTwinMaker.Types.GetEntityResponse, AWSError>;
/**
* Gets a nmetadata transfer job.
*/
getMetadataTransferJob(params: IoTTwinMaker.Types.GetMetadataTransferJobRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.GetMetadataTransferJobResponse) => void): Request<IoTTwinMaker.Types.GetMetadataTransferJobResponse, AWSError>;
/**
* Gets a nmetadata transfer job.
*/
getMetadataTransferJob(callback?: (err: AWSError, data: IoTTwinMaker.Types.GetMetadataTransferJobResponse) => void): Request<IoTTwinMaker.Types.GetMetadataTransferJobResponse, AWSError>;
/**
* Gets the pricing plan.
*/
getPricingPlan(params: IoTTwinMaker.Types.GetPricingPlanRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.GetPricingPlanResponse) => void): Request<IoTTwinMaker.Types.GetPricingPlanResponse, AWSError>;
/**
* Gets the pricing plan.
*/
getPricingPlan(callback?: (err: AWSError, data: IoTTwinMaker.Types.GetPricingPlanResponse) => void): Request<IoTTwinMaker.Types.GetPricingPlanResponse, AWSError>;
/**
* Gets the property values for a component, component type, entity, or workspace. You must specify a value for either componentName, componentTypeId, entityId, or workspaceId.
*/
getPropertyValue(params: IoTTwinMaker.Types.GetPropertyValueRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.GetPropertyValueResponse) => void): Request<IoTTwinMaker.Types.GetPropertyValueResponse, AWSError>;
/**
* Gets the property values for a component, component type, entity, or workspace. You must specify a value for either componentName, componentTypeId, entityId, or workspaceId.
*/
getPropertyValue(callback?: (err: AWSError, data: IoTTwinMaker.Types.GetPropertyValueResponse) => void): Request<IoTTwinMaker.Types.GetPropertyValueResponse, AWSError>;
/**
* 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.
*/
getPropertyValueHistory(params: IoTTwinMaker.Types.GetPropertyValueHistoryRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.GetPropertyValueHistoryResponse) => void): Request<IoTTwinMaker.Types.GetPropertyValueHistoryResponse, AWSError>;
/**
* 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.
*/
getPropertyValueHistory(callback?: (err: AWSError, data: IoTTwinMaker.Types.GetPropertyValueHistoryResponse) => void): Request<IoTTwinMaker.Types.GetPropertyValueHistoryResponse, AWSError>;
/**
* Retrieves information about a scene.
*/
getScene(params: IoTTwinMaker.Types.GetSceneRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.GetSceneResponse) => void): Request<IoTTwinMaker.Types.GetSceneResponse, AWSError>;
/**
* Retrieves information about a scene.
*/
getScene(callback?: (err: AWSError, data: IoTTwinMaker.Types.GetSceneResponse) => void): Request<IoTTwinMaker.Types.GetSceneResponse, AWSError>;
/**
* Gets the SyncJob.
*/
getSyncJob(params: IoTTwinMaker.Types.GetSyncJobRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.GetSyncJobResponse) => void): Request<IoTTwinMaker.Types.GetSyncJobResponse, AWSError>;
/**
* Gets the SyncJob.
*/
getSyncJob(callback?: (err: AWSError, data: IoTTwinMaker.Types.GetSyncJobResponse) => void): Request<IoTTwinMaker.Types.GetSyncJobResponse, AWSError>;
/**
* Retrieves information about a workspace.
*/
getWorkspace(params: IoTTwinMaker.Types.GetWorkspaceRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.GetWorkspaceResponse) => void): Request<IoTTwinMaker.Types.GetWorkspaceResponse, AWSError>;
/**
* Retrieves information about a workspace.
*/
getWorkspace(callback?: (err: AWSError, data: IoTTwinMaker.Types.GetWorkspaceResponse) => void): Request<IoTTwinMaker.Types.GetWorkspaceResponse, AWSError>;
/**
* Lists all component types in a workspace.
*/
listComponentTypes(params: IoTTwinMaker.Types.ListComponentTypesRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.ListComponentTypesResponse) => void): Request<IoTTwinMaker.Types.ListComponentTypesResponse, AWSError>;
/**
* Lists all component types in a workspace.
*/
listComponentTypes(callback?: (err: AWSError, data: IoTTwinMaker.Types.ListComponentTypesResponse) => void): Request<IoTTwinMaker.Types.ListComponentTypesResponse, AWSError>;
/**
* This API lists the components of an entity.
*/
listComponents(params: IoTTwinMaker.Types.ListComponentsRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.ListComponentsResponse) => void): Request<IoTTwinMaker.Types.ListComponentsResponse, AWSError>;
/**
* This API lists the components of an entity.
*/
listComponents(callback?: (err: AWSError, data: IoTTwinMaker.Types.ListComponentsResponse) => void): Request<IoTTwinMaker.Types.ListComponentsResponse, AWSError>;
/**
* Lists all entities in a workspace.
*/
listEntities(params: IoTTwinMaker.Types.ListEntitiesRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.ListEntitiesResponse) => void): Request<IoTTwinMaker.Types.ListEntitiesResponse, AWSError>;
/**
* Lists all entities in a workspace.
*/
listEntities(callback?: (err: AWSError, data: IoTTwinMaker.Types.ListEntitiesResponse) => void): Request<IoTTwinMaker.Types.ListEntitiesResponse, AWSError>;
/**
* Lists the metadata transfer jobs.
*/
listMetadataTransferJobs(params: IoTTwinMaker.Types.ListMetadataTransferJobsRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.ListMetadataTransferJobsResponse) => void): Request<IoTTwinMaker.Types.ListMetadataTransferJobsResponse, AWSError>;
/**
* Lists the metadata transfer jobs.
*/
listMetadataTransferJobs(callback?: (err: AWSError, data: IoTTwinMaker.Types.ListMetadataTransferJobsResponse) => void): Request<IoTTwinMaker.Types.ListMetadataTransferJobsResponse, AWSError>;
/**
* This API lists the properties of a component.
*/
listProperties(params: IoTTwinMaker.Types.ListPropertiesRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.ListPropertiesResponse) => void): Request<IoTTwinMaker.Types.ListPropertiesResponse, AWSError>;
/**
* This API lists the properties of a component.
*/
listProperties(callback?: (err: AWSError, data: IoTTwinMaker.Types.ListPropertiesResponse) => void): Request<IoTTwinMaker.Types.ListPropertiesResponse, AWSError>;
/**
* Lists all scenes in a workspace.
*/
listScenes(params: IoTTwinMaker.Types.ListScenesRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.ListScenesResponse) => void): Request<IoTTwinMaker.Types.ListScenesResponse, AWSError>;
/**
* Lists all scenes in a workspace.
*/
listScenes(callback?: (err: AWSError, data: IoTTwinMaker.Types.ListScenesResponse) => void): Request<IoTTwinMaker.Types.ListScenesResponse, AWSError>;
/**
* List all SyncJobs.
*/
listSyncJobs(params: IoTTwinMaker.Types.ListSyncJobsRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.ListSyncJobsResponse) => void): Request<IoTTwinMaker.Types.ListSyncJobsResponse, AWSError>;
/**
* List all SyncJobs.
*/
listSyncJobs(callback?: (err: AWSError, data: IoTTwinMaker.Types.ListSyncJobsResponse) => void): Request<IoTTwinMaker.Types.ListSyncJobsResponse, AWSError>;
/**
* Lists the sync resources.
*/
listSyncResources(params: IoTTwinMaker.Types.ListSyncResourcesRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.ListSyncResourcesResponse) => void): Request<IoTTwinMaker.Types.ListSyncResourcesResponse, AWSError>;
/**
* Lists the sync resources.
*/
listSyncResources(callback?: (err: AWSError, data: IoTTwinMaker.Types.ListSyncResourcesResponse) => void): Request<IoTTwinMaker.Types.ListSyncResourcesResponse, AWSError>;
/**
* Lists all tags associated with a resource.
*/
listTagsForResource(params: IoTTwinMaker.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.ListTagsForResourceResponse) => void): Request<IoTTwinMaker.Types.ListTagsForResourceResponse, AWSError>;
/**
* Lists all tags associated with a resource.
*/
listTagsForResource(callback?: (err: AWSError, data: IoTTwinMaker.Types.ListTagsForResourceResponse) => void): Request<IoTTwinMaker.Types.ListTagsForResourceResponse, AWSError>;
/**
* Retrieves information about workspaces in the current account.
*/
listWorkspaces(params: IoTTwinMaker.Types.ListWorkspacesRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.ListWorkspacesResponse) => void): Request<IoTTwinMaker.Types.ListWorkspacesResponse, AWSError>;
/**
* Retrieves information about workspaces in the current account.
*/
listWorkspaces(callback?: (err: AWSError, data: IoTTwinMaker.Types.ListWorkspacesResponse) => void): Request<IoTTwinMaker.Types.ListWorkspacesResponse, AWSError>;
/**
* Adds tags to a resource.
*/
tagResource(params: IoTTwinMaker.Types.TagResourceRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.TagResourceResponse) => void): Request<IoTTwinMaker.Types.TagResourceResponse, AWSError>;
/**
* Adds tags to a resource.
*/
tagResource(callback?: (err: AWSError, data: IoTTwinMaker.Types.TagResourceResponse) => void): Request<IoTTwinMaker.Types.TagResourceResponse, AWSError>;
/**
* Removes tags from a resource.
*/
untagResource(params: IoTTwinMaker.Types.UntagResourceRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.UntagResourceResponse) => void): Request<IoTTwinMaker.Types.UntagResourceResponse, AWSError>;
/**
* Removes tags from a resource.
*/
untagResource(callback?: (err: AWSError, data: IoTTwinMaker.Types.UntagResourceResponse) => void): Request<IoTTwinMaker.Types.UntagResourceResponse, AWSError>;
/**
* Updates information in a component type.
*/
updateComponentType(params: IoTTwinMaker.Types.UpdateComponentTypeRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.UpdateComponentTypeResponse) => void): Request<IoTTwinMaker.Types.UpdateComponentTypeResponse, AWSError>;
/**
* Updates information in a component type.
*/
updateComponentType(callback?: (err: AWSError, data: IoTTwinMaker.Types.UpdateComponentTypeResponse) => void): Request<IoTTwinMaker.Types.UpdateComponentTypeResponse, AWSError>;
/**
* Updates an entity.
*/
updateEntity(params: IoTTwinMaker.Types.UpdateEntityRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.UpdateEntityResponse) => void): Request<IoTTwinMaker.Types.UpdateEntityResponse, AWSError>;
/**
* Updates an entity.
*/
updateEntity(callback?: (err: AWSError, data: IoTTwinMaker.Types.UpdateEntityResponse) => void): Request<IoTTwinMaker.Types.UpdateEntityResponse, AWSError>;
/**
* Update the pricing plan.
*/
updatePricingPlan(params: IoTTwinMaker.Types.UpdatePricingPlanRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.UpdatePricingPlanResponse) => void): Request<IoTTwinMaker.Types.UpdatePricingPlanResponse, AWSError>;
/**
* Update the pricing plan.
*/
updatePricingPlan(callback?: (err: AWSError, data: IoTTwinMaker.Types.UpdatePricingPlanResponse) => void): Request<IoTTwinMaker.Types.UpdatePricingPlanResponse, AWSError>;
/**
* Updates a scene.
*/
updateScene(params: IoTTwinMaker.Types.UpdateSceneRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.UpdateSceneResponse) => void): Request<IoTTwinMaker.Types.UpdateSceneResponse, AWSError>;
/**
* Updates a scene.
*/
updateScene(callback?: (err: AWSError, data: IoTTwinMaker.Types.UpdateSceneResponse) => void): Request<IoTTwinMaker.Types.UpdateSceneResponse, AWSError>;
/**
* Updates a workspace.
*/
updateWorkspace(params: IoTTwinMaker.Types.UpdateWorkspaceRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.UpdateWorkspaceResponse) => void): Request<IoTTwinMaker.Types.UpdateWorkspaceResponse, AWSError>;
/**
* Updates a workspace.
*/
updateWorkspace(callback?: (err: AWSError, data: IoTTwinMaker.Types.UpdateWorkspaceResponse) => void): Request<IoTTwinMaker.Types.UpdateWorkspaceResponse, AWSError>;
}
declare namespace IoTTwinMaker {
export interface BatchPutPropertyError {
/**
* The error code.
*/
errorCode: String;
/**
* The error message.
*/
errorMessage: String;
/**
* An object that contains information about errors returned by the BatchPutProperty action.
*/
entry: PropertyValueEntry;
}
export interface BatchPutPropertyErrorEntry {
/**
* A list of objects that contain information about errors returned by the BatchPutProperty action.
*/
errors: Errors;
}
export interface BatchPutPropertyValuesRequest {
/**
* The ID of the workspace that contains the properties to set.
*/
workspaceId: Id;
/**
* An object that maps strings to the property value entries to set. Each string in the mapping must be unique to this object.
*/
entries: Entries;
}
export interface BatchPutPropertyValuesResponse {
/**
* Entries that caused errors in the batch put operation.
*/
errorEntries: ErrorEntries;
}
export type Boolean = boolean;
export interface BundleInformation {
/**
* The bundle names.
*/
bundleNames: PricingBundles;
/**
* The pricing tier.
*/
pricingTier?: PricingTier;
}
export type BundleName = string;
export interface CancelMetadataTransferJobRequest {
/**
* The metadata transfer job Id.
*/
metadataTransferJobId: Id;
}
export interface CancelMetadataTransferJobResponse {
/**
* The metadata transfer job Id.
*/
metadataTransferJobId: Id;
/**
* The metadata transfer job ARN.
*/
arn: TwinMakerArn;
/**
* Used to update the DateTime property.
*/
updateDateTime: Timestamp;
/**
* The metadata transfer job's status.
*/
status: MetadataTransferJobStatus;
/**
* The metadata transfer job's progress.
*/
progress?: MetadataTransferJobProgress;
}
export interface ColumnDescription {
/**
* The name of the column description.
*/
name?: ColumnName;
/**
* The type of the column description.
*/
type?: ColumnType;
}
export type ColumnDescriptions = ColumnDescription[];
export type ColumnName = string;
export type ColumnType = "NODE"|"EDGE"|"VALUE"|string;
export type ComponentPath = string;
export interface ComponentPropertyGroupRequest {
/**
* The group type.
*/
groupType?: GroupType;
/**
* The property names.
*/
propertyNames?: PropertyNames;
/**
* The update type.
*/
updateType?: PropertyGroupUpdateType;
}
export type ComponentPropertyGroupRequests = {[key: string]: ComponentPropertyGroupRequest};
export interface ComponentPropertyGroupResponse {
/**
* The group type.
*/
groupType: GroupType;
/**
* The names of properties
*/
propertyNames: PropertyNames;
/**
* A Boolean value that specifies whether the property group is inherited from a parent entity
*/
isInherited: Boolean;
}
export type ComponentPropertyGroupResponses = {[key: string]: ComponentPropertyGroupResponse};
export interface ComponentRequest {
/**
* The description of the component request.
*/
description?: Description;
/**
* The ID of the component type.
*/
componentTypeId?: ComponentTypeId;
/**
* An object that maps strings to the properties to set in the component type. Each string in the mapping must be unique to this object.
*/
properties?: PropertyRequests;
/**
* The property groups.
*/
propertyGroups?: ComponentPropertyGroupRequests;
}
export interface ComponentResponse {
/**
* The name of the component.
*/
componentName?: Name;
/**
* The description of the component type.
*/
description?: Description;
/**
* The ID of the component type.
*/
componentTypeId?: ComponentTypeId;
/**
* The status of the component type.
*/
status?: Status;
/**
* The name of the property definition set in the request.
*/
definedIn?: String;
/**
* An object that maps strings to the properties to set in the component type. Each string in the mapping must be unique to this object.
*/
properties?: PropertyResponses;
/**
* The property groups.
*/
propertyGroups?: ComponentPropertyGroupResponses;
/**
* The syncSource of the sync job, if this entity was created by a sync job.
*/
syncSource?: SyncSource;
/**
* This flag notes whether all properties of the component are returned in the API response. The maximum number of properties returned is 800.
*/
areAllPropertiesReturned?: Boolean;
/**
* This lists objects that contain information about the compositeComponents.
*/
compositeComponents?: CompositeComponentResponse;
/**
* This flag notes whether all compositeComponents are returned in the API response.
*/
areAllCompositeComponentsReturned?: Boolean;
}
export type ComponentSummaries = ComponentSummary[];
export interface ComponentSummary {
/**
* The name of the component.
*/
componentName: Name;
/**
* The ID of the component type.
*/
componentTypeId: ComponentTypeId;
/**
* The name of the property definition set in the request.
*/
definedIn?: String;
/**
* The description of the component request.
*/
description?: Description;
/**
* The property groups.
*/
propertyGroups?: ComponentPropertyGroupResponses;
/**
* The status of the component type.
*/
status: Status;
/**
* The syncSource of the sync job, if this entity was created by a sync job.
*/
syncSource?: SyncSource;
/**
* This string specifies the path to the composite component, starting from the top-level component.
*/
componentPath?: ComponentPath;
}
export type ComponentTypeId = string;
export type ComponentTypeName = string;
export type ComponentTypeSummaries = ComponentTypeSummary[];
export interface ComponentTypeSummary {
/**
* The ARN of the component type.
*/
arn: TwinMakerArn;
/**
* The ID of the component type.
*/
componentTypeId: ComponentTypeId;
/**
* The date and time when the component type was created.
*/
creationDateTime: Timestamp;
/**
* The date and time when the component type was last updated.
*/
updateDateTime: Timestamp;
/**
* The description of the component type.
*/
description?: Description;
/**
* The current status of the component type.
*/
status?: Status;
/**
* The component type name.
*/
componentTypeName?: ComponentTypeName;
}
export interface ComponentUpdateRequest {
/**
* The update type of the component update request.
*/
updateType?: ComponentUpdateType;
/**
* The description of the component type.
*/
description?: Description;
/**
* The ID of the component type.
*/
componentTypeId?: ComponentTypeId;
/**
* An object that maps strings to the properties to set in the component type update. Each string in the mapping must be unique to this object.
*/
propertyUpdates?: PropertyRequests;
/**
* The property group updates.
*/
propertyGroupUpdates?: ComponentPropertyGroupRequests;
}
export type ComponentUpdateType = "CREATE"|"UPDATE"|"DELETE"|string;
export type ComponentUpdatesMapRequest = {[key: string]: ComponentUpdateRequest};
export type ComponentsMap = {[key: string]: ComponentResponse};
export type ComponentsMapRequest = {[key: string]: ComponentRequest};
export interface CompositeComponentRequest {
/**
* The description of the component type.
*/
description?: Description;
/**
* This is an object that maps strings to the properties to set in the component type. Each string in the mapping must be unique to this object.
*/
properties?: PropertyRequests;
/**
* The property groups.
*/
propertyGroups?: ComponentPropertyGroupRequests;
}
export type CompositeComponentResponse = {[key: string]: ComponentSummary};
export interface CompositeComponentTypeRequest {
/**
* This is the componentTypeId that the compositeComponentType refers to.
*/
componentTypeId?: ComponentTypeId;
}
export interface CompositeComponentTypeResponse {
/**
* This is the componentTypeId that this compositeComponentType refers to.
*/
componentTypeId?: ComponentTypeId;
/**
* This boolean indicates whether this compositeComponentType is inherited from its parent.
*/
isInherited?: Boolean;
}
export type CompositeComponentTypesRequest = {[key: string]: CompositeComponentTypeRequest};
export type CompositeComponentTypesResponse = {[key: string]: CompositeComponentTypeResponse};
export interface CompositeComponentUpdateRequest {
/**
* The update type of the component update request.
*/
updateType?: ComponentUpdateType;
/**
* The description of the component type.
*/
description?: Description;
/**
* An object that maps strings to the properties to set in the component type update. Each string in the mapping must be unique to this object.
*/
propertyUpdates?: PropertyRequests;
/**
* The property group updates.
*/
propertyGroupUpdates?: ComponentPropertyGroupRequests;
}
export type CompositeComponentUpdatesMapRequest = {[key: string]: CompositeComponentUpdateRequest};
export type CompositeComponentsMapRequest = {[key: string]: CompositeComponentRequest};
export type Configuration = {[key: string]: Value};
export interface CreateComponentTypeRequest {
/**
* The ID of the workspace that contains the component type.
*/
workspaceId: Id;
/**
* A Boolean value that specifies whether an entity can have more than one component of this type.
*/
isSingleton?: Boolean;
/**
* The ID of the component type.
*/
componentTypeId: ComponentTypeId;
/**
* The description of the component type.
*/
description?: Description;
/**
* An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object.
*/
propertyDefinitions?: PropertyDefinitionsRequest;
/**
* Specifies the parent component type to extend.
*/
extendsFrom?: ExtendsFrom;
/**
* An object that maps strings to the functions in the component type. Each string in the mapping must be unique to this object.
*/
functions?: FunctionsRequest;
/**
* Metadata that you can use to manage the component type.
*/
tags?: TagMap;
/**
*
*/
propertyGroups?: PropertyGroupsRequest;
/**
* A friendly name for the component type.
*/
componentTypeName?: ComponentTypeName;
/**
* This is an object that maps strings to compositeComponentTypes of the componentType. CompositeComponentType is referenced by componentTypeId.
*/
compositeComponentTypes?: CompositeComponentTypesRequest;
}
export interface CreateComponentTypeResponse {
/**
* The ARN of the component type.
*/
arn: TwinMakerArn;
/**
* The date and time when the entity was created.
*/
creationDateTime: Timestamp;
/**
* The current state of the component type.
*/
state: State;
}
export interface CreateEntityRequest {
/**
* The ID of the workspace that contains the entity.
*/
workspaceId: Id;
/**
* The ID of the entity.
*/
entityId?: EntityId;
/**
* The name of the entity.
*/
entityName: EntityName;
/**
* The description of the entity.
*/
description?: Description;
/**
* An object that maps strings to the components in the entity. Each string in the mapping must be unique to this object.
*/
components?: ComponentsMapRequest;
/**
* This is an object that maps strings to compositeComponent updates in the request. Each key of the map represents the componentPath of the compositeComponent.
*/
compositeComponents?: CompositeComponentsMapRequest;
/**
* The ID of the entity's parent entity.
*/
parentEntityId?: ParentEntityId;
/**
* Metadata that you can use to manage the entity.
*/
tags?: TagMap;
}
export interface CreateEntityResponse {
/**
* The ID of the entity.
*/
entityId: EntityId;
/**
* The ARN of the entity.
*/
arn: TwinMakerArn;
/**
* The date and time when the entity was created.
*/
creationDateTime: Timestamp;
/**
* The current state of the entity.
*/
state: State;
}
export interface CreateMetadataTransferJobRequest {
/**
* The metadata transfer job Id.
*/
metadataTransferJobId?: Id;
/**
* The metadata transfer job description.
*/
description?: Description;
/**
* The metadata transfer job sources.
*/
sources: SourceConfigurations;
/**
* The metadata transfer job destination.
*/
destination: DestinationConfiguration;
}
export interface CreateMetadataTransferJobResponse {
/**
* The metadata transfer job Id.
*/
metadataTransferJobId: Id;
/**
* The metadata transfer job ARN.
*/
arn: TwinMakerArn;
/**
* The The metadata transfer job creation DateTime property.
*/
creationDateTime: Timestamp;
/**
* The metadata transfer job response status.
*/
status: MetadataTransferJobStatus;
}
export interface CreateSceneRequest {
/**
* The ID of the workspace that contains the scene.
*/
workspaceId: Id;
/**
* The ID of the scene.
*/
sceneId: Id;
/**
* The relative path that specifies the location of the content definition file.
*/
contentLocation: S3Url;
/**
* The description for this scene.
*/
description?: Description;
/**
* A list of capabilities that the scene uses to render itself.
*/
capabilities?: SceneCapabilities;
/**
* Metadata that you can use to manage the scene.
*/
tags?: TagMap;
/**
* The request metadata.
*/
sceneMetadata?: SceneMetadataMap;
}
export interface CreateSceneResponse {
/**
* The ARN of the scene.
*/
arn: TwinMakerArn;
/**
* The date and time when the scene was created.
*/
creationDateTime: Timestamp;
}
export interface CreateSyncJobRequest {
/**
* The workspace ID.
*/
workspaceId: Id;
/**
* The sync source. Currently the only supported syncSoource is SITEWISE .
*/
syncSource: SyncSource;
/**
* The SyncJob IAM role. This IAM role is used by the SyncJob to read from the syncSource, and create, update, or delete the corresponding resources.
*/
syncRole: RoleArn;
/**
* The SyncJob tags.
*/
tags?: TagMap;
}
export interface CreateSyncJobResponse {
/**
* The SyncJob ARN.
*/
arn: TwinMakerArn;
/**
* The date and time for the SyncJob creation.
*/
creationDateTime: Timestamp;
/**
* The SyncJob response state.
*/
state: SyncJobState;
}
export interface CreateWorkspaceRequest {
/**
* The ID of the workspace.
*/
workspaceId: Id;
/**
* The description of the workspace.
*/
description?: Description;
/**
* The ARN of the S3 bucket where resources associated with the workspace are stored.
*/
s3Location?: S3Location;
/**
* The ARN of the execution role associated with the workspace.
*/
role?: RoleArn;
/**
* Metadata that you can use to manage the workspace
*/
tags?: TagMap;
}
export interface CreateWorkspaceResponse {
/**
* The ARN of the workspace.
*/
arn: TwinMakerArn;
/**
* The date and time when the workspace was created.
*/
creationDateTime: Timestamp;
}
export interface DataConnector {
/**
* The Lambda function associated with this data connector.
*/
lambda?: LambdaFunction;
/**
* A Boolean value that specifies whether the data connector is native to IoT TwinMaker.
*/
isNative?: Boolean;
}
export interface DataType {
/**
* The underlying type of the data type.
*/
type: Type;
/**
* The nested type in the data type.
*/
nestedType?: DataType;
/**
* The allowed values for this data type.
*/
allowedValues?: DataValueList;
/**
* The unit of measure used in this data type.
*/
unitOfMeasure?: String;
/**
* A relationship that associates a component with another component.
*/
relationship?: Relationship;
}
export interface DataValue {
/**
* A Boolean value.
*/
booleanValue?: Boolean;
/**
* A double value.
*/
doubleValue?: Double;
/**
* An integer value.
*/
integerValue?: Integer;
/**
* A long value.
*/
longValue?: Long;
/**
* A string value.
*/
stringValue?: String;
/**
* A list of multiple values.
*/
listValue?: DataValueList;
/**
* An object that maps strings to multiple DataValue objects.
*/
mapValue?: DataValueMap;
/**
* A value that relates a component to another component.
*/
relationshipValue?: RelationshipValue;
/**
* An expression that produces the value.
*/
expression?: Expression;
}
export type DataValueList = DataValue[];
export type DataValueMap = {[key: string]: DataValue};
export interface DeleteComponentTypeRequest {
/**
* The ID of the workspace that contains the component type.
*/
workspaceId: Id;
/**
* The ID of the component type to delete.
*/
componentTypeId: ComponentTypeId;
}
export interface DeleteComponentTypeResponse {
/**
* The current state of the component type to be deleted.
*/
state: State;
}
export interface DeleteEntityRequest {
/**
* The ID of the workspace that contains the entity to delete.
*/
workspaceId: Id;
/**
* The ID of the entity to delete.
*/
entityId: EntityId;
/**
* A Boolean value that specifies whether the operation deletes child entities.
*/
isRecursive?: Boolean;
}
export interface DeleteEntityResponse {
/**
* The current state of the deleted entity.
*/
state: State;
}
export interface DeleteSceneRequest {
/**
* The ID of the workspace.
*/
workspaceId: Id;
/**
* The ID of the scene to delete.
*/
sceneId: Id;
}
export interface DeleteSceneResponse {
}
export interface DeleteSyncJobRequest {
/**
* The workspace ID.
*/
workspaceId: Id;
/**
* The sync source. Currently the only supported syncSource is SITEWISE .
*/
syncSource: SyncSource;
}
export interface DeleteSyncJobResponse {
/**
* The SyncJob response state.
*/
state: SyncJobState;
}
export interface DeleteWorkspaceRequest {
/**
* The ID of the workspace to delete.
*/
workspaceId: Id;
}
export interface DeleteWorkspaceResponse {
/**
* The string that specifies the delete result for the workspace.
*/
message?: WorkspaceDeleteMessage;
}
export type Description = string;
export interface DestinationConfiguration {
/**
* The destination type.
*/
type: DestinationType;
/**
* The metadata transfer job S3 configuration. [need to add S3 entity]
*/
s3Configuration?: S3DestinationConfiguration;
/**
* The metadata transfer job Amazon Web Services IoT TwinMaker configuration.
*/
iotTwinMakerConfiguration?: IotTwinMakerDestinationConfiguration;
}
export type DestinationType = "s3"|"iotsitewise"|"iottwinmaker"|string;
export type Double = number;
export type EntityId = string;
export type EntityName = string;
export interface EntityPropertyReference {
/**
* The name of the component.
*/
componentName?: Name;
/**
* This string specifies the path to the composite component, starting from the top-level component.
*/
componentPath?: ComponentPath;
/**
* A mapping of external IDs to property names. External IDs uniquely identify properties from external data stores.
*/
externalIdProperty?: ExternalIdProperty;
/**
* The ID of the entity.
*/
entityId?: EntityId;
/**
* The name of the property.
*/
propertyName: Name;
}
export type EntitySummaries = EntitySummary[];
export interface EntitySummary {
/**
* The ID of the entity.
*/
entityId: EntityId;
/**
* The name of the entity.
*/
entityName: EntityName;
/**
* The ARN of the entity.
*/
arn: TwinMakerArn;
/**
* The ID of the parent entity.
*/
parentEntityId?: ParentEntityId;
/**
* The current status of the entity.
*/
status: Status;
/**
* The description of the entity.
*/
description?: Description;
/**
* An eventual Boolean value that specifies whether the entity has child entities or not.
*/
hasChildEntities?: Boolean;
/**
* The date and time when the entity was created.
*/
creationDateTime: Timestamp;
/**
* The last date and time when the entity was updated.
*/
updateDateTime: Timestamp;
}
export type Entries = PropertyValueEntry[];
export type ErrorCode = "VALIDATION_ERROR"|"INTERNAL_FAILURE"|"SYNC_INITIALIZING_ERROR"|"SYNC_CREATING_ERROR"|"SYNC_PROCESSING_ERROR"|"SYNC_DELETING_ERROR"|"PROCESSING_ERROR"|"COMPOSITE_COMPONENT_FAILURE"|string;
export interface ErrorDetails {
/**
* The error code.
*/
code?: ErrorCode;
/**
* The error message.
*/
message?: ErrorMessage;
}
export type ErrorEntries = BatchPutPropertyErrorEntry[];
export type ErrorMessage = string;
export type Errors = BatchPutPropertyError[];
export interface ExecuteQueryRequest {
/**
* The ID of the workspace.
*/
workspaceId: Id;
/**
* The query statement.
*/
queryStatement: QueryStatement;
/**
* The maximum number of results to return at one time. The default is 50.
*/
maxResults?: QueryServiceMaxResults;
/**
* The string that specifies the next page of results.
*/
nextToken?: NextToken;
}
export interface ExecuteQueryResponse {
/**
* A list of ColumnDescription objects.
*/
columnDescriptions?: ColumnDescriptions;
/**
* Represents a single row in the query results.
*/
rows?: Rows;
/**
* The string that specifies the next page of results.
*/
nextToken?: NextToken;
}
export type Expression = string;
export type ExtendsFrom = ComponentTypeId[];
export type ExternalIdProperty = {[key: string]: String};
export interface FilterByAsset {
/**
* Filter by asset Id.
*/
assetId?: Uuid;
/**
* The external-Id property of an asset.
*/
assetExternalId?: SiteWiseExternalId;
/**
* Includes sub-assets.[need description hekp for this]
*/
includeOffspring?: Boolean;
/**
* Boolean to include the asset model.
*/
includeAssetModel?: Boolean;
}
export interface FilterByAssetModel {
/**
* The asset model Id.
*/
assetModelId?: Uuid;
/**
* The external-Id property of an asset model.
*/
assetModelExternalId?: SiteWiseExternalId;
/**
* Include asset offspring. [need desc.]
*/
includeOffspring?: Boolean;
/**
* Bolean to include assets.
*/
includeAssets?: Boolean;
}
export interface FilterByComponentType {
/**
* The component type Id.
*/
componentTypeId: ComponentTypeId;
}
export interface FilterByEntity {
/**
* The entity Id.
*/
entityId: EntityId;
}
export interface FunctionRequest {
/**
* The required properties of the function.
*/
requiredProperties?: RequiredProperties;
/**
* The scope of the function.
*/
scope?: Scope;
/**
* The data connector.
*/
implementedBy?: DataConnector;
}
export interface FunctionResponse {
/**
* The required properties of the function.
*/
requiredProperties?: RequiredProperties;
/**
* The scope of the function.
*/
scope?: Scope;
/**
* The data connector.
*/
implementedBy?: DataConnector;
/**
* Indicates whether this function is inherited.
*/
isInherited?: Boolean;
}
export type FunctionsRequest = {[key: string]: FunctionRequest};
export type FunctionsResponse = {[key: string]: FunctionResponse};
export type GeneratedSceneMetadataMap = {[key: string]: SceneMetadataValue};
export interface GetComponentTypeRequest {
/**
* The ID of the workspace that contains the component type.
*/
workspaceId: Id;
/**
* The ID of the component type.
*/
componentTypeId: ComponentTypeId;
}
export interface GetComponentTypeResponse {
/**
* The ID of the workspace that contains the component type.
*/
workspaceId: Id;
/**
* A Boolean value that specifies whether an entity can have more than one component of this type.
*/
isSingleton?: Boolean;
/**
* The ID of the component type.
*/
componentTypeId: ComponentTypeId;
/**
* The description of the component type.
*/
description?: Description;
/**
* An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object.
*/
propertyDefinitions?: PropertyDefinitionsResponse;
/**
* The name of the parent component type that this component type extends.
*/
extendsFrom?: ExtendsFrom;
/**
* An object that maps strings to the functions in the component type. Each string in the mapping must be unique to this object.
*/
functions?: FunctionsResponse;
/**
* The date and time when the component type was created.
*/
creationDateTime: Timestamp;
/**
* The date and time when the component was last updated.
*/
updateDateTime: Timestamp;
/**
* The ARN of the component type.
*/
arn: TwinMakerArn;
/**
* A Boolean value that specifies whether the component type is abstract.
*/
isAbstract?: Boolean;
/**
* A Boolean value that specifies whether the component type has a schema initializer and that the schema initializer has run.
*/
isSchemaInitialized?: Boolean;
/**
* The current status of the component type.
*/
status?: Status;
/**
* The maximum number of results to return at one time. The default is 25. Valid Range: Minimum value of 1. Maximum value of 250.
*/
propertyGroups?: PropertyGroupsResponse;
/**
* The syncSource of the SyncJob, if this entity was created by a SyncJob.
*/
syncSource?: SyncSource;
/**
* The component type name.
*/
componentTypeName?: ComponentTypeName;
/**
* This is an object that maps strings to compositeComponentTypes of the componentType. CompositeComponentType is referenced by componentTypeId.
*/
compositeComponentTypes?: CompositeComponentTypesResponse;
}
export interface GetEntityRequest {
/**
* The ID of the workspace.
*/
workspaceId: Id;
/**
* The ID of the entity.
*/
entityId: EntityId;
}
export interface GetEntityResponse {
/**
* The ID of the entity.
*/
entityId: EntityId;
/**
* The name of the entity.
*/
entityName: EntityName;
/**
* The ARN of the entity.
*/
arn: TwinMakerArn;
/**
* The current status of the entity.
*/
status: Status;
/**
* The ID of the workspace.
*/
workspaceId: Id;
/**
* The description of the entity.
*/
description?: Description;
/**
* An object that maps strings to the components in the entity. Each string in the mapping must be unique to this object.
*/
components?: ComponentsMap;
/**
* The ID of the parent entity for this entity.