2019/05/29 - AWS IoT Things Graph - 35 new api methods
Changes Update iotthingsgraph client to latest version
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.
See also: AWS API Documentation
Request Syntax
client.create_flow_template(
definition={
'language': 'GRAPHQL',
'text': 'string'
},
compatibleNamespaceVersion=123
)
dict
[REQUIRED]
The workflow DefinitionDocument.
language (string) -- [REQUIRED]
The language used to define the entity. GRAPHQL is the only valid value.
text (string) -- [REQUIRED]
The GraphQL text that defines the entity.
integer
The namespace version in which the workflow is to be created.
If no value is specified, the latest version is used by default.
dict
Response Syntax
{
'summary': {
'id': 'string',
'arn': 'string',
'revisionNumber': 123,
'createdAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
summary (dict) --
The summary object that describes the created workflow.
id (string) --
The ID of the workflow.
arn (string) --
The ARN of the workflow.
revisionNumber (integer) --
The revision number of the workflow.
createdAt (datetime) --
The date when the workflow was created.
Gets a system.
See also: AWS API Documentation
Request Syntax
client.get_system_template(
id='string',
revisionNumber=123
)
string
[REQUIRED]
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
integer
The number that specifies the revision of the system to get.
dict
Response Syntax
{
'description': {
'summary': {
'id': 'string',
'arn': 'string',
'revisionNumber': 123,
'createdAt': datetime(2015, 1, 1)
},
'definition': {
'language': 'GRAPHQL',
'text': 'string'
},
'validatedNamespaceVersion': 123
}
}
Response Structure
(dict) --
description (dict) --
An object that contains summary data about the system.
summary (dict) --
An object that contains summary information about a system.
id (string) --
The ID of the system.
arn (string) --
The ARN of the system.
revisionNumber (integer) --
The revision number of the system.
createdAt (datetime) --
The date when the system was created.
definition (dict) --
The definition document of a system.
language (string) --
The language used to define the entity. GRAPHQL is the only valid value.
text (string) --
The GraphQL text that defines the entity.
validatedNamespaceVersion (integer) --
The namespace version against which the system was validated. Use this value in your system instance.
Gets the latest version of the user's namespace and the public version that it is tracking.
See also: AWS API Documentation
Request Syntax
client.describe_namespace(
namespaceName='string'
)
string
The name of the user's namespace. Set this to aws to get the public namespace.
dict
Response Syntax
{
'namespaceArn': 'string',
'namespaceName': 'string',
'trackingNamespaceName': 'string',
'trackingNamespaceVersion': 123,
'namespaceVersion': 123
}
Response Structure
(dict) --
namespaceArn (string) --
The ARN of the namespace.
namespaceName (string) --
The name of the namespace.
trackingNamespaceName (string) --
The name of the public namespace that the latest namespace version is tracking.
trackingNamespaceVersion (integer) --
The version of the public namespace that the latest version is tracking.
namespaceVersion (integer) --
The version of the user's namespace to describe.
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).
See also: AWS API Documentation
Request Syntax
client.delete_flow_template(
id='string'
)
string
[REQUIRED]
The ID of the workflow to be deleted.
The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME
dict
Response Syntax
{}
Response Structure
(dict) --
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.
See also: AWS API Documentation
Request Syntax
client.get_entities(
ids=[
'string',
],
namespaceVersion=123
)
list
[REQUIRED]
An array of entity IDs.
The IDs should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME
(string) --
integer
The version of the user's namespace. Defaults to the latest version of the user's namespace.
dict
Response Syntax
{
'descriptions': [
{
'id': 'string',
'arn': 'string',
'type': 'DEVICE'|'SERVICE'|'DEVICE_MODEL'|'CAPABILITY'|'STATE'|'ACTION'|'EVENT'|'PROPERTY'|'MAPPING'|'ENUM',
'createdAt': datetime(2015, 1, 1),
'definition': {
'language': 'GRAPHQL',
'text': 'string'
}
},
]
}
Response Structure
(dict) --
descriptions (list) --
An array of descriptions for the specified entities.
(dict) --
Describes the properties of an entity.
id (string) --
The entity ID.
arn (string) --
The entity ARN.
type (string) --
The entity type.
createdAt (datetime) --
The time at which the entity was created.
definition (dict) --
The definition document of the entity.
language (string) --
The language used to define the entity. GRAPHQL is the only valid value.
text (string) --
The GraphQL text that defines the entity.
Removes a system instance from its target (Cloud or Greengrass).
See also: AWS API Documentation
Request Syntax
client.undeploy_system_instance(
id='string'
)
string
The ID of the system instance to remove from its target.
dict
Response Syntax
{
'summary': {
'id': 'string',
'arn': 'string',
'status': 'NOT_DEPLOYED'|'BOOTSTRAP'|'DEPLOY_IN_PROGRESS'|'DEPLOYED_IN_TARGET'|'UNDEPLOY_IN_PROGRESS'|'FAILED'|'PENDING_DELETE'|'DELETED_IN_TARGET',
'target': 'GREENGRASS'|'CLOUD',
'greengrassGroupName': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'greengrassGroupId': 'string',
'greengrassGroupVersionId': 'string'
}
}
Response Structure
(dict) --
summary (dict) --
An object that contains summary information about the system instance that was removed from its target.
id (string) --
The ID of the system instance.
arn (string) --
The ARN of the system instance.
status (string) --
The status of the system instance.
target (string) --
The target of the system instance.
greengrassGroupName (string) --
The ID of the Greengrass group where the system instance is deployed.
createdAt (datetime) --
The date when the system instance was created.
updatedAt (datetime) --
The date and time when the system instance was last updated.
greengrassGroupId (string) --
The ID of the Greengrass group where the system instance is deployed.
greengrassGroupVersionId (string) --
The version of the Greengrass group where the system instance is deployed.
Associates a device with a concrete thing that is in the user's registry.
A thing can be associated with only one device at a time. If you associate a thing with a new device id, its previous association will be removed.
See also: AWS API Documentation
Request Syntax
client.associate_entity_to_thing(
thingName='string',
entityId='string',
namespaceVersion=123
)
string
[REQUIRED]
The name of the thing to which the entity is to be associated.
string
[REQUIRED]
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
integer
The version of the user's namespace. Defaults to the latest version of the user's namespace.
dict
Response Syntax
{}
Response Structure
(dict) --
Searches for summary information about workflows.
See also: AWS API Documentation
Request Syntax
client.search_flow_templates(
filters=[
{
'name': 'DEVICE_MODEL_ID',
'value': [
'string',
]
},
],
nextToken='string',
maxResults=123
)
list
An array of objects that limit the result set. The only valid filter is DEVICE_MODEL_ID.
(dict) --
An object that filters a workflow search.
name (string) -- [REQUIRED]
The name of the search filter field.
value (list) -- [REQUIRED]
An array of string values for the search filter field. Multiple values function as AND criteria in the search.
(string) --
string
The string that specifies the next page of results. Use this when you're paginating results.
integer
The maximum number of results to return in the response.
dict
Response Syntax
{
'summaries': [
{
'id': 'string',
'arn': 'string',
'revisionNumber': 123,
'createdAt': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
summaries (list) --
An array of objects that contain summary information about each workflow in the result set.
(dict) --
An object that contains summary information about a workflow.
id (string) --
The ID of the workflow.
arn (string) --
The ARN of the workflow.
revisionNumber (integer) --
The revision number of the workflow.
createdAt (datetime) --
The date when the workflow was created.
nextToken (string) --
The string to specify as nextToken when you request the next page of results.
Deprecates the specified workflow. This action marks the workflow for deletion. Deprecated flows can't be deployed, but existing deployments will continue to run.
See also: AWS API Documentation
Request Syntax
client.deprecate_flow_template(
id='string'
)
string
[REQUIRED]
The ID of the workflow to be deleted.
The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME
dict
Response Syntax
{}
Response Structure
(dict) --
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.
See also: AWS API Documentation
Request Syntax
client.upload_entity_definitions(
document={
'language': 'GRAPHQL',
'text': 'string'
},
syncWithPublicNamespace=True|False,
deprecateExistingEntities=True|False
)
dict
The DefinitionDocument that defines the updated entities.
language (string) -- [REQUIRED]
The language used to define the entity. GRAPHQL is the only valid value.
text (string) -- [REQUIRED]
The GraphQL text that defines the entity.
boolean
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
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.
dict
Response Syntax
{
'uploadId': 'string'
}
Response Structure
(dict) --
uploadId (string) --
The ID that specifies the upload action. You can use this to track the status of the upload.
Gets the latest version of the DefinitionDocument and FlowTemplateSummary for the specified workflow.
See also: AWS API Documentation
Request Syntax
client.get_flow_template(
id='string',
revisionNumber=123
)
string
[REQUIRED]
The ID of the workflow.
The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME
integer
The number of the workflow revision to retrieve.
dict
Response Syntax
{
'description': {
'summary': {
'id': 'string',
'arn': 'string',
'revisionNumber': 123,
'createdAt': datetime(2015, 1, 1)
},
'definition': {
'language': 'GRAPHQL',
'text': 'string'
},
'validatedNamespaceVersion': 123
}
}
Response Structure
(dict) --
description (dict) --
The object that describes the specified workflow.
summary (dict) --
An object that contains summary information about a workflow.
id (string) --
The ID of the workflow.
arn (string) --
The ARN of the workflow.
revisionNumber (integer) --
The revision number of the workflow.
createdAt (datetime) --
The date when the workflow was created.
definition (dict) --
A workflow's definition document.
language (string) --
The language used to define the entity. GRAPHQL is the only valid value.
text (string) --
The GraphQL text that defines the entity.
validatedNamespaceVersion (integer) --
The version of the user's namespace against which the workflow was validated. Use this value in your system instance.
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.
See also: AWS API Documentation
Request Syntax
client.search_things(
entityId='string',
nextToken='string',
maxResults=123,
namespaceVersion=123
)
string
[REQUIRED]
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
The string that specifies the next page of results. Use this when you're paginating results.
integer
The maximum number of results to return in the response.
integer
The version of the user's namespace. Defaults to the latest version of the user's namespace.
dict
Response Syntax
{
'things': [
{
'thingArn': 'string',
'thingName': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
things (list) --
An array of things in the result set.
(dict) --
An AWS IoT thing.
thingArn (string) --
The ARN of the thing.
thingName (string) --
The name of the thing.
nextToken (string) --
The string to specify as nextToken when you request the next page of results.
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.
See also: AWS API Documentation
Request Syntax
client.deploy_system_instance(
id='string'
)
string
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
dict
Response Syntax
{
'summary': {
'id': 'string',
'arn': 'string',
'status': 'NOT_DEPLOYED'|'BOOTSTRAP'|'DEPLOY_IN_PROGRESS'|'DEPLOYED_IN_TARGET'|'UNDEPLOY_IN_PROGRESS'|'FAILED'|'PENDING_DELETE'|'DELETED_IN_TARGET',
'target': 'GREENGRASS'|'CLOUD',
'greengrassGroupName': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'greengrassGroupId': 'string',
'greengrassGroupVersionId': 'string'
},
'greengrassDeploymentId': 'string'
}
Response Structure
(dict) --
summary (dict) --
An object that contains summary information about a system instance that was deployed.
id (string) --
The ID of the system instance.
arn (string) --
The ARN of the system instance.
status (string) --
The status of the system instance.
target (string) --
The target of the system instance.
greengrassGroupName (string) --
The ID of the Greengrass group where the system instance is deployed.
createdAt (datetime) --
The date when the system instance was created.
updatedAt (datetime) --
The date and time when the system instance was last updated.
greengrassGroupId (string) --
The ID of the Greengrass group where the system instance is deployed.
greengrassGroupVersionId (string) --
The version of the Greengrass group where the system instance is deployed.
greengrassDeploymentId (string) --
The ID of the Greengrass deployment used to deploy the system instance.
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.
See also: AWS API Documentation
Request Syntax
client.delete_namespace()
dict
Response Syntax
{
'namespaceArn': 'string',
'namespaceName': 'string'
}
Response Structure
(dict) --
namespaceArn (string) --
The ARN of the namespace to be deleted.
namespaceName (string) --
The name of the namespace to be deleted.
Creates a system. The system is validated against the entities in the latest version of the user's namespace unless another namespace version is specified in the request.
See also: AWS API Documentation
Request Syntax
client.create_system_template(
definition={
'language': 'GRAPHQL',
'text': 'string'
},
compatibleNamespaceVersion=123
)
dict
[REQUIRED]
The DefinitionDocument used to create the system.
language (string) -- [REQUIRED]
The language used to define the entity. GRAPHQL is the only valid value.
text (string) -- [REQUIRED]
The GraphQL text that defines the entity.
integer
The namespace version in which the system is to be created.
If no value is specified, the latest version is used by default.
dict
Response Syntax
{
'summary': {
'id': 'string',
'arn': 'string',
'revisionNumber': 123,
'createdAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
summary (dict) --
The summary object that describes the created system.
id (string) --
The ID of the system.
arn (string) --
The ARN of the system.
revisionNumber (integer) --
The revision number of the system.
createdAt (datetime) --
The date when the system was created.
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.
See also: AWS API Documentation
Request Syntax
client.delete_system_instance(
id='string'
)
string
The ID of the system instance to be deleted.
dict
Response Syntax
{}
Response Structure
(dict) --
Gets the status of the specified upload.
See also: AWS API Documentation
Request Syntax
client.get_upload_status(
uploadId='string'
)
string
[REQUIRED]
The ID of the upload. This value is returned by the UploadEntityDefinitions action.
dict
Response Syntax
{
'uploadId': 'string',
'uploadStatus': 'IN_PROGRESS'|'SUCCEEDED'|'FAILED',
'namespaceArn': 'string',
'namespaceName': 'string',
'namespaceVersion': 123,
'failureReason': [
'string',
],
'createdDate': datetime(2015, 1, 1)
}
Response Structure
(dict) --
uploadId (string) --
The ID of the upload.
uploadStatus (string) --
The status of the upload. The initial status is IN_PROGRESS. The response show all validation failures if the upload fails.
namespaceArn (string) --
The ARN of the upload.
namespaceName (string) --
The name of the upload's namespace.
namespaceVersion (integer) --
The version of the user's namespace. Defaults to the latest version of the user's namespace.
failureReason (list) --
The reason for an upload failure.
(string) --
createdDate (datetime) --
The date at which the upload was created.
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.
See also: AWS API Documentation
Request Syntax
client.create_system_instance(
tags=[
{
'key': 'string',
'value': 'string'
},
],
definition={
'language': 'GRAPHQL',
'text': 'string'
},
target='GREENGRASS'|'CLOUD',
greengrassGroupName='string',
s3BucketName='string',
metricsConfiguration={
'cloudMetricEnabled': True|False,
'metricRuleRoleArn': 'string'
},
flowActionsRoleArn='string'
)
list
Metadata, consisting of key-value pairs, that can be used to categorize your system instances.
(dict) --
Metadata assigned to an AWS IoT Things Graph resource consisting of a key-value pair.
key (string) -- [REQUIRED]
The required name of the tag. The string value can be from 1 to 128 Unicode characters in length.
value (string) -- [REQUIRED]
The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length.
dict
[REQUIRED]
A document that defines an entity.
language (string) -- [REQUIRED]
The language used to define the entity. GRAPHQL is the only valid value.
text (string) -- [REQUIRED]
The GraphQL text that defines the entity.
string
[REQUIRED]
The target type of the deployment. Valid values are GREENGRASS and CLOUD.
string
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
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.
dict
An object that specifies whether cloud metrics are collected in a deployment and, if so, what role is used to collect metrics.
cloudMetricEnabled (boolean) --
A Boolean that specifies whether cloud metrics are collected.
metricRuleRoleArn (string) --
The ARN of the role that is used to collect cloud metrics.
string
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.
dict
Response Syntax
{
'summary': {
'id': 'string',
'arn': 'string',
'status': 'NOT_DEPLOYED'|'BOOTSTRAP'|'DEPLOY_IN_PROGRESS'|'DEPLOYED_IN_TARGET'|'UNDEPLOY_IN_PROGRESS'|'FAILED'|'PENDING_DELETE'|'DELETED_IN_TARGET',
'target': 'GREENGRASS'|'CLOUD',
'greengrassGroupName': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'greengrassGroupId': 'string',
'greengrassGroupVersionId': 'string'
}
}
Response Structure
(dict) --
summary (dict) --
The summary object that describes the new system instance.
id (string) --
The ID of the system instance.
arn (string) --
The ARN of the system instance.
status (string) --
The status of the system instance.
target (string) --
The target of the system instance.
greengrassGroupName (string) --
The ID of the Greengrass group where the system instance is deployed.
createdAt (datetime) --
The date when the system instance was created.
updatedAt (datetime) --
The date and time when the system instance was last updated.
greengrassGroupId (string) --
The ID of the Greengrass group where the system instance is deployed.
greengrassGroupVersionId (string) --
The version of the Greengrass group where the system instance is deployed.
Creates a tag for the specified resource.
See also: AWS API Documentation
Request Syntax
client.tag_resource(
resourceArn='string',
tags=[
{
'key': 'string',
'value': 'string'
},
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the resource whose tags are returned.
list
[REQUIRED]
A list of tags to add to the resource.>
(dict) --
Metadata assigned to an AWS IoT Things Graph resource consisting of a key-value pair.
key (string) -- [REQUIRED]
The required name of the tag. The string value can be from 1 to 128 Unicode characters in length.
value (string) -- [REQUIRED]
The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length.
dict
Response Syntax
{}
Response Structure
(dict) --
Gets a system instance.
See also: AWS API Documentation
Request Syntax
client.get_system_instance(
id='string'
)
string
[REQUIRED]
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
dict
Response Syntax
{
'description': {
'summary': {
'id': 'string',
'arn': 'string',
'status': 'NOT_DEPLOYED'|'BOOTSTRAP'|'DEPLOY_IN_PROGRESS'|'DEPLOYED_IN_TARGET'|'UNDEPLOY_IN_PROGRESS'|'FAILED'|'PENDING_DELETE'|'DELETED_IN_TARGET',
'target': 'GREENGRASS'|'CLOUD',
'greengrassGroupName': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'greengrassGroupId': 'string',
'greengrassGroupVersionId': 'string'
},
'definition': {
'language': 'GRAPHQL',
'text': 'string'
},
's3BucketName': 'string',
'metricsConfiguration': {
'cloudMetricEnabled': True|False,
'metricRuleRoleArn': 'string'
},
'validatedNamespaceVersion': 123,
'validatedDependencyRevisions': [
{
'id': 'string',
'revisionNumber': 123
},
],
'flowActionsRoleArn': 'string'
}
}
Response Structure
(dict) --
description (dict) --
An object that describes the system instance.
summary (dict) --
An object that contains summary information about a system instance.
id (string) --
The ID of the system instance.
arn (string) --
The ARN of the system instance.
status (string) --
The status of the system instance.
target (string) --
The target of the system instance.
greengrassGroupName (string) --
The ID of the Greengrass group where the system instance is deployed.
createdAt (datetime) --
The date when the system instance was created.
updatedAt (datetime) --
The date and time when the system instance was last updated.
greengrassGroupId (string) --
The ID of the Greengrass group where the system instance is deployed.
greengrassGroupVersionId (string) --
The version of the Greengrass group where the system instance is deployed.
definition (dict) --
A document that defines an entity.
language (string) --
The language used to define the entity. GRAPHQL is the only valid value.
text (string) --
The GraphQL text that defines the entity.
s3BucketName (string) --
The Amazon Simple Storage Service bucket where information about a system instance is stored.
metricsConfiguration (dict) --
An object that specifies whether cloud metrics are collected in a deployment and, if so, what role is used to collect metrics.
cloudMetricEnabled (boolean) --
A Boolean that specifies whether cloud metrics are collected.
metricRuleRoleArn (string) --
The ARN of the role that is used to collect cloud metrics.
validatedNamespaceVersion (integer) --
The version of the user's namespace against which the system instance was validated.
validatedDependencyRevisions (list) --
A list of objects that contain all of the IDs and revision numbers of workflows and systems that are used in a system instance.
(dict) --
An object that contains the ID and revision number of a workflow or system that is part of a deployment.
id (string) --
The ID of the workflow or system.
revisionNumber (integer) --
The revision number of the workflow or system.
flowActionsRoleArn (string) --
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.
Gets revisions made to the specified system template. Only the previous 100 revisions are stored. If the system has been deprecated, this action will return the revisions that occurred before its deprecation. This action won't work with systems that have been deleted.
See also: AWS API Documentation
Request Syntax
client.get_system_template_revisions(
id='string',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
The ID of the system template.
The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME
string
The string that specifies the next page of results. Use this when you're paginating results.
integer
The maximum number of results to return in the response.
dict
Response Syntax
{
'summaries': [
{
'id': 'string',
'arn': 'string',
'revisionNumber': 123,
'createdAt': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
summaries (list) --
An array of objects that contain summary data about the system template revisions.
(dict) --
An object that contains information about a system.
id (string) --
The ID of the system.
arn (string) --
The ARN of the system.
revisionNumber (integer) --
The revision number of the system.
createdAt (datetime) --
The date when the system was created.
nextToken (string) --
The string to specify as nextToken when you request the next page of results.
Searches for system instances in the user's account.
See also: AWS API Documentation
Request Syntax
client.search_system_instances(
filters=[
{
'name': 'SYSTEM_TEMPLATE_ID'|'STATUS'|'GREENGRASS_GROUP_NAME',
'value': [
'string',
]
},
],
nextToken='string',
maxResults=123
)
list
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.
(dict) --
An object that filters a system instance search. Multiple filters function as OR criteria in the search. For example a search that includes a GREENGRASS_GROUP_NAME and a STATUS filter searches for system instances in the specified Greengrass group that have the specified status.
name (string) --
The name of the search filter field.
value (list) --
An array of string values for the search filter field. Multiple values function as AND criteria in the search.
(string) --
string
The string that specifies the next page of results. Use this when you're paginating results.
integer
The maximum number of results to return in the response.
dict
Response Syntax
{
'summaries': [
{
'id': 'string',
'arn': 'string',
'status': 'NOT_DEPLOYED'|'BOOTSTRAP'|'DEPLOY_IN_PROGRESS'|'DEPLOYED_IN_TARGET'|'UNDEPLOY_IN_PROGRESS'|'FAILED'|'PENDING_DELETE'|'DELETED_IN_TARGET',
'target': 'GREENGRASS'|'CLOUD',
'greengrassGroupName': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'greengrassGroupId': 'string',
'greengrassGroupVersionId': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
summaries (list) --
An array of objects that contain summary data abour the system instances in the result set.
(dict) --
An object that contains summary information about a system instance.
id (string) --
The ID of the system instance.
arn (string) --
The ARN of the system instance.
status (string) --
The status of the system instance.
target (string) --
The target of the system instance.
greengrassGroupName (string) --
The ID of the Greengrass group where the system instance is deployed.
createdAt (datetime) --
The date when the system instance was created.
updatedAt (datetime) --
The date and time when the system instance was last updated.
greengrassGroupId (string) --
The ID of the Greengrass group where the system instance is deployed.
greengrassGroupVersionId (string) --
The version of the Greengrass group where the system instance is deployed.
nextToken (string) --
The string to specify as nextToken when you request the next page of results.
Updates the specified system. You don't need to run this action after updating a workflow. Any deployment that uses the system will see the changes in the system when it is redeployed.
See also: AWS API Documentation
Request Syntax
client.update_system_template(
id='string',
definition={
'language': 'GRAPHQL',
'text': 'string'
},
compatibleNamespaceVersion=123
)
string
[REQUIRED]
The ID of the system to be updated.
The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME
dict
[REQUIRED]
The DefinitionDocument that contains the updated system definition.
language (string) -- [REQUIRED]
The language used to define the entity. GRAPHQL is the only valid value.
text (string) -- [REQUIRED]
The GraphQL text that defines the entity.
integer
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.
dict
Response Syntax
{
'summary': {
'id': 'string',
'arn': 'string',
'revisionNumber': 123,
'createdAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
summary (dict) --
An object containing summary information about the updated system.
id (string) --
The ID of the system.
arn (string) --
The ARN of the system.
revisionNumber (integer) --
The revision number of the system.
createdAt (datetime) --
The date when the system was created.
Lists all tags on an AWS IoT Things Graph resource.
See also: AWS API Documentation
Request Syntax
client.list_tags_for_resource(
maxResults=123,
resourceArn='string',
nextToken='string'
)
integer
The maximum number of tags to return.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the resource whose tags are to be returned.
string
The token that specifies the next page of results to return.
dict
Response Syntax
{
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
tags (list) --
List of tags returned by the ListTagsForResource operation.
(dict) --
Metadata assigned to an AWS IoT Things Graph resource consisting of a key-value pair.
key (string) --
The required name of the tag. The string value can be from 1 to 128 Unicode characters in length.
value (string) --
The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length.
nextToken (string) --
The token that specifies the next page of results to return.
Searches for AWS IoT Things Graph workflow execution instances.
See also: AWS API Documentation
Request Syntax
client.search_flow_executions(
systemInstanceId='string',
flowExecutionId='string',
startTime=datetime(2015, 1, 1),
endTime=datetime(2015, 1, 1),
nextToken='string',
maxResults=123
)
string
[REQUIRED]
The ID of the system instance that contains the flow.
string
The ID of a flow execution.
datetime
The date and time of the earliest flow execution to return.
datetime
The date and time of the latest flow execution to return.
string
The string that specifies the next page of results. Use this when you're paginating results.
integer
The maximum number of results to return in the response.
dict
Response Syntax
{
'summaries': [
{
'flowExecutionId': 'string',
'status': 'RUNNING'|'ABORTED'|'SUCCEEDED'|'FAILED',
'systemInstanceId': 'string',
'flowTemplateId': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
summaries (list) --
An array of objects that contain summary information about each workflow execution in the result set.
(dict) --
An object that contains summary information about a flow execution.
flowExecutionId (string) --
The ID of the flow execution.
status (string) --
The current status of the flow execution.
systemInstanceId (string) --
The ID of the system instance that contains the flow.
flowTemplateId (string) --
The ID of the flow.
createdAt (datetime) --
The date and time when the flow execution summary was created.
updatedAt (datetime) --
The date and time when the flow execution summary was last updated.
nextToken (string) --
The string to specify as nextToken when you request the next page of results.
Deprecates the specified system.
See also: AWS API Documentation
Request Syntax
client.deprecate_system_template(
id='string'
)
string
[REQUIRED]
The ID of the system to delete.
The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME
dict
Response Syntax
{}
Response Structure
(dict) --
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.
See also: AWS API Documentation
Request Syntax
client.get_flow_template_revisions(
id='string',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
The ID of the workflow.
The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME
string
The string that specifies the next page of results. Use this when you're paginating results.
integer
The maximum number of results to return in the response.
dict
Response Syntax
{
'summaries': [
{
'id': 'string',
'arn': 'string',
'revisionNumber': 123,
'createdAt': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
summaries (list) --
An array of objects that provide summary data about each revision.
(dict) --
An object that contains summary information about a workflow.
id (string) --
The ID of the workflow.
arn (string) --
The ARN of the workflow.
revisionNumber (integer) --
The revision number of the workflow.
createdAt (datetime) --
The date when the workflow was created.
nextToken (string) --
The string to specify as nextToken when you request the next page of results.
Searches for summary information about systems in the user's account. You can filter by the ID of a workflow to return only systems that use the specified workflow.
See also: AWS API Documentation
Request Syntax
client.search_system_templates(
filters=[
{
'name': 'FLOW_TEMPLATE_ID',
'value': [
'string',
]
},
],
nextToken='string',
maxResults=123
)
list
An array of filters that limit the result set. The only valid filter is FLOW_TEMPLATE_ID.
(dict) --
An object that filters a system search.
name (string) -- [REQUIRED]
The name of the system search filter field.
value (list) -- [REQUIRED]
An array of string values for the search filter field. Multiple values function as AND criteria in the search.
(string) --
string
The string that specifies the next page of results. Use this when you're paginating results.
integer
The maximum number of results to return in the response.
dict
Response Syntax
{
'summaries': [
{
'id': 'string',
'arn': 'string',
'revisionNumber': 123,
'createdAt': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
summaries (list) --
An array of objects that contain summary information about each system deployment in the result set.
(dict) --
An object that contains information about a system.
id (string) --
The ID of the system.
arn (string) --
The ARN of the system.
revisionNumber (integer) --
The revision number of the system.
createdAt (datetime) --
The date when the system was created.
nextToken (string) --
The string to specify as nextToken when you request the next page of results.
Returns a list of objects that contain information about events in a flow execution.
See also: AWS API Documentation
Request Syntax
client.list_flow_execution_messages(
flowExecutionId='string',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
The ID of the flow execution.
string
The string that specifies the next page of results. Use this when you're paginating results.
integer
The maximum number of results to return in the response.
dict
Response Syntax
{
'messages': [
{
'messageId': 'string',
'eventType': 'EXECUTION_STARTED'|'EXECUTION_FAILED'|'EXECUTION_ABORTED'|'EXECUTION_SUCCEEDED'|'STEP_STARTED'|'STEP_FAILED'|'STEP_SUCCEEDED'|'ACTIVITY_SCHEDULED'|'ACTIVITY_STARTED'|'ACTIVITY_FAILED'|'ACTIVITY_SUCCEEDED'|'START_FLOW_EXECUTION_TASK'|'SCHEDULE_NEXT_READY_STEPS_TASK'|'THING_ACTION_TASK'|'THING_ACTION_TASK_FAILED'|'THING_ACTION_TASK_SUCCEEDED'|'ACKNOWLEDGE_TASK_MESSAGE',
'timestamp': datetime(2015, 1, 1),
'payload': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
messages (list) --
A list of objects that contain information about events in the specified flow execution.
(dict) --
An object that contains information about a flow event.
messageId (string) --
The unique identifier of the message.
eventType (string) --
The type of flow event .
timestamp (datetime) --
The date and time when the message was last updated.
payload (string) --
A string containing information about the flow event.
nextToken (string) --
The string to specify as nextToken when you request the next page of results.
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.
See also: AWS API Documentation
Request Syntax
client.update_flow_template(
id='string',
definition={
'language': 'GRAPHQL',
'text': 'string'
},
compatibleNamespaceVersion=123
)
string
[REQUIRED]
The ID of the workflow to be updated.
The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME
dict
[REQUIRED]
The DefinitionDocument that contains the updated workflow definition.
language (string) -- [REQUIRED]
The language used to define the entity. GRAPHQL is the only valid value.
text (string) -- [REQUIRED]
The GraphQL text that defines the entity.
integer
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.
dict
Response Syntax
{
'summary': {
'id': 'string',
'arn': 'string',
'revisionNumber': 123,
'createdAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
summary (dict) --
An object containing summary information about the updated workflow.
id (string) --
The ID of the workflow.
arn (string) --
The ARN of the workflow.
revisionNumber (integer) --
The revision number of the workflow.
createdAt (datetime) --
The date when the workflow was created.
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.
See also: AWS API Documentation
Request Syntax
client.delete_system_template(
id='string'
)
string
[REQUIRED]
The ID of the system to be deleted.
The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME
dict
Response Syntax
{}
Response Structure
(dict) --
Removes a tag from the specified resource.
See also: AWS API Documentation
Request Syntax
client.untag_resource(
resourceArn='string',
tagKeys=[
'string',
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the resource whose tags are to be removed.
list
[REQUIRED]
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) --
dict
Response Syntax
{}
Response Structure
(dict) --
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.
See also: AWS API Documentation
Request Syntax
client.dissociate_entity_from_thing(
thingName='string',
entityType='DEVICE'|'SERVICE'|'DEVICE_MODEL'|'CAPABILITY'|'STATE'|'ACTION'|'EVENT'|'PROPERTY'|'MAPPING'|'ENUM'
)
string
[REQUIRED]
The name of the thing to disassociate.
string
[REQUIRED]
The entity type from which to disassociate the thing.
dict
Response Syntax
{}
Response Structure
(dict) --
Searches for entities of the specified type. You can search for entities in your namespace and the public namespace that you're tracking.
See also: AWS API Documentation
Request Syntax
client.search_entities(
entityTypes=[
'DEVICE'|'SERVICE'|'DEVICE_MODEL'|'CAPABILITY'|'STATE'|'ACTION'|'EVENT'|'PROPERTY'|'MAPPING'|'ENUM',
],
filters=[
{
'name': 'NAME'|'NAMESPACE'|'SEMANTIC_TYPE_PATH'|'REFERENCED_ENTITY_ID',
'value': [
'string',
]
},
],
nextToken='string',
maxResults=123,
namespaceVersion=123
)
list
[REQUIRED]
The entity types for which to search.
(string) --
list
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.
(dict) --
An object that filters an entity search. Multiple filters function as OR criteria in the search. For example a search that includes a NAMESPACE and a REFERENCED_ENTITY_ID filter searches for entities in the specified namespace that use the entity specified by the value of REFERENCED_ENTITY_ID.
name (string) --
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.
value (list) --
An array of string values for the search filter field. Multiple values function as AND criteria in the search.
(string) --
string
The string that specifies the next page of results. Use this when you're paginating results.
integer
The maximum number of results to return in the response.
integer
The version of the user's namespace. Defaults to the latest version of the user's namespace.
dict
Response Syntax
{
'descriptions': [
{
'id': 'string',
'arn': 'string',
'type': 'DEVICE'|'SERVICE'|'DEVICE_MODEL'|'CAPABILITY'|'STATE'|'ACTION'|'EVENT'|'PROPERTY'|'MAPPING'|'ENUM',
'createdAt': datetime(2015, 1, 1),
'definition': {
'language': 'GRAPHQL',
'text': 'string'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
descriptions (list) --
An array of descriptions for each entity returned in the search result.
(dict) --
Describes the properties of an entity.
id (string) --
The entity ID.
arn (string) --
The entity ARN.
type (string) --
The entity type.
createdAt (datetime) --
The time at which the entity was created.
definition (dict) --
The definition document of the entity.
language (string) --
The language used to define the entity. GRAPHQL is the only valid value.
text (string) --
The GraphQL text that defines the entity.
nextToken (string) --
The string to specify as nextToken when you request the next page of results.
Gets the status of a namespace deletion task.
See also: AWS API Documentation
Request Syntax
client.get_namespace_deletion_status()
dict
Response Syntax
{
'namespaceArn': 'string',
'namespaceName': 'string',
'status': 'IN_PROGRESS'|'SUCCEEDED'|'FAILED',
'errorCode': 'VALIDATION_FAILED',
'errorMessage': 'string'
}
Response Structure
(dict) --
namespaceArn (string) --
The ARN of the namespace that is being deleted.
namespaceName (string) --
The name of the namespace that is being deleted.
status (string) --
The status of the deletion request.
errorCode (string) --
An error code returned by the namespace deletion task.
errorMessage (string) --
An error code returned by the namespace deletion task.