github.com/aavshr/aws-sdk-go@v1.41.3/models/apis/iotthingsgraph/2018-09-06/docs-2.json (about) 1 { 2 "version": "2.0", 3 "service": "<fullname>AWS IoT Things Graph</fullname> <p>AWS IoT Things Graph provides an integrated set of tools that enable developers to connect devices and services that use different standards, such as units of measure and communication protocols. AWS IoT Things Graph makes it possible to build IoT applications with little to no code by connecting devices and services and defining how they interact at an abstract level.</p> <p>For more information about how AWS IoT Things Graph works, see the <a href=\"https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-whatis.html\">User Guide</a>.</p>", 4 "operations": { 5 "AssociateEntityToThing": "<p>Associates a device with a concrete thing that is in the user's registry.</p> <p>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.</p>", 6 "CreateFlowTemplate": "<p>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.</p>", 7 "CreateSystemInstance": "<p>Creates a system instance. </p> <p>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.</p> <p>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.</p> <p>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.</p> <p>If the definition document doesn't specify a version of the user's namespace, the latest version will be used by default.</p>", 8 "CreateSystemTemplate": "<p>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.</p>", 9 "DeleteFlowTemplate": "<p>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).</p>", 10 "DeleteNamespace": "<p>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.</p>", 11 "DeleteSystemInstance": "<p>Deletes a system instance. Only system instances that have never been deployed, or that have been undeployed can be deleted.</p> <p>Users can create a new system instance that has the same ID as a deleted system instance.</p>", 12 "DeleteSystemTemplate": "<p>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.</p>", 13 "DeploySystemInstance": "<p> <b>Greengrass and Cloud Deployments</b> </p> <p>Deploys the system instance to the target specified in <code>CreateSystemInstance</code>. </p> <p> <b>Greengrass Deployments</b> </p> <p>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.</p> <p>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.</p> <p>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>.</p>", 14 "DeprecateFlowTemplate": "<p>Deprecates the specified workflow. This action marks the workflow for deletion. Deprecated flows can't be deployed, but existing deployments will continue to run.</p>", 15 "DeprecateSystemTemplate": "<p>Deprecates the specified system.</p>", 16 "DescribeNamespace": "<p>Gets the latest version of the user's namespace and the public version that it is tracking.</p>", 17 "DissociateEntityFromThing": "<p>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.</p>", 18 "GetEntities": "<p>Gets definitions of the specified entities. Uses the latest version of the user's namespace by default. This API returns the following TDM entities.</p> <ul> <li> <p>Properties</p> </li> <li> <p>States</p> </li> <li> <p>Events</p> </li> <li> <p>Actions</p> </li> <li> <p>Capabilities</p> </li> <li> <p>Mappings</p> </li> <li> <p>Devices</p> </li> <li> <p>Device Models</p> </li> <li> <p>Services</p> </li> </ul> <p>This action doesn't return definitions for systems, flows, and deployments.</p>", 19 "GetFlowTemplate": "<p>Gets the latest version of the <code>DefinitionDocument</code> and <code>FlowTemplateSummary</code> for the specified workflow.</p>", 20 "GetFlowTemplateRevisions": "<p>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.</p>", 21 "GetNamespaceDeletionStatus": "<p>Gets the status of a namespace deletion task.</p>", 22 "GetSystemInstance": "<p>Gets a system instance.</p>", 23 "GetSystemTemplate": "<p>Gets a system.</p>", 24 "GetSystemTemplateRevisions": "<p>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.</p>", 25 "GetUploadStatus": "<p>Gets the status of the specified upload.</p>", 26 "ListFlowExecutionMessages": "<p>Returns a list of objects that contain information about events in a flow execution.</p>", 27 "ListTagsForResource": "<p>Lists all tags on an AWS IoT Things Graph resource.</p>", 28 "SearchEntities": "<p>Searches for entities of the specified type. You can search for entities in your namespace and the public namespace that you're tracking.</p>", 29 "SearchFlowExecutions": "<p>Searches for AWS IoT Things Graph workflow execution instances.</p>", 30 "SearchFlowTemplates": "<p>Searches for summary information about workflows.</p>", 31 "SearchSystemInstances": "<p>Searches for system instances in the user's account.</p>", 32 "SearchSystemTemplates": "<p>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.</p>", 33 "SearchThings": "<p>Searches for things associated with the specified entity. You can search by both device and device model.</p> <p>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.</p> <p>This action searches for exact matches and doesn't perform partial text matching.</p>", 34 "TagResource": "<p>Creates a tag for the specified resource.</p>", 35 "UndeploySystemInstance": "<p>Removes a system instance from its target (Cloud or Greengrass).</p>", 36 "UntagResource": "<p>Removes a tag from the specified resource.</p>", 37 "UpdateFlowTemplate": "<p>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. </p>", 38 "UpdateSystemTemplate": "<p>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.</p>", 39 "UploadEntityDefinitions": "<p>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.</p> <p>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>.</p> <p>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.</p> <p>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>. </p>" 40 }, 41 "shapes": { 42 "Arn": { 43 "base": null, 44 "refs": { 45 "DeleteNamespaceResponse$namespaceArn": "<p>The ARN of the namespace to be deleted.</p>", 46 "DescribeNamespaceResponse$namespaceArn": "<p>The ARN of the namespace.</p>", 47 "EntityDescription$arn": "<p>The entity ARN.</p>", 48 "FlowTemplateSummary$arn": "<p>The ARN of the workflow.</p>", 49 "GetNamespaceDeletionStatusResponse$namespaceArn": "<p>The ARN of the namespace that is being deleted.</p>", 50 "GetUploadStatusResponse$namespaceArn": "<p>The ARN of the upload.</p>", 51 "SystemInstanceSummary$arn": "<p>The ARN of the system instance.</p>", 52 "SystemTemplateSummary$arn": "<p>The ARN of the system.</p>" 53 } 54 }, 55 "AssociateEntityToThingRequest": { 56 "base": null, 57 "refs": { 58 } 59 }, 60 "AssociateEntityToThingResponse": { 61 "base": null, 62 "refs": { 63 } 64 }, 65 "CreateFlowTemplateRequest": { 66 "base": null, 67 "refs": { 68 } 69 }, 70 "CreateFlowTemplateResponse": { 71 "base": null, 72 "refs": { 73 } 74 }, 75 "CreateSystemInstanceRequest": { 76 "base": null, 77 "refs": { 78 } 79 }, 80 "CreateSystemInstanceResponse": { 81 "base": null, 82 "refs": { 83 } 84 }, 85 "CreateSystemTemplateRequest": { 86 "base": null, 87 "refs": { 88 } 89 }, 90 "CreateSystemTemplateResponse": { 91 "base": null, 92 "refs": { 93 } 94 }, 95 "DefinitionDocument": { 96 "base": "<p>A document that defines an entity. </p>", 97 "refs": { 98 "CreateFlowTemplateRequest$definition": "<p>The workflow <code>DefinitionDocument</code>.</p>", 99 "CreateSystemInstanceRequest$definition": null, 100 "CreateSystemTemplateRequest$definition": "<p>The <code>DefinitionDocument</code> used to create the system.</p>", 101 "EntityDescription$definition": "<p>The definition document of the entity.</p>", 102 "FlowTemplateDescription$definition": "<p>A workflow's definition document.</p>", 103 "SystemInstanceDescription$definition": null, 104 "SystemTemplateDescription$definition": "<p>The definition document of a system.</p>", 105 "UpdateFlowTemplateRequest$definition": "<p>The <code>DefinitionDocument</code> that contains the updated workflow definition.</p>", 106 "UpdateSystemTemplateRequest$definition": "<p>The <code>DefinitionDocument</code> that contains the updated system definition.</p>", 107 "UploadEntityDefinitionsRequest$document": "<p>The <code>DefinitionDocument</code> that defines the updated entities.</p>" 108 } 109 }, 110 "DefinitionLanguage": { 111 "base": null, 112 "refs": { 113 "DefinitionDocument$language": "<p>The language used to define the entity. <code>GRAPHQL</code> is the only valid value.</p>" 114 } 115 }, 116 "DefinitionText": { 117 "base": null, 118 "refs": { 119 "DefinitionDocument$text": "<p>The GraphQL text that defines the entity.</p>" 120 } 121 }, 122 "DeleteFlowTemplateRequest": { 123 "base": null, 124 "refs": { 125 } 126 }, 127 "DeleteFlowTemplateResponse": { 128 "base": null, 129 "refs": { 130 } 131 }, 132 "DeleteNamespaceRequest": { 133 "base": null, 134 "refs": { 135 } 136 }, 137 "DeleteNamespaceResponse": { 138 "base": null, 139 "refs": { 140 } 141 }, 142 "DeleteSystemInstanceRequest": { 143 "base": null, 144 "refs": { 145 } 146 }, 147 "DeleteSystemInstanceResponse": { 148 "base": null, 149 "refs": { 150 } 151 }, 152 "DeleteSystemTemplateRequest": { 153 "base": null, 154 "refs": { 155 } 156 }, 157 "DeleteSystemTemplateResponse": { 158 "base": null, 159 "refs": { 160 } 161 }, 162 "DependencyRevision": { 163 "base": "<p>An object that contains the ID and revision number of a workflow or system that is part of a deployment.</p>", 164 "refs": { 165 "DependencyRevisions$member": null 166 } 167 }, 168 "DependencyRevisions": { 169 "base": null, 170 "refs": { 171 "SystemInstanceDescription$validatedDependencyRevisions": "<p>A list of objects that contain all of the IDs and revision numbers of workflows and systems that are used in a system instance.</p>" 172 } 173 }, 174 "DeploySystemInstanceRequest": { 175 "base": null, 176 "refs": { 177 } 178 }, 179 "DeploySystemInstanceResponse": { 180 "base": null, 181 "refs": { 182 } 183 }, 184 "DeploymentTarget": { 185 "base": null, 186 "refs": { 187 "CreateSystemInstanceRequest$target": "<p>The target type of the deployment. Valid values are <code>GREENGRASS</code> and <code>CLOUD</code>.</p>", 188 "SystemInstanceSummary$target": "<p>The target of the system instance.</p>" 189 } 190 }, 191 "DeprecateExistingEntities": { 192 "base": null, 193 "refs": { 194 "UploadEntityDefinitionsRequest$deprecateExistingEntities": "<p>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.</p>" 195 } 196 }, 197 "DeprecateFlowTemplateRequest": { 198 "base": null, 199 "refs": { 200 } 201 }, 202 "DeprecateFlowTemplateResponse": { 203 "base": null, 204 "refs": { 205 } 206 }, 207 "DeprecateSystemTemplateRequest": { 208 "base": null, 209 "refs": { 210 } 211 }, 212 "DeprecateSystemTemplateResponse": { 213 "base": null, 214 "refs": { 215 } 216 }, 217 "DescribeNamespaceRequest": { 218 "base": null, 219 "refs": { 220 } 221 }, 222 "DescribeNamespaceResponse": { 223 "base": null, 224 "refs": { 225 } 226 }, 227 "DissociateEntityFromThingRequest": { 228 "base": null, 229 "refs": { 230 } 231 }, 232 "DissociateEntityFromThingResponse": { 233 "base": null, 234 "refs": { 235 } 236 }, 237 "Enabled": { 238 "base": null, 239 "refs": { 240 "MetricsConfiguration$cloudMetricEnabled": "<p>A Boolean that specifies whether cloud metrics are collected.</p>" 241 } 242 }, 243 "EntityDescription": { 244 "base": "<p>Describes the properties of an entity.</p>", 245 "refs": { 246 "EntityDescriptions$member": null 247 } 248 }, 249 "EntityDescriptions": { 250 "base": null, 251 "refs": { 252 "GetEntitiesResponse$descriptions": "<p>An array of descriptions for the specified entities.</p>", 253 "SearchEntitiesResponse$descriptions": "<p>An array of descriptions for each entity returned in the search result.</p>" 254 } 255 }, 256 "EntityFilter": { 257 "base": "<p>An object that filters an entity search. Multiple filters function as OR criteria in the search. For example a search that includes a <code>NAMESPACE</code> and a <code>REFERENCED_ENTITY_ID</code> filter searches for entities in the specified namespace that use the entity specified by the value of <code>REFERENCED_ENTITY_ID</code>.</p>", 258 "refs": { 259 "EntityFilters$member": null 260 } 261 }, 262 "EntityFilterName": { 263 "base": null, 264 "refs": { 265 "EntityFilter$name": "<p>The name of the entity search filter field. <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.</p>" 266 } 267 }, 268 "EntityFilterValue": { 269 "base": null, 270 "refs": { 271 "EntityFilterValues$member": null 272 } 273 }, 274 "EntityFilterValues": { 275 "base": null, 276 "refs": { 277 "EntityFilter$value": "<p>An array of string values for the search filter field. Multiple values function as AND criteria in the search.</p>" 278 } 279 }, 280 "EntityFilters": { 281 "base": null, 282 "refs": { 283 "SearchEntitiesRequest$filters": "<p>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.</p> <p>Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND criteria.</p>" 284 } 285 }, 286 "EntityType": { 287 "base": null, 288 "refs": { 289 "DissociateEntityFromThingRequest$entityType": "<p>The entity type from which to disassociate the thing.</p>", 290 "EntityDescription$type": "<p>The entity type.</p>", 291 "EntityTypes$member": null 292 } 293 }, 294 "EntityTypes": { 295 "base": null, 296 "refs": { 297 "SearchEntitiesRequest$entityTypes": "<p>The entity types for which to search.</p>" 298 } 299 }, 300 "ErrorMessage": { 301 "base": null, 302 "refs": { 303 "InternalFailureException$message": null, 304 "InvalidRequestException$message": null, 305 "LimitExceededException$message": null, 306 "ResourceAlreadyExistsException$message": null, 307 "ResourceInUseException$message": null, 308 "ResourceNotFoundException$message": null, 309 "ThrottlingException$message": null 310 } 311 }, 312 "FlowExecutionEventType": { 313 "base": null, 314 "refs": { 315 "FlowExecutionMessage$eventType": "<p>The type of flow event .</p>" 316 } 317 }, 318 "FlowExecutionId": { 319 "base": null, 320 "refs": { 321 "FlowExecutionSummary$flowExecutionId": "<p>The ID of the flow execution.</p>", 322 "ListFlowExecutionMessagesRequest$flowExecutionId": "<p>The ID of the flow execution.</p>", 323 "SearchFlowExecutionsRequest$flowExecutionId": "<p>The ID of a flow execution.</p>" 324 } 325 }, 326 "FlowExecutionMessage": { 327 "base": "<p>An object that contains information about a flow event.</p>", 328 "refs": { 329 "FlowExecutionMessages$member": null 330 } 331 }, 332 "FlowExecutionMessageId": { 333 "base": null, 334 "refs": { 335 "FlowExecutionMessage$messageId": "<p>The unique identifier of the message.</p>" 336 } 337 }, 338 "FlowExecutionMessagePayload": { 339 "base": null, 340 "refs": { 341 "FlowExecutionMessage$payload": "<p>A string containing information about the flow event.</p>" 342 } 343 }, 344 "FlowExecutionMessages": { 345 "base": null, 346 "refs": { 347 "ListFlowExecutionMessagesResponse$messages": "<p>A list of objects that contain information about events in the specified flow execution.</p>" 348 } 349 }, 350 "FlowExecutionStatus": { 351 "base": null, 352 "refs": { 353 "FlowExecutionSummary$status": "<p>The current status of the flow execution.</p>" 354 } 355 }, 356 "FlowExecutionSummaries": { 357 "base": null, 358 "refs": { 359 "SearchFlowExecutionsResponse$summaries": "<p>An array of objects that contain summary information about each workflow execution in the result set.</p>" 360 } 361 }, 362 "FlowExecutionSummary": { 363 "base": "<p>An object that contains summary information about a flow execution.</p>", 364 "refs": { 365 "FlowExecutionSummaries$member": null 366 } 367 }, 368 "FlowTemplateDescription": { 369 "base": "<p>An object that contains a workflow's definition and summary information.</p>", 370 "refs": { 371 "GetFlowTemplateResponse$description": "<p>The object that describes the specified workflow.</p>" 372 } 373 }, 374 "FlowTemplateFilter": { 375 "base": "<p>An object that filters a workflow search.</p>", 376 "refs": { 377 "FlowTemplateFilters$member": null 378 } 379 }, 380 "FlowTemplateFilterName": { 381 "base": null, 382 "refs": { 383 "FlowTemplateFilter$name": "<p>The name of the search filter field.</p>" 384 } 385 }, 386 "FlowTemplateFilterValue": { 387 "base": null, 388 "refs": { 389 "FlowTemplateFilterValues$member": null 390 } 391 }, 392 "FlowTemplateFilterValues": { 393 "base": null, 394 "refs": { 395 "FlowTemplateFilter$value": "<p>An array of string values for the search filter field. Multiple values function as AND criteria in the search.</p>" 396 } 397 }, 398 "FlowTemplateFilters": { 399 "base": null, 400 "refs": { 401 "SearchFlowTemplatesRequest$filters": "<p>An array of objects that limit the result set. The only valid filter is <code>DEVICE_MODEL_ID</code>.</p>" 402 } 403 }, 404 "FlowTemplateSummaries": { 405 "base": null, 406 "refs": { 407 "GetFlowTemplateRevisionsResponse$summaries": "<p>An array of objects that provide summary data about each revision.</p>", 408 "SearchFlowTemplatesResponse$summaries": "<p>An array of objects that contain summary information about each workflow in the result set.</p>" 409 } 410 }, 411 "FlowTemplateSummary": { 412 "base": "<p>An object that contains summary information about a workflow.</p>", 413 "refs": { 414 "CreateFlowTemplateResponse$summary": "<p>The summary object that describes the created workflow.</p>", 415 "FlowTemplateDescription$summary": "<p>An object that contains summary information about a workflow.</p>", 416 "FlowTemplateSummaries$member": null, 417 "UpdateFlowTemplateResponse$summary": "<p>An object containing summary information about the updated workflow.</p>" 418 } 419 }, 420 "GetEntitiesRequest": { 421 "base": null, 422 "refs": { 423 } 424 }, 425 "GetEntitiesResponse": { 426 "base": null, 427 "refs": { 428 } 429 }, 430 "GetFlowTemplateRequest": { 431 "base": null, 432 "refs": { 433 } 434 }, 435 "GetFlowTemplateResponse": { 436 "base": null, 437 "refs": { 438 } 439 }, 440 "GetFlowTemplateRevisionsRequest": { 441 "base": null, 442 "refs": { 443 } 444 }, 445 "GetFlowTemplateRevisionsResponse": { 446 "base": null, 447 "refs": { 448 } 449 }, 450 "GetNamespaceDeletionStatusRequest": { 451 "base": null, 452 "refs": { 453 } 454 }, 455 "GetNamespaceDeletionStatusResponse": { 456 "base": null, 457 "refs": { 458 } 459 }, 460 "GetSystemInstanceRequest": { 461 "base": null, 462 "refs": { 463 } 464 }, 465 "GetSystemInstanceResponse": { 466 "base": null, 467 "refs": { 468 } 469 }, 470 "GetSystemTemplateRequest": { 471 "base": null, 472 "refs": { 473 } 474 }, 475 "GetSystemTemplateResponse": { 476 "base": null, 477 "refs": { 478 } 479 }, 480 "GetSystemTemplateRevisionsRequest": { 481 "base": null, 482 "refs": { 483 } 484 }, 485 "GetSystemTemplateRevisionsResponse": { 486 "base": null, 487 "refs": { 488 } 489 }, 490 "GetUploadStatusRequest": { 491 "base": null, 492 "refs": { 493 } 494 }, 495 "GetUploadStatusResponse": { 496 "base": null, 497 "refs": { 498 } 499 }, 500 "GreengrassDeploymentId": { 501 "base": null, 502 "refs": { 503 "DeploySystemInstanceResponse$greengrassDeploymentId": "<p>The ID of the Greengrass deployment used to deploy the system instance.</p>" 504 } 505 }, 506 "GreengrassGroupId": { 507 "base": null, 508 "refs": { 509 "SystemInstanceSummary$greengrassGroupId": "<p>The ID of the Greengrass group where the system instance is deployed.</p>" 510 } 511 }, 512 "GreengrassGroupVersionId": { 513 "base": null, 514 "refs": { 515 "SystemInstanceSummary$greengrassGroupVersionId": "<p>The version of the Greengrass group where the system instance is deployed.</p>" 516 } 517 }, 518 "GroupName": { 519 "base": null, 520 "refs": { 521 "CreateSystemInstanceRequest$greengrassGroupName": "<p>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>.</p>", 522 "SystemInstanceSummary$greengrassGroupName": "<p>The ID of the Greengrass group where the system instance is deployed.</p>" 523 } 524 }, 525 "InternalFailureException": { 526 "base": "<p/>", 527 "refs": { 528 } 529 }, 530 "InvalidRequestException": { 531 "base": "<p/>", 532 "refs": { 533 } 534 }, 535 "LimitExceededException": { 536 "base": "<p/>", 537 "refs": { 538 } 539 }, 540 "ListFlowExecutionMessagesRequest": { 541 "base": null, 542 "refs": { 543 } 544 }, 545 "ListFlowExecutionMessagesResponse": { 546 "base": null, 547 "refs": { 548 } 549 }, 550 "ListTagsForResourceRequest": { 551 "base": null, 552 "refs": { 553 } 554 }, 555 "ListTagsForResourceResponse": { 556 "base": null, 557 "refs": { 558 } 559 }, 560 "MaxResults": { 561 "base": null, 562 "refs": { 563 "GetFlowTemplateRevisionsRequest$maxResults": "<p>The maximum number of results to return in the response.</p>", 564 "GetSystemTemplateRevisionsRequest$maxResults": "<p>The maximum number of results to return in the response.</p>", 565 "ListFlowExecutionMessagesRequest$maxResults": "<p>The maximum number of results to return in the response.</p>", 566 "ListTagsForResourceRequest$maxResults": "<p>The maximum number of tags to return.</p>", 567 "SearchEntitiesRequest$maxResults": "<p>The maximum number of results to return in the response.</p>", 568 "SearchFlowExecutionsRequest$maxResults": "<p>The maximum number of results to return in the response.</p>", 569 "SearchFlowTemplatesRequest$maxResults": "<p>The maximum number of results to return in the response.</p>", 570 "SearchSystemInstancesRequest$maxResults": "<p>The maximum number of results to return in the response.</p>", 571 "SearchSystemTemplatesRequest$maxResults": "<p>The maximum number of results to return in the response.</p>", 572 "SearchThingsRequest$maxResults": "<p>The maximum number of results to return in the response.</p>" 573 } 574 }, 575 "MetricsConfiguration": { 576 "base": "<p>An object that specifies whether cloud metrics are collected in a deployment and, if so, what role is used to collect metrics.</p>", 577 "refs": { 578 "CreateSystemInstanceRequest$metricsConfiguration": null, 579 "SystemInstanceDescription$metricsConfiguration": null 580 } 581 }, 582 "NamespaceDeletionStatus": { 583 "base": null, 584 "refs": { 585 "GetNamespaceDeletionStatusResponse$status": "<p>The status of the deletion request.</p>" 586 } 587 }, 588 "NamespaceDeletionStatusErrorCodes": { 589 "base": null, 590 "refs": { 591 "GetNamespaceDeletionStatusResponse$errorCode": "<p>An error code returned by the namespace deletion task.</p>" 592 } 593 }, 594 "NamespaceName": { 595 "base": null, 596 "refs": { 597 "DeleteNamespaceResponse$namespaceName": "<p>The name of the namespace to be deleted.</p>", 598 "DescribeNamespaceRequest$namespaceName": "<p>The name of the user's namespace. Set this to <code>aws</code> to get the public namespace.</p>", 599 "DescribeNamespaceResponse$namespaceName": "<p>The name of the namespace.</p>", 600 "DescribeNamespaceResponse$trackingNamespaceName": "<p>The name of the public namespace that the latest namespace version is tracking.</p>", 601 "GetNamespaceDeletionStatusResponse$namespaceName": "<p>The name of the namespace that is being deleted.</p>", 602 "GetUploadStatusResponse$namespaceName": "<p>The name of the upload's namespace.</p>" 603 } 604 }, 605 "NextToken": { 606 "base": null, 607 "refs": { 608 "GetFlowTemplateRevisionsRequest$nextToken": "<p>The string that specifies the next page of results. Use this when you're paginating results.</p>", 609 "GetFlowTemplateRevisionsResponse$nextToken": "<p>The string to specify as <code>nextToken</code> when you request the next page of results.</p>", 610 "GetSystemTemplateRevisionsRequest$nextToken": "<p>The string that specifies the next page of results. Use this when you're paginating results.</p>", 611 "GetSystemTemplateRevisionsResponse$nextToken": "<p>The string to specify as <code>nextToken</code> when you request the next page of results. </p>", 612 "ListFlowExecutionMessagesRequest$nextToken": "<p>The string that specifies the next page of results. Use this when you're paginating results.</p>", 613 "ListFlowExecutionMessagesResponse$nextToken": "<p>The string to specify as <code>nextToken</code> when you request the next page of results. </p>", 614 "ListTagsForResourceRequest$nextToken": "<p>The token that specifies the next page of results to return.</p>", 615 "ListTagsForResourceResponse$nextToken": "<p>The token that specifies the next page of results to return.</p>", 616 "SearchEntitiesRequest$nextToken": "<p>The string that specifies the next page of results. Use this when you're paginating results.</p>", 617 "SearchEntitiesResponse$nextToken": "<p>The string to specify as <code>nextToken</code> when you request the next page of results.</p>", 618 "SearchFlowExecutionsRequest$nextToken": "<p>The string that specifies the next page of results. Use this when you're paginating results.</p>", 619 "SearchFlowExecutionsResponse$nextToken": "<p>The string to specify as <code>nextToken</code> when you request the next page of results.</p>", 620 "SearchFlowTemplatesRequest$nextToken": "<p>The string that specifies the next page of results. Use this when you're paginating results.</p>", 621 "SearchFlowTemplatesResponse$nextToken": "<p>The string to specify as <code>nextToken</code> when you request the next page of results.</p>", 622 "SearchSystemInstancesRequest$nextToken": "<p>The string that specifies the next page of results. Use this when you're paginating results.</p>", 623 "SearchSystemInstancesResponse$nextToken": "<p>The string to specify as <code>nextToken</code> when you request the next page of results. </p>", 624 "SearchSystemTemplatesRequest$nextToken": "<p>The string that specifies the next page of results. Use this when you're paginating results.</p>", 625 "SearchSystemTemplatesResponse$nextToken": "<p>The string to specify as <code>nextToken</code> when you request the next page of results.</p>", 626 "SearchThingsRequest$nextToken": "<p>The string that specifies the next page of results. Use this when you're paginating results.</p>", 627 "SearchThingsResponse$nextToken": "<p>The string to specify as <code>nextToken</code> when you request the next page of results.</p>" 628 } 629 }, 630 "ResourceAlreadyExistsException": { 631 "base": "<p/>", 632 "refs": { 633 } 634 }, 635 "ResourceArn": { 636 "base": null, 637 "refs": { 638 "ListTagsForResourceRequest$resourceArn": "<p>The Amazon Resource Name (ARN) of the resource whose tags are to be returned.</p>", 639 "TagResourceRequest$resourceArn": "<p>The Amazon Resource Name (ARN) of the resource whose tags are returned.</p>", 640 "UntagResourceRequest$resourceArn": "<p>The Amazon Resource Name (ARN) of the resource whose tags are to be removed.</p>" 641 } 642 }, 643 "ResourceInUseException": { 644 "base": "<p/>", 645 "refs": { 646 } 647 }, 648 "ResourceNotFoundException": { 649 "base": "<p/>", 650 "refs": { 651 } 652 }, 653 "RoleArn": { 654 "base": null, 655 "refs": { 656 "CreateSystemInstanceRequest$flowActionsRoleArn": "<p>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>.</p>", 657 "MetricsConfiguration$metricRuleRoleArn": "<p>The ARN of the role that is used to collect cloud metrics.</p>", 658 "SystemInstanceDescription$flowActionsRoleArn": "<p>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.</p>" 659 } 660 }, 661 "S3BucketName": { 662 "base": null, 663 "refs": { 664 "CreateSystemInstanceRequest$s3BucketName": "<p>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>.</p>", 665 "SystemInstanceDescription$s3BucketName": "<p>The Amazon Simple Storage Service bucket where information about a system instance is stored.</p>" 666 } 667 }, 668 "SearchEntitiesRequest": { 669 "base": null, 670 "refs": { 671 } 672 }, 673 "SearchEntitiesResponse": { 674 "base": null, 675 "refs": { 676 } 677 }, 678 "SearchFlowExecutionsRequest": { 679 "base": null, 680 "refs": { 681 } 682 }, 683 "SearchFlowExecutionsResponse": { 684 "base": null, 685 "refs": { 686 } 687 }, 688 "SearchFlowTemplatesRequest": { 689 "base": null, 690 "refs": { 691 } 692 }, 693 "SearchFlowTemplatesResponse": { 694 "base": null, 695 "refs": { 696 } 697 }, 698 "SearchSystemInstancesRequest": { 699 "base": null, 700 "refs": { 701 } 702 }, 703 "SearchSystemInstancesResponse": { 704 "base": null, 705 "refs": { 706 } 707 }, 708 "SearchSystemTemplatesRequest": { 709 "base": null, 710 "refs": { 711 } 712 }, 713 "SearchSystemTemplatesResponse": { 714 "base": null, 715 "refs": { 716 } 717 }, 718 "SearchThingsRequest": { 719 "base": null, 720 "refs": { 721 } 722 }, 723 "SearchThingsResponse": { 724 "base": null, 725 "refs": { 726 } 727 }, 728 "String": { 729 "base": null, 730 "refs": { 731 "GetNamespaceDeletionStatusResponse$errorMessage": "<p>An error code returned by the namespace deletion task.</p>", 732 "StringList$member": null 733 } 734 }, 735 "StringList": { 736 "base": null, 737 "refs": { 738 "GetUploadStatusResponse$failureReason": "<p>The reason for an upload failure.</p>" 739 } 740 }, 741 "SyncWithPublicNamespace": { 742 "base": null, 743 "refs": { 744 "UploadEntityDefinitionsRequest$syncWithPublicNamespace": "<p>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.</p>" 745 } 746 }, 747 "SystemInstanceDeploymentStatus": { 748 "base": null, 749 "refs": { 750 "SystemInstanceSummary$status": "<p>The status of the system instance.</p>" 751 } 752 }, 753 "SystemInstanceDescription": { 754 "base": "<p>An object that contains a system instance definition and summary information.</p>", 755 "refs": { 756 "GetSystemInstanceResponse$description": "<p>An object that describes the system instance.</p>" 757 } 758 }, 759 "SystemInstanceFilter": { 760 "base": "<p>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.</p>", 761 "refs": { 762 "SystemInstanceFilters$member": null 763 } 764 }, 765 "SystemInstanceFilterName": { 766 "base": null, 767 "refs": { 768 "SystemInstanceFilter$name": "<p>The name of the search filter field.</p>" 769 } 770 }, 771 "SystemInstanceFilterValue": { 772 "base": null, 773 "refs": { 774 "SystemInstanceFilterValues$member": null 775 } 776 }, 777 "SystemInstanceFilterValues": { 778 "base": null, 779 "refs": { 780 "SystemInstanceFilter$value": "<p>An array of string values for the search filter field. Multiple values function as AND criteria in the search. </p>" 781 } 782 }, 783 "SystemInstanceFilters": { 784 "base": null, 785 "refs": { 786 "SearchSystemInstancesRequest$filters": "<p>Optional filter to apply to the search. Valid filters are <code>SYSTEM_TEMPLATE_ID</code>, <code>STATUS</code>, and <code>GREENGRASS_GROUP_NAME</code>.</p> <p>Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND criteria.</p>" 787 } 788 }, 789 "SystemInstanceSummaries": { 790 "base": null, 791 "refs": { 792 "SearchSystemInstancesResponse$summaries": "<p>An array of objects that contain summary data abour the system instances in the result set.</p>" 793 } 794 }, 795 "SystemInstanceSummary": { 796 "base": "<p>An object that contains summary information about a system instance.</p>", 797 "refs": { 798 "CreateSystemInstanceResponse$summary": "<p>The summary object that describes the new system instance.</p>", 799 "DeploySystemInstanceResponse$summary": "<p>An object that contains summary information about a system instance that was deployed. </p>", 800 "SystemInstanceDescription$summary": "<p>An object that contains summary information about a system instance.</p>", 801 "SystemInstanceSummaries$member": null, 802 "UndeploySystemInstanceResponse$summary": "<p>An object that contains summary information about the system instance that was removed from its target.</p>" 803 } 804 }, 805 "SystemTemplateDescription": { 806 "base": "<p>An object that contains a system's definition document and summary information.</p>", 807 "refs": { 808 "GetSystemTemplateResponse$description": "<p>An object that contains summary data about the system.</p>" 809 } 810 }, 811 "SystemTemplateFilter": { 812 "base": "<p>An object that filters a system search.</p>", 813 "refs": { 814 "SystemTemplateFilters$member": null 815 } 816 }, 817 "SystemTemplateFilterName": { 818 "base": null, 819 "refs": { 820 "SystemTemplateFilter$name": "<p>The name of the system search filter field.</p>" 821 } 822 }, 823 "SystemTemplateFilterValue": { 824 "base": null, 825 "refs": { 826 "SystemTemplateFilterValues$member": null 827 } 828 }, 829 "SystemTemplateFilterValues": { 830 "base": null, 831 "refs": { 832 "SystemTemplateFilter$value": "<p>An array of string values for the search filter field. Multiple values function as AND criteria in the search.</p>" 833 } 834 }, 835 "SystemTemplateFilters": { 836 "base": null, 837 "refs": { 838 "SearchSystemTemplatesRequest$filters": "<p>An array of filters that limit the result set. The only valid filter is <code>FLOW_TEMPLATE_ID</code>.</p>" 839 } 840 }, 841 "SystemTemplateSummaries": { 842 "base": null, 843 "refs": { 844 "GetSystemTemplateRevisionsResponse$summaries": "<p>An array of objects that contain summary data about the system template revisions.</p>", 845 "SearchSystemTemplatesResponse$summaries": "<p>An array of objects that contain summary information about each system deployment in the result set.</p>" 846 } 847 }, 848 "SystemTemplateSummary": { 849 "base": "<p>An object that contains information about a system.</p>", 850 "refs": { 851 "CreateSystemTemplateResponse$summary": "<p>The summary object that describes the created system.</p>", 852 "SystemTemplateDescription$summary": "<p>An object that contains summary information about a system.</p>", 853 "SystemTemplateSummaries$member": null, 854 "UpdateSystemTemplateResponse$summary": "<p>An object containing summary information about the updated system.</p>" 855 } 856 }, 857 "Tag": { 858 "base": "<p>Metadata assigned to an AWS IoT Things Graph resource consisting of a key-value pair.</p>", 859 "refs": { 860 "TagList$member": null 861 } 862 }, 863 "TagKey": { 864 "base": null, 865 "refs": { 866 "Tag$key": "<p>The required name of the tag. The string value can be from 1 to 128 Unicode characters in length.</p>", 867 "TagKeyList$member": null 868 } 869 }, 870 "TagKeyList": { 871 "base": null, 872 "refs": { 873 "UntagResourceRequest$tagKeys": "<p>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. </p> <p>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>. </p>" 874 } 875 }, 876 "TagList": { 877 "base": null, 878 "refs": { 879 "CreateSystemInstanceRequest$tags": "<p>Metadata, consisting of key-value pairs, that can be used to categorize your system instances.</p>", 880 "ListTagsForResourceResponse$tags": "<p>List of tags returned by the <code>ListTagsForResource</code> operation.</p>", 881 "TagResourceRequest$tags": "<p>A list of tags to add to the resource.></p>" 882 } 883 }, 884 "TagResourceRequest": { 885 "base": null, 886 "refs": { 887 } 888 }, 889 "TagResourceResponse": { 890 "base": null, 891 "refs": { 892 } 893 }, 894 "TagValue": { 895 "base": null, 896 "refs": { 897 "Tag$value": "<p>The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length.</p>" 898 } 899 }, 900 "Thing": { 901 "base": "<p>An AWS IoT thing.</p>", 902 "refs": { 903 "Things$member": null 904 } 905 }, 906 "ThingArn": { 907 "base": null, 908 "refs": { 909 "Thing$thingArn": "<p>The ARN of the thing.</p>" 910 } 911 }, 912 "ThingName": { 913 "base": null, 914 "refs": { 915 "AssociateEntityToThingRequest$thingName": "<p>The name of the thing to which the entity is to be associated.</p>", 916 "DissociateEntityFromThingRequest$thingName": "<p>The name of the thing to disassociate.</p>", 917 "Thing$thingName": "<p>The name of the thing.</p>" 918 } 919 }, 920 "Things": { 921 "base": null, 922 "refs": { 923 "SearchThingsResponse$things": "<p>An array of things in the result set.</p>" 924 } 925 }, 926 "ThrottlingException": { 927 "base": "<p/>", 928 "refs": { 929 } 930 }, 931 "Timestamp": { 932 "base": null, 933 "refs": { 934 "EntityDescription$createdAt": "<p>The time at which the entity was created.</p>", 935 "FlowExecutionMessage$timestamp": "<p>The date and time when the message was last updated.</p>", 936 "FlowExecutionSummary$createdAt": "<p>The date and time when the flow execution summary was created.</p>", 937 "FlowExecutionSummary$updatedAt": "<p>The date and time when the flow execution summary was last updated.</p>", 938 "FlowTemplateSummary$createdAt": "<p>The date when the workflow was created.</p>", 939 "GetUploadStatusResponse$createdDate": "<p>The date at which the upload was created.</p>", 940 "SearchFlowExecutionsRequest$startTime": "<p>The date and time of the earliest flow execution to return.</p>", 941 "SearchFlowExecutionsRequest$endTime": "<p>The date and time of the latest flow execution to return.</p>", 942 "SystemInstanceSummary$createdAt": "<p>The date when the system instance was created.</p>", 943 "SystemInstanceSummary$updatedAt": "<p> The date and time when the system instance was last updated.</p>", 944 "SystemTemplateSummary$createdAt": "<p>The date when the system was created.</p>" 945 } 946 }, 947 "UndeploySystemInstanceRequest": { 948 "base": null, 949 "refs": { 950 } 951 }, 952 "UndeploySystemInstanceResponse": { 953 "base": null, 954 "refs": { 955 } 956 }, 957 "UntagResourceRequest": { 958 "base": null, 959 "refs": { 960 } 961 }, 962 "UntagResourceResponse": { 963 "base": null, 964 "refs": { 965 } 966 }, 967 "UpdateFlowTemplateRequest": { 968 "base": null, 969 "refs": { 970 } 971 }, 972 "UpdateFlowTemplateResponse": { 973 "base": null, 974 "refs": { 975 } 976 }, 977 "UpdateSystemTemplateRequest": { 978 "base": null, 979 "refs": { 980 } 981 }, 982 "UpdateSystemTemplateResponse": { 983 "base": null, 984 "refs": { 985 } 986 }, 987 "UploadEntityDefinitionsRequest": { 988 "base": null, 989 "refs": { 990 } 991 }, 992 "UploadEntityDefinitionsResponse": { 993 "base": null, 994 "refs": { 995 } 996 }, 997 "UploadId": { 998 "base": null, 999 "refs": { 1000 "GetUploadStatusRequest$uploadId": "<p>The ID of the upload. This value is returned by the <code>UploadEntityDefinitions</code> action.</p>", 1001 "GetUploadStatusResponse$uploadId": "<p>The ID of the upload.</p>", 1002 "UploadEntityDefinitionsResponse$uploadId": "<p>The ID that specifies the upload action. You can use this to track the status of the upload.</p>" 1003 } 1004 }, 1005 "UploadStatus": { 1006 "base": null, 1007 "refs": { 1008 "GetUploadStatusResponse$uploadStatus": "<p>The status of the upload. The initial status is <code>IN_PROGRESS</code>. The response show all validation failures if the upload fails.</p>" 1009 } 1010 }, 1011 "Urn": { 1012 "base": null, 1013 "refs": { 1014 "AssociateEntityToThingRequest$entityId": "<p>The ID of the device to be associated with the thing.</p> <p>The ID should be in the following format.</p> <p> <code>urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME</code> </p>", 1015 "DeleteFlowTemplateRequest$id": "<p>The ID of the workflow to be deleted.</p> <p>The ID should be in the following format.</p> <p> <code>urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME</code> </p>", 1016 "DeleteSystemInstanceRequest$id": "<p>The ID of the system instance to be deleted.</p>", 1017 "DeleteSystemTemplateRequest$id": "<p>The ID of the system to be deleted.</p> <p>The ID should be in the following format.</p> <p> <code>urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME</code> </p>", 1018 "DependencyRevision$id": "<p>The ID of the workflow or system.</p>", 1019 "DeploySystemInstanceRequest$id": "<p>The ID of the system instance. This value is returned by the <code>CreateSystemInstance</code> action.</p> <p>The ID should be in the following format.</p> <p> <code>urn:tdm:REGION/ACCOUNT ID/default:deployment:DEPLOYMENTNAME</code> </p>", 1020 "DeprecateFlowTemplateRequest$id": "<p>The ID of the workflow to be deleted.</p> <p>The ID should be in the following format.</p> <p> <code>urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME</code> </p>", 1021 "DeprecateSystemTemplateRequest$id": "<p>The ID of the system to delete.</p> <p>The ID should be in the following format.</p> <p> <code>urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME</code> </p>", 1022 "EntityDescription$id": "<p>The entity ID.</p>", 1023 "FlowExecutionSummary$systemInstanceId": "<p>The ID of the system instance that contains the flow.</p>", 1024 "FlowExecutionSummary$flowTemplateId": "<p>The ID of the flow.</p>", 1025 "FlowTemplateSummary$id": "<p>The ID of the workflow.</p>", 1026 "GetFlowTemplateRequest$id": "<p>The ID of the workflow.</p> <p>The ID should be in the following format.</p> <p> <code>urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME</code> </p>", 1027 "GetFlowTemplateRevisionsRequest$id": "<p>The ID of the workflow.</p> <p>The ID should be in the following format.</p> <p> <code>urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME</code> </p>", 1028 "GetSystemInstanceRequest$id": "<p>The ID of the system deployment instance. This value is returned by <code>CreateSystemInstance</code>.</p> <p>The ID should be in the following format.</p> <p> <code>urn:tdm:REGION/ACCOUNT ID/default:deployment:DEPLOYMENTNAME</code> </p>", 1029 "GetSystemTemplateRequest$id": "<p>The ID of the system to get. This ID must be in the user's namespace.</p> <p>The ID should be in the following format.</p> <p> <code>urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME</code> </p>", 1030 "GetSystemTemplateRevisionsRequest$id": "<p>The ID of the system template.</p> <p>The ID should be in the following format.</p> <p> <code>urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME</code> </p>", 1031 "SearchFlowExecutionsRequest$systemInstanceId": "<p>The ID of the system instance that contains the flow.</p>", 1032 "SearchThingsRequest$entityId": "<p>The ID of the entity to which the things are associated.</p> <p>The IDs should be in the following format.</p> <p> <code>urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME</code> </p>", 1033 "SystemInstanceSummary$id": "<p>The ID of the system instance.</p>", 1034 "SystemTemplateSummary$id": "<p>The ID of the system.</p>", 1035 "UndeploySystemInstanceRequest$id": "<p>The ID of the system instance to remove from its target.</p>", 1036 "UpdateFlowTemplateRequest$id": "<p>The ID of the workflow to be updated.</p> <p>The ID should be in the following format.</p> <p> <code>urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME</code> </p>", 1037 "UpdateSystemTemplateRequest$id": "<p>The ID of the system to be updated.</p> <p>The ID should be in the following format.</p> <p> <code>urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME</code> </p>", 1038 "Urns$member": null 1039 } 1040 }, 1041 "Urns": { 1042 "base": null, 1043 "refs": { 1044 "GetEntitiesRequest$ids": "<p>An array of entity IDs.</p> <p>The IDs should be in the following format.</p> <p> <code>urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME</code> </p>" 1045 } 1046 }, 1047 "Version": { 1048 "base": null, 1049 "refs": { 1050 "AssociateEntityToThingRequest$namespaceVersion": "<p>The version of the user's namespace. Defaults to the latest version of the user's namespace.</p>", 1051 "CreateFlowTemplateRequest$compatibleNamespaceVersion": "<p>The namespace version in which the workflow is to be created.</p> <p>If no value is specified, the latest version is used by default.</p>", 1052 "CreateSystemTemplateRequest$compatibleNamespaceVersion": "<p>The namespace version in which the system is to be created.</p> <p>If no value is specified, the latest version is used by default.</p>", 1053 "DependencyRevision$revisionNumber": "<p>The revision number of the workflow or system.</p>", 1054 "DescribeNamespaceResponse$trackingNamespaceVersion": "<p>The version of the public namespace that the latest version is tracking.</p>", 1055 "DescribeNamespaceResponse$namespaceVersion": "<p>The version of the user's namespace to describe.</p>", 1056 "FlowTemplateDescription$validatedNamespaceVersion": "<p>The version of the user's namespace against which the workflow was validated. Use this value in your system instance.</p>", 1057 "FlowTemplateSummary$revisionNumber": "<p>The revision number of the workflow.</p>", 1058 "GetEntitiesRequest$namespaceVersion": "<p>The version of the user's namespace. Defaults to the latest version of the user's namespace.</p>", 1059 "GetFlowTemplateRequest$revisionNumber": "<p>The number of the workflow revision to retrieve.</p>", 1060 "GetSystemTemplateRequest$revisionNumber": "<p>The number that specifies the revision of the system to get.</p>", 1061 "GetUploadStatusResponse$namespaceVersion": "<p>The version of the user's namespace. Defaults to the latest version of the user's namespace.</p>", 1062 "SearchEntitiesRequest$namespaceVersion": "<p>The version of the user's namespace. Defaults to the latest version of the user's namespace.</p>", 1063 "SearchThingsRequest$namespaceVersion": "<p>The version of the user's namespace. Defaults to the latest version of the user's namespace.</p>", 1064 "SystemInstanceDescription$validatedNamespaceVersion": "<p>The version of the user's namespace against which the system instance was validated.</p>", 1065 "SystemTemplateDescription$validatedNamespaceVersion": "<p>The namespace version against which the system was validated. Use this value in your system instance.</p>", 1066 "SystemTemplateSummary$revisionNumber": "<p>The revision number of the system.</p>", 1067 "UpdateFlowTemplateRequest$compatibleNamespaceVersion": "<p>The version of the user's namespace.</p> <p>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.</p>", 1068 "UpdateSystemTemplateRequest$compatibleNamespaceVersion": "<p>The version of the user's namespace. Defaults to the latest version of the user's namespace.</p> <p>If no value is specified, the latest version is used by default.</p>" 1069 } 1070 } 1071 } 1072 }