1{ 2 "version":"2.0", 3 "metadata":{ 4 "apiVersion":"2016-05-01", 5 "endpointPrefix":"workdocs", 6 "jsonVersion":"1.1", 7 "protocol":"rest-json", 8 "serviceFullName":"Amazon WorkDocs", 9 "signatureVersion":"v4", 10 "uid":"workdocs-2016-05-01" 11 }, 12 "operations":{ 13 "AbortDocumentVersionUpload":{ 14 "name":"AbortDocumentVersionUpload", 15 "http":{ 16 "method":"DELETE", 17 "requestUri":"/api/v1/documents/{DocumentId}/versions/{VersionId}", 18 "responseCode":204 19 }, 20 "input":{"shape":"AbortDocumentVersionUploadRequest"}, 21 "errors":[ 22 {"shape":"EntityNotExistsException"}, 23 {"shape":"ProhibitedStateException"}, 24 {"shape":"UnauthorizedOperationException"}, 25 {"shape":"UnauthorizedResourceAccessException"}, 26 {"shape":"FailedDependencyException"}, 27 {"shape":"ServiceUnavailableException"} 28 ] 29 }, 30 "ActivateUser":{ 31 "name":"ActivateUser", 32 "http":{ 33 "method":"POST", 34 "requestUri":"/api/v1/users/{UserId}/activation", 35 "responseCode":200 36 }, 37 "input":{"shape":"ActivateUserRequest"}, 38 "output":{"shape":"ActivateUserResponse"}, 39 "errors":[ 40 {"shape":"EntityNotExistsException"}, 41 {"shape":"UnauthorizedOperationException"}, 42 {"shape":"UnauthorizedResourceAccessException"}, 43 {"shape":"FailedDependencyException"}, 44 {"shape":"ServiceUnavailableException"} 45 ] 46 }, 47 "AddResourcePermissions":{ 48 "name":"AddResourcePermissions", 49 "http":{ 50 "method":"POST", 51 "requestUri":"/api/v1/resources/{ResourceId}/permissions", 52 "responseCode":201 53 }, 54 "input":{"shape":"AddResourcePermissionsRequest"}, 55 "output":{"shape":"AddResourcePermissionsResponse"}, 56 "errors":[ 57 {"shape":"UnauthorizedOperationException"}, 58 {"shape":"UnauthorizedResourceAccessException"}, 59 {"shape":"FailedDependencyException"}, 60 {"shape":"ServiceUnavailableException"} 61 ] 62 }, 63 "CreateComment":{ 64 "name":"CreateComment", 65 "http":{ 66 "method":"POST", 67 "requestUri":"/api/v1/documents/{DocumentId}/versions/{VersionId}/comment", 68 "responseCode":201 69 }, 70 "input":{"shape":"CreateCommentRequest"}, 71 "output":{"shape":"CreateCommentResponse"}, 72 "errors":[ 73 {"shape":"EntityNotExistsException"}, 74 {"shape":"ProhibitedStateException"}, 75 {"shape":"UnauthorizedOperationException"}, 76 {"shape":"UnauthorizedResourceAccessException"}, 77 {"shape":"FailedDependencyException"}, 78 {"shape":"ServiceUnavailableException"}, 79 {"shape":"DocumentLockedForCommentsException"} 80 ] 81 }, 82 "CreateCustomMetadata":{ 83 "name":"CreateCustomMetadata", 84 "http":{ 85 "method":"PUT", 86 "requestUri":"/api/v1/resources/{ResourceId}/customMetadata", 87 "responseCode":200 88 }, 89 "input":{"shape":"CreateCustomMetadataRequest"}, 90 "output":{"shape":"CreateCustomMetadataResponse"}, 91 "errors":[ 92 {"shape":"EntityNotExistsException"}, 93 {"shape":"UnauthorizedOperationException"}, 94 {"shape":"UnauthorizedResourceAccessException"}, 95 {"shape":"ProhibitedStateException"}, 96 {"shape":"CustomMetadataLimitExceededException"}, 97 {"shape":"FailedDependencyException"}, 98 {"shape":"ServiceUnavailableException"} 99 ] 100 }, 101 "CreateFolder":{ 102 "name":"CreateFolder", 103 "http":{ 104 "method":"POST", 105 "requestUri":"/api/v1/folders", 106 "responseCode":201 107 }, 108 "input":{"shape":"CreateFolderRequest"}, 109 "output":{"shape":"CreateFolderResponse"}, 110 "errors":[ 111 {"shape":"EntityNotExistsException"}, 112 {"shape":"EntityAlreadyExistsException"}, 113 {"shape":"ProhibitedStateException"}, 114 {"shape":"LimitExceededException"}, 115 {"shape":"UnauthorizedOperationException"}, 116 {"shape":"UnauthorizedResourceAccessException"}, 117 {"shape":"FailedDependencyException"}, 118 {"shape":"ServiceUnavailableException"} 119 ] 120 }, 121 "CreateLabels":{ 122 "name":"CreateLabels", 123 "http":{ 124 "method":"PUT", 125 "requestUri":"/api/v1/resources/{ResourceId}/labels", 126 "responseCode":200 127 }, 128 "input":{"shape":"CreateLabelsRequest"}, 129 "output":{"shape":"CreateLabelsResponse"}, 130 "errors":[ 131 {"shape":"EntityNotExistsException"}, 132 {"shape":"UnauthorizedOperationException"}, 133 {"shape":"UnauthorizedResourceAccessException"}, 134 {"shape":"FailedDependencyException"}, 135 {"shape":"ServiceUnavailableException"}, 136 {"shape":"TooManyLabelsException"} 137 ] 138 }, 139 "CreateNotificationSubscription":{ 140 "name":"CreateNotificationSubscription", 141 "http":{ 142 "method":"POST", 143 "requestUri":"/api/v1/organizations/{OrganizationId}/subscriptions", 144 "responseCode":200 145 }, 146 "input":{"shape":"CreateNotificationSubscriptionRequest"}, 147 "output":{"shape":"CreateNotificationSubscriptionResponse"}, 148 "errors":[ 149 {"shape":"UnauthorizedResourceAccessException"}, 150 {"shape":"TooManySubscriptionsException"}, 151 {"shape":"ServiceUnavailableException"} 152 ] 153 }, 154 "CreateUser":{ 155 "name":"CreateUser", 156 "http":{ 157 "method":"POST", 158 "requestUri":"/api/v1/users", 159 "responseCode":201 160 }, 161 "input":{"shape":"CreateUserRequest"}, 162 "output":{"shape":"CreateUserResponse"}, 163 "errors":[ 164 {"shape":"EntityAlreadyExistsException"}, 165 {"shape":"UnauthorizedOperationException"}, 166 {"shape":"UnauthorizedResourceAccessException"}, 167 {"shape":"FailedDependencyException"}, 168 {"shape":"ServiceUnavailableException"} 169 ] 170 }, 171 "DeactivateUser":{ 172 "name":"DeactivateUser", 173 "http":{ 174 "method":"DELETE", 175 "requestUri":"/api/v1/users/{UserId}/activation", 176 "responseCode":204 177 }, 178 "input":{"shape":"DeactivateUserRequest"}, 179 "errors":[ 180 {"shape":"EntityNotExistsException"}, 181 {"shape":"UnauthorizedOperationException"}, 182 {"shape":"UnauthorizedResourceAccessException"}, 183 {"shape":"FailedDependencyException"}, 184 {"shape":"ServiceUnavailableException"} 185 ] 186 }, 187 "DeleteComment":{ 188 "name":"DeleteComment", 189 "http":{ 190 "method":"DELETE", 191 "requestUri":"/api/v1/documents/{DocumentId}/versions/{VersionId}/comment/{CommentId}", 192 "responseCode":204 193 }, 194 "input":{"shape":"DeleteCommentRequest"}, 195 "errors":[ 196 {"shape":"EntityNotExistsException"}, 197 {"shape":"ProhibitedStateException"}, 198 {"shape":"UnauthorizedOperationException"}, 199 {"shape":"UnauthorizedResourceAccessException"}, 200 {"shape":"FailedDependencyException"}, 201 {"shape":"ServiceUnavailableException"}, 202 {"shape":"DocumentLockedForCommentsException"} 203 ] 204 }, 205 "DeleteCustomMetadata":{ 206 "name":"DeleteCustomMetadata", 207 "http":{ 208 "method":"DELETE", 209 "requestUri":"/api/v1/resources/{ResourceId}/customMetadata", 210 "responseCode":200 211 }, 212 "input":{"shape":"DeleteCustomMetadataRequest"}, 213 "output":{"shape":"DeleteCustomMetadataResponse"}, 214 "errors":[ 215 {"shape":"EntityNotExistsException"}, 216 {"shape":"UnauthorizedOperationException"}, 217 {"shape":"UnauthorizedResourceAccessException"}, 218 {"shape":"ProhibitedStateException"}, 219 {"shape":"FailedDependencyException"}, 220 {"shape":"ServiceUnavailableException"} 221 ] 222 }, 223 "DeleteDocument":{ 224 "name":"DeleteDocument", 225 "http":{ 226 "method":"DELETE", 227 "requestUri":"/api/v1/documents/{DocumentId}", 228 "responseCode":204 229 }, 230 "input":{"shape":"DeleteDocumentRequest"}, 231 "errors":[ 232 {"shape":"EntityNotExistsException"}, 233 {"shape":"ProhibitedStateException"}, 234 {"shape":"ConcurrentModificationException"}, 235 {"shape":"UnauthorizedOperationException"}, 236 {"shape":"UnauthorizedResourceAccessException"}, 237 {"shape":"FailedDependencyException"}, 238 {"shape":"ServiceUnavailableException"} 239 ] 240 }, 241 "DeleteFolder":{ 242 "name":"DeleteFolder", 243 "http":{ 244 "method":"DELETE", 245 "requestUri":"/api/v1/folders/{FolderId}", 246 "responseCode":204 247 }, 248 "input":{"shape":"DeleteFolderRequest"}, 249 "errors":[ 250 {"shape":"EntityNotExistsException"}, 251 {"shape":"ProhibitedStateException"}, 252 {"shape":"ConcurrentModificationException"}, 253 {"shape":"UnauthorizedOperationException"}, 254 {"shape":"UnauthorizedResourceAccessException"}, 255 {"shape":"FailedDependencyException"}, 256 {"shape":"ServiceUnavailableException"} 257 ] 258 }, 259 "DeleteFolderContents":{ 260 "name":"DeleteFolderContents", 261 "http":{ 262 "method":"DELETE", 263 "requestUri":"/api/v1/folders/{FolderId}/contents", 264 "responseCode":204 265 }, 266 "input":{"shape":"DeleteFolderContentsRequest"}, 267 "errors":[ 268 {"shape":"EntityNotExistsException"}, 269 {"shape":"UnauthorizedOperationException"}, 270 {"shape":"UnauthorizedResourceAccessException"}, 271 {"shape":"FailedDependencyException"}, 272 {"shape":"ServiceUnavailableException"} 273 ] 274 }, 275 "DeleteLabels":{ 276 "name":"DeleteLabels", 277 "http":{ 278 "method":"DELETE", 279 "requestUri":"/api/v1/resources/{ResourceId}/labels", 280 "responseCode":200 281 }, 282 "input":{"shape":"DeleteLabelsRequest"}, 283 "output":{"shape":"DeleteLabelsResponse"}, 284 "errors":[ 285 {"shape":"EntityNotExistsException"}, 286 {"shape":"UnauthorizedOperationException"}, 287 {"shape":"UnauthorizedResourceAccessException"}, 288 {"shape":"FailedDependencyException"}, 289 {"shape":"ServiceUnavailableException"} 290 ] 291 }, 292 "DeleteNotificationSubscription":{ 293 "name":"DeleteNotificationSubscription", 294 "http":{ 295 "method":"DELETE", 296 "requestUri":"/api/v1/organizations/{OrganizationId}/subscriptions/{SubscriptionId}", 297 "responseCode":200 298 }, 299 "input":{"shape":"DeleteNotificationSubscriptionRequest"}, 300 "errors":[ 301 {"shape":"UnauthorizedResourceAccessException"}, 302 {"shape":"EntityNotExistsException"}, 303 {"shape":"ServiceUnavailableException"}, 304 {"shape":"ProhibitedStateException"} 305 ] 306 }, 307 "DeleteUser":{ 308 "name":"DeleteUser", 309 "http":{ 310 "method":"DELETE", 311 "requestUri":"/api/v1/users/{UserId}", 312 "responseCode":204 313 }, 314 "input":{"shape":"DeleteUserRequest"}, 315 "errors":[ 316 {"shape":"EntityNotExistsException"}, 317 {"shape":"UnauthorizedOperationException"}, 318 {"shape":"UnauthorizedResourceAccessException"}, 319 {"shape":"FailedDependencyException"}, 320 {"shape":"ServiceUnavailableException"} 321 ] 322 }, 323 "DescribeActivities":{ 324 "name":"DescribeActivities", 325 "http":{ 326 "method":"GET", 327 "requestUri":"/api/v1/activities", 328 "responseCode":200 329 }, 330 "input":{"shape":"DescribeActivitiesRequest"}, 331 "output":{"shape":"DescribeActivitiesResponse"}, 332 "errors":[ 333 {"shape":"UnauthorizedOperationException"}, 334 {"shape":"UnauthorizedResourceAccessException"}, 335 {"shape":"InvalidArgumentException"}, 336 {"shape":"FailedDependencyException"}, 337 {"shape":"ServiceUnavailableException"} 338 ] 339 }, 340 "DescribeComments":{ 341 "name":"DescribeComments", 342 "http":{ 343 "method":"GET", 344 "requestUri":"/api/v1/documents/{DocumentId}/versions/{VersionId}/comments", 345 "responseCode":200 346 }, 347 "input":{"shape":"DescribeCommentsRequest"}, 348 "output":{"shape":"DescribeCommentsResponse"}, 349 "errors":[ 350 {"shape":"EntityNotExistsException"}, 351 {"shape":"ProhibitedStateException"}, 352 {"shape":"UnauthorizedOperationException"}, 353 {"shape":"UnauthorizedResourceAccessException"}, 354 {"shape":"FailedDependencyException"}, 355 {"shape":"ServiceUnavailableException"} 356 ] 357 }, 358 "DescribeDocumentVersions":{ 359 "name":"DescribeDocumentVersions", 360 "http":{ 361 "method":"GET", 362 "requestUri":"/api/v1/documents/{DocumentId}/versions", 363 "responseCode":200 364 }, 365 "input":{"shape":"DescribeDocumentVersionsRequest"}, 366 "output":{"shape":"DescribeDocumentVersionsResponse"}, 367 "errors":[ 368 {"shape":"EntityNotExistsException"}, 369 {"shape":"UnauthorizedOperationException"}, 370 {"shape":"UnauthorizedResourceAccessException"}, 371 {"shape":"InvalidArgumentException"}, 372 {"shape":"FailedDependencyException"}, 373 {"shape":"ServiceUnavailableException"}, 374 {"shape":"ProhibitedStateException"} 375 ] 376 }, 377 "DescribeFolderContents":{ 378 "name":"DescribeFolderContents", 379 "http":{ 380 "method":"GET", 381 "requestUri":"/api/v1/folders/{FolderId}/contents", 382 "responseCode":200 383 }, 384 "input":{"shape":"DescribeFolderContentsRequest"}, 385 "output":{"shape":"DescribeFolderContentsResponse"}, 386 "errors":[ 387 {"shape":"EntityNotExistsException"}, 388 {"shape":"UnauthorizedResourceAccessException"}, 389 {"shape":"InvalidArgumentException"}, 390 {"shape":"FailedDependencyException"}, 391 {"shape":"ServiceUnavailableException"}, 392 {"shape":"ProhibitedStateException"} 393 ] 394 }, 395 "DescribeNotificationSubscriptions":{ 396 "name":"DescribeNotificationSubscriptions", 397 "http":{ 398 "method":"GET", 399 "requestUri":"/api/v1/organizations/{OrganizationId}/subscriptions", 400 "responseCode":200 401 }, 402 "input":{"shape":"DescribeNotificationSubscriptionsRequest"}, 403 "output":{"shape":"DescribeNotificationSubscriptionsResponse"}, 404 "errors":[ 405 {"shape":"UnauthorizedResourceAccessException"}, 406 {"shape":"EntityNotExistsException"}, 407 {"shape":"ServiceUnavailableException"} 408 ] 409 }, 410 "DescribeResourcePermissions":{ 411 "name":"DescribeResourcePermissions", 412 "http":{ 413 "method":"GET", 414 "requestUri":"/api/v1/resources/{ResourceId}/permissions", 415 "responseCode":200 416 }, 417 "input":{"shape":"DescribeResourcePermissionsRequest"}, 418 "output":{"shape":"DescribeResourcePermissionsResponse"}, 419 "errors":[ 420 {"shape":"UnauthorizedOperationException"}, 421 {"shape":"UnauthorizedResourceAccessException"}, 422 {"shape":"FailedDependencyException"}, 423 {"shape":"ServiceUnavailableException"} 424 ] 425 }, 426 "DescribeRootFolders":{ 427 "name":"DescribeRootFolders", 428 "http":{ 429 "method":"GET", 430 "requestUri":"/api/v1/me/root", 431 "responseCode":200 432 }, 433 "input":{"shape":"DescribeRootFoldersRequest"}, 434 "output":{"shape":"DescribeRootFoldersResponse"}, 435 "errors":[ 436 {"shape":"UnauthorizedOperationException"}, 437 {"shape":"UnauthorizedResourceAccessException"}, 438 {"shape":"InvalidArgumentException"}, 439 {"shape":"FailedDependencyException"}, 440 {"shape":"ServiceUnavailableException"} 441 ] 442 }, 443 "DescribeUsers":{ 444 "name":"DescribeUsers", 445 "http":{ 446 "method":"GET", 447 "requestUri":"/api/v1/users", 448 "responseCode":200 449 }, 450 "input":{"shape":"DescribeUsersRequest"}, 451 "output":{"shape":"DescribeUsersResponse"}, 452 "errors":[ 453 {"shape":"UnauthorizedOperationException"}, 454 {"shape":"UnauthorizedResourceAccessException"}, 455 {"shape":"FailedDependencyException"}, 456 {"shape":"ServiceUnavailableException"}, 457 {"shape":"InvalidArgumentException"} 458 ] 459 }, 460 "GetCurrentUser":{ 461 "name":"GetCurrentUser", 462 "http":{ 463 "method":"GET", 464 "requestUri":"/api/v1/me", 465 "responseCode":200 466 }, 467 "input":{"shape":"GetCurrentUserRequest"}, 468 "output":{"shape":"GetCurrentUserResponse"}, 469 "errors":[ 470 {"shape":"EntityNotExistsException"}, 471 {"shape":"UnauthorizedOperationException"}, 472 {"shape":"UnauthorizedResourceAccessException"}, 473 {"shape":"FailedDependencyException"}, 474 {"shape":"ServiceUnavailableException"} 475 ] 476 }, 477 "GetDocument":{ 478 "name":"GetDocument", 479 "http":{ 480 "method":"GET", 481 "requestUri":"/api/v1/documents/{DocumentId}", 482 "responseCode":200 483 }, 484 "input":{"shape":"GetDocumentRequest"}, 485 "output":{"shape":"GetDocumentResponse"}, 486 "errors":[ 487 {"shape":"EntityNotExistsException"}, 488 {"shape":"UnauthorizedOperationException"}, 489 {"shape":"UnauthorizedResourceAccessException"}, 490 {"shape":"InvalidArgumentException"}, 491 {"shape":"FailedDependencyException"}, 492 {"shape":"ServiceUnavailableException"} 493 ] 494 }, 495 "GetDocumentPath":{ 496 "name":"GetDocumentPath", 497 "http":{ 498 "method":"GET", 499 "requestUri":"/api/v1/documents/{DocumentId}/path", 500 "responseCode":200 501 }, 502 "input":{"shape":"GetDocumentPathRequest"}, 503 "output":{"shape":"GetDocumentPathResponse"}, 504 "errors":[ 505 {"shape":"EntityNotExistsException"}, 506 {"shape":"UnauthorizedOperationException"}, 507 {"shape":"UnauthorizedResourceAccessException"}, 508 {"shape":"FailedDependencyException"}, 509 {"shape":"ServiceUnavailableException"} 510 ] 511 }, 512 "GetDocumentVersion":{ 513 "name":"GetDocumentVersion", 514 "http":{ 515 "method":"GET", 516 "requestUri":"/api/v1/documents/{DocumentId}/versions/{VersionId}", 517 "responseCode":200 518 }, 519 "input":{"shape":"GetDocumentVersionRequest"}, 520 "output":{"shape":"GetDocumentVersionResponse"}, 521 "errors":[ 522 {"shape":"EntityNotExistsException"}, 523 {"shape":"UnauthorizedOperationException"}, 524 {"shape":"UnauthorizedResourceAccessException"}, 525 {"shape":"FailedDependencyException"}, 526 {"shape":"ServiceUnavailableException"}, 527 {"shape":"ProhibitedStateException"} 528 ] 529 }, 530 "GetFolder":{ 531 "name":"GetFolder", 532 "http":{ 533 "method":"GET", 534 "requestUri":"/api/v1/folders/{FolderId}", 535 "responseCode":200 536 }, 537 "input":{"shape":"GetFolderRequest"}, 538 "output":{"shape":"GetFolderResponse"}, 539 "errors":[ 540 {"shape":"EntityNotExistsException"}, 541 {"shape":"UnauthorizedOperationException"}, 542 {"shape":"UnauthorizedResourceAccessException"}, 543 {"shape":"InvalidArgumentException"}, 544 {"shape":"FailedDependencyException"}, 545 {"shape":"ServiceUnavailableException"}, 546 {"shape":"ProhibitedStateException"} 547 ] 548 }, 549 "GetFolderPath":{ 550 "name":"GetFolderPath", 551 "http":{ 552 "method":"GET", 553 "requestUri":"/api/v1/folders/{FolderId}/path", 554 "responseCode":200 555 }, 556 "input":{"shape":"GetFolderPathRequest"}, 557 "output":{"shape":"GetFolderPathResponse"}, 558 "errors":[ 559 {"shape":"EntityNotExistsException"}, 560 {"shape":"UnauthorizedOperationException"}, 561 {"shape":"UnauthorizedResourceAccessException"}, 562 {"shape":"FailedDependencyException"}, 563 {"shape":"ServiceUnavailableException"} 564 ] 565 }, 566 "InitiateDocumentVersionUpload":{ 567 "name":"InitiateDocumentVersionUpload", 568 "http":{ 569 "method":"POST", 570 "requestUri":"/api/v1/documents", 571 "responseCode":201 572 }, 573 "input":{"shape":"InitiateDocumentVersionUploadRequest"}, 574 "output":{"shape":"InitiateDocumentVersionUploadResponse"}, 575 "errors":[ 576 {"shape":"EntityNotExistsException"}, 577 {"shape":"EntityAlreadyExistsException"}, 578 {"shape":"StorageLimitExceededException"}, 579 {"shape":"StorageLimitWillExceedException"}, 580 {"shape":"ProhibitedStateException"}, 581 {"shape":"UnauthorizedOperationException"}, 582 {"shape":"UnauthorizedResourceAccessException"}, 583 {"shape":"FailedDependencyException"}, 584 {"shape":"ServiceUnavailableException"}, 585 {"shape":"DraftUploadOutOfSyncException"}, 586 {"shape":"ResourceAlreadyCheckedOutException"} 587 ] 588 }, 589 "RemoveAllResourcePermissions":{ 590 "name":"RemoveAllResourcePermissions", 591 "http":{ 592 "method":"DELETE", 593 "requestUri":"/api/v1/resources/{ResourceId}/permissions", 594 "responseCode":204 595 }, 596 "input":{"shape":"RemoveAllResourcePermissionsRequest"}, 597 "errors":[ 598 {"shape":"UnauthorizedOperationException"}, 599 {"shape":"UnauthorizedResourceAccessException"}, 600 {"shape":"FailedDependencyException"}, 601 {"shape":"ServiceUnavailableException"} 602 ] 603 }, 604 "RemoveResourcePermission":{ 605 "name":"RemoveResourcePermission", 606 "http":{ 607 "method":"DELETE", 608 "requestUri":"/api/v1/resources/{ResourceId}/permissions/{PrincipalId}", 609 "responseCode":204 610 }, 611 "input":{"shape":"RemoveResourcePermissionRequest"}, 612 "errors":[ 613 {"shape":"UnauthorizedOperationException"}, 614 {"shape":"UnauthorizedResourceAccessException"}, 615 {"shape":"FailedDependencyException"}, 616 {"shape":"ServiceUnavailableException"} 617 ] 618 }, 619 "UpdateDocument":{ 620 "name":"UpdateDocument", 621 "http":{ 622 "method":"PATCH", 623 "requestUri":"/api/v1/documents/{DocumentId}", 624 "responseCode":200 625 }, 626 "input":{"shape":"UpdateDocumentRequest"}, 627 "errors":[ 628 {"shape":"EntityNotExistsException"}, 629 {"shape":"EntityAlreadyExistsException"}, 630 {"shape":"LimitExceededException"}, 631 {"shape":"ProhibitedStateException"}, 632 {"shape":"ConcurrentModificationException"}, 633 {"shape":"UnauthorizedOperationException"}, 634 {"shape":"UnauthorizedResourceAccessException"}, 635 {"shape":"FailedDependencyException"}, 636 {"shape":"ServiceUnavailableException"} 637 ] 638 }, 639 "UpdateDocumentVersion":{ 640 "name":"UpdateDocumentVersion", 641 "http":{ 642 "method":"PATCH", 643 "requestUri":"/api/v1/documents/{DocumentId}/versions/{VersionId}", 644 "responseCode":200 645 }, 646 "input":{"shape":"UpdateDocumentVersionRequest"}, 647 "errors":[ 648 {"shape":"EntityNotExistsException"}, 649 {"shape":"ProhibitedStateException"}, 650 {"shape":"ConcurrentModificationException"}, 651 {"shape":"InvalidOperationException"}, 652 {"shape":"UnauthorizedOperationException"}, 653 {"shape":"UnauthorizedResourceAccessException"}, 654 {"shape":"FailedDependencyException"}, 655 {"shape":"ServiceUnavailableException"} 656 ] 657 }, 658 "UpdateFolder":{ 659 "name":"UpdateFolder", 660 "http":{ 661 "method":"PATCH", 662 "requestUri":"/api/v1/folders/{FolderId}", 663 "responseCode":200 664 }, 665 "input":{"shape":"UpdateFolderRequest"}, 666 "errors":[ 667 {"shape":"EntityNotExistsException"}, 668 {"shape":"EntityAlreadyExistsException"}, 669 {"shape":"ProhibitedStateException"}, 670 {"shape":"ConcurrentModificationException"}, 671 {"shape":"LimitExceededException"}, 672 {"shape":"UnauthorizedOperationException"}, 673 {"shape":"UnauthorizedResourceAccessException"}, 674 {"shape":"FailedDependencyException"}, 675 {"shape":"ServiceUnavailableException"} 676 ] 677 }, 678 "UpdateUser":{ 679 "name":"UpdateUser", 680 "http":{ 681 "method":"PATCH", 682 "requestUri":"/api/v1/users/{UserId}", 683 "responseCode":200 684 }, 685 "input":{"shape":"UpdateUserRequest"}, 686 "output":{"shape":"UpdateUserResponse"}, 687 "errors":[ 688 {"shape":"EntityNotExistsException"}, 689 {"shape":"UnauthorizedOperationException"}, 690 {"shape":"UnauthorizedResourceAccessException"}, 691 {"shape":"IllegalUserStateException"}, 692 {"shape":"FailedDependencyException"}, 693 {"shape":"ServiceUnavailableException"}, 694 {"shape":"DeactivatingLastSystemUserException"} 695 ] 696 } 697 }, 698 "shapes":{ 699 "AbortDocumentVersionUploadRequest":{ 700 "type":"structure", 701 "required":[ 702 "DocumentId", 703 "VersionId" 704 ], 705 "members":{ 706 "AuthenticationToken":{ 707 "shape":"AuthenticationHeaderType", 708 "location":"header", 709 "locationName":"Authentication" 710 }, 711 "DocumentId":{ 712 "shape":"ResourceIdType", 713 "location":"uri", 714 "locationName":"DocumentId" 715 }, 716 "VersionId":{ 717 "shape":"DocumentVersionIdType", 718 "location":"uri", 719 "locationName":"VersionId" 720 } 721 } 722 }, 723 "ActivateUserRequest":{ 724 "type":"structure", 725 "required":["UserId"], 726 "members":{ 727 "UserId":{ 728 "shape":"IdType", 729 "location":"uri", 730 "locationName":"UserId" 731 }, 732 "AuthenticationToken":{ 733 "shape":"AuthenticationHeaderType", 734 "location":"header", 735 "locationName":"Authentication" 736 } 737 } 738 }, 739 "ActivateUserResponse":{ 740 "type":"structure", 741 "members":{ 742 "User":{"shape":"User"} 743 } 744 }, 745 "Activity":{ 746 "type":"structure", 747 "members":{ 748 "Type":{"shape":"ActivityType"}, 749 "TimeStamp":{"shape":"TimestampType"}, 750 "OrganizationId":{"shape":"IdType"}, 751 "Initiator":{"shape":"UserMetadata"}, 752 "Participants":{"shape":"Participants"}, 753 "ResourceMetadata":{"shape":"ResourceMetadata"}, 754 "OriginalParent":{"shape":"ResourceMetadata"}, 755 "CommentMetadata":{"shape":"CommentMetadata"} 756 } 757 }, 758 "ActivityType":{ 759 "type":"string", 760 "enum":[ 761 "DOCUMENT_CHECKED_IN", 762 "DOCUMENT_CHECKED_OUT", 763 "DOCUMENT_RENAMED", 764 "DOCUMENT_VERSION_UPLOADED", 765 "DOCUMENT_VERSION_DELETED", 766 "DOCUMENT_RECYCLED", 767 "DOCUMENT_RESTORED", 768 "DOCUMENT_REVERTED", 769 "DOCUMENT_SHARED", 770 "DOCUMENT_UNSHARED", 771 "DOCUMENT_SHARE_PERMISSION_CHANGED", 772 "DOCUMENT_SHAREABLE_LINK_CREATED", 773 "DOCUMENT_SHAREABLE_LINK_REMOVED", 774 "DOCUMENT_SHAREABLE_LINK_PERMISSION_CHANGED", 775 "DOCUMENT_MOVED", 776 "DOCUMENT_COMMENT_ADDED", 777 "DOCUMENT_COMMENT_DELETED", 778 "DOCUMENT_ANNOTATION_ADDED", 779 "DOCUMENT_ANNOTATION_DELETED", 780 "FOLDER_CREATED", 781 "FOLDER_DELETED", 782 "FOLDER_RENAMED", 783 "FOLDER_RECYCLED", 784 "FOLDER_RESTORED", 785 "FOLDER_SHARED", 786 "FOLDER_UNSHARED", 787 "FOLDER_SHARE_PERMISSION_CHANGED", 788 "FOLDER_SHAREABLE_LINK_CREATED", 789 "FOLDER_SHAREABLE_LINK_REMOVED", 790 "FOLDER_SHAREABLE_LINK_PERMISSION_CHANGED", 791 "FOLDER_MOVED" 792 ] 793 }, 794 "AddResourcePermissionsRequest":{ 795 "type":"structure", 796 "required":[ 797 "ResourceId", 798 "Principals" 799 ], 800 "members":{ 801 "AuthenticationToken":{ 802 "shape":"AuthenticationHeaderType", 803 "location":"header", 804 "locationName":"Authentication" 805 }, 806 "ResourceId":{ 807 "shape":"ResourceIdType", 808 "location":"uri", 809 "locationName":"ResourceId" 810 }, 811 "Principals":{"shape":"SharePrincipalList"} 812 } 813 }, 814 "AddResourcePermissionsResponse":{ 815 "type":"structure", 816 "members":{ 817 "ShareResults":{"shape":"ShareResultsList"} 818 } 819 }, 820 "AuthenticationHeaderType":{ 821 "type":"string", 822 "max":8199, 823 "min":1, 824 "sensitive":true 825 }, 826 "BooleanType":{"type":"boolean"}, 827 "Comment":{ 828 "type":"structure", 829 "required":["CommentId"], 830 "members":{ 831 "CommentId":{"shape":"CommentIdType"}, 832 "ParentId":{"shape":"CommentIdType"}, 833 "ThreadId":{"shape":"CommentIdType"}, 834 "Text":{"shape":"CommentTextType"}, 835 "Contributor":{"shape":"User"}, 836 "CreatedTimestamp":{"shape":"TimestampType"}, 837 "Status":{"shape":"CommentStatusType"}, 838 "Visibility":{"shape":"CommentVisibilityType"}, 839 "RecipientId":{"shape":"IdType"} 840 } 841 }, 842 "CommentIdType":{ 843 "type":"string", 844 "max":128, 845 "min":1, 846 "pattern":"[\\w+-.@]+" 847 }, 848 "CommentList":{ 849 "type":"list", 850 "member":{"shape":"Comment"} 851 }, 852 "CommentMetadata":{ 853 "type":"structure", 854 "members":{ 855 "CommentId":{"shape":"CommentIdType"}, 856 "Contributor":{"shape":"User"}, 857 "CreatedTimestamp":{"shape":"TimestampType"}, 858 "CommentStatus":{"shape":"CommentStatusType"}, 859 "RecipientId":{"shape":"IdType"} 860 } 861 }, 862 "CommentStatusType":{ 863 "type":"string", 864 "enum":[ 865 "DRAFT", 866 "PUBLISHED", 867 "DELETED" 868 ] 869 }, 870 "CommentTextType":{ 871 "type":"string", 872 "max":2048, 873 "min":1, 874 "sensitive":true 875 }, 876 "CommentVisibilityType":{ 877 "type":"string", 878 "enum":[ 879 "PUBLIC", 880 "PRIVATE" 881 ] 882 }, 883 "ConcurrentModificationException":{ 884 "type":"structure", 885 "members":{ 886 "Message":{"shape":"ErrorMessageType"} 887 }, 888 "error":{"httpStatusCode":409}, 889 "exception":true 890 }, 891 "CreateCommentRequest":{ 892 "type":"structure", 893 "required":[ 894 "DocumentId", 895 "VersionId", 896 "Text" 897 ], 898 "members":{ 899 "AuthenticationToken":{ 900 "shape":"AuthenticationHeaderType", 901 "location":"header", 902 "locationName":"Authentication" 903 }, 904 "DocumentId":{ 905 "shape":"ResourceIdType", 906 "location":"uri", 907 "locationName":"DocumentId" 908 }, 909 "VersionId":{ 910 "shape":"DocumentVersionIdType", 911 "location":"uri", 912 "locationName":"VersionId" 913 }, 914 "ParentId":{"shape":"CommentIdType"}, 915 "ThreadId":{"shape":"CommentIdType"}, 916 "Text":{"shape":"CommentTextType"}, 917 "Visibility":{"shape":"CommentVisibilityType"}, 918 "NotifyCollaborators":{"shape":"BooleanType"} 919 } 920 }, 921 "CreateCommentResponse":{ 922 "type":"structure", 923 "members":{ 924 "Comment":{"shape":"Comment"} 925 } 926 }, 927 "CreateCustomMetadataRequest":{ 928 "type":"structure", 929 "required":[ 930 "ResourceId", 931 "CustomMetadata" 932 ], 933 "members":{ 934 "AuthenticationToken":{ 935 "shape":"AuthenticationHeaderType", 936 "location":"header", 937 "locationName":"Authentication" 938 }, 939 "ResourceId":{ 940 "shape":"ResourceIdType", 941 "location":"uri", 942 "locationName":"ResourceId" 943 }, 944 "VersionId":{ 945 "shape":"DocumentVersionIdType", 946 "location":"querystring", 947 "locationName":"versionid" 948 }, 949 "CustomMetadata":{"shape":"CustomMetadataMap"} 950 } 951 }, 952 "CreateCustomMetadataResponse":{ 953 "type":"structure", 954 "members":{ 955 } 956 }, 957 "CreateFolderRequest":{ 958 "type":"structure", 959 "required":["ParentFolderId"], 960 "members":{ 961 "AuthenticationToken":{ 962 "shape":"AuthenticationHeaderType", 963 "location":"header", 964 "locationName":"Authentication" 965 }, 966 "Name":{"shape":"ResourceNameType"}, 967 "ParentFolderId":{"shape":"ResourceIdType"} 968 } 969 }, 970 "CreateFolderResponse":{ 971 "type":"structure", 972 "members":{ 973 "Metadata":{"shape":"FolderMetadata"} 974 } 975 }, 976 "CreateLabelsRequest":{ 977 "type":"structure", 978 "required":[ 979 "ResourceId", 980 "Labels" 981 ], 982 "members":{ 983 "ResourceId":{ 984 "shape":"ResourceIdType", 985 "location":"uri", 986 "locationName":"ResourceId" 987 }, 988 "Labels":{"shape":"Labels"}, 989 "AuthenticationToken":{ 990 "shape":"AuthenticationHeaderType", 991 "location":"header", 992 "locationName":"Authentication" 993 } 994 } 995 }, 996 "CreateLabelsResponse":{ 997 "type":"structure", 998 "members":{ 999 } 1000 }, 1001 "CreateNotificationSubscriptionRequest":{ 1002 "type":"structure", 1003 "required":[ 1004 "OrganizationId", 1005 "Endpoint", 1006 "Protocol", 1007 "SubscriptionType" 1008 ], 1009 "members":{ 1010 "OrganizationId":{ 1011 "shape":"IdType", 1012 "location":"uri", 1013 "locationName":"OrganizationId" 1014 }, 1015 "Endpoint":{"shape":"SubscriptionEndPointType"}, 1016 "Protocol":{"shape":"SubscriptionProtocolType"}, 1017 "SubscriptionType":{"shape":"SubscriptionType"} 1018 } 1019 }, 1020 "CreateNotificationSubscriptionResponse":{ 1021 "type":"structure", 1022 "members":{ 1023 "Subscription":{"shape":"Subscription"} 1024 } 1025 }, 1026 "CreateUserRequest":{ 1027 "type":"structure", 1028 "required":[ 1029 "Username", 1030 "GivenName", 1031 "Surname", 1032 "Password" 1033 ], 1034 "members":{ 1035 "OrganizationId":{"shape":"IdType"}, 1036 "Username":{"shape":"UsernameType"}, 1037 "EmailAddress":{"shape":"EmailAddressType"}, 1038 "GivenName":{"shape":"UserAttributeValueType"}, 1039 "Surname":{"shape":"UserAttributeValueType"}, 1040 "Password":{"shape":"PasswordType"}, 1041 "TimeZoneId":{"shape":"TimeZoneIdType"}, 1042 "StorageRule":{"shape":"StorageRuleType"}, 1043 "AuthenticationToken":{ 1044 "shape":"AuthenticationHeaderType", 1045 "location":"header", 1046 "locationName":"Authentication" 1047 } 1048 } 1049 }, 1050 "CreateUserResponse":{ 1051 "type":"structure", 1052 "members":{ 1053 "User":{"shape":"User"} 1054 } 1055 }, 1056 "CustomMetadataKeyList":{ 1057 "type":"list", 1058 "member":{"shape":"CustomMetadataKeyType"}, 1059 "max":8 1060 }, 1061 "CustomMetadataKeyType":{ 1062 "type":"string", 1063 "max":56, 1064 "min":1, 1065 "pattern":"[a-zA-Z0-9._+-/=][a-zA-Z0-9 ._+-/=]*" 1066 }, 1067 "CustomMetadataLimitExceededException":{ 1068 "type":"structure", 1069 "members":{ 1070 "Message":{"shape":"ErrorMessageType"} 1071 }, 1072 "error":{"httpStatusCode":429}, 1073 "exception":true 1074 }, 1075 "CustomMetadataMap":{ 1076 "type":"map", 1077 "key":{"shape":"CustomMetadataKeyType"}, 1078 "value":{"shape":"CustomMetadataValueType"}, 1079 "max":8, 1080 "min":1 1081 }, 1082 "CustomMetadataValueType":{ 1083 "type":"string", 1084 "max":256, 1085 "min":1, 1086 "pattern":"[a-zA-Z0-9._+-/=][a-zA-Z0-9 ._+-/=]*" 1087 }, 1088 "DeactivateUserRequest":{ 1089 "type":"structure", 1090 "required":["UserId"], 1091 "members":{ 1092 "UserId":{ 1093 "shape":"IdType", 1094 "location":"uri", 1095 "locationName":"UserId" 1096 }, 1097 "AuthenticationToken":{ 1098 "shape":"AuthenticationHeaderType", 1099 "location":"header", 1100 "locationName":"Authentication" 1101 } 1102 } 1103 }, 1104 "DeactivatingLastSystemUserException":{ 1105 "type":"structure", 1106 "members":{ 1107 }, 1108 "error":{"httpStatusCode":409}, 1109 "exception":true 1110 }, 1111 "DeleteCommentRequest":{ 1112 "type":"structure", 1113 "required":[ 1114 "DocumentId", 1115 "VersionId", 1116 "CommentId" 1117 ], 1118 "members":{ 1119 "AuthenticationToken":{ 1120 "shape":"AuthenticationHeaderType", 1121 "location":"header", 1122 "locationName":"Authentication" 1123 }, 1124 "DocumentId":{ 1125 "shape":"ResourceIdType", 1126 "location":"uri", 1127 "locationName":"DocumentId" 1128 }, 1129 "VersionId":{ 1130 "shape":"DocumentVersionIdType", 1131 "location":"uri", 1132 "locationName":"VersionId" 1133 }, 1134 "CommentId":{ 1135 "shape":"CommentIdType", 1136 "location":"uri", 1137 "locationName":"CommentId" 1138 } 1139 } 1140 }, 1141 "DeleteCustomMetadataRequest":{ 1142 "type":"structure", 1143 "required":["ResourceId"], 1144 "members":{ 1145 "AuthenticationToken":{ 1146 "shape":"AuthenticationHeaderType", 1147 "location":"header", 1148 "locationName":"Authentication" 1149 }, 1150 "ResourceId":{ 1151 "shape":"ResourceIdType", 1152 "location":"uri", 1153 "locationName":"ResourceId" 1154 }, 1155 "VersionId":{ 1156 "shape":"DocumentVersionIdType", 1157 "location":"querystring", 1158 "locationName":"versionId" 1159 }, 1160 "Keys":{ 1161 "shape":"CustomMetadataKeyList", 1162 "location":"querystring", 1163 "locationName":"keys" 1164 }, 1165 "DeleteAll":{ 1166 "shape":"BooleanType", 1167 "location":"querystring", 1168 "locationName":"deleteAll" 1169 } 1170 } 1171 }, 1172 "DeleteCustomMetadataResponse":{ 1173 "type":"structure", 1174 "members":{ 1175 } 1176 }, 1177 "DeleteDocumentRequest":{ 1178 "type":"structure", 1179 "required":["DocumentId"], 1180 "members":{ 1181 "AuthenticationToken":{ 1182 "shape":"AuthenticationHeaderType", 1183 "location":"header", 1184 "locationName":"Authentication" 1185 }, 1186 "DocumentId":{ 1187 "shape":"ResourceIdType", 1188 "location":"uri", 1189 "locationName":"DocumentId" 1190 } 1191 } 1192 }, 1193 "DeleteFolderContentsRequest":{ 1194 "type":"structure", 1195 "required":["FolderId"], 1196 "members":{ 1197 "AuthenticationToken":{ 1198 "shape":"AuthenticationHeaderType", 1199 "location":"header", 1200 "locationName":"Authentication" 1201 }, 1202 "FolderId":{ 1203 "shape":"ResourceIdType", 1204 "location":"uri", 1205 "locationName":"FolderId" 1206 } 1207 } 1208 }, 1209 "DeleteFolderRequest":{ 1210 "type":"structure", 1211 "required":["FolderId"], 1212 "members":{ 1213 "AuthenticationToken":{ 1214 "shape":"AuthenticationHeaderType", 1215 "location":"header", 1216 "locationName":"Authentication" 1217 }, 1218 "FolderId":{ 1219 "shape":"ResourceIdType", 1220 "location":"uri", 1221 "locationName":"FolderId" 1222 } 1223 } 1224 }, 1225 "DeleteLabelsRequest":{ 1226 "type":"structure", 1227 "required":["ResourceId"], 1228 "members":{ 1229 "ResourceId":{ 1230 "shape":"ResourceIdType", 1231 "location":"uri", 1232 "locationName":"ResourceId" 1233 }, 1234 "AuthenticationToken":{ 1235 "shape":"AuthenticationHeaderType", 1236 "location":"header", 1237 "locationName":"Authentication" 1238 }, 1239 "Labels":{ 1240 "shape":"Labels", 1241 "location":"querystring", 1242 "locationName":"labels" 1243 }, 1244 "DeleteAll":{ 1245 "shape":"BooleanType", 1246 "location":"querystring", 1247 "locationName":"deleteAll" 1248 } 1249 } 1250 }, 1251 "DeleteLabelsResponse":{ 1252 "type":"structure", 1253 "members":{ 1254 } 1255 }, 1256 "DeleteNotificationSubscriptionRequest":{ 1257 "type":"structure", 1258 "required":[ 1259 "SubscriptionId", 1260 "OrganizationId" 1261 ], 1262 "members":{ 1263 "SubscriptionId":{ 1264 "shape":"IdType", 1265 "location":"uri", 1266 "locationName":"SubscriptionId" 1267 }, 1268 "OrganizationId":{ 1269 "shape":"IdType", 1270 "location":"uri", 1271 "locationName":"OrganizationId" 1272 } 1273 } 1274 }, 1275 "DeleteUserRequest":{ 1276 "type":"structure", 1277 "required":["UserId"], 1278 "members":{ 1279 "AuthenticationToken":{ 1280 "shape":"AuthenticationHeaderType", 1281 "location":"header", 1282 "locationName":"Authentication" 1283 }, 1284 "UserId":{ 1285 "shape":"IdType", 1286 "location":"uri", 1287 "locationName":"UserId" 1288 } 1289 } 1290 }, 1291 "DescribeActivitiesRequest":{ 1292 "type":"structure", 1293 "members":{ 1294 "AuthenticationToken":{ 1295 "shape":"AuthenticationHeaderType", 1296 "location":"header", 1297 "locationName":"Authentication" 1298 }, 1299 "StartTime":{ 1300 "shape":"TimestampType", 1301 "location":"querystring", 1302 "locationName":"startTime" 1303 }, 1304 "EndTime":{ 1305 "shape":"TimestampType", 1306 "location":"querystring", 1307 "locationName":"endTime" 1308 }, 1309 "OrganizationId":{ 1310 "shape":"IdType", 1311 "location":"querystring", 1312 "locationName":"organizationId" 1313 }, 1314 "UserId":{ 1315 "shape":"IdType", 1316 "location":"querystring", 1317 "locationName":"userId" 1318 }, 1319 "Limit":{ 1320 "shape":"LimitType", 1321 "location":"querystring", 1322 "locationName":"limit" 1323 }, 1324 "Marker":{ 1325 "shape":"MarkerType", 1326 "location":"querystring", 1327 "locationName":"marker" 1328 } 1329 } 1330 }, 1331 "DescribeActivitiesResponse":{ 1332 "type":"structure", 1333 "members":{ 1334 "UserActivities":{"shape":"UserActivities"}, 1335 "Marker":{"shape":"MarkerType"} 1336 } 1337 }, 1338 "DescribeCommentsRequest":{ 1339 "type":"structure", 1340 "required":[ 1341 "DocumentId", 1342 "VersionId" 1343 ], 1344 "members":{ 1345 "AuthenticationToken":{ 1346 "shape":"AuthenticationHeaderType", 1347 "location":"header", 1348 "locationName":"Authentication" 1349 }, 1350 "DocumentId":{ 1351 "shape":"ResourceIdType", 1352 "location":"uri", 1353 "locationName":"DocumentId" 1354 }, 1355 "VersionId":{ 1356 "shape":"DocumentVersionIdType", 1357 "location":"uri", 1358 "locationName":"VersionId" 1359 }, 1360 "Limit":{ 1361 "shape":"LimitType", 1362 "location":"querystring", 1363 "locationName":"limit" 1364 }, 1365 "Marker":{ 1366 "shape":"MarkerType", 1367 "location":"querystring", 1368 "locationName":"marker" 1369 } 1370 } 1371 }, 1372 "DescribeCommentsResponse":{ 1373 "type":"structure", 1374 "members":{ 1375 "Comments":{"shape":"CommentList"}, 1376 "Marker":{"shape":"MarkerType"} 1377 } 1378 }, 1379 "DescribeDocumentVersionsRequest":{ 1380 "type":"structure", 1381 "required":["DocumentId"], 1382 "members":{ 1383 "AuthenticationToken":{ 1384 "shape":"AuthenticationHeaderType", 1385 "location":"header", 1386 "locationName":"Authentication" 1387 }, 1388 "DocumentId":{ 1389 "shape":"ResourceIdType", 1390 "location":"uri", 1391 "locationName":"DocumentId" 1392 }, 1393 "Marker":{ 1394 "shape":"PageMarkerType", 1395 "location":"querystring", 1396 "locationName":"marker" 1397 }, 1398 "Limit":{ 1399 "shape":"LimitType", 1400 "location":"querystring", 1401 "locationName":"limit" 1402 }, 1403 "Include":{ 1404 "shape":"FieldNamesType", 1405 "location":"querystring", 1406 "locationName":"include" 1407 }, 1408 "Fields":{ 1409 "shape":"FieldNamesType", 1410 "location":"querystring", 1411 "locationName":"fields" 1412 } 1413 } 1414 }, 1415 "DescribeDocumentVersionsResponse":{ 1416 "type":"structure", 1417 "members":{ 1418 "DocumentVersions":{"shape":"DocumentVersionMetadataList"}, 1419 "Marker":{"shape":"PageMarkerType"} 1420 } 1421 }, 1422 "DescribeFolderContentsRequest":{ 1423 "type":"structure", 1424 "required":["FolderId"], 1425 "members":{ 1426 "AuthenticationToken":{ 1427 "shape":"AuthenticationHeaderType", 1428 "location":"header", 1429 "locationName":"Authentication" 1430 }, 1431 "FolderId":{ 1432 "shape":"ResourceIdType", 1433 "location":"uri", 1434 "locationName":"FolderId" 1435 }, 1436 "Sort":{ 1437 "shape":"ResourceSortType", 1438 "location":"querystring", 1439 "locationName":"sort" 1440 }, 1441 "Order":{ 1442 "shape":"OrderType", 1443 "location":"querystring", 1444 "locationName":"order" 1445 }, 1446 "Limit":{ 1447 "shape":"LimitType", 1448 "location":"querystring", 1449 "locationName":"limit" 1450 }, 1451 "Marker":{ 1452 "shape":"PageMarkerType", 1453 "location":"querystring", 1454 "locationName":"marker" 1455 }, 1456 "Type":{ 1457 "shape":"FolderContentType", 1458 "location":"querystring", 1459 "locationName":"type" 1460 }, 1461 "Include":{ 1462 "shape":"FieldNamesType", 1463 "location":"querystring", 1464 "locationName":"include" 1465 } 1466 } 1467 }, 1468 "DescribeFolderContentsResponse":{ 1469 "type":"structure", 1470 "members":{ 1471 "Folders":{"shape":"FolderMetadataList"}, 1472 "Documents":{"shape":"DocumentMetadataList"}, 1473 "Marker":{"shape":"PageMarkerType"} 1474 } 1475 }, 1476 "DescribeNotificationSubscriptionsRequest":{ 1477 "type":"structure", 1478 "required":["OrganizationId"], 1479 "members":{ 1480 "OrganizationId":{ 1481 "shape":"IdType", 1482 "location":"uri", 1483 "locationName":"OrganizationId" 1484 }, 1485 "Marker":{ 1486 "shape":"PageMarkerType", 1487 "location":"querystring", 1488 "locationName":"marker" 1489 }, 1490 "Limit":{ 1491 "shape":"LimitType", 1492 "location":"querystring", 1493 "locationName":"limit" 1494 } 1495 } 1496 }, 1497 "DescribeNotificationSubscriptionsResponse":{ 1498 "type":"structure", 1499 "members":{ 1500 "Subscriptions":{"shape":"SubscriptionList"}, 1501 "Marker":{"shape":"PageMarkerType"} 1502 } 1503 }, 1504 "DescribeResourcePermissionsRequest":{ 1505 "type":"structure", 1506 "required":["ResourceId"], 1507 "members":{ 1508 "AuthenticationToken":{ 1509 "shape":"AuthenticationHeaderType", 1510 "location":"header", 1511 "locationName":"Authentication" 1512 }, 1513 "ResourceId":{ 1514 "shape":"ResourceIdType", 1515 "location":"uri", 1516 "locationName":"ResourceId" 1517 }, 1518 "Limit":{ 1519 "shape":"LimitType", 1520 "location":"querystring", 1521 "locationName":"limit" 1522 }, 1523 "Marker":{ 1524 "shape":"PageMarkerType", 1525 "location":"querystring", 1526 "locationName":"marker" 1527 } 1528 } 1529 }, 1530 "DescribeResourcePermissionsResponse":{ 1531 "type":"structure", 1532 "members":{ 1533 "Principals":{"shape":"PrincipalList"}, 1534 "Marker":{"shape":"PageMarkerType"} 1535 } 1536 }, 1537 "DescribeRootFoldersRequest":{ 1538 "type":"structure", 1539 "required":["AuthenticationToken"], 1540 "members":{ 1541 "AuthenticationToken":{ 1542 "shape":"AuthenticationHeaderType", 1543 "location":"header", 1544 "locationName":"Authentication" 1545 }, 1546 "Limit":{ 1547 "shape":"LimitType", 1548 "location":"querystring", 1549 "locationName":"limit" 1550 }, 1551 "Marker":{ 1552 "shape":"PageMarkerType", 1553 "location":"querystring", 1554 "locationName":"marker" 1555 } 1556 } 1557 }, 1558 "DescribeRootFoldersResponse":{ 1559 "type":"structure", 1560 "members":{ 1561 "Folders":{"shape":"FolderMetadataList"}, 1562 "Marker":{"shape":"PageMarkerType"} 1563 } 1564 }, 1565 "DescribeUsersRequest":{ 1566 "type":"structure", 1567 "members":{ 1568 "AuthenticationToken":{ 1569 "shape":"AuthenticationHeaderType", 1570 "location":"header", 1571 "locationName":"Authentication" 1572 }, 1573 "OrganizationId":{ 1574 "shape":"IdType", 1575 "location":"querystring", 1576 "locationName":"organizationId" 1577 }, 1578 "UserIds":{ 1579 "shape":"UserIdsType", 1580 "location":"querystring", 1581 "locationName":"userIds" 1582 }, 1583 "Query":{ 1584 "shape":"SearchQueryType", 1585 "location":"querystring", 1586 "locationName":"query" 1587 }, 1588 "Include":{ 1589 "shape":"UserFilterType", 1590 "location":"querystring", 1591 "locationName":"include" 1592 }, 1593 "Order":{ 1594 "shape":"OrderType", 1595 "location":"querystring", 1596 "locationName":"order" 1597 }, 1598 "Sort":{ 1599 "shape":"UserSortType", 1600 "location":"querystring", 1601 "locationName":"sort" 1602 }, 1603 "Marker":{ 1604 "shape":"PageMarkerType", 1605 "location":"querystring", 1606 "locationName":"marker" 1607 }, 1608 "Limit":{ 1609 "shape":"LimitType", 1610 "location":"querystring", 1611 "locationName":"limit" 1612 }, 1613 "Fields":{ 1614 "shape":"FieldNamesType", 1615 "location":"querystring", 1616 "locationName":"fields" 1617 } 1618 } 1619 }, 1620 "DescribeUsersResponse":{ 1621 "type":"structure", 1622 "members":{ 1623 "Users":{"shape":"OrganizationUserList"}, 1624 "TotalNumberOfUsers":{"shape":"SizeType"}, 1625 "Marker":{"shape":"PageMarkerType"} 1626 } 1627 }, 1628 "DocumentContentType":{ 1629 "type":"string", 1630 "max":128, 1631 "min":1 1632 }, 1633 "DocumentLockedForCommentsException":{ 1634 "type":"structure", 1635 "members":{ 1636 "Message":{"shape":"ErrorMessageType"} 1637 }, 1638 "error":{"httpStatusCode":409}, 1639 "exception":true 1640 }, 1641 "DocumentMetadata":{ 1642 "type":"structure", 1643 "members":{ 1644 "Id":{"shape":"ResourceIdType"}, 1645 "CreatorId":{"shape":"IdType"}, 1646 "ParentFolderId":{"shape":"ResourceIdType"}, 1647 "CreatedTimestamp":{"shape":"TimestampType"}, 1648 "ModifiedTimestamp":{"shape":"TimestampType"}, 1649 "LatestVersionMetadata":{"shape":"DocumentVersionMetadata"}, 1650 "ResourceState":{"shape":"ResourceStateType"}, 1651 "Labels":{"shape":"Labels"} 1652 } 1653 }, 1654 "DocumentMetadataList":{ 1655 "type":"list", 1656 "member":{"shape":"DocumentMetadata"} 1657 }, 1658 "DocumentSourceType":{ 1659 "type":"string", 1660 "enum":[ 1661 "ORIGINAL", 1662 "WITH_COMMENTS" 1663 ] 1664 }, 1665 "DocumentSourceUrlMap":{ 1666 "type":"map", 1667 "key":{"shape":"DocumentSourceType"}, 1668 "value":{"shape":"UrlType"} 1669 }, 1670 "DocumentStatusType":{ 1671 "type":"string", 1672 "enum":[ 1673 "INITIALIZED", 1674 "ACTIVE" 1675 ] 1676 }, 1677 "DocumentThumbnailType":{ 1678 "type":"string", 1679 "enum":[ 1680 "SMALL", 1681 "SMALL_HQ", 1682 "LARGE" 1683 ] 1684 }, 1685 "DocumentThumbnailUrlMap":{ 1686 "type":"map", 1687 "key":{"shape":"DocumentThumbnailType"}, 1688 "value":{"shape":"UrlType"} 1689 }, 1690 "DocumentVersionIdType":{ 1691 "type":"string", 1692 "max":128, 1693 "min":1, 1694 "pattern":"[\\w+-.@]+" 1695 }, 1696 "DocumentVersionMetadata":{ 1697 "type":"structure", 1698 "members":{ 1699 "Id":{"shape":"DocumentVersionIdType"}, 1700 "Name":{"shape":"ResourceNameType"}, 1701 "ContentType":{"shape":"DocumentContentType"}, 1702 "Size":{"shape":"SizeType"}, 1703 "Signature":{"shape":"HashType"}, 1704 "Status":{"shape":"DocumentStatusType"}, 1705 "CreatedTimestamp":{"shape":"TimestampType"}, 1706 "ModifiedTimestamp":{"shape":"TimestampType"}, 1707 "ContentCreatedTimestamp":{"shape":"TimestampType"}, 1708 "ContentModifiedTimestamp":{"shape":"TimestampType"}, 1709 "CreatorId":{"shape":"IdType"}, 1710 "Thumbnail":{"shape":"DocumentThumbnailUrlMap"}, 1711 "Source":{"shape":"DocumentSourceUrlMap"} 1712 } 1713 }, 1714 "DocumentVersionMetadataList":{ 1715 "type":"list", 1716 "member":{"shape":"DocumentVersionMetadata"} 1717 }, 1718 "DocumentVersionStatus":{ 1719 "type":"string", 1720 "enum":["ACTIVE"] 1721 }, 1722 "DraftUploadOutOfSyncException":{ 1723 "type":"structure", 1724 "members":{ 1725 "Message":{"shape":"ErrorMessageType"} 1726 }, 1727 "error":{"httpStatusCode":409}, 1728 "exception":true 1729 }, 1730 "EmailAddressType":{ 1731 "type":"string", 1732 "max":256, 1733 "min":1, 1734 "pattern":"[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}" 1735 }, 1736 "EntityAlreadyExistsException":{ 1737 "type":"structure", 1738 "members":{ 1739 "Message":{"shape":"ErrorMessageType"} 1740 }, 1741 "error":{"httpStatusCode":409}, 1742 "exception":true 1743 }, 1744 "EntityIdList":{ 1745 "type":"list", 1746 "member":{"shape":"IdType"} 1747 }, 1748 "EntityNotExistsException":{ 1749 "type":"structure", 1750 "members":{ 1751 "Message":{"shape":"ErrorMessageType"}, 1752 "EntityIds":{"shape":"EntityIdList"} 1753 }, 1754 "error":{"httpStatusCode":404}, 1755 "exception":true 1756 }, 1757 "ErrorMessageType":{"type":"string"}, 1758 "FailedDependencyException":{ 1759 "type":"structure", 1760 "members":{ 1761 "Message":{"shape":"ErrorMessageType"} 1762 }, 1763 "error":{"httpStatusCode":424}, 1764 "exception":true 1765 }, 1766 "FieldNamesType":{ 1767 "type":"string", 1768 "max":256, 1769 "min":1, 1770 "pattern":"[\\w,]+" 1771 }, 1772 "FolderContentType":{ 1773 "type":"string", 1774 "enum":[ 1775 "ALL", 1776 "DOCUMENT", 1777 "FOLDER" 1778 ] 1779 }, 1780 "FolderMetadata":{ 1781 "type":"structure", 1782 "members":{ 1783 "Id":{"shape":"ResourceIdType"}, 1784 "Name":{"shape":"ResourceNameType"}, 1785 "CreatorId":{"shape":"IdType"}, 1786 "ParentFolderId":{"shape":"ResourceIdType"}, 1787 "CreatedTimestamp":{"shape":"TimestampType"}, 1788 "ModifiedTimestamp":{"shape":"TimestampType"}, 1789 "ResourceState":{"shape":"ResourceStateType"}, 1790 "Signature":{"shape":"HashType"}, 1791 "Labels":{"shape":"Labels"}, 1792 "Size":{"shape":"SizeType"}, 1793 "LatestVersionSize":{"shape":"SizeType"} 1794 } 1795 }, 1796 "FolderMetadataList":{ 1797 "type":"list", 1798 "member":{"shape":"FolderMetadata"} 1799 }, 1800 "GetCurrentUserRequest":{ 1801 "type":"structure", 1802 "required":["AuthenticationToken"], 1803 "members":{ 1804 "AuthenticationToken":{ 1805 "shape":"AuthenticationHeaderType", 1806 "location":"header", 1807 "locationName":"Authentication" 1808 } 1809 } 1810 }, 1811 "GetCurrentUserResponse":{ 1812 "type":"structure", 1813 "members":{ 1814 "User":{"shape":"User"} 1815 } 1816 }, 1817 "GetDocumentPathRequest":{ 1818 "type":"structure", 1819 "required":["DocumentId"], 1820 "members":{ 1821 "AuthenticationToken":{ 1822 "shape":"AuthenticationHeaderType", 1823 "location":"header", 1824 "locationName":"Authentication" 1825 }, 1826 "DocumentId":{ 1827 "shape":"IdType", 1828 "location":"uri", 1829 "locationName":"DocumentId" 1830 }, 1831 "Limit":{ 1832 "shape":"LimitType", 1833 "location":"querystring", 1834 "locationName":"limit" 1835 }, 1836 "Fields":{ 1837 "shape":"FieldNamesType", 1838 "location":"querystring", 1839 "locationName":"fields" 1840 }, 1841 "Marker":{ 1842 "shape":"PageMarkerType", 1843 "location":"querystring", 1844 "locationName":"marker" 1845 } 1846 } 1847 }, 1848 "GetDocumentPathResponse":{ 1849 "type":"structure", 1850 "members":{ 1851 "Path":{"shape":"ResourcePath"} 1852 } 1853 }, 1854 "GetDocumentRequest":{ 1855 "type":"structure", 1856 "required":["DocumentId"], 1857 "members":{ 1858 "AuthenticationToken":{ 1859 "shape":"AuthenticationHeaderType", 1860 "location":"header", 1861 "locationName":"Authentication" 1862 }, 1863 "DocumentId":{ 1864 "shape":"ResourceIdType", 1865 "location":"uri", 1866 "locationName":"DocumentId" 1867 }, 1868 "IncludeCustomMetadata":{ 1869 "shape":"BooleanType", 1870 "location":"querystring", 1871 "locationName":"includeCustomMetadata" 1872 } 1873 } 1874 }, 1875 "GetDocumentResponse":{ 1876 "type":"structure", 1877 "members":{ 1878 "Metadata":{"shape":"DocumentMetadata"}, 1879 "CustomMetadata":{"shape":"CustomMetadataMap"} 1880 } 1881 }, 1882 "GetDocumentVersionRequest":{ 1883 "type":"structure", 1884 "required":[ 1885 "DocumentId", 1886 "VersionId" 1887 ], 1888 "members":{ 1889 "AuthenticationToken":{ 1890 "shape":"AuthenticationHeaderType", 1891 "location":"header", 1892 "locationName":"Authentication" 1893 }, 1894 "DocumentId":{ 1895 "shape":"ResourceIdType", 1896 "location":"uri", 1897 "locationName":"DocumentId" 1898 }, 1899 "VersionId":{ 1900 "shape":"DocumentVersionIdType", 1901 "location":"uri", 1902 "locationName":"VersionId" 1903 }, 1904 "Fields":{ 1905 "shape":"FieldNamesType", 1906 "location":"querystring", 1907 "locationName":"fields" 1908 }, 1909 "IncludeCustomMetadata":{ 1910 "shape":"BooleanType", 1911 "location":"querystring", 1912 "locationName":"includeCustomMetadata" 1913 } 1914 } 1915 }, 1916 "GetDocumentVersionResponse":{ 1917 "type":"structure", 1918 "members":{ 1919 "Metadata":{"shape":"DocumentVersionMetadata"}, 1920 "CustomMetadata":{"shape":"CustomMetadataMap"} 1921 } 1922 }, 1923 "GetFolderPathRequest":{ 1924 "type":"structure", 1925 "required":["FolderId"], 1926 "members":{ 1927 "AuthenticationToken":{ 1928 "shape":"AuthenticationHeaderType", 1929 "location":"header", 1930 "locationName":"Authentication" 1931 }, 1932 "FolderId":{ 1933 "shape":"IdType", 1934 "location":"uri", 1935 "locationName":"FolderId" 1936 }, 1937 "Limit":{ 1938 "shape":"LimitType", 1939 "location":"querystring", 1940 "locationName":"limit" 1941 }, 1942 "Fields":{ 1943 "shape":"FieldNamesType", 1944 "location":"querystring", 1945 "locationName":"fields" 1946 }, 1947 "Marker":{ 1948 "shape":"PageMarkerType", 1949 "location":"querystring", 1950 "locationName":"marker" 1951 } 1952 } 1953 }, 1954 "GetFolderPathResponse":{ 1955 "type":"structure", 1956 "members":{ 1957 "Path":{"shape":"ResourcePath"} 1958 } 1959 }, 1960 "GetFolderRequest":{ 1961 "type":"structure", 1962 "required":["FolderId"], 1963 "members":{ 1964 "AuthenticationToken":{ 1965 "shape":"AuthenticationHeaderType", 1966 "location":"header", 1967 "locationName":"Authentication" 1968 }, 1969 "FolderId":{ 1970 "shape":"ResourceIdType", 1971 "location":"uri", 1972 "locationName":"FolderId" 1973 }, 1974 "IncludeCustomMetadata":{ 1975 "shape":"BooleanType", 1976 "location":"querystring", 1977 "locationName":"includeCustomMetadata" 1978 } 1979 } 1980 }, 1981 "GetFolderResponse":{ 1982 "type":"structure", 1983 "members":{ 1984 "Metadata":{"shape":"FolderMetadata"}, 1985 "CustomMetadata":{"shape":"CustomMetadataMap"} 1986 } 1987 }, 1988 "GroupMetadata":{ 1989 "type":"structure", 1990 "members":{ 1991 "Id":{"shape":"IdType"}, 1992 "Name":{"shape":"GroupNameType"} 1993 } 1994 }, 1995 "GroupMetadataList":{ 1996 "type":"list", 1997 "member":{"shape":"GroupMetadata"} 1998 }, 1999 "GroupNameType":{"type":"string"}, 2000 "HashType":{ 2001 "type":"string", 2002 "max":128, 2003 "min":0, 2004 "pattern":"[&\\w+-.@]+" 2005 }, 2006 "HeaderNameType":{ 2007 "type":"string", 2008 "max":256, 2009 "min":1, 2010 "pattern":"[\\w-]+" 2011 }, 2012 "HeaderValueType":{ 2013 "type":"string", 2014 "max":1024, 2015 "min":1 2016 }, 2017 "IdType":{ 2018 "type":"string", 2019 "max":256, 2020 "min":1, 2021 "pattern":"[&\\w+-.@]+" 2022 }, 2023 "IllegalUserStateException":{ 2024 "type":"structure", 2025 "members":{ 2026 "Message":{"shape":"ErrorMessageType"} 2027 }, 2028 "error":{"httpStatusCode":409}, 2029 "exception":true 2030 }, 2031 "InitiateDocumentVersionUploadRequest":{ 2032 "type":"structure", 2033 "required":["ParentFolderId"], 2034 "members":{ 2035 "AuthenticationToken":{ 2036 "shape":"AuthenticationHeaderType", 2037 "location":"header", 2038 "locationName":"Authentication" 2039 }, 2040 "Id":{"shape":"ResourceIdType"}, 2041 "Name":{"shape":"ResourceNameType"}, 2042 "ContentCreatedTimestamp":{"shape":"TimestampType"}, 2043 "ContentModifiedTimestamp":{"shape":"TimestampType"}, 2044 "ContentType":{"shape":"DocumentContentType"}, 2045 "DocumentSizeInBytes":{"shape":"SizeType"}, 2046 "ParentFolderId":{"shape":"ResourceIdType"} 2047 } 2048 }, 2049 "InitiateDocumentVersionUploadResponse":{ 2050 "type":"structure", 2051 "members":{ 2052 "Metadata":{"shape":"DocumentMetadata"}, 2053 "UploadMetadata":{"shape":"UploadMetadata"} 2054 } 2055 }, 2056 "InvalidArgumentException":{ 2057 "type":"structure", 2058 "members":{ 2059 "Message":{"shape":"ErrorMessageType"} 2060 }, 2061 "error":{"httpStatusCode":400}, 2062 "exception":true 2063 }, 2064 "InvalidOperationException":{ 2065 "type":"structure", 2066 "members":{ 2067 "Message":{"shape":"ErrorMessageType"} 2068 }, 2069 "error":{"httpStatusCode":405}, 2070 "exception":true 2071 }, 2072 "Label":{ 2073 "type":"string", 2074 "max":32, 2075 "min":1, 2076 "pattern":"[a-zA-Z0-9._+-/=][a-zA-Z0-9 ._+-/=]*" 2077 }, 2078 "Labels":{ 2079 "type":"list", 2080 "member":{"shape":"Label"}, 2081 "max":20 2082 }, 2083 "LimitExceededException":{ 2084 "type":"structure", 2085 "members":{ 2086 "Message":{"shape":"ErrorMessageType"} 2087 }, 2088 "error":{"httpStatusCode":409}, 2089 "exception":true 2090 }, 2091 "LimitType":{ 2092 "type":"integer", 2093 "max":999, 2094 "min":1 2095 }, 2096 "LocaleType":{ 2097 "type":"string", 2098 "enum":[ 2099 "en", 2100 "fr", 2101 "ko", 2102 "de", 2103 "es", 2104 "ja", 2105 "ru", 2106 "zh_CN", 2107 "zh_TW", 2108 "pt_BR", 2109 "default" 2110 ] 2111 }, 2112 "MarkerType":{ 2113 "type":"string", 2114 "max":2048, 2115 "min":1, 2116 "pattern":"[\\u0000-\\u00FF]+" 2117 }, 2118 "MessageType":{ 2119 "type":"string", 2120 "max":2048, 2121 "min":0, 2122 "sensitive":true 2123 }, 2124 "OrderType":{ 2125 "type":"string", 2126 "enum":[ 2127 "ASCENDING", 2128 "DESCENDING" 2129 ] 2130 }, 2131 "OrganizationUserList":{ 2132 "type":"list", 2133 "member":{"shape":"User"} 2134 }, 2135 "PageMarkerType":{ 2136 "type":"string", 2137 "max":2048, 2138 "min":1 2139 }, 2140 "Participants":{ 2141 "type":"structure", 2142 "members":{ 2143 "Users":{"shape":"UserMetadataList"}, 2144 "Groups":{"shape":"GroupMetadataList"} 2145 } 2146 }, 2147 "PasswordType":{ 2148 "type":"string", 2149 "max":32, 2150 "min":4, 2151 "pattern":"[\\u0020-\\u00FF]+", 2152 "sensitive":true 2153 }, 2154 "PermissionInfo":{ 2155 "type":"structure", 2156 "members":{ 2157 "Role":{"shape":"RoleType"}, 2158 "Type":{"shape":"RolePermissionType"} 2159 } 2160 }, 2161 "PermissionInfoList":{ 2162 "type":"list", 2163 "member":{"shape":"PermissionInfo"} 2164 }, 2165 "PositiveSizeType":{ 2166 "type":"long", 2167 "min":0 2168 }, 2169 "Principal":{ 2170 "type":"structure", 2171 "members":{ 2172 "Id":{"shape":"IdType"}, 2173 "Type":{"shape":"PrincipalType"}, 2174 "Roles":{"shape":"PermissionInfoList"} 2175 } 2176 }, 2177 "PrincipalList":{ 2178 "type":"list", 2179 "member":{"shape":"Principal"} 2180 }, 2181 "PrincipalType":{ 2182 "type":"string", 2183 "enum":[ 2184 "USER", 2185 "GROUP", 2186 "INVITE", 2187 "ANONYMOUS", 2188 "ORGANIZATION" 2189 ] 2190 }, 2191 "ProhibitedStateException":{ 2192 "type":"structure", 2193 "members":{ 2194 "Message":{"shape":"ErrorMessageType"} 2195 }, 2196 "error":{"httpStatusCode":409}, 2197 "exception":true 2198 }, 2199 "RemoveAllResourcePermissionsRequest":{ 2200 "type":"structure", 2201 "required":["ResourceId"], 2202 "members":{ 2203 "AuthenticationToken":{ 2204 "shape":"AuthenticationHeaderType", 2205 "location":"header", 2206 "locationName":"Authentication" 2207 }, 2208 "ResourceId":{ 2209 "shape":"ResourceIdType", 2210 "location":"uri", 2211 "locationName":"ResourceId" 2212 } 2213 } 2214 }, 2215 "RemoveResourcePermissionRequest":{ 2216 "type":"structure", 2217 "required":[ 2218 "ResourceId", 2219 "PrincipalId" 2220 ], 2221 "members":{ 2222 "AuthenticationToken":{ 2223 "shape":"AuthenticationHeaderType", 2224 "location":"header", 2225 "locationName":"Authentication" 2226 }, 2227 "ResourceId":{ 2228 "shape":"ResourceIdType", 2229 "location":"uri", 2230 "locationName":"ResourceId" 2231 }, 2232 "PrincipalId":{ 2233 "shape":"IdType", 2234 "location":"uri", 2235 "locationName":"PrincipalId" 2236 }, 2237 "PrincipalType":{ 2238 "shape":"PrincipalType", 2239 "location":"querystring", 2240 "locationName":"type" 2241 } 2242 } 2243 }, 2244 "ResourceAlreadyCheckedOutException":{ 2245 "type":"structure", 2246 "members":{ 2247 "Message":{"shape":"ErrorMessageType"} 2248 }, 2249 "error":{"httpStatusCode":409}, 2250 "exception":true 2251 }, 2252 "ResourceIdType":{ 2253 "type":"string", 2254 "max":128, 2255 "min":1, 2256 "pattern":"[\\w+-.@]+" 2257 }, 2258 "ResourceMetadata":{ 2259 "type":"structure", 2260 "members":{ 2261 "Type":{"shape":"ResourceType"}, 2262 "Name":{"shape":"ResourceNameType"}, 2263 "OriginalName":{"shape":"ResourceNameType"}, 2264 "Id":{"shape":"ResourceIdType"}, 2265 "VersionId":{"shape":"DocumentVersionIdType"}, 2266 "Owner":{"shape":"UserMetadata"}, 2267 "ParentId":{"shape":"ResourceIdType"} 2268 } 2269 }, 2270 "ResourceNameType":{ 2271 "type":"string", 2272 "max":255, 2273 "min":1, 2274 "pattern":"[\\u0020-\\u202D\\u202F-\\uFFFF]+" 2275 }, 2276 "ResourcePath":{ 2277 "type":"structure", 2278 "members":{ 2279 "Components":{"shape":"ResourcePathComponentList"} 2280 } 2281 }, 2282 "ResourcePathComponent":{ 2283 "type":"structure", 2284 "members":{ 2285 "Id":{"shape":"IdType"}, 2286 "Name":{"shape":"ResourceNameType"} 2287 } 2288 }, 2289 "ResourcePathComponentList":{ 2290 "type":"list", 2291 "member":{"shape":"ResourcePathComponent"} 2292 }, 2293 "ResourceSortType":{ 2294 "type":"string", 2295 "enum":[ 2296 "DATE", 2297 "NAME" 2298 ] 2299 }, 2300 "ResourceStateType":{ 2301 "type":"string", 2302 "enum":[ 2303 "ACTIVE", 2304 "RESTORING", 2305 "RECYCLING", 2306 "RECYCLED" 2307 ] 2308 }, 2309 "ResourceType":{ 2310 "type":"string", 2311 "enum":[ 2312 "FOLDER", 2313 "DOCUMENT" 2314 ] 2315 }, 2316 "RolePermissionType":{ 2317 "type":"string", 2318 "enum":[ 2319 "DIRECT", 2320 "INHERITED" 2321 ] 2322 }, 2323 "RoleType":{ 2324 "type":"string", 2325 "enum":[ 2326 "VIEWER", 2327 "CONTRIBUTOR", 2328 "OWNER", 2329 "COOWNER" 2330 ] 2331 }, 2332 "SearchQueryType":{ 2333 "type":"string", 2334 "max":512, 2335 "min":1, 2336 "pattern":"[\\u0020-\\uFFFF]+", 2337 "sensitive":true 2338 }, 2339 "ServiceUnavailableException":{ 2340 "type":"structure", 2341 "members":{ 2342 "Message":{"shape":"ErrorMessageType"} 2343 }, 2344 "error":{"httpStatusCode":503}, 2345 "exception":true, 2346 "fault":true 2347 }, 2348 "SharePrincipal":{ 2349 "type":"structure", 2350 "required":[ 2351 "Id", 2352 "Type", 2353 "Role" 2354 ], 2355 "members":{ 2356 "Id":{"shape":"IdType"}, 2357 "Type":{"shape":"PrincipalType"}, 2358 "Role":{"shape":"RoleType"} 2359 } 2360 }, 2361 "SharePrincipalList":{ 2362 "type":"list", 2363 "member":{"shape":"SharePrincipal"} 2364 }, 2365 "ShareResult":{ 2366 "type":"structure", 2367 "members":{ 2368 "PrincipalId":{"shape":"IdType"}, 2369 "Role":{"shape":"RoleType"}, 2370 "Status":{"shape":"ShareStatusType"}, 2371 "ShareId":{"shape":"ResourceIdType"}, 2372 "StatusMessage":{"shape":"MessageType"} 2373 } 2374 }, 2375 "ShareResultsList":{ 2376 "type":"list", 2377 "member":{"shape":"ShareResult"} 2378 }, 2379 "ShareStatusType":{ 2380 "type":"string", 2381 "enum":[ 2382 "SUCCESS", 2383 "FAILURE" 2384 ] 2385 }, 2386 "SignedHeaderMap":{ 2387 "type":"map", 2388 "key":{"shape":"HeaderNameType"}, 2389 "value":{"shape":"HeaderValueType"} 2390 }, 2391 "SizeType":{"type":"long"}, 2392 "StorageLimitExceededException":{ 2393 "type":"structure", 2394 "members":{ 2395 "Message":{"shape":"ErrorMessageType"} 2396 }, 2397 "error":{"httpStatusCode":409}, 2398 "exception":true 2399 }, 2400 "StorageLimitWillExceedException":{ 2401 "type":"structure", 2402 "members":{ 2403 "Message":{"shape":"ErrorMessageType"} 2404 }, 2405 "error":{"httpStatusCode":413}, 2406 "exception":true 2407 }, 2408 "StorageRuleType":{ 2409 "type":"structure", 2410 "members":{ 2411 "StorageAllocatedInBytes":{"shape":"PositiveSizeType"}, 2412 "StorageType":{"shape":"StorageType"} 2413 } 2414 }, 2415 "StorageType":{ 2416 "type":"string", 2417 "enum":[ 2418 "UNLIMITED", 2419 "QUOTA" 2420 ] 2421 }, 2422 "Subscription":{ 2423 "type":"structure", 2424 "members":{ 2425 "SubscriptionId":{"shape":"IdType"}, 2426 "EndPoint":{"shape":"SubscriptionEndPointType"}, 2427 "Protocol":{"shape":"SubscriptionProtocolType"} 2428 } 2429 }, 2430 "SubscriptionEndPointType":{ 2431 "type":"string", 2432 "max":256, 2433 "min":1 2434 }, 2435 "SubscriptionList":{ 2436 "type":"list", 2437 "member":{"shape":"Subscription"}, 2438 "max":256 2439 }, 2440 "SubscriptionProtocolType":{ 2441 "type":"string", 2442 "enum":["HTTPS"] 2443 }, 2444 "SubscriptionType":{ 2445 "type":"string", 2446 "enum":["ALL"] 2447 }, 2448 "TimeZoneIdType":{ 2449 "type":"string", 2450 "max":256, 2451 "min":1 2452 }, 2453 "TimestampType":{"type":"timestamp"}, 2454 "TooManyLabelsException":{ 2455 "type":"structure", 2456 "members":{ 2457 "Message":{"shape":"ErrorMessageType"} 2458 }, 2459 "error":{"httpStatusCode":429}, 2460 "exception":true 2461 }, 2462 "TooManySubscriptionsException":{ 2463 "type":"structure", 2464 "members":{ 2465 "Message":{"shape":"ErrorMessageType"} 2466 }, 2467 "error":{"httpStatusCode":429}, 2468 "exception":true 2469 }, 2470 "UnauthorizedOperationException":{ 2471 "type":"structure", 2472 "members":{ 2473 }, 2474 "error":{"httpStatusCode":403}, 2475 "exception":true 2476 }, 2477 "UnauthorizedResourceAccessException":{ 2478 "type":"structure", 2479 "members":{ 2480 "Message":{"shape":"ErrorMessageType"} 2481 }, 2482 "error":{"httpStatusCode":404}, 2483 "exception":true 2484 }, 2485 "UpdateDocumentRequest":{ 2486 "type":"structure", 2487 "required":["DocumentId"], 2488 "members":{ 2489 "AuthenticationToken":{ 2490 "shape":"AuthenticationHeaderType", 2491 "location":"header", 2492 "locationName":"Authentication" 2493 }, 2494 "DocumentId":{ 2495 "shape":"ResourceIdType", 2496 "location":"uri", 2497 "locationName":"DocumentId" 2498 }, 2499 "Name":{"shape":"ResourceNameType"}, 2500 "ParentFolderId":{"shape":"ResourceIdType"}, 2501 "ResourceState":{"shape":"ResourceStateType"} 2502 } 2503 }, 2504 "UpdateDocumentVersionRequest":{ 2505 "type":"structure", 2506 "required":[ 2507 "DocumentId", 2508 "VersionId" 2509 ], 2510 "members":{ 2511 "AuthenticationToken":{ 2512 "shape":"AuthenticationHeaderType", 2513 "location":"header", 2514 "locationName":"Authentication" 2515 }, 2516 "DocumentId":{ 2517 "shape":"ResourceIdType", 2518 "location":"uri", 2519 "locationName":"DocumentId" 2520 }, 2521 "VersionId":{ 2522 "shape":"DocumentVersionIdType", 2523 "location":"uri", 2524 "locationName":"VersionId" 2525 }, 2526 "VersionStatus":{"shape":"DocumentVersionStatus"} 2527 } 2528 }, 2529 "UpdateFolderRequest":{ 2530 "type":"structure", 2531 "required":["FolderId"], 2532 "members":{ 2533 "AuthenticationToken":{ 2534 "shape":"AuthenticationHeaderType", 2535 "location":"header", 2536 "locationName":"Authentication" 2537 }, 2538 "FolderId":{ 2539 "shape":"ResourceIdType", 2540 "location":"uri", 2541 "locationName":"FolderId" 2542 }, 2543 "Name":{"shape":"ResourceNameType"}, 2544 "ParentFolderId":{"shape":"ResourceIdType"}, 2545 "ResourceState":{"shape":"ResourceStateType"} 2546 } 2547 }, 2548 "UpdateUserRequest":{ 2549 "type":"structure", 2550 "required":["UserId"], 2551 "members":{ 2552 "AuthenticationToken":{ 2553 "shape":"AuthenticationHeaderType", 2554 "location":"header", 2555 "locationName":"Authentication" 2556 }, 2557 "UserId":{ 2558 "shape":"IdType", 2559 "location":"uri", 2560 "locationName":"UserId" 2561 }, 2562 "GivenName":{"shape":"UserAttributeValueType"}, 2563 "Surname":{"shape":"UserAttributeValueType"}, 2564 "Type":{"shape":"UserType"}, 2565 "StorageRule":{"shape":"StorageRuleType"}, 2566 "TimeZoneId":{"shape":"TimeZoneIdType"}, 2567 "Locale":{"shape":"LocaleType"} 2568 } 2569 }, 2570 "UpdateUserResponse":{ 2571 "type":"structure", 2572 "members":{ 2573 "User":{"shape":"User"} 2574 } 2575 }, 2576 "UploadMetadata":{ 2577 "type":"structure", 2578 "members":{ 2579 "UploadUrl":{"shape":"UrlType"}, 2580 "SignedHeaders":{"shape":"SignedHeaderMap"} 2581 } 2582 }, 2583 "UrlType":{ 2584 "type":"string", 2585 "max":1024, 2586 "min":1, 2587 "sensitive":true 2588 }, 2589 "User":{ 2590 "type":"structure", 2591 "members":{ 2592 "Id":{"shape":"IdType"}, 2593 "Username":{"shape":"UsernameType"}, 2594 "EmailAddress":{"shape":"EmailAddressType"}, 2595 "GivenName":{"shape":"UserAttributeValueType"}, 2596 "Surname":{"shape":"UserAttributeValueType"}, 2597 "OrganizationId":{"shape":"IdType"}, 2598 "RootFolderId":{"shape":"ResourceIdType"}, 2599 "RecycleBinFolderId":{"shape":"ResourceIdType"}, 2600 "Status":{"shape":"UserStatusType"}, 2601 "Type":{"shape":"UserType"}, 2602 "CreatedTimestamp":{"shape":"TimestampType"}, 2603 "ModifiedTimestamp":{"shape":"TimestampType"}, 2604 "TimeZoneId":{"shape":"TimeZoneIdType"}, 2605 "Locale":{"shape":"LocaleType"}, 2606 "Storage":{"shape":"UserStorageMetadata"} 2607 } 2608 }, 2609 "UserActivities":{ 2610 "type":"list", 2611 "member":{"shape":"Activity"} 2612 }, 2613 "UserAttributeValueType":{ 2614 "type":"string", 2615 "max":64, 2616 "min":1 2617 }, 2618 "UserFilterType":{ 2619 "type":"string", 2620 "enum":[ 2621 "ALL", 2622 "ACTIVE_PENDING" 2623 ] 2624 }, 2625 "UserIdsType":{ 2626 "type":"string", 2627 "max":2000, 2628 "min":1, 2629 "pattern":"[&\\w+-.@, ]+" 2630 }, 2631 "UserMetadata":{ 2632 "type":"structure", 2633 "members":{ 2634 "Id":{"shape":"IdType"}, 2635 "Username":{"shape":"UsernameType"}, 2636 "GivenName":{"shape":"UserAttributeValueType"}, 2637 "Surname":{"shape":"UserAttributeValueType"}, 2638 "EmailAddress":{"shape":"EmailAddressType"} 2639 } 2640 }, 2641 "UserMetadataList":{ 2642 "type":"list", 2643 "member":{"shape":"UserMetadata"} 2644 }, 2645 "UserSortType":{ 2646 "type":"string", 2647 "enum":[ 2648 "USER_NAME", 2649 "FULL_NAME", 2650 "STORAGE_LIMIT", 2651 "USER_STATUS", 2652 "STORAGE_USED" 2653 ] 2654 }, 2655 "UserStatusType":{ 2656 "type":"string", 2657 "enum":[ 2658 "ACTIVE", 2659 "INACTIVE", 2660 "PENDING" 2661 ] 2662 }, 2663 "UserStorageMetadata":{ 2664 "type":"structure", 2665 "members":{ 2666 "StorageUtilizedInBytes":{"shape":"SizeType"}, 2667 "StorageRule":{"shape":"StorageRuleType"} 2668 } 2669 }, 2670 "UserType":{ 2671 "type":"string", 2672 "enum":[ 2673 "USER", 2674 "ADMIN" 2675 ] 2676 }, 2677 "UsernameType":{ 2678 "type":"string", 2679 "max":256, 2680 "min":1, 2681 "pattern":"[\\w\\-+.]+(@[a-zA-Z0-9.\\-]+\\.[a-zA-Z]+)?" 2682 } 2683 } 2684} 2685