String thingName
The name of the thing to which the entity is to be associated.
String entityId
The ID of the device to be associated with the thing.
The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME
Long namespaceVersion
The version of the user's namespace. Defaults to the latest version of the user's namespace.
DefinitionDocument definition
The workflow DefinitionDocument.
Long compatibleNamespaceVersion
The namespace version in which the workflow is to be created.
If no value is specified, the latest version is used by default.
FlowTemplateSummary summary
The summary object that describes the created workflow.
List<E> tags
Metadata, consisting of key-value pairs, that can be used to categorize your system instances.
DefinitionDocument definition
String target
The target type of the deployment. Valid values are GREENGRASS and CLOUD.
String greengrassGroupName
The name of the Greengrass group where the system instance will be deployed. This value is required if the value
of the target parameter is GREENGRASS.
String s3BucketName
The name of the Amazon Simple Storage Service bucket that will be used to store and deploy the system instance's
resource file. This value is required if the value of the target parameter is
GREENGRASS.
MetricsConfiguration metricsConfiguration
String flowActionsRoleArn
The ARN of the IAM role that AWS IoT Things Graph will assume when it executes the flow. This role must have read
and write access to AWS Lambda and AWS IoT and any other AWS services that the flow uses when it executes. This
value is required if the value of the target parameter is CLOUD.
SystemInstanceSummary summary
The summary object that describes the new system instance.
DefinitionDocument definition
The DefinitionDocument used to create the system.
Long compatibleNamespaceVersion
The namespace version in which the system is to be created.
If no value is specified, the latest version is used by default.
SystemTemplateSummary summary
The summary object that describes the created system.
String id
The ID of the workflow to be deleted.
The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME
String id
The ID of the system instance to be deleted.
String id
The ID of the system to be deleted.
The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME
String id
The ID of the system instance. This value is returned by the CreateSystemInstance action.
The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:deployment:DEPLOYMENTNAME
SystemInstanceSummary summary
An object that contains summary information about a system instance that was deployed.
String greengrassDeploymentId
The ID of the Greengrass deployment used to deploy the system instance.
String id
The ID of the workflow to be deleted.
The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME
String id
The ID of the system to delete.
The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME
String namespaceName
The name of the user's namespace. Set this to aws to get the public namespace.
String namespaceArn
The ARN of the namespace.
String namespaceName
The name of the namespace.
String trackingNamespaceName
The name of the public namespace that the latest namespace version is tracking.
Long trackingNamespaceVersion
The version of the public namespace that the latest version is tracking.
Long namespaceVersion
The version of the user's namespace to describe.
String id
The entity ID.
String arn
The entity ARN.
String type
The entity type.
Date createdAt
The time at which the entity was created.
DefinitionDocument definition
The definition document of the entity.
String name
The name of the entity search filter field. REFERENCED_ENTITY_ID filters on entities that are used
by the entity in the result set. For example, you can filter on the ID of a property that is used in a state.
List<E> value
An array of string values for the search filter field. Multiple values function as AND criteria in the search.
String flowExecutionId
The ID of the flow execution.
String status
The current status of the flow execution.
String systemInstanceId
The ID of the system instance that contains the flow.
String flowTemplateId
The ID of the flow.
Date createdAt
The date and time when the flow execution summary was created.
Date updatedAt
The date and time when the flow execution summary was last updated.
FlowTemplateSummary summary
An object that contains summary information about a workflow.
DefinitionDocument definition
A workflow's definition document.
Long validatedNamespaceVersion
The version of the user's namespace against which the workflow was validated. Use this value in your system instance.
FlowTemplateDescription description
The object that describes the specified workflow.
String id
The ID of the workflow.
The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME
String nextToken
The string that specifies the next page of results. Use this when you're paginating results.
Integer maxResults
The maximum number of results to return in the response.
String namespaceArn
The ARN of the namespace that is being deleted.
String namespaceName
The name of the namespace that is being deleted.
String status
The status of the deletion request.
String errorCode
An error code returned by the namespace deletion task.
String errorMessage
An error code returned by the namespace deletion task.
String id
The ID of the system deployment instance. This value is returned by CreateSystemInstance.
The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:deployment:DEPLOYMENTNAME
SystemInstanceDescription description
An object that describes the system instance.
SystemTemplateDescription description
An object that contains summary data about the system.
String id
The ID of the system template.
The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME
String nextToken
The string that specifies the next page of results. Use this when you're paginating results.
Integer maxResults
The maximum number of results to return in the response.
String uploadId
The ID of the upload. This value is returned by the UploadEntityDefinitions action.
String uploadId
The ID of the upload.
String uploadStatus
The status of the upload. The initial status is IN_PROGRESS. The response show all validation
failures if the upload fails.
String namespaceArn
The ARN of the upload.
String namespaceName
The name of the upload's namespace.
Long namespaceVersion
The version of the user's namespace. Defaults to the latest version of the user's namespace.
List<E> failureReason
The reason for an upload failure.
Date createdDate
The date at which the upload was created.
List<E> entityTypes
The entity types for which to search.
List<E> filters
Optional filter to apply to the search. Valid filters are NAME NAMESPACE,
SEMANTIC_TYPE_PATH and REFERENCED_ENTITY_ID. REFERENCED_ENTITY_ID filters
on entities that are used by the entity in the result set. For example, you can filter on the ID of a property
that is used in a state.
Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND criteria.
String nextToken
The string that specifies the next page of results. Use this when you're paginating results.
Integer maxResults
The maximum number of results to return in the response.
Long namespaceVersion
The version of the user's namespace. Defaults to the latest version of the user's namespace.
String systemInstanceId
The ID of the system instance that contains the flow.
String flowExecutionId
The ID of a flow execution.
Date startTime
The date and time of the earliest flow execution to return.
Date endTime
The date and time of the latest flow execution to return.
String nextToken
The string that specifies the next page of results. Use this when you're paginating results.
Integer maxResults
The maximum number of results to return in the response.
List<E> filters
An array of objects that limit the result set. The only valid filter is DEVICE_MODEL_ID.
String nextToken
The string that specifies the next page of results. Use this when you're paginating results.
Integer maxResults
The maximum number of results to return in the response.
List<E> filters
Optional filter to apply to the search. Valid filters are SYSTEM_TEMPLATE_ID, STATUS,
and GREENGRASS_GROUP_NAME.
Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND criteria.
String nextToken
The string that specifies the next page of results. Use this when you're paginating results.
Integer maxResults
The maximum number of results to return in the response.
List<E> filters
An array of filters that limit the result set. The only valid filter is FLOW_TEMPLATE_ID.
String nextToken
The string that specifies the next page of results. Use this when you're paginating results.
Integer maxResults
The maximum number of results to return in the response.
String entityId
The ID of the entity to which the things are associated.
The IDs should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME
String nextToken
The string that specifies the next page of results. Use this when you're paginating results.
Integer maxResults
The maximum number of results to return in the response.
Long namespaceVersion
The version of the user's namespace. Defaults to the latest version of the user's namespace.
SystemInstanceSummary summary
An object that contains summary information about a system instance.
DefinitionDocument definition
String s3BucketName
The Amazon Simple Storage Service bucket where information about a system instance is stored.
MetricsConfiguration metricsConfiguration
Long validatedNamespaceVersion
The version of the user's namespace against which the system instance was validated.
List<E> validatedDependencyRevisions
A list of objects that contain all of the IDs and revision numbers of workflows and systems that are used in a system instance.
String flowActionsRoleArn
The AWS Identity and Access Management (IAM) role that AWS IoT Things Graph assumes during flow execution in a cloud deployment. This role must have read and write permissionss to AWS Lambda and AWS IoT and to any other AWS services that the flow uses.
String id
The ID of the system instance.
String arn
The ARN of the system instance.
String status
The status of the system instance.
String target
The target of the system instance.
String greengrassGroupName
The ID of the Greengrass group where the system instance is deployed.
Date createdAt
The date when the system instance was created.
Date updatedAt
The date and time when the system instance was last updated.
String greengrassGroupId
The ID of the Greengrass group where the system instance is deployed.
String greengrassGroupVersionId
The version of the Greengrass group where the system instance is deployed.
SystemTemplateSummary summary
An object that contains summary information about a system.
DefinitionDocument definition
The definition document of a system.
Long validatedNamespaceVersion
The namespace version against which the system was validated. Use this value in your system instance.
String id
The ID of the system instance to remove from its target.
SystemInstanceSummary summary
An object that contains summary information about the system instance that was removed from its target.
String resourceArn
The Amazon Resource Name (ARN) of the resource whose tags are to be removed.
List<E> tagKeys
A list of tag key names to remove from the resource. You don't specify the value. Both the key and its associated value are removed.
This parameter to the API requires a JSON text string argument. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide.
String id
The ID of the workflow to be updated.
The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME
DefinitionDocument definition
The DefinitionDocument that contains the updated workflow definition.
Long compatibleNamespaceVersion
The version of the user's namespace.
If no value is specified, the latest version is used by default. Use the GetFlowTemplateRevisions if
you want to find earlier revisions of the flow to update.
FlowTemplateSummary summary
An object containing summary information about the updated workflow.
String id
The ID of the system to be updated.
The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME
DefinitionDocument definition
The DefinitionDocument that contains the updated system definition.
Long compatibleNamespaceVersion
The version of the user's namespace. Defaults to the latest version of the user's namespace.
If no value is specified, the latest version is used by default.
SystemTemplateSummary summary
An object containing summary information about the updated system.
DefinitionDocument document
The DefinitionDocument that defines the updated entities.
Boolean syncWithPublicNamespace
A Boolean that specifies whether to synchronize with the latest version of the public namespace. If set to
true, the upload will create a new namespace version.
Boolean deprecateExistingEntities
A Boolean that specifies whether to deprecate all entities in the latest version before uploading the new
DefinitionDocument. If set to true, the upload will create a new namespace version.
String uploadId
The ID that specifies the upload action. You can use this to track the status of the upload.
Copyright © 2023. All rights reserved.