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

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

ResourceNotFoundException:

InternalFailureException:

ThrottlingException:

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

Result Syntax

[
    'summary' => [
        'arn' => '<string>',
        'createdAt' => <DateTime>,
        'id' => '<string>',
        'revisionNumber' => <integer>,
    ],
]

Result Details

Errors

InvalidRequestException:

ResourceAlreadyExistsException:

ThrottlingException:

LimitExceededException:

InternalFailureException:

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

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

Errors

InvalidRequestException:

ResourceAlreadyExistsException:

ThrottlingException:

InternalFailureException:

LimitExceededException:

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

Result Syntax

[
    'summary' => [
        'arn' => '<string>',
        'createdAt' => <DateTime>,
        'id' => '<string>',
        'revisionNumber' => <integer>,
    ],
]

Result Details

Errors

InvalidRequestException:

ResourceAlreadyExistsException:

ThrottlingException:

InternalFailureException:

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

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

ThrottlingException:

InternalFailureException:

ResourceInUseException:

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. This action takes no request parameters.

Parameter Syntax

$result = $client->deleteNamespace([
]);

Parameter Details

Result Syntax

[
    'namespaceArn' => '<string>',
    'namespaceName' => '<string>',
]

Result Details

Errors

InternalFailureException:

ThrottlingException:

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

InvalidRequestException:

ThrottlingException:

InternalFailureException:

ResourceInUseException:

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

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

ThrottlingException:

InternalFailureException:

ResourceInUseException:

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

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

Errors

ResourceNotFoundException:

InvalidRequestException:

ThrottlingException:

InternalFailureException:

ResourceInUseException:

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

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

ThrottlingException:

InternalFailureException:

ResourceNotFoundException:

DeprecateSystemTemplate

$result = $client->deprecateSystemTemplate([/* ... */]);
$promise = $client->deprecateSystemTemplateAsync([/* ... */]);

Deprecates the specified system.

Parameter Syntax

$result = $client->deprecateSystemTemplate([
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

ThrottlingException:

InternalFailureException:

ResourceNotFoundException:

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

Result Syntax

[
    'namespaceArn' => '<string>',
    'namespaceName' => '<string>',
    'namespaceVersion' => <integer>,
    'trackingNamespaceName' => '<string>',
    'trackingNamespaceVersion' => <integer>,
]

Result Details

Errors

ResourceNotFoundException:

InvalidRequestException:

InternalFailureException:

ThrottlingException:

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

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

ResourceNotFoundException:

InternalFailureException:

ThrottlingException:

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

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

Errors

InvalidRequestException:

ResourceNotFoundException:

ThrottlingException:

InternalFailureException:

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

Result Syntax

[
    'description' => [
        'definition' => [
            'language' => 'GRAPHQL',
            'text' => '<string>',
        ],
        'summary' => [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'id' => '<string>',
            'revisionNumber' => <integer>,
        ],
        'validatedNamespaceVersion' => <integer>,
    ],
]

Result Details

Errors

InvalidRequestException:

ThrottlingException:

InternalFailureException:

ResourceNotFoundException:

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

Result Syntax

[
    'nextToken' => '<string>',
    'summaries' => [
        [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'id' => '<string>',
            'revisionNumber' => <integer>,
        ],
        // ...
    ],
]

Result Details

Errors

InvalidRequestException:

ThrottlingException:

InternalFailureException:

ResourceNotFoundException:

GetNamespaceDeletionStatus

$result = $client->getNamespaceDeletionStatus([/* ... */]);
$promise = $client->getNamespaceDeletionStatusAsync([/* ... */]);

Gets the status of a namespace deletion task.

Parameter Syntax

$result = $client->getNamespaceDeletionStatus([
]);

Parameter Details

Result Syntax

[
    'errorCode' => 'VALIDATION_FAILED',
    'errorMessage' => '<string>',
    'namespaceArn' => '<string>',
    'namespaceName' => '<string>',
    'status' => 'IN_PROGRESS|SUCCEEDED|FAILED',
]

Result Details

Errors

InvalidRequestException:

InternalFailureException:

ThrottlingException:

GetSystemInstance

$result = $client->getSystemInstance([/* ... */]);
$promise = $client->getSystemInstanceAsync([/* ... */]);

Gets a system instance.

Parameter Syntax

$result = $client->getSystemInstance([
    'id' => '<string>', // REQUIRED
]);

Parameter Details

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

Errors

InvalidRequestException:

ThrottlingException:

InternalFailureException:

ResourceNotFoundException:

GetSystemTemplate

$result = $client->getSystemTemplate([/* ... */]);
$promise = $client->getSystemTemplateAsync([/* ... */]);

Gets a system.

Parameter Syntax

$result = $client->getSystemTemplate([
    'id' => '<string>', // REQUIRED
    'revisionNumber' => <integer>,
]);

Parameter Details

Result Syntax

[
    'description' => [
        'definition' => [
            'language' => 'GRAPHQL',
            'text' => '<string>',
        ],
        'summary' => [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'id' => '<string>',
            'revisionNumber' => <integer>,
        ],
        'validatedNamespaceVersion' => <integer>,
    ],
]

Result Details

Errors

InvalidRequestException:

ThrottlingException:

InternalFailureException:

ResourceNotFoundException:

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

Result Syntax

[
    'nextToken' => '<string>',
    'summaries' => [
        [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'id' => '<string>',
            'revisionNumber' => <integer>,
        ],
        // ...
    ],
]

Result Details

Errors

InvalidRequestException:

ThrottlingException:

InternalFailureException:

ResourceNotFoundException:

GetUploadStatus

$result = $client->getUploadStatus([/* ... */]);
$promise = $client->getUploadStatusAsync([/* ... */]);

Gets the status of the specified upload.

Parameter Syntax

$result = $client->getUploadStatus([
    'uploadId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'createdDate' => <DateTime>,
    'failureReason' => ['<string>', ...],
    'namespaceArn' => '<string>',
    'namespaceName' => '<string>',
    'namespaceVersion' => <integer>,
    'uploadId' => '<string>',
    'uploadStatus' => 'IN_PROGRESS|SUCCEEDED|FAILED',
]

Result Details

Errors

InvalidRequestException:

ResourceNotFoundException:

InternalFailureException:

ThrottlingException:

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

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

Errors

InvalidRequestException:

ThrottlingException:

InternalFailureException:

ResourceNotFoundException:

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

Result Syntax

[
    'nextToken' => '<string>',
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidRequestException:

ResourceAlreadyExistsException:

ThrottlingException:

InternalFailureException:

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

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

Errors

InvalidRequestException:

InternalFailureException:

ThrottlingException:

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

Result Syntax

[
    'nextToken' => '<string>',
    'summaries' => [
        [
            'createdAt' => <DateTime>,
            'flowExecutionId' => '<string>',
            'flowTemplateId' => '<string>',
            'status' => 'RUNNING|ABORTED|SUCCEEDED|FAILED',
            'systemInstanceId' => '<string>',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

InvalidRequestException:

ThrottlingException:

InternalFailureException:

ResourceNotFoundException:

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

Result Syntax

[
    'nextToken' => '<string>',
    'summaries' => [
        [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'id' => '<string>',
            'revisionNumber' => <integer>,
        ],
        // ...
    ],
]

Result Details

Errors

InvalidRequestException:

ThrottlingException:

InternalFailureException:

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

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

Errors

InvalidRequestException:

ThrottlingException:

InternalFailureException:

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

Result Syntax

[
    'nextToken' => '<string>',
    'summaries' => [
        [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'id' => '<string>',
            'revisionNumber' => <integer>,
        ],
        // ...
    ],
]

Result Details

Errors

InvalidRequestException:

ThrottlingException:

InternalFailureException:

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

Result Syntax

[
    'nextToken' => '<string>',
    'things' => [
        [
            'thingArn' => '<string>',
            'thingName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidRequestException:

ResourceNotFoundException:

InternalFailureException:

ThrottlingException:

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

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

ResourceAlreadyExistsException:

ThrottlingException:

InternalFailureException:

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

Errors

InvalidRequestException:

ThrottlingException:

InternalFailureException:

ResourceNotFoundException:

ResourceInUseException:

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

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

ResourceAlreadyExistsException:

ThrottlingException:

InternalFailureException:

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

Result Syntax

[
    'summary' => [
        'arn' => '<string>',
        'createdAt' => <DateTime>,
        'id' => '<string>',
        'revisionNumber' => <integer>,
    ],
]

Result Details

Errors

InvalidRequestException:

ResourceNotFoundException:

ThrottlingException:

InternalFailureException:

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

Result Syntax

[
    'summary' => [
        'arn' => '<string>',
        'createdAt' => <DateTime>,
        'id' => '<string>',
        'revisionNumber' => <integer>,
    ],
]

Result Details

Errors

InvalidRequestException:

ResourceNotFoundException:

ThrottlingException:

InternalFailureException:

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

Result Syntax

[
    'uploadId' => '<string>',
]

Result Details

Errors

InvalidRequestException:

InternalFailureException:

ThrottlingException: