1{ 2 "version":"2.0", 3 "metadata":{ 4 "apiVersion":"2021-11-29", 5 "endpointPrefix":"iottwinmaker", 6 "jsonVersion":"1.1", 7 "protocol":"rest-json", 8 "serviceFullName":"AWS IoT TwinMaker", 9 "serviceId":"IoTTwinMaker", 10 "signatureVersion":"v4", 11 "signingName":"iottwinmaker", 12 "uid":"iottwinmaker-2021-11-29" 13 }, 14 "operations":{ 15 "BatchPutPropertyValues":{ 16 "name":"BatchPutPropertyValues", 17 "http":{ 18 "method":"POST", 19 "requestUri":"/workspaces/{workspaceId}/entity-properties", 20 "responseCode":200 21 }, 22 "input":{"shape":"BatchPutPropertyValuesRequest"}, 23 "output":{"shape":"BatchPutPropertyValuesResponse"}, 24 "errors":[ 25 {"shape":"InternalServerException"}, 26 {"shape":"ResourceNotFoundException"}, 27 {"shape":"ThrottlingException"}, 28 {"shape":"ValidationException"} 29 ], 30 "documentation":"<p>Sets values for multiple time series properties.</p>", 31 "endpoint":{"hostPrefix":"data."} 32 }, 33 "CancelMetadataTransferJob":{ 34 "name":"CancelMetadataTransferJob", 35 "http":{ 36 "method":"PUT", 37 "requestUri":"/metadata-transfer-jobs/{metadataTransferJobId}/cancel", 38 "responseCode":200 39 }, 40 "input":{"shape":"CancelMetadataTransferJobRequest"}, 41 "output":{"shape":"CancelMetadataTransferJobResponse"}, 42 "errors":[ 43 {"shape":"InternalServerException"}, 44 {"shape":"AccessDeniedException"}, 45 {"shape":"ResourceNotFoundException"}, 46 {"shape":"ThrottlingException"}, 47 {"shape":"ValidationException"}, 48 {"shape":"ConflictException"} 49 ], 50 "documentation":"<p>Cancels the metadata transfer job.</p>", 51 "endpoint":{"hostPrefix":"api."} 52 }, 53 "CreateComponentType":{ 54 "name":"CreateComponentType", 55 "http":{ 56 "method":"POST", 57 "requestUri":"/workspaces/{workspaceId}/component-types/{componentTypeId}", 58 "responseCode":200 59 }, 60 "input":{"shape":"CreateComponentTypeRequest"}, 61 "output":{"shape":"CreateComponentTypeResponse"}, 62 "errors":[ 63 {"shape":"InternalServerException"}, 64 {"shape":"AccessDeniedException"}, 65 {"shape":"ThrottlingException"}, 66 {"shape":"ValidationException"}, 67 {"shape":"ConflictException"}, 68 {"shape":"ServiceQuotaExceededException"} 69 ], 70 "documentation":"<p>Creates a component type.</p>", 71 "endpoint":{"hostPrefix":"api."} 72 }, 73 "CreateEntity":{ 74 "name":"CreateEntity", 75 "http":{ 76 "method":"POST", 77 "requestUri":"/workspaces/{workspaceId}/entities", 78 "responseCode":200 79 }, 80 "input":{"shape":"CreateEntityRequest"}, 81 "output":{"shape":"CreateEntityResponse"}, 82 "errors":[ 83 {"shape":"InternalServerException"}, 84 {"shape":"AccessDeniedException"}, 85 {"shape":"ThrottlingException"}, 86 {"shape":"ValidationException"}, 87 {"shape":"ConflictException"}, 88 {"shape":"ServiceQuotaExceededException"} 89 ], 90 "documentation":"<p>Creates an entity.</p>", 91 "endpoint":{"hostPrefix":"api."} 92 }, 93 "CreateMetadataTransferJob":{ 94 "name":"CreateMetadataTransferJob", 95 "http":{ 96 "method":"POST", 97 "requestUri":"/metadata-transfer-jobs", 98 "responseCode":200 99 }, 100 "input":{"shape":"CreateMetadataTransferJobRequest"}, 101 "output":{"shape":"CreateMetadataTransferJobResponse"}, 102 "errors":[ 103 {"shape":"InternalServerException"}, 104 {"shape":"AccessDeniedException"}, 105 {"shape":"ResourceNotFoundException"}, 106 {"shape":"ThrottlingException"}, 107 {"shape":"ValidationException"}, 108 {"shape":"ConflictException"}, 109 {"shape":"ServiceQuotaExceededException"} 110 ], 111 "documentation":"<p>Creates a new metadata transfer job.</p>", 112 "endpoint":{"hostPrefix":"api."} 113 }, 114 "CreateScene":{ 115 "name":"CreateScene", 116 "http":{ 117 "method":"POST", 118 "requestUri":"/workspaces/{workspaceId}/scenes", 119 "responseCode":200 120 }, 121 "input":{"shape":"CreateSceneRequest"}, 122 "output":{"shape":"CreateSceneResponse"}, 123 "errors":[ 124 {"shape":"InternalServerException"}, 125 {"shape":"AccessDeniedException"}, 126 {"shape":"ThrottlingException"}, 127 {"shape":"ValidationException"}, 128 {"shape":"ConflictException"}, 129 {"shape":"ServiceQuotaExceededException"} 130 ], 131 "documentation":"<p>Creates a scene.</p>", 132 "endpoint":{"hostPrefix":"api."} 133 }, 134 "CreateSyncJob":{ 135 "name":"CreateSyncJob", 136 "http":{ 137 "method":"POST", 138 "requestUri":"/workspaces/{workspaceId}/sync-jobs/{syncSource}", 139 "responseCode":200 140 }, 141 "input":{"shape":"CreateSyncJobRequest"}, 142 "output":{"shape":"CreateSyncJobResponse"}, 143 "errors":[ 144 {"shape":"InternalServerException"}, 145 {"shape":"AccessDeniedException"}, 146 {"shape":"ThrottlingException"}, 147 {"shape":"ValidationException"}, 148 {"shape":"ConflictException"}, 149 {"shape":"ServiceQuotaExceededException"} 150 ], 151 "documentation":"<p>This action creates a SyncJob.</p>", 152 "endpoint":{"hostPrefix":"api."} 153 }, 154 "CreateWorkspace":{ 155 "name":"CreateWorkspace", 156 "http":{ 157 "method":"POST", 158 "requestUri":"/workspaces/{workspaceId}", 159 "responseCode":200 160 }, 161 "input":{"shape":"CreateWorkspaceRequest"}, 162 "output":{"shape":"CreateWorkspaceResponse"}, 163 "errors":[ 164 {"shape":"InternalServerException"}, 165 {"shape":"AccessDeniedException"}, 166 {"shape":"ThrottlingException"}, 167 {"shape":"ValidationException"}, 168 {"shape":"ConflictException"}, 169 {"shape":"ServiceQuotaExceededException"} 170 ], 171 "documentation":"<p>Creates a workplace.</p>", 172 "endpoint":{"hostPrefix":"api."} 173 }, 174 "DeleteComponentType":{ 175 "name":"DeleteComponentType", 176 "http":{ 177 "method":"DELETE", 178 "requestUri":"/workspaces/{workspaceId}/component-types/{componentTypeId}", 179 "responseCode":200 180 }, 181 "input":{"shape":"DeleteComponentTypeRequest"}, 182 "output":{"shape":"DeleteComponentTypeResponse"}, 183 "errors":[ 184 {"shape":"InternalServerException"}, 185 {"shape":"AccessDeniedException"}, 186 {"shape":"ResourceNotFoundException"}, 187 {"shape":"ThrottlingException"}, 188 {"shape":"ValidationException"} 189 ], 190 "documentation":"<p>Deletes a component type.</p>", 191 "endpoint":{"hostPrefix":"api."} 192 }, 193 "DeleteEntity":{ 194 "name":"DeleteEntity", 195 "http":{ 196 "method":"DELETE", 197 "requestUri":"/workspaces/{workspaceId}/entities/{entityId}", 198 "responseCode":200 199 }, 200 "input":{"shape":"DeleteEntityRequest"}, 201 "output":{"shape":"DeleteEntityResponse"}, 202 "errors":[ 203 {"shape":"InternalServerException"}, 204 {"shape":"ResourceNotFoundException"}, 205 {"shape":"ThrottlingException"}, 206 {"shape":"ValidationException"}, 207 {"shape":"ServiceQuotaExceededException"} 208 ], 209 "documentation":"<p>Deletes an entity.</p>", 210 "endpoint":{"hostPrefix":"api."} 211 }, 212 "DeleteScene":{ 213 "name":"DeleteScene", 214 "http":{ 215 "method":"DELETE", 216 "requestUri":"/workspaces/{workspaceId}/scenes/{sceneId}", 217 "responseCode":200 218 }, 219 "input":{"shape":"DeleteSceneRequest"}, 220 "output":{"shape":"DeleteSceneResponse"}, 221 "errors":[ 222 {"shape":"InternalServerException"}, 223 {"shape":"AccessDeniedException"}, 224 {"shape":"ResourceNotFoundException"}, 225 {"shape":"ThrottlingException"}, 226 {"shape":"ValidationException"} 227 ], 228 "documentation":"<p>Deletes a scene.</p>", 229 "endpoint":{"hostPrefix":"api."} 230 }, 231 "DeleteSyncJob":{ 232 "name":"DeleteSyncJob", 233 "http":{ 234 "method":"DELETE", 235 "requestUri":"/workspaces/{workspaceId}/sync-jobs/{syncSource}", 236 "responseCode":200 237 }, 238 "input":{"shape":"DeleteSyncJobRequest"}, 239 "output":{"shape":"DeleteSyncJobResponse"}, 240 "errors":[ 241 {"shape":"InternalServerException"}, 242 {"shape":"AccessDeniedException"}, 243 {"shape":"ResourceNotFoundException"}, 244 {"shape":"ThrottlingException"}, 245 {"shape":"ValidationException"}, 246 {"shape":"ServiceQuotaExceededException"} 247 ], 248 "documentation":"<p>Delete the SyncJob.</p>", 249 "endpoint":{"hostPrefix":"api."} 250 }, 251 "DeleteWorkspace":{ 252 "name":"DeleteWorkspace", 253 "http":{ 254 "method":"DELETE", 255 "requestUri":"/workspaces/{workspaceId}", 256 "responseCode":200 257 }, 258 "input":{"shape":"DeleteWorkspaceRequest"}, 259 "output":{"shape":"DeleteWorkspaceResponse"}, 260 "errors":[ 261 {"shape":"InternalServerException"}, 262 {"shape":"AccessDeniedException"}, 263 {"shape":"ResourceNotFoundException"}, 264 {"shape":"ThrottlingException"}, 265 {"shape":"ValidationException"} 266 ], 267 "documentation":"<p>Deletes a workspace.</p>", 268 "endpoint":{"hostPrefix":"api."} 269 }, 270 "ExecuteQuery":{ 271 "name":"ExecuteQuery", 272 "http":{ 273 "method":"POST", 274 "requestUri":"/queries/execution", 275 "responseCode":200 276 }, 277 "input":{"shape":"ExecuteQueryRequest"}, 278 "output":{"shape":"ExecuteQueryResponse"}, 279 "errors":[ 280 {"shape":"InternalServerException"}, 281 {"shape":"AccessDeniedException"}, 282 {"shape":"QueryTimeoutException"}, 283 {"shape":"ThrottlingException"}, 284 {"shape":"ValidationException"}, 285 {"shape":"ServiceQuotaExceededException"} 286 ], 287 "documentation":"<p>Run queries to access information from your knowledge graph of entities within individual workspaces.</p> <note> <p>The ExecuteQuery action only works with <a href=\"https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/home.html\">Amazon Web Services Java SDK2</a>. ExecuteQuery will not work with any Amazon Web Services Java SDK version < 2.x.</p> </note>", 288 "endpoint":{"hostPrefix":"api."} 289 }, 290 "GetComponentType":{ 291 "name":"GetComponentType", 292 "http":{ 293 "method":"GET", 294 "requestUri":"/workspaces/{workspaceId}/component-types/{componentTypeId}", 295 "responseCode":200 296 }, 297 "input":{"shape":"GetComponentTypeRequest"}, 298 "output":{"shape":"GetComponentTypeResponse"}, 299 "errors":[ 300 {"shape":"InternalServerException"}, 301 {"shape":"AccessDeniedException"}, 302 {"shape":"ResourceNotFoundException"}, 303 {"shape":"ThrottlingException"}, 304 {"shape":"ValidationException"} 305 ], 306 "documentation":"<p>Retrieves information about a component type.</p>", 307 "endpoint":{"hostPrefix":"api."} 308 }, 309 "GetEntity":{ 310 "name":"GetEntity", 311 "http":{ 312 "method":"GET", 313 "requestUri":"/workspaces/{workspaceId}/entities/{entityId}", 314 "responseCode":200 315 }, 316 "input":{"shape":"GetEntityRequest"}, 317 "output":{"shape":"GetEntityResponse"}, 318 "errors":[ 319 {"shape":"InternalServerException"}, 320 {"shape":"ResourceNotFoundException"}, 321 {"shape":"ThrottlingException"}, 322 {"shape":"ValidationException"}, 323 {"shape":"ServiceQuotaExceededException"} 324 ], 325 "documentation":"<p>Retrieves information about an entity.</p>", 326 "endpoint":{"hostPrefix":"api."} 327 }, 328 "GetMetadataTransferJob":{ 329 "name":"GetMetadataTransferJob", 330 "http":{ 331 "method":"GET", 332 "requestUri":"/metadata-transfer-jobs/{metadataTransferJobId}", 333 "responseCode":200 334 }, 335 "input":{"shape":"GetMetadataTransferJobRequest"}, 336 "output":{"shape":"GetMetadataTransferJobResponse"}, 337 "errors":[ 338 {"shape":"InternalServerException"}, 339 {"shape":"AccessDeniedException"}, 340 {"shape":"ResourceNotFoundException"}, 341 {"shape":"ThrottlingException"}, 342 {"shape":"ValidationException"} 343 ], 344 "documentation":"<p>Gets a nmetadata transfer job.</p>", 345 "endpoint":{"hostPrefix":"api."} 346 }, 347 "GetPricingPlan":{ 348 "name":"GetPricingPlan", 349 "http":{ 350 "method":"GET", 351 "requestUri":"/pricingplan", 352 "responseCode":200 353 }, 354 "input":{"shape":"GetPricingPlanRequest"}, 355 "output":{"shape":"GetPricingPlanResponse"}, 356 "errors":[ 357 {"shape":"InternalServerException"}, 358 {"shape":"AccessDeniedException"}, 359 {"shape":"ThrottlingException"}, 360 {"shape":"ValidationException"} 361 ], 362 "documentation":"<p>Gets the pricing plan.</p>", 363 "endpoint":{"hostPrefix":"api."} 364 }, 365 "GetPropertyValue":{ 366 "name":"GetPropertyValue", 367 "http":{ 368 "method":"POST", 369 "requestUri":"/workspaces/{workspaceId}/entity-properties/value", 370 "responseCode":200 371 }, 372 "input":{"shape":"GetPropertyValueRequest"}, 373 "output":{"shape":"GetPropertyValueResponse"}, 374 "errors":[ 375 {"shape":"InternalServerException"}, 376 {"shape":"ConnectorFailureException"}, 377 {"shape":"AccessDeniedException"}, 378 {"shape":"ResourceNotFoundException"}, 379 {"shape":"ThrottlingException"}, 380 {"shape":"ValidationException"}, 381 {"shape":"ConnectorTimeoutException"} 382 ], 383 "documentation":"<p>Gets the property values for a component, component type, entity, or workspace.</p> <p>You must specify a value for either <code>componentName</code>, <code>componentTypeId</code>, <code>entityId</code>, or <code>workspaceId</code>.</p>", 384 "endpoint":{"hostPrefix":"data."} 385 }, 386 "GetPropertyValueHistory":{ 387 "name":"GetPropertyValueHistory", 388 "http":{ 389 "method":"POST", 390 "requestUri":"/workspaces/{workspaceId}/entity-properties/history", 391 "responseCode":200 392 }, 393 "input":{"shape":"GetPropertyValueHistoryRequest"}, 394 "output":{"shape":"GetPropertyValueHistoryResponse"}, 395 "errors":[ 396 {"shape":"InternalServerException"}, 397 {"shape":"ConnectorFailureException"}, 398 {"shape":"AccessDeniedException"}, 399 {"shape":"ResourceNotFoundException"}, 400 {"shape":"ThrottlingException"}, 401 {"shape":"ValidationException"}, 402 {"shape":"ConnectorTimeoutException"} 403 ], 404 "documentation":"<p>Retrieves information about the history of a time series property value for a component, component type, entity, or workspace.</p> <p>You must specify a value for <code>workspaceId</code>. For entity-specific queries, specify values for <code>componentName</code> and <code>entityId</code>. For cross-entity quries, specify a value for <code>componentTypeId</code>.</p>", 405 "endpoint":{"hostPrefix":"data."} 406 }, 407 "GetScene":{ 408 "name":"GetScene", 409 "http":{ 410 "method":"GET", 411 "requestUri":"/workspaces/{workspaceId}/scenes/{sceneId}", 412 "responseCode":200 413 }, 414 "input":{"shape":"GetSceneRequest"}, 415 "output":{"shape":"GetSceneResponse"}, 416 "errors":[ 417 {"shape":"InternalServerException"}, 418 {"shape":"AccessDeniedException"}, 419 {"shape":"ResourceNotFoundException"}, 420 {"shape":"ThrottlingException"}, 421 {"shape":"ValidationException"} 422 ], 423 "documentation":"<p>Retrieves information about a scene.</p>", 424 "endpoint":{"hostPrefix":"api."} 425 }, 426 "GetSyncJob":{ 427 "name":"GetSyncJob", 428 "http":{ 429 "method":"GET", 430 "requestUri":"/sync-jobs/{syncSource}", 431 "responseCode":200 432 }, 433 "input":{"shape":"GetSyncJobRequest"}, 434 "output":{"shape":"GetSyncJobResponse"}, 435 "errors":[ 436 {"shape":"InternalServerException"}, 437 {"shape":"AccessDeniedException"}, 438 {"shape":"ResourceNotFoundException"}, 439 {"shape":"ThrottlingException"}, 440 {"shape":"ValidationException"}, 441 {"shape":"ServiceQuotaExceededException"} 442 ], 443 "documentation":"<p>Gets the SyncJob.</p>", 444 "endpoint":{"hostPrefix":"api."} 445 }, 446 "GetWorkspace":{ 447 "name":"GetWorkspace", 448 "http":{ 449 "method":"GET", 450 "requestUri":"/workspaces/{workspaceId}", 451 "responseCode":200 452 }, 453 "input":{"shape":"GetWorkspaceRequest"}, 454 "output":{"shape":"GetWorkspaceResponse"}, 455 "errors":[ 456 {"shape":"InternalServerException"}, 457 {"shape":"ResourceNotFoundException"}, 458 {"shape":"ThrottlingException"}, 459 {"shape":"ValidationException"}, 460 {"shape":"ServiceQuotaExceededException"} 461 ], 462 "documentation":"<p>Retrieves information about a workspace.</p>", 463 "endpoint":{"hostPrefix":"api."} 464 }, 465 "ListComponentTypes":{ 466 "name":"ListComponentTypes", 467 "http":{ 468 "method":"POST", 469 "requestUri":"/workspaces/{workspaceId}/component-types-list", 470 "responseCode":200 471 }, 472 "input":{"shape":"ListComponentTypesRequest"}, 473 "output":{"shape":"ListComponentTypesResponse"}, 474 "errors":[ 475 {"shape":"InternalServerException"}, 476 {"shape":"AccessDeniedException"}, 477 {"shape":"ThrottlingException"}, 478 {"shape":"ValidationException"} 479 ], 480 "documentation":"<p>Lists all component types in a workspace.</p>", 481 "endpoint":{"hostPrefix":"api."} 482 }, 483 "ListComponents":{ 484 "name":"ListComponents", 485 "http":{ 486 "method":"POST", 487 "requestUri":"/workspaces/{workspaceId}/entities/{entityId}/components-list", 488 "responseCode":200 489 }, 490 "input":{"shape":"ListComponentsRequest"}, 491 "output":{"shape":"ListComponentsResponse"}, 492 "errors":[ 493 {"shape":"InternalServerException"}, 494 {"shape":"AccessDeniedException"}, 495 {"shape":"ResourceNotFoundException"}, 496 {"shape":"ThrottlingException"}, 497 {"shape":"ValidationException"} 498 ], 499 "documentation":"<p>This API lists the components of an entity.</p>", 500 "endpoint":{"hostPrefix":"api."} 501 }, 502 "ListEntities":{ 503 "name":"ListEntities", 504 "http":{ 505 "method":"POST", 506 "requestUri":"/workspaces/{workspaceId}/entities-list", 507 "responseCode":200 508 }, 509 "input":{"shape":"ListEntitiesRequest"}, 510 "output":{"shape":"ListEntitiesResponse"}, 511 "errors":[ 512 {"shape":"InternalServerException"}, 513 {"shape":"ThrottlingException"}, 514 {"shape":"ValidationException"}, 515 {"shape":"ServiceQuotaExceededException"} 516 ], 517 "documentation":"<p>Lists all entities in a workspace.</p>", 518 "endpoint":{"hostPrefix":"api."} 519 }, 520 "ListMetadataTransferJobs":{ 521 "name":"ListMetadataTransferJobs", 522 "http":{ 523 "method":"POST", 524 "requestUri":"/metadata-transfer-jobs-list", 525 "responseCode":200 526 }, 527 "input":{"shape":"ListMetadataTransferJobsRequest"}, 528 "output":{"shape":"ListMetadataTransferJobsResponse"}, 529 "errors":[ 530 {"shape":"InternalServerException"}, 531 {"shape":"AccessDeniedException"}, 532 {"shape":"ThrottlingException"}, 533 {"shape":"ValidationException"} 534 ], 535 "documentation":"<p>Lists the metadata transfer jobs.</p>", 536 "endpoint":{"hostPrefix":"api."} 537 }, 538 "ListProperties":{ 539 "name":"ListProperties", 540 "http":{ 541 "method":"POST", 542 "requestUri":"/workspaces/{workspaceId}/properties-list", 543 "responseCode":200 544 }, 545 "input":{"shape":"ListPropertiesRequest"}, 546 "output":{"shape":"ListPropertiesResponse"}, 547 "errors":[ 548 {"shape":"InternalServerException"}, 549 {"shape":"AccessDeniedException"}, 550 {"shape":"ResourceNotFoundException"}, 551 {"shape":"ThrottlingException"}, 552 {"shape":"ValidationException"} 553 ], 554 "documentation":"<p>This API lists the properties of a component.</p>", 555 "endpoint":{"hostPrefix":"api."} 556 }, 557 "ListScenes":{ 558 "name":"ListScenes", 559 "http":{ 560 "method":"POST", 561 "requestUri":"/workspaces/{workspaceId}/scenes-list", 562 "responseCode":200 563 }, 564 "input":{"shape":"ListScenesRequest"}, 565 "output":{"shape":"ListScenesResponse"}, 566 "errors":[ 567 {"shape":"InternalServerException"}, 568 {"shape":"AccessDeniedException"}, 569 {"shape":"ThrottlingException"}, 570 {"shape":"ValidationException"} 571 ], 572 "documentation":"<p>Lists all scenes in a workspace.</p>", 573 "endpoint":{"hostPrefix":"api."} 574 }, 575 "ListSyncJobs":{ 576 "name":"ListSyncJobs", 577 "http":{ 578 "method":"POST", 579 "requestUri":"/workspaces/{workspaceId}/sync-jobs-list", 580 "responseCode":200 581 }, 582 "input":{"shape":"ListSyncJobsRequest"}, 583 "output":{"shape":"ListSyncJobsResponse"}, 584 "errors":[ 585 {"shape":"InternalServerException"}, 586 {"shape":"AccessDeniedException"}, 587 {"shape":"ThrottlingException"}, 588 {"shape":"ValidationException"}, 589 {"shape":"ServiceQuotaExceededException"} 590 ], 591 "documentation":"<p>List all SyncJobs.</p>", 592 "endpoint":{"hostPrefix":"api."} 593 }, 594 "ListSyncResources":{ 595 "name":"ListSyncResources", 596 "http":{ 597 "method":"POST", 598 "requestUri":"/workspaces/{workspaceId}/sync-jobs/{syncSource}/resources-list", 599 "responseCode":200 600 }, 601 "input":{"shape":"ListSyncResourcesRequest"}, 602 "output":{"shape":"ListSyncResourcesResponse"}, 603 "errors":[ 604 {"shape":"InternalServerException"}, 605 {"shape":"AccessDeniedException"}, 606 {"shape":"ThrottlingException"}, 607 {"shape":"ValidationException"}, 608 {"shape":"ServiceQuotaExceededException"} 609 ], 610 "documentation":"<p>Lists the sync resources.</p>", 611 "endpoint":{"hostPrefix":"api."} 612 }, 613 "ListTagsForResource":{ 614 "name":"ListTagsForResource", 615 "http":{ 616 "method":"POST", 617 "requestUri":"/tags-list", 618 "responseCode":200 619 }, 620 "input":{"shape":"ListTagsForResourceRequest"}, 621 "output":{"shape":"ListTagsForResourceResponse"}, 622 "errors":[ 623 {"shape":"AccessDeniedException"}, 624 {"shape":"ResourceNotFoundException"} 625 ], 626 "documentation":"<p>Lists all tags associated with a resource.</p>", 627 "endpoint":{"hostPrefix":"api."} 628 }, 629 "ListWorkspaces":{ 630 "name":"ListWorkspaces", 631 "http":{ 632 "method":"POST", 633 "requestUri":"/workspaces-list", 634 "responseCode":200 635 }, 636 "input":{"shape":"ListWorkspacesRequest"}, 637 "output":{"shape":"ListWorkspacesResponse"}, 638 "errors":[ 639 {"shape":"InternalServerException"}, 640 {"shape":"ThrottlingException"}, 641 {"shape":"ValidationException"}, 642 {"shape":"ServiceQuotaExceededException"} 643 ], 644 "documentation":"<p>Retrieves information about workspaces in the current account.</p>", 645 "endpoint":{"hostPrefix":"api."} 646 }, 647 "TagResource":{ 648 "name":"TagResource", 649 "http":{ 650 "method":"POST", 651 "requestUri":"/tags", 652 "responseCode":200 653 }, 654 "input":{"shape":"TagResourceRequest"}, 655 "output":{"shape":"TagResourceResponse"}, 656 "errors":[ 657 {"shape":"TooManyTagsException"}, 658 {"shape":"AccessDeniedException"}, 659 {"shape":"ResourceNotFoundException"} 660 ], 661 "documentation":"<p>Adds tags to a resource.</p>", 662 "endpoint":{"hostPrefix":"api."} 663 }, 664 "UntagResource":{ 665 "name":"UntagResource", 666 "http":{ 667 "method":"DELETE", 668 "requestUri":"/tags", 669 "responseCode":200 670 }, 671 "input":{"shape":"UntagResourceRequest"}, 672 "output":{"shape":"UntagResourceResponse"}, 673 "errors":[ 674 {"shape":"AccessDeniedException"}, 675 {"shape":"ResourceNotFoundException"} 676 ], 677 "documentation":"<p>Removes tags from a resource.</p>", 678 "endpoint":{"hostPrefix":"api."} 679 }, 680 "UpdateComponentType":{ 681 "name":"UpdateComponentType", 682 "http":{ 683 "method":"PUT", 684 "requestUri":"/workspaces/{workspaceId}/component-types/{componentTypeId}", 685 "responseCode":200 686 }, 687 "input":{"shape":"UpdateComponentTypeRequest"}, 688 "output":{"shape":"UpdateComponentTypeResponse"}, 689 "errors":[ 690 {"shape":"InternalServerException"}, 691 {"shape":"AccessDeniedException"}, 692 {"shape":"ResourceNotFoundException"}, 693 {"shape":"ThrottlingException"}, 694 {"shape":"ValidationException"}, 695 {"shape":"ServiceQuotaExceededException"} 696 ], 697 "documentation":"<p>Updates information in a component type.</p>", 698 "endpoint":{"hostPrefix":"api."} 699 }, 700 "UpdateEntity":{ 701 "name":"UpdateEntity", 702 "http":{ 703 "method":"PUT", 704 "requestUri":"/workspaces/{workspaceId}/entities/{entityId}", 705 "responseCode":200 706 }, 707 "input":{"shape":"UpdateEntityRequest"}, 708 "output":{"shape":"UpdateEntityResponse"}, 709 "errors":[ 710 {"shape":"InternalServerException"}, 711 {"shape":"AccessDeniedException"}, 712 {"shape":"ResourceNotFoundException"}, 713 {"shape":"ThrottlingException"}, 714 {"shape":"ValidationException"}, 715 {"shape":"ConflictException"}, 716 {"shape":"ServiceQuotaExceededException"} 717 ], 718 "documentation":"<p>Updates an entity.</p>", 719 "endpoint":{"hostPrefix":"api."} 720 }, 721 "UpdatePricingPlan":{ 722 "name":"UpdatePricingPlan", 723 "http":{ 724 "method":"POST", 725 "requestUri":"/pricingplan", 726 "responseCode":200 727 }, 728 "input":{"shape":"UpdatePricingPlanRequest"}, 729 "output":{"shape":"UpdatePricingPlanResponse"}, 730 "errors":[ 731 {"shape":"InternalServerException"}, 732 {"shape":"AccessDeniedException"}, 733 {"shape":"ThrottlingException"}, 734 {"shape":"ValidationException"} 735 ], 736 "documentation":"<p>Update the pricing plan.</p>", 737 "endpoint":{"hostPrefix":"api."} 738 }, 739 "UpdateScene":{ 740 "name":"UpdateScene", 741 "http":{ 742 "method":"PUT", 743 "requestUri":"/workspaces/{workspaceId}/scenes/{sceneId}", 744 "responseCode":200 745 }, 746 "input":{"shape":"UpdateSceneRequest"}, 747 "output":{"shape":"UpdateSceneResponse"}, 748 "errors":[ 749 {"shape":"InternalServerException"}, 750 {"shape":"AccessDeniedException"}, 751 {"shape":"ResourceNotFoundException"}, 752 {"shape":"ThrottlingException"}, 753 {"shape":"ValidationException"} 754 ], 755 "documentation":"<p>Updates a scene.</p>", 756 "endpoint":{"hostPrefix":"api."} 757 }, 758 "UpdateWorkspace":{ 759 "name":"UpdateWorkspace", 760 "http":{ 761 "method":"PUT", 762 "requestUri":"/workspaces/{workspaceId}", 763 "responseCode":200 764 }, 765 "input":{"shape":"UpdateWorkspaceRequest"}, 766 "output":{"shape":"UpdateWorkspaceResponse"}, 767 "errors":[ 768 {"shape":"InternalServerException"}, 769 {"shape":"AccessDeniedException"}, 770 {"shape":"ResourceNotFoundException"}, 771 {"shape":"ThrottlingException"}, 772 {"shape":"ValidationException"}, 773 {"shape":"ServiceQuotaExceededException"} 774 ], 775 "documentation":"<p>Updates a workspace.</p>", 776 "endpoint":{"hostPrefix":"api."} 777 } 778 }, 779 "shapes":{ 780 "AccessDeniedException":{ 781 "type":"structure", 782 "members":{ 783 "message":{"shape":"ErrorMessage"} 784 }, 785 "documentation":"<p>Access is denied.</p>", 786 "error":{ 787 "httpStatusCode":403, 788 "senderFault":true 789 }, 790 "exception":true 791 }, 792 "BatchPutPropertyError":{ 793 "type":"structure", 794 "required":[ 795 "errorCode", 796 "errorMessage", 797 "entry" 798 ], 799 "members":{ 800 "errorCode":{ 801 "shape":"String", 802 "documentation":"<p>The error code.</p>" 803 }, 804 "errorMessage":{ 805 "shape":"String", 806 "documentation":"<p>The error message.</p>" 807 }, 808 "entry":{ 809 "shape":"PropertyValueEntry", 810 "documentation":"<p>An object that contains information about errors returned by the <code>BatchPutProperty</code> action.</p>" 811 } 812 }, 813 "documentation":"<p>An error returned by the <code>BatchPutProperty</code> action.</p>" 814 }, 815 "BatchPutPropertyErrorEntry":{ 816 "type":"structure", 817 "required":["errors"], 818 "members":{ 819 "errors":{ 820 "shape":"Errors", 821 "documentation":"<p>A list of objects that contain information about errors returned by the <code>BatchPutProperty</code> action.</p>" 822 } 823 }, 824 "documentation":"<p>An object that contains information about errors returned by the <code>BatchPutProperty</code> action.</p>" 825 }, 826 "BatchPutPropertyValuesRequest":{ 827 "type":"structure", 828 "required":[ 829 "workspaceId", 830 "entries" 831 ], 832 "members":{ 833 "workspaceId":{ 834 "shape":"Id", 835 "documentation":"<p>The ID of the workspace that contains the properties to set.</p>", 836 "location":"uri", 837 "locationName":"workspaceId" 838 }, 839 "entries":{ 840 "shape":"Entries", 841 "documentation":"<p>An object that maps strings to the property value entries to set. Each string in the mapping must be unique to this object.</p>" 842 } 843 } 844 }, 845 "BatchPutPropertyValuesResponse":{ 846 "type":"structure", 847 "required":["errorEntries"], 848 "members":{ 849 "errorEntries":{ 850 "shape":"ErrorEntries", 851 "documentation":"<p>Entries that caused errors in the batch put operation.</p>" 852 } 853 } 854 }, 855 "Boolean":{ 856 "type":"boolean", 857 "box":true 858 }, 859 "BundleInformation":{ 860 "type":"structure", 861 "required":["bundleNames"], 862 "members":{ 863 "bundleNames":{ 864 "shape":"PricingBundles", 865 "documentation":"<p>The bundle names.</p>" 866 }, 867 "pricingTier":{ 868 "shape":"PricingTier", 869 "documentation":"<p>The pricing tier.</p>" 870 } 871 }, 872 "documentation":"<p>Information about the pricing bundle.</p>" 873 }, 874 "BundleName":{ 875 "type":"string", 876 "max":256, 877 "min":1, 878 "pattern":".*" 879 }, 880 "CancelMetadataTransferJobRequest":{ 881 "type":"structure", 882 "required":["metadataTransferJobId"], 883 "members":{ 884 "metadataTransferJobId":{ 885 "shape":"Id", 886 "documentation":"<p>The metadata transfer job Id.</p>", 887 "location":"uri", 888 "locationName":"metadataTransferJobId" 889 } 890 } 891 }, 892 "CancelMetadataTransferJobResponse":{ 893 "type":"structure", 894 "required":[ 895 "metadataTransferJobId", 896 "arn", 897 "updateDateTime", 898 "status" 899 ], 900 "members":{ 901 "metadataTransferJobId":{ 902 "shape":"Id", 903 "documentation":"<p>The metadata transfer job Id.</p>" 904 }, 905 "arn":{ 906 "shape":"TwinMakerArn", 907 "documentation":"<p>The metadata transfer job ARN.</p>" 908 }, 909 "updateDateTime":{ 910 "shape":"Timestamp", 911 "documentation":"<p>Used to update the DateTime property.</p>" 912 }, 913 "status":{ 914 "shape":"MetadataTransferJobStatus", 915 "documentation":"<p>The metadata transfer job's status.</p>" 916 }, 917 "progress":{ 918 "shape":"MetadataTransferJobProgress", 919 "documentation":"<p>The metadata transfer job's progress.</p>" 920 } 921 } 922 }, 923 "ColumnDescription":{ 924 "type":"structure", 925 "members":{ 926 "name":{ 927 "shape":"ColumnName", 928 "documentation":"<p>The name of the column description.</p>" 929 }, 930 "type":{ 931 "shape":"ColumnType", 932 "documentation":"<p>The type of the column description.</p>" 933 } 934 }, 935 "documentation":"<p>A description of the column in the query results.</p>" 936 }, 937 "ColumnDescriptions":{ 938 "type":"list", 939 "member":{"shape":"ColumnDescription"} 940 }, 941 "ColumnName":{ 942 "type":"string", 943 "pattern":".*" 944 }, 945 "ColumnType":{ 946 "type":"string", 947 "enum":[ 948 "NODE", 949 "EDGE", 950 "VALUE" 951 ] 952 }, 953 "ComponentPath":{ 954 "type":"string", 955 "max":2048, 956 "min":1, 957 "pattern":"[a-zA-Z_\\-0-9/]+" 958 }, 959 "ComponentPropertyGroupRequest":{ 960 "type":"structure", 961 "members":{ 962 "groupType":{ 963 "shape":"GroupType", 964 "documentation":"<p>The group type.</p>" 965 }, 966 "propertyNames":{ 967 "shape":"PropertyNames", 968 "documentation":"<p>The property names.</p>" 969 }, 970 "updateType":{ 971 "shape":"PropertyGroupUpdateType", 972 "documentation":"<p>The update type.</p>" 973 } 974 }, 975 "documentation":"<p>The component property group request.</p>" 976 }, 977 "ComponentPropertyGroupRequests":{ 978 "type":"map", 979 "key":{"shape":"Name"}, 980 "value":{"shape":"ComponentPropertyGroupRequest"} 981 }, 982 "ComponentPropertyGroupResponse":{ 983 "type":"structure", 984 "required":[ 985 "groupType", 986 "propertyNames", 987 "isInherited" 988 ], 989 "members":{ 990 "groupType":{ 991 "shape":"GroupType", 992 "documentation":"<p>The group type.</p>" 993 }, 994 "propertyNames":{ 995 "shape":"PropertyNames", 996 "documentation":"<p>The names of properties</p>" 997 }, 998 "isInherited":{ 999 "shape":"Boolean", 1000 "documentation":"<p>A Boolean value that specifies whether the property group is inherited from a parent entity</p>" 1001 } 1002 }, 1003 "documentation":"<p>The component property group response.</p>" 1004 }, 1005 "ComponentPropertyGroupResponses":{ 1006 "type":"map", 1007 "key":{"shape":"Name"}, 1008 "value":{"shape":"ComponentPropertyGroupResponse"} 1009 }, 1010 "ComponentRequest":{ 1011 "type":"structure", 1012 "members":{ 1013 "description":{ 1014 "shape":"Description", 1015 "documentation":"<p>The description of the component request.</p>" 1016 }, 1017 "componentTypeId":{ 1018 "shape":"ComponentTypeId", 1019 "documentation":"<p>The ID of the component type.</p>" 1020 }, 1021 "properties":{ 1022 "shape":"PropertyRequests", 1023 "documentation":"<p>An object that maps strings to the properties to set in the component type. Each string in the mapping must be unique to this object.</p>" 1024 }, 1025 "propertyGroups":{ 1026 "shape":"ComponentPropertyGroupRequests", 1027 "documentation":"<p>The property groups.</p>" 1028 } 1029 }, 1030 "documentation":"<p>An object that sets information about a component type create or update request.</p>" 1031 }, 1032 "ComponentResponse":{ 1033 "type":"structure", 1034 "members":{ 1035 "componentName":{ 1036 "shape":"Name", 1037 "documentation":"<p>The name of the component.</p>" 1038 }, 1039 "description":{ 1040 "shape":"Description", 1041 "documentation":"<p>The description of the component type.</p>" 1042 }, 1043 "componentTypeId":{ 1044 "shape":"ComponentTypeId", 1045 "documentation":"<p>The ID of the component type.</p>" 1046 }, 1047 "status":{ 1048 "shape":"Status", 1049 "documentation":"<p>The status of the component type.</p>" 1050 }, 1051 "definedIn":{ 1052 "shape":"String", 1053 "documentation":"<p>The name of the property definition set in the request.</p>" 1054 }, 1055 "properties":{ 1056 "shape":"PropertyResponses", 1057 "documentation":"<p>An object that maps strings to the properties to set in the component type. Each string in the mapping must be unique to this object.</p>" 1058 }, 1059 "propertyGroups":{ 1060 "shape":"ComponentPropertyGroupResponses", 1061 "documentation":"<p>The property groups.</p>" 1062 }, 1063 "syncSource":{ 1064 "shape":"SyncSource", 1065 "documentation":"<p>The syncSource of the sync job, if this entity was created by a sync job.</p>" 1066 }, 1067 "areAllPropertiesReturned":{ 1068 "shape":"Boolean", 1069 "documentation":"<p>This flag notes whether all properties of the component are returned in the API response. The maximum number of properties returned is 800.</p>" 1070 }, 1071 "compositeComponents":{ 1072 "shape":"CompositeComponentResponse", 1073 "documentation":"<p>This lists objects that contain information about the <code>compositeComponents</code>.</p>" 1074 }, 1075 "areAllCompositeComponentsReturned":{ 1076 "shape":"Boolean", 1077 "documentation":"<p>This flag notes whether all <code>compositeComponents</code> are returned in the API response.</p>" 1078 } 1079 }, 1080 "documentation":"<p>An object that returns information about a component type create or update request.</p>" 1081 }, 1082 "ComponentSummaries":{ 1083 "type":"list", 1084 "member":{"shape":"ComponentSummary"} 1085 }, 1086 "ComponentSummary":{ 1087 "type":"structure", 1088 "required":[ 1089 "componentName", 1090 "componentTypeId", 1091 "status" 1092 ], 1093 "members":{ 1094 "componentName":{ 1095 "shape":"Name", 1096 "documentation":"<p>The name of the component.</p>" 1097 }, 1098 "componentTypeId":{ 1099 "shape":"ComponentTypeId", 1100 "documentation":"<p>The ID of the component type.</p>" 1101 }, 1102 "definedIn":{ 1103 "shape":"String", 1104 "documentation":"<p>The name of the property definition set in the request.</p>" 1105 }, 1106 "description":{ 1107 "shape":"Description", 1108 "documentation":"<p>The description of the component request.</p>" 1109 }, 1110 "propertyGroups":{ 1111 "shape":"ComponentPropertyGroupResponses", 1112 "documentation":"<p>The property groups.</p>" 1113 }, 1114 "status":{ 1115 "shape":"Status", 1116 "documentation":"<p>The status of the component type.</p>" 1117 }, 1118 "syncSource":{ 1119 "shape":"SyncSource", 1120 "documentation":"<p>The <code>syncSource</code> of the sync job, if this entity was created by a sync job.</p>" 1121 }, 1122 "componentPath":{ 1123 "shape":"ComponentPath", 1124 "documentation":"<p>This string specifies the path to the composite component, starting from the top-level component.</p>" 1125 } 1126 }, 1127 "documentation":"<p>An object that returns information about a component summary.</p>" 1128 }, 1129 "ComponentTypeId":{ 1130 "type":"string", 1131 "max":256, 1132 "min":1, 1133 "pattern":"[a-zA-Z_\\.\\-0-9:]+" 1134 }, 1135 "ComponentTypeName":{ 1136 "type":"string", 1137 "max":256, 1138 "min":0, 1139 "pattern":".*[^\\u0000-\\u001F\\u007F]*.*" 1140 }, 1141 "ComponentTypeSummaries":{ 1142 "type":"list", 1143 "member":{"shape":"ComponentTypeSummary"} 1144 }, 1145 "ComponentTypeSummary":{ 1146 "type":"structure", 1147 "required":[ 1148 "arn", 1149 "componentTypeId", 1150 "creationDateTime", 1151 "updateDateTime" 1152 ], 1153 "members":{ 1154 "arn":{ 1155 "shape":"TwinMakerArn", 1156 "documentation":"<p>The ARN of the component type.</p>" 1157 }, 1158 "componentTypeId":{ 1159 "shape":"ComponentTypeId", 1160 "documentation":"<p>The ID of the component type.</p>" 1161 }, 1162 "creationDateTime":{ 1163 "shape":"Timestamp", 1164 "documentation":"<p>The date and time when the component type was created.</p>" 1165 }, 1166 "updateDateTime":{ 1167 "shape":"Timestamp", 1168 "documentation":"<p>The date and time when the component type was last updated.</p>" 1169 }, 1170 "description":{ 1171 "shape":"Description", 1172 "documentation":"<p>The description of the component type.</p>" 1173 }, 1174 "status":{ 1175 "shape":"Status", 1176 "documentation":"<p>The current status of the component type.</p>" 1177 }, 1178 "componentTypeName":{ 1179 "shape":"ComponentTypeName", 1180 "documentation":"<p>The component type name.</p>" 1181 } 1182 }, 1183 "documentation":"<p>An object that contains information about a component type.</p>" 1184 }, 1185 "ComponentUpdateRequest":{ 1186 "type":"structure", 1187 "members":{ 1188 "updateType":{ 1189 "shape":"ComponentUpdateType", 1190 "documentation":"<p>The update type of the component update request.</p>" 1191 }, 1192 "description":{ 1193 "shape":"Description", 1194 "documentation":"<p>The description of the component type.</p>" 1195 }, 1196 "componentTypeId":{ 1197 "shape":"ComponentTypeId", 1198 "documentation":"<p>The ID of the component type.</p>" 1199 }, 1200 "propertyUpdates":{ 1201 "shape":"PropertyRequests", 1202 "documentation":"<p>An object that maps strings to the properties to set in the component type update. Each string in the mapping must be unique to this object.</p>" 1203 }, 1204 "propertyGroupUpdates":{ 1205 "shape":"ComponentPropertyGroupRequests", 1206 "documentation":"<p>The property group updates.</p>" 1207 } 1208 }, 1209 "documentation":"<p>The component update request.</p>" 1210 }, 1211 "ComponentUpdateType":{ 1212 "type":"string", 1213 "enum":[ 1214 "CREATE", 1215 "UPDATE", 1216 "DELETE" 1217 ] 1218 }, 1219 "ComponentUpdatesMapRequest":{ 1220 "type":"map", 1221 "key":{"shape":"Name"}, 1222 "value":{"shape":"ComponentUpdateRequest"} 1223 }, 1224 "ComponentsMap":{ 1225 "type":"map", 1226 "key":{"shape":"Name"}, 1227 "value":{"shape":"ComponentResponse"} 1228 }, 1229 "ComponentsMapRequest":{ 1230 "type":"map", 1231 "key":{"shape":"Name"}, 1232 "value":{"shape":"ComponentRequest"} 1233 }, 1234 "CompositeComponentRequest":{ 1235 "type":"structure", 1236 "members":{ 1237 "description":{ 1238 "shape":"Description", 1239 "documentation":"<p>The description of the component type.</p>" 1240 }, 1241 "properties":{ 1242 "shape":"PropertyRequests", 1243 "documentation":"<p>This is an object that maps strings to the properties to set in the component type. Each string in the mapping must be unique to this object.</p>" 1244 }, 1245 "propertyGroups":{ 1246 "shape":"ComponentPropertyGroupRequests", 1247 "documentation":"<p>The property groups.</p>" 1248 } 1249 }, 1250 "documentation":"<p>An object that sets information about the composite component update request.</p>" 1251 }, 1252 "CompositeComponentResponse":{ 1253 "type":"map", 1254 "key":{"shape":"Name"}, 1255 "value":{"shape":"ComponentSummary"} 1256 }, 1257 "CompositeComponentTypeRequest":{ 1258 "type":"structure", 1259 "members":{ 1260 "componentTypeId":{ 1261 "shape":"ComponentTypeId", 1262 "documentation":"<p>This is the <code>componentTypeId</code> that the <code>compositeComponentType</code> refers to.</p>" 1263 } 1264 }, 1265 "documentation":"<p>An object that sets information about the composite component types of a component type.</p>" 1266 }, 1267 "CompositeComponentTypeResponse":{ 1268 "type":"structure", 1269 "members":{ 1270 "componentTypeId":{ 1271 "shape":"ComponentTypeId", 1272 "documentation":"<p>This is the <code>componentTypeId</code> that this <code>compositeComponentType</code> refers to.</p>" 1273 }, 1274 "isInherited":{ 1275 "shape":"Boolean", 1276 "documentation":"<p>This boolean indicates whether this <code>compositeComponentType</code> is inherited from its parent.</p>" 1277 } 1278 }, 1279 "documentation":"<p>An object that returns information about the composite component types of a component type.</p>" 1280 }, 1281 "CompositeComponentTypesRequest":{ 1282 "type":"map", 1283 "key":{"shape":"Name"}, 1284 "value":{"shape":"CompositeComponentTypeRequest"} 1285 }, 1286 "CompositeComponentTypesResponse":{ 1287 "type":"map", 1288 "key":{"shape":"Name"}, 1289 "value":{"shape":"CompositeComponentTypeResponse"} 1290 }, 1291 "CompositeComponentUpdateRequest":{ 1292 "type":"structure", 1293 "members":{ 1294 "updateType":{ 1295 "shape":"ComponentUpdateType", 1296 "documentation":"<p>The update type of the component update request.</p>" 1297 }, 1298 "description":{ 1299 "shape":"Description", 1300 "documentation":"<p>The description of the component type.</p>" 1301 }, 1302 "propertyUpdates":{ 1303 "shape":"PropertyRequests", 1304 "documentation":"<p>An object that maps strings to the properties to set in the component type update. Each string in the mapping must be unique to this object.</p>" 1305 }, 1306 "propertyGroupUpdates":{ 1307 "shape":"ComponentPropertyGroupRequests", 1308 "documentation":"<p>The property group updates.</p>" 1309 } 1310 }, 1311 "documentation":"<p>An object that sets information about the composite component update request.</p>" 1312 }, 1313 "CompositeComponentUpdatesMapRequest":{ 1314 "type":"map", 1315 "key":{"shape":"ComponentPath"}, 1316 "value":{"shape":"CompositeComponentUpdateRequest"} 1317 }, 1318 "CompositeComponentsMapRequest":{ 1319 "type":"map", 1320 "key":{"shape":"ComponentPath"}, 1321 "value":{"shape":"CompositeComponentRequest"} 1322 }, 1323 "Configuration":{ 1324 "type":"map", 1325 "key":{"shape":"Name"}, 1326 "value":{"shape":"Value"} 1327 }, 1328 "ConflictException":{ 1329 "type":"structure", 1330 "members":{ 1331 "message":{"shape":"ErrorMessage"} 1332 }, 1333 "documentation":"<p>A conflict occurred.</p>", 1334 "error":{ 1335 "httpStatusCode":409, 1336 "senderFault":true 1337 }, 1338 "exception":true 1339 }, 1340 "ConnectorFailureException":{ 1341 "type":"structure", 1342 "members":{ 1343 "message":{"shape":"ErrorMessage"} 1344 }, 1345 "documentation":"<p>The connector failed.</p>", 1346 "error":{ 1347 "httpStatusCode":424, 1348 "senderFault":true 1349 }, 1350 "exception":true 1351 }, 1352 "ConnectorTimeoutException":{ 1353 "type":"structure", 1354 "members":{ 1355 "message":{"shape":"ErrorMessage"} 1356 }, 1357 "documentation":"<p>The connector timed out.</p>", 1358 "error":{ 1359 "httpStatusCode":424, 1360 "senderFault":true 1361 }, 1362 "exception":true 1363 }, 1364 "CreateComponentTypeRequest":{ 1365 "type":"structure", 1366 "required":[ 1367 "workspaceId", 1368 "componentTypeId" 1369 ], 1370 "members":{ 1371 "workspaceId":{ 1372 "shape":"Id", 1373 "documentation":"<p>The ID of the workspace that contains the component type.</p>", 1374 "location":"uri", 1375 "locationName":"workspaceId" 1376 }, 1377 "isSingleton":{ 1378 "shape":"Boolean", 1379 "documentation":"<p>A Boolean value that specifies whether an entity can have more than one component of this type.</p>" 1380 }, 1381 "componentTypeId":{ 1382 "shape":"ComponentTypeId", 1383 "documentation":"<p>The ID of the component type.</p>", 1384 "location":"uri", 1385 "locationName":"componentTypeId" 1386 }, 1387 "description":{ 1388 "shape":"Description", 1389 "documentation":"<p>The description of the component type.</p>" 1390 }, 1391 "propertyDefinitions":{ 1392 "shape":"PropertyDefinitionsRequest", 1393 "documentation":"<p>An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object.</p>" 1394 }, 1395 "extendsFrom":{ 1396 "shape":"ExtendsFrom", 1397 "documentation":"<p>Specifies the parent component type to extend.</p>" 1398 }, 1399 "functions":{ 1400 "shape":"FunctionsRequest", 1401 "documentation":"<p>An object that maps strings to the functions in the component type. Each string in the mapping must be unique to this object.</p>" 1402 }, 1403 "tags":{ 1404 "shape":"TagMap", 1405 "documentation":"<p>Metadata that you can use to manage the component type.</p>" 1406 }, 1407 "propertyGroups":{ 1408 "shape":"PropertyGroupsRequest", 1409 "documentation":"<p/>" 1410 }, 1411 "componentTypeName":{ 1412 "shape":"ComponentTypeName", 1413 "documentation":"<p>A friendly name for the component type.</p>" 1414 }, 1415 "compositeComponentTypes":{ 1416 "shape":"CompositeComponentTypesRequest", 1417 "documentation":"<p>This is an object that maps strings to <code>compositeComponentTypes</code> of the <code>componentType</code>. <code>CompositeComponentType</code> is referenced by <code>componentTypeId</code>.</p>" 1418 } 1419 } 1420 }, 1421 "CreateComponentTypeResponse":{ 1422 "type":"structure", 1423 "required":[ 1424 "arn", 1425 "creationDateTime", 1426 "state" 1427 ], 1428 "members":{ 1429 "arn":{ 1430 "shape":"TwinMakerArn", 1431 "documentation":"<p>The ARN of the component type.</p>" 1432 }, 1433 "creationDateTime":{ 1434 "shape":"Timestamp", 1435 "documentation":"<p>The date and time when the entity was created.</p>" 1436 }, 1437 "state":{ 1438 "shape":"State", 1439 "documentation":"<p>The current state of the component type.</p>" 1440 } 1441 } 1442 }, 1443 "CreateEntityRequest":{ 1444 "type":"structure", 1445 "required":[ 1446 "workspaceId", 1447 "entityName" 1448 ], 1449 "members":{ 1450 "workspaceId":{ 1451 "shape":"Id", 1452 "documentation":"<p>The ID of the workspace that contains the entity.</p>", 1453 "location":"uri", 1454 "locationName":"workspaceId" 1455 }, 1456 "entityId":{ 1457 "shape":"EntityId", 1458 "documentation":"<p>The ID of the entity.</p>" 1459 }, 1460 "entityName":{ 1461 "shape":"EntityName", 1462 "documentation":"<p>The name of the entity.</p>" 1463 }, 1464 "description":{ 1465 "shape":"Description", 1466 "documentation":"<p>The description of the entity.</p>" 1467 }, 1468 "components":{ 1469 "shape":"ComponentsMapRequest", 1470 "documentation":"<p>An object that maps strings to the components in the entity. Each string in the mapping must be unique to this object.</p>" 1471 }, 1472 "compositeComponents":{ 1473 "shape":"CompositeComponentsMapRequest", 1474 "documentation":"<p>This is an object that maps strings to <code>compositeComponent</code> updates in the request. Each key of the map represents the <code>componentPath</code> of the <code>compositeComponent</code>.</p>" 1475 }, 1476 "parentEntityId":{ 1477 "shape":"ParentEntityId", 1478 "documentation":"<p>The ID of the entity's parent entity.</p>" 1479 }, 1480 "tags":{ 1481 "shape":"TagMap", 1482 "documentation":"<p>Metadata that you can use to manage the entity.</p>" 1483 } 1484 } 1485 }, 1486 "CreateEntityResponse":{ 1487 "type":"structure", 1488 "required":[ 1489 "entityId", 1490 "arn", 1491 "creationDateTime", 1492 "state" 1493 ], 1494 "members":{ 1495 "entityId":{ 1496 "shape":"EntityId", 1497 "documentation":"<p>The ID of the entity.</p>" 1498 }, 1499 "arn":{ 1500 "shape":"TwinMakerArn", 1501 "documentation":"<p>The ARN of the entity.</p>" 1502 }, 1503 "creationDateTime":{ 1504 "shape":"Timestamp", 1505 "documentation":"<p>The date and time when the entity was created.</p>" 1506 }, 1507 "state":{ 1508 "shape":"State", 1509 "documentation":"<p>The current state of the entity.</p>" 1510 } 1511 } 1512 }, 1513 "CreateMetadataTransferJobRequest":{ 1514 "type":"structure", 1515 "required":[ 1516 "sources", 1517 "destination" 1518 ], 1519 "members":{ 1520 "metadataTransferJobId":{ 1521 "shape":"Id", 1522 "documentation":"<p>The metadata transfer job Id.</p>" 1523 }, 1524 "description":{ 1525 "shape":"Description", 1526 "documentation":"<p>The metadata transfer job description.</p>" 1527 }, 1528 "sources":{ 1529 "shape":"SourceConfigurations", 1530 "documentation":"<p>The metadata transfer job sources.</p>" 1531 }, 1532 "destination":{ 1533 "shape":"DestinationConfiguration", 1534 "documentation":"<p>The metadata transfer job destination.</p>" 1535 } 1536 } 1537 }, 1538 "CreateMetadataTransferJobResponse":{ 1539 "type":"structure", 1540 "required":[ 1541 "metadataTransferJobId", 1542 "arn", 1543 "creationDateTime", 1544 "status" 1545 ], 1546 "members":{ 1547 "metadataTransferJobId":{ 1548 "shape":"Id", 1549 "documentation":"<p>The metadata transfer job Id.</p>" 1550 }, 1551 "arn":{ 1552 "shape":"TwinMakerArn", 1553 "documentation":"<p>The metadata transfer job ARN.</p>" 1554 }, 1555 "creationDateTime":{ 1556 "shape":"Timestamp", 1557 "documentation":"<p>The The metadata transfer job creation DateTime property.</p>" 1558 }, 1559 "status":{ 1560 "shape":"MetadataTransferJobStatus", 1561 "documentation":"<p>The metadata transfer job response status.</p>" 1562 } 1563 } 1564 }, 1565 "CreateSceneRequest":{ 1566 "type":"structure", 1567 "required":[ 1568 "workspaceId", 1569 "sceneId", 1570 "contentLocation" 1571 ], 1572 "members":{ 1573 "workspaceId":{ 1574 "shape":"Id", 1575 "documentation":"<p>The ID of the workspace that contains the scene.</p>", 1576 "location":"uri", 1577 "locationName":"workspaceId" 1578 }, 1579 "sceneId":{ 1580 "shape":"Id", 1581 "documentation":"<p>The ID of the scene.</p>" 1582 }, 1583 "contentLocation":{ 1584 "shape":"S3Url", 1585 "documentation":"<p>The relative path that specifies the location of the content definition file.</p>" 1586 }, 1587 "description":{ 1588 "shape":"Description", 1589 "documentation":"<p>The description for this scene.</p>" 1590 }, 1591 "capabilities":{ 1592 "shape":"SceneCapabilities", 1593 "documentation":"<p>A list of capabilities that the scene uses to render itself.</p>" 1594 }, 1595 "tags":{ 1596 "shape":"TagMap", 1597 "documentation":"<p>Metadata that you can use to manage the scene.</p>" 1598 }, 1599 "sceneMetadata":{ 1600 "shape":"SceneMetadataMap", 1601 "documentation":"<p>The request metadata.</p>" 1602 } 1603 } 1604 }, 1605 "CreateSceneResponse":{ 1606 "type":"structure", 1607 "required":[ 1608 "arn", 1609 "creationDateTime" 1610 ], 1611 "members":{ 1612 "arn":{ 1613 "shape":"TwinMakerArn", 1614 "documentation":"<p>The ARN of the scene.</p>" 1615 }, 1616 "creationDateTime":{ 1617 "shape":"Timestamp", 1618 "documentation":"<p>The date and time when the scene was created.</p>" 1619 } 1620 } 1621 }, 1622 "CreateSyncJobRequest":{ 1623 "type":"structure", 1624 "required":[ 1625 "workspaceId", 1626 "syncSource", 1627 "syncRole" 1628 ], 1629 "members":{ 1630 "workspaceId":{ 1631 "shape":"Id", 1632 "documentation":"<p>The workspace ID.</p>", 1633 "location":"uri", 1634 "locationName":"workspaceId" 1635 }, 1636 "syncSource":{ 1637 "shape":"SyncSource", 1638 "documentation":"<p>The sync source.</p> <note> <p>Currently the only supported syncSoource is <code>SITEWISE </code>.</p> </note>", 1639 "location":"uri", 1640 "locationName":"syncSource" 1641 }, 1642 "syncRole":{ 1643 "shape":"RoleArn", 1644 "documentation":"<p>The SyncJob IAM role. This IAM role is used by the SyncJob to read from the syncSource, and create, update, or delete the corresponding resources.</p>" 1645 }, 1646 "tags":{ 1647 "shape":"TagMap", 1648 "documentation":"<p>The SyncJob tags.</p>" 1649 } 1650 } 1651 }, 1652 "CreateSyncJobResponse":{ 1653 "type":"structure", 1654 "required":[ 1655 "arn", 1656 "creationDateTime", 1657 "state" 1658 ], 1659 "members":{ 1660 "arn":{ 1661 "shape":"TwinMakerArn", 1662 "documentation":"<p>The SyncJob ARN.</p>" 1663 }, 1664 "creationDateTime":{ 1665 "shape":"Timestamp", 1666 "documentation":"<p>The date and time for the SyncJob creation.</p>" 1667 }, 1668 "state":{ 1669 "shape":"SyncJobState", 1670 "documentation":"<p>The SyncJob response state.</p>" 1671 } 1672 } 1673 }, 1674 "CreateWorkspaceRequest":{ 1675 "type":"structure", 1676 "required":["workspaceId"], 1677 "members":{ 1678 "workspaceId":{ 1679 "shape":"Id", 1680 "documentation":"<p>The ID of the workspace.</p>", 1681 "location":"uri", 1682 "locationName":"workspaceId" 1683 }, 1684 "description":{ 1685 "shape":"Description", 1686 "documentation":"<p>The description of the workspace.</p>" 1687 }, 1688 "s3Location":{ 1689 "shape":"S3Location", 1690 "documentation":"<p>The ARN of the S3 bucket where resources associated with the workspace are stored.</p>" 1691 }, 1692 "role":{ 1693 "shape":"RoleArn", 1694 "documentation":"<p>The ARN of the execution role associated with the workspace.</p>" 1695 }, 1696 "tags":{ 1697 "shape":"TagMap", 1698 "documentation":"<p>Metadata that you can use to manage the workspace</p>" 1699 } 1700 } 1701 }, 1702 "CreateWorkspaceResponse":{ 1703 "type":"structure", 1704 "required":[ 1705 "arn", 1706 "creationDateTime" 1707 ], 1708 "members":{ 1709 "arn":{ 1710 "shape":"TwinMakerArn", 1711 "documentation":"<p>The ARN of the workspace.</p>" 1712 }, 1713 "creationDateTime":{ 1714 "shape":"Timestamp", 1715 "documentation":"<p>The date and time when the workspace was created.</p>" 1716 } 1717 } 1718 }, 1719 "DataConnector":{ 1720 "type":"structure", 1721 "members":{ 1722 "lambda":{ 1723 "shape":"LambdaFunction", 1724 "documentation":"<p>The Lambda function associated with this data connector.</p>" 1725 }, 1726 "isNative":{ 1727 "shape":"Boolean", 1728 "documentation":"<p>A Boolean value that specifies whether the data connector is native to IoT TwinMaker.</p>" 1729 } 1730 }, 1731 "documentation":"<p>The data connector.</p>" 1732 }, 1733 "DataType":{ 1734 "type":"structure", 1735 "required":["type"], 1736 "members":{ 1737 "type":{ 1738 "shape":"Type", 1739 "documentation":"<p>The underlying type of the data type.</p>" 1740 }, 1741 "nestedType":{ 1742 "shape":"DataType", 1743 "documentation":"<p>The nested type in the data type.</p>" 1744 }, 1745 "allowedValues":{ 1746 "shape":"DataValueList", 1747 "documentation":"<p>The allowed values for this data type.</p>" 1748 }, 1749 "unitOfMeasure":{ 1750 "shape":"String", 1751 "documentation":"<p>The unit of measure used in this data type.</p>" 1752 }, 1753 "relationship":{ 1754 "shape":"Relationship", 1755 "documentation":"<p>A relationship that associates a component with another component.</p>" 1756 } 1757 }, 1758 "documentation":"<p>An object that specifies the data type of a property.</p>" 1759 }, 1760 "DataValue":{ 1761 "type":"structure", 1762 "members":{ 1763 "booleanValue":{ 1764 "shape":"Boolean", 1765 "documentation":"<p>A Boolean value.</p>" 1766 }, 1767 "doubleValue":{ 1768 "shape":"Double", 1769 "documentation":"<p>A double value.</p>" 1770 }, 1771 "integerValue":{ 1772 "shape":"Integer", 1773 "documentation":"<p>An integer value.</p>" 1774 }, 1775 "longValue":{ 1776 "shape":"Long", 1777 "documentation":"<p>A long value.</p>" 1778 }, 1779 "stringValue":{ 1780 "shape":"String", 1781 "documentation":"<p>A string value.</p>" 1782 }, 1783 "listValue":{ 1784 "shape":"DataValueList", 1785 "documentation":"<p>A list of multiple values.</p>" 1786 }, 1787 "mapValue":{ 1788 "shape":"DataValueMap", 1789 "documentation":"<p>An object that maps strings to multiple <code>DataValue</code> objects.</p>" 1790 }, 1791 "relationshipValue":{ 1792 "shape":"RelationshipValue", 1793 "documentation":"<p>A value that relates a component to another component.</p>" 1794 }, 1795 "expression":{ 1796 "shape":"Expression", 1797 "documentation":"<p>An expression that produces the value.</p>" 1798 } 1799 }, 1800 "documentation":"<p>An object that specifies a value for a property.</p>" 1801 }, 1802 "DataValueList":{ 1803 "type":"list", 1804 "member":{"shape":"DataValue"}, 1805 "max":50, 1806 "min":0 1807 }, 1808 "DataValueMap":{ 1809 "type":"map", 1810 "key":{"shape":"String"}, 1811 "value":{"shape":"DataValue"}, 1812 "max":50, 1813 "min":0 1814 }, 1815 "DeleteComponentTypeRequest":{ 1816 "type":"structure", 1817 "required":[ 1818 "workspaceId", 1819 "componentTypeId" 1820 ], 1821 "members":{ 1822 "workspaceId":{ 1823 "shape":"Id", 1824 "documentation":"<p>The ID of the workspace that contains the component type.</p>", 1825 "location":"uri", 1826 "locationName":"workspaceId" 1827 }, 1828 "componentTypeId":{ 1829 "shape":"ComponentTypeId", 1830 "documentation":"<p>The ID of the component type to delete.</p>", 1831 "location":"uri", 1832 "locationName":"componentTypeId" 1833 } 1834 } 1835 }, 1836 "DeleteComponentTypeResponse":{ 1837 "type":"structure", 1838 "required":["state"], 1839 "members":{ 1840 "state":{ 1841 "shape":"State", 1842 "documentation":"<p>The current state of the component type to be deleted.</p>" 1843 } 1844 } 1845 }, 1846 "DeleteEntityRequest":{ 1847 "type":"structure", 1848 "required":[ 1849 "workspaceId", 1850 "entityId" 1851 ], 1852 "members":{ 1853 "workspaceId":{ 1854 "shape":"Id", 1855 "documentation":"<p>The ID of the workspace that contains the entity to delete.</p>", 1856 "location":"uri", 1857 "locationName":"workspaceId" 1858 }, 1859 "entityId":{ 1860 "shape":"EntityId", 1861 "documentation":"<p>The ID of the entity to delete.</p>", 1862 "location":"uri", 1863 "locationName":"entityId" 1864 }, 1865 "isRecursive":{ 1866 "shape":"Boolean", 1867 "documentation":"<p>A Boolean value that specifies whether the operation deletes child entities.</p>", 1868 "location":"querystring", 1869 "locationName":"isRecursive" 1870 } 1871 } 1872 }, 1873 "DeleteEntityResponse":{ 1874 "type":"structure", 1875 "required":["state"], 1876 "members":{ 1877 "state":{ 1878 "shape":"State", 1879 "documentation":"<p>The current state of the deleted entity.</p>" 1880 } 1881 } 1882 }, 1883 "DeleteSceneRequest":{ 1884 "type":"structure", 1885 "required":[ 1886 "workspaceId", 1887 "sceneId" 1888 ], 1889 "members":{ 1890 "workspaceId":{ 1891 "shape":"Id", 1892 "documentation":"<p>The ID of the workspace.</p>", 1893 "location":"uri", 1894 "locationName":"workspaceId" 1895 }, 1896 "sceneId":{ 1897 "shape":"Id", 1898 "documentation":"<p>The ID of the scene to delete.</p>", 1899 "location":"uri", 1900 "locationName":"sceneId" 1901 } 1902 } 1903 }, 1904 "DeleteSceneResponse":{ 1905 "type":"structure", 1906 "members":{ 1907 } 1908 }, 1909 "DeleteSyncJobRequest":{ 1910 "type":"structure", 1911 "required":[ 1912 "workspaceId", 1913 "syncSource" 1914 ], 1915 "members":{ 1916 "workspaceId":{ 1917 "shape":"Id", 1918 "documentation":"<p>The workspace ID.</p>", 1919 "location":"uri", 1920 "locationName":"workspaceId" 1921 }, 1922 "syncSource":{ 1923 "shape":"SyncSource", 1924 "documentation":"<p>The sync source.</p> <note> <p>Currently the only supported syncSource is <code>SITEWISE </code>.</p> </note>", 1925 "location":"uri", 1926 "locationName":"syncSource" 1927 } 1928 } 1929 }, 1930 "DeleteSyncJobResponse":{ 1931 "type":"structure", 1932 "required":["state"], 1933 "members":{ 1934 "state":{ 1935 "shape":"SyncJobState", 1936 "documentation":"<p>The SyncJob response state.</p>" 1937 } 1938 } 1939 }, 1940 "DeleteWorkspaceRequest":{ 1941 "type":"structure", 1942 "required":["workspaceId"], 1943 "members":{ 1944 "workspaceId":{ 1945 "shape":"Id", 1946 "documentation":"<p>The ID of the workspace to delete.</p>", 1947 "location":"uri", 1948 "locationName":"workspaceId" 1949 } 1950 } 1951 }, 1952 "DeleteWorkspaceResponse":{ 1953 "type":"structure", 1954 "members":{ 1955 "message":{ 1956 "shape":"WorkspaceDeleteMessage", 1957 "documentation":"<p>The string that specifies the delete result for the workspace.</p>" 1958 } 1959 } 1960 }, 1961 "Description":{ 1962 "type":"string", 1963 "max":2048, 1964 "min":0, 1965 "pattern":".*" 1966 }, 1967 "DestinationConfiguration":{ 1968 "type":"structure", 1969 "required":["type"], 1970 "members":{ 1971 "type":{ 1972 "shape":"DestinationType", 1973 "documentation":"<p>The destination type.</p>" 1974 }, 1975 "s3Configuration":{ 1976 "shape":"S3DestinationConfiguration", 1977 "documentation":"<p>The metadata transfer job S3 configuration. [need to add S3 entity]</p>" 1978 }, 1979 "iotTwinMakerConfiguration":{ 1980 "shape":"IotTwinMakerDestinationConfiguration", 1981 "documentation":"<p>The metadata transfer job Amazon Web Services IoT TwinMaker configuration.</p>" 1982 } 1983 }, 1984 "documentation":"<p>The [link to action] metadata transfer job destination configuration.</p>" 1985 }, 1986 "DestinationType":{ 1987 "type":"string", 1988 "enum":[ 1989 "s3", 1990 "iotsitewise", 1991 "iottwinmaker" 1992 ] 1993 }, 1994 "Double":{ 1995 "type":"double", 1996 "box":true 1997 }, 1998 "EntityId":{ 1999 "type":"string", 2000 "max":128, 2001 "min":1, 2002 "pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|^[a-zA-Z0-9][a-zA-Z_\\-0-9.:]*[a-zA-Z0-9]+" 2003 }, 2004 "EntityName":{ 2005 "type":"string", 2006 "max":256, 2007 "min":1, 2008 "pattern":"[^\\u0000-\\u001F\\u007F]+" 2009 }, 2010 "EntityPropertyReference":{ 2011 "type":"structure", 2012 "required":["propertyName"], 2013 "members":{ 2014 "componentName":{ 2015 "shape":"Name", 2016 "documentation":"<p>The name of the component.</p>" 2017 }, 2018 "componentPath":{ 2019 "shape":"ComponentPath", 2020 "documentation":"<p>This string specifies the path to the composite component, starting from the top-level component.</p>" 2021 }, 2022 "externalIdProperty":{ 2023 "shape":"ExternalIdProperty", 2024 "documentation":"<p>A mapping of external IDs to property names. External IDs uniquely identify properties from external data stores.</p>" 2025 }, 2026 "entityId":{ 2027 "shape":"EntityId", 2028 "documentation":"<p>The ID of the entity.</p>" 2029 }, 2030 "propertyName":{ 2031 "shape":"Name", 2032 "documentation":"<p>The name of the property.</p>" 2033 } 2034 }, 2035 "documentation":"<p>An object that uniquely identifies an entity property.</p>" 2036 }, 2037 "EntitySummaries":{ 2038 "type":"list", 2039 "member":{"shape":"EntitySummary"} 2040 }, 2041 "EntitySummary":{ 2042 "type":"structure", 2043 "required":[ 2044 "entityId", 2045 "entityName", 2046 "arn", 2047 "status", 2048 "creationDateTime", 2049 "updateDateTime" 2050 ], 2051 "members":{ 2052 "entityId":{ 2053 "shape":"EntityId", 2054 "documentation":"<p>The ID of the entity.</p>" 2055 }, 2056 "entityName":{ 2057 "shape":"EntityName", 2058 "documentation":"<p>The name of the entity.</p>" 2059 }, 2060 "arn":{ 2061 "shape":"TwinMakerArn", 2062 "documentation":"<p>The ARN of the entity.</p>" 2063 }, 2064 "parentEntityId":{ 2065 "shape":"ParentEntityId", 2066 "documentation":"<p>The ID of the parent entity.</p>" 2067 }, 2068 "status":{ 2069 "shape":"Status", 2070 "documentation":"<p>The current status of the entity.</p>" 2071 }, 2072 "description":{ 2073 "shape":"Description", 2074 "documentation":"<p>The description of the entity.</p>" 2075 }, 2076 "hasChildEntities":{ 2077 "shape":"Boolean", 2078 "documentation":"<p>An <b>eventual</b> Boolean value that specifies whether the entity has child entities or not.</p>" 2079 }, 2080 "creationDateTime":{ 2081 "shape":"Timestamp", 2082 "documentation":"<p>The date and time when the entity was created.</p>" 2083 }, 2084 "updateDateTime":{ 2085 "shape":"Timestamp", 2086 "documentation":"<p>The last date and time when the entity was updated.</p>" 2087 } 2088 }, 2089 "documentation":"<p>An object that contains information about an entity.</p>" 2090 }, 2091 "Entries":{ 2092 "type":"list", 2093 "member":{"shape":"PropertyValueEntry"}, 2094 "max":10, 2095 "min":1 2096 }, 2097 "ErrorCode":{ 2098 "type":"string", 2099 "enum":[ 2100 "VALIDATION_ERROR", 2101 "INTERNAL_FAILURE", 2102 "SYNC_INITIALIZING_ERROR", 2103 "SYNC_CREATING_ERROR", 2104 "SYNC_PROCESSING_ERROR", 2105 "SYNC_DELETING_ERROR", 2106 "PROCESSING_ERROR", 2107 "COMPOSITE_COMPONENT_FAILURE" 2108 ] 2109 }, 2110 "ErrorDetails":{ 2111 "type":"structure", 2112 "members":{ 2113 "code":{ 2114 "shape":"ErrorCode", 2115 "documentation":"<p>The error code.</p>" 2116 }, 2117 "message":{ 2118 "shape":"ErrorMessage", 2119 "documentation":"<p>The error message.</p>" 2120 } 2121 }, 2122 "documentation":"<p>The error details.</p>" 2123 }, 2124 "ErrorEntries":{ 2125 "type":"list", 2126 "member":{"shape":"BatchPutPropertyErrorEntry"}, 2127 "max":10, 2128 "min":1 2129 }, 2130 "ErrorMessage":{ 2131 "type":"string", 2132 "max":2048, 2133 "min":0 2134 }, 2135 "Errors":{ 2136 "type":"list", 2137 "member":{"shape":"BatchPutPropertyError"}, 2138 "max":10, 2139 "min":1 2140 }, 2141 "ExceptionMessage":{"type":"string"}, 2142 "ExecuteQueryRequest":{ 2143 "type":"structure", 2144 "required":[ 2145 "workspaceId", 2146 "queryStatement" 2147 ], 2148 "members":{ 2149 "workspaceId":{ 2150 "shape":"Id", 2151 "documentation":"<p>The ID of the workspace.</p>" 2152 }, 2153 "queryStatement":{ 2154 "shape":"QueryStatement", 2155 "documentation":"<p>The query statement.</p>" 2156 }, 2157 "maxResults":{ 2158 "shape":"QueryServiceMaxResults", 2159 "documentation":"<p>The maximum number of results to return at one time. The default is 50.</p>" 2160 }, 2161 "nextToken":{ 2162 "shape":"NextToken", 2163 "documentation":"<p>The string that specifies the next page of results.</p>" 2164 } 2165 } 2166 }, 2167 "ExecuteQueryResponse":{ 2168 "type":"structure", 2169 "members":{ 2170 "columnDescriptions":{ 2171 "shape":"ColumnDescriptions", 2172 "documentation":"<p>A list of ColumnDescription objects.</p>" 2173 }, 2174 "rows":{ 2175 "shape":"Rows", 2176 "documentation":"<p>Represents a single row in the query results.</p>" 2177 }, 2178 "nextToken":{ 2179 "shape":"NextToken", 2180 "documentation":"<p>The string that specifies the next page of results.</p>" 2181 } 2182 } 2183 }, 2184 "Expression":{ 2185 "type":"string", 2186 "max":316, 2187 "min":1, 2188 "pattern":"(^\\$\\{Parameters\\.[a-zA-z]+([a-zA-z_0-9]*)}$)" 2189 }, 2190 "ExtendsFrom":{ 2191 "type":"list", 2192 "member":{"shape":"ComponentTypeId"} 2193 }, 2194 "ExternalIdProperty":{ 2195 "type":"map", 2196 "key":{"shape":"String"}, 2197 "value":{"shape":"String"} 2198 }, 2199 "FilterByAsset":{ 2200 "type":"structure", 2201 "members":{ 2202 "assetId":{ 2203 "shape":"Uuid", 2204 "documentation":"<p>Filter by asset Id.</p>" 2205 }, 2206 "assetExternalId":{ 2207 "shape":"SiteWiseExternalId", 2208 "documentation":"<p>The external-Id property of an asset. </p>" 2209 }, 2210 "includeOffspring":{ 2211 "shape":"Boolean", 2212 "documentation":"<p>Includes sub-assets.[need description hekp for this]</p>" 2213 }, 2214 "includeAssetModel":{ 2215 "shape":"Boolean", 2216 "documentation":"<p>Boolean to include the asset model.</p>" 2217 } 2218 }, 2219 "documentation":"<p>Filter by asset. [TwinMaker asset]</p>" 2220 }, 2221 "FilterByAssetModel":{ 2222 "type":"structure", 2223 "members":{ 2224 "assetModelId":{ 2225 "shape":"Uuid", 2226 "documentation":"<p>The asset model Id.</p>" 2227 }, 2228 "assetModelExternalId":{ 2229 "shape":"SiteWiseExternalId", 2230 "documentation":"<p>The external-Id property of an asset model.</p>" 2231 }, 2232 "includeOffspring":{ 2233 "shape":"Boolean", 2234 "documentation":"<p>Include asset offspring. [need desc.]</p>" 2235 }, 2236 "includeAssets":{ 2237 "shape":"Boolean", 2238 "documentation":"<p>Bolean to include assets.</p>" 2239 } 2240 }, 2241 "documentation":"<p>Filter by asset model.</p>" 2242 }, 2243 "FilterByComponentType":{ 2244 "type":"structure", 2245 "required":["componentTypeId"], 2246 "members":{ 2247 "componentTypeId":{ 2248 "shape":"ComponentTypeId", 2249 "documentation":"<p>The component type Id.</p>" 2250 } 2251 }, 2252 "documentation":"<p>Filter by component type.</p>" 2253 }, 2254 "FilterByEntity":{ 2255 "type":"structure", 2256 "required":["entityId"], 2257 "members":{ 2258 "entityId":{ 2259 "shape":"EntityId", 2260 "documentation":"<p>The entity Id.</p>" 2261 } 2262 }, 2263 "documentation":"<p>Vilter by entity.</p>" 2264 }, 2265 "FunctionRequest":{ 2266 "type":"structure", 2267 "members":{ 2268 "requiredProperties":{ 2269 "shape":"RequiredProperties", 2270 "documentation":"<p>The required properties of the function.</p>" 2271 }, 2272 "scope":{ 2273 "shape":"Scope", 2274 "documentation":"<p>The scope of the function.</p>" 2275 }, 2276 "implementedBy":{ 2277 "shape":"DataConnector", 2278 "documentation":"<p>The data connector.</p>" 2279 } 2280 }, 2281 "documentation":"<p>The function request body.</p>" 2282 }, 2283 "FunctionResponse":{ 2284 "type":"structure", 2285 "members":{ 2286 "requiredProperties":{ 2287 "shape":"RequiredProperties", 2288 "documentation":"<p>The required properties of the function.</p>" 2289 }, 2290 "scope":{ 2291 "shape":"Scope", 2292 "documentation":"<p>The scope of the function.</p>" 2293 }, 2294 "implementedBy":{ 2295 "shape":"DataConnector", 2296 "documentation":"<p>The data connector.</p>" 2297 }, 2298 "isInherited":{ 2299 "shape":"Boolean", 2300 "documentation":"<p>Indicates whether this function is inherited.</p>" 2301 } 2302 }, 2303 "documentation":"<p>The function response.</p>" 2304 }, 2305 "FunctionsRequest":{ 2306 "type":"map", 2307 "key":{"shape":"Name"}, 2308 "value":{"shape":"FunctionRequest"} 2309 }, 2310 "FunctionsResponse":{ 2311 "type":"map", 2312 "key":{"shape":"Name"}, 2313 "value":{"shape":"FunctionResponse"} 2314 }, 2315 "GeneratedSceneMetadataMap":{ 2316 "type":"map", 2317 "key":{"shape":"Name"}, 2318 "value":{"shape":"SceneMetadataValue"}, 2319 "max":50, 2320 "min":0 2321 }, 2322 "GetComponentTypeRequest":{ 2323 "type":"structure", 2324 "required":[ 2325 "workspaceId", 2326 "componentTypeId" 2327 ], 2328 "members":{ 2329 "workspaceId":{ 2330 "shape":"Id", 2331 "documentation":"<p>The ID of the workspace that contains the component type.</p>", 2332 "location":"uri", 2333 "locationName":"workspaceId" 2334 }, 2335 "componentTypeId":{ 2336 "shape":"ComponentTypeId", 2337 "documentation":"<p>The ID of the component type.</p>", 2338 "location":"uri", 2339 "locationName":"componentTypeId" 2340 } 2341 } 2342 }, 2343 "GetComponentTypeResponse":{ 2344 "type":"structure", 2345 "required":[ 2346 "workspaceId", 2347 "componentTypeId", 2348 "creationDateTime", 2349 "updateDateTime", 2350 "arn" 2351 ], 2352 "members":{ 2353 "workspaceId":{ 2354 "shape":"Id", 2355 "documentation":"<p>The ID of the workspace that contains the component type.</p>" 2356 }, 2357 "isSingleton":{ 2358 "shape":"Boolean", 2359 "documentation":"<p>A Boolean value that specifies whether an entity can have more than one component of this type.</p>" 2360 }, 2361 "componentTypeId":{ 2362 "shape":"ComponentTypeId", 2363 "documentation":"<p>The ID of the component type.</p>" 2364 }, 2365 "description":{ 2366 "shape":"Description", 2367 "documentation":"<p>The description of the component type.</p>" 2368 }, 2369 "propertyDefinitions":{ 2370 "shape":"PropertyDefinitionsResponse", 2371 "documentation":"<p>An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object.</p>" 2372 }, 2373 "extendsFrom":{ 2374 "shape":"ExtendsFrom", 2375 "documentation":"<p>The name of the parent component type that this component type extends.</p>" 2376 }, 2377 "functions":{ 2378 "shape":"FunctionsResponse", 2379 "documentation":"<p>An object that maps strings to the functions in the component type. Each string in the mapping must be unique to this object.</p>" 2380 }, 2381 "creationDateTime":{ 2382 "shape":"Timestamp", 2383 "documentation":"<p>The date and time when the component type was created.</p>" 2384 }, 2385 "updateDateTime":{ 2386 "shape":"Timestamp", 2387 "documentation":"<p>The date and time when the component was last updated.</p>" 2388 }, 2389 "arn":{ 2390 "shape":"TwinMakerArn", 2391 "documentation":"<p>The ARN of the component type.</p>" 2392 }, 2393 "isAbstract":{ 2394 "shape":"Boolean", 2395 "documentation":"<p>A Boolean value that specifies whether the component type is abstract.</p>" 2396 }, 2397 "isSchemaInitialized":{ 2398 "shape":"Boolean", 2399 "documentation":"<p>A Boolean value that specifies whether the component type has a schema initializer and that the schema initializer has run.</p>" 2400 }, 2401 "status":{ 2402 "shape":"Status", 2403 "documentation":"<p>The current status of the component type.</p>" 2404 }, 2405 "propertyGroups":{ 2406 "shape":"PropertyGroupsResponse", 2407 "documentation":"<p>The maximum number of results to return at one time. The default is 25.</p> <p>Valid Range: Minimum value of 1. Maximum value of 250.</p>" 2408 }, 2409 "syncSource":{ 2410 "shape":"SyncSource", 2411 "documentation":"<p>The syncSource of the SyncJob, if this entity was created by a SyncJob.</p>" 2412 }, 2413 "componentTypeName":{ 2414 "shape":"ComponentTypeName", 2415 "documentation":"<p>The component type name.</p>" 2416 }, 2417 "compositeComponentTypes":{ 2418 "shape":"CompositeComponentTypesResponse", 2419 "documentation":"<p>This is an object that maps strings to <code>compositeComponentTypes</code> of the <code>componentType</code>. <code>CompositeComponentType</code> is referenced by <code>componentTypeId</code>.</p>" 2420 } 2421 } 2422 }, 2423 "GetEntityRequest":{ 2424 "type":"structure", 2425 "required":[ 2426 "workspaceId", 2427 "entityId" 2428 ], 2429 "members":{ 2430 "workspaceId":{ 2431 "shape":"Id", 2432 "documentation":"<p>The ID of the workspace.</p>", 2433 "location":"uri", 2434 "locationName":"workspaceId" 2435 }, 2436 "entityId":{ 2437 "shape":"EntityId", 2438 "documentation":"<p>The ID of the entity.</p>", 2439 "location":"uri", 2440 "locationName":"entityId" 2441 } 2442 } 2443 }, 2444 "GetEntityResponse":{ 2445 "type":"structure", 2446 "required":[ 2447 "entityId", 2448 "entityName", 2449 "arn", 2450 "status", 2451 "workspaceId", 2452 "parentEntityId", 2453 "hasChildEntities", 2454 "creationDateTime", 2455 "updateDateTime" 2456 ], 2457 "members":{ 2458 "entityId":{ 2459 "shape":"EntityId", 2460 "documentation":"<p>The ID of the entity.</p>" 2461 }, 2462 "entityName":{ 2463 "shape":"EntityName", 2464 "documentation":"<p>The name of the entity.</p>" 2465 }, 2466 "arn":{ 2467 "shape":"TwinMakerArn", 2468 "documentation":"<p>The ARN of the entity.</p>" 2469 }, 2470 "status":{ 2471 "shape":"Status", 2472 "documentation":"<p>The current status of the entity.</p>" 2473 }, 2474 "workspaceId":{ 2475 "shape":"Id", 2476 "documentation":"<p>The ID of the workspace.</p>" 2477 }, 2478 "description":{ 2479 "shape":"Description", 2480 "documentation":"<p>The description of the entity.</p>" 2481 }, 2482 "components":{ 2483 "shape":"ComponentsMap", 2484 "documentation":"<p>An object that maps strings to the components in the entity. Each string in the mapping must be unique to this object.</p>" 2485 }, 2486 "parentEntityId":{ 2487 "shape":"ParentEntityId", 2488 "documentation":"<p>The ID of the parent entity for this entity.</p>" 2489 }, 2490 "hasChildEntities":{ 2491 "shape":"Boolean", 2492 "documentation":"<p>A Boolean value that specifies whether the entity has associated child entities.</p>" 2493 }, 2494 "creationDateTime":{ 2495 "shape":"Timestamp", 2496 "documentation":"<p>The date and time when the entity was created.</p>" 2497 }, 2498 "updateDateTime":{ 2499 "shape":"Timestamp", 2500 "documentation":"<p>The date and time when the entity was last updated.</p>" 2501 }, 2502 "syncSource":{ 2503 "shape":"SyncSource", 2504 "documentation":"<p>The syncSource of the sync job, if this entity was created by a sync job.</p>" 2505 }, 2506 "areAllComponentsReturned":{ 2507 "shape":"Boolean", 2508 "documentation":"<p>This flag notes whether all components are returned in the API response. The maximum number of components returned is 30.</p>" 2509 } 2510 } 2511 }, 2512 "GetMetadataTransferJobRequest":{ 2513 "type":"structure", 2514 "required":["metadataTransferJobId"], 2515 "members":{ 2516 "metadataTransferJobId":{ 2517 "shape":"Id", 2518 "documentation":"<p>The metadata transfer job Id.</p>", 2519 "location":"uri", 2520 "locationName":"metadataTransferJobId" 2521 } 2522 } 2523 }, 2524 "GetMetadataTransferJobResponse":{ 2525 "type":"structure", 2526 "required":[ 2527 "metadataTransferJobId", 2528 "arn", 2529 "sources", 2530 "destination", 2531 "metadataTransferJobRole", 2532 "creationDateTime", 2533 "updateDateTime", 2534 "status" 2535 ], 2536 "members":{ 2537 "metadataTransferJobId":{ 2538 "shape":"Id", 2539 "documentation":"<p>The metadata transfer job Id.</p>" 2540 }, 2541 "arn":{ 2542 "shape":"TwinMakerArn", 2543 "documentation":"<p>The metadata transfer job ARN.</p>" 2544 }, 2545 "description":{ 2546 "shape":"Description", 2547 "documentation":"<p>The metadata transfer job description.</p>" 2548 }, 2549 "sources":{ 2550 "shape":"SourceConfigurations", 2551 "documentation":"<p>The metadata transfer job's sources.</p>" 2552 }, 2553 "destination":{ 2554 "shape":"DestinationConfiguration", 2555 "documentation":"<p>The metadata transfer job's destination.</p>" 2556 }, 2557 "metadataTransferJobRole":{ 2558 "shape":"RoleArn", 2559 "documentation":"<p>The metadata transfer job's role.</p>" 2560 }, 2561 "reportUrl":{ 2562 "shape":"String", 2563 "documentation":"<p>The metadata transfer job's report URL.</p>" 2564 }, 2565 "creationDateTime":{ 2566 "shape":"Timestamp", 2567 "documentation":"<p>The metadata transfer job's creation DateTime property.</p>" 2568 }, 2569 "updateDateTime":{ 2570 "shape":"Timestamp", 2571 "documentation":"<p>The metadata transfer job's update DateTime property.</p>" 2572 }, 2573 "status":{ 2574 "shape":"MetadataTransferJobStatus", 2575 "documentation":"<p>The metadata transfer job's status.</p>" 2576 }, 2577 "progress":{ 2578 "shape":"MetadataTransferJobProgress", 2579 "documentation":"<p>The metadata transfer job's progress.</p>" 2580 } 2581 } 2582 }, 2583 "GetPricingPlanRequest":{ 2584 "type":"structure", 2585 "members":{ 2586 } 2587 }, 2588 "GetPricingPlanResponse":{ 2589 "type":"structure", 2590 "required":["currentPricingPlan"], 2591 "members":{ 2592 "currentPricingPlan":{ 2593 "shape":"PricingPlan", 2594 "documentation":"<p>The chosen pricing plan for the current billing cycle.</p>" 2595 }, 2596 "pendingPricingPlan":{ 2597 "shape":"PricingPlan", 2598 "documentation":"<p>The pending pricing plan.</p>" 2599 } 2600 } 2601 }, 2602 "GetPropertyValueHistoryRequest":{ 2603 "type":"structure", 2604 "required":[ 2605 "workspaceId", 2606 "selectedProperties" 2607 ], 2608 "members":{ 2609 "workspaceId":{ 2610 "shape":"Id", 2611 "documentation":"<p>The ID of the workspace.</p>", 2612 "location":"uri", 2613 "locationName":"workspaceId" 2614 }, 2615 "entityId":{ 2616 "shape":"EntityId", 2617 "documentation":"<p>The ID of the entity.</p>" 2618 }, 2619 "componentName":{ 2620 "shape":"Name", 2621 "documentation":"<p>The name of the component.</p>" 2622 }, 2623 "componentPath":{ 2624 "shape":"ComponentPath", 2625 "documentation":"<p>This string specifies the path to the composite component, starting from the top-level component.</p>" 2626 }, 2627 "componentTypeId":{ 2628 "shape":"ComponentTypeId", 2629 "documentation":"<p>The ID of the component type.</p>" 2630 }, 2631 "selectedProperties":{ 2632 "shape":"SelectedPropertyList", 2633 "documentation":"<p>A list of properties whose value histories the request retrieves.</p>" 2634 }, 2635 "propertyFilters":{ 2636 "shape":"PropertyFilters", 2637 "documentation":"<p>A list of objects that filter the property value history request.</p>" 2638 }, 2639 "startDateTime":{ 2640 "shape":"Timestamp", 2641 "documentation":"<p>The date and time of the earliest property value to return.</p>", 2642 "deprecated":true, 2643 "deprecatedMessage":"This field is deprecated and will throw an error in the future. Use startTime instead." 2644 }, 2645 "endDateTime":{ 2646 "shape":"Timestamp", 2647 "documentation":"<p>The date and time of the latest property value to return.</p>", 2648 "deprecated":true, 2649 "deprecatedMessage":"This field is deprecated and will throw an error in the future. Use endTime instead." 2650 }, 2651 "interpolation":{ 2652 "shape":"InterpolationParameters", 2653 "documentation":"<p>An object that specifies the interpolation type and the interval over which to interpolate data.</p>" 2654 }, 2655 "nextToken":{ 2656 "shape":"NextToken", 2657 "documentation":"<p>The string that specifies the next page of results.</p>" 2658 }, 2659 "maxResults":{ 2660 "shape":"MaxResults", 2661 "documentation":"<p>The maximum number of results to return at one time. The default is 25.</p> <p>Valid Range: Minimum value of 1. Maximum value of 250.</p>" 2662 }, 2663 "orderByTime":{ 2664 "shape":"OrderByTime", 2665 "documentation":"<p>The time direction to use in the result order.</p>" 2666 }, 2667 "startTime":{ 2668 "shape":"Time", 2669 "documentation":"<p>The ISO8601 DateTime of the earliest property value to return.</p> <p>For more information about the ISO8601 DateTime format, see the data type <a href=\"https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_PropertyValue.html\">PropertyValue</a>.</p>" 2670 }, 2671 "endTime":{ 2672 "shape":"Time", 2673 "documentation":"<p>The ISO8601 DateTime of the latest property value to return.</p> <p>For more information about the ISO8601 DateTime format, see the data type <a href=\"https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_PropertyValue.html\">PropertyValue</a>.</p>" 2674 } 2675 } 2676 }, 2677 "GetPropertyValueHistoryResponse":{ 2678 "type":"structure", 2679 "required":["propertyValues"], 2680 "members":{ 2681 "propertyValues":{ 2682 "shape":"PropertyValueList", 2683 "documentation":"<p>An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object.</p>" 2684 }, 2685 "nextToken":{ 2686 "shape":"NextToken", 2687 "documentation":"<p>The string that specifies the next page of results.</p>" 2688 } 2689 } 2690 }, 2691 "GetPropertyValueRequest":{ 2692 "type":"structure", 2693 "required":[ 2694 "selectedProperties", 2695 "workspaceId" 2696 ], 2697 "members":{ 2698 "componentName":{ 2699 "shape":"Name", 2700 "documentation":"<p>The name of the component whose property values the operation returns.</p>" 2701 }, 2702 "componentPath":{ 2703 "shape":"ComponentPath", 2704 "documentation":"<p>This string specifies the path to the composite component, starting from the top-level component.</p>" 2705 }, 2706 "componentTypeId":{ 2707 "shape":"ComponentTypeId", 2708 "documentation":"<p>The ID of the component type whose property values the operation returns.</p>" 2709 }, 2710 "entityId":{ 2711 "shape":"EntityId", 2712 "documentation":"<p>The ID of the entity whose property values the operation returns.</p>" 2713 }, 2714 "selectedProperties":{ 2715 "shape":"SelectedPropertyList", 2716 "documentation":"<p>The properties whose values the operation returns.</p>" 2717 }, 2718 "workspaceId":{ 2719 "shape":"Id", 2720 "documentation":"<p>The ID of the workspace whose values the operation returns.</p>", 2721 "location":"uri", 2722 "locationName":"workspaceId" 2723 }, 2724 "maxResults":{ 2725 "shape":"MaxResults", 2726 "documentation":"<p>The maximum number of results to return at one time. The default is 25.</p> <p>Valid Range: Minimum value of 1. Maximum value of 250.</p>" 2727 }, 2728 "nextToken":{ 2729 "shape":"NextToken", 2730 "documentation":"<p>The string that specifies the next page of results.</p>" 2731 }, 2732 "propertyGroupName":{ 2733 "shape":"Name", 2734 "documentation":"<p>The property group name.</p>" 2735 }, 2736 "tabularConditions":{ 2737 "shape":"TabularConditions", 2738 "documentation":"<p>The tabular conditions.</p>" 2739 } 2740 } 2741 }, 2742 "GetPropertyValueResponse":{ 2743 "type":"structure", 2744 "members":{ 2745 "propertyValues":{ 2746 "shape":"PropertyLatestValueMap", 2747 "documentation":"<p>An object that maps strings to the properties and latest property values in the response. Each string in the mapping must be unique to this object.</p>" 2748 }, 2749 "nextToken":{ 2750 "shape":"NextToken", 2751 "documentation":"<p>The string that specifies the next page of results.</p>" 2752 }, 2753 "tabularPropertyValues":{ 2754 "shape":"TabularPropertyValues", 2755 "documentation":"<p>A table of property values.</p>" 2756 } 2757 } 2758 }, 2759 "GetSceneRequest":{ 2760 "type":"structure", 2761 "required":[ 2762 "workspaceId", 2763 "sceneId" 2764 ], 2765 "members":{ 2766 "workspaceId":{ 2767 "shape":"Id", 2768 "documentation":"<p>The ID of the workspace that contains the scene.</p>", 2769 "location":"uri", 2770 "locationName":"workspaceId" 2771 }, 2772 "sceneId":{ 2773 "shape":"Id", 2774 "documentation":"<p>The ID of the scene.</p>", 2775 "location":"uri", 2776 "locationName":"sceneId" 2777 } 2778 } 2779 }, 2780 "GetSceneResponse":{ 2781 "type":"structure", 2782 "required":[ 2783 "workspaceId", 2784 "sceneId", 2785 "contentLocation", 2786 "arn", 2787 "creationDateTime", 2788 "updateDateTime" 2789 ], 2790 "members":{ 2791 "workspaceId":{ 2792 "shape":"Id", 2793 "documentation":"<p>The ID of the workspace that contains the scene.</p>" 2794 }, 2795 "sceneId":{ 2796 "shape":"Id", 2797 "documentation":"<p>The ID of the scene.</p>" 2798 }, 2799 "contentLocation":{ 2800 "shape":"S3Url", 2801 "documentation":"<p>The relative path that specifies the location of the content definition file.</p>" 2802 }, 2803 "arn":{ 2804 "shape":"TwinMakerArn", 2805 "documentation":"<p>The ARN of the scene.</p>" 2806 }, 2807 "creationDateTime":{ 2808 "shape":"Timestamp", 2809 "documentation":"<p>The date and time when the scene was created.</p>" 2810 }, 2811 "updateDateTime":{ 2812 "shape":"Timestamp", 2813 "documentation":"<p>The date and time when the scene was last updated.</p>" 2814 }, 2815 "description":{ 2816 "shape":"Description", 2817 "documentation":"<p>The description of the scene.</p>" 2818 }, 2819 "capabilities":{ 2820 "shape":"SceneCapabilities", 2821 "documentation":"<p>A list of capabilities that the scene uses to render.</p>" 2822 }, 2823 "sceneMetadata":{ 2824 "shape":"SceneMetadataMap", 2825 "documentation":"<p>The response metadata.</p>" 2826 }, 2827 "generatedSceneMetadata":{ 2828 "shape":"GeneratedSceneMetadataMap", 2829 "documentation":"<p>The generated scene metadata.</p>" 2830 }, 2831 "error":{ 2832 "shape":"SceneError", 2833 "documentation":"<p>The SceneResponse error.</p>" 2834 } 2835 } 2836 }, 2837 "GetSyncJobRequest":{ 2838 "type":"structure", 2839 "required":["syncSource"], 2840 "members":{ 2841 "syncSource":{ 2842 "shape":"SyncSource", 2843 "documentation":"<p>The sync source.</p> <note> <p>Currently the only supported syncSource is <code>SITEWISE </code>.</p> </note>", 2844 "location":"uri", 2845 "locationName":"syncSource" 2846 }, 2847 "workspaceId":{ 2848 "shape":"Id", 2849 "documentation":"<p>The workspace ID.</p>", 2850 "location":"querystring", 2851 "locationName":"workspace" 2852 } 2853 } 2854 }, 2855 "GetSyncJobResponse":{ 2856 "type":"structure", 2857 "required":[ 2858 "arn", 2859 "workspaceId", 2860 "syncSource", 2861 "syncRole", 2862 "status", 2863 "creationDateTime", 2864 "updateDateTime" 2865 ], 2866 "members":{ 2867 "arn":{ 2868 "shape":"TwinMakerArn", 2869 "documentation":"<p>The sync job ARN.</p>" 2870 }, 2871 "workspaceId":{ 2872 "shape":"Id", 2873 "documentation":"<p>The ID of the workspace that contains the sync job.</p>" 2874 }, 2875 "syncSource":{ 2876 "shape":"SyncSource", 2877 "documentation":"<p>The sync soucre.</p> <note> <p>Currently the only supported syncSource is <code>SITEWISE </code>.</p> </note>" 2878 }, 2879 "syncRole":{ 2880 "shape":"RoleArn", 2881 "documentation":"<p>The sync IAM role.</p>" 2882 }, 2883 "status":{ 2884 "shape":"SyncJobStatus", 2885 "documentation":"<p>The SyncJob response status.</p>" 2886 }, 2887 "creationDateTime":{ 2888 "shape":"Timestamp", 2889 "documentation":"<p>The creation date and time.</p>" 2890 }, 2891 "updateDateTime":{ 2892 "shape":"Timestamp", 2893 "documentation":"<p>The update date and time.</p>" 2894 } 2895 } 2896 }, 2897 "GetWorkspaceRequest":{ 2898 "type":"structure", 2899 "required":["workspaceId"], 2900 "members":{ 2901 "workspaceId":{ 2902 "shape":"IdOrArn", 2903 "documentation":"<p>The ID of the workspace.</p>", 2904 "location":"uri", 2905 "locationName":"workspaceId" 2906 } 2907 } 2908 }, 2909 "GetWorkspaceResponse":{ 2910 "type":"structure", 2911 "required":[ 2912 "workspaceId", 2913 "arn", 2914 "creationDateTime", 2915 "updateDateTime" 2916 ], 2917 "members":{ 2918 "workspaceId":{ 2919 "shape":"Id", 2920 "documentation":"<p>The ID of the workspace.</p>" 2921 }, 2922 "arn":{ 2923 "shape":"TwinMakerArn", 2924 "documentation":"<p>The ARN of the workspace.</p>" 2925 }, 2926 "description":{ 2927 "shape":"Description", 2928 "documentation":"<p>The description of the workspace.</p>" 2929 }, 2930 "linkedServices":{ 2931 "shape":"LinkedServices", 2932 "documentation":"<p>A list of services that are linked to the workspace.</p>" 2933 }, 2934 "s3Location":{ 2935 "shape":"S3Location", 2936 "documentation":"<p>The ARN of the S3 bucket where resources associated with the workspace are stored.</p>" 2937 }, 2938 "role":{ 2939 "shape":"RoleArn", 2940 "documentation":"<p>The ARN of the execution role associated with the workspace.</p>" 2941 }, 2942 "creationDateTime":{ 2943 "shape":"Timestamp", 2944 "documentation":"<p>The date and time when the workspace was created.</p>" 2945 }, 2946 "updateDateTime":{ 2947 "shape":"Timestamp", 2948 "documentation":"<p>The date and time when the workspace was last updated.</p>" 2949 } 2950 } 2951 }, 2952 "GroupType":{ 2953 "type":"string", 2954 "enum":["TABULAR"] 2955 }, 2956 "Id":{ 2957 "type":"string", 2958 "max":128, 2959 "min":1, 2960 "pattern":"[a-zA-Z_0-9][a-zA-Z_\\-0-9]*[a-zA-Z0-9]+" 2961 }, 2962 "IdOrArn":{ 2963 "type":"string", 2964 "max":2048, 2965 "min":1, 2966 "pattern":"[a-zA-Z_0-9][a-zA-Z_\\-0-9]*[a-zA-Z0-9]+$|^arn:((aws)|(aws-cn)|(aws-us-gov)):iottwinmaker:[a-z0-9-]+:[0-9]{12}:[\\/a-zA-Z0-9_-]+" 2967 }, 2968 "Integer":{ 2969 "type":"integer", 2970 "box":true 2971 }, 2972 "InternalServerException":{ 2973 "type":"structure", 2974 "members":{ 2975 "message":{"shape":"ErrorMessage"} 2976 }, 2977 "documentation":"<p>An unexpected error has occurred.</p>", 2978 "error":{"httpStatusCode":500}, 2979 "exception":true, 2980 "fault":true 2981 }, 2982 "InterpolationParameters":{ 2983 "type":"structure", 2984 "members":{ 2985 "interpolationType":{ 2986 "shape":"InterpolationType", 2987 "documentation":"<p>The interpolation type.</p>" 2988 }, 2989 "intervalInSeconds":{ 2990 "shape":"IntervalInSeconds", 2991 "documentation":"<p>The interpolation time interval in seconds.</p>" 2992 } 2993 }, 2994 "documentation":"<p>An object that specifies how to interpolate data in a list.</p>" 2995 }, 2996 "InterpolationType":{ 2997 "type":"string", 2998 "enum":["LINEAR"] 2999 }, 3000 "IntervalInSeconds":{ 3001 "type":"long", 3002 "box":true 3003 }, 3004 "IotSiteWiseSourceConfiguration":{ 3005 "type":"structure", 3006 "members":{ 3007 "filters":{ 3008 "shape":"IotSiteWiseSourceConfigurationFilters", 3009 "documentation":"<p>The AWS IoT SiteWise soucre configuration filters.</p>" 3010 } 3011 }, 3012 "documentation":"<p>The metadata transfer job AWS IoT SiteWise source configuration.</p>" 3013 }, 3014 "IotSiteWiseSourceConfigurationFilter":{ 3015 "type":"structure", 3016 "members":{ 3017 "filterByAssetModel":{ 3018 "shape":"FilterByAssetModel", 3019 "documentation":"<p>Filter by asset model.</p>" 3020 }, 3021 "filterByAsset":{ 3022 "shape":"FilterByAsset", 3023 "documentation":"<p>Filter by asset.</p>" 3024 } 3025 }, 3026 "documentation":"<p>The AWS IoT SiteWise soucre configuration filter.[need held with desc here]</p>", 3027 "union":true 3028 }, 3029 "IotSiteWiseSourceConfigurationFilters":{ 3030 "type":"list", 3031 "member":{"shape":"IotSiteWiseSourceConfigurationFilter"} 3032 }, 3033 "IotTwinMakerDestinationConfiguration":{ 3034 "type":"structure", 3035 "required":["workspace"], 3036 "members":{ 3037 "workspace":{ 3038 "shape":"TwinMakerArn", 3039 "documentation":"<p>The IoT TwinMaker workspace.</p>" 3040 } 3041 }, 3042 "documentation":"<p>The metadata transfer job AWS IoT TwinMaker destination configuration.</p>" 3043 }, 3044 "IotTwinMakerSourceConfiguration":{ 3045 "type":"structure", 3046 "required":["workspace"], 3047 "members":{ 3048 "workspace":{ 3049 "shape":"TwinMakerArn", 3050 "documentation":"<p>The IoT TwinMaker workspace.</p>" 3051 }, 3052 "filters":{ 3053 "shape":"IotTwinMakerSourceConfigurationFilters", 3054 "documentation":"<p>The metadata transfer job AWS IoT TwinMaker source configuration filters.</p>" 3055 } 3056 }, 3057 "documentation":"<p>The metadata transfer job AWS IoT TwinMaker source configuration.</p>" 3058 }, 3059 "IotTwinMakerSourceConfigurationFilter":{ 3060 "type":"structure", 3061 "members":{ 3062 "filterByComponentType":{ 3063 "shape":"FilterByComponentType", 3064 "documentation":"<p>Filter by component type.</p>" 3065 }, 3066 "filterByEntity":{ 3067 "shape":"FilterByEntity", 3068 "documentation":"<p>Filter by entity.</p>" 3069 } 3070 }, 3071 "documentation":"<p>The metadata transfer job AWS IoT TwinMaker source configuration filter.</p>", 3072 "union":true 3073 }, 3074 "IotTwinMakerSourceConfigurationFilters":{ 3075 "type":"list", 3076 "member":{"shape":"IotTwinMakerSourceConfigurationFilter"} 3077 }, 3078 "LambdaArn":{ 3079 "type":"string", 3080 "max":2048, 3081 "min":20, 3082 "pattern":"arn:((aws)|(aws-cn)|(aws-us-gov)):lambda:[a-z0-9-]+:[0-9]{12}:function:[\\/a-zA-Z0-9_-]+" 3083 }, 3084 "LambdaFunction":{ 3085 "type":"structure", 3086 "required":["arn"], 3087 "members":{ 3088 "arn":{ 3089 "shape":"LambdaArn", 3090 "documentation":"<p>The ARN of the Lambda function.</p>" 3091 } 3092 }, 3093 "documentation":"<p>The Lambda function.</p>" 3094 }, 3095 "LinkedService":{ 3096 "type":"string", 3097 "pattern":"[a-zA-Z_0-9]+" 3098 }, 3099 "LinkedServices":{ 3100 "type":"list", 3101 "member":{"shape":"LinkedService"} 3102 }, 3103 "ListComponentTypesFilter":{ 3104 "type":"structure", 3105 "members":{ 3106 "extendsFrom":{ 3107 "shape":"ComponentTypeId", 3108 "documentation":"<p>The component type that the component types in the list extend.</p>" 3109 }, 3110 "namespace":{ 3111 "shape":"String", 3112 "documentation":"<p>The namespace to which the component types in the list belong.</p>" 3113 }, 3114 "isAbstract":{ 3115 "shape":"Boolean", 3116 "documentation":"<p>A Boolean value that specifies whether the component types in the list are abstract.</p>" 3117 } 3118 }, 3119 "documentation":"<p>An object that filters items in a list of component types.</p> <note> <p>Only one object is accepted as a valid input.</p> </note>", 3120 "union":true 3121 }, 3122 "ListComponentTypesFilters":{ 3123 "type":"list", 3124 "member":{"shape":"ListComponentTypesFilter"} 3125 }, 3126 "ListComponentTypesRequest":{ 3127 "type":"structure", 3128 "required":["workspaceId"], 3129 "members":{ 3130 "workspaceId":{ 3131 "shape":"Id", 3132 "documentation":"<p>The ID of the workspace.</p>", 3133 "location":"uri", 3134 "locationName":"workspaceId" 3135 }, 3136 "filters":{ 3137 "shape":"ListComponentTypesFilters", 3138 "documentation":"<p>A list of objects that filter the request.</p>" 3139 }, 3140 "nextToken":{ 3141 "shape":"NextToken", 3142 "documentation":"<p>The string that specifies the next page of results.</p>" 3143 }, 3144 "maxResults":{ 3145 "shape":"MaxResults", 3146 "documentation":"<p>The maximum number of results to return at one time. The default is 25.</p> <p>Valid Range: Minimum value of 1. Maximum value of 250.</p>" 3147 } 3148 } 3149 }, 3150 "ListComponentTypesResponse":{ 3151 "type":"structure", 3152 "required":[ 3153 "workspaceId", 3154 "componentTypeSummaries" 3155 ], 3156 "members":{ 3157 "workspaceId":{ 3158 "shape":"Id", 3159 "documentation":"<p>The ID of the workspace.</p>" 3160 }, 3161 "componentTypeSummaries":{ 3162 "shape":"ComponentTypeSummaries", 3163 "documentation":"<p>A list of objects that contain information about the component types.</p>" 3164 }, 3165 "nextToken":{ 3166 "shape":"NextToken", 3167 "documentation":"<p>The string that specifies the next page of results.</p>" 3168 }, 3169 "maxResults":{ 3170 "shape":"MaxResults", 3171 "documentation":"<p>Specifies the maximum number of results to display.</p>" 3172 } 3173 } 3174 }, 3175 "ListComponentsRequest":{ 3176 "type":"structure", 3177 "required":[ 3178 "workspaceId", 3179 "entityId" 3180 ], 3181 "members":{ 3182 "workspaceId":{ 3183 "shape":"Id", 3184 "documentation":"<p>The workspace ID.</p>", 3185 "location":"uri", 3186 "locationName":"workspaceId" 3187 }, 3188 "entityId":{ 3189 "shape":"EntityId", 3190 "documentation":"<p>The ID for the entity whose metadata (component/properties) is returned by the operation.</p>", 3191 "location":"uri", 3192 "locationName":"entityId" 3193 }, 3194 "componentPath":{ 3195 "shape":"ComponentPath", 3196 "documentation":"<p>This string specifies the path to the composite component, starting from the top-level component.</p>" 3197 }, 3198 "maxResults":{ 3199 "shape":"MaxResults", 3200 "documentation":"<p>The maximum number of results returned at one time. The default is 25.</p>" 3201 }, 3202 "nextToken":{ 3203 "shape":"NextToken", 3204 "documentation":"<p>The string that specifies the next page of results.</p>" 3205 } 3206 } 3207 }, 3208 "ListComponentsResponse":{ 3209 "type":"structure", 3210 "required":["componentSummaries"], 3211 "members":{ 3212 "componentSummaries":{ 3213 "shape":"ComponentSummaries", 3214 "documentation":"<p>A list of objects that contain information about the components.</p>" 3215 }, 3216 "nextToken":{ 3217 "shape":"NextToken", 3218 "documentation":"<p>The string that specifies the next page of component results.</p>" 3219 } 3220 } 3221 }, 3222 "ListEntitiesFilter":{ 3223 "type":"structure", 3224 "members":{ 3225 "parentEntityId":{ 3226 "shape":"ParentEntityId", 3227 "documentation":"<p>The parent of the entities in the list.</p>" 3228 }, 3229 "componentTypeId":{ 3230 "shape":"ComponentTypeId", 3231 "documentation":"<p>The ID of the component type in the entities in the list.</p>" 3232 }, 3233 "externalId":{ 3234 "shape":"String", 3235 "documentation":"<p>The external-Id property of a component. The external-Id property is the primary key of an external storage system.</p>" 3236 } 3237 }, 3238 "documentation":"<p>An object that filters items in a list of entities.</p>", 3239 "union":true 3240 }, 3241 "ListEntitiesFilters":{ 3242 "type":"list", 3243 "member":{"shape":"ListEntitiesFilter"} 3244 }, 3245 "ListEntitiesRequest":{ 3246 "type":"structure", 3247 "required":["workspaceId"], 3248 "members":{ 3249 "workspaceId":{ 3250 "shape":"Id", 3251 "documentation":"<p>The ID of the workspace.</p>", 3252 "location":"uri", 3253 "locationName":"workspaceId" 3254 }, 3255 "filters":{ 3256 "shape":"ListEntitiesFilters", 3257 "documentation":"<p>A list of objects that filter the request.</p> <note> <p>Only one object is accepted as a valid input.</p> </note>" 3258 }, 3259 "maxResults":{ 3260 "shape":"MaxResults", 3261 "documentation":"<p>The maximum number of results to return at one time. The default is 25.</p> <p>Valid Range: Minimum value of 1. Maximum value of 250.</p>" 3262 }, 3263 "nextToken":{ 3264 "shape":"NextToken", 3265 "documentation":"<p>The string that specifies the next page of results.</p>" 3266 } 3267 } 3268 }, 3269 "ListEntitiesResponse":{ 3270 "type":"structure", 3271 "members":{ 3272 "entitySummaries":{ 3273 "shape":"EntitySummaries", 3274 "documentation":"<p>A list of objects that contain information about the entities.</p>" 3275 }, 3276 "nextToken":{ 3277 "shape":"NextToken", 3278 "documentation":"<p>The string that specifies the next page of results.</p>" 3279 } 3280 } 3281 }, 3282 "ListMetadataTransferJobsFilter":{ 3283 "type":"structure", 3284 "members":{ 3285 "workspaceId":{ 3286 "shape":"Id", 3287 "documentation":"<p>The workspace Id.</p>" 3288 }, 3289 "state":{ 3290 "shape":"MetadataTransferJobState", 3291 "documentation":"<p>The filter state.</p>" 3292 } 3293 }, 3294 "documentation":"<p>The ListMetadataTransferJobs filter.</p>", 3295 "union":true 3296 }, 3297 "ListMetadataTransferJobsFilters":{ 3298 "type":"list", 3299 "member":{"shape":"ListMetadataTransferJobsFilter"} 3300 }, 3301 "ListMetadataTransferJobsRequest":{ 3302 "type":"structure", 3303 "required":[ 3304 "sourceType", 3305 "destinationType" 3306 ], 3307 "members":{ 3308 "sourceType":{ 3309 "shape":"SourceType", 3310 "documentation":"<p>The metadata transfer job's source type.</p>" 3311 }, 3312 "destinationType":{ 3313 "shape":"DestinationType", 3314 "documentation":"<p>The metadata transfer job's destination type.</p>" 3315 }, 3316 "filters":{ 3317 "shape":"ListMetadataTransferJobsFilters", 3318 "documentation":"<p>An object that filters metadata transfer jobs.</p>" 3319 }, 3320 "nextToken":{ 3321 "shape":"NextToken", 3322 "documentation":"<p>The string that specifies the next page of results.</p>" 3323 }, 3324 "maxResults":{ 3325 "shape":"MaxResults", 3326 "documentation":"<p>The maximum number of results to return at one time.</p>" 3327 } 3328 } 3329 }, 3330 "ListMetadataTransferJobsResponse":{ 3331 "type":"structure", 3332 "required":["metadataTransferJobSummaries"], 3333 "members":{ 3334 "metadataTransferJobSummaries":{ 3335 "shape":"MetadataTransferJobSummaries", 3336 "documentation":"<p>The metadata transfer job summaries.</p>" 3337 }, 3338 "nextToken":{ 3339 "shape":"NextToken", 3340 "documentation":"<p>The string that specifies the next page of results.</p>" 3341 } 3342 } 3343 }, 3344 "ListPropertiesRequest":{ 3345 "type":"structure", 3346 "required":[ 3347 "workspaceId", 3348 "entityId" 3349 ], 3350 "members":{ 3351 "workspaceId":{ 3352 "shape":"Id", 3353 "documentation":"<p>The workspace ID.</p>", 3354 "location":"uri", 3355 "locationName":"workspaceId" 3356 }, 3357 "componentName":{ 3358 "shape":"Name", 3359 "documentation":"<p>The name of the component whose properties are returned by the operation.</p>" 3360 }, 3361 "componentPath":{ 3362 "shape":"ComponentPath", 3363 "documentation":"<p>This string specifies the path to the composite component, starting from the top-level component.</p>" 3364 }, 3365 "entityId":{ 3366 "shape":"EntityId", 3367 "documentation":"<p>The ID for the entity whose metadata (component/properties) is returned by the operation.</p>" 3368 }, 3369 "maxResults":{ 3370 "shape":"MaxResults", 3371 "documentation":"<p>The maximum number of results returned at one time. The default is 25.</p>" 3372 }, 3373 "nextToken":{ 3374 "shape":"NextToken", 3375 "documentation":"<p>The string that specifies the next page of results.</p>" 3376 } 3377 } 3378 }, 3379 "ListPropertiesResponse":{ 3380 "type":"structure", 3381 "required":["propertySummaries"], 3382 "members":{ 3383 "propertySummaries":{ 3384 "shape":"PropertySummaries", 3385 "documentation":"<p>A list of objects that contain information about the properties.</p>" 3386 }, 3387 "nextToken":{ 3388 "shape":"NextToken", 3389 "documentation":"<p>The string that specifies the next page of property results.</p>" 3390 } 3391 } 3392 }, 3393 "ListScenesRequest":{ 3394 "type":"structure", 3395 "required":["workspaceId"], 3396 "members":{ 3397 "workspaceId":{ 3398 "shape":"Id", 3399 "documentation":"<p>The ID of the workspace that contains the scenes.</p>", 3400 "location":"uri", 3401 "locationName":"workspaceId" 3402 }, 3403 "maxResults":{ 3404 "shape":"MaxResults", 3405 "documentation":"<p>Specifies the maximum number of results to display.</p>" 3406 }, 3407 "nextToken":{ 3408 "shape":"NextToken", 3409 "documentation":"<p>The string that specifies the next page of results.</p>" 3410 } 3411 } 3412 }, 3413 "ListScenesResponse":{ 3414 "type":"structure", 3415 "members":{ 3416 "sceneSummaries":{ 3417 "shape":"SceneSummaries", 3418 "documentation":"<p>A list of objects that contain information about the scenes.</p>" 3419 }, 3420 "nextToken":{ 3421 "shape":"NextToken", 3422 "documentation":"<p>The string that specifies the next page of results.</p>" 3423 } 3424 } 3425 }, 3426 "ListSyncJobsRequest":{ 3427 "type":"structure", 3428 "required":["workspaceId"], 3429 "members":{ 3430 "workspaceId":{ 3431 "shape":"Id", 3432 "documentation":"<p>The ID of the workspace that contains the sync job.</p>", 3433 "location":"uri", 3434 "locationName":"workspaceId" 3435 }, 3436 "maxResults":{ 3437 "shape":"MaxResults", 3438 "documentation":"<p>The maximum number of results to return at one time. The default is 50.</p> <p>Valid Range: Minimum value of 0. Maximum value of 200.</p>" 3439 }, 3440 "nextToken":{ 3441 "shape":"NextToken", 3442 "documentation":"<p>The string that specifies the next page of results.</p>" 3443 } 3444 } 3445 }, 3446 "ListSyncJobsResponse":{ 3447 "type":"structure", 3448 "members":{ 3449 "syncJobSummaries":{ 3450 "shape":"SyncJobSummaries", 3451 "documentation":"<p>The listed SyncJob summaries.</p>" 3452 }, 3453 "nextToken":{ 3454 "shape":"NextToken", 3455 "documentation":"<p>The string that specifies the next page of results.</p>" 3456 } 3457 } 3458 }, 3459 "ListSyncResourcesRequest":{ 3460 "type":"structure", 3461 "required":[ 3462 "workspaceId", 3463 "syncSource" 3464 ], 3465 "members":{ 3466 "workspaceId":{ 3467 "shape":"Id", 3468 "documentation":"<p>The ID of the workspace that contains the sync job.</p>", 3469 "location":"uri", 3470 "locationName":"workspaceId" 3471 }, 3472 "syncSource":{ 3473 "shape":"SyncSource", 3474 "documentation":"<p>The sync source.</p> <note> <p>Currently the only supported syncSource is <code>SITEWISE </code>.</p> </note>", 3475 "location":"uri", 3476 "locationName":"syncSource" 3477 }, 3478 "filters":{ 3479 "shape":"SyncResourceFilters", 3480 "documentation":"<p>A list of objects that filter the request.</p> <p>The following filter combinations are supported:</p> <ul> <li> <p>Filter with state</p> </li> <li> <p>Filter with ResourceType and ResourceId</p> </li> <li> <p>Filter with ResourceType and ExternalId</p> </li> </ul>" 3481 }, 3482 "maxResults":{ 3483 "shape":"MaxResults", 3484 "documentation":"<p>The maximum number of results to return at one time. The default is 50.</p> <p>Valid Range: Minimum value of 0. Maximum value of 200.</p>" 3485 }, 3486 "nextToken":{ 3487 "shape":"NextToken", 3488 "documentation":"<p>The string that specifies the next page of results.</p>" 3489 } 3490 } 3491 }, 3492 "ListSyncResourcesResponse":{ 3493 "type":"structure", 3494 "members":{ 3495 "syncResources":{ 3496 "shape":"SyncResourceSummaries", 3497 "documentation":"<p>The sync resources.</p>" 3498 }, 3499 "nextToken":{ 3500 "shape":"NextToken", 3501 "documentation":"<p>The string that specifies the next page of results.</p>" 3502 } 3503 } 3504 }, 3505 "ListTagsForResourceRequest":{ 3506 "type":"structure", 3507 "required":["resourceARN"], 3508 "members":{ 3509 "resourceARN":{ 3510 "shape":"TwinMakerArn", 3511 "documentation":"<p>The ARN of the resource.</p>" 3512 }, 3513 "maxResults":{ 3514 "shape":"MaxResults", 3515 "documentation":"<p>The maximum number of results to return at one time. The default is 25.</p> <p>Valid Range: Minimum value of 1. Maximum value of 250.</p>" 3516 }, 3517 "nextToken":{ 3518 "shape":"NextToken", 3519 "documentation":"<p>The string that specifies the next page of results.</p>" 3520 } 3521 } 3522 }, 3523 "ListTagsForResourceResponse":{ 3524 "type":"structure", 3525 "members":{ 3526 "tags":{ 3527 "shape":"TagMap", 3528 "documentation":"<p>Metadata that you can use to manage a resource.</p>" 3529 }, 3530 "nextToken":{ 3531 "shape":"NextToken", 3532 "documentation":"<p>The string that specifies the next page of results.</p>" 3533 } 3534 } 3535 }, 3536 "ListWorkspacesRequest":{ 3537 "type":"structure", 3538 "members":{ 3539 "maxResults":{ 3540 "shape":"MaxResults", 3541 "documentation":"<p>The maximum number of results to return at one time. The default is 25.</p> <p>Valid Range: Minimum value of 1. Maximum value of 250.</p>" 3542 }, 3543 "nextToken":{ 3544 "shape":"NextToken", 3545 "documentation":"<p>The string that specifies the next page of results.</p>" 3546 } 3547 } 3548 }, 3549 "ListWorkspacesResponse":{ 3550 "type":"structure", 3551 "members":{ 3552 "workspaceSummaries":{ 3553 "shape":"WorkspaceSummaries", 3554 "documentation":"<p>A list of objects that contain information about the workspaces.</p>" 3555 }, 3556 "nextToken":{ 3557 "shape":"NextToken", 3558 "documentation":"<p>The string that specifies the next page of results.</p>" 3559 } 3560 } 3561 }, 3562 "Long":{ 3563 "type":"long", 3564 "box":true 3565 }, 3566 "MaxResults":{ 3567 "type":"integer", 3568 "box":true, 3569 "max":200, 3570 "min":0 3571 }, 3572 "MetadataTransferJobProgress":{ 3573 "type":"structure", 3574 "members":{ 3575 "totalCount":{ 3576 "shape":"Integer", 3577 "documentation":"<p>The total count. [of what]</p>" 3578 }, 3579 "succeededCount":{ 3580 "shape":"Integer", 3581 "documentation":"<p>The succeeded count.</p>" 3582 }, 3583 "skippedCount":{ 3584 "shape":"Integer", 3585 "documentation":"<p>The skipped count.</p>" 3586 }, 3587 "failedCount":{ 3588 "shape":"Integer", 3589 "documentation":"<p>The failed count.</p>" 3590 } 3591 }, 3592 "documentation":"<p>The metadata transfer job's progress.</p>" 3593 }, 3594 "MetadataTransferJobState":{ 3595 "type":"string", 3596 "enum":[ 3597 "VALIDATING", 3598 "PENDING", 3599 "RUNNING", 3600 "CANCELLING", 3601 "ERROR", 3602 "COMPLETED", 3603 "CANCELLED" 3604 ] 3605 }, 3606 "MetadataTransferJobStatus":{ 3607 "type":"structure", 3608 "members":{ 3609 "state":{ 3610 "shape":"MetadataTransferJobState", 3611 "documentation":"<p>The metadata transfer job state.</p>" 3612 }, 3613 "error":{ 3614 "shape":"ErrorDetails", 3615 "documentation":"<p>The metadata transfer job error.</p>" 3616 }, 3617 "queuedPosition":{ 3618 "shape":"Integer", 3619 "documentation":"<p>The queued position.</p>" 3620 } 3621 }, 3622 "documentation":"<p>The metadata transfer job status.</p>" 3623 }, 3624 "MetadataTransferJobSummaries":{ 3625 "type":"list", 3626 "member":{"shape":"MetadataTransferJobSummary"} 3627 }, 3628 "MetadataTransferJobSummary":{ 3629 "type":"structure", 3630 "required":[ 3631 "metadataTransferJobId", 3632 "arn", 3633 "creationDateTime", 3634 "updateDateTime", 3635 "status" 3636 ], 3637 "members":{ 3638 "metadataTransferJobId":{ 3639 "shape":"Id", 3640 "documentation":"<p>The metadata transfer job summary Id.</p>" 3641 }, 3642 "arn":{ 3643 "shape":"TwinMakerArn", 3644 "documentation":"<p>The metadata transfer job summary ARN.</p>" 3645 }, 3646 "creationDateTime":{ 3647 "shape":"Timestamp", 3648 "documentation":"<p>The metadata transfer job summary creation DateTime object.</p>" 3649 }, 3650 "updateDateTime":{ 3651 "shape":"Timestamp", 3652 "documentation":"<p>The metadata transfer job summary update DateTime object</p>" 3653 }, 3654 "status":{ 3655 "shape":"MetadataTransferJobStatus", 3656 "documentation":"<p>The metadata transfer job summary status.</p>" 3657 }, 3658 "progress":{ 3659 "shape":"MetadataTransferJobProgress", 3660 "documentation":"<p>The metadata transfer job summary progess.</p>" 3661 } 3662 }, 3663 "documentation":"<p>The metadata transfer job summary.</p>" 3664 }, 3665 "Name":{ 3666 "type":"string", 3667 "max":256, 3668 "min":1, 3669 "pattern":"[a-zA-Z_\\-0-9]+" 3670 }, 3671 "NextToken":{ 3672 "type":"string", 3673 "max":17880, 3674 "min":0, 3675 "pattern":".*" 3676 }, 3677 "Order":{ 3678 "type":"string", 3679 "enum":[ 3680 "ASCENDING", 3681 "DESCENDING" 3682 ] 3683 }, 3684 "OrderBy":{ 3685 "type":"structure", 3686 "required":["propertyName"], 3687 "members":{ 3688 "order":{ 3689 "shape":"Order", 3690 "documentation":"<p>The set order that filters results.</p>" 3691 }, 3692 "propertyName":{ 3693 "shape":"String", 3694 "documentation":"<p>The property name.</p>" 3695 } 3696 }, 3697 "documentation":"<p>Filter criteria that orders the return output. It can be sorted in ascending or descending order.</p>" 3698 }, 3699 "OrderByList":{ 3700 "type":"list", 3701 "member":{"shape":"OrderBy"}, 3702 "max":10, 3703 "min":1 3704 }, 3705 "OrderByTime":{ 3706 "type":"string", 3707 "enum":[ 3708 "ASCENDING", 3709 "DESCENDING" 3710 ] 3711 }, 3712 "ParentEntityId":{ 3713 "type":"string", 3714 "max":128, 3715 "min":1, 3716 "pattern":"\\$ROOT|^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|^[a-zA-Z0-9][a-zA-Z_\\-0-9.:]*[a-zA-Z0-9]+" 3717 }, 3718 "ParentEntityUpdateRequest":{ 3719 "type":"structure", 3720 "required":["updateType"], 3721 "members":{ 3722 "updateType":{ 3723 "shape":"ParentEntityUpdateType", 3724 "documentation":"<p>The type of the update.</p>" 3725 }, 3726 "parentEntityId":{ 3727 "shape":"ParentEntityId", 3728 "documentation":"<p>The ID of the parent entity.</p>" 3729 } 3730 }, 3731 "documentation":"<p>The parent entity update request.</p>" 3732 }, 3733 "ParentEntityUpdateType":{ 3734 "type":"string", 3735 "enum":[ 3736 "UPDATE", 3737 "DELETE" 3738 ] 3739 }, 3740 "PricingBundles":{ 3741 "type":"list", 3742 "member":{"shape":"BundleName"}, 3743 "max":10, 3744 "min":1 3745 }, 3746 "PricingMode":{ 3747 "type":"string", 3748 "enum":[ 3749 "BASIC", 3750 "STANDARD", 3751 "TIERED_BUNDLE" 3752 ] 3753 }, 3754 "PricingPlan":{ 3755 "type":"structure", 3756 "required":[ 3757 "effectiveDateTime", 3758 "pricingMode", 3759 "updateDateTime", 3760 "updateReason" 3761 ], 3762 "members":{ 3763 "billableEntityCount":{ 3764 "shape":"Long", 3765 "documentation":"<p>The billable entity count.</p>" 3766 }, 3767 "bundleInformation":{ 3768 "shape":"BundleInformation", 3769 "documentation":"<p>The pricing plan's bundle information.</p>" 3770 }, 3771 "effectiveDateTime":{ 3772 "shape":"Timestamp", 3773 "documentation":"<p>The effective date and time of the pricing plan.</p>" 3774 }, 3775 "pricingMode":{ 3776 "shape":"PricingMode", 3777 "documentation":"<p>The pricing mode.</p>" 3778 }, 3779 "updateDateTime":{ 3780 "shape":"Timestamp", 3781 "documentation":"<p>The set date and time for updating a pricing plan.</p>" 3782 }, 3783 "updateReason":{ 3784 "shape":"UpdateReason", 3785 "documentation":"<p>The update reason for changing a pricing plan.</p>" 3786 } 3787 }, 3788 "documentation":"<p>The pricing plan.</p>" 3789 }, 3790 "PricingTier":{ 3791 "type":"string", 3792 "enum":[ 3793 "TIER_1", 3794 "TIER_2", 3795 "TIER_3", 3796 "TIER_4" 3797 ] 3798 }, 3799 "PropertyDefinitionRequest":{ 3800 "type":"structure", 3801 "members":{ 3802 "dataType":{ 3803 "shape":"DataType", 3804 "documentation":"<p>An object that contains information about the data type.</p>" 3805 }, 3806 "isRequiredInEntity":{ 3807 "shape":"Boolean", 3808 "documentation":"<p>A Boolean value that specifies whether the property is required.</p>" 3809 }, 3810 "isExternalId":{ 3811 "shape":"Boolean", 3812 "documentation":"<p>A Boolean value that specifies whether the property ID comes from an external data store.</p>" 3813 }, 3814 "isStoredExternally":{ 3815 "shape":"Boolean", 3816 "documentation":"<p>A Boolean value that specifies whether the property is stored externally.</p>" 3817 }, 3818 "isTimeSeries":{ 3819 "shape":"Boolean", 3820 "documentation":"<p>A Boolean value that specifies whether the property consists of time series data.</p>" 3821 }, 3822 "defaultValue":{ 3823 "shape":"DataValue", 3824 "documentation":"<p>An object that contains the default value.</p>" 3825 }, 3826 "configuration":{ 3827 "shape":"Configuration", 3828 "documentation":"<p>A mapping that specifies configuration information about the property. Use this field to specify information that you read from and write to an external source.</p>" 3829 }, 3830 "displayName":{ 3831 "shape":"PropertyDisplayName", 3832 "documentation":"<p>A friendly name for the property.</p>" 3833 } 3834 }, 3835 "documentation":"<p>An object that sets information about a property.</p>" 3836 }, 3837 "PropertyDefinitionResponse":{ 3838 "type":"structure", 3839 "required":[ 3840 "dataType", 3841 "isTimeSeries", 3842 "isRequiredInEntity", 3843 "isExternalId", 3844 "isStoredExternally", 3845 "isImported", 3846 "isFinal", 3847 "isInherited" 3848 ], 3849 "members":{ 3850 "dataType":{ 3851 "shape":"DataType", 3852 "documentation":"<p>An object that contains information about the data type.</p>" 3853 }, 3854 "isTimeSeries":{ 3855 "shape":"Boolean", 3856 "documentation":"<p>A Boolean value that specifies whether the property consists of time series data.</p>" 3857 }, 3858 "isRequiredInEntity":{ 3859 "shape":"Boolean", 3860 "documentation":"<p>A Boolean value that specifies whether the property is required in an entity.</p>" 3861 }, 3862 "isExternalId":{ 3863 "shape":"Boolean", 3864 "documentation":"<p>A Boolean value that specifies whether the property ID comes from an external data store.</p>" 3865 }, 3866 "isStoredExternally":{ 3867 "shape":"Boolean", 3868 "documentation":"<p>A Boolean value that specifies whether the property is stored externally.</p>" 3869 }, 3870 "isImported":{ 3871 "shape":"Boolean", 3872 "documentation":"<p>A Boolean value that specifies whether the property definition is imported from an external data store.</p>" 3873 }, 3874 "isFinal":{ 3875 "shape":"Boolean", 3876 "documentation":"<p>A Boolean value that specifies whether the property definition can be updated.</p>" 3877 }, 3878 "isInherited":{ 3879 "shape":"Boolean", 3880 "documentation":"<p>A Boolean value that specifies whether the property definition is inherited from a parent entity.</p>" 3881 }, 3882 "defaultValue":{ 3883 "shape":"DataValue", 3884 "documentation":"<p>An object that contains the default value.</p>" 3885 }, 3886 "configuration":{ 3887 "shape":"Configuration", 3888 "documentation":"<p>A mapping that specifies configuration information about the property.</p>" 3889 }, 3890 "displayName":{ 3891 "shape":"PropertyDisplayName", 3892 "documentation":"<p>A friendly name for the property.</p>" 3893 } 3894 }, 3895 "documentation":"<p>An object that contains response data from a property definition request.</p>" 3896 }, 3897 "PropertyDefinitionsRequest":{ 3898 "type":"map", 3899 "key":{"shape":"Name"}, 3900 "value":{"shape":"PropertyDefinitionRequest"} 3901 }, 3902 "PropertyDefinitionsResponse":{ 3903 "type":"map", 3904 "key":{"shape":"Name"}, 3905 "value":{"shape":"PropertyDefinitionResponse"} 3906 }, 3907 "PropertyDisplayName":{ 3908 "type":"string", 3909 "max":256, 3910 "min":0, 3911 "pattern":".*[^\\u0000-\\u001F\\u007F]*.*" 3912 }, 3913 "PropertyFilter":{ 3914 "type":"structure", 3915 "members":{ 3916 "propertyName":{ 3917 "shape":"String", 3918 "documentation":"<p>The property name associated with this property filter.</p>" 3919 }, 3920 "operator":{ 3921 "shape":"String", 3922 "documentation":"<p>The operator associated with this property filter.</p>" 3923 }, 3924 "value":{ 3925 "shape":"DataValue", 3926 "documentation":"<p>The value associated with this property filter.</p>" 3927 } 3928 }, 3929 "documentation":"<p>An object that filters items returned by a property request.</p>" 3930 }, 3931 "PropertyFilters":{ 3932 "type":"list", 3933 "member":{"shape":"PropertyFilter"}, 3934 "max":10, 3935 "min":1 3936 }, 3937 "PropertyGroupRequest":{ 3938 "type":"structure", 3939 "members":{ 3940 "groupType":{ 3941 "shape":"GroupType", 3942 "documentation":"<p>The group type.</p>" 3943 }, 3944 "propertyNames":{ 3945 "shape":"PropertyNames", 3946 "documentation":"<p>The names of properties.</p>" 3947 } 3948 }, 3949 "documentation":"<p/>" 3950 }, 3951 "PropertyGroupResponse":{ 3952 "type":"structure", 3953 "required":[ 3954 "groupType", 3955 "propertyNames", 3956 "isInherited" 3957 ], 3958 "members":{ 3959 "groupType":{ 3960 "shape":"GroupType", 3961 "documentation":"<p>The group types.</p>" 3962 }, 3963 "propertyNames":{ 3964 "shape":"PropertyNames", 3965 "documentation":"<p>The names of properties.</p>" 3966 }, 3967 "isInherited":{ 3968 "shape":"Boolean", 3969 "documentation":"<p>A Boolean value that specifies whether the property group is inherited from a parent entity</p>" 3970 } 3971 }, 3972 "documentation":"<p>The property group response</p>" 3973 }, 3974 "PropertyGroupUpdateType":{ 3975 "type":"string", 3976 "enum":[ 3977 "UPDATE", 3978 "DELETE", 3979 "CREATE" 3980 ] 3981 }, 3982 "PropertyGroupsRequest":{ 3983 "type":"map", 3984 "key":{"shape":"Name"}, 3985 "value":{"shape":"PropertyGroupRequest"} 3986 }, 3987 "PropertyGroupsResponse":{ 3988 "type":"map", 3989 "key":{"shape":"Name"}, 3990 "value":{"shape":"PropertyGroupResponse"} 3991 }, 3992 "PropertyLatestValue":{ 3993 "type":"structure", 3994 "required":["propertyReference"], 3995 "members":{ 3996 "propertyReference":{ 3997 "shape":"EntityPropertyReference", 3998 "documentation":"<p>An object that specifies information about a property.</p>" 3999 }, 4000 "propertyValue":{ 4001 "shape":"DataValue", 4002 "documentation":"<p>The value of the property.</p>" 4003 } 4004 }, 4005 "documentation":"<p>The latest value of the property.</p>" 4006 }, 4007 "PropertyLatestValueMap":{ 4008 "type":"map", 4009 "key":{"shape":"Name"}, 4010 "value":{"shape":"PropertyLatestValue"} 4011 }, 4012 "PropertyNames":{ 4013 "type":"list", 4014 "member":{"shape":"Name"} 4015 }, 4016 "PropertyRequest":{ 4017 "type":"structure", 4018 "members":{ 4019 "definition":{ 4020 "shape":"PropertyDefinitionRequest", 4021 "documentation":"<p>An object that specifies information about a property.</p>" 4022 }, 4023 "value":{ 4024 "shape":"DataValue", 4025 "documentation":"<p>The value of the property.</p>" 4026 }, 4027 "updateType":{ 4028 "shape":"PropertyUpdateType", 4029 "documentation":"<p>The update type of the update property request.</p>" 4030 } 4031 }, 4032 "documentation":"<p>An object that sets information about a property.</p>" 4033 }, 4034 "PropertyRequests":{ 4035 "type":"map", 4036 "key":{"shape":"Name"}, 4037 "value":{"shape":"PropertyRequest"} 4038 }, 4039 "PropertyResponse":{ 4040 "type":"structure", 4041 "members":{ 4042 "definition":{ 4043 "shape":"PropertyDefinitionResponse", 4044 "documentation":"<p>An object that specifies information about a property.</p>" 4045 }, 4046 "value":{ 4047 "shape":"DataValue", 4048 "documentation":"<p>The value of the property.</p>" 4049 }, 4050 "areAllPropertyValuesReturned":{ 4051 "shape":"Boolean", 4052 "documentation":"<p>This flag notes whether all values of a list or map type property are returned in the API response. The maximum number of values per property returned is 50.</p>" 4053 } 4054 }, 4055 "documentation":"<p>An object that contains information about a property response.</p>" 4056 }, 4057 "PropertyResponses":{ 4058 "type":"map", 4059 "key":{"shape":"Name"}, 4060 "value":{"shape":"PropertyResponse"} 4061 }, 4062 "PropertySummaries":{ 4063 "type":"list", 4064 "member":{"shape":"PropertySummary"} 4065 }, 4066 "PropertySummary":{ 4067 "type":"structure", 4068 "required":["propertyName"], 4069 "members":{ 4070 "definition":{ 4071 "shape":"PropertyDefinitionResponse", 4072 "documentation":"<p>This is the schema for the property.</p>" 4073 }, 4074 "propertyName":{ 4075 "shape":"Name", 4076 "documentation":"<p>This is the name of the property.</p>" 4077 }, 4078 "value":{ 4079 "shape":"DataValue", 4080 "documentation":"<p>This is the value for the property.</p>" 4081 }, 4082 "areAllPropertyValuesReturned":{ 4083 "shape":"Boolean", 4084 "documentation":"<p>This flag notes whether all values of a list or map type property are returned in the API response. The maximum number of values per property returned is 50.</p>" 4085 } 4086 }, 4087 "documentation":"<p>This is an object that contains the information of a property.</p>" 4088 }, 4089 "PropertyTableValue":{ 4090 "type":"map", 4091 "key":{"shape":"Name"}, 4092 "value":{"shape":"DataValue"} 4093 }, 4094 "PropertyUpdateType":{ 4095 "type":"string", 4096 "enum":[ 4097 "UPDATE", 4098 "DELETE", 4099 "CREATE" 4100 ] 4101 }, 4102 "PropertyValue":{ 4103 "type":"structure", 4104 "required":["value"], 4105 "members":{ 4106 "timestamp":{ 4107 "shape":"Timestamp", 4108 "documentation":"<p>The timestamp of a value for a time series property.</p>", 4109 "deprecated":true, 4110 "deprecatedMessage":"This field is deprecated and will throw an error in the future. Use time instead." 4111 }, 4112 "value":{ 4113 "shape":"DataValue", 4114 "documentation":"<p>An object that specifies a value for a time series property.</p>" 4115 }, 4116 "time":{ 4117 "shape":"Time", 4118 "documentation":"<p>ISO8601 DateTime of a value for a time series property.</p> <p>The time for when the property value was recorded in ISO 8601 format: <i>YYYY-MM-DDThh:mm:ss[.SSSSSSSSS][Z/±HH:mm]</i>.</p> <ul> <li> <p> <i>[YYYY]</i>: year</p> </li> <li> <p> <i>[MM]</i>: month</p> </li> <li> <p> <i>[DD]</i>: day</p> </li> <li> <p> <i>[hh]</i>: hour</p> </li> <li> <p> <i>[mm]</i>: minute</p> </li> <li> <p> <i>[ss]</i>: seconds</p> </li> <li> <p> <i>[.SSSSSSSSS]</i>: additional precision, where precedence is maintained. For example: [.573123] is equal to 573123000 nanoseconds.</p> </li> <li> <p> <i>Z</i>: default timezone UTC</p> </li> <li> <p> <i>± HH:mm</i>: time zone offset in Hours and Minutes.</p> </li> </ul> <p> <i>Required sub-fields</i>: YYYY-MM-DDThh:mm:ss and [Z/±HH:mm]</p>" 4119 } 4120 }, 4121 "documentation":"<p>An object that contains information about a value for a time series property.</p>" 4122 }, 4123 "PropertyValueEntry":{ 4124 "type":"structure", 4125 "required":["entityPropertyReference"], 4126 "members":{ 4127 "entityPropertyReference":{ 4128 "shape":"EntityPropertyReference", 4129 "documentation":"<p>An object that contains information about the entity that has the property.</p>" 4130 }, 4131 "propertyValues":{ 4132 "shape":"PropertyValues", 4133 "documentation":"<p>A list of objects that specify time series property values.</p>" 4134 } 4135 }, 4136 "documentation":"<p>An object that specifies information about time series property values. This object is used and consumed by the <a href=\"https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_BatchPutPropertyValues.html\">BatchPutPropertyValues</a> action.</p>" 4137 }, 4138 "PropertyValueHistory":{ 4139 "type":"structure", 4140 "required":["entityPropertyReference"], 4141 "members":{ 4142 "entityPropertyReference":{ 4143 "shape":"EntityPropertyReference", 4144 "documentation":"<p>An object that uniquely identifies an entity property.</p>" 4145 }, 4146 "values":{ 4147 "shape":"Values", 4148 "documentation":"<p>A list of objects that contain information about the values in the history of a time series property.</p>" 4149 } 4150 }, 4151 "documentation":"<p>The history of values for a time series property.</p>" 4152 }, 4153 "PropertyValueList":{ 4154 "type":"list", 4155 "member":{"shape":"PropertyValueHistory"} 4156 }, 4157 "PropertyValues":{ 4158 "type":"list", 4159 "member":{"shape":"PropertyValue"}, 4160 "max":10, 4161 "min":1 4162 }, 4163 "QueryResultValue":{ 4164 "type":"structure", 4165 "members":{ 4166 }, 4167 "document":true 4168 }, 4169 "QueryServiceMaxResults":{ 4170 "type":"integer", 4171 "box":true, 4172 "max":100, 4173 "min":1 4174 }, 4175 "QueryStatement":{ 4176 "type":"string", 4177 "max":1000, 4178 "min":1, 4179 "pattern":"[\\s\\S]+" 4180 }, 4181 "QueryTimeoutException":{ 4182 "type":"structure", 4183 "members":{ 4184 "message":{"shape":"ErrorMessage"} 4185 }, 4186 "documentation":"<p>The query timeout exception.</p>", 4187 "error":{ 4188 "httpStatusCode":400, 4189 "senderFault":true 4190 }, 4191 "exception":true, 4192 "retryable":{"throttling":false} 4193 }, 4194 "Relationship":{ 4195 "type":"structure", 4196 "members":{ 4197 "targetComponentTypeId":{ 4198 "shape":"ComponentTypeId", 4199 "documentation":"<p>The ID of the target component type associated with this relationship.</p>" 4200 }, 4201 "relationshipType":{ 4202 "shape":"String", 4203 "documentation":"<p>The type of the relationship.</p>" 4204 } 4205 }, 4206 "documentation":"<p>An object that specifies a relationship with another component type.</p>" 4207 }, 4208 "RelationshipValue":{ 4209 "type":"structure", 4210 "members":{ 4211 "targetEntityId":{ 4212 "shape":"EntityId", 4213 "documentation":"<p>The ID of the target entity associated with this relationship value.</p>" 4214 }, 4215 "targetComponentName":{ 4216 "shape":"Name", 4217 "documentation":"<p>The name of the target component associated with the relationship value.</p>" 4218 } 4219 }, 4220 "documentation":"<p>A value that associates a component and an entity.</p>" 4221 }, 4222 "RequiredProperties":{ 4223 "type":"list", 4224 "member":{"shape":"Name"} 4225 }, 4226 "ResourceNotFoundException":{ 4227 "type":"structure", 4228 "members":{ 4229 "message":{"shape":"ErrorMessage"} 4230 }, 4231 "documentation":"<p>The resource wasn't found.</p>", 4232 "error":{ 4233 "httpStatusCode":404, 4234 "senderFault":true 4235 }, 4236 "exception":true 4237 }, 4238 "RoleArn":{ 4239 "type":"string", 4240 "max":2048, 4241 "min":20, 4242 "pattern":"arn:((aws)|(aws-cn)|(aws-us-gov)):iam::[0-9]{12}:role/.*" 4243 }, 4244 "Row":{ 4245 "type":"structure", 4246 "members":{ 4247 "rowData":{ 4248 "shape":"RowData", 4249 "documentation":"<p>The data in a row of query results.</p>" 4250 } 4251 }, 4252 "documentation":"<p>Represents a single row in the query results.</p>" 4253 }, 4254 "RowData":{ 4255 "type":"list", 4256 "member":{"shape":"QueryResultValue"} 4257 }, 4258 "Rows":{ 4259 "type":"list", 4260 "member":{"shape":"Row"} 4261 }, 4262 "S3DestinationConfiguration":{ 4263 "type":"structure", 4264 "required":["location"], 4265 "members":{ 4266 "location":{ 4267 "shape":"S3DestinationLocation", 4268 "documentation":"<p>The S3 destination configuration location.</p>" 4269 } 4270 }, 4271 "documentation":"<p>The S3 destination configuration.</p>" 4272 }, 4273 "S3DestinationLocation":{ 4274 "type":"string", 4275 "pattern":".*(^arn:((aws)|(aws-cn)|(aws-us-gov)):s3:::)([/a-zA-Z0-9_-]+$).*" 4276 }, 4277 "S3Location":{ 4278 "type":"string", 4279 "max":1024, 4280 "min":0, 4281 "pattern":".*(^arn:((aws)|(aws-cn)|(aws-us-gov)):s3:::)([a-zA-Z0-9_-]+$).*" 4282 }, 4283 "S3SourceConfiguration":{ 4284 "type":"structure", 4285 "required":["location"], 4286 "members":{ 4287 "location":{ 4288 "shape":"S3SourceLocation", 4289 "documentation":"<p>The S3 destination source configuration location.</p>" 4290 } 4291 }, 4292 "documentation":"<p>The S3 destination source configuration.</p>" 4293 }, 4294 "S3SourceLocation":{ 4295 "type":"string", 4296 "pattern":".*(^arn:((aws)|(aws-cn)|(aws-us-gov)):s3:::)([a-zA-Z0-9_-]+)\\/([/.a-zA-Z0-9_-]+$).*" 4297 }, 4298 "S3Url":{ 4299 "type":"string", 4300 "max":256, 4301 "min":0, 4302 "pattern":"[sS]3://[A-Za-z0-9._/-]+" 4303 }, 4304 "SceneCapabilities":{ 4305 "type":"list", 4306 "member":{"shape":"SceneCapability"}, 4307 "max":50, 4308 "min":0 4309 }, 4310 "SceneCapability":{ 4311 "type":"string", 4312 "max":256, 4313 "min":0, 4314 "pattern":".*" 4315 }, 4316 "SceneError":{ 4317 "type":"structure", 4318 "members":{ 4319 "code":{ 4320 "shape":"SceneErrorCode", 4321 "documentation":"<p>The SceneError code.</p>" 4322 }, 4323 "message":{ 4324 "shape":"ErrorMessage", 4325 "documentation":"<p>The SceneError message.</p>" 4326 } 4327 }, 4328 "documentation":"<p>The scene error.</p>" 4329 }, 4330 "SceneErrorCode":{ 4331 "type":"string", 4332 "enum":["MATTERPORT_ERROR"] 4333 }, 4334 "SceneMetadataMap":{ 4335 "type":"map", 4336 "key":{"shape":"Name"}, 4337 "value":{"shape":"SceneMetadataValue"}, 4338 "max":50, 4339 "min":0 4340 }, 4341 "SceneMetadataValue":{ 4342 "type":"string", 4343 "max":2048, 4344 "min":0, 4345 "pattern":".*" 4346 }, 4347 "SceneSummaries":{ 4348 "type":"list", 4349 "member":{"shape":"SceneSummary"} 4350 }, 4351 "SceneSummary":{ 4352 "type":"structure", 4353 "required":[ 4354 "sceneId", 4355 "contentLocation", 4356 "arn", 4357 "creationDateTime", 4358 "updateDateTime" 4359 ], 4360 "members":{ 4361 "sceneId":{ 4362 "shape":"Id", 4363 "documentation":"<p>The ID of the scene.</p>" 4364 }, 4365 "contentLocation":{ 4366 "shape":"S3Url", 4367 "documentation":"<p>The relative path that specifies the location of the content definition file.</p>" 4368 }, 4369 "arn":{ 4370 "shape":"TwinMakerArn", 4371 "documentation":"<p>The ARN of the scene.</p>" 4372 }, 4373 "creationDateTime":{ 4374 "shape":"Timestamp", 4375 "documentation":"<p>The date and time when the scene was created.</p>" 4376 }, 4377 "updateDateTime":{ 4378 "shape":"Timestamp", 4379 "documentation":"<p>The date and time when the scene was last updated.</p>" 4380 }, 4381 "description":{ 4382 "shape":"Description", 4383 "documentation":"<p>The scene description.</p>" 4384 } 4385 }, 4386 "documentation":"<p>An object that contains information about a scene.</p>" 4387 }, 4388 "Scope":{ 4389 "type":"string", 4390 "enum":[ 4391 "ENTITY", 4392 "WORKSPACE" 4393 ] 4394 }, 4395 "SelectedPropertyList":{ 4396 "type":"list", 4397 "member":{"shape":"String"}, 4398 "max":10, 4399 "min":1 4400 }, 4401 "ServiceQuotaExceededException":{ 4402 "type":"structure", 4403 "members":{ 4404 "message":{"shape":"ErrorMessage"} 4405 }, 4406 "documentation":"<p>The service quota was exceeded.</p>", 4407 "error":{ 4408 "httpStatusCode":402, 4409 "senderFault":true 4410 }, 4411 "exception":true 4412 }, 4413 "SiteWiseExternalId":{ 4414 "type":"string", 4415 "max":128, 4416 "min":2, 4417 "pattern":".*[a-zA-Z0-9_][a-zA-Z_\\-0-9.:]*[a-zA-Z0-9_]+.*" 4418 }, 4419 "SourceConfiguration":{ 4420 "type":"structure", 4421 "required":["type"], 4422 "members":{ 4423 "type":{ 4424 "shape":"SourceType", 4425 "documentation":"<p>The source configuration type.</p>" 4426 }, 4427 "s3Configuration":{ 4428 "shape":"S3SourceConfiguration", 4429 "documentation":"<p>The source configuration S3 configuration.</p>" 4430 }, 4431 "iotSiteWiseConfiguration":{ 4432 "shape":"IotSiteWiseSourceConfiguration", 4433 "documentation":"<p>The source configuration IoT SiteWise configuration.</p>" 4434 }, 4435 "iotTwinMakerConfiguration":{ 4436 "shape":"IotTwinMakerSourceConfiguration", 4437 "documentation":"<p>The source configuration IoT TwinMaker configuration.</p>" 4438 } 4439 }, 4440 "documentation":"<p>The source configuration.</p>" 4441 }, 4442 "SourceConfigurations":{ 4443 "type":"list", 4444 "member":{"shape":"SourceConfiguration"}, 4445 "max":1, 4446 "min":1 4447 }, 4448 "SourceType":{ 4449 "type":"string", 4450 "enum":[ 4451 "s3", 4452 "iotsitewise", 4453 "iottwinmaker" 4454 ] 4455 }, 4456 "State":{ 4457 "type":"string", 4458 "enum":[ 4459 "CREATING", 4460 "UPDATING", 4461 "DELETING", 4462 "ACTIVE", 4463 "ERROR" 4464 ] 4465 }, 4466 "Status":{ 4467 "type":"structure", 4468 "members":{ 4469 "state":{ 4470 "shape":"State", 4471 "documentation":"<p>The current state of the entity, component, component type, or workspace.</p>" 4472 }, 4473 "error":{ 4474 "shape":"ErrorDetails", 4475 "documentation":"<p>The error message.</p>" 4476 } 4477 }, 4478 "documentation":"<p>An object that represents the status of an entity, component, component type, or workspace.</p>" 4479 }, 4480 "String":{ 4481 "type":"string", 4482 "max":256, 4483 "min":1, 4484 "pattern":".*" 4485 }, 4486 "SyncJobState":{ 4487 "type":"string", 4488 "enum":[ 4489 "CREATING", 4490 "INITIALIZING", 4491 "ACTIVE", 4492 "DELETING", 4493 "ERROR" 4494 ] 4495 }, 4496 "SyncJobStatus":{ 4497 "type":"structure", 4498 "members":{ 4499 "state":{ 4500 "shape":"SyncJobState", 4501 "documentation":"<p>The SyncJob status state.</p>" 4502 }, 4503 "error":{ 4504 "shape":"ErrorDetails", 4505 "documentation":"<p>The SyncJob error.</p>" 4506 } 4507 }, 4508 "documentation":"<p>The SyncJob status.</p>" 4509 }, 4510 "SyncJobSummaries":{ 4511 "type":"list", 4512 "member":{"shape":"SyncJobSummary"} 4513 }, 4514 "SyncJobSummary":{ 4515 "type":"structure", 4516 "members":{ 4517 "arn":{ 4518 "shape":"TwinMakerArn", 4519 "documentation":"<p>The SyncJob summary ARN.</p>" 4520 }, 4521 "workspaceId":{ 4522 "shape":"Id", 4523 "documentation":"<p>The ID of the workspace that contains the sync job.</p>" 4524 }, 4525 "syncSource":{ 4526 "shape":"SyncSource", 4527 "documentation":"<p>The sync source.</p>" 4528 }, 4529 "status":{ 4530 "shape":"SyncJobStatus", 4531 "documentation":"<p>The SyncJob summaries status.</p>" 4532 }, 4533 "creationDateTime":{ 4534 "shape":"Timestamp", 4535 "documentation":"<p>The creation date and time.</p>" 4536 }, 4537 "updateDateTime":{ 4538 "shape":"Timestamp", 4539 "documentation":"<p>The update date and time.</p>" 4540 } 4541 }, 4542 "documentation":"<p>The SyncJob summary.</p>" 4543 }, 4544 "SyncResourceFilter":{ 4545 "type":"structure", 4546 "members":{ 4547 "state":{ 4548 "shape":"SyncResourceState", 4549 "documentation":"<p>The sync resource filter's state.</p>" 4550 }, 4551 "resourceType":{ 4552 "shape":"SyncResourceType", 4553 "documentation":"<p>The sync resource filter resource type</p>" 4554 }, 4555 "resourceId":{ 4556 "shape":"Id", 4557 "documentation":"<p>The sync resource filter resource ID.</p>" 4558 }, 4559 "externalId":{ 4560 "shape":"Id", 4561 "documentation":"<p>The external ID.</p>" 4562 } 4563 }, 4564 "documentation":"<p>The sync resource filter.</p>", 4565 "union":true 4566 }, 4567 "SyncResourceFilters":{ 4568 "type":"list", 4569 "member":{"shape":"SyncResourceFilter"} 4570 }, 4571 "SyncResourceState":{ 4572 "type":"string", 4573 "enum":[ 4574 "INITIALIZING", 4575 "PROCESSING", 4576 "DELETED", 4577 "IN_SYNC", 4578 "ERROR" 4579 ] 4580 }, 4581 "SyncResourceStatus":{ 4582 "type":"structure", 4583 "members":{ 4584 "state":{ 4585 "shape":"SyncResourceState", 4586 "documentation":"<p>The sync resource status state.</p>" 4587 }, 4588 "error":{ 4589 "shape":"ErrorDetails", 4590 "documentation":"<p>The status error.</p>" 4591 } 4592 }, 4593 "documentation":"<p>The sync resource status.</p>" 4594 }, 4595 "SyncResourceSummaries":{ 4596 "type":"list", 4597 "member":{"shape":"SyncResourceSummary"} 4598 }, 4599 "SyncResourceSummary":{ 4600 "type":"structure", 4601 "members":{ 4602 "resourceType":{ 4603 "shape":"SyncResourceType", 4604 "documentation":"<p>The resource type.</p>" 4605 }, 4606 "externalId":{ 4607 "shape":"Id", 4608 "documentation":"<p>The external ID.</p>" 4609 }, 4610 "resourceId":{ 4611 "shape":"Id", 4612 "documentation":"<p>The resource ID.</p>" 4613 }, 4614 "status":{ 4615 "shape":"SyncResourceStatus", 4616 "documentation":"<p>The sync resource summary status.</p>" 4617 }, 4618 "updateDateTime":{ 4619 "shape":"Timestamp", 4620 "documentation":"<p>The update date and time.</p>" 4621 } 4622 }, 4623 "documentation":"<p>The sync resource summary.</p>" 4624 }, 4625 "SyncResourceType":{ 4626 "type":"string", 4627 "enum":[ 4628 "ENTITY", 4629 "COMPONENT_TYPE" 4630 ] 4631 }, 4632 "SyncSource":{ 4633 "type":"string", 4634 "pattern":"[a-zA-Z_0-9]+" 4635 }, 4636 "TabularConditions":{ 4637 "type":"structure", 4638 "members":{ 4639 "orderBy":{ 4640 "shape":"OrderByList", 4641 "documentation":"<p>Filter criteria that orders the output. It can be sorted in ascending or descending order.</p>" 4642 }, 4643 "propertyFilters":{ 4644 "shape":"PropertyFilters", 4645 "documentation":"<p>You can filter the request using various logical operators and a key-value format. For example:</p> <p> <code>{\"key\": \"serverType\", \"value\": \"webServer\"}</code> </p>" 4646 } 4647 }, 4648 "documentation":"<p>The tabular conditions.</p>" 4649 }, 4650 "TabularPropertyValue":{ 4651 "type":"list", 4652 "member":{"shape":"PropertyTableValue"} 4653 }, 4654 "TabularPropertyValues":{ 4655 "type":"list", 4656 "member":{"shape":"TabularPropertyValue"} 4657 }, 4658 "TagKey":{ 4659 "type":"string", 4660 "max":128, 4661 "min":1, 4662 "pattern":"([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)" 4663 }, 4664 "TagKeyList":{ 4665 "type":"list", 4666 "member":{"shape":"TagKey"}, 4667 "max":50, 4668 "min":0 4669 }, 4670 "TagMap":{ 4671 "type":"map", 4672 "key":{"shape":"TagKey"}, 4673 "value":{"shape":"TagValue"}, 4674 "max":50, 4675 "min":0 4676 }, 4677 "TagResourceRequest":{ 4678 "type":"structure", 4679 "required":[ 4680 "resourceARN", 4681 "tags" 4682 ], 4683 "members":{ 4684 "resourceARN":{ 4685 "shape":"TwinMakerArn", 4686 "documentation":"<p>The ARN of the resource.</p>" 4687 }, 4688 "tags":{ 4689 "shape":"TagMap", 4690 "documentation":"<p>Metadata to add to this resource.</p>" 4691 } 4692 } 4693 }, 4694 "TagResourceResponse":{ 4695 "type":"structure", 4696 "members":{ 4697 } 4698 }, 4699 "TagValue":{ 4700 "type":"string", 4701 "max":256, 4702 "min":1, 4703 "pattern":".*" 4704 }, 4705 "ThrottlingException":{ 4706 "type":"structure", 4707 "members":{ 4708 "message":{"shape":"ErrorMessage"} 4709 }, 4710 "documentation":"<p>The rate exceeds the limit.</p>", 4711 "error":{ 4712 "httpStatusCode":429, 4713 "senderFault":true 4714 }, 4715 "exception":true 4716 }, 4717 "Time":{ 4718 "type":"string", 4719 "documentation":"<p>Timestamp represented in ISO 8601 format</p>", 4720 "max":35, 4721 "min":20 4722 }, 4723 "Timestamp":{ 4724 "type":"timestamp", 4725 "documentation":"<p>supports epoch seconds value</p>" 4726 }, 4727 "TooManyTagsException":{ 4728 "type":"structure", 4729 "members":{ 4730 "message":{"shape":"ExceptionMessage"} 4731 }, 4732 "documentation":"<p>The number of tags exceeds the limit.</p>", 4733 "error":{ 4734 "httpStatusCode":400, 4735 "senderFault":true 4736 }, 4737 "exception":true 4738 }, 4739 "TwinMakerArn":{ 4740 "type":"string", 4741 "max":2048, 4742 "min":20, 4743 "pattern":"arn:((aws)|(aws-cn)|(aws-us-gov)):iottwinmaker:[a-z0-9-]+:[0-9]{12}:[\\/a-zA-Z0-9_\\-\\.:]+" 4744 }, 4745 "Type":{ 4746 "type":"string", 4747 "enum":[ 4748 "RELATIONSHIP", 4749 "STRING", 4750 "LONG", 4751 "BOOLEAN", 4752 "INTEGER", 4753 "DOUBLE", 4754 "LIST", 4755 "MAP" 4756 ] 4757 }, 4758 "UntagResourceRequest":{ 4759 "type":"structure", 4760 "required":[ 4761 "resourceARN", 4762 "tagKeys" 4763 ], 4764 "members":{ 4765 "resourceARN":{ 4766 "shape":"TwinMakerArn", 4767 "documentation":"<p>The ARN of the resource.</p>", 4768 "location":"querystring", 4769 "locationName":"resourceARN" 4770 }, 4771 "tagKeys":{ 4772 "shape":"TagKeyList", 4773 "documentation":"<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>", 4774 "location":"querystring", 4775 "locationName":"tagKeys" 4776 } 4777 } 4778 }, 4779 "UntagResourceResponse":{ 4780 "type":"structure", 4781 "members":{ 4782 } 4783 }, 4784 "UpdateComponentTypeRequest":{ 4785 "type":"structure", 4786 "required":[ 4787 "workspaceId", 4788 "componentTypeId" 4789 ], 4790 "members":{ 4791 "workspaceId":{ 4792 "shape":"Id", 4793 "documentation":"<p>The ID of the workspace.</p>", 4794 "location":"uri", 4795 "locationName":"workspaceId" 4796 }, 4797 "isSingleton":{ 4798 "shape":"Boolean", 4799 "documentation":"<p>A Boolean value that specifies whether an entity can have more than one component of this type.</p>" 4800 }, 4801 "componentTypeId":{ 4802 "shape":"ComponentTypeId", 4803 "documentation":"<p>The ID of the component type.</p>", 4804 "location":"uri", 4805 "locationName":"componentTypeId" 4806 }, 4807 "description":{ 4808 "shape":"Description", 4809 "documentation":"<p>The description of the component type.</p>" 4810 }, 4811 "propertyDefinitions":{ 4812 "shape":"PropertyDefinitionsRequest", 4813 "documentation":"<p>An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object.</p>" 4814 }, 4815 "extendsFrom":{ 4816 "shape":"ExtendsFrom", 4817 "documentation":"<p>Specifies the component type that this component type extends.</p>" 4818 }, 4819 "functions":{ 4820 "shape":"FunctionsRequest", 4821 "documentation":"<p>An object that maps strings to the functions in the component type. Each string in the mapping must be unique to this object.</p>" 4822 }, 4823 "propertyGroups":{ 4824 "shape":"PropertyGroupsRequest", 4825 "documentation":"<p>The property groups.</p>" 4826 }, 4827 "componentTypeName":{ 4828 "shape":"ComponentTypeName", 4829 "documentation":"<p>The component type name.</p>" 4830 }, 4831 "compositeComponentTypes":{ 4832 "shape":"CompositeComponentTypesRequest", 4833 "documentation":"<p>This is an object that maps strings to <code>compositeComponentTypes</code> of the <code>componentType</code>. <code>CompositeComponentType</code> is referenced by <code>componentTypeId</code>.</p>" 4834 } 4835 } 4836 }, 4837 "UpdateComponentTypeResponse":{ 4838 "type":"structure", 4839 "required":[ 4840 "workspaceId", 4841 "arn", 4842 "componentTypeId", 4843 "state" 4844 ], 4845 "members":{ 4846 "workspaceId":{ 4847 "shape":"Id", 4848 "documentation":"<p>The ID of the workspace that contains the component type.</p>" 4849 }, 4850 "arn":{ 4851 "shape":"TwinMakerArn", 4852 "documentation":"<p>The ARN of the component type.</p>" 4853 }, 4854 "componentTypeId":{ 4855 "shape":"ComponentTypeId", 4856 "documentation":"<p>The ID of the component type.</p>" 4857 }, 4858 "state":{ 4859 "shape":"State", 4860 "documentation":"<p>The current state of the component type.</p>" 4861 } 4862 } 4863 }, 4864 "UpdateEntityRequest":{ 4865 "type":"structure", 4866 "required":[ 4867 "workspaceId", 4868 "entityId" 4869 ], 4870 "members":{ 4871 "workspaceId":{ 4872 "shape":"Id", 4873 "documentation":"<p>The ID of the workspace that contains the entity.</p>", 4874 "location":"uri", 4875 "locationName":"workspaceId" 4876 }, 4877 "entityId":{ 4878 "shape":"EntityId", 4879 "documentation":"<p>The ID of the entity.</p>", 4880 "location":"uri", 4881 "locationName":"entityId" 4882 }, 4883 "entityName":{ 4884 "shape":"EntityName", 4885 "documentation":"<p>The name of the entity.</p>" 4886 }, 4887 "description":{ 4888 "shape":"Description", 4889 "documentation":"<p>The description of the entity.</p>" 4890 }, 4891 "componentUpdates":{ 4892 "shape":"ComponentUpdatesMapRequest", 4893 "documentation":"<p>An object that maps strings to the component updates in the request. Each string in the mapping must be unique to this object.</p>" 4894 }, 4895 "compositeComponentUpdates":{ 4896 "shape":"CompositeComponentUpdatesMapRequest", 4897 "documentation":"<p>This is an object that maps strings to <code>compositeComponent</code> updates in the request. Each key of the map represents the <code>componentPath</code> of the <code>compositeComponent</code>.</p>" 4898 }, 4899 "parentEntityUpdate":{ 4900 "shape":"ParentEntityUpdateRequest", 4901 "documentation":"<p>An object that describes the update request for a parent entity.</p>" 4902 } 4903 } 4904 }, 4905 "UpdateEntityResponse":{ 4906 "type":"structure", 4907 "required":[ 4908 "updateDateTime", 4909 "state" 4910 ], 4911 "members":{ 4912 "updateDateTime":{ 4913 "shape":"Timestamp", 4914 "documentation":"<p>The date and time when the entity was last updated.</p>" 4915 }, 4916 "state":{ 4917 "shape":"State", 4918 "documentation":"<p>The current state of the entity update.</p>" 4919 } 4920 } 4921 }, 4922 "UpdatePricingPlanRequest":{ 4923 "type":"structure", 4924 "required":["pricingMode"], 4925 "members":{ 4926 "pricingMode":{ 4927 "shape":"PricingMode", 4928 "documentation":"<p>The pricing mode.</p>" 4929 }, 4930 "bundleNames":{ 4931 "shape":"PricingBundles", 4932 "documentation":"<p>The bundle names.</p>" 4933 } 4934 } 4935 }, 4936 "UpdatePricingPlanResponse":{ 4937 "type":"structure", 4938 "required":["currentPricingPlan"], 4939 "members":{ 4940 "currentPricingPlan":{ 4941 "shape":"PricingPlan", 4942 "documentation":"<p>Update the current pricing plan.</p>" 4943 }, 4944 "pendingPricingPlan":{ 4945 "shape":"PricingPlan", 4946 "documentation":"<p>Update the pending pricing plan.</p>" 4947 } 4948 } 4949 }, 4950 "UpdateReason":{ 4951 "type":"string", 4952 "enum":[ 4953 "DEFAULT", 4954 "PRICING_TIER_UPDATE", 4955 "ENTITY_COUNT_UPDATE", 4956 "PRICING_MODE_UPDATE", 4957 "OVERWRITTEN" 4958 ] 4959 }, 4960 "UpdateSceneRequest":{ 4961 "type":"structure", 4962 "required":[ 4963 "workspaceId", 4964 "sceneId" 4965 ], 4966 "members":{ 4967 "workspaceId":{ 4968 "shape":"Id", 4969 "documentation":"<p>The ID of the workspace that contains the scene.</p>", 4970 "location":"uri", 4971 "locationName":"workspaceId" 4972 }, 4973 "sceneId":{ 4974 "shape":"Id", 4975 "documentation":"<p>The ID of the scene.</p>", 4976 "location":"uri", 4977 "locationName":"sceneId" 4978 }, 4979 "contentLocation":{ 4980 "shape":"S3Url", 4981 "documentation":"<p>The relative path that specifies the location of the content definition file.</p>" 4982 }, 4983 "description":{ 4984 "shape":"Description", 4985 "documentation":"<p>The description of this scene.</p>" 4986 }, 4987 "capabilities":{ 4988 "shape":"SceneCapabilities", 4989 "documentation":"<p>A list of capabilities that the scene uses to render.</p>" 4990 }, 4991 "sceneMetadata":{ 4992 "shape":"SceneMetadataMap", 4993 "documentation":"<p>The scene metadata.</p>" 4994 } 4995 } 4996 }, 4997 "UpdateSceneResponse":{ 4998 "type":"structure", 4999 "required":["updateDateTime"], 5000 "members":{ 5001 "updateDateTime":{ 5002 "shape":"Timestamp", 5003 "documentation":"<p>The date and time when the scene was last updated.</p>" 5004 } 5005 } 5006 }, 5007 "UpdateWorkspaceRequest":{ 5008 "type":"structure", 5009 "required":["workspaceId"], 5010 "members":{ 5011 "workspaceId":{ 5012 "shape":"Id", 5013 "documentation":"<p>The ID of the workspace.</p>", 5014 "location":"uri", 5015 "locationName":"workspaceId" 5016 }, 5017 "description":{ 5018 "shape":"Description", 5019 "documentation":"<p>The description of the workspace.</p>" 5020 }, 5021 "role":{ 5022 "shape":"RoleArn", 5023 "documentation":"<p>The ARN of the execution role associated with the workspace.</p>" 5024 }, 5025 "s3Location":{ 5026 "shape":"S3Location", 5027 "documentation":"<p>The ARN of the S3 bucket where resources associated with the workspace are stored.</p>" 5028 } 5029 } 5030 }, 5031 "UpdateWorkspaceResponse":{ 5032 "type":"structure", 5033 "required":["updateDateTime"], 5034 "members":{ 5035 "updateDateTime":{ 5036 "shape":"Timestamp", 5037 "documentation":"<p>The date and time of the current update.</p>" 5038 } 5039 } 5040 }, 5041 "Uuid":{ 5042 "type":"string", 5043 "max":36, 5044 "min":36, 5045 "pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" 5046 }, 5047 "ValidationException":{ 5048 "type":"structure", 5049 "members":{ 5050 "message":{"shape":"ErrorMessage"} 5051 }, 5052 "documentation":"<p>Failed</p>", 5053 "error":{ 5054 "httpStatusCode":400, 5055 "senderFault":true 5056 }, 5057 "exception":true 5058 }, 5059 "Value":{ 5060 "type":"string", 5061 "pattern":".*" 5062 }, 5063 "Values":{ 5064 "type":"list", 5065 "member":{"shape":"PropertyValue"} 5066 }, 5067 "WorkspaceDeleteMessage":{ 5068 "type":"string", 5069 "max":2048, 5070 "min":0, 5071 "pattern":".*" 5072 }, 5073 "WorkspaceSummaries":{ 5074 "type":"list", 5075 "member":{"shape":"WorkspaceSummary"} 5076 }, 5077 "WorkspaceSummary":{ 5078 "type":"structure", 5079 "required":[ 5080 "workspaceId", 5081 "arn", 5082 "creationDateTime", 5083 "updateDateTime" 5084 ], 5085 "members":{ 5086 "workspaceId":{ 5087 "shape":"Id", 5088 "documentation":"<p>The ID of the workspace.</p>" 5089 }, 5090 "arn":{ 5091 "shape":"TwinMakerArn", 5092 "documentation":"<p>The ARN of the workspace.</p>" 5093 }, 5094 "description":{ 5095 "shape":"Description", 5096 "documentation":"<p>The description of the workspace.</p>" 5097 }, 5098 "linkedServices":{ 5099 "shape":"LinkedServices", 5100 "documentation":"<p>A list of services that are linked to the workspace.</p>" 5101 }, 5102 "creationDateTime":{ 5103 "shape":"Timestamp", 5104 "documentation":"<p>The date and time when the workspace was created.</p>" 5105 }, 5106 "updateDateTime":{ 5107 "shape":"Timestamp", 5108 "documentation":"<p>The date and time when the workspace was last updated.</p>" 5109 } 5110 }, 5111 "documentation":"<p>An object that contains information about a workspace.</p>" 5112 } 5113 }, 5114 "documentation":"<p>IoT TwinMaker is a service with which you can build operational digital twins of physical systems. IoT TwinMaker overlays measurements and analysis from real-world sensors, cameras, and enterprise applications so you can create data visualizations to monitor your physical factory, building, or industrial plant. You can use this real-world data to monitor operations and diagnose and repair errors.</p>" 5115} 5116