Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IoTThingsGraph

AWS IoT Things Graph

AWS IoT Things Graph provides an integrated set of tools that enable developers to connect devices and services that use different standards, such as units of measure and communication protocols. AWS IoT Things Graph makes it possible to build IoT applications with little to no code by connecting devices and services and defining how they interact at an abstract level.

For more information about how AWS IoT Things Graph works, see the User Guide.

The AWS IoT Things Graph service is discontinued.

Hierarchy

Implements

Index

Constructors

constructor

Properties

Readonly config

The resolved configuration of IoTThingsGraphClient class. This is resolved and normalized from the constructor configuration interface.

middlewareStack

Methods

associateEntityToThing

createFlowTemplate

  • deprecated

    Creates a workflow template. Workflows can be created only in the user's namespace. (The public namespace contains only entities.) The workflow can contain only entities in the specified namespace. The workflow is validated against the entities in the latest version of the user's namespace unless another namespace version is specified in the request.

    Parameters

    Returns Promise<CreateFlowTemplateCommandOutput>

  • deprecated

    Creates a workflow template. Workflows can be created only in the user's namespace. (The public namespace contains only entities.) The workflow can contain only entities in the specified namespace. The workflow is validated against the entities in the latest version of the user's namespace unless another namespace version is specified in the request.

    Parameters

    Returns void

  • deprecated

    Creates a workflow template. Workflows can be created only in the user's namespace. (The public namespace contains only entities.) The workflow can contain only entities in the specified namespace. The workflow is validated against the entities in the latest version of the user's namespace unless another namespace version is specified in the request.

    Parameters

    Returns void

  • deprecated

    Creates a workflow template. Workflows can be created only in the user's namespace. (The public namespace contains only entities.) The workflow can contain only entities in the specified namespace. The workflow is validated against the entities in the latest version of the user's namespace unless another namespace version is specified in the request.

    Parameters

    • args: CreateFlowTemplateCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<CreateFlowTemplateCommandOutput>

  • deprecated

    Creates a workflow template. Workflows can be created only in the user's namespace. (The public namespace contains only entities.) The workflow can contain only entities in the specified namespace. The workflow is validated against the entities in the latest version of the user's namespace unless another namespace version is specified in the request.

    Parameters

    Returns void

  • deprecated

    Creates a workflow template. Workflows can be created only in the user's namespace. (The public namespace contains only entities.) The workflow can contain only entities in the specified namespace. The workflow is validated against the entities in the latest version of the user's namespace unless another namespace version is specified in the request.

    Parameters

    Returns void

createSystemInstance

  • deprecated

    Creates a system instance.

    This action validates the system instance, prepares the deployment-related resources. For Greengrass deployments, it updates the Greengrass group that is specified by the greengrassGroupName parameter. It also adds a file to the S3 bucket specified by the s3BucketName parameter. You need to call DeploySystemInstance after running this action.

    For Greengrass deployments, since this action modifies and adds resources to a Greengrass group and an S3 bucket on the caller's behalf, the calling identity must have write permissions to both the specified Greengrass group and S3 bucket. Otherwise, the call will fail with an authorization error.

    For cloud deployments, this action requires a flowActionsRoleArn value. This is an IAM role that has permissions to access AWS services, such as AWS Lambda and AWS IoT, that the flow uses when it executes.

    If the definition document doesn't specify a version of the user's namespace, the latest version will be used by default.

    Parameters

    Returns Promise<CreateSystemInstanceCommandOutput>

  • deprecated

    Creates a system instance.

    This action validates the system instance, prepares the deployment-related resources. For Greengrass deployments, it updates the Greengrass group that is specified by the greengrassGroupName parameter. It also adds a file to the S3 bucket specified by the s3BucketName parameter. You need to call DeploySystemInstance after running this action.

    For Greengrass deployments, since this action modifies and adds resources to a Greengrass group and an S3 bucket on the caller's behalf, the calling identity must have write permissions to both the specified Greengrass group and S3 bucket. Otherwise, the call will fail with an authorization error.

    For cloud deployments, this action requires a flowActionsRoleArn value. This is an IAM role that has permissions to access AWS services, such as AWS Lambda and AWS IoT, that the flow uses when it executes.

    If the definition document doesn't specify a version of the user's namespace, the latest version will be used by default.

    Parameters

    Returns void

  • deprecated

    Creates a system instance.

    This action validates the system instance, prepares the deployment-related resources. For Greengrass deployments, it updates the Greengrass group that is specified by the greengrassGroupName parameter. It also adds a file to the S3 bucket specified by the s3BucketName parameter. You need to call DeploySystemInstance after running this action.

    For Greengrass deployments, since this action modifies and adds resources to a Greengrass group and an S3 bucket on the caller's behalf, the calling identity must have write permissions to both the specified Greengrass group and S3 bucket. Otherwise, the call will fail with an authorization error.

    For cloud deployments, this action requires a flowActionsRoleArn value. This is an IAM role that has permissions to access AWS services, such as AWS Lambda and AWS IoT, that the flow uses when it executes.

    If the definition document doesn't specify a version of the user's namespace, the latest version will be used by default.

    Parameters

    Returns void

  • deprecated

    Creates a system instance.

    This action validates the system instance, prepares the deployment-related resources. For Greengrass deployments, it updates the Greengrass group that is specified by the greengrassGroupName parameter. It also adds a file to the S3 bucket specified by the s3BucketName parameter. You need to call DeploySystemInstance after running this action.

    For Greengrass deployments, since this action modifies and adds resources to a Greengrass group and an S3 bucket on the caller's behalf, the calling identity must have write permissions to both the specified Greengrass group and S3 bucket. Otherwise, the call will fail with an authorization error.

    For cloud deployments, this action requires a flowActionsRoleArn value. This is an IAM role that has permissions to access AWS services, such as AWS Lambda and AWS IoT, that the flow uses when it executes.

    If the definition document doesn't specify a version of the user's namespace, the latest version will be used by default.

    Parameters

    • args: CreateSystemInstanceCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<CreateSystemInstanceCommandOutput>

  • deprecated

    Creates a system instance.

    This action validates the system instance, prepares the deployment-related resources. For Greengrass deployments, it updates the Greengrass group that is specified by the greengrassGroupName parameter. It also adds a file to the S3 bucket specified by the s3BucketName parameter. You need to call DeploySystemInstance after running this action.

    For Greengrass deployments, since this action modifies and adds resources to a Greengrass group and an S3 bucket on the caller's behalf, the calling identity must have write permissions to both the specified Greengrass group and S3 bucket. Otherwise, the call will fail with an authorization error.

    For cloud deployments, this action requires a flowActionsRoleArn value. This is an IAM role that has permissions to access AWS services, such as AWS Lambda and AWS IoT, that the flow uses when it executes.

    If the definition document doesn't specify a version of the user's namespace, the latest version will be used by default.

    Parameters

    Returns void

  • deprecated

    Creates a system instance.

    This action validates the system instance, prepares the deployment-related resources. For Greengrass deployments, it updates the Greengrass group that is specified by the greengrassGroupName parameter. It also adds a file to the S3 bucket specified by the s3BucketName parameter. You need to call DeploySystemInstance after running this action.

    For Greengrass deployments, since this action modifies and adds resources to a Greengrass group and an S3 bucket on the caller's behalf, the calling identity must have write permissions to both the specified Greengrass group and S3 bucket. Otherwise, the call will fail with an authorization error.

    For cloud deployments, this action requires a flowActionsRoleArn value. This is an IAM role that has permissions to access AWS services, such as AWS Lambda and AWS IoT, that the flow uses when it executes.

    If the definition document doesn't specify a version of the user's namespace, the latest version will be used by default.

    Parameters

    Returns void

createSystemTemplate

deleteFlowTemplate

  • deprecated

    Deletes a workflow. Any new system or deployment that contains this workflow will fail to update or deploy. Existing deployments that contain the workflow will continue to run (since they use a snapshot of the workflow taken at the time of deployment).

    Parameters

    Returns Promise<DeleteFlowTemplateCommandOutput>

  • deprecated

    Deletes a workflow. Any new system or deployment that contains this workflow will fail to update or deploy. Existing deployments that contain the workflow will continue to run (since they use a snapshot of the workflow taken at the time of deployment).

    Parameters

    Returns void

  • deprecated

    Deletes a workflow. Any new system or deployment that contains this workflow will fail to update or deploy. Existing deployments that contain the workflow will continue to run (since they use a snapshot of the workflow taken at the time of deployment).

    Parameters

    Returns void

  • deprecated

    Deletes a workflow. Any new system or deployment that contains this workflow will fail to update or deploy. Existing deployments that contain the workflow will continue to run (since they use a snapshot of the workflow taken at the time of deployment).

    Parameters

    • args: DeleteFlowTemplateCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<DeleteFlowTemplateCommandOutput>

  • deprecated

    Deletes a workflow. Any new system or deployment that contains this workflow will fail to update or deploy. Existing deployments that contain the workflow will continue to run (since they use a snapshot of the workflow taken at the time of deployment).

    Parameters

    Returns void

  • deprecated

    Deletes a workflow. Any new system or deployment that contains this workflow will fail to update or deploy. Existing deployments that contain the workflow will continue to run (since they use a snapshot of the workflow taken at the time of deployment).

    Parameters

    Returns void

deleteNamespace

  • deprecated

    Deletes the specified namespace. This action deletes all of the entities in the namespace. Delete the systems and flows that use entities in the namespace before performing this action. This action takes no request parameters.

    Parameters

    Returns Promise<DeleteNamespaceCommandOutput>

  • deprecated

    Deletes the specified namespace. This action deletes all of the entities in the namespace. Delete the systems and flows that use entities in the namespace before performing this action. This action takes no request parameters.

    Parameters

    Returns void

  • deprecated

    Deletes the specified namespace. This action deletes all of the entities in the namespace. Delete the systems and flows that use entities in the namespace before performing this action. This action takes no request parameters.

    Parameters

    Returns void

  • deprecated

    Deletes the specified namespace. This action deletes all of the entities in the namespace. Delete the systems and flows that use entities in the namespace before performing this action. This action takes no request parameters.

    Parameters

    • args: DeleteNamespaceCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<DeleteNamespaceCommandOutput>

  • deprecated

    Deletes the specified namespace. This action deletes all of the entities in the namespace. Delete the systems and flows that use entities in the namespace before performing this action. This action takes no request parameters.

    Parameters

    Returns void

  • deprecated

    Deletes the specified namespace. This action deletes all of the entities in the namespace. Delete the systems and flows that use entities in the namespace before performing this action. This action takes no request parameters.

    Parameters

    Returns void

deleteSystemInstance

deleteSystemTemplate

deploySystemInstance

  • deprecated

    Greengrass and Cloud Deployments

    Deploys the system instance to the target specified in CreateSystemInstance.

    Greengrass Deployments

    If the system or any workflows and entities have been updated before this action is called, then the deployment will create a new Amazon Simple Storage Service resource file and then deploy it.

    Since this action creates a Greengrass deployment on the caller's behalf, the calling identity must have write permissions to the specified Greengrass group. Otherwise, the call will fail with an authorization error.

    For information about the artifacts that get added to your Greengrass core device when you use this API, see AWS IoT Things Graph and AWS IoT Greengrass.

    Parameters

    Returns Promise<DeploySystemInstanceCommandOutput>

  • deprecated

    Greengrass and Cloud Deployments

    Deploys the system instance to the target specified in CreateSystemInstance.

    Greengrass Deployments

    If the system or any workflows and entities have been updated before this action is called, then the deployment will create a new Amazon Simple Storage Service resource file and then deploy it.

    Since this action creates a Greengrass deployment on the caller's behalf, the calling identity must have write permissions to the specified Greengrass group. Otherwise, the call will fail with an authorization error.

    For information about the artifacts that get added to your Greengrass core device when you use this API, see AWS IoT Things Graph and AWS IoT Greengrass.

    Parameters

    Returns void

  • deprecated

    Greengrass and Cloud Deployments

    Deploys the system instance to the target specified in CreateSystemInstance.

    Greengrass Deployments

    If the system or any workflows and entities have been updated before this action is called, then the deployment will create a new Amazon Simple Storage Service resource file and then deploy it.

    Since this action creates a Greengrass deployment on the caller's behalf, the calling identity must have write permissions to the specified Greengrass group. Otherwise, the call will fail with an authorization error.

    For information about the artifacts that get added to your Greengrass core device when you use this API, see AWS IoT Things Graph and AWS IoT Greengrass.

    Parameters

    Returns void

  • deprecated

    Greengrass and Cloud Deployments

    Deploys the system instance to the target specified in CreateSystemInstance.

    Greengrass Deployments

    If the system or any workflows and entities have been updated before this action is called, then the deployment will create a new Amazon Simple Storage Service resource file and then deploy it.

    Since this action creates a Greengrass deployment on the caller's behalf, the calling identity must have write permissions to the specified Greengrass group. Otherwise, the call will fail with an authorization error.

    For information about the artifacts that get added to your Greengrass core device when you use this API, see AWS IoT Things Graph and AWS IoT Greengrass.

    Parameters

    • args: DeploySystemInstanceCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<DeploySystemInstanceCommandOutput>

  • deprecated

    Greengrass and Cloud Deployments

    Deploys the system instance to the target specified in CreateSystemInstance.

    Greengrass Deployments

    If the system or any workflows and entities have been updated before this action is called, then the deployment will create a new Amazon Simple Storage Service resource file and then deploy it.

    Since this action creates a Greengrass deployment on the caller's behalf, the calling identity must have write permissions to the specified Greengrass group. Otherwise, the call will fail with an authorization error.

    For information about the artifacts that get added to your Greengrass core device when you use this API, see AWS IoT Things Graph and AWS IoT Greengrass.

    Parameters

    Returns void

  • deprecated

    Greengrass and Cloud Deployments

    Deploys the system instance to the target specified in CreateSystemInstance.

    Greengrass Deployments

    If the system or any workflows and entities have been updated before this action is called, then the deployment will create a new Amazon Simple Storage Service resource file and then deploy it.

    Since this action creates a Greengrass deployment on the caller's behalf, the calling identity must have write permissions to the specified Greengrass group. Otherwise, the call will fail with an authorization error.

    For information about the artifacts that get added to your Greengrass core device when you use this API, see AWS IoT Things Graph and AWS IoT Greengrass.

    Parameters

    Returns void

deprecateFlowTemplate

deprecateSystemTemplate

describeNamespace

destroy

  • destroy(): void
  • Destroy underlying resources, like sockets. It's usually not necessary to do this. However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed. Otherwise, sockets might stay open for quite a long time before the server terminates them.

    Returns void

dissociateEntityFromThing

getEntities

  • deprecated

    Gets definitions of the specified entities. Uses the latest version of the user's namespace by default. This API returns the following TDM entities.

    • Properties

    • States

    • Events

    • Actions

    • Capabilities

    • Mappings

    • Devices

    • Device Models

    • Services

    This action doesn't return definitions for systems, flows, and deployments.

    Parameters

    Returns Promise<GetEntitiesCommandOutput>

  • deprecated

    Gets definitions of the specified entities. Uses the latest version of the user's namespace by default. This API returns the following TDM entities.

    • Properties

    • States

    • Events

    • Actions

    • Capabilities

    • Mappings

    • Devices

    • Device Models

    • Services

    This action doesn't return definitions for systems, flows, and deployments.

    Parameters

    Returns void

  • deprecated

    Gets definitions of the specified entities. Uses the latest version of the user's namespace by default. This API returns the following TDM entities.

    • Properties

    • States

    • Events

    • Actions

    • Capabilities

    • Mappings

    • Devices

    • Device Models

    • Services

    This action doesn't return definitions for systems, flows, and deployments.

    Parameters

    Returns void

  • deprecated

    Gets definitions of the specified entities. Uses the latest version of the user's namespace by default. This API returns the following TDM entities.

    • Properties

    • States

    • Events

    • Actions

    • Capabilities

    • Mappings

    • Devices

    • Device Models

    • Services

    This action doesn't return definitions for systems, flows, and deployments.

    Parameters

    • args: GetEntitiesCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<GetEntitiesCommandOutput>

  • deprecated

    Gets definitions of the specified entities. Uses the latest version of the user's namespace by default. This API returns the following TDM entities.

    • Properties

    • States

    • Events

    • Actions

    • Capabilities

    • Mappings

    • Devices

    • Device Models

    • Services

    This action doesn't return definitions for systems, flows, and deployments.

    Parameters

    Returns void

  • deprecated

    Gets definitions of the specified entities. Uses the latest version of the user's namespace by default. This API returns the following TDM entities.

    • Properties

    • States

    • Events

    • Actions

    • Capabilities

    • Mappings

    • Devices

    • Device Models

    • Services

    This action doesn't return definitions for systems, flows, and deployments.

    Parameters

    Returns void

getFlowTemplate

getFlowTemplateRevisions

getNamespaceDeletionStatus

getSystemInstance

getSystemTemplate

getSystemTemplateRevisions

getUploadStatus

listFlowExecutionMessages

listTagsForResource

searchEntities

searchFlowExecutions

searchFlowTemplates

searchSystemInstances

searchSystemTemplates

searchThings

  • deprecated

    Searches for things associated with the specified entity. You can search by both device and device model.

    For example, if two different devices, camera1 and camera2, implement the camera device model, the user can associate thing1 to camera1 and thing2 to camera2. SearchThings(camera2) will return only thing2, but SearchThings(camera) will return both thing1 and thing2.

    This action searches for exact matches and doesn't perform partial text matching.

    Parameters

    Returns Promise<SearchThingsCommandOutput>

  • deprecated

    Searches for things associated with the specified entity. You can search by both device and device model.

    For example, if two different devices, camera1 and camera2, implement the camera device model, the user can associate thing1 to camera1 and thing2 to camera2. SearchThings(camera2) will return only thing2, but SearchThings(camera) will return both thing1 and thing2.

    This action searches for exact matches and doesn't perform partial text matching.

    Parameters

    Returns void

  • deprecated

    Searches for things associated with the specified entity. You can search by both device and device model.

    For example, if two different devices, camera1 and camera2, implement the camera device model, the user can associate thing1 to camera1 and thing2 to camera2. SearchThings(camera2) will return only thing2, but SearchThings(camera) will return both thing1 and thing2.

    This action searches for exact matches and doesn't perform partial text matching.

    Parameters

    Returns void

  • deprecated

    Searches for things associated with the specified entity. You can search by both device and device model.

    For example, if two different devices, camera1 and camera2, implement the camera device model, the user can associate thing1 to camera1 and thing2 to camera2. SearchThings(camera2) will return only thing2, but SearchThings(camera) will return both thing1 and thing2.

    This action searches for exact matches and doesn't perform partial text matching.

    Parameters

    • args: SearchThingsCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<SearchThingsCommandOutput>

  • deprecated

    Searches for things associated with the specified entity. You can search by both device and device model.

    For example, if two different devices, camera1 and camera2, implement the camera device model, the user can associate thing1 to camera1 and thing2 to camera2. SearchThings(camera2) will return only thing2, but SearchThings(camera) will return both thing1 and thing2.

    This action searches for exact matches and doesn't perform partial text matching.

    Parameters

    Returns void

  • deprecated

    Searches for things associated with the specified entity. You can search by both device and device model.

    For example, if two different devices, camera1 and camera2, implement the camera device model, the user can associate thing1 to camera1 and thing2 to camera2. SearchThings(camera2) will return only thing2, but SearchThings(camera) will return both thing1 and thing2.

    This action searches for exact matches and doesn't perform partial text matching.

    Parameters

    Returns void

send

tagResource

undeploySystemInstance

untagResource

updateFlowTemplate

  • deprecated

    Updates the specified workflow. All deployed systems and system instances that use the workflow will see the changes in the flow when it is redeployed. If you don't want this behavior, copy the workflow (creating a new workflow with a different ID), and update the copy. The workflow can contain only entities in the specified namespace.

    Parameters

    Returns Promise<UpdateFlowTemplateCommandOutput>

  • deprecated

    Updates the specified workflow. All deployed systems and system instances that use the workflow will see the changes in the flow when it is redeployed. If you don't want this behavior, copy the workflow (creating a new workflow with a different ID), and update the copy. The workflow can contain only entities in the specified namespace.

    Parameters

    Returns void

  • deprecated

    Updates the specified workflow. All deployed systems and system instances that use the workflow will see the changes in the flow when it is redeployed. If you don't want this behavior, copy the workflow (creating a new workflow with a different ID), and update the copy. The workflow can contain only entities in the specified namespace.

    Parameters

    Returns void

  • deprecated

    Updates the specified workflow. All deployed systems and system instances that use the workflow will see the changes in the flow when it is redeployed. If you don't want this behavior, copy the workflow (creating a new workflow with a different ID), and update the copy. The workflow can contain only entities in the specified namespace.

    Parameters

    • args: UpdateFlowTemplateCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<UpdateFlowTemplateCommandOutput>

  • deprecated

    Updates the specified workflow. All deployed systems and system instances that use the workflow will see the changes in the flow when it is redeployed. If you don't want this behavior, copy the workflow (creating a new workflow with a different ID), and update the copy. The workflow can contain only entities in the specified namespace.

    Parameters

    Returns void

  • deprecated

    Updates the specified workflow. All deployed systems and system instances that use the workflow will see the changes in the flow when it is redeployed. If you don't want this behavior, copy the workflow (creating a new workflow with a different ID), and update the copy. The workflow can contain only entities in the specified namespace.

    Parameters

    Returns void

updateSystemTemplate

uploadEntityDefinitions

  • deprecated

    Asynchronously uploads one or more entity definitions to the user's namespace. The document parameter is required if syncWithPublicNamespace and deleteExistingEntites are false. If the syncWithPublicNamespace parameter is set to true, the user's namespace will synchronize with the latest version of the public namespace. If deprecateExistingEntities is set to true, all entities in the latest version will be deleted before the new DefinitionDocument is uploaded.

    When a user uploads entity definitions for the first time, the service creates a new namespace for the user. The new namespace tracks the public namespace. Currently users can have only one namespace. The namespace version increments whenever a user uploads entity definitions that are backwards-incompatible and whenever a user sets the syncWithPublicNamespace parameter or the deprecateExistingEntities parameter to true.

    The IDs for all of the entities should be in URN format. Each entity must be in the user's namespace. Users can't create entities in the public namespace, but entity definitions can refer to entities in the public namespace.

    Valid entities are Device, DeviceModel, Service, Capability, State, Action, Event, Property, Mapping, Enum.

    Parameters

    Returns Promise<UploadEntityDefinitionsCommandOutput>

  • deprecated

    Asynchronously uploads one or more entity definitions to the user's namespace. The document parameter is required if syncWithPublicNamespace and deleteExistingEntites are false. If the syncWithPublicNamespace parameter is set to true, the user's namespace will synchronize with the latest version of the public namespace. If deprecateExistingEntities is set to true, all entities in the latest version will be deleted before the new DefinitionDocument is uploaded.

    When a user uploads entity definitions for the first time, the service creates a new namespace for the user. The new namespace tracks the public namespace. Currently users can have only one namespace. The namespace version increments whenever a user uploads entity definitions that are backwards-incompatible and whenever a user sets the syncWithPublicNamespace parameter or the deprecateExistingEntities parameter to true.

    The IDs for all of the entities should be in URN format. Each entity must be in the user's namespace. Users can't create entities in the public namespace, but entity definitions can refer to entities in the public namespace.

    Valid entities are Device, DeviceModel, Service, Capability, State, Action, Event, Property, Mapping, Enum.

    Parameters

    Returns void

  • deprecated

    Asynchronously uploads one or more entity definitions to the user's namespace. The document parameter is required if syncWithPublicNamespace and deleteExistingEntites are false. If the syncWithPublicNamespace parameter is set to true, the user's namespace will synchronize with the latest version of the public namespace. If deprecateExistingEntities is set to true, all entities in the latest version will be deleted before the new DefinitionDocument is uploaded.

    When a user uploads entity definitions for the first time, the service creates a new namespace for the user. The new namespace tracks the public namespace. Currently users can have only one namespace. The namespace version increments whenever a user uploads entity definitions that are backwards-incompatible and whenever a user sets the syncWithPublicNamespace parameter or the deprecateExistingEntities parameter to true.

    The IDs for all of the entities should be in URN format. Each entity must be in the user's namespace. Users can't create entities in the public namespace, but entity definitions can refer to entities in the public namespace.

    Valid entities are Device, DeviceModel, Service, Capability, State, Action, Event, Property, Mapping, Enum.

    Parameters

    Returns void

  • deprecated

    Asynchronously uploads one or more entity definitions to the user's namespace. The document parameter is required if syncWithPublicNamespace and deleteExistingEntites are false. If the syncWithPublicNamespace parameter is set to true, the user's namespace will synchronize with the latest version of the public namespace. If deprecateExistingEntities is set to true, all entities in the latest version will be deleted before the new DefinitionDocument is uploaded.

    When a user uploads entity definitions for the first time, the service creates a new namespace for the user. The new namespace tracks the public namespace. Currently users can have only one namespace. The namespace version increments whenever a user uploads entity definitions that are backwards-incompatible and whenever a user sets the syncWithPublicNamespace parameter or the deprecateExistingEntities parameter to true.

    The IDs for all of the entities should be in URN format. Each entity must be in the user's namespace. Users can't create entities in the public namespace, but entity definitions can refer to entities in the public namespace.

    Valid entities are Device, DeviceModel, Service, Capability, State, Action, Event, Property, Mapping, Enum.

    Parameters

    • args: UploadEntityDefinitionsCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<UploadEntityDefinitionsCommandOutput>

  • deprecated

    Asynchronously uploads one or more entity definitions to the user's namespace. The document parameter is required if syncWithPublicNamespace and deleteExistingEntites are false. If the syncWithPublicNamespace parameter is set to true, the user's namespace will synchronize with the latest version of the public namespace. If deprecateExistingEntities is set to true, all entities in the latest version will be deleted before the new DefinitionDocument is uploaded.

    When a user uploads entity definitions for the first time, the service creates a new namespace for the user. The new namespace tracks the public namespace. Currently users can have only one namespace. The namespace version increments whenever a user uploads entity definitions that are backwards-incompatible and whenever a user sets the syncWithPublicNamespace parameter or the deprecateExistingEntities parameter to true.

    The IDs for all of the entities should be in URN format. Each entity must be in the user's namespace. Users can't create entities in the public namespace, but entity definitions can refer to entities in the public namespace.

    Valid entities are Device, DeviceModel, Service, Capability, State, Action, Event, Property, Mapping, Enum.

    Parameters

    Returns void

  • deprecated

    Asynchronously uploads one or more entity definitions to the user's namespace. The document parameter is required if syncWithPublicNamespace and deleteExistingEntites are false. If the syncWithPublicNamespace parameter is set to true, the user's namespace will synchronize with the latest version of the public namespace. If deprecateExistingEntities is set to true, all entities in the latest version will be deleted before the new DefinitionDocument is uploaded.

    When a user uploads entity definitions for the first time, the service creates a new namespace for the user. The new namespace tracks the public namespace. Currently users can have only one namespace. The namespace version increments whenever a user uploads entity definitions that are backwards-incompatible and whenever a user sets the syncWithPublicNamespace parameter or the deprecateExistingEntities parameter to true.

    The IDs for all of the entities should be in URN format. Each entity must be in the user's namespace. Users can't create entities in the public namespace, but entity definitions can refer to entities in the public namespace.

    Valid entities are Device, DeviceModel, Service, Capability, State, Action, Event, Property, Mapping, Enum.

    Parameters

    Returns void