AWS IoT Things Graph 2018-09-06
- Client: Aws\IoTThingsGraph\IoTThingsGraphClient
- Service ID: iotthingsgraph
- Version: 2018-09-06
This page describes the parameters and results for the operations of the AWS IoT Things Graph (2018-09-06), and shows how to use the Aws\IoTThingsGraph\IoTThingsGraphClient object to call the described operations. This documentation is specific to the 2018-09-06 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- AssociateEntityToThing ( array $params = [] )
Associates a device with a concrete thing that is in the user's registry.
- CreateFlowTemplate ( array $params = [] )
Creates a workflow template.
- CreateSystemInstance ( array $params = [] )
Creates a system instance.
- CreateSystemTemplate ( array $params = [] )
Creates a system.
- DeleteFlowTemplate ( array $params = [] )
Deletes a workflow.
- DeleteNamespace ( array $params = [] )
Deletes the specified namespace.
- DeleteSystemInstance ( array $params = [] )
Deletes a system instance.
- DeleteSystemTemplate ( array $params = [] )
Deletes a system.
- DeploySystemInstance ( array $params = [] )
Greengrass and Cloud Deployments Deploys the system instance to the target specified in CreateSystemInstance.
- DeprecateFlowTemplate ( array $params = [] )
Deprecates the specified workflow.
- DeprecateSystemTemplate ( array $params = [] )
Deprecates the specified system.
- DescribeNamespace ( array $params = [] )
Gets the latest version of the user's namespace and the public version that it is tracking.
- DissociateEntityFromThing ( array $params = [] )
Dissociates a device entity from a concrete thing.
- GetEntities ( array $params = [] )
Gets definitions of the specified entities.
- GetFlowTemplate ( array $params = [] )
Gets the latest version of the DefinitionDocument and FlowTemplateSummary for the specified workflow.
- GetFlowTemplateRevisions ( array $params = [] )
Gets revisions of the specified workflow.
- GetNamespaceDeletionStatus ( array $params = [] )
Gets the status of a namespace deletion task.
- GetSystemInstance ( array $params = [] )
Gets a system instance.
- GetSystemTemplate ( array $params = [] )
Gets a system.
- GetSystemTemplateRevisions ( array $params = [] )
Gets revisions made to the specified system template.
- GetUploadStatus ( array $params = [] )
Gets the status of the specified upload.
- ListFlowExecutionMessages ( array $params = [] )
Returns a list of objects that contain information about events in a flow execution.
- ListTagsForResource ( array $params = [] )
Lists all tags on an AWS IoT Things Graph resource.
- SearchEntities ( array $params = [] )
Searches for entities of the specified type.
- SearchFlowExecutions ( array $params = [] )
Searches for AWS IoT Things Graph workflow execution instances.
- SearchFlowTemplates ( array $params = [] )
Searches for summary information about workflows.
- SearchSystemInstances ( array $params = [] )
Searches for system instances in the user's account.
- SearchSystemTemplates ( array $params = [] )
Searches for summary information about systems in the user's account.
- SearchThings ( array $params = [] )
Searches for things associated with the specified entity.
- TagResource ( array $params = [] )
Creates a tag for the specified resource.
- UndeploySystemInstance ( array $params = [] )
Removes a system instance from its target (Cloud or Greengrass).
- UntagResource ( array $params = [] )
Removes a tag from the specified resource.
- UpdateFlowTemplate ( array $params = [] )
Updates the specified workflow.
- UpdateSystemTemplate ( array $params = [] )
Updates the specified system.
- UploadEntityDefinitions ( array $params = [] )
Asynchronously uploads one or more entity definitions to the user's namespace.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Operations
AssociateEntityToThing
$result = $client->associateEntityToThing([/* ... */]); $promise = $client->associateEntityToThingAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->associateEntityToThing([
'entityId' => '<string>', // REQUIRED
'namespaceVersion' => <integer>,
'thingName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- entityId
-
- Required: Yes
- Type: string
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 - namespaceVersion
-
- Type: long (int|float)
The version of the user's namespace. Defaults to the latest version of the user's namespace.
- thingName
-
- Required: Yes
- Type: string
The name of the thing to which the entity is to be associated.
Result Syntax
[]
Result Details
Errors
CreateFlowTemplate
$result = $client->createFlowTemplate([/* ... */]); $promise = $client->createFlowTemplateAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->createFlowTemplate([
'compatibleNamespaceVersion' => <integer>,
'definition' => [ // REQUIRED
'language' => 'GRAPHQL', // REQUIRED
'text' => '<string>', // REQUIRED
],
]);
Parameter Details
Members
- compatibleNamespaceVersion
-
- Type: long (int|float)
The namespace version in which the workflow is to be created.
If no value is specified, the latest version is used by default.
- definition
-
- Required: Yes
- Type: DefinitionDocument structure
The workflow
DefinitionDocument.
Result Syntax
[
'summary' => [
'arn' => '<string>',
'createdAt' => <DateTime>,
'id' => '<string>',
'revisionNumber' => <integer>,
],
]
Result Details
Members
- summary
-
- Type: FlowTemplateSummary structure
The summary object that describes the created workflow.
Errors
CreateSystemInstance
$result = $client->createSystemInstance([/* ... */]); $promise = $client->createSystemInstanceAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->createSystemInstance([
'definition' => [ // REQUIRED
'language' => 'GRAPHQL', // REQUIRED
'text' => '<string>', // REQUIRED
],
'flowActionsRoleArn' => '<string>',
'greengrassGroupName' => '<string>',
'metricsConfiguration' => [
'cloudMetricEnabled' => true || false,
'metricRuleRoleArn' => '<string>',
],
's3BucketName' => '<string>',
'tags' => [
[
'key' => '<string>', // REQUIRED
'value' => '<string>', // REQUIRED
],
// ...
],
'target' => 'GREENGRASS|CLOUD', // REQUIRED
]);
Parameter Details
Members
- definition
-
- Required: Yes
- Type: DefinitionDocument structure
A document that defines an entity.
- flowActionsRoleArn
-
- Type: 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
targetparameter isCLOUD. - greengrassGroupName
-
- Type: string
The name of the Greengrass group where the system instance will be deployed. This value is required if the value of the
targetparameter isGREENGRASS. - metricsConfiguration
-
- Type: MetricsConfiguration structure
An object that specifies whether cloud metrics are collected in a deployment and, if so, what role is used to collect metrics.
- s3BucketName
-
- Type: 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
targetparameter isGREENGRASS. - tags
-
- Type: Array of Tag structures
Metadata, consisting of key-value pairs, that can be used to categorize your system instances.
- target
-
- Required: Yes
- Type: string
The target type of the deployment. Valid values are
GREENGRASSandCLOUD.
Result Syntax
[
'summary' => [
'arn' => '<string>',
'createdAt' => <DateTime>,
'greengrassGroupId' => '<string>',
'greengrassGroupName' => '<string>',
'greengrassGroupVersionId' => '<string>',
'id' => '<string>',
'status' => 'NOT_DEPLOYED|BOOTSTRAP|DEPLOY_IN_PROGRESS|DEPLOYED_IN_TARGET|UNDEPLOY_IN_PROGRESS|FAILED|PENDING_DELETE|DELETED_IN_TARGET',
'target' => 'GREENGRASS|CLOUD',
'updatedAt' => <DateTime>,
],
]
Result Details
Members
- summary
-
- Type: SystemInstanceSummary structure
The summary object that describes the new system instance.
Errors
CreateSystemTemplate
$result = $client->createSystemTemplate([/* ... */]); $promise = $client->createSystemTemplateAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->createSystemTemplate([
'compatibleNamespaceVersion' => <integer>,
'definition' => [ // REQUIRED
'language' => 'GRAPHQL', // REQUIRED
'text' => '<string>', // REQUIRED
],
]);
Parameter Details
Members
- compatibleNamespaceVersion
-
- Type: long (int|float)
The namespace version in which the system is to be created.
If no value is specified, the latest version is used by default.
- definition
-
- Required: Yes
- Type: DefinitionDocument structure
The
DefinitionDocumentused to create the system.
Result Syntax
[
'summary' => [
'arn' => '<string>',
'createdAt' => <DateTime>,
'id' => '<string>',
'revisionNumber' => <integer>,
],
]
Result Details
Members
- summary
-
- Type: SystemTemplateSummary structure
The summary object that describes the created system.
Errors
DeleteFlowTemplate
$result = $client->deleteFlowTemplate([/* ... */]); $promise = $client->deleteFlowTemplateAsync([/* ... */]);
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).
Parameter Syntax
$result = $client->deleteFlowTemplate([
'id' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
DeleteNamespace
$result = $client->deleteNamespace([/* ... */]); $promise = $client->deleteNamespaceAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->deleteNamespace([ ]);
Parameter Details
Members
Result Syntax
[
'namespaceArn' => '<string>',
'namespaceName' => '<string>',
]
Result Details
Members
Errors
DeleteSystemInstance
$result = $client->deleteSystemInstance([/* ... */]); $promise = $client->deleteSystemInstanceAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->deleteSystemInstance([
'id' => '<string>',
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
DeleteSystemTemplate
$result = $client->deleteSystemTemplate([/* ... */]); $promise = $client->deleteSystemTemplateAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->deleteSystemTemplate([
'id' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
DeploySystemInstance
$result = $client->deploySystemInstance([/* ... */]); $promise = $client->deploySystemInstanceAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->deploySystemInstance([
'id' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'greengrassDeploymentId' => '<string>',
'summary' => [
'arn' => '<string>',
'createdAt' => <DateTime>,
'greengrassGroupId' => '<string>',
'greengrassGroupName' => '<string>',
'greengrassGroupVersionId' => '<string>',
'id' => '<string>',
'status' => 'NOT_DEPLOYED|BOOTSTRAP|DEPLOY_IN_PROGRESS|DEPLOYED_IN_TARGET|UNDEPLOY_IN_PROGRESS|FAILED|PENDING_DELETE|DELETED_IN_TARGET',
'target' => 'GREENGRASS|CLOUD',
'updatedAt' => <DateTime>,
],
]
Result Details
Members
- greengrassDeploymentId
-
- Type: string
The ID of the Greengrass deployment used to deploy the system instance.
- summary
-
- Required: Yes
- Type: SystemInstanceSummary structure
An object that contains summary information about a system instance that was deployed.
Errors
DeprecateFlowTemplate
$result = $client->deprecateFlowTemplate([/* ... */]); $promise = $client->deprecateFlowTemplateAsync([/* ... */]);
Deprecates the specified workflow. This action marks the workflow for deletion. Deprecated flows can't be deployed, but existing deployments will continue to run.
Parameter Syntax
$result = $client->deprecateFlowTemplate([
'id' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
DeprecateSystemTemplate
$result = $client->deprecateSystemTemplate([/* ... */]); $promise = $client->deprecateSystemTemplateAsync([/* ... */]);
Deprecates the specified system.
Parameter Syntax
$result = $client->deprecateSystemTemplate([
'id' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
DescribeNamespace
$result = $client->describeNamespace([/* ... */]); $promise = $client->describeNamespaceAsync([/* ... */]);
Gets the latest version of the user's namespace and the public version that it is tracking.
Parameter Syntax
$result = $client->describeNamespace([
'namespaceName' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'namespaceArn' => '<string>',
'namespaceName' => '<string>',
'namespaceVersion' => <integer>,
'trackingNamespaceName' => '<string>',
'trackingNamespaceVersion' => <integer>,
]
Result Details
Members
- namespaceArn
-
- Type: string
The ARN of the namespace.
- namespaceName
-
- Type: string
The name of the namespace.
- namespaceVersion
-
- Type: long (int|float)
The version of the user's namespace to describe.
- trackingNamespaceName
-
- Type: string
The name of the public namespace that the latest namespace version is tracking.
- trackingNamespaceVersion
-
- Type: long (int|float)
The version of the public namespace that the latest version is tracking.
Errors
DissociateEntityFromThing
$result = $client->dissociateEntityFromThing([/* ... */]); $promise = $client->dissociateEntityFromThingAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->dissociateEntityFromThing([
'entityType' => 'DEVICE|SERVICE|DEVICE_MODEL|CAPABILITY|STATE|ACTION|EVENT|PROPERTY|MAPPING|ENUM', // REQUIRED
'thingName' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
GetEntities
$result = $client->getEntities([/* ... */]); $promise = $client->getEntitiesAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->getEntities([
'ids' => ['<string>', ...], // REQUIRED
'namespaceVersion' => <integer>,
]);
Parameter Details
Members
Result Syntax
[
'descriptions' => [
[
'arn' => '<string>',
'createdAt' => <DateTime>,
'definition' => [
'language' => 'GRAPHQL',
'text' => '<string>',
],
'id' => '<string>',
'type' => 'DEVICE|SERVICE|DEVICE_MODEL|CAPABILITY|STATE|ACTION|EVENT|PROPERTY|MAPPING|ENUM',
],
// ...
],
]
Result Details
Members
- descriptions
-
- Type: Array of EntityDescription structures
An array of descriptions for the specified entities.
Errors
GetFlowTemplate
$result = $client->getFlowTemplate([/* ... */]); $promise = $client->getFlowTemplateAsync([/* ... */]);
Gets the latest version of the DefinitionDocument and FlowTemplateSummary for the specified workflow.
Parameter Syntax
$result = $client->getFlowTemplate([
'id' => '<string>', // REQUIRED
'revisionNumber' => <integer>,
]);
Parameter Details
Members
Result Syntax
[
'description' => [
'definition' => [
'language' => 'GRAPHQL',
'text' => '<string>',
],
'summary' => [
'arn' => '<string>',
'createdAt' => <DateTime>,
'id' => '<string>',
'revisionNumber' => <integer>,
],
'validatedNamespaceVersion' => <integer>,
],
]
Result Details
Members
- description
-
- Type: FlowTemplateDescription structure
The object that describes the specified workflow.
Errors
GetFlowTemplateRevisions
$result = $client->getFlowTemplateRevisions([/* ... */]); $promise = $client->getFlowTemplateRevisionsAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->getFlowTemplateRevisions([
'id' => '<string>', // REQUIRED
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
- id
-
- Required: Yes
- Type: string
The ID of the workflow.
The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME - maxResults
-
- Type: int
The maximum number of results to return in the response.
- nextToken
-
- Type: string
The string that specifies the next page of results. Use this when you're paginating results.
Result Syntax
[
'nextToken' => '<string>',
'summaries' => [
[
'arn' => '<string>',
'createdAt' => <DateTime>,
'id' => '<string>',
'revisionNumber' => <integer>,
],
// ...
],
]
Result Details
Members
- nextToken
-
- Type: string
The string to specify as
nextTokenwhen you request the next page of results. - summaries
-
- Type: Array of FlowTemplateSummary structures
An array of objects that provide summary data about each revision.
Errors
GetNamespaceDeletionStatus
$result = $client->getNamespaceDeletionStatus([/* ... */]); $promise = $client->getNamespaceDeletionStatusAsync([/* ... */]);
Gets the status of a namespace deletion task.
Parameter Syntax
$result = $client->getNamespaceDeletionStatus([ ]);
Parameter Details
Members
Result Syntax
[
'errorCode' => 'VALIDATION_FAILED',
'errorMessage' => '<string>',
'namespaceArn' => '<string>',
'namespaceName' => '<string>',
'status' => 'IN_PROGRESS|SUCCEEDED|FAILED',
]
Result Details
Members
- errorCode
-
- Type: string
An error code returned by the namespace deletion task.
- errorMessage
-
- Type: string
An error code returned by the namespace deletion task.
- namespaceArn
-
- Type: string
The ARN of the namespace that is being deleted.
- namespaceName
-
- Type: string
The name of the namespace that is being deleted.
- status
-
- Type: string
The status of the deletion request.
Errors
GetSystemInstance
$result = $client->getSystemInstance([/* ... */]); $promise = $client->getSystemInstanceAsync([/* ... */]);
Gets a system instance.
Parameter Syntax
$result = $client->getSystemInstance([
'id' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'description' => [
'definition' => [
'language' => 'GRAPHQL',
'text' => '<string>',
],
'flowActionsRoleArn' => '<string>',
'metricsConfiguration' => [
'cloudMetricEnabled' => true || false,
'metricRuleRoleArn' => '<string>',
],
's3BucketName' => '<string>',
'summary' => [
'arn' => '<string>',
'createdAt' => <DateTime>,
'greengrassGroupId' => '<string>',
'greengrassGroupName' => '<string>',
'greengrassGroupVersionId' => '<string>',
'id' => '<string>',
'status' => 'NOT_DEPLOYED|BOOTSTRAP|DEPLOY_IN_PROGRESS|DEPLOYED_IN_TARGET|UNDEPLOY_IN_PROGRESS|FAILED|PENDING_DELETE|DELETED_IN_TARGET',
'target' => 'GREENGRASS|CLOUD',
'updatedAt' => <DateTime>,
],
'validatedDependencyRevisions' => [
[
'id' => '<string>',
'revisionNumber' => <integer>,
],
// ...
],
'validatedNamespaceVersion' => <integer>,
],
]
Result Details
Members
- description
-
- Type: SystemInstanceDescription structure
An object that describes the system instance.
Errors
GetSystemTemplate
$result = $client->getSystemTemplate([/* ... */]); $promise = $client->getSystemTemplateAsync([/* ... */]);
Gets a system.
Parameter Syntax
$result = $client->getSystemTemplate([
'id' => '<string>', // REQUIRED
'revisionNumber' => <integer>,
]);
Parameter Details
Members
Result Syntax
[
'description' => [
'definition' => [
'language' => 'GRAPHQL',
'text' => '<string>',
],
'summary' => [
'arn' => '<string>',
'createdAt' => <DateTime>,
'id' => '<string>',
'revisionNumber' => <integer>,
],
'validatedNamespaceVersion' => <integer>,
],
]
Result Details
Members
- description
-
- Type: SystemTemplateDescription structure
An object that contains summary data about the system.
Errors
GetSystemTemplateRevisions
$result = $client->getSystemTemplateRevisions([/* ... */]); $promise = $client->getSystemTemplateRevisionsAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->getSystemTemplateRevisions([
'id' => '<string>', // REQUIRED
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
- id
-
- Required: Yes
- Type: string
The ID of the system template.
The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME - maxResults
-
- Type: int
The maximum number of results to return in the response.
- nextToken
-
- Type: string
The string that specifies the next page of results. Use this when you're paginating results.
Result Syntax
[
'nextToken' => '<string>',
'summaries' => [
[
'arn' => '<string>',
'createdAt' => <DateTime>,
'id' => '<string>',
'revisionNumber' => <integer>,
],
// ...
],
]
Result Details
Members
- nextToken
-
- Type: string
The string to specify as
nextTokenwhen you request the next page of results. - summaries
-
- Type: Array of SystemTemplateSummary structures
An array of objects that contain summary data about the system template revisions.
Errors
GetUploadStatus
$result = $client->getUploadStatus([/* ... */]); $promise = $client->getUploadStatusAsync([/* ... */]);
Gets the status of the specified upload.
Parameter Syntax
$result = $client->getUploadStatus([
'uploadId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'createdDate' => <DateTime>,
'failureReason' => ['<string>', ...],
'namespaceArn' => '<string>',
'namespaceName' => '<string>',
'namespaceVersion' => <integer>,
'uploadId' => '<string>',
'uploadStatus' => 'IN_PROGRESS|SUCCEEDED|FAILED',
]
Result Details
Members
- createdDate
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date at which the upload was created.
- failureReason
-
- Type: Array of strings
The reason for an upload failure.
- namespaceArn
-
- Type: string
The ARN of the upload.
- namespaceName
-
- Type: string
The name of the upload's namespace.
- namespaceVersion
-
- Type: long (int|float)
The version of the user's namespace. Defaults to the latest version of the user's namespace.
- uploadId
-
- Required: Yes
- Type: string
The ID of the upload.
- uploadStatus
-
- Required: Yes
- Type: string
The status of the upload. The initial status is
IN_PROGRESS. The response show all validation failures if the upload fails.
Errors
ListFlowExecutionMessages
$result = $client->listFlowExecutionMessages([/* ... */]); $promise = $client->listFlowExecutionMessagesAsync([/* ... */]);
Returns a list of objects that contain information about events in a flow execution.
Parameter Syntax
$result = $client->listFlowExecutionMessages([
'flowExecutionId' => '<string>', // REQUIRED
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'messages' => [
[
'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',
'messageId' => '<string>',
'payload' => '<string>',
'timestamp' => <DateTime>,
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- messages
-
- Type: Array of FlowExecutionMessage structures
A list of objects that contain information about events in the specified flow execution.
- nextToken
-
- Type: string
The string to specify as
nextTokenwhen you request the next page of results.
Errors
ListTagsForResource
$result = $client->listTagsForResource([/* ... */]); $promise = $client->listTagsForResourceAsync([/* ... */]);
Lists all tags on an AWS IoT Things Graph resource.
Parameter Syntax
$result = $client->listTagsForResource([
'maxResults' => <integer>,
'nextToken' => '<string>',
'resourceArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'nextToken' => '<string>',
'tags' => [
[
'key' => '<string>',
'value' => '<string>',
],
// ...
],
]
Result Details
Members
- nextToken
-
- Type: string
The token that specifies the next page of results to return.
- tags
-
- Type: Array of Tag structures
List of tags returned by the
ListTagsForResourceoperation.
Errors
SearchEntities
$result = $client->searchEntities([/* ... */]); $promise = $client->searchEntitiesAsync([/* ... */]);
Searches for entities of the specified type. You can search for entities in your namespace and the public namespace that you're tracking.
Parameter Syntax
$result = $client->searchEntities([
'entityTypes' => ['<string>', ...], // REQUIRED
'filters' => [
[
'name' => 'NAME|NAMESPACE|SEMANTIC_TYPE_PATH|REFERENCED_ENTITY_ID',
'value' => ['<string>', ...],
],
// ...
],
'maxResults' => <integer>,
'namespaceVersion' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
- entityTypes
-
- Required: Yes
- Type: Array of strings
The entity types for which to search.
- filters
-
- Type: Array of EntityFilter structures
Optional filter to apply to the search. Valid filters are
NAMENAMESPACE,SEMANTIC_TYPE_PATHandREFERENCED_ENTITY_ID.REFERENCED_ENTITY_IDfilters 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.
- maxResults
-
- Type: int
The maximum number of results to return in the response.
- namespaceVersion
-
- Type: long (int|float)
The version of the user's namespace. Defaults to the latest version of the user's namespace.
- nextToken
-
- Type: string
The string that specifies the next page of results. Use this when you're paginating results.
Result Syntax
[
'descriptions' => [
[
'arn' => '<string>',
'createdAt' => <DateTime>,
'definition' => [
'language' => 'GRAPHQL',
'text' => '<string>',
],
'id' => '<string>',
'type' => 'DEVICE|SERVICE|DEVICE_MODEL|CAPABILITY|STATE|ACTION|EVENT|PROPERTY|MAPPING|ENUM',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- descriptions
-
- Type: Array of EntityDescription structures
An array of descriptions for each entity returned in the search result.
- nextToken
-
- Type: string
The string to specify as
nextTokenwhen you request the next page of results.
Errors
SearchFlowExecutions
$result = $client->searchFlowExecutions([/* ... */]); $promise = $client->searchFlowExecutionsAsync([/* ... */]);
Searches for AWS IoT Things Graph workflow execution instances.
Parameter Syntax
$result = $client->searchFlowExecutions([
'endTime' => <integer || string || DateTime>,
'flowExecutionId' => '<string>',
'maxResults' => <integer>,
'nextToken' => '<string>',
'startTime' => <integer || string || DateTime>,
'systemInstanceId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- endTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time of the latest flow execution to return.
- flowExecutionId
-
- Type: string
The ID of a flow execution.
- maxResults
-
- Type: int
The maximum number of results to return in the response.
- nextToken
-
- Type: string
The string that specifies the next page of results. Use this when you're paginating results.
- startTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time of the earliest flow execution to return.
- systemInstanceId
-
- Required: Yes
- Type: string
The ID of the system instance that contains the flow.
Result Syntax
[
'nextToken' => '<string>',
'summaries' => [
[
'createdAt' => <DateTime>,
'flowExecutionId' => '<string>',
'flowTemplateId' => '<string>',
'status' => 'RUNNING|ABORTED|SUCCEEDED|FAILED',
'systemInstanceId' => '<string>',
'updatedAt' => <DateTime>,
],
// ...
],
]
Result Details
Members
- nextToken
-
- Type: string
The string to specify as
nextTokenwhen you request the next page of results. - summaries
-
- Type: Array of FlowExecutionSummary structures
An array of objects that contain summary information about each workflow execution in the result set.
Errors
SearchFlowTemplates
$result = $client->searchFlowTemplates([/* ... */]); $promise = $client->searchFlowTemplatesAsync([/* ... */]);
Searches for summary information about workflows.
Parameter Syntax
$result = $client->searchFlowTemplates([
'filters' => [
[
'name' => 'DEVICE_MODEL_ID', // REQUIRED
'value' => ['<string>', ...], // REQUIRED
],
// ...
],
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
- filters
-
- Type: Array of FlowTemplateFilter structures
An array of objects that limit the result set. The only valid filter is
DEVICE_MODEL_ID. - maxResults
-
- Type: int
The maximum number of results to return in the response.
- nextToken
-
- Type: string
The string that specifies the next page of results. Use this when you're paginating results.
Result Syntax
[
'nextToken' => '<string>',
'summaries' => [
[
'arn' => '<string>',
'createdAt' => <DateTime>,
'id' => '<string>',
'revisionNumber' => <integer>,
],
// ...
],
]
Result Details
Members
- nextToken
-
- Type: string
The string to specify as
nextTokenwhen you request the next page of results. - summaries
-
- Type: Array of FlowTemplateSummary structures
An array of objects that contain summary information about each workflow in the result set.
Errors
SearchSystemInstances
$result = $client->searchSystemInstances([/* ... */]); $promise = $client->searchSystemInstancesAsync([/* ... */]);
Searches for system instances in the user's account.
Parameter Syntax
$result = $client->searchSystemInstances([
'filters' => [
[
'name' => 'SYSTEM_TEMPLATE_ID|STATUS|GREENGRASS_GROUP_NAME',
'value' => ['<string>', ...],
],
// ...
],
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
- filters
-
- Type: Array of SystemInstanceFilter structures
Optional filter to apply to the search. Valid filters are
SYSTEM_TEMPLATE_ID,STATUS, andGREENGRASS_GROUP_NAME.Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND criteria.
- maxResults
-
- Type: int
The maximum number of results to return in the response.
- nextToken
-
- Type: string
The string that specifies the next page of results. Use this when you're paginating results.
Result Syntax
[
'nextToken' => '<string>',
'summaries' => [
[
'arn' => '<string>',
'createdAt' => <DateTime>,
'greengrassGroupId' => '<string>',
'greengrassGroupName' => '<string>',
'greengrassGroupVersionId' => '<string>',
'id' => '<string>',
'status' => 'NOT_DEPLOYED|BOOTSTRAP|DEPLOY_IN_PROGRESS|DEPLOYED_IN_TARGET|UNDEPLOY_IN_PROGRESS|FAILED|PENDING_DELETE|DELETED_IN_TARGET',
'target' => 'GREENGRASS|CLOUD',
'updatedAt' => <DateTime>,
],
// ...
],
]
Result Details
Members
- nextToken
-
- Type: string
The string to specify as
nextTokenwhen you request the next page of results. - summaries
-
- Type: Array of SystemInstanceSummary structures
An array of objects that contain summary data abour the system instances in the result set.
Errors
SearchSystemTemplates
$result = $client->searchSystemTemplates([/* ... */]); $promise = $client->searchSystemTemplatesAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->searchSystemTemplates([
'filters' => [
[
'name' => 'FLOW_TEMPLATE_ID', // REQUIRED
'value' => ['<string>', ...], // REQUIRED
],
// ...
],
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
- filters
-
- Type: Array of SystemTemplateFilter structures
An array of filters that limit the result set. The only valid filter is
FLOW_TEMPLATE_ID. - maxResults
-
- Type: int
The maximum number of results to return in the response.
- nextToken
-
- Type: string
The string that specifies the next page of results. Use this when you're paginating results.
Result Syntax
[
'nextToken' => '<string>',
'summaries' => [
[
'arn' => '<string>',
'createdAt' => <DateTime>,
'id' => '<string>',
'revisionNumber' => <integer>,
],
// ...
],
]
Result Details
Members
- nextToken
-
- Type: string
The string to specify as
nextTokenwhen you request the next page of results. - summaries
-
- Type: Array of SystemTemplateSummary structures
An array of objects that contain summary information about each system deployment in the result set.
Errors
SearchThings
$result = $client->searchThings([/* ... */]); $promise = $client->searchThingsAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->searchThings([
'entityId' => '<string>', // REQUIRED
'maxResults' => <integer>,
'namespaceVersion' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
- entityId
-
- Required: Yes
- Type: string
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 - maxResults
-
- Type: int
The maximum number of results to return in the response.
- namespaceVersion
-
- Type: long (int|float)
The version of the user's namespace. Defaults to the latest version of the user's namespace.
- nextToken
-
- Type: string
The string that specifies the next page of results. Use this when you're paginating results.
Result Syntax
[
'nextToken' => '<string>',
'things' => [
[
'thingArn' => '<string>',
'thingName' => '<string>',
],
// ...
],
]
Result Details
Members
- nextToken
-
- Type: string
The string to specify as
nextTokenwhen you request the next page of results. - things
-
- Type: Array of Thing structures
An array of things in the result set.
Errors
TagResource
$result = $client->tagResource([/* ... */]); $promise = $client->tagResourceAsync([/* ... */]);
Creates a tag for the specified resource.
Parameter Syntax
$result = $client->tagResource([
'resourceArn' => '<string>', // REQUIRED
'tags' => [ // REQUIRED
[
'key' => '<string>', // REQUIRED
'value' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the resource whose tags are returned.
- tags
-
- Required: Yes
- Type: Array of Tag structures
A list of tags to add to the resource.>
Result Syntax
[]
Result Details
Errors
UndeploySystemInstance
$result = $client->undeploySystemInstance([/* ... */]); $promise = $client->undeploySystemInstanceAsync([/* ... */]);
Removes a system instance from its target (Cloud or Greengrass).
Parameter Syntax
$result = $client->undeploySystemInstance([
'id' => '<string>',
]);
Parameter Details
Result Syntax
[
'summary' => [
'arn' => '<string>',
'createdAt' => <DateTime>,
'greengrassGroupId' => '<string>',
'greengrassGroupName' => '<string>',
'greengrassGroupVersionId' => '<string>',
'id' => '<string>',
'status' => 'NOT_DEPLOYED|BOOTSTRAP|DEPLOY_IN_PROGRESS|DEPLOYED_IN_TARGET|UNDEPLOY_IN_PROGRESS|FAILED|PENDING_DELETE|DELETED_IN_TARGET',
'target' => 'GREENGRASS|CLOUD',
'updatedAt' => <DateTime>,
],
]
Result Details
Members
- summary
-
- Type: SystemInstanceSummary structure
An object that contains summary information about the system instance that was removed from its target.
Errors
UntagResource
$result = $client->untagResource([/* ... */]); $promise = $client->untagResourceAsync([/* ... */]);
Removes a tag from the specified resource.
Parameter Syntax
$result = $client->untagResource([
'resourceArn' => '<string>', // REQUIRED
'tagKeys' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the resource whose tags are to be removed.
- tagKeys
-
- Required: Yes
- Type: Array of strings
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.
Result Syntax
[]
Result Details
Errors
UpdateFlowTemplate
$result = $client->updateFlowTemplate([/* ... */]); $promise = $client->updateFlowTemplateAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->updateFlowTemplate([
'compatibleNamespaceVersion' => <integer>,
'definition' => [ // REQUIRED
'language' => 'GRAPHQL', // REQUIRED
'text' => '<string>', // REQUIRED
],
'id' => '<string>', // REQUIRED
]);
Parameter Details
Members
- compatibleNamespaceVersion
-
- Type: long (int|float)
The version of the user's namespace.
If no value is specified, the latest version is used by default. Use the
GetFlowTemplateRevisionsif you want to find earlier revisions of the flow to update. - definition
-
- Required: Yes
- Type: DefinitionDocument structure
The
DefinitionDocumentthat contains the updated workflow definition. - id
-
- Required: Yes
- Type: string
The ID of the workflow to be updated.
The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME
Result Syntax
[
'summary' => [
'arn' => '<string>',
'createdAt' => <DateTime>,
'id' => '<string>',
'revisionNumber' => <integer>,
],
]
Result Details
Members
- summary
-
- Type: FlowTemplateSummary structure
An object containing summary information about the updated workflow.
Errors
UpdateSystemTemplate
$result = $client->updateSystemTemplate([/* ... */]); $promise = $client->updateSystemTemplateAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->updateSystemTemplate([
'compatibleNamespaceVersion' => <integer>,
'definition' => [ // REQUIRED
'language' => 'GRAPHQL', // REQUIRED
'text' => '<string>', // REQUIRED
],
'id' => '<string>', // REQUIRED
]);
Parameter Details
Members
- compatibleNamespaceVersion
-
- Type: long (int|float)
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.
- definition
-
- Required: Yes
- Type: DefinitionDocument structure
The
DefinitionDocumentthat contains the updated system definition. - id
-
- Required: Yes
- Type: string
The ID of the system to be updated.
The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME
Result Syntax
[
'summary' => [
'arn' => '<string>',
'createdAt' => <DateTime>,
'id' => '<string>',
'revisionNumber' => <integer>,
],
]
Result Details
Members
- summary
-
- Type: SystemTemplateSummary structure
An object containing summary information about the updated system.
Errors
UploadEntityDefinitions
$result = $client->uploadEntityDefinitions([/* ... */]); $promise = $client->uploadEntityDefinitionsAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->uploadEntityDefinitions([
'deprecateExistingEntities' => true || false,
'document' => [
'language' => 'GRAPHQL', // REQUIRED
'text' => '<string>', // REQUIRED
],
'syncWithPublicNamespace' => true || false,
]);
Parameter Details
Members
- deprecateExistingEntities
-
- Type: boolean
A Boolean that specifies whether to deprecate all entities in the latest version before uploading the new
DefinitionDocument. If set totrue, the upload will create a new namespace version. - document
-
- Type: DefinitionDocument structure
The
DefinitionDocumentthat defines the updated entities. - syncWithPublicNamespace
-
- Type: 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.
Result Syntax
[
'uploadId' => '<string>',
]
Result Details
Members
Errors
Shapes
DefinitionDocument
Description
A document that defines an entity.
Members
DependencyRevision
Description
An object that contains the ID and revision number of a workflow or system that is part of a deployment.
Members
EntityDescription
Description
Describes the properties of an entity.
Members
- arn
-
- Type: string
The entity ARN.
- createdAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the entity was created.
- definition
-
- Type: DefinitionDocument structure
The definition document of the entity.
- id
-
- Type: string
The entity ID.
- type
-
- Type: string
The entity type.
EntityFilter
Description
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.
Members
- name
-
- Type: string
The name of the entity search filter field.
REFERENCED_ENTITY_IDfilters 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
-
- Type: Array of strings
An array of string values for the search filter field. Multiple values function as AND criteria in the search.
FlowExecutionMessage
Description
An object that contains information about a flow event.
Members
- eventType
-
- Type: string
The type of flow event .
- messageId
-
- Type: string
The unique identifier of the message.
- payload
-
- Type: string
A string containing information about the flow event.
- timestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time when the message was last updated.
FlowExecutionSummary
Description
An object that contains summary information about a flow execution.
Members
- createdAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time when the flow execution summary was created.
- flowExecutionId
-
- Type: string
The ID of the flow execution.
- flowTemplateId
-
- Type: string
The ID of the flow.
- status
-
- Type: string
The current status of the flow execution.
- systemInstanceId
-
- Type: string
The ID of the system instance that contains the flow.
- updatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time when the flow execution summary was last updated.
FlowTemplateDescription
Description
An object that contains a workflow's definition and summary information.
Members
- definition
-
- Type: DefinitionDocument structure
A workflow's definition document.
- summary
-
- Type: FlowTemplateSummary structure
An object that contains summary information about a workflow.
- validatedNamespaceVersion
-
- Type: long (int|float)
The version of the user's namespace against which the workflow was validated. Use this value in your system instance.
FlowTemplateFilter
Description
An object that filters a workflow search.
Members
FlowTemplateSummary
Description
An object that contains summary information about a workflow.
Members
InternalFailureException
InvalidRequestException
LimitExceededException
MetricsConfiguration
Description
An object that specifies whether cloud metrics are collected in a deployment and, if so, what role is used to collect metrics.
Members
ResourceAlreadyExistsException
ResourceInUseException
ResourceNotFoundException
SystemInstanceDescription
Description
An object that contains a system instance definition and summary information.
Members
- definition
-
- Type: DefinitionDocument structure
A document that defines an entity.
- flowActionsRoleArn
-
- Type: 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.
- metricsConfiguration
-
- Type: MetricsConfiguration structure
An object that specifies whether cloud metrics are collected in a deployment and, if so, what role is used to collect metrics.
- s3BucketName
-
- Type: string
The Amazon Simple Storage Service bucket where information about a system instance is stored.
- summary
-
- Type: SystemInstanceSummary structure
An object that contains summary information about a system instance.
- validatedDependencyRevisions
-
- Type: Array of DependencyRevision structures
A list of objects that contain all of the IDs and revision numbers of workflows and systems that are used in a system instance.
- validatedNamespaceVersion
-
- Type: long (int|float)
The version of the user's namespace against which the system instance was validated.
SystemInstanceFilter
Description
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.
Members
SystemInstanceSummary
Description
An object that contains summary information about a system instance.
Members
- arn
-
- Type: string
The ARN of the system instance.
- createdAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date when the system instance was created.
- greengrassGroupId
-
- Type: string
The ID of the Greengrass group where the system instance is deployed.
- greengrassGroupName
-
- Type: string
The ID of the Greengrass group where the system instance is deployed.
- greengrassGroupVersionId
-
- Type: string
The version of the Greengrass group where the system instance is deployed.
- id
-
- Type: string
The ID of the system instance.
- status
-
- Type: string
The status of the system instance.
- target
-
- Type: string
The target of the system instance.
- updatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time when the system instance was last updated.
SystemTemplateDescription
Description
An object that contains a system's definition document and summary information.
Members
- definition
-
- Type: DefinitionDocument structure
The definition document of a system.
- summary
-
- Type: SystemTemplateSummary structure
An object that contains summary information about a system.
- validatedNamespaceVersion
-
- Type: long (int|float)
The namespace version against which the system was validated. Use this value in your system instance.
SystemTemplateFilter
Description
An object that filters a system search.
Members
SystemTemplateSummary
Description
An object that contains information about a system.
Members
Tag
Description
Metadata assigned to an AWS IoT Things Graph resource consisting of a key-value pair.
Members
Thing
Description
An AWS IoT thing.
