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