AWS.Tools.IoTThingsGraph.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.IoTThingsGraph</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.IOTTG.AddIOTTGEntityToThingCmdlet"> <summary> Associates a device with a concrete thing that is in the user's registry. <para> 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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.AddIOTTGEntityToThingCmdlet.EntityId"> <summary> <para> <para>The ID of the device to be associated with the thing.</para><para>The ID should be in the following format.</para><para><code>urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.AddIOTTGEntityToThingCmdlet.NamespaceVersion"> <summary> <para> <para>The version of the user's namespace. Defaults to the latest version of the user's namespace.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.AddIOTTGEntityToThingCmdlet.ThingName"> <summary> <para> <para>The name of the thing to which the entity is to be associated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.AddIOTTGEntityToThingCmdlet.PassThru"> <summary> Returns the value passed to the EntityId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.AddIOTTGEntityToThingCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTTG.AddIOTTGResourceTagCmdlet"> <summary> Creates a tag for the specified resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.AddIOTTGResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource whose tags are returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.AddIOTTGResourceTagCmdlet.Tag"> <summary> <para> <para>A list of tags to add to the resource.></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.AddIOTTGResourceTagCmdlet.PassThru"> <summary> Returns the value passed to the ResourceArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.AddIOTTGResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTTG.AddIOTTGSystemInstanceDeploymentCmdlet"> <summary> <b>Greengrass and Cloud Deployments</b><para> Deploys the system instance to the target specified in <code>CreateSystemInstance</code>. </para><para><b>Greengrass Deployments</b></para><para> 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. </para><para> 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. </para><para> For information about the artifacts that get added to your Greengrass core device when you use this API, see <a href="https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-greengrass.html">AWS IoT Things Graph and AWS IoT Greengrass</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.AddIOTTGSystemInstanceDeploymentCmdlet.Id"> <summary> <para> <para>The ID of the system instance. This value is returned by the <code>CreateSystemInstance</code> action.</para><para>The ID should be in the following format.</para><para><code>urn:tdm:REGION/ACCOUNT ID/default:deployment:DEPLOYMENTNAME</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.AddIOTTGSystemInstanceDeploymentCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTTG.GetIOTTGEntityCmdlet"> <summary> Gets definitions of the specified entities. Uses the latest version of the user's namespace by default. This API returns the following TDM entities. <ul><li><para> Properties </para></li><li><para> States </para></li><li><para> Events </para></li><li><para> Actions </para></li><li><para> Capabilities </para></li><li><para> Mappings </para></li><li><para> Devices </para></li><li><para> Device Models </para></li><li><para> Services </para></li></ul><para> This action doesn't return definitions for systems, flows, and deployments. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.GetIOTTGEntityCmdlet.Id"> <summary> <para> <para>An array of entity IDs.</para><para>The IDs should be in the following format.</para><para><code>urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.GetIOTTGEntityCmdlet.NamespaceVersion"> <summary> <para> <para>The version of the user's namespace. Defaults to the latest version of the user's namespace.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTTG.GetIOTTGFlowExecutionMessageListCmdlet"> <summary> Returns a list of objects that contain information about events in a flow execution. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.GetIOTTGFlowExecutionMessageListCmdlet.FlowExecutionId"> <summary> <para> <para>The ID of the flow execution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.GetIOTTGFlowExecutionMessageListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.GetIOTTGFlowExecutionMessageListCmdlet.NextToken"> <summary> <para> <para>The string that specifies the next page of results. Use this when you're paginating results.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTTG.GetIOTTGFlowTemplateCmdlet"> <summary> Gets the latest version of the <code>DefinitionDocument</code> and <code>FlowTemplateSummary</code> for the specified workflow. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.GetIOTTGFlowTemplateCmdlet.Id"> <summary> <para> <para>The ID of the workflow.</para><para>The ID should be in the following format.</para><para><code>urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.GetIOTTGFlowTemplateCmdlet.RevisionNumber"> <summary> <para> <para>The number of the workflow revision to retrieve.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTTG.GetIOTTGFlowTemplateRevisionCmdlet"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.GetIOTTGFlowTemplateRevisionCmdlet.Id"> <summary> <para> <para>The ID of the workflow.</para><para>The ID should be in the following format.</para><para><code>urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.GetIOTTGFlowTemplateRevisionCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.GetIOTTGFlowTemplateRevisionCmdlet.NextToken"> <summary> <para> <para>The string that specifies the next page of results. Use this when you're paginating results.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTTG.GetIOTTGNamespaceCmdlet"> <summary> Gets the latest version of the user's namespace and the public version that it is tracking. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.GetIOTTGNamespaceCmdlet.NamespaceName"> <summary> <para> <para>The name of the user's namespace. Set this to <code>aws</code> to get the public namespace.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTTG.GetIOTTGNamespaceDeletionStatusCmdlet"> <summary> Gets the status of a namespace deletion task. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTTG.GetIOTTGResourceTagCmdlet"> <summary> Lists all tags on an AWS IoT Things Graph resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.GetIOTTGResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource whose tags are to be returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.GetIOTTGResourceTagCmdlet.MaxResult"> <summary> <para> <para>The maximum number of tags to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.GetIOTTGResourceTagCmdlet.NextToken"> <summary> <para> <para>The token that specifies the next page of results to return.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTTG.GetIOTTGSystemInstanceCmdlet"> <summary> Gets a system instance. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.GetIOTTGSystemInstanceCmdlet.Id"> <summary> <para> <para>The ID of the system deployment instance. This value is returned by <code>CreateSystemInstance</code>.</para><para>The ID should be in the following format.</para><para><code>urn:tdm:REGION/ACCOUNT ID/default:deployment:DEPLOYMENTNAME</code></para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTTG.GetIOTTGSystemTemplateCmdlet"> <summary> Gets a system. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.GetIOTTGSystemTemplateCmdlet.Id"> <summary> <para> <para>The ID of the system to get. This ID must be in the user's namespace.</para><para>The ID should be in the following format.</para><para><code>urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.GetIOTTGSystemTemplateCmdlet.RevisionNumber"> <summary> <para> <para>The number that specifies the revision of the system to get.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTTG.GetIOTTGSystemTemplateRevisionCmdlet"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.GetIOTTGSystemTemplateRevisionCmdlet.Id"> <summary> <para> <para>The ID of the system template.</para><para>The ID should be in the following format.</para><para><code>urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.GetIOTTGSystemTemplateRevisionCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.GetIOTTGSystemTemplateRevisionCmdlet.NextToken"> <summary> <para> <para>The string that specifies the next page of results. Use this when you're paginating results.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTTG.GetIOTTGUploadStatusCmdlet"> <summary> Gets the status of the specified upload. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.GetIOTTGUploadStatusCmdlet.UploadId"> <summary> <para> <para>The ID of the upload. This value is returned by the <code>UploadEntityDefinitions</code> action.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTTG.NewIOTTGFlowTemplateCmdlet"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.NewIOTTGFlowTemplateCmdlet.CompatibleNamespaceVersion"> <summary> <para> <para>The namespace version in which the workflow is to be created.</para><para>If no value is specified, the latest version is used by default.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.NewIOTTGFlowTemplateCmdlet.Definition_Language"> <summary> <para> <para>The language used to define the entity. <code>GRAPHQL</code> is the only valid value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.NewIOTTGFlowTemplateCmdlet.Definition_Text"> <summary> <para> <para>The GraphQL text that defines the entity.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.NewIOTTGFlowTemplateCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTTG.NewIOTTGSystemInstanceCmdlet"> <summary> Creates a system instance. <para> This action validates the system instance, prepares the deployment-related resources. For Greengrass deployments, it updates the Greengrass group that is specified by the <code>greengrassGroupName</code> parameter. It also adds a file to the S3 bucket specified by the <code>s3BucketName</code> parameter. You need to call <code>DeploySystemInstance</code> after running this action. </para><para> 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. </para><para> For cloud deployments, this action requires a <code>flowActionsRoleArn</code> 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. </para><para> If the definition document doesn't specify a version of the user's namespace, the latest version will be used by default. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.NewIOTTGSystemInstanceCmdlet.MetricsConfiguration_CloudMetricEnabled"> <summary> <para> <para>A Boolean that specifies whether cloud metrics are collected.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.NewIOTTGSystemInstanceCmdlet.FlowActionsRoleArn"> <summary> <para> <para>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 <code>target</code> parameter is <code>CLOUD</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.NewIOTTGSystemInstanceCmdlet.GreengrassGroupName"> <summary> <para> <para>The name of the Greengrass group where the system instance will be deployed. This value is required if the value of the <code>target</code> parameter is <code>GREENGRASS</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.NewIOTTGSystemInstanceCmdlet.Definition_Language"> <summary> <para> <para>The language used to define the entity. <code>GRAPHQL</code> is the only valid value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.NewIOTTGSystemInstanceCmdlet.MetricsConfiguration_MetricRuleRoleArn"> <summary> <para> <para>The ARN of the role that is used to collect cloud metrics.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.NewIOTTGSystemInstanceCmdlet.S3BucketName"> <summary> <para> <para>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 <code>target</code> parameter is <code>GREENGRASS</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.NewIOTTGSystemInstanceCmdlet.Tag"> <summary> <para> <para>Metadata, consisting of key-value pairs, that can be used to categorize your system instances.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.NewIOTTGSystemInstanceCmdlet.Target"> <summary> <para> <para>The target type of the deployment. Valid values are <code>GREENGRASS</code> and <code>CLOUD</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.NewIOTTGSystemInstanceCmdlet.Definition_Text"> <summary> <para> <para>The GraphQL text that defines the entity.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.NewIOTTGSystemInstanceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTTG.NewIOTTGSystemTemplateCmdlet"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.NewIOTTGSystemTemplateCmdlet.CompatibleNamespaceVersion"> <summary> <para> <para>The namespace version in which the system is to be created.</para><para>If no value is specified, the latest version is used by default.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.NewIOTTGSystemTemplateCmdlet.Definition_Language"> <summary> <para> <para>The language used to define the entity. <code>GRAPHQL</code> is the only valid value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.NewIOTTGSystemTemplateCmdlet.Definition_Text"> <summary> <para> <para>The GraphQL text that defines the entity.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.NewIOTTGSystemTemplateCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTTG.RemoveIOTTGEntityFromThingCmdlet"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.RemoveIOTTGEntityFromThingCmdlet.EntityType"> <summary> <para> <para>The entity type from which to disassociate the thing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.RemoveIOTTGEntityFromThingCmdlet.ThingName"> <summary> <para> <para>The name of the thing to disassociate.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.RemoveIOTTGEntityFromThingCmdlet.PassThru"> <summary> Returns the value passed to the ThingName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.RemoveIOTTGEntityFromThingCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTTG.RemoveIOTTGFlowTemplateCmdlet"> <summary> 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). </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.RemoveIOTTGFlowTemplateCmdlet.Id"> <summary> <para> <para>The ID of the workflow to be deleted.</para><para>The ID should be in the following format.</para><para><code>urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.RemoveIOTTGFlowTemplateCmdlet.PassThru"> <summary> Returns the value passed to the Id parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.RemoveIOTTGFlowTemplateCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTTG.RemoveIOTTGNamespaceCmdlet"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.RemoveIOTTGNamespaceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTTG.RemoveIOTTGResourceTagCmdlet"> <summary> Removes a tag from the specified resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.RemoveIOTTGResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource whose tags are to be removed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.RemoveIOTTGResourceTagCmdlet.TagKey"> <summary> <para> <para>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. </para><para>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 <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters.html#cli-using-param-json">Using JSON for Parameters</a> in the <i>AWS CLI User Guide</i>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.RemoveIOTTGResourceTagCmdlet.PassThru"> <summary> Returns the value passed to the ResourceArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.RemoveIOTTGResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTTG.RemoveIOTTGSystemInstanceCmdlet"> <summary> Deletes a system instance. Only system instances that have never been deployed, or that have been undeployed can be deleted. <para> Users can create a new system instance that has the same ID as a deleted system instance. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.RemoveIOTTGSystemInstanceCmdlet.Id"> <summary> <para> <para>The ID of the system instance to be deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.RemoveIOTTGSystemInstanceCmdlet.PassThru"> <summary> Returns the value passed to the Id parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.RemoveIOTTGSystemInstanceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTTG.RemoveIOTTGSystemInstanceDeploymentCmdlet"> <summary> Removes a system instance from its target (Cloud or Greengrass). </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.RemoveIOTTGSystemInstanceDeploymentCmdlet.Id"> <summary> <para> <para>The ID of the system instance to remove from its target.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.RemoveIOTTGSystemInstanceDeploymentCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTTG.RemoveIOTTGSystemTemplateCmdlet"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.RemoveIOTTGSystemTemplateCmdlet.Id"> <summary> <para> <para>The ID of the system to be deleted.</para><para>The ID should be in the following format.</para><para><code>urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.RemoveIOTTGSystemTemplateCmdlet.PassThru"> <summary> Returns the value passed to the Id parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.RemoveIOTTGSystemTemplateCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTTG.SearchIOTTGEntityCmdlet"> <summary> Searches for entities of the specified type. You can search for entities in your namespace and the public namespace that you're tracking. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.SearchIOTTGEntityCmdlet.EntityType"> <summary> <para> <para>The entity types for which to search.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.SearchIOTTGEntityCmdlet.Filter"> <summary> <para> <para>Optional filter to apply to the search. Valid filters are <code>NAME</code><code>NAMESPACE</code>, <code>SEMANTIC_TYPE_PATH</code> and <code>REFERENCED_ENTITY_ID</code>. <code>REFERENCED_ENTITY_ID</code> 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.</para><para>Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND criteria.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.SearchIOTTGEntityCmdlet.NamespaceVersion"> <summary> <para> <para>The version of the user's namespace. Defaults to the latest version of the user's namespace.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.SearchIOTTGEntityCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.SearchIOTTGEntityCmdlet.NextToken"> <summary> <para> <para>The string that specifies the next page of results. Use this when you're paginating results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.SearchIOTTGEntityCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTTG.SearchIOTTGFlowExecutionCmdlet"> <summary> Searches for AWS IoT Things Graph workflow execution instances. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.SearchIOTTGFlowExecutionCmdlet.EndTime"> <summary> <para> <para>The date and time of the latest flow execution to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.SearchIOTTGFlowExecutionCmdlet.FlowExecutionId"> <summary> <para> <para>The ID of a flow execution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.SearchIOTTGFlowExecutionCmdlet.StartTime"> <summary> <para> <para>The date and time of the earliest flow execution to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.SearchIOTTGFlowExecutionCmdlet.SystemInstanceId"> <summary> <para> <para>The ID of the system instance that contains the flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.SearchIOTTGFlowExecutionCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.SearchIOTTGFlowExecutionCmdlet.NextToken"> <summary> <para> <para>The string that specifies the next page of results. Use this when you're paginating results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.SearchIOTTGFlowExecutionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTTG.SearchIOTTGFlowTemplateCmdlet"> <summary> Searches for summary information about workflows. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.SearchIOTTGFlowTemplateCmdlet.Filter"> <summary> <para> <para>An array of objects that limit the result set. The only valid filter is <code>DEVICE_MODEL_ID</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.SearchIOTTGFlowTemplateCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.SearchIOTTGFlowTemplateCmdlet.NextToken"> <summary> <para> <para>The string that specifies the next page of results. Use this when you're paginating results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.SearchIOTTGFlowTemplateCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTTG.SearchIOTTGSystemInstanceCmdlet"> <summary> Searches for system instances in the user's account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.SearchIOTTGSystemInstanceCmdlet.Filter"> <summary> <para> <para>Optional filter to apply to the search. Valid filters are <code>SYSTEM_TEMPLATE_ID</code>, <code>STATUS</code>, and <code>GREENGRASS_GROUP_NAME</code>.</para><para>Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND criteria.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.SearchIOTTGSystemInstanceCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.SearchIOTTGSystemInstanceCmdlet.NextToken"> <summary> <para> <para>The string that specifies the next page of results. Use this when you're paginating results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.SearchIOTTGSystemInstanceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTTG.SearchIOTTGSystemTemplateCmdlet"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.SearchIOTTGSystemTemplateCmdlet.Filter"> <summary> <para> <para>An array of filters that limit the result set. The only valid filter is <code>FLOW_TEMPLATE_ID</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.SearchIOTTGSystemTemplateCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.SearchIOTTGSystemTemplateCmdlet.NextToken"> <summary> <para> <para>The string that specifies the next page of results. Use this when you're paginating results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.SearchIOTTGSystemTemplateCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTTG.SearchIOTTGThingCmdlet"> <summary> Searches for things associated with the specified entity. You can search by both device and device model. <para> 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. <code>SearchThings(camera2)</code> will return only thing2, but <code>SearchThings(camera)</code> will return both thing1 and thing2. </para><para> This action searches for exact matches and doesn't perform partial text matching. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.SearchIOTTGThingCmdlet.EntityId"> <summary> <para> <para>The ID of the entity to which the things are associated.</para><para>The IDs should be in the following format.</para><para><code>urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.SearchIOTTGThingCmdlet.NamespaceVersion"> <summary> <para> <para>The version of the user's namespace. Defaults to the latest version of the user's namespace.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.SearchIOTTGThingCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.SearchIOTTGThingCmdlet.NextToken"> <summary> <para> <para>The string that specifies the next page of results. Use this when you're paginating results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.SearchIOTTGThingCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTTG.SetIOTTGEntityDefinitionCmdlet"> <summary> Asynchronously uploads one or more entity definitions to the user's namespace. The <code>document</code> parameter is required if <code>syncWithPublicNamespace</code> and <code>deleteExistingEntites</code> are false. If the <code>syncWithPublicNamespace</code> parameter is set to <code>true</code>, the user's namespace will synchronize with the latest version of the public namespace. If <code>deprecateExistingEntities</code> is set to true, all entities in the latest version will be deleted before the new <code>DefinitionDocument</code> is uploaded. <para> 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 <code>syncWithPublicNamespace</code> parameter or the <code>deprecateExistingEntities</code> parameter to <code>true</code>. </para><para> 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. </para><para> Valid entities are <code>Device</code>, <code>DeviceModel</code>, <code>Service</code>, <code>Capability</code>, <code>State</code>, <code>Action</code>, <code>Event</code>, <code>Property</code>, <code>Mapping</code>, <code>Enum</code>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.SetIOTTGEntityDefinitionCmdlet.DeprecateExistingEntity"> <summary> <para> <para>A Boolean that specifies whether to deprecate all entities in the latest version before uploading the new <code>DefinitionDocument</code>. If set to <code>true</code>, the upload will create a new namespace version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.SetIOTTGEntityDefinitionCmdlet.Document_Language"> <summary> <para> <para>The language used to define the entity. <code>GRAPHQL</code> is the only valid value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.SetIOTTGEntityDefinitionCmdlet.SyncWithPublicNamespace"> <summary> <para> <para>A Boolean that specifies whether to synchronize with the latest version of the public namespace. If set to <code>true</code>, the upload will create a new namespace version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.SetIOTTGEntityDefinitionCmdlet.Document_Text"> <summary> <para> <para>The GraphQL text that defines the entity.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.SetIOTTGEntityDefinitionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTTG.SetIOTTGFlowTemplateDeprecationCmdlet"> <summary> Deprecates the specified workflow. This action marks the workflow for deletion. Deprecated flows can't be deployed, but existing deployments will continue to run. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.SetIOTTGFlowTemplateDeprecationCmdlet.Id"> <summary> <para> <para>The ID of the workflow to be deleted.</para><para>The ID should be in the following format.</para><para><code>urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.SetIOTTGFlowTemplateDeprecationCmdlet.PassThru"> <summary> Returns the value passed to the Id parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.SetIOTTGFlowTemplateDeprecationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTTG.SetIOTTGSystemTemplateDeprecationCmdlet"> <summary> Deprecates the specified system. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.SetIOTTGSystemTemplateDeprecationCmdlet.Id"> <summary> <para> <para>The ID of the system to delete.</para><para>The ID should be in the following format.</para><para><code>urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.SetIOTTGSystemTemplateDeprecationCmdlet.PassThru"> <summary> Returns the value passed to the Id parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.SetIOTTGSystemTemplateDeprecationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTTG.UpdateIOTTGFlowTemplateCmdlet"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.UpdateIOTTGFlowTemplateCmdlet.CompatibleNamespaceVersion"> <summary> <para> <para>The version of the user's namespace.</para><para>If no value is specified, the latest version is used by default. Use the <code>GetFlowTemplateRevisions</code> if you want to find earlier revisions of the flow to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.UpdateIOTTGFlowTemplateCmdlet.Id"> <summary> <para> <para>The ID of the workflow to be updated.</para><para>The ID should be in the following format.</para><para><code>urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.UpdateIOTTGFlowTemplateCmdlet.Definition_Language"> <summary> <para> <para>The language used to define the entity. <code>GRAPHQL</code> is the only valid value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.UpdateIOTTGFlowTemplateCmdlet.Definition_Text"> <summary> <para> <para>The GraphQL text that defines the entity.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.UpdateIOTTGFlowTemplateCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTTG.UpdateIOTTGSystemTemplateCmdlet"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.UpdateIOTTGSystemTemplateCmdlet.CompatibleNamespaceVersion"> <summary> <para> <para>The version of the user's namespace. Defaults to the latest version of the user's namespace.</para><para>If no value is specified, the latest version is used by default.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.UpdateIOTTGSystemTemplateCmdlet.Id"> <summary> <para> <para>The ID of the system to be updated.</para><para>The ID should be in the following format.</para><para><code>urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.UpdateIOTTGSystemTemplateCmdlet.Definition_Language"> <summary> <para> <para>The language used to define the entity. <code>GRAPHQL</code> is the only valid value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.UpdateIOTTGSystemTemplateCmdlet.Definition_Text"> <summary> <para> <para>The GraphQL text that defines the entity.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTTG.UpdateIOTTGSystemTemplateCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |