{ "namespaceArn": "string", "namespaceName": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
namespaceArn (p. 15)
The ARN of the namespace to be deleted.
Type: String
namespaceName (p. 15)
The name of the namespace to be deleted.
Type: String
Length Constraints: Maximum length of 128.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 118).
InternalFailureException HTTP Status Code: 500 ThrottlingException
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
API Version 2018-09-06 15
See Also
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DeleteSystemInstance
Deletes a system instance. Only system instances that have never been deployed, or that have been undeployed can be deleted.
Users can create a new system instance that has the same ID as a deleted system instance.
Request Syntax
{ "id": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 116).
The request accepts the following data in JSON format.
id (p. 17)
The ID of the system instance to be deleted.
Type: String
Length Constraints: Maximum length of 160.
Pattern: ^urn:tdm:(([a-z]{2}-(gov-)?[a-z]{4,9}-[0-9]{1,3}/
[0-9]+/)*[\p{Alnum}_]+(/[\p{Alnum}_]+)*):([\p{Alpha}]*):([\p{Alnum}_]+(/
[\p{Alnum}_]+)*)$
Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 118).
InternalFailureException
HTTP Status Code: 500 InvalidRequestException
HTTP Status Code: 400 ResourceInUseException
HTTP Status Code: 400
API Version 2018-09-06 17
See Also
ThrottlingException
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DeleteSystemTemplate
Deletes a system. New deployments can't contain the system after its deletion. Existing deployments that contain the system will continue to work because they use a snapshot of the system that is taken when it is deployed.
Request Syntax
{ "id": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 116).
The request accepts the following data in JSON format.
id (p. 19)
The ID of the system to be deleted.
The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME Type: String
Length Constraints: Maximum length of 160.
Pattern: ^urn:tdm:(([a-z]{2}-(gov-)?[a-z]{4,9}-[0-9]{1,3}/
[0-9]+/)*[\p{Alnum}_]+(/[\p{Alnum}_]+)*):([\p{Alpha}]*):([\p{Alnum}_]+(/
[\p{Alnum}_]+)*)$
Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 118).
InternalFailureException
HTTP Status Code: 500 InvalidRequestException
HTTP Status Code: 400 ResourceInUseException
API Version 2018-09-06 19
See Also
HTTP Status Code: 400 ThrottlingException
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DeploySystemInstance
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.
Request Syntax
{
"id": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 116).
The request accepts the following data in JSON format.
id (p. 21)
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 Type: String
Length Constraints: Maximum length of 160.
Pattern: ^urn:tdm:(([a-z]{2}-(gov-)?[a-z]{4,9}-[0-9]{1,3}/
[0-9]+/)*[\p{Alnum}_]+(/[\p{Alnum}_]+)*):([\p{Alpha}]*):([\p{Alnum}_]+(/
[\p{Alnum}_]+)*)$
Required: Yes
Response Syntax
{ "greengrassDeploymentId": "string", "summary": {
"arn": "string",
API Version 2018-09-06 21
Response Elements
"createdAt": number,
"greengrassGroupId": "string", "greengrassGroupName": "string", "greengrassGroupVersionId": "string", "id": "string",
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
greengrassDeploymentId (p. 21)
The ID of the Greengrass deployment used to deploy the system instance.
Type: String summary (p. 21)
An object that contains summary information about a system instance that was deployed.
Type: SystemInstanceSummary (p. 109) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 118).
InternalFailureException
HTTP Status Code: 500 InvalidRequestException
HTTP Status Code: 400 ResourceInUseException
HTTP Status Code: 400 ResourceNotFoundException
HTTP Status Code: 400 ThrottlingException
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
API Version 2018-09-06 23
DeprecateFlowTemplate
DeprecateFlowTemplate
Deprecates the specified workflow. This action marks the workflow for deletion. Deprecated flows can't be deployed, but existing deployments will continue to run.
Request Syntax
{
"id": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 116).
The request accepts the following data in JSON format.
id (p. 24)
The ID of the workflow to be deleted.
The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME Type: String
Length Constraints: Maximum length of 160.
Pattern: ^urn:tdm:(([a-z]{2}-(gov-)?[a-z]{4,9}-[0-9]{1,3}/
[0-9]+/)*[\p{Alnum}_]+(/[\p{Alnum}_]+)*):([\p{Alpha}]*):([\p{Alnum}_]+(/
[\p{Alnum}_]+)*)$
Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 118).
InternalFailureException
HTTP Status Code: 500 InvalidRequestException
HTTP Status Code: 400 ResourceNotFoundException
HTTP Status Code: 400 ThrottlingException
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
API Version 2018-09-06 25
DeprecateSystemTemplate
DeprecateSystemTemplate
Deprecates the specified system.
Request Syntax
{ "id": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 116).
The request accepts the following data in JSON format.
id (p. 26)
The ID of the system to delete.
The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME Type: String
Length Constraints: Maximum length of 160.
Pattern: ^urn:tdm:(([a-z]{2}-(gov-)?[a-z]{4,9}-[0-9]{1,3}/
[0-9]+/)*[\p{Alnum}_]+(/[\p{Alnum}_]+)*):([\p{Alpha}]*):([\p{Alnum}_]+(/
[\p{Alnum}_]+)*)$
Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 118).
InternalFailureException
HTTP Status Code: 500 InvalidRequestException
HTTP Status Code: 400 ResourceNotFoundException
HTTP Status Code: 400
ThrottlingException
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
API Version 2018-09-06 27
DescribeNamespace
DescribeNamespace
Gets the latest version of the user's namespace and the public version that it is tracking.
Request Syntax
{
"namespaceName": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 116).
The request accepts the following data in JSON format.
namespaceName (p. 28)
The name of the user's namespace. Set this to aws to get the public namespace.
Type: String
Length Constraints: Maximum length of 128.
Required: No
Response Syntax
{
"namespaceArn": "string", "namespaceName": "string", "namespaceVersion": number, "trackingNamespaceName": "string", "trackingNamespaceVersion": number }
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
namespaceArn (p. 28)
The ARN of the namespace.
Type: String
namespaceName (p. 28)
The name of the namespace.
Type: String
Length Constraints: Maximum length of 128.
namespaceVersion (p. 28)
The version of the user's namespace to describe.
Type: Long
trackingNamespaceName (p. 28)
The name of the public namespace that the latest namespace version is tracking.
Type: String
Length Constraints: Maximum length of 128.
trackingNamespaceVersion (p. 28)
The version of the public namespace that the latest version is tracking.
Type: Long
Errors
For information about the errors that are common to all actions, see Common Errors (p. 118).
InternalFailureException
HTTP Status Code: 500 InvalidRequestException
HTTP Status Code: 400 ResourceNotFoundException
HTTP Status Code: 400 ThrottlingException
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
API Version 2018-09-06 29
See Also
DissociateEntityFromThing
Dissociates a device entity from a concrete thing. The action takes only the type of the entity that you need to dissociate because only one entity of a particular type can be associated with a thing.
Request Syntax
{
"entityType": "string", "thingName": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 116).
The request accepts the following data in JSON format.
entityType (p. 31)
The entity type from which to disassociate the thing.
Type: String
Valid Values: DEVICE | SERVICE | DEVICE_MODEL | CAPABILITY | STATE | ACTION | EVENT | PROPERTY | MAPPING | ENUM
Required: Yes thingName (p. 31)
The name of the thing to disassociate.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: [a-zA-Z0-9:_-]+
Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 118).
InternalFailureException
HTTP Status Code: 500 InvalidRequestException
API Version 2018-09-06 31
See Also
HTTP Status Code: 400 ResourceNotFoundException
HTTP Status Code: 400 ThrottlingException
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
GetEntities
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
• Device Models
• Services
This action doesn't return definitions for systems, flows, and deployments.
Request Syntax
{
"ids": [ "string" ], "namespaceVersion": number }
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 116).
The request accepts the following data in JSON format.
ids (p. 33)
An array of entity IDs.
The IDs should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 25 items.
Length Constraints: Maximum length of 160.
Pattern: ^urn:tdm:(([a-z]{2}-(gov-)?[a-z]{4,9}-[0-9]{1,3}/
[0-9]+/)*[\p{Alnum}_]+(/[\p{Alnum}_]+)*):([\p{Alpha}]*):([\p{Alnum}_]+(/
[\p{Alnum}_]+)*)$
Required: Yes
namespaceVersion (p. 33)
The version of the user's namespace. Defaults to the latest version of the user's namespace.
Type: Long
API Version 2018-09-06 33
Response Syntax
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
descriptions (p. 34)
An array of descriptions for the specified entities.
Type: Array of EntityDescription (p. 96) objects
Errors
For information about the errors that are common to all actions, see Common Errors (p. 118).
InternalFailureException
HTTP Status Code: 500 InvalidRequestException
HTTP Status Code: 400 ResourceNotFoundException
HTTP Status Code: 400 ThrottlingException
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
API Version 2018-09-06 35
GetFlowTemplate
GetFlowTemplate
Gets the latest version of the DefinitionDocument and FlowTemplateSummary for the specified workflow.
Request Syntax
{ "id": "string",
"revisionNumber": number }
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 116).
The request accepts the following data in JSON format.
id (p. 36)
The ID of the workflow.
The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME Type: String
Length Constraints: Maximum length of 160.
Pattern: ^urn:tdm:(([a-z]{2}-(gov-)?[a-z]{4,9}-[0-9]{1,3}/
[0-9]+/)*[\p{Alnum}_]+(/[\p{Alnum}_]+)*):([\p{Alpha}]*):([\p{Alnum}_]+(/
[\p{Alnum}_]+)*)$
Required: Yes revisionNumber (p. 36)
The number of the workflow revision to retrieve.
Type: Long
"revisionNumber": number },
"validatedNamespaceVersion": number }
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
description (p. 36)
The object that describes the specified workflow.
Type: FlowTemplateDescription (p. 102) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 118).
InternalFailureException
HTTP Status Code: 500 InvalidRequestException
HTTP Status Code: 400 ResourceNotFoundException
HTTP Status Code: 400 ThrottlingException
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
API Version 2018-09-06 37
GetFlowTemplateRevisions
GetFlowTemplateRevisions
Gets revisions of the specified workflow. Only the last 100 revisions are stored. If the workflow has been deprecated, this action will return revisions that occurred before the deprecation. This action won't work for workflows that have been deleted.
Request Syntax
{
"id": "string", "maxResults": number, "nextToken": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 116).
The request accepts the following data in JSON format.
id (p. 38)
The ID of the workflow.
The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME Type: String
Length Constraints: Maximum length of 160.
Pattern: ^urn:tdm:(([a-z]{2}-(gov-)?[a-z]{4,9}-[0-9]{1,3}/
[0-9]+/)*[\p{Alnum}_]+(/[\p{Alnum}_]+)*):([\p{Alpha}]*):([\p{Alnum}_]+(/
[\p{Alnum}_]+)*)$
Required: Yes maxResults (p. 38)
The maximum number of results to return in the response.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 250.
Required: No nextToken (p. 38)
The string that specifies the next page of results. Use this when you're paginating results.
Type: String Required: No
Response Syntax
{
"nextToken": "string", "summaries": [
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
nextToken (p. 39)
The string to specify as nextToken when you request the next page of results.
Type: String summaries (p. 39)
An array of objects that provide summary data about each revision.
Type: Array of FlowTemplateSummary (p. 104) objects
Errors
For information about the errors that are common to all actions, see Common Errors (p. 118).
InternalFailureException
HTTP Status Code: 500 InvalidRequestException
HTTP Status Code: 400 ResourceNotFoundException
HTTP Status Code: 400 ThrottlingException
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
API Version 2018-09-06 39
See Also
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
GetNamespaceDeletionStatus
Gets the status of a namespace deletion task.
Response Syntax
{ "errorCode": "string", "errorMessage": "string", "namespaceArn": "string", "namespaceName": "string", "status": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
errorCode (p. 41)
An error code returned by the namespace deletion task.
Type: String
Valid Values: VALIDATION_FAILED errorMessage (p. 41)
An error code returned by the namespace deletion task.
Type: String namespaceArn (p. 41)
The ARN of the namespace that is being deleted.
Type: String
namespaceName (p. 41)
The name of the namespace that is being deleted.
Type: String
Length Constraints: Maximum length of 128.
status (p. 41)
The status of the deletion request.
Type: String
Valid Values: IN_PROGRESS | SUCCEEDED | FAILED
Errors
For information about the errors that are common to all actions, see Common Errors (p. 118).
API Version 2018-09-06 41
See Also
InternalFailureException
HTTP Status Code: 500 InvalidRequestException
HTTP Status Code: 400 ThrottlingException
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
GetSystemInstance
Gets a system instance.
Request Syntax
{ "id": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 116).
The request accepts the following data in JSON format.
id (p. 43)
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 Type: String
Length Constraints: Maximum length of 160.
Pattern: ^urn:tdm:(([a-z]{2}-(gov-)?[a-z]{4,9}-[0-9]{1,3}/
"flowActionsRoleArn": "string", "metricsConfiguration": { "cloudMetricEnabled": boolean, "metricRuleRoleArn": "string"
},
"s3BucketName": "string", "summary": {
"arn": "string", "createdAt": number,
"greengrassGroupId": "string", "greengrassGroupName": "string", "greengrassGroupVersionId": "string", "id": "string",
API Version 2018-09-06 43
Response Elements
"status": "string", "target": "string", "updatedAt": number },
"validatedDependencyRevisions": [ {
"id": "string",
"revisionNumber": number }
],
"validatedNamespaceVersion": number }}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
description (p. 43)
An object that describes the system instance.
Type: SystemInstanceDescription (p. 106) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 118).
InternalFailureException
HTTP Status Code: 500 InvalidRequestException
HTTP Status Code: 400 ResourceNotFoundException
HTTP Status Code: 400 ThrottlingException
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
API Version 2018-09-06 45
GetSystemTemplate
GetSystemTemplate
Gets a system.
Request Syntax
{ "id": "string",
"revisionNumber": number }
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 116).
The request accepts the following data in JSON format.
id (p. 46)
The ID of the system to get. This ID must be in the user's namespace.
The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME Type: String
Length Constraints: Maximum length of 160.
Pattern: ^urn:tdm:(([a-z]{2}-(gov-)?[a-z]{4,9}-[0-9]{1,3}/
[0-9]+/)*[\p{Alnum}_]+(/[\p{Alnum}_]+)*):([\p{Alpha}]*):([\p{Alnum}_]+(/
[\p{Alnum}_]+)*)$
Required: Yes revisionNumber (p. 46)
The number that specifies the revision of the system to get.
Type: Long
},
"validatedNamespaceVersion": number }}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
description (p. 46)
An object that contains summary data about the system.
An object that contains summary data about the system.