1{ 2 "metadata": { 3 "apiVersion": "2020-08-11", 4 "endpointPrefix": "amplifybackend", 5 "signingName": "amplifybackend", 6 "serviceFullName": "AmplifyBackend", 7 "serviceId": "AmplifyBackend", 8 "protocol": "rest-json", 9 "jsonVersion": "1.1", 10 "uid": "amplifybackend-2020-08-11", 11 "signatureVersion": "v4" 12 }, 13 "operations": { 14 "CloneBackend": { 15 "name": "CloneBackend", 16 "http": { 17 "method": "POST", 18 "requestUri": "/backend/{appId}/environments/{backendEnvironmentName}/clone", 19 "responseCode": 200 20 }, 21 "input": { 22 "shape": "CloneBackendRequest" 23 }, 24 "output": { 25 "shape": "CloneBackendResponse", 26 "documentation": "<p>200 response</p>" 27 }, 28 "errors": [ 29 { 30 "shape": "NotFoundException", 31 "documentation": "<p>404 response</p>" 32 }, 33 { 34 "shape": "GatewayTimeoutException", 35 "documentation": "<p>504 response</p>" 36 }, 37 { 38 "shape": "TooManyRequestsException", 39 "documentation": "<p>429 response</p>" 40 }, 41 { 42 "shape": "BadRequestException", 43 "documentation": "<p>400 response</p>" 44 } 45 ], 46 "documentation": "<p>This operation clones an existing backend.</p>" 47 }, 48 "CreateBackend": { 49 "name": "CreateBackend", 50 "http": { 51 "method": "POST", 52 "requestUri": "/backend", 53 "responseCode": 200 54 }, 55 "input": { 56 "shape": "CreateBackendRequest" 57 }, 58 "output": { 59 "shape": "CreateBackendResponse", 60 "documentation": "<p>200 response</p>" 61 }, 62 "errors": [ 63 { 64 "shape": "NotFoundException", 65 "documentation": "<p>404 response</p>" 66 }, 67 { 68 "shape": "GatewayTimeoutException", 69 "documentation": "<p>504 response</p>" 70 }, 71 { 72 "shape": "TooManyRequestsException", 73 "documentation": "<p>429 response</p>" 74 }, 75 { 76 "shape": "BadRequestException", 77 "documentation": "<p>400 response</p>" 78 } 79 ], 80 "documentation": "<p>This operation creates a backend for an Amplify app. Backends are automatically created at the time of app creation.</p>" 81 }, 82 "CreateBackendAPI": { 83 "name": "CreateBackendAPI", 84 "http": { 85 "method": "POST", 86 "requestUri": "/backend/{appId}/api", 87 "responseCode": 200 88 }, 89 "input": { 90 "shape": "CreateBackendAPIRequest" 91 }, 92 "output": { 93 "shape": "CreateBackendAPIResponse", 94 "documentation": "<p>200 response</p>" 95 }, 96 "errors": [ 97 { 98 "shape": "NotFoundException", 99 "documentation": "<p>404 response</p>" 100 }, 101 { 102 "shape": "GatewayTimeoutException", 103 "documentation": "<p>504 response</p>" 104 }, 105 { 106 "shape": "TooManyRequestsException", 107 "documentation": "<p>429 response</p>" 108 }, 109 { 110 "shape": "BadRequestException", 111 "documentation": "<p>400 response</p>" 112 } 113 ], 114 "documentation": "<p>Creates a new backend API resource.</p>" 115 }, 116 "CreateBackendAuth": { 117 "name": "CreateBackendAuth", 118 "http": { 119 "method": "POST", 120 "requestUri": "/backend/{appId}/auth", 121 "responseCode": 200 122 }, 123 "input": { 124 "shape": "CreateBackendAuthRequest" 125 }, 126 "output": { 127 "shape": "CreateBackendAuthResponse", 128 "documentation": "<p>200 response</p>" 129 }, 130 "errors": [ 131 { 132 "shape": "NotFoundException", 133 "documentation": "<p>404 response</p>" 134 }, 135 { 136 "shape": "GatewayTimeoutException", 137 "documentation": "<p>504 response</p>" 138 }, 139 { 140 "shape": "TooManyRequestsException", 141 "documentation": "<p>429 response</p>" 142 }, 143 { 144 "shape": "BadRequestException", 145 "documentation": "<p>400 response</p>" 146 } 147 ], 148 "documentation": "<p>Creates a new backend authentication resource.</p>" 149 }, 150 "CreateBackendConfig": { 151 "name": "CreateBackendConfig", 152 "http": { 153 "method": "POST", 154 "requestUri": "/backend/{appId}/config", 155 "responseCode": 200 156 }, 157 "input": { 158 "shape": "CreateBackendConfigRequest" 159 }, 160 "output": { 161 "shape": "CreateBackendConfigResponse", 162 "documentation": "<p>200 response</p>" 163 }, 164 "errors": [ 165 { 166 "shape": "NotFoundException", 167 "documentation": "<p>404 response</p>" 168 }, 169 { 170 "shape": "GatewayTimeoutException", 171 "documentation": "<p>504 response</p>" 172 }, 173 { 174 "shape": "TooManyRequestsException", 175 "documentation": "<p>429 response</p>" 176 }, 177 { 178 "shape": "BadRequestException", 179 "documentation": "<p>400 response</p>" 180 } 181 ], 182 "documentation": "<p>Creates a config object for a backend.</p>" 183 }, 184 "CreateBackendStorage": { 185 "name": "CreateBackendStorage", 186 "http": { 187 "method": "POST", 188 "requestUri": "/backend/{appId}/storage", 189 "responseCode": 200 190 }, 191 "input": { 192 "shape": "CreateBackendStorageRequest" 193 }, 194 "output": { 195 "shape": "CreateBackendStorageResponse", 196 "documentation": "<p>200 response</p>" 197 }, 198 "errors": [ 199 { 200 "shape": "NotFoundException", 201 "documentation": "<p>404 response</p>" 202 }, 203 { 204 "shape": "GatewayTimeoutException", 205 "documentation": "<p>504 response</p>" 206 }, 207 { 208 "shape": "TooManyRequestsException", 209 "documentation": "<p>429 response</p>" 210 }, 211 { 212 "shape": "BadRequestException", 213 "documentation": "<p>400 response</p>" 214 } 215 ], 216 "documentation": "<p>Creates a backend storage resource.</p>" 217 }, 218 "CreateToken": { 219 "name": "CreateToken", 220 "http": { 221 "method": "POST", 222 "requestUri": "/backend/{appId}/challenge", 223 "responseCode": 200 224 }, 225 "input": { 226 "shape": "CreateTokenRequest" 227 }, 228 "output": { 229 "shape": "CreateTokenResponse", 230 "documentation": "<p>200 response</p>" 231 }, 232 "errors": [ 233 { 234 "shape": "NotFoundException", 235 "documentation": "<p>404 response</p>" 236 }, 237 { 238 "shape": "GatewayTimeoutException", 239 "documentation": "<p>504 response</p>" 240 }, 241 { 242 "shape": "TooManyRequestsException", 243 "documentation": "<p>429 response</p>" 244 }, 245 { 246 "shape": "BadRequestException", 247 "documentation": "<p>400 response</p>" 248 } 249 ], 250 "documentation": "<p>Generates a one-time challenge code to authenticate a user into your Amplify Admin UI.</p>" 251 }, 252 "DeleteBackend": { 253 "name": "DeleteBackend", 254 "http": { 255 "method": "POST", 256 "requestUri": "/backend/{appId}/environments/{backendEnvironmentName}/remove", 257 "responseCode": 200 258 }, 259 "input": { 260 "shape": "DeleteBackendRequest" 261 }, 262 "output": { 263 "shape": "DeleteBackendResponse", 264 "documentation": "<p>200 response</p>" 265 }, 266 "errors": [ 267 { 268 "shape": "NotFoundException", 269 "documentation": "<p>404 response</p>" 270 }, 271 { 272 "shape": "GatewayTimeoutException", 273 "documentation": "<p>504 response</p>" 274 }, 275 { 276 "shape": "TooManyRequestsException", 277 "documentation": "<p>429 response</p>" 278 }, 279 { 280 "shape": "BadRequestException", 281 "documentation": "<p>400 response</p>" 282 } 283 ], 284 "documentation": "<p>Removes an existing environment from your Amplify project.</p>" 285 }, 286 "DeleteBackendAPI": { 287 "name": "DeleteBackendAPI", 288 "http": { 289 "method": "POST", 290 "requestUri": "/backend/{appId}/api/{backendEnvironmentName}/remove", 291 "responseCode": 200 292 }, 293 "input": { 294 "shape": "DeleteBackendAPIRequest" 295 }, 296 "output": { 297 "shape": "DeleteBackendAPIResponse", 298 "documentation": "<p>200 response</p>" 299 }, 300 "errors": [ 301 { 302 "shape": "NotFoundException", 303 "documentation": "<p>404 response</p>" 304 }, 305 { 306 "shape": "GatewayTimeoutException", 307 "documentation": "<p>504 response</p>" 308 }, 309 { 310 "shape": "TooManyRequestsException", 311 "documentation": "<p>429 response</p>" 312 }, 313 { 314 "shape": "BadRequestException", 315 "documentation": "<p>400 response</p>" 316 } 317 ], 318 "documentation": "<p>Deletes an existing backend API resource.</p>" 319 }, 320 "DeleteBackendAuth": { 321 "name": "DeleteBackendAuth", 322 "http": { 323 "method": "POST", 324 "requestUri": "/backend/{appId}/auth/{backendEnvironmentName}/remove", 325 "responseCode": 200 326 }, 327 "input": { 328 "shape": "DeleteBackendAuthRequest" 329 }, 330 "output": { 331 "shape": "DeleteBackendAuthResponse", 332 "documentation": "<p>200 response</p>" 333 }, 334 "errors": [ 335 { 336 "shape": "NotFoundException", 337 "documentation": "<p>404 response</p>" 338 }, 339 { 340 "shape": "GatewayTimeoutException", 341 "documentation": "<p>504 response</p>" 342 }, 343 { 344 "shape": "TooManyRequestsException", 345 "documentation": "<p>429 response</p>" 346 }, 347 { 348 "shape": "BadRequestException", 349 "documentation": "<p>400 response</p>" 350 } 351 ], 352 "documentation": "<p>Deletes an existing backend authentication resource.</p>" 353 }, 354 "DeleteBackendStorage": { 355 "name": "DeleteBackendStorage", 356 "http": { 357 "method": "POST", 358 "requestUri": "/backend/{appId}/storage/{backendEnvironmentName}/remove", 359 "responseCode": 200 360 }, 361 "input": { 362 "shape": "DeleteBackendStorageRequest" 363 }, 364 "output": { 365 "shape": "DeleteBackendStorageResponse", 366 "documentation": "<p>200 response</p>" 367 }, 368 "errors": [ 369 { 370 "shape": "NotFoundException", 371 "documentation": "<p>404 response</p>" 372 }, 373 { 374 "shape": "GatewayTimeoutException", 375 "documentation": "<p>504 response</p>" 376 }, 377 { 378 "shape": "TooManyRequestsException", 379 "documentation": "<p>429 response</p>" 380 }, 381 { 382 "shape": "BadRequestException", 383 "documentation": "<p>400 response</p>" 384 } 385 ], 386 "documentation": "<p>Removes the specified backend storage resource.</p>" 387 }, 388 "DeleteToken": { 389 "name": "DeleteToken", 390 "http": { 391 "method": "POST", 392 "requestUri": "/backend/{appId}/challenge/{sessionId}/remove", 393 "responseCode": 200 394 }, 395 "input": { 396 "shape": "DeleteTokenRequest" 397 }, 398 "output": { 399 "shape": "DeleteTokenResponse", 400 "documentation": "<p>200 response</p>" 401 }, 402 "errors": [ 403 { 404 "shape": "NotFoundException", 405 "documentation": "<p>404 response</p>" 406 }, 407 { 408 "shape": "GatewayTimeoutException", 409 "documentation": "<p>504 response</p>" 410 }, 411 { 412 "shape": "TooManyRequestsException", 413 "documentation": "<p>429 response</p>" 414 }, 415 { 416 "shape": "BadRequestException", 417 "documentation": "<p>400 response</p>" 418 } 419 ], 420 "documentation": "<p>Deletes the challenge token based on the given appId and sessionId.</p>" 421 }, 422 "GenerateBackendAPIModels": { 423 "name": "GenerateBackendAPIModels", 424 "http": { 425 "method": "POST", 426 "requestUri": "/backend/{appId}/api/{backendEnvironmentName}/generateModels", 427 "responseCode": 200 428 }, 429 "input": { 430 "shape": "GenerateBackendAPIModelsRequest" 431 }, 432 "output": { 433 "shape": "GenerateBackendAPIModelsResponse", 434 "documentation": "<p>200 response</p>" 435 }, 436 "errors": [ 437 { 438 "shape": "NotFoundException", 439 "documentation": "<p>404 response</p>" 440 }, 441 { 442 "shape": "GatewayTimeoutException", 443 "documentation": "<p>504 response</p>" 444 }, 445 { 446 "shape": "TooManyRequestsException", 447 "documentation": "<p>429 response</p>" 448 }, 449 { 450 "shape": "BadRequestException", 451 "documentation": "<p>400 response</p>" 452 } 453 ], 454 "documentation": "<p>Generates a model schema for an existing backend API resource.</p>" 455 }, 456 "GetBackend": { 457 "name": "GetBackend", 458 "http": { 459 "method": "POST", 460 "requestUri": "/backend/{appId}/details", 461 "responseCode": 200 462 }, 463 "input": { 464 "shape": "GetBackendRequest" 465 }, 466 "output": { 467 "shape": "GetBackendResponse", 468 "documentation": "<p>200 response</p>" 469 }, 470 "errors": [ 471 { 472 "shape": "NotFoundException", 473 "documentation": "<p>404 response</p>" 474 }, 475 { 476 "shape": "GatewayTimeoutException", 477 "documentation": "<p>504 response</p>" 478 }, 479 { 480 "shape": "TooManyRequestsException", 481 "documentation": "<p>429 response</p>" 482 }, 483 { 484 "shape": "BadRequestException", 485 "documentation": "<p>400 response</p>" 486 } 487 ], 488 "documentation": "<p>Provides project-level details for your Amplify UI project.</p>" 489 }, 490 "GetBackendAPI": { 491 "name": "GetBackendAPI", 492 "http": { 493 "method": "POST", 494 "requestUri": "/backend/{appId}/api/{backendEnvironmentName}/details", 495 "responseCode": 200 496 }, 497 "input": { 498 "shape": "GetBackendAPIRequest" 499 }, 500 "output": { 501 "shape": "GetBackendAPIResponse", 502 "documentation": "<p>200 response</p>" 503 }, 504 "errors": [ 505 { 506 "shape": "NotFoundException", 507 "documentation": "<p>404 response</p>" 508 }, 509 { 510 "shape": "GatewayTimeoutException", 511 "documentation": "<p>504 response</p>" 512 }, 513 { 514 "shape": "TooManyRequestsException", 515 "documentation": "<p>429 response</p>" 516 }, 517 { 518 "shape": "BadRequestException", 519 "documentation": "<p>400 response</p>" 520 } 521 ], 522 "documentation": "<p>Gets the details for a backend API.</p>" 523 }, 524 "GetBackendAPIModels": { 525 "name": "GetBackendAPIModels", 526 "http": { 527 "method": "POST", 528 "requestUri": "/backend/{appId}/api/{backendEnvironmentName}/getModels", 529 "responseCode": 200 530 }, 531 "input": { 532 "shape": "GetBackendAPIModelsRequest" 533 }, 534 "output": { 535 "shape": "GetBackendAPIModelsResponse", 536 "documentation": "<p>200 response</p>" 537 }, 538 "errors": [ 539 { 540 "shape": "NotFoundException", 541 "documentation": "<p>404 response</p>" 542 }, 543 { 544 "shape": "GatewayTimeoutException", 545 "documentation": "<p>504 response</p>" 546 }, 547 { 548 "shape": "TooManyRequestsException", 549 "documentation": "<p>429 response</p>" 550 }, 551 { 552 "shape": "BadRequestException", 553 "documentation": "<p>400 response</p>" 554 } 555 ], 556 "documentation": "<p>Gets a model introspection schema for an existing backend API resource.</p>" 557 }, 558 "GetBackendAuth": { 559 "name": "GetBackendAuth", 560 "http": { 561 "method": "POST", 562 "requestUri": "/backend/{appId}/auth/{backendEnvironmentName}/details", 563 "responseCode": 200 564 }, 565 "input": { 566 "shape": "GetBackendAuthRequest" 567 }, 568 "output": { 569 "shape": "GetBackendAuthResponse", 570 "documentation": "<p>200 response</p>" 571 }, 572 "errors": [ 573 { 574 "shape": "NotFoundException", 575 "documentation": "<p>404 response</p>" 576 }, 577 { 578 "shape": "GatewayTimeoutException", 579 "documentation": "<p>504 response</p>" 580 }, 581 { 582 "shape": "TooManyRequestsException", 583 "documentation": "<p>429 response</p>" 584 }, 585 { 586 "shape": "BadRequestException", 587 "documentation": "<p>400 response</p>" 588 } 589 ], 590 "documentation": "<p>Gets a backend auth details.</p>" 591 }, 592 "GetBackendJob": { 593 "name": "GetBackendJob", 594 "http": { 595 "method": "GET", 596 "requestUri": "/backend/{appId}/job/{backendEnvironmentName}/{jobId}", 597 "responseCode": 200 598 }, 599 "input": { 600 "shape": "GetBackendJobRequest" 601 }, 602 "output": { 603 "shape": "GetBackendJobResponse", 604 "documentation": "<p>200 response</p>" 605 }, 606 "errors": [ 607 { 608 "shape": "NotFoundException", 609 "documentation": "<p>404 response</p>" 610 }, 611 { 612 "shape": "GatewayTimeoutException", 613 "documentation": "<p>504 response</p>" 614 }, 615 { 616 "shape": "TooManyRequestsException", 617 "documentation": "<p>429 response</p>" 618 }, 619 { 620 "shape": "BadRequestException", 621 "documentation": "<p>400 response</p>" 622 } 623 ], 624 "documentation": "<p>Returns information about a specific job.</p>" 625 }, 626 "GetBackendStorage": { 627 "name": "GetBackendStorage", 628 "http": { 629 "method": "POST", 630 "requestUri": "/backend/{appId}/storage/{backendEnvironmentName}/details", 631 "responseCode": 200 632 }, 633 "input": { 634 "shape": "GetBackendStorageRequest" 635 }, 636 "output": { 637 "shape": "GetBackendStorageResponse", 638 "documentation": "<p>200 response</p>" 639 }, 640 "errors": [ 641 { 642 "shape": "NotFoundException", 643 "documentation": "<p>404 response</p>" 644 }, 645 { 646 "shape": "GatewayTimeoutException", 647 "documentation": "<p>504 response</p>" 648 }, 649 { 650 "shape": "TooManyRequestsException", 651 "documentation": "<p>429 response</p>" 652 }, 653 { 654 "shape": "BadRequestException", 655 "documentation": "<p>400 response</p>" 656 } 657 ], 658 "documentation": "<p>Gets details for a backend storage resource.</p>" 659 }, 660 "GetToken": { 661 "name": "GetToken", 662 "http": { 663 "method": "GET", 664 "requestUri": "/backend/{appId}/challenge/{sessionId}", 665 "responseCode": 200 666 }, 667 "input": { 668 "shape": "GetTokenRequest" 669 }, 670 "output": { 671 "shape": "GetTokenResponse", 672 "documentation": "<p>200 response</p>" 673 }, 674 "errors": [ 675 { 676 "shape": "NotFoundException", 677 "documentation": "<p>404 response</p>" 678 }, 679 { 680 "shape": "GatewayTimeoutException", 681 "documentation": "<p>504 response</p>" 682 }, 683 { 684 "shape": "TooManyRequestsException", 685 "documentation": "<p>429 response</p>" 686 }, 687 { 688 "shape": "BadRequestException", 689 "documentation": "<p>400 response</p>" 690 } 691 ], 692 "documentation": "<p>Gets the challenge token based on the given appId and sessionId.</p>" 693 }, 694 "ImportBackendAuth": { 695 "name": "ImportBackendAuth", 696 "http": { 697 "method": "POST", 698 "requestUri": "/backend/{appId}/auth/{backendEnvironmentName}/import", 699 "responseCode": 200 700 }, 701 "input": { 702 "shape": "ImportBackendAuthRequest" 703 }, 704 "output": { 705 "shape": "ImportBackendAuthResponse", 706 "documentation": "<p>200 response</p>" 707 }, 708 "errors": [ 709 { 710 "shape": "NotFoundException", 711 "documentation": "<p>404 response</p>" 712 }, 713 { 714 "shape": "GatewayTimeoutException", 715 "documentation": "<p>504 response</p>" 716 }, 717 { 718 "shape": "TooManyRequestsException", 719 "documentation": "<p>429 response</p>" 720 }, 721 { 722 "shape": "BadRequestException", 723 "documentation": "<p>400 response</p>" 724 } 725 ], 726 "documentation": "<p>Imports an existing backend authentication resource.</p>" 727 }, 728 "ImportBackendStorage": { 729 "name": "ImportBackendStorage", 730 "http": { 731 "method": "POST", 732 "requestUri": "/backend/{appId}/storage/{backendEnvironmentName}/import", 733 "responseCode": 200 734 }, 735 "input": { 736 "shape": "ImportBackendStorageRequest" 737 }, 738 "output": { 739 "shape": "ImportBackendStorageResponse", 740 "documentation": "<p>200 response</p>" 741 }, 742 "errors": [ 743 { 744 "shape": "NotFoundException", 745 "documentation": "<p>404 response</p>" 746 }, 747 { 748 "shape": "GatewayTimeoutException", 749 "documentation": "<p>504 response</p>" 750 }, 751 { 752 "shape": "TooManyRequestsException", 753 "documentation": "<p>429 response</p>" 754 }, 755 { 756 "shape": "BadRequestException", 757 "documentation": "<p>400 response</p>" 758 } 759 ], 760 "documentation": "<p>Imports an existing backend storage resource.</p>" 761 }, 762 "ListBackendJobs": { 763 "name": "ListBackendJobs", 764 "http": { 765 "method": "POST", 766 "requestUri": "/backend/{appId}/job/{backendEnvironmentName}", 767 "responseCode": 200 768 }, 769 "input": { 770 "shape": "ListBackendJobsRequest" 771 }, 772 "output": { 773 "shape": "ListBackendJobsResponse", 774 "documentation": "<p>200 response</p>" 775 }, 776 "errors": [ 777 { 778 "shape": "NotFoundException", 779 "documentation": "<p>404 response</p>" 780 }, 781 { 782 "shape": "GatewayTimeoutException", 783 "documentation": "<p>504 response</p>" 784 }, 785 { 786 "shape": "TooManyRequestsException", 787 "documentation": "<p>429 response</p>" 788 }, 789 { 790 "shape": "BadRequestException", 791 "documentation": "<p>400 response</p>" 792 } 793 ], 794 "documentation": "<p>Lists the jobs for the backend of an Amplify app.</p>" 795 }, 796 "ListS3Buckets": { 797 "name": "ListS3Buckets", 798 "http": { 799 "method": "POST", 800 "requestUri": "/s3Buckets", 801 "responseCode": 200 802 }, 803 "input": { 804 "shape": "ListS3BucketsRequest" 805 }, 806 "output": { 807 "shape": "ListS3BucketsResponse", 808 "documentation": "<p>200 response</p>" 809 }, 810 "errors": [ 811 { 812 "shape": "NotFoundException", 813 "documentation": "<p>404 response</p>" 814 }, 815 { 816 "shape": "GatewayTimeoutException", 817 "documentation": "<p>504 response</p>" 818 }, 819 { 820 "shape": "TooManyRequestsException", 821 "documentation": "<p>429 response</p>" 822 }, 823 { 824 "shape": "BadRequestException", 825 "documentation": "<p>400 response</p>" 826 } 827 ], 828 "documentation": "<p>The list of S3 buckets in your account.</p>" 829 }, 830 "RemoveAllBackends": { 831 "name": "RemoveAllBackends", 832 "http": { 833 "method": "POST", 834 "requestUri": "/backend/{appId}/remove", 835 "responseCode": 200 836 }, 837 "input": { 838 "shape": "RemoveAllBackendsRequest" 839 }, 840 "output": { 841 "shape": "RemoveAllBackendsResponse", 842 "documentation": "<p>200 response</p>" 843 }, 844 "errors": [ 845 { 846 "shape": "NotFoundException", 847 "documentation": "<p>404 response</p>" 848 }, 849 { 850 "shape": "GatewayTimeoutException", 851 "documentation": "<p>504 response</p>" 852 }, 853 { 854 "shape": "TooManyRequestsException", 855 "documentation": "<p>429 response</p>" 856 }, 857 { 858 "shape": "BadRequestException", 859 "documentation": "<p>400 response</p>" 860 } 861 ], 862 "documentation": "<p>Removes all backend environments from your Amplify project.</p>" 863 }, 864 "RemoveBackendConfig": { 865 "name": "RemoveBackendConfig", 866 "http": { 867 "method": "POST", 868 "requestUri": "/backend/{appId}/config/remove", 869 "responseCode": 200 870 }, 871 "input": { 872 "shape": "RemoveBackendConfigRequest" 873 }, 874 "output": { 875 "shape": "RemoveBackendConfigResponse", 876 "documentation": "<p>200 response</p>" 877 }, 878 "errors": [ 879 { 880 "shape": "NotFoundException", 881 "documentation": "<p>404 response</p>" 882 }, 883 { 884 "shape": "GatewayTimeoutException", 885 "documentation": "<p>504 response</p>" 886 }, 887 { 888 "shape": "TooManyRequestsException", 889 "documentation": "<p>429 response</p>" 890 }, 891 { 892 "shape": "BadRequestException", 893 "documentation": "<p>400 response</p>" 894 } 895 ], 896 "documentation": "<p>Removes the AWS resources required to access the Amplify Admin UI.</p>" 897 }, 898 "UpdateBackendAPI": { 899 "name": "UpdateBackendAPI", 900 "http": { 901 "method": "POST", 902 "requestUri": "/backend/{appId}/api/{backendEnvironmentName}", 903 "responseCode": 200 904 }, 905 "input": { 906 "shape": "UpdateBackendAPIRequest" 907 }, 908 "output": { 909 "shape": "UpdateBackendAPIResponse", 910 "documentation": "<p>200 response</p>" 911 }, 912 "errors": [ 913 { 914 "shape": "NotFoundException", 915 "documentation": "<p>404 response</p>" 916 }, 917 { 918 "shape": "GatewayTimeoutException", 919 "documentation": "<p>504 response</p>" 920 }, 921 { 922 "shape": "TooManyRequestsException", 923 "documentation": "<p>429 response</p>" 924 }, 925 { 926 "shape": "BadRequestException", 927 "documentation": "<p>400 response</p>" 928 } 929 ], 930 "documentation": "<p>Updates an existing backend API resource.</p>" 931 }, 932 "UpdateBackendAuth": { 933 "name": "UpdateBackendAuth", 934 "http": { 935 "method": "POST", 936 "requestUri": "/backend/{appId}/auth/{backendEnvironmentName}", 937 "responseCode": 200 938 }, 939 "input": { 940 "shape": "UpdateBackendAuthRequest" 941 }, 942 "output": { 943 "shape": "UpdateBackendAuthResponse", 944 "documentation": "<p>200 response</p>" 945 }, 946 "errors": [ 947 { 948 "shape": "NotFoundException", 949 "documentation": "<p>404 response</p>" 950 }, 951 { 952 "shape": "GatewayTimeoutException", 953 "documentation": "<p>504 response</p>" 954 }, 955 { 956 "shape": "TooManyRequestsException", 957 "documentation": "<p>429 response</p>" 958 }, 959 { 960 "shape": "BadRequestException", 961 "documentation": "<p>400 response</p>" 962 } 963 ], 964 "documentation": "<p>Updates an existing backend authentication resource.</p>" 965 }, 966 "UpdateBackendConfig": { 967 "name": "UpdateBackendConfig", 968 "http": { 969 "method": "POST", 970 "requestUri": "/backend/{appId}/config/update", 971 "responseCode": 200 972 }, 973 "input": { 974 "shape": "UpdateBackendConfigRequest" 975 }, 976 "output": { 977 "shape": "UpdateBackendConfigResponse", 978 "documentation": "<p>200 response</p>" 979 }, 980 "errors": [ 981 { 982 "shape": "NotFoundException", 983 "documentation": "<p>404 response</p>" 984 }, 985 { 986 "shape": "GatewayTimeoutException", 987 "documentation": "<p>504 response</p>" 988 }, 989 { 990 "shape": "TooManyRequestsException", 991 "documentation": "<p>429 response</p>" 992 }, 993 { 994 "shape": "BadRequestException", 995 "documentation": "<p>400 response</p>" 996 } 997 ], 998 "documentation": "<p>Updates the AWS resources required to access the Amplify Admin UI.</p>" 999 }, 1000 "UpdateBackendJob": { 1001 "name": "UpdateBackendJob", 1002 "http": { 1003 "method": "POST", 1004 "requestUri": "/backend/{appId}/job/{backendEnvironmentName}/{jobId}", 1005 "responseCode": 200 1006 }, 1007 "input": { 1008 "shape": "UpdateBackendJobRequest" 1009 }, 1010 "output": { 1011 "shape": "UpdateBackendJobResponse", 1012 "documentation": "<p>200 response</p>" 1013 }, 1014 "errors": [ 1015 { 1016 "shape": "NotFoundException", 1017 "documentation": "<p>404 response</p>" 1018 }, 1019 { 1020 "shape": "GatewayTimeoutException", 1021 "documentation": "<p>504 response</p>" 1022 }, 1023 { 1024 "shape": "TooManyRequestsException", 1025 "documentation": "<p>429 response</p>" 1026 }, 1027 { 1028 "shape": "BadRequestException", 1029 "documentation": "<p>400 response</p>" 1030 } 1031 ], 1032 "documentation": "<p>Updates a specific job.</p>" 1033 }, 1034 "UpdateBackendStorage": { 1035 "name": "UpdateBackendStorage", 1036 "http": { 1037 "method": "POST", 1038 "requestUri": "/backend/{appId}/storage/{backendEnvironmentName}", 1039 "responseCode": 200 1040 }, 1041 "input": { 1042 "shape": "UpdateBackendStorageRequest" 1043 }, 1044 "output": { 1045 "shape": "UpdateBackendStorageResponse", 1046 "documentation": "<p>200 response</p>" 1047 }, 1048 "errors": [ 1049 { 1050 "shape": "NotFoundException", 1051 "documentation": "<p>404 response</p>" 1052 }, 1053 { 1054 "shape": "GatewayTimeoutException", 1055 "documentation": "<p>504 response</p>" 1056 }, 1057 { 1058 "shape": "TooManyRequestsException", 1059 "documentation": "<p>429 response</p>" 1060 }, 1061 { 1062 "shape": "BadRequestException", 1063 "documentation": "<p>400 response</p>" 1064 } 1065 ], 1066 "documentation": "<p>Updates an existing backend storage resource.</p>" 1067 } 1068 }, 1069 "shapes": { 1070 "AuthResources": { 1071 "type": "string", 1072 "enum": [ 1073 "USER_POOL_ONLY", 1074 "IDENTITY_POOL_AND_USER_POOL" 1075 ] 1076 }, 1077 "BackendAPIAppSyncAuthSettings": { 1078 "type": "structure", 1079 "members": { 1080 "CognitoUserPoolId": { 1081 "shape": "__string", 1082 "locationName": "cognitoUserPoolId", 1083 "documentation": "<p>The Amazon Cognito user pool ID, if Amazon Cognito was used as an authentication setting to access your data models.</p>" 1084 }, 1085 "Description": { 1086 "shape": "__string", 1087 "locationName": "description", 1088 "documentation": "<p>The API key description for API_KEY, if it was used as an authentication mechanism to access your data models.</p>" 1089 }, 1090 "ExpirationTime": { 1091 "shape": "__double", 1092 "locationName": "expirationTime", 1093 "documentation": "<p>The API key expiration time for API_KEY, if it was used as an authentication mechanism to access your data models.</p>" 1094 }, 1095 "OpenIDAuthTTL": { 1096 "shape": "__string", 1097 "locationName": "openIDAuthTTL", 1098 "documentation": "<p>The expiry time for the OpenID authentication mechanism.</p>" 1099 }, 1100 "OpenIDClientId": { 1101 "shape": "__string", 1102 "locationName": "openIDClientId", 1103 "documentation": "<p>The clientID for openID, if openID was used as an authentication setting to access your data models.</p>" 1104 }, 1105 "OpenIDIatTTL": { 1106 "shape": "__string", 1107 "locationName": "openIDIatTTL", 1108 "documentation": "<p>The expiry time for the OpenID authentication mechanism.</p>" 1109 }, 1110 "OpenIDIssueURL": { 1111 "shape": "__string", 1112 "locationName": "openIDIssueURL", 1113 "documentation": "<p>The openID issuer URL, if openID was used as an authentication setting to access your data models.</p>" 1114 }, 1115 "OpenIDProviderName": { 1116 "shape": "__string", 1117 "locationName": "openIDProviderName", 1118 "documentation": "<p>The OpenID provider name, if OpenID was used as an authentication mechanism to access your data models.</p>" 1119 } 1120 }, 1121 "documentation": "<p>The authentication settings for accessing provisioned data models in your Amplify project.</p>" 1122 }, 1123 "BackendAPIAuthType": { 1124 "type": "structure", 1125 "members": { 1126 "Mode": { 1127 "shape": "Mode", 1128 "locationName": "mode", 1129 "documentation": "<p>Describes the authentication mode.</p>" 1130 }, 1131 "Settings": { 1132 "shape": "BackendAPIAppSyncAuthSettings", 1133 "locationName": "settings", 1134 "documentation": "<p>Describes settings for the authentication mode.</p>" 1135 } 1136 }, 1137 "documentation": "<p>Describes the auth types for your configured data models.</p>" 1138 }, 1139 "BackendAPICodegenReqObj": { 1140 "type": "structure", 1141 "members": { 1142 "ResourceName": { 1143 "shape": "__string", 1144 "locationName": "resourceName", 1145 "documentation": "<p>The name of this resource.</p>" 1146 } 1147 }, 1148 "documentation": "<p>The request object for this operation.</p>", 1149 "required": [ 1150 "ResourceName" 1151 ] 1152 }, 1153 "BackendAPICodegenRespObj": { 1154 "type": "structure", 1155 "members": { 1156 "AppId": { 1157 "shape": "__string", 1158 "locationName": "appId", 1159 "documentation": "<p>The app ID.</p>" 1160 }, 1161 "BackendEnvironmentName": { 1162 "shape": "__string", 1163 "locationName": "backendEnvironmentName", 1164 "documentation": "<p>The name of the backend environment.</p>" 1165 }, 1166 "Error": { 1167 "shape": "__string", 1168 "locationName": "error", 1169 "documentation": "<p>If the request fails, this error is returned.</p>" 1170 }, 1171 "JobId": { 1172 "shape": "__string", 1173 "locationName": "jobId", 1174 "documentation": "<p>The ID for the job.</p>" 1175 }, 1176 "Operation": { 1177 "shape": "__string", 1178 "locationName": "operation", 1179 "documentation": "<p>The name of the operation.</p>" 1180 }, 1181 "Status": { 1182 "shape": "__string", 1183 "locationName": "status", 1184 "documentation": "<p>The current status of the request.</p>" 1185 } 1186 }, 1187 "documentation": "<p>The response object sent when a backend is created.</p>", 1188 "required": [ 1189 "AppId", 1190 "BackendEnvironmentName" 1191 ] 1192 }, 1193 "BackendAPIConflictResolution": { 1194 "type": "structure", 1195 "members": { 1196 "ResolutionStrategy": { 1197 "shape": "ResolutionStrategy", 1198 "locationName": "resolutionStrategy", 1199 "documentation": "<p>The strategy for conflict resolution.</p>" 1200 } 1201 }, 1202 "documentation": "<p>Describes the conflict resolution configuration for your data model configured in your Amplify project.</p>" 1203 }, 1204 "BackendAPIReqObj": { 1205 "type": "structure", 1206 "members": { 1207 "ResourceConfig": { 1208 "shape": "BackendAPIResourceConfig", 1209 "locationName": "resourceConfig", 1210 "documentation": "<p>Defines the resource configuration for the data model in your Amplify project.</p>" 1211 }, 1212 "ResourceName": { 1213 "shape": "__string", 1214 "locationName": "resourceName", 1215 "documentation": "<p>The name of this resource.</p>" 1216 } 1217 }, 1218 "documentation": "<p>The request object for this operation.</p>", 1219 "required": [ 1220 "ResourceName" 1221 ] 1222 }, 1223 "BackendAPIResourceConfig": { 1224 "type": "structure", 1225 "members": { 1226 "AdditionalAuthTypes": { 1227 "shape": "ListOfBackendAPIAuthType", 1228 "locationName": "additionalAuthTypes", 1229 "documentation": "<p>Additional authentication methods used to interact with your data models.</p>" 1230 }, 1231 "ApiName": { 1232 "shape": "__string", 1233 "locationName": "apiName", 1234 "documentation": "<p>The API name used to interact with the data model, configured as a part of your Amplify project.</p>" 1235 }, 1236 "ConflictResolution": { 1237 "shape": "BackendAPIConflictResolution", 1238 "locationName": "conflictResolution", 1239 "documentation": "<p>The conflict resolution strategy for your data stored in the data models.</p>" 1240 }, 1241 "DefaultAuthType": { 1242 "shape": "BackendAPIAuthType", 1243 "locationName": "defaultAuthType", 1244 "documentation": "<p>The default authentication type for interacting with the configured data models in your Amplify project.</p>" 1245 }, 1246 "Service": { 1247 "shape": "__string", 1248 "locationName": "service", 1249 "documentation": "<p>The service used to provision and interact with the data model.</p>" 1250 }, 1251 "TransformSchema": { 1252 "shape": "__string", 1253 "locationName": "transformSchema", 1254 "documentation": "<p>The definition of the data model in the annotated transform of the GraphQL schema.</p>" 1255 } 1256 }, 1257 "documentation": "<p>The resource config for the data model, configured as a part of the Amplify project.</p>" 1258 }, 1259 "BackendAPIRespObj": { 1260 "type": "structure", 1261 "members": { 1262 "AppId": { 1263 "shape": "__string", 1264 "locationName": "appId", 1265 "documentation": "<p>The app ID.</p>" 1266 }, 1267 "BackendEnvironmentName": { 1268 "shape": "__string", 1269 "locationName": "backendEnvironmentName", 1270 "documentation": "<p>The name of the backend environment.</p>" 1271 }, 1272 "Error": { 1273 "shape": "__string", 1274 "locationName": "error", 1275 "documentation": "<p>If the request fails, this error is returned.</p>" 1276 }, 1277 "JobId": { 1278 "shape": "__string", 1279 "locationName": "jobId", 1280 "documentation": "<p>The ID for the job.</p>" 1281 }, 1282 "Operation": { 1283 "shape": "__string", 1284 "locationName": "operation", 1285 "documentation": "<p>The name of the operation.</p>" 1286 }, 1287 "Status": { 1288 "shape": "__string", 1289 "locationName": "status", 1290 "documentation": "<p>The current status of the request.</p>" 1291 } 1292 }, 1293 "documentation": "<p>The response object sent when a backend is created.</p>", 1294 "required": [ 1295 "AppId", 1296 "BackendEnvironmentName" 1297 ] 1298 }, 1299 "BackendAuthAppleProviderConfig": { 1300 "type": "structure", 1301 "sensitive": true, 1302 "members": { 1303 "ClientId": { 1304 "shape": "__string", 1305 "locationName": "client_id", 1306 "documentation": "<p>Describes the client_id (also called Services ID) that comes from Apple.</p>" 1307 }, 1308 "KeyId": { 1309 "shape": "__string", 1310 "locationName": "key_id", 1311 "documentation": "<p>Describes the key_id that comes from Apple.</p>" 1312 }, 1313 "PrivateKey": { 1314 "shape": "__string", 1315 "locationName": "private_key", 1316 "documentation": "<p>Describes the private_key that comes from Apple.</p>" 1317 }, 1318 "TeamId": { 1319 "shape": "__string", 1320 "locationName": "team_id", 1321 "documentation": "<p>Describes the team_id that comes from Apple.</p>" 1322 } 1323 }, 1324 "documentation": "<p>Describes Apple social federation configurations for allowing your app users to sign in using OAuth.</p>" 1325 }, 1326 "BackendAuthRespObj": { 1327 "type": "structure", 1328 "members": { 1329 "AppId": { 1330 "shape": "__string", 1331 "locationName": "appId", 1332 "documentation": "<p>The app ID.</p>" 1333 }, 1334 "BackendEnvironmentName": { 1335 "shape": "__string", 1336 "locationName": "backendEnvironmentName", 1337 "documentation": "<p>The name of the backend environment.</p>" 1338 }, 1339 "Error": { 1340 "shape": "__string", 1341 "locationName": "error", 1342 "documentation": "<p>If the request fails, this error is returned.</p>" 1343 }, 1344 "JobId": { 1345 "shape": "__string", 1346 "locationName": "jobId", 1347 "documentation": "<p>The ID for the job.</p>" 1348 }, 1349 "Operation": { 1350 "shape": "__string", 1351 "locationName": "operation", 1352 "documentation": "<p>The name of the operation.</p>" 1353 }, 1354 "Status": { 1355 "shape": "__string", 1356 "locationName": "status", 1357 "documentation": "<p>The current status of the request.</p>" 1358 } 1359 }, 1360 "documentation": "<p>The response object for this operation.</p>", 1361 "required": [ 1362 "AppId", 1363 "BackendEnvironmentName" 1364 ] 1365 }, 1366 "BackendAuthSocialProviderConfig": { 1367 "type": "structure", 1368 "sensitive": true, 1369 "members": { 1370 "ClientId": { 1371 "shape": "__string", 1372 "locationName": "client_id", 1373 "documentation": "<p>Describes the client_id, which can be obtained from the third-party social federation provider.</p>" 1374 }, 1375 "ClientSecret": { 1376 "shape": "__string", 1377 "locationName": "client_secret", 1378 "documentation": "<p>Describes the client_secret, which can be obtained from third-party social federation providers.</p>" 1379 } 1380 }, 1381 "documentation": "<p>Describes third-party social federation configurations for allowing your app users to sign in using OAuth.</p>" 1382 }, 1383 "BackendConfigRespObj": { 1384 "type": "structure", 1385 "members": { 1386 "AppId": { 1387 "shape": "__string", 1388 "locationName": "appId", 1389 "documentation": "<p>The app ID.</p>" 1390 }, 1391 "BackendManagerAppId": { 1392 "shape": "__string", 1393 "locationName": "backendManagerAppId", 1394 "documentation": "<p>The app ID for the backend manager.</p>" 1395 }, 1396 "Error": { 1397 "shape": "__string", 1398 "locationName": "error", 1399 "documentation": "<p>If the request fails, this error is returned.</p>" 1400 }, 1401 "LoginAuthConfig": { 1402 "shape": "LoginAuthConfigReqObj", 1403 "locationName": "loginAuthConfig", 1404 "documentation": "<p>Describes the Amazon Cognito configurations for the Admin UI auth resource to log in with.</p>" 1405 } 1406 }, 1407 "documentation": "<p>The response object for this operation.</p>" 1408 }, 1409 "BackendJobReqObj": { 1410 "type": "structure", 1411 "members": { 1412 "Operation": { 1413 "shape": "__string", 1414 "locationName": "operation", 1415 "documentation": "<p>Filters the list of response objects to include only those with the specified operation name.</p>" 1416 }, 1417 "Status": { 1418 "shape": "__string", 1419 "locationName": "status", 1420 "documentation": "<p>Filters the list of response objects to include only those with the specified status.</p>" 1421 } 1422 }, 1423 "documentation": "<p>The request object for this operation.</p>" 1424 }, 1425 "BackendJobRespObj": { 1426 "type": "structure", 1427 "members": { 1428 "AppId": { 1429 "shape": "__string", 1430 "locationName": "appId", 1431 "documentation": "<p>The app ID.</p>" 1432 }, 1433 "BackendEnvironmentName": { 1434 "shape": "__string", 1435 "locationName": "backendEnvironmentName", 1436 "documentation": "<p>The name of the backend environment.</p>" 1437 }, 1438 "CreateTime": { 1439 "shape": "__string", 1440 "locationName": "createTime", 1441 "documentation": "<p>The time when the job was created.</p>" 1442 }, 1443 "Error": { 1444 "shape": "__string", 1445 "locationName": "error", 1446 "documentation": "<p>If the request fails, this error is returned.</p>" 1447 }, 1448 "JobId": { 1449 "shape": "__string", 1450 "locationName": "jobId", 1451 "documentation": "<p>The ID for the job.</p>" 1452 }, 1453 "Operation": { 1454 "shape": "__string", 1455 "locationName": "operation", 1456 "documentation": "<p>The name of the operation.</p>" 1457 }, 1458 "Status": { 1459 "shape": "__string", 1460 "locationName": "status", 1461 "documentation": "<p>The current status of the request.</p>" 1462 }, 1463 "UpdateTime": { 1464 "shape": "__string", 1465 "locationName": "updateTime", 1466 "documentation": "<p>The time when the job was last updated.</p>" 1467 } 1468 }, 1469 "documentation": "<p>The response object for this operation.</p>", 1470 "required": [ 1471 "AppId", 1472 "BackendEnvironmentName" 1473 ] 1474 }, 1475 "BackendStoragePermissions": { 1476 "type": "structure", 1477 "members": { 1478 "Authenticated": { 1479 "shape": "ListOfAuthenticatedElement", 1480 "locationName": "authenticated", 1481 "documentation": "<p>Lists all authenticated user read, write, and delete permissions for your S3 bucket.</p>" 1482 }, 1483 "UnAuthenticated": { 1484 "shape": "ListOfUnAuthenticatedElement", 1485 "locationName": "unAuthenticated", 1486 "documentation": "<p>Lists all unauthenticated user read, write, and delete permissions for your S3 bucket.</p>" 1487 } 1488 }, 1489 "documentation": "<p>Describes the read, write, and delete permissions users have against your storage S3 bucket.</p>", 1490 "required": [ 1491 "Authenticated" 1492 ] 1493 }, 1494 "BackendStorageRespObj": { 1495 "type": "structure", 1496 "members": { 1497 "AppId": { 1498 "shape": "__string", 1499 "locationName": "appId", 1500 "documentation": "<p>The app ID.</p>" 1501 }, 1502 "BackendEnvironmentName": { 1503 "shape": "__string", 1504 "locationName": "backendEnvironmentName", 1505 "documentation": "<p>The name of the backend environment.</p>" 1506 }, 1507 "JobId": { 1508 "shape": "__string", 1509 "locationName": "jobId", 1510 "documentation": "<p>The ID for the job.</p>" 1511 }, 1512 "Status": { 1513 "shape": "__string", 1514 "locationName": "status", 1515 "documentation": "<p>The current status of the request.</p>" 1516 } 1517 }, 1518 "documentation": "<p>The response object for this operation.</p>", 1519 "required": [ 1520 "Status", 1521 "AppId", 1522 "BackendEnvironmentName", 1523 "JobId" 1524 ] 1525 }, 1526 "BadRequestException": { 1527 "type": "structure", 1528 "members": { 1529 "Message": { 1530 "shape": "__string", 1531 "locationName": "message", 1532 "documentation": "<p>An error message to inform that the request failed.</p>" 1533 } 1534 }, 1535 "documentation": "<p>An error returned if a request is not formed properly.</p>", 1536 "exception": true, 1537 "error": { 1538 "httpStatusCode": 400 1539 } 1540 }, 1541 "CloneBackendReqObj": { 1542 "type": "structure", 1543 "members": { 1544 "TargetEnvironmentName": { 1545 "shape": "__string", 1546 "locationName": "targetEnvironmentName", 1547 "documentation": "<p>The name of the destination backend environment to be created.</p>" 1548 } 1549 }, 1550 "documentation": "<p>The request object for this operation.</p>", 1551 "required": [ 1552 "TargetEnvironmentName" 1553 ] 1554 }, 1555 "CloneBackendRequest": { 1556 "type": "structure", 1557 "members": { 1558 "AppId": { 1559 "shape": "__string", 1560 "location": "uri", 1561 "locationName": "appId", 1562 "documentation": "<p>The app ID.</p>" 1563 }, 1564 "BackendEnvironmentName": { 1565 "shape": "__string", 1566 "location": "uri", 1567 "locationName": "backendEnvironmentName", 1568 "documentation": "<p>The name of the backend environment.</p>" 1569 }, 1570 "TargetEnvironmentName": { 1571 "shape": "__string", 1572 "locationName": "targetEnvironmentName", 1573 "documentation": "<p>The name of the destination backend environment to be created.</p>" 1574 } 1575 }, 1576 "documentation": "<p>The request body for CloneBackend.</p>", 1577 "required": [ 1578 "AppId", 1579 "BackendEnvironmentName", 1580 "TargetEnvironmentName" 1581 ] 1582 }, 1583 "CloneBackendRespObj": { 1584 "type": "structure", 1585 "members": { 1586 "AppId": { 1587 "shape": "__string", 1588 "locationName": "appId", 1589 "documentation": "<p>The app ID.</p>" 1590 }, 1591 "BackendEnvironmentName": { 1592 "shape": "__string", 1593 "locationName": "backendEnvironmentName", 1594 "documentation": "<p>The name of the backend environment.</p>" 1595 }, 1596 "Error": { 1597 "shape": "__string", 1598 "locationName": "error", 1599 "documentation": "<p>If the request fails, this error is returned.</p>" 1600 }, 1601 "JobId": { 1602 "shape": "__string", 1603 "locationName": "jobId", 1604 "documentation": "<p>The ID for the job.</p>" 1605 }, 1606 "Operation": { 1607 "shape": "__string", 1608 "locationName": "operation", 1609 "documentation": "<p>The name of the operation.</p>" 1610 }, 1611 "Status": { 1612 "shape": "__string", 1613 "locationName": "status", 1614 "documentation": "<p>The current status of the request.</p>" 1615 } 1616 }, 1617 "documentation": "<p>The response object sent when a backend is created.</p>", 1618 "required": [ 1619 "AppId", 1620 "BackendEnvironmentName" 1621 ] 1622 }, 1623 "CloneBackendResponse": { 1624 "type": "structure", 1625 "members": { 1626 "AppId": { 1627 "shape": "__string", 1628 "locationName": "appId", 1629 "documentation": "<p>The app ID.</p>" 1630 }, 1631 "BackendEnvironmentName": { 1632 "shape": "__string", 1633 "locationName": "backendEnvironmentName", 1634 "documentation": "<p>The name of the backend environment.</p>" 1635 }, 1636 "Error": { 1637 "shape": "__string", 1638 "locationName": "error", 1639 "documentation": "<p>If the request fails, this error is returned.</p>" 1640 }, 1641 "JobId": { 1642 "shape": "__string", 1643 "locationName": "jobId", 1644 "documentation": "<p>The ID for the job.</p>" 1645 }, 1646 "Operation": { 1647 "shape": "__string", 1648 "locationName": "operation", 1649 "documentation": "<p>The name of the operation.</p>" 1650 }, 1651 "Status": { 1652 "shape": "__string", 1653 "locationName": "status", 1654 "documentation": "<p>The current status of the request.</p>" 1655 } 1656 } 1657 }, 1658 "CreateBackendAPIReqObj": { 1659 "type": "structure", 1660 "members": { 1661 "BackendEnvironmentName": { 1662 "shape": "__string", 1663 "locationName": "backendEnvironmentName", 1664 "documentation": "<p>The name of the backend environment.</p>" 1665 }, 1666 "ResourceConfig": { 1667 "shape": "BackendAPIResourceConfig", 1668 "locationName": "resourceConfig", 1669 "documentation": "<p>The resource configuration for this request.</p>" 1670 }, 1671 "ResourceName": { 1672 "shape": "__string", 1673 "locationName": "resourceName", 1674 "documentation": "<p>The name of this resource.</p>" 1675 } 1676 }, 1677 "documentation": "<p>The request object for this operation.</p>", 1678 "required": [ 1679 "ResourceName", 1680 "BackendEnvironmentName", 1681 "ResourceConfig" 1682 ] 1683 }, 1684 "CreateBackendAPIRequest": { 1685 "type": "structure", 1686 "members": { 1687 "AppId": { 1688 "shape": "__string", 1689 "location": "uri", 1690 "locationName": "appId", 1691 "documentation": "<p>The app ID.</p>" 1692 }, 1693 "BackendEnvironmentName": { 1694 "shape": "__string", 1695 "locationName": "backendEnvironmentName", 1696 "documentation": "<p>The name of the backend environment.</p>" 1697 }, 1698 "ResourceConfig": { 1699 "shape": "BackendAPIResourceConfig", 1700 "locationName": "resourceConfig", 1701 "documentation": "<p>The resource configuration for this request.</p>" 1702 }, 1703 "ResourceName": { 1704 "shape": "__string", 1705 "locationName": "resourceName", 1706 "documentation": "<p>The name of this resource.</p>" 1707 } 1708 }, 1709 "documentation": "<p>The request body for CreateBackendAPI.</p>", 1710 "required": [ 1711 "AppId", 1712 "ResourceName", 1713 "BackendEnvironmentName", 1714 "ResourceConfig" 1715 ] 1716 }, 1717 "CreateBackendAPIResponse": { 1718 "type": "structure", 1719 "members": { 1720 "AppId": { 1721 "shape": "__string", 1722 "locationName": "appId", 1723 "documentation": "<p>The app ID.</p>" 1724 }, 1725 "BackendEnvironmentName": { 1726 "shape": "__string", 1727 "locationName": "backendEnvironmentName", 1728 "documentation": "<p>The name of the backend environment.</p>" 1729 }, 1730 "Error": { 1731 "shape": "__string", 1732 "locationName": "error", 1733 "documentation": "<p>If the request fails, this error is returned.</p>" 1734 }, 1735 "JobId": { 1736 "shape": "__string", 1737 "locationName": "jobId", 1738 "documentation": "<p>The ID for the job.</p>" 1739 }, 1740 "Operation": { 1741 "shape": "__string", 1742 "locationName": "operation", 1743 "documentation": "<p>The name of the operation.</p>" 1744 }, 1745 "Status": { 1746 "shape": "__string", 1747 "locationName": "status", 1748 "documentation": "<p>The current status of the request.</p>" 1749 } 1750 } 1751 }, 1752 "CreateBackendAuthForgotPasswordConfig": { 1753 "type": "structure", 1754 "members": { 1755 "DeliveryMethod": { 1756 "shape": "DeliveryMethod", 1757 "locationName": "deliveryMethod", 1758 "documentation": "<p><b>(DEPRECATED)</b> Describes which mode to use (either SMS or email) to deliver messages to app users who want to recover their password.</p>" 1759 }, 1760 "EmailSettings": { 1761 "shape": "EmailSettings", 1762 "locationName": "emailSettings", 1763 "documentation": "<p><b>(DEPRECATED)</b> The configuration for the email sent when an app user forgets their password.</p>" 1764 }, 1765 "SmsSettings": { 1766 "shape": "SmsSettings", 1767 "locationName": "smsSettings", 1768 "documentation": "<p><b>(DEPRECATED)</b> The configuration for the SMS message sent when an app user forgets their password.</p>" 1769 } 1770 }, 1771 "documentation": "<p><b>(DEPRECATED)</b> Describes the forgot password policy for authenticating into the Amplify app.</p>", 1772 "required": [ 1773 "DeliveryMethod" 1774 ] 1775 }, 1776 "CreateBackendAuthIdentityPoolConfig": { 1777 "type": "structure", 1778 "members": { 1779 "IdentityPoolName": { 1780 "shape": "__string", 1781 "locationName": "identityPoolName", 1782 "documentation": "<p>Name of the Amazon Cognito identity pool used for authorization.</p>" 1783 }, 1784 "UnauthenticatedLogin": { 1785 "shape": "__boolean", 1786 "locationName": "unauthenticatedLogin", 1787 "documentation": "<p>Set to true or false based on whether you want to enable guest authorization to your Amplify app.</p>" 1788 } 1789 }, 1790 "documentation": "<p>Describes authorization configurations for the auth resources, configured as a part of your Amplify project.</p>", 1791 "required": [ 1792 "UnauthenticatedLogin", 1793 "IdentityPoolName" 1794 ] 1795 }, 1796 "CreateBackendAuthMFAConfig": { 1797 "type": "structure", 1798 "members": { 1799 "MFAMode": { 1800 "shape": "MFAMode", 1801 "documentation": "<p>Describes whether MFA should be [ON, OFF, or OPTIONAL] for authentication in your Amplify project.</p>" 1802 }, 1803 "Settings": { 1804 "shape": "Settings", 1805 "locationName": "settings", 1806 "documentation": "<p>Describes the configuration settings and methods for your Amplify app users to use MFA.</p>" 1807 } 1808 }, 1809 "documentation": "<p>Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.</p>", 1810 "required": [ 1811 "MFAMode" 1812 ] 1813 }, 1814 "CreateBackendAuthOAuthConfig": { 1815 "type": "structure", 1816 "members": { 1817 "DomainPrefix": { 1818 "shape": "__string", 1819 "locationName": "domainPrefix", 1820 "documentation": "<p>The domain prefix for your Amplify app.</p>" 1821 }, 1822 "OAuthGrantType": { 1823 "shape": "OAuthGrantType", 1824 "locationName": "oAuthGrantType", 1825 "documentation": "<p>The OAuth grant type that you use to allow app users to authenticate from your Amplify app.</p>" 1826 }, 1827 "OAuthScopes": { 1828 "shape": "ListOfOAuthScopesElement", 1829 "locationName": "oAuthScopes", 1830 "documentation": "<p>List of OAuth-related flows used to allow your app users to authenticate from your Amplify app.</p>" 1831 }, 1832 "RedirectSignInURIs": { 1833 "shape": "ListOf__string", 1834 "locationName": "redirectSignInURIs", 1835 "documentation": "<p>The redirected URI for signing in to your Amplify app.</p>" 1836 }, 1837 "RedirectSignOutURIs": { 1838 "shape": "ListOf__string", 1839 "locationName": "redirectSignOutURIs", 1840 "documentation": "<p>Redirect URLs that OAuth uses when a user signs out of an Amplify app.</p>" 1841 }, 1842 "SocialProviderSettings": { 1843 "shape": "SocialProviderSettings", 1844 "locationName": "socialProviderSettings", 1845 "documentation": "<p>The settings for using social providers to access your Amplify app.</p>" 1846 } 1847 }, 1848 "documentation": "<p>Creates the OAuth configuration for your Amplify project.</p>", 1849 "required": [ 1850 "RedirectSignOutURIs", 1851 "RedirectSignInURIs", 1852 "OAuthGrantType", 1853 "OAuthScopes" 1854 ] 1855 }, 1856 "CreateBackendAuthPasswordPolicyConfig": { 1857 "type": "structure", 1858 "members": { 1859 "AdditionalConstraints": { 1860 "shape": "ListOfAdditionalConstraintsElement", 1861 "locationName": "additionalConstraints", 1862 "documentation": "<p>Additional constraints for the password used to access the backend of your Amplify project.</p>" 1863 }, 1864 "MinimumLength": { 1865 "shape": "__double", 1866 "locationName": "minimumLength", 1867 "documentation": "<p>The minimum length of the password used to access the backend of your Amplify project.</p>" 1868 } 1869 }, 1870 "documentation": "<p>The password policy configuration for the backend to your Amplify project.</p>", 1871 "required": [ 1872 "MinimumLength" 1873 ] 1874 }, 1875 "CreateBackendAuthReqObj": { 1876 "type": "structure", 1877 "members": { 1878 "BackendEnvironmentName": { 1879 "shape": "__string", 1880 "locationName": "backendEnvironmentName", 1881 "documentation": "<p>The name of the backend environment.</p>" 1882 }, 1883 "ResourceConfig": { 1884 "shape": "CreateBackendAuthResourceConfig", 1885 "locationName": "resourceConfig", 1886 "documentation": "<p>The resource configuration for this request object.</p>" 1887 }, 1888 "ResourceName": { 1889 "shape": "__string", 1890 "locationName": "resourceName", 1891 "documentation": "<p>The name of this resource.</p>" 1892 } 1893 }, 1894 "documentation": "<p>The request object for this operation.</p>", 1895 "required": [ 1896 "ResourceName", 1897 "BackendEnvironmentName", 1898 "ResourceConfig" 1899 ] 1900 }, 1901 "CreateBackendAuthRequest": { 1902 "type": "structure", 1903 "members": { 1904 "AppId": { 1905 "shape": "__string", 1906 "location": "uri", 1907 "locationName": "appId", 1908 "documentation": "<p>The app ID.</p>" 1909 }, 1910 "BackendEnvironmentName": { 1911 "shape": "__string", 1912 "locationName": "backendEnvironmentName", 1913 "documentation": "<p>The name of the backend environment.</p>" 1914 }, 1915 "ResourceConfig": { 1916 "shape": "CreateBackendAuthResourceConfig", 1917 "locationName": "resourceConfig", 1918 "documentation": "<p>The resource configuration for this request object.</p>" 1919 }, 1920 "ResourceName": { 1921 "shape": "__string", 1922 "locationName": "resourceName", 1923 "documentation": "<p>The name of this resource.</p>" 1924 } 1925 }, 1926 "documentation": "<p>The request body for CreateBackendAuth.</p>", 1927 "required": [ 1928 "AppId", 1929 "ResourceName", 1930 "BackendEnvironmentName", 1931 "ResourceConfig" 1932 ] 1933 }, 1934 "CreateBackendAuthResourceConfig": { 1935 "type": "structure", 1936 "members": { 1937 "AuthResources": { 1938 "shape": "AuthResources", 1939 "locationName": "authResources", 1940 "documentation": "<p>Defines whether you want to configure only authentication or both authentication and authorization settings.</p>" 1941 }, 1942 "IdentityPoolConfigs": { 1943 "shape": "CreateBackendAuthIdentityPoolConfig", 1944 "locationName": "identityPoolConfigs", 1945 "documentation": "<p>Describes the authorization configuration for the Amazon Cognito identity pool, provisioned as a part of your auth resource in the Amplify project.</p>" 1946 }, 1947 "Service": { 1948 "shape": "Service", 1949 "locationName": "service", 1950 "documentation": "<p>Defines the service name to use when configuring an authentication resource in your Amplify project.</p>" 1951 }, 1952 "UserPoolConfigs": { 1953 "shape": "CreateBackendAuthUserPoolConfig", 1954 "locationName": "userPoolConfigs", 1955 "documentation": "<p>Describes authentication configuration for the Amazon Cognito user pool, provisioned as a part of your auth resource in the Amplify project.</p>" 1956 } 1957 }, 1958 "documentation": "<p>Defines the resource configuration when creating an auth resource in your Amplify project.</p>", 1959 "required": [ 1960 "AuthResources", 1961 "UserPoolConfigs", 1962 "Service" 1963 ] 1964 }, 1965 "CreateBackendAuthResponse": { 1966 "type": "structure", 1967 "members": { 1968 "AppId": { 1969 "shape": "__string", 1970 "locationName": "appId", 1971 "documentation": "<p>The app ID.</p>" 1972 }, 1973 "BackendEnvironmentName": { 1974 "shape": "__string", 1975 "locationName": "backendEnvironmentName", 1976 "documentation": "<p>The name of the backend environment.</p>" 1977 }, 1978 "Error": { 1979 "shape": "__string", 1980 "locationName": "error", 1981 "documentation": "<p>If the request fails, this error is returned.</p>" 1982 }, 1983 "JobId": { 1984 "shape": "__string", 1985 "locationName": "jobId", 1986 "documentation": "<p>The ID for the job.</p>" 1987 }, 1988 "Operation": { 1989 "shape": "__string", 1990 "locationName": "operation", 1991 "documentation": "<p>The name of the operation.</p>" 1992 }, 1993 "Status": { 1994 "shape": "__string", 1995 "locationName": "status", 1996 "documentation": "<p>The current status of the request.</p>" 1997 } 1998 } 1999 }, 2000 "CreateBackendAuthUserPoolConfig": { 2001 "type": "structure", 2002 "members": { 2003 "ForgotPassword": { 2004 "shape": "CreateBackendAuthForgotPasswordConfig", 2005 "locationName": "forgotPassword", 2006 "documentation": "<p><b>(DEPRECATED)</b> Describes the forgotten password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.</p>" 2007 }, 2008 "Mfa": { 2009 "shape": "CreateBackendAuthMFAConfig", 2010 "locationName": "mfa", 2011 "documentation": "<p>Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.</p>" 2012 }, 2013 "OAuth": { 2014 "shape": "CreateBackendAuthOAuthConfig", 2015 "locationName": "oAuth", 2016 "documentation": "<p>Describes the OAuth policy and rules for your Amazon Cognito user pool, configured as a part of your Amplify project.</p>" 2017 }, 2018 "PasswordPolicy": { 2019 "shape": "CreateBackendAuthPasswordPolicyConfig", 2020 "locationName": "passwordPolicy", 2021 "documentation": "<p>Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.</p>" 2022 }, 2023 "RequiredSignUpAttributes": { 2024 "shape": "ListOfRequiredSignUpAttributesElement", 2025 "locationName": "requiredSignUpAttributes", 2026 "documentation": "<p>The required attributes to sign up new users in the user pool.</p>" 2027 }, 2028 "SignInMethod": { 2029 "shape": "SignInMethod", 2030 "locationName": "signInMethod", 2031 "documentation": "<p>Describes the sign-in methods that your Amplify app users use to log in using the Amazon Cognito user pool, configured as a part of your Amplify project.</p>" 2032 }, 2033 "UserPoolName": { 2034 "shape": "__string", 2035 "locationName": "userPoolName", 2036 "documentation": "<p>The Amazon Cognito user pool name.</p>" 2037 }, 2038 "VerificationMessage": { 2039 "shape": "CreateBackendAuthVerificationMessageConfig", 2040 "locationName": "verificationMessage", 2041 "documentation": "<p>Describes the email or SMS verification message for your Amazon Cognito user pool, configured as a part of your Amplify project.</p>" 2042 } 2043 }, 2044 "documentation": "<p>Describes the Amazon Cognito user pool configuration for the auth resource to be configured for your Amplify project.</p>", 2045 "required": [ 2046 "RequiredSignUpAttributes", 2047 "SignInMethod", 2048 "UserPoolName" 2049 ] 2050 }, 2051 "CreateBackendAuthVerificationMessageConfig": { 2052 "type": "structure", 2053 "members": { 2054 "DeliveryMethod": { 2055 "shape": "DeliveryMethod", 2056 "locationName": "deliveryMethod", 2057 "documentation": "<p>The type of verification message to send.</p>" 2058 }, 2059 "EmailSettings": { 2060 "shape": "EmailSettings", 2061 "locationName": "emailSettings", 2062 "documentation": "<p>The settings for the email message.</p>" 2063 }, 2064 "SmsSettings": { 2065 "shape": "SmsSettings", 2066 "locationName": "smsSettings", 2067 "documentation": "<p>The settings for the SMS message.</p>" 2068 } 2069 }, 2070 "documentation": "<p>Creates an email or SMS verification message for the auth resource configured for your Amplify project.</p>", 2071 "required": [ 2072 "DeliveryMethod" 2073 ] 2074 }, 2075 "CreateBackendConfigReqObj": { 2076 "type": "structure", 2077 "members": { 2078 "BackendManagerAppId": { 2079 "shape": "__string", 2080 "locationName": "backendManagerAppId", 2081 "documentation": "<p>The app ID for the backend manager.</p>" 2082 } 2083 }, 2084 "documentation": "<p>The request object for this operation.</p>" 2085 }, 2086 "CreateBackendConfigRequest": { 2087 "type": "structure", 2088 "members": { 2089 "AppId": { 2090 "shape": "__string", 2091 "location": "uri", 2092 "locationName": "appId", 2093 "documentation": "<p>The app ID.</p>" 2094 }, 2095 "BackendManagerAppId": { 2096 "shape": "__string", 2097 "locationName": "backendManagerAppId", 2098 "documentation": "<p>The app ID for the backend manager.</p>" 2099 } 2100 }, 2101 "documentation": "<p>The request body for CreateBackendConfig.</p>", 2102 "required": [ 2103 "AppId" 2104 ] 2105 }, 2106 "CreateBackendConfigRespObj": { 2107 "type": "structure", 2108 "members": { 2109 "AppId": { 2110 "shape": "__string", 2111 "locationName": "appId", 2112 "documentation": "<p>The app ID.</p>" 2113 }, 2114 "BackendEnvironmentName": { 2115 "shape": "__string", 2116 "locationName": "backendEnvironmentName", 2117 "documentation": "<p>The name of the backend environment.</p>" 2118 }, 2119 "JobId": { 2120 "shape": "__string", 2121 "locationName": "jobId", 2122 "documentation": "<p>The ID for the job.</p>" 2123 }, 2124 "Status": { 2125 "shape": "__string", 2126 "locationName": "status", 2127 "documentation": "<p>The current status of the request.</p>" 2128 } 2129 }, 2130 "documentation": "<p>The response object for this operation.</p>", 2131 "required": [ 2132 "AppId" 2133 ] 2134 }, 2135 "CreateBackendConfigResponse": { 2136 "type": "structure", 2137 "members": { 2138 "AppId": { 2139 "shape": "__string", 2140 "locationName": "appId", 2141 "documentation": "<p>The app ID.</p>" 2142 }, 2143 "BackendEnvironmentName": { 2144 "shape": "__string", 2145 "locationName": "backendEnvironmentName", 2146 "documentation": "<p>The name of the backend environment.</p>" 2147 }, 2148 "JobId": { 2149 "shape": "__string", 2150 "locationName": "jobId", 2151 "documentation": "<p>The ID for the job.</p>" 2152 }, 2153 "Status": { 2154 "shape": "__string", 2155 "locationName": "status", 2156 "documentation": "<p>The current status of the request.</p>" 2157 } 2158 } 2159 }, 2160 "CreateBackendReqObj": { 2161 "type": "structure", 2162 "members": { 2163 "AppId": { 2164 "shape": "__string", 2165 "locationName": "appId", 2166 "documentation": "<p>The app ID.</p>" 2167 }, 2168 "AppName": { 2169 "shape": "__string", 2170 "locationName": "appName", 2171 "documentation": "<p>The name of the app.</p>" 2172 }, 2173 "BackendEnvironmentName": { 2174 "shape": "__string", 2175 "locationName": "backendEnvironmentName", 2176 "documentation": "<p>The name of the backend environment.</p>" 2177 }, 2178 "ResourceConfig": { 2179 "shape": "ResourceConfig", 2180 "locationName": "resourceConfig", 2181 "documentation": "<p>The resource configuration for creating a backend.</p>" 2182 }, 2183 "ResourceName": { 2184 "shape": "__string", 2185 "locationName": "resourceName", 2186 "documentation": "<p>The name of the resource.</p>" 2187 } 2188 }, 2189 "documentation": "<p>The request object for this operation.</p>", 2190 "required": [ 2191 "AppId", 2192 "BackendEnvironmentName", 2193 "AppName" 2194 ] 2195 }, 2196 "CreateBackendRequest": { 2197 "type": "structure", 2198 "members": { 2199 "AppId": { 2200 "shape": "__string", 2201 "locationName": "appId", 2202 "documentation": "<p>The app ID.</p>" 2203 }, 2204 "AppName": { 2205 "shape": "__string", 2206 "locationName": "appName", 2207 "documentation": "<p>The name of the app.</p>" 2208 }, 2209 "BackendEnvironmentName": { 2210 "shape": "__string", 2211 "locationName": "backendEnvironmentName", 2212 "documentation": "<p>The name of the backend environment.</p>" 2213 }, 2214 "ResourceConfig": { 2215 "shape": "ResourceConfig", 2216 "locationName": "resourceConfig", 2217 "documentation": "<p>The resource configuration for creating a backend.</p>" 2218 }, 2219 "ResourceName": { 2220 "shape": "__string", 2221 "locationName": "resourceName", 2222 "documentation": "<p>The name of the resource.</p>" 2223 } 2224 }, 2225 "documentation": "<p>The request body for CreateBackend.</p>", 2226 "required": [ 2227 "AppId", 2228 "BackendEnvironmentName", 2229 "AppName" 2230 ] 2231 }, 2232 "CreateBackendRespObj": { 2233 "type": "structure", 2234 "members": { 2235 "AppId": { 2236 "shape": "__string", 2237 "locationName": "appId", 2238 "documentation": "<p>The app ID.</p>" 2239 }, 2240 "BackendEnvironmentName": { 2241 "shape": "__string", 2242 "locationName": "backendEnvironmentName", 2243 "documentation": "<p>The name of the backend environment.</p>" 2244 }, 2245 "Error": { 2246 "shape": "__string", 2247 "locationName": "error", 2248 "documentation": "<p>If the request fails, this error is returned.</p>" 2249 }, 2250 "JobId": { 2251 "shape": "__string", 2252 "locationName": "jobId", 2253 "documentation": "<p>The ID for the job.</p>" 2254 }, 2255 "Operation": { 2256 "shape": "__string", 2257 "locationName": "operation", 2258 "documentation": "<p>The name of the operation.</p>" 2259 }, 2260 "Status": { 2261 "shape": "__string", 2262 "locationName": "status", 2263 "documentation": "<p>The current status of the request.</p>" 2264 } 2265 }, 2266 "documentation": "<p>The response object sent when a backend is created.</p>", 2267 "required": [ 2268 "AppId", 2269 "BackendEnvironmentName" 2270 ] 2271 }, 2272 "CreateBackendResponse": { 2273 "type": "structure", 2274 "members": { 2275 "AppId": { 2276 "shape": "__string", 2277 "locationName": "appId", 2278 "documentation": "<p>The app ID.</p>" 2279 }, 2280 "BackendEnvironmentName": { 2281 "shape": "__string", 2282 "locationName": "backendEnvironmentName", 2283 "documentation": "<p>The name of the backend environment.</p>" 2284 }, 2285 "Error": { 2286 "shape": "__string", 2287 "locationName": "error", 2288 "documentation": "<p>If the request fails, this error is returned.</p>" 2289 }, 2290 "JobId": { 2291 "shape": "__string", 2292 "locationName": "jobId", 2293 "documentation": "<p>The ID for the job.</p>" 2294 }, 2295 "Operation": { 2296 "shape": "__string", 2297 "locationName": "operation", 2298 "documentation": "<p>The name of the operation.</p>" 2299 }, 2300 "Status": { 2301 "shape": "__string", 2302 "locationName": "status", 2303 "documentation": "<p>The current status of the request.</p>" 2304 } 2305 } 2306 }, 2307 "CreateBackendStorageReqObj": { 2308 "type": "structure", 2309 "members": { 2310 "BackendEnvironmentName": { 2311 "shape": "__string", 2312 "locationName": "backendEnvironmentName", 2313 "documentation": "<p>The name of the backend environment.</p>" 2314 }, 2315 "ResourceConfig": { 2316 "shape": "CreateBackendStorageResourceConfig", 2317 "locationName": "resourceConfig", 2318 "documentation": "<p>The resource configuration for creating backend storage.</p>" 2319 }, 2320 "ResourceName": { 2321 "shape": "__string", 2322 "locationName": "resourceName", 2323 "documentation": "<p>The name of the storage resource.</p>" 2324 } 2325 }, 2326 "documentation": "<p>The request object for this operation.</p>", 2327 "required": [ 2328 "ResourceName", 2329 "BackendEnvironmentName", 2330 "ResourceConfig" 2331 ] 2332 }, 2333 "CreateBackendStorageRequest": { 2334 "type": "structure", 2335 "members": { 2336 "AppId": { 2337 "shape": "__string", 2338 "location": "uri", 2339 "locationName": "appId", 2340 "documentation": "<p>The app ID.</p>" 2341 }, 2342 "BackendEnvironmentName": { 2343 "shape": "__string", 2344 "locationName": "backendEnvironmentName", 2345 "documentation": "<p>The name of the backend environment.</p>" 2346 }, 2347 "ResourceConfig": { 2348 "shape": "CreateBackendStorageResourceConfig", 2349 "locationName": "resourceConfig", 2350 "documentation": "<p>The resource configuration for creating backend storage.</p>" 2351 }, 2352 "ResourceName": { 2353 "shape": "__string", 2354 "locationName": "resourceName", 2355 "documentation": "<p>The name of the storage resource.</p>" 2356 } 2357 }, 2358 "documentation": "<p>The request body for CreateBackendStorage.</p>", 2359 "required": [ 2360 "AppId", 2361 "ResourceName", 2362 "BackendEnvironmentName", 2363 "ResourceConfig" 2364 ] 2365 }, 2366 "CreateBackendStorageResourceConfig": { 2367 "type": "structure", 2368 "members": { 2369 "BucketName": { 2370 "shape": "__string", 2371 "locationName": "bucketName", 2372 "documentation": "<p>The name of the S3 bucket.</p>" 2373 }, 2374 "Permissions": { 2375 "shape": "BackendStoragePermissions", 2376 "locationName": "permissions", 2377 "documentation": "<p>The authorization configuration for the storage S3 bucket.</p>" 2378 }, 2379 "ServiceName": { 2380 "shape": "ServiceName", 2381 "locationName": "serviceName", 2382 "documentation": "<p>The name of the storage service.</p>" 2383 } 2384 }, 2385 "documentation": "<p>The resource configuration for creating backend storage.</p>", 2386 "required": [ 2387 "ServiceName", 2388 "Permissions" 2389 ] 2390 }, 2391 "CreateBackendStorageResponse": { 2392 "type": "structure", 2393 "members": { 2394 "AppId": { 2395 "shape": "__string", 2396 "locationName": "appId", 2397 "documentation": "<p>The app ID.</p>" 2398 }, 2399 "BackendEnvironmentName": { 2400 "shape": "__string", 2401 "locationName": "backendEnvironmentName", 2402 "documentation": "<p>The name of the backend environment.</p>" 2403 }, 2404 "JobId": { 2405 "shape": "__string", 2406 "locationName": "jobId", 2407 "documentation": "<p>The ID for the job.</p>" 2408 }, 2409 "Status": { 2410 "shape": "__string", 2411 "locationName": "status", 2412 "documentation": "<p>The current status of the request.</p>" 2413 } 2414 } 2415 }, 2416 "CreateTokenRequest": { 2417 "type": "structure", 2418 "members": { 2419 "AppId": { 2420 "shape": "__string", 2421 "location": "uri", 2422 "locationName": "appId", 2423 "documentation": "<p>The app ID.</p>" 2424 } 2425 }, 2426 "required": [ 2427 "AppId" 2428 ] 2429 }, 2430 "CreateTokenRespObj": { 2431 "type": "structure", 2432 "members": { 2433 "AppId": { 2434 "shape": "__string", 2435 "locationName": "appId", 2436 "documentation": "<p>The app ID.</p>" 2437 }, 2438 "ChallengeCode": { 2439 "shape": "__string", 2440 "locationName": "challengeCode", 2441 "documentation": "<p>One-time challenge code for authenticating into the Amplify Admin UI.</p>" 2442 }, 2443 "SessionId": { 2444 "shape": "__string", 2445 "locationName": "sessionId", 2446 "documentation": "<p>A unique ID provided when creating a new challenge token.</p>" 2447 }, 2448 "Ttl": { 2449 "shape": "__string", 2450 "locationName": "ttl", 2451 "documentation": "<p>The expiry time for the one-time generated token code.</p>" 2452 } 2453 }, 2454 "documentation": "<p>The response object for this operation.</p>", 2455 "required": [ 2456 "AppId", 2457 "Ttl", 2458 "SessionId", 2459 "ChallengeCode" 2460 ] 2461 }, 2462 "CreateTokenResponse": { 2463 "type": "structure", 2464 "members": { 2465 "AppId": { 2466 "shape": "__string", 2467 "locationName": "appId", 2468 "documentation": "<p>The app ID.</p>" 2469 }, 2470 "ChallengeCode": { 2471 "shape": "__string", 2472 "locationName": "challengeCode", 2473 "documentation": "<p>One-time challenge code for authenticating into the Amplify Admin UI.</p>" 2474 }, 2475 "SessionId": { 2476 "shape": "__string", 2477 "locationName": "sessionId", 2478 "documentation": "<p>A unique ID provided when creating a new challenge token.</p>" 2479 }, 2480 "Ttl": { 2481 "shape": "__string", 2482 "locationName": "ttl", 2483 "documentation": "<p>The expiry time for the one-time generated token code.</p>" 2484 } 2485 } 2486 }, 2487 "DeleteBackendAPIRequest": { 2488 "type": "structure", 2489 "members": { 2490 "AppId": { 2491 "shape": "__string", 2492 "location": "uri", 2493 "locationName": "appId", 2494 "documentation": "<p>The app ID.</p>" 2495 }, 2496 "BackendEnvironmentName": { 2497 "shape": "__string", 2498 "location": "uri", 2499 "locationName": "backendEnvironmentName", 2500 "documentation": "<p>The name of the backend environment.</p>" 2501 }, 2502 "ResourceConfig": { 2503 "shape": "BackendAPIResourceConfig", 2504 "locationName": "resourceConfig", 2505 "documentation": "<p>Defines the resource configuration for the data model in your Amplify project.</p>" 2506 }, 2507 "ResourceName": { 2508 "shape": "__string", 2509 "locationName": "resourceName", 2510 "documentation": "<p>The name of this resource.</p>" 2511 } 2512 }, 2513 "documentation": "<p>The request body for DeleteBackendAPI.</p>", 2514 "required": [ 2515 "AppId", 2516 "BackendEnvironmentName", 2517 "ResourceName" 2518 ] 2519 }, 2520 "DeleteBackendAPIResponse": { 2521 "type": "structure", 2522 "members": { 2523 "AppId": { 2524 "shape": "__string", 2525 "locationName": "appId", 2526 "documentation": "<p>The app ID.</p>" 2527 }, 2528 "BackendEnvironmentName": { 2529 "shape": "__string", 2530 "locationName": "backendEnvironmentName", 2531 "documentation": "<p>The name of the backend environment.</p>" 2532 }, 2533 "Error": { 2534 "shape": "__string", 2535 "locationName": "error", 2536 "documentation": "<p>If the request fails, this error is returned.</p>" 2537 }, 2538 "JobId": { 2539 "shape": "__string", 2540 "locationName": "jobId", 2541 "documentation": "<p>The ID for the job.</p>" 2542 }, 2543 "Operation": { 2544 "shape": "__string", 2545 "locationName": "operation", 2546 "documentation": "<p>The name of the operation.</p>" 2547 }, 2548 "Status": { 2549 "shape": "__string", 2550 "locationName": "status", 2551 "documentation": "<p>The current status of the request.</p>" 2552 } 2553 } 2554 }, 2555 "DeleteBackendAuthRequest": { 2556 "type": "structure", 2557 "members": { 2558 "AppId": { 2559 "shape": "__string", 2560 "location": "uri", 2561 "locationName": "appId", 2562 "documentation": "<p>The app ID.</p>" 2563 }, 2564 "BackendEnvironmentName": { 2565 "shape": "__string", 2566 "location": "uri", 2567 "locationName": "backendEnvironmentName", 2568 "documentation": "<p>The name of the backend environment.</p>" 2569 }, 2570 "ResourceName": { 2571 "shape": "__string", 2572 "locationName": "resourceName", 2573 "documentation": "<p>The name of this resource.</p>" 2574 } 2575 }, 2576 "documentation": "<p>The request body for DeleteBackendAuth.</p>", 2577 "required": [ 2578 "AppId", 2579 "BackendEnvironmentName", 2580 "ResourceName" 2581 ] 2582 }, 2583 "DeleteBackendAuthResponse": { 2584 "type": "structure", 2585 "members": { 2586 "AppId": { 2587 "shape": "__string", 2588 "locationName": "appId", 2589 "documentation": "<p>The app ID.</p>" 2590 }, 2591 "BackendEnvironmentName": { 2592 "shape": "__string", 2593 "locationName": "backendEnvironmentName", 2594 "documentation": "<p>The name of the backend environment.</p>" 2595 }, 2596 "Error": { 2597 "shape": "__string", 2598 "locationName": "error", 2599 "documentation": "<p>If the request fails, this error is returned.</p>" 2600 }, 2601 "JobId": { 2602 "shape": "__string", 2603 "locationName": "jobId", 2604 "documentation": "<p>The ID for the job.</p>" 2605 }, 2606 "Operation": { 2607 "shape": "__string", 2608 "locationName": "operation", 2609 "documentation": "<p>The name of the operation.</p>" 2610 }, 2611 "Status": { 2612 "shape": "__string", 2613 "locationName": "status", 2614 "documentation": "<p>The current status of the request.</p>" 2615 } 2616 } 2617 }, 2618 "DeleteBackendRequest": { 2619 "type": "structure", 2620 "members": { 2621 "AppId": { 2622 "shape": "__string", 2623 "location": "uri", 2624 "locationName": "appId", 2625 "documentation": "<p>The app ID.</p>" 2626 }, 2627 "BackendEnvironmentName": { 2628 "shape": "__string", 2629 "location": "uri", 2630 "locationName": "backendEnvironmentName", 2631 "documentation": "<p>The name of the backend environment.</p>" 2632 } 2633 }, 2634 "required": [ 2635 "AppId", 2636 "BackendEnvironmentName" 2637 ] 2638 }, 2639 "DeleteBackendRespObj": { 2640 "type": "structure", 2641 "members": { 2642 "AppId": { 2643 "shape": "__string", 2644 "locationName": "appId", 2645 "documentation": "<p>The app ID.</p>" 2646 }, 2647 "BackendEnvironmentName": { 2648 "shape": "__string", 2649 "locationName": "backendEnvironmentName", 2650 "documentation": "<p>The name of the backend environment.</p>" 2651 }, 2652 "Error": { 2653 "shape": "__string", 2654 "locationName": "error", 2655 "documentation": "<p>If the request fails, this error is returned.</p>" 2656 }, 2657 "JobId": { 2658 "shape": "__string", 2659 "locationName": "jobId", 2660 "documentation": "<p>The ID for the job.</p>" 2661 }, 2662 "Operation": { 2663 "shape": "__string", 2664 "locationName": "operation", 2665 "documentation": "<p>The name of the operation.</p>" 2666 }, 2667 "Status": { 2668 "shape": "__string", 2669 "locationName": "status", 2670 "documentation": "<p>The current status of the request.</p>" 2671 } 2672 }, 2673 "documentation": "<p>The returned object for a request to delete a backend.</p>", 2674 "required": [ 2675 "AppId", 2676 "BackendEnvironmentName" 2677 ] 2678 }, 2679 "DeleteBackendResponse": { 2680 "type": "structure", 2681 "members": { 2682 "AppId": { 2683 "shape": "__string", 2684 "locationName": "appId", 2685 "documentation": "<p>The app ID.</p>" 2686 }, 2687 "BackendEnvironmentName": { 2688 "shape": "__string", 2689 "locationName": "backendEnvironmentName", 2690 "documentation": "<p>The name of the backend environment.</p>" 2691 }, 2692 "Error": { 2693 "shape": "__string", 2694 "locationName": "error", 2695 "documentation": "<p>If the request fails, this error is returned.</p>" 2696 }, 2697 "JobId": { 2698 "shape": "__string", 2699 "locationName": "jobId", 2700 "documentation": "<p>The ID for the job.</p>" 2701 }, 2702 "Operation": { 2703 "shape": "__string", 2704 "locationName": "operation", 2705 "documentation": "<p>The name of the operation.</p>" 2706 }, 2707 "Status": { 2708 "shape": "__string", 2709 "locationName": "status", 2710 "documentation": "<p>The current status of the request.</p>" 2711 } 2712 } 2713 }, 2714 "DeleteBackendStorageRequest": { 2715 "type": "structure", 2716 "members": { 2717 "AppId": { 2718 "shape": "__string", 2719 "location": "uri", 2720 "locationName": "appId", 2721 "documentation": "<p>The app ID.</p>" 2722 }, 2723 "BackendEnvironmentName": { 2724 "shape": "__string", 2725 "location": "uri", 2726 "locationName": "backendEnvironmentName", 2727 "documentation": "<p>The name of the backend environment.</p>" 2728 }, 2729 "ResourceName": { 2730 "shape": "__string", 2731 "locationName": "resourceName", 2732 "documentation": "<p>The name of the storage resource.</p>" 2733 }, 2734 "ServiceName": { 2735 "shape": "ServiceName", 2736 "locationName": "serviceName", 2737 "documentation": "<p>The name of the storage service.</p>" 2738 } 2739 }, 2740 "documentation": "<p>The request body for DeleteBackendStorage.</p>", 2741 "required": [ 2742 "AppId", 2743 "BackendEnvironmentName", 2744 "ServiceName", 2745 "ResourceName" 2746 ] 2747 }, 2748 "DeleteBackendStorageResponse": { 2749 "type": "structure", 2750 "members": { 2751 "AppId": { 2752 "shape": "__string", 2753 "locationName": "appId", 2754 "documentation": "<p>The app ID.</p>" 2755 }, 2756 "BackendEnvironmentName": { 2757 "shape": "__string", 2758 "locationName": "backendEnvironmentName", 2759 "documentation": "<p>The name of the backend environment.</p>" 2760 }, 2761 "JobId": { 2762 "shape": "__string", 2763 "locationName": "jobId", 2764 "documentation": "<p>The ID for the job.</p>" 2765 }, 2766 "Status": { 2767 "shape": "__string", 2768 "locationName": "status", 2769 "documentation": "<p>The current status of the request.</p>" 2770 } 2771 } 2772 }, 2773 "DeleteTokenRequest": { 2774 "type": "structure", 2775 "members": { 2776 "AppId": { 2777 "shape": "__string", 2778 "location": "uri", 2779 "locationName": "appId", 2780 "documentation": "<p>The app ID.</p>" 2781 }, 2782 "SessionId": { 2783 "shape": "__string", 2784 "location": "uri", 2785 "locationName": "sessionId", 2786 "documentation": "<p>The session ID.</p>" 2787 } 2788 }, 2789 "required": [ 2790 "SessionId", 2791 "AppId" 2792 ] 2793 }, 2794 "DeleteTokenRespObj": { 2795 "type": "structure", 2796 "members": { 2797 "IsSuccess": { 2798 "shape": "__boolean", 2799 "locationName": "isSuccess", 2800 "documentation": "<p>Indicates whether the request succeeded or failed.</p>" 2801 } 2802 }, 2803 "documentation": "<p>The response object for this operation.</p>", 2804 "required": [ 2805 "IsSuccess" 2806 ] 2807 }, 2808 "DeleteTokenResponse": { 2809 "type": "structure", 2810 "members": { 2811 "IsSuccess": { 2812 "shape": "__boolean", 2813 "locationName": "isSuccess", 2814 "documentation": "<p>Indicates whether the request succeeded or failed.</p>" 2815 } 2816 } 2817 }, 2818 "DeliveryMethod": { 2819 "type": "string", 2820 "documentation": "<p>The type of verification message to send.</p>", 2821 "enum": [ 2822 "EMAIL", 2823 "SMS" 2824 ] 2825 }, 2826 "EmailSettings": { 2827 "type": "structure", 2828 "sensitive": true, 2829 "members": { 2830 "EmailMessage": { 2831 "shape": "__string", 2832 "locationName": "emailMessage", 2833 "documentation": "<p>The contents of the email message.</p>" 2834 }, 2835 "EmailSubject": { 2836 "shape": "__string", 2837 "locationName": "emailSubject", 2838 "documentation": "<p>The contents of the subject line of the email message.</p>" 2839 } 2840 }, 2841 "documentation": "<p>The configuration for the email sent when an app user forgets their password.</p>" 2842 }, 2843 "GatewayTimeoutException": { 2844 "type": "structure", 2845 "members": { 2846 "Message": { 2847 "shape": "__string", 2848 "locationName": "message", 2849 "documentation": "<p>An error message to inform that the request failed.</p>" 2850 } 2851 }, 2852 "documentation": "<p>An error returned if there's a temporary issue with the service.</p>", 2853 "exception": true, 2854 "error": { 2855 "httpStatusCode": 504 2856 } 2857 }, 2858 "GenerateBackendAPIModelsRequest": { 2859 "type": "structure", 2860 "members": { 2861 "AppId": { 2862 "shape": "__string", 2863 "location": "uri", 2864 "locationName": "appId", 2865 "documentation": "<p>The app ID.</p>" 2866 }, 2867 "BackendEnvironmentName": { 2868 "shape": "__string", 2869 "location": "uri", 2870 "locationName": "backendEnvironmentName", 2871 "documentation": "<p>The name of the backend environment.</p>" 2872 }, 2873 "ResourceName": { 2874 "shape": "__string", 2875 "locationName": "resourceName", 2876 "documentation": "<p>The name of this resource.</p>" 2877 } 2878 }, 2879 "documentation": "<p>The request body for GenerateBackendAPIModels.</p>", 2880 "required": [ 2881 "AppId", 2882 "BackendEnvironmentName", 2883 "ResourceName" 2884 ] 2885 }, 2886 "GenerateBackendAPIModelsResponse": { 2887 "type": "structure", 2888 "members": { 2889 "AppId": { 2890 "shape": "__string", 2891 "locationName": "appId", 2892 "documentation": "<p>The app ID.</p>" 2893 }, 2894 "BackendEnvironmentName": { 2895 "shape": "__string", 2896 "locationName": "backendEnvironmentName", 2897 "documentation": "<p>The name of the backend environment.</p>" 2898 }, 2899 "Error": { 2900 "shape": "__string", 2901 "locationName": "error", 2902 "documentation": "<p>If the request fails, this error is returned.</p>" 2903 }, 2904 "JobId": { 2905 "shape": "__string", 2906 "locationName": "jobId", 2907 "documentation": "<p>The ID for the job.</p>" 2908 }, 2909 "Operation": { 2910 "shape": "__string", 2911 "locationName": "operation", 2912 "documentation": "<p>The name of the operation.</p>" 2913 }, 2914 "Status": { 2915 "shape": "__string", 2916 "locationName": "status", 2917 "documentation": "<p>The current status of the request.</p>" 2918 } 2919 } 2920 }, 2921 "GetBackendAPIModelsRequest": { 2922 "type": "structure", 2923 "members": { 2924 "AppId": { 2925 "shape": "__string", 2926 "location": "uri", 2927 "locationName": "appId", 2928 "documentation": "<p>The app ID.</p>" 2929 }, 2930 "BackendEnvironmentName": { 2931 "shape": "__string", 2932 "location": "uri", 2933 "locationName": "backendEnvironmentName", 2934 "documentation": "<p>The name of the backend environment.</p>" 2935 }, 2936 "ResourceName": { 2937 "shape": "__string", 2938 "locationName": "resourceName", 2939 "documentation": "<p>The name of this resource.</p>" 2940 } 2941 }, 2942 "documentation": "<p>The request body for GetBackendAPIModels.</p>", 2943 "required": [ 2944 "AppId", 2945 "BackendEnvironmentName", 2946 "ResourceName" 2947 ] 2948 }, 2949 "GetBackendAPIModelsResponse": { 2950 "type": "structure", 2951 "members": { 2952 "Models": { 2953 "shape": "__string", 2954 "locationName": "models", 2955 "documentation": "<p>Stringified JSON of the datastore model.</p>" 2956 }, 2957 "Status": { 2958 "shape": "Status", 2959 "locationName": "status", 2960 "documentation": "<p>The current status of the request.</p>" 2961 }, 2962 "ModelIntrospectionSchema": { 2963 "shape": "__string", 2964 "locationName": "modelIntrospectionSchema", 2965 "documentation": "<p>Stringified JSON of the model introspection schema for an existing backend API resource.</p>" 2966 } 2967 } 2968 }, 2969 "GetBackendAPIRequest": { 2970 "type": "structure", 2971 "members": { 2972 "AppId": { 2973 "shape": "__string", 2974 "location": "uri", 2975 "locationName": "appId", 2976 "documentation": "<p>The app ID.</p>" 2977 }, 2978 "BackendEnvironmentName": { 2979 "shape": "__string", 2980 "location": "uri", 2981 "locationName": "backendEnvironmentName", 2982 "documentation": "<p>The name of the backend environment.</p>" 2983 }, 2984 "ResourceConfig": { 2985 "shape": "BackendAPIResourceConfig", 2986 "locationName": "resourceConfig", 2987 "documentation": "<p>Defines the resource configuration for the data model in your Amplify project.</p>" 2988 }, 2989 "ResourceName": { 2990 "shape": "__string", 2991 "locationName": "resourceName", 2992 "documentation": "<p>The name of this resource.</p>" 2993 } 2994 }, 2995 "documentation": "<p>The request body for GetBackendAPI.</p>", 2996 "required": [ 2997 "AppId", 2998 "BackendEnvironmentName", 2999 "ResourceName" 3000 ] 3001 }, 3002 "GetBackendAPIRespObj": { 3003 "type": "structure", 3004 "members": { 3005 "AppId": { 3006 "shape": "__string", 3007 "locationName": "appId", 3008 "documentation": "<p>The app ID.</p>" 3009 }, 3010 "BackendEnvironmentName": { 3011 "shape": "__string", 3012 "locationName": "backendEnvironmentName", 3013 "documentation": "<p>The name of the backend environment.</p>" 3014 }, 3015 "Error": { 3016 "shape": "__string", 3017 "locationName": "error", 3018 "documentation": "<p>If the request fails, this error is returned.</p>" 3019 }, 3020 "ResourceConfig": { 3021 "shape": "BackendAPIResourceConfig", 3022 "locationName": "resourceConfig", 3023 "documentation": "<p>The resource configuration for this response object.</p>" 3024 }, 3025 "ResourceName": { 3026 "shape": "__string", 3027 "locationName": "resourceName", 3028 "documentation": "<p>The name of this resource.</p>" 3029 } 3030 }, 3031 "documentation": "<p>The response object for this operation.</p>", 3032 "required": [ 3033 "AppId", 3034 "BackendEnvironmentName" 3035 ] 3036 }, 3037 "GetBackendAPIResponse": { 3038 "type": "structure", 3039 "members": { 3040 "AppId": { 3041 "shape": "__string", 3042 "locationName": "appId", 3043 "documentation": "<p>The app ID.</p>" 3044 }, 3045 "BackendEnvironmentName": { 3046 "shape": "__string", 3047 "locationName": "backendEnvironmentName", 3048 "documentation": "<p>The name of the backend environment.</p>" 3049 }, 3050 "Error": { 3051 "shape": "__string", 3052 "locationName": "error", 3053 "documentation": "<p>If the request fails, this error is returned.</p>" 3054 }, 3055 "ResourceConfig": { 3056 "shape": "BackendAPIResourceConfig", 3057 "locationName": "resourceConfig", 3058 "documentation": "<p>The resource configuration for this response object.</p>" 3059 }, 3060 "ResourceName": { 3061 "shape": "__string", 3062 "locationName": "resourceName", 3063 "documentation": "<p>The name of this resource.</p>" 3064 } 3065 } 3066 }, 3067 "GetBackendAuthReqObj": { 3068 "type": "structure", 3069 "members": { 3070 "ResourceName": { 3071 "shape": "__string", 3072 "locationName": "resourceName", 3073 "documentation": "<p>The name of this resource.</p>" 3074 } 3075 }, 3076 "documentation": "<p>The request object for this operation.</p>", 3077 "required": [ 3078 "ResourceName" 3079 ] 3080 }, 3081 "GetBackendAuthRequest": { 3082 "type": "structure", 3083 "members": { 3084 "AppId": { 3085 "shape": "__string", 3086 "location": "uri", 3087 "locationName": "appId", 3088 "documentation": "<p>The app ID.</p>" 3089 }, 3090 "BackendEnvironmentName": { 3091 "shape": "__string", 3092 "location": "uri", 3093 "locationName": "backendEnvironmentName", 3094 "documentation": "<p>The name of the backend environment.</p>" 3095 }, 3096 "ResourceName": { 3097 "shape": "__string", 3098 "locationName": "resourceName", 3099 "documentation": "<p>The name of this resource.</p>" 3100 } 3101 }, 3102 "documentation": "<p>The request body for GetBackendAuth.</p>", 3103 "required": [ 3104 "AppId", 3105 "BackendEnvironmentName", 3106 "ResourceName" 3107 ] 3108 }, 3109 "GetBackendAuthRespObj": { 3110 "type": "structure", 3111 "members": { 3112 "AppId": { 3113 "shape": "__string", 3114 "locationName": "appId", 3115 "documentation": "<p>The app ID.</p>" 3116 }, 3117 "BackendEnvironmentName": { 3118 "shape": "__string", 3119 "locationName": "backendEnvironmentName", 3120 "documentation": "<p>The name of the backend environment.</p>" 3121 }, 3122 "Error": { 3123 "shape": "__string", 3124 "locationName": "error", 3125 "documentation": "<p>If the request fails, this error is returned.</p>" 3126 }, 3127 "ResourceConfig": { 3128 "shape": "CreateBackendAuthResourceConfig", 3129 "locationName": "resourceConfig", 3130 "documentation": "<p>The resource configuration for authorization requests to the backend of your Amplify project.</p>" 3131 }, 3132 "ResourceName": { 3133 "shape": "__string", 3134 "locationName": "resourceName", 3135 "documentation": "<p>The name of this resource.</p>" 3136 } 3137 }, 3138 "documentation": "<p>The response object for this operation.</p>", 3139 "required": [ 3140 "AppId", 3141 "BackendEnvironmentName" 3142 ] 3143 }, 3144 "GetBackendAuthResponse": { 3145 "type": "structure", 3146 "members": { 3147 "AppId": { 3148 "shape": "__string", 3149 "locationName": "appId", 3150 "documentation": "<p>The app ID.</p>" 3151 }, 3152 "BackendEnvironmentName": { 3153 "shape": "__string", 3154 "locationName": "backendEnvironmentName", 3155 "documentation": "<p>The name of the backend environment.</p>" 3156 }, 3157 "Error": { 3158 "shape": "__string", 3159 "locationName": "error", 3160 "documentation": "<p>If the request fails, this error is returned.</p>" 3161 }, 3162 "ResourceConfig": { 3163 "shape": "CreateBackendAuthResourceConfig", 3164 "locationName": "resourceConfig", 3165 "documentation": "<p>The resource configuration for authorization requests to the backend of your Amplify project.</p>" 3166 }, 3167 "ResourceName": { 3168 "shape": "__string", 3169 "locationName": "resourceName", 3170 "documentation": "<p>The name of this resource.</p>" 3171 } 3172 } 3173 }, 3174 "GetBackendJobRequest": { 3175 "type": "structure", 3176 "members": { 3177 "AppId": { 3178 "shape": "__string", 3179 "location": "uri", 3180 "locationName": "appId", 3181 "documentation": "<p>The app ID.</p>" 3182 }, 3183 "BackendEnvironmentName": { 3184 "shape": "__string", 3185 "location": "uri", 3186 "locationName": "backendEnvironmentName", 3187 "documentation": "<p>The name of the backend environment.</p>" 3188 }, 3189 "JobId": { 3190 "shape": "__string", 3191 "location": "uri", 3192 "locationName": "jobId", 3193 "documentation": "<p>The ID for the job.</p>" 3194 } 3195 }, 3196 "required": [ 3197 "AppId", 3198 "BackendEnvironmentName", 3199 "JobId" 3200 ] 3201 }, 3202 "GetBackendJobResponse": { 3203 "type": "structure", 3204 "members": { 3205 "AppId": { 3206 "shape": "__string", 3207 "locationName": "appId", 3208 "documentation": "<p>The app ID.</p>" 3209 }, 3210 "BackendEnvironmentName": { 3211 "shape": "__string", 3212 "locationName": "backendEnvironmentName", 3213 "documentation": "<p>The name of the backend environment.</p>" 3214 }, 3215 "CreateTime": { 3216 "shape": "__string", 3217 "locationName": "createTime", 3218 "documentation": "<p>The time when the job was created.</p>" 3219 }, 3220 "Error": { 3221 "shape": "__string", 3222 "locationName": "error", 3223 "documentation": "<p>If the request fails, this error is returned.</p>" 3224 }, 3225 "JobId": { 3226 "shape": "__string", 3227 "locationName": "jobId", 3228 "documentation": "<p>The ID for the job.</p>" 3229 }, 3230 "Operation": { 3231 "shape": "__string", 3232 "locationName": "operation", 3233 "documentation": "<p>The name of the operation.</p>" 3234 }, 3235 "Status": { 3236 "shape": "__string", 3237 "locationName": "status", 3238 "documentation": "<p>The current status of the request.</p>" 3239 }, 3240 "UpdateTime": { 3241 "shape": "__string", 3242 "locationName": "updateTime", 3243 "documentation": "<p>The time when the job was last updated.</p>" 3244 } 3245 } 3246 }, 3247 "GetBackendReqObj": { 3248 "type": "structure", 3249 "members": { 3250 "BackendEnvironmentName": { 3251 "shape": "__string", 3252 "locationName": "backendEnvironmentName", 3253 "documentation": "<p>The name of the backend environment.</p>" 3254 } 3255 }, 3256 "documentation": "<p>The request object for this operation.</p>" 3257 }, 3258 "GetBackendRequest": { 3259 "type": "structure", 3260 "members": { 3261 "AppId": { 3262 "shape": "__string", 3263 "location": "uri", 3264 "locationName": "appId", 3265 "documentation": "<p>The app ID.</p>" 3266 }, 3267 "BackendEnvironmentName": { 3268 "shape": "__string", 3269 "locationName": "backendEnvironmentName", 3270 "documentation": "<p>The name of the backend environment.</p>" 3271 } 3272 }, 3273 "documentation": "<p>The request body for GetBackend.</p>", 3274 "required": [ 3275 "AppId" 3276 ] 3277 }, 3278 "GetBackendRespObj": { 3279 "type": "structure", 3280 "members": { 3281 "AmplifyFeatureFlags": { 3282 "shape": "__string", 3283 "locationName": "amplifyFeatureFlags", 3284 "documentation": "<p>A stringified version of the cli.json file for your Amplify project.</p>" 3285 }, 3286 "AmplifyMetaConfig": { 3287 "shape": "__string", 3288 "locationName": "amplifyMetaConfig", 3289 "documentation": "<p>A stringified version of the current configs for your Amplify project.</p>" 3290 }, 3291 "AppId": { 3292 "shape": "__string", 3293 "locationName": "appId", 3294 "documentation": "<p>The app ID.</p>" 3295 }, 3296 "AppName": { 3297 "shape": "__string", 3298 "locationName": "appName", 3299 "documentation": "<p>The name of the app.</p>" 3300 }, 3301 "BackendEnvironmentList": { 3302 "shape": "ListOf__string", 3303 "locationName": "backendEnvironmentList", 3304 "documentation": "<p>A list of backend environments in an array.</p>" 3305 }, 3306 "BackendEnvironmentName": { 3307 "shape": "__string", 3308 "locationName": "backendEnvironmentName", 3309 "documentation": "<p>The name of the backend environment.</p>" 3310 }, 3311 "Error": { 3312 "shape": "__string", 3313 "locationName": "error", 3314 "documentation": "<p>If the request failed, this is the returned error.</p>" 3315 } 3316 }, 3317 "documentation": "<p>The response object for this operation.</p>", 3318 "required": [ 3319 "AppId" 3320 ] 3321 }, 3322 "GetBackendResponse": { 3323 "type": "structure", 3324 "members": { 3325 "AmplifyFeatureFlags": { 3326 "shape": "__string", 3327 "locationName": "amplifyFeatureFlags", 3328 "documentation": "<p>A stringified version of the cli.json file for your Amplify project.</p>" 3329 }, 3330 "AmplifyMetaConfig": { 3331 "shape": "__string", 3332 "locationName": "amplifyMetaConfig", 3333 "documentation": "<p>A stringified version of the current configs for your Amplify project.</p>" 3334 }, 3335 "AppId": { 3336 "shape": "__string", 3337 "locationName": "appId", 3338 "documentation": "<p>The app ID.</p>" 3339 }, 3340 "AppName": { 3341 "shape": "__string", 3342 "locationName": "appName", 3343 "documentation": "<p>The name of the app.</p>" 3344 }, 3345 "BackendEnvironmentList": { 3346 "shape": "ListOf__string", 3347 "locationName": "backendEnvironmentList", 3348 "documentation": "<p>A list of backend environments in an array.</p>" 3349 }, 3350 "BackendEnvironmentName": { 3351 "shape": "__string", 3352 "locationName": "backendEnvironmentName", 3353 "documentation": "<p>The name of the backend environment.</p>" 3354 }, 3355 "Error": { 3356 "shape": "__string", 3357 "locationName": "error", 3358 "documentation": "<p>If the request failed, this is the returned error.</p>" 3359 } 3360 } 3361 }, 3362 "GetBackendStorageReqObj": { 3363 "type": "structure", 3364 "members": { 3365 "ResourceName": { 3366 "shape": "__string", 3367 "locationName": "resourceName", 3368 "documentation": "<p>The name of the storage resource.</p>" 3369 } 3370 }, 3371 "documentation": "<p>The request object for this operation.</p>", 3372 "required": [ 3373 "ResourceName" 3374 ] 3375 }, 3376 "GetBackendStorageRequest": { 3377 "type": "structure", 3378 "members": { 3379 "AppId": { 3380 "shape": "__string", 3381 "location": "uri", 3382 "locationName": "appId", 3383 "documentation": "<p>The app ID.</p>" 3384 }, 3385 "BackendEnvironmentName": { 3386 "shape": "__string", 3387 "location": "uri", 3388 "locationName": "backendEnvironmentName", 3389 "documentation": "<p>The name of the backend environment.</p>" 3390 }, 3391 "ResourceName": { 3392 "shape": "__string", 3393 "locationName": "resourceName", 3394 "documentation": "<p>The name of the storage resource.</p>" 3395 } 3396 }, 3397 "documentation": "<p>The request body for GetBackendStorage.</p>", 3398 "required": [ 3399 "AppId", 3400 "BackendEnvironmentName", 3401 "ResourceName" 3402 ] 3403 }, 3404 "GetBackendStorageResourceConfig": { 3405 "type": "structure", 3406 "members": { 3407 "BucketName": { 3408 "shape": "__string", 3409 "locationName": "bucketName", 3410 "documentation": "<p>The name of the S3 bucket.</p>" 3411 }, 3412 "Imported": { 3413 "shape": "__boolean", 3414 "locationName": "imported", 3415 "documentation": "<p>Returns True if the storage resource has been imported.</p>" 3416 }, 3417 "Permissions": { 3418 "shape": "BackendStoragePermissions", 3419 "locationName": "permissions", 3420 "documentation": "<p>The authorization configuration for the storage S3 bucket.</p>" 3421 }, 3422 "ServiceName": { 3423 "shape": "ServiceName", 3424 "locationName": "serviceName", 3425 "documentation": "<p>The name of the storage service.</p>" 3426 } 3427 }, 3428 "documentation": "<p>The details for a backend storage resource.</p>", 3429 "required": [ 3430 "ServiceName", 3431 "Imported" 3432 ] 3433 }, 3434 "GetBackendStorageRespObj": { 3435 "type": "structure", 3436 "members": { 3437 "AppId": { 3438 "shape": "__string", 3439 "locationName": "appId", 3440 "documentation": "<p>The app ID.</p>" 3441 }, 3442 "BackendEnvironmentName": { 3443 "shape": "__string", 3444 "locationName": "backendEnvironmentName", 3445 "documentation": "<p>The name of the backend environment.</p>" 3446 }, 3447 "ResourceConfig": { 3448 "shape": "GetBackendStorageResourceConfig", 3449 "locationName": "resourceConfig", 3450 "documentation": "<p>The resource configuration for the backend storage resource.</p>" 3451 }, 3452 "ResourceName": { 3453 "shape": "__string", 3454 "locationName": "resourceName", 3455 "documentation": "<p>The name of the storage resource.</p>" 3456 } 3457 }, 3458 "documentation": "<p>The response object for this operation.</p>", 3459 "required": [ 3460 "AppId", 3461 "BackendEnvironmentName" 3462 ] 3463 }, 3464 "GetBackendStorageResponse": { 3465 "type": "structure", 3466 "members": { 3467 "AppId": { 3468 "shape": "__string", 3469 "locationName": "appId", 3470 "documentation": "<p>The app ID.</p>" 3471 }, 3472 "BackendEnvironmentName": { 3473 "shape": "__string", 3474 "locationName": "backendEnvironmentName", 3475 "documentation": "<p>The name of the backend environment.</p>" 3476 }, 3477 "ResourceConfig": { 3478 "shape": "GetBackendStorageResourceConfig", 3479 "locationName": "resourceConfig", 3480 "documentation": "<p>The resource configuration for the backend storage resource.</p>" 3481 }, 3482 "ResourceName": { 3483 "shape": "__string", 3484 "locationName": "resourceName", 3485 "documentation": "<p>The name of the storage resource.</p>" 3486 } 3487 } 3488 }, 3489 "GetTokenRequest": { 3490 "type": "structure", 3491 "members": { 3492 "AppId": { 3493 "shape": "__string", 3494 "location": "uri", 3495 "locationName": "appId", 3496 "documentation": "<p>The app ID.</p>" 3497 }, 3498 "SessionId": { 3499 "shape": "__string", 3500 "location": "uri", 3501 "locationName": "sessionId", 3502 "documentation": "<p>The session ID.</p>" 3503 } 3504 }, 3505 "required": [ 3506 "SessionId", 3507 "AppId" 3508 ] 3509 }, 3510 "GetTokenRespObj": { 3511 "type": "structure", 3512 "members": { 3513 "AppId": { 3514 "shape": "__string", 3515 "locationName": "appId", 3516 "documentation": "<p>The app ID.</p>" 3517 }, 3518 "ChallengeCode": { 3519 "shape": "__string", 3520 "locationName": "challengeCode", 3521 "documentation": "<p>The one-time challenge code for authenticating into the Amplify Admin UI.</p>" 3522 }, 3523 "SessionId": { 3524 "shape": "__string", 3525 "locationName": "sessionId", 3526 "documentation": "<p>A unique ID provided when creating a new challenge token.</p>" 3527 }, 3528 "Ttl": { 3529 "shape": "__string", 3530 "locationName": "ttl", 3531 "documentation": "<p>The expiry time for the one-time generated token code.</p>" 3532 } 3533 }, 3534 "documentation": "<p>The response object for this operation.</p>", 3535 "required": [ 3536 "AppId", 3537 "Ttl", 3538 "SessionId", 3539 "ChallengeCode" 3540 ] 3541 }, 3542 "GetTokenResponse": { 3543 "type": "structure", 3544 "members": { 3545 "AppId": { 3546 "shape": "__string", 3547 "locationName": "appId", 3548 "documentation": "<p>The app ID.</p>" 3549 }, 3550 "ChallengeCode": { 3551 "shape": "__string", 3552 "locationName": "challengeCode", 3553 "documentation": "<p>The one-time challenge code for authenticating into the Amplify Admin UI.</p>" 3554 }, 3555 "SessionId": { 3556 "shape": "__string", 3557 "locationName": "sessionId", 3558 "documentation": "<p>A unique ID provided when creating a new challenge token.</p>" 3559 }, 3560 "Ttl": { 3561 "shape": "__string", 3562 "locationName": "ttl", 3563 "documentation": "<p>The expiry time for the one-time generated token code.</p>" 3564 } 3565 } 3566 }, 3567 "ImportBackendAuthReqObj": { 3568 "type": "structure", 3569 "members": { 3570 "IdentityPoolId": { 3571 "shape": "__string", 3572 "locationName": "identityPoolId", 3573 "documentation": "<p>The ID of the Amazon Cognito identity pool.</p>" 3574 }, 3575 "NativeClientId": { 3576 "shape": "__string", 3577 "locationName": "nativeClientId", 3578 "documentation": "<p>The ID of the Amazon Cognito native client.</p>" 3579 }, 3580 "UserPoolId": { 3581 "shape": "__string", 3582 "locationName": "userPoolId", 3583 "documentation": "<p>The ID of the Amazon Cognito user pool.</p>" 3584 }, 3585 "WebClientId": { 3586 "shape": "__string", 3587 "locationName": "webClientId", 3588 "documentation": "<p>The ID of the Amazon Cognito web client.</p>" 3589 } 3590 }, 3591 "documentation": "<p>The request object for this operation.</p>", 3592 "required": [ 3593 "UserPoolId", 3594 "NativeClientId", 3595 "WebClientId" 3596 ] 3597 }, 3598 "ImportBackendAuthRequest": { 3599 "type": "structure", 3600 "members": { 3601 "AppId": { 3602 "shape": "__string", 3603 "location": "uri", 3604 "locationName": "appId", 3605 "documentation": "<p>The app ID.</p>" 3606 }, 3607 "BackendEnvironmentName": { 3608 "shape": "__string", 3609 "location": "uri", 3610 "locationName": "backendEnvironmentName", 3611 "documentation": "<p>The name of the backend environment.</p>" 3612 }, 3613 "IdentityPoolId": { 3614 "shape": "__string", 3615 "locationName": "identityPoolId", 3616 "documentation": "<p>The ID of the Amazon Cognito identity pool.</p>" 3617 }, 3618 "NativeClientId": { 3619 "shape": "__string", 3620 "locationName": "nativeClientId", 3621 "documentation": "<p>The ID of the Amazon Cognito native client.</p>" 3622 }, 3623 "UserPoolId": { 3624 "shape": "__string", 3625 "locationName": "userPoolId", 3626 "documentation": "<p>The ID of the Amazon Cognito user pool.</p>" 3627 }, 3628 "WebClientId": { 3629 "shape": "__string", 3630 "locationName": "webClientId", 3631 "documentation": "<p>The ID of the Amazon Cognito web client.</p>" 3632 } 3633 }, 3634 "documentation": "<p>The request body for ImportBackendAuth.</p>", 3635 "required": [ 3636 "AppId", 3637 "BackendEnvironmentName", 3638 "UserPoolId", 3639 "NativeClientId", 3640 "WebClientId" 3641 ] 3642 }, 3643 "ImportBackendAuthResponse": { 3644 "type": "structure", 3645 "members": { 3646 "AppId": { 3647 "shape": "__string", 3648 "locationName": "appId", 3649 "documentation": "<p>The app ID.</p>" 3650 }, 3651 "BackendEnvironmentName": { 3652 "shape": "__string", 3653 "locationName": "backendEnvironmentName", 3654 "documentation": "<p>The name of the backend environment.</p>" 3655 }, 3656 "Error": { 3657 "shape": "__string", 3658 "locationName": "error", 3659 "documentation": "<p>If the request fails, this error is returned.</p>" 3660 }, 3661 "JobId": { 3662 "shape": "__string", 3663 "locationName": "jobId", 3664 "documentation": "<p>The ID for the job.</p>" 3665 }, 3666 "Operation": { 3667 "shape": "__string", 3668 "locationName": "operation", 3669 "documentation": "<p>The name of the operation.</p>" 3670 }, 3671 "Status": { 3672 "shape": "__string", 3673 "locationName": "status", 3674 "documentation": "<p>The current status of the request.</p>" 3675 } 3676 } 3677 }, 3678 "ImportBackendStorageReqObj": { 3679 "type": "structure", 3680 "members": { 3681 "BucketName": { 3682 "shape": "__string", 3683 "locationName": "bucketName", 3684 "documentation": "<p>The name of the S3 bucket.</p>" 3685 }, 3686 "ServiceName": { 3687 "shape": "ServiceName", 3688 "locationName": "serviceName", 3689 "documentation": "<p>The name of the storage service.</p>" 3690 } 3691 }, 3692 "documentation": "<p>The request object for this operation.</p>", 3693 "required": [ 3694 "ServiceName" 3695 ] 3696 }, 3697 "ImportBackendStorageRequest": { 3698 "type": "structure", 3699 "members": { 3700 "AppId": { 3701 "shape": "__string", 3702 "location": "uri", 3703 "locationName": "appId", 3704 "documentation": "<p>The app ID.</p>" 3705 }, 3706 "BackendEnvironmentName": { 3707 "shape": "__string", 3708 "location": "uri", 3709 "locationName": "backendEnvironmentName", 3710 "documentation": "<p>The name of the backend environment.</p>" 3711 }, 3712 "BucketName": { 3713 "shape": "__string", 3714 "locationName": "bucketName", 3715 "documentation": "<p>The name of the S3 bucket.</p>" 3716 }, 3717 "ServiceName": { 3718 "shape": "ServiceName", 3719 "locationName": "serviceName", 3720 "documentation": "<p>The name of the storage service.</p>" 3721 } 3722 }, 3723 "documentation": "<p>The request body for ImportBackendStorage.</p>", 3724 "required": [ 3725 "AppId", 3726 "BackendEnvironmentName", 3727 "ServiceName" 3728 ] 3729 }, 3730 "ImportBackendStorageResponse": { 3731 "type": "structure", 3732 "members": { 3733 "AppId": { 3734 "shape": "__string", 3735 "locationName": "appId", 3736 "documentation": "<p>The app ID.</p>" 3737 }, 3738 "BackendEnvironmentName": { 3739 "shape": "__string", 3740 "locationName": "backendEnvironmentName", 3741 "documentation": "<p>The name of the backend environment.</p>" 3742 }, 3743 "JobId": { 3744 "shape": "__string", 3745 "locationName": "jobId", 3746 "documentation": "<p>The ID for the job.</p>" 3747 }, 3748 "Status": { 3749 "shape": "__string", 3750 "locationName": "status", 3751 "documentation": "<p>The current status of the request.</p>" 3752 } 3753 } 3754 }, 3755 "InternalServiceException": { 3756 "type": "structure", 3757 "members": { 3758 "Message": { 3759 "shape": "__string", 3760 "locationName": "message", 3761 "documentation": "<p>An error message to inform that the request failed.</p>" 3762 } 3763 }, 3764 "documentation": "<p>An error returned if there's a temporary issue with the service.</p>" 3765 }, 3766 "LimitExceededException": { 3767 "type": "structure", 3768 "members": { 3769 "LimitType": { 3770 "shape": "__string", 3771 "locationName": "limitType", 3772 "documentation": "<p>The type of limit that was exceeded.</p>" 3773 }, 3774 "Message": { 3775 "shape": "__string", 3776 "locationName": "message", 3777 "documentation": "<p>An error message to inform that the request has failed.</p>" 3778 } 3779 }, 3780 "documentation": "<p>An error that is returned when a limit of a specific type has been exceeded.</p>" 3781 }, 3782 "ListBackendJobReqObj": { 3783 "type": "structure", 3784 "members": { 3785 "JobId": { 3786 "shape": "__string", 3787 "locationName": "jobId", 3788 "documentation": "<p>The ID for the job.</p>" 3789 }, 3790 "MaxResults": { 3791 "shape": "__integerMin1Max25", 3792 "locationName": "maxResults", 3793 "documentation": "<p>The maximum number of results that you want in the response.</p>" 3794 }, 3795 "NextToken": { 3796 "shape": "__string", 3797 "locationName": "nextToken", 3798 "documentation": "<p>The token for the next set of results.</p>" 3799 }, 3800 "Operation": { 3801 "shape": "__string", 3802 "locationName": "operation", 3803 "documentation": "<p>Filters the list of response objects to include only those with the specified operation name.</p>" 3804 }, 3805 "Status": { 3806 "shape": "__string", 3807 "locationName": "status", 3808 "documentation": "<p>Filters the list of response objects to include only those with the specified status.</p>" 3809 } 3810 }, 3811 "documentation": "<p>The request object for this operation.</p>" 3812 }, 3813 "ListBackendJobRespObj": { 3814 "type": "structure", 3815 "members": { 3816 "Jobs": { 3817 "shape": "ListOfBackendJobRespObj", 3818 "locationName": "jobs", 3819 "documentation": "<p>An array of jobs and their properties.</p>" 3820 }, 3821 "NextToken": { 3822 "shape": "__string", 3823 "locationName": "nextToken", 3824 "documentation": "<p>The token for the next set of results.</p>" 3825 } 3826 }, 3827 "documentation": "<p>The returned list of backend jobs.</p>" 3828 }, 3829 "ListBackendJobsRequest": { 3830 "type": "structure", 3831 "members": { 3832 "AppId": { 3833 "shape": "__string", 3834 "location": "uri", 3835 "locationName": "appId", 3836 "documentation": "<p>The app ID.</p>" 3837 }, 3838 "BackendEnvironmentName": { 3839 "shape": "__string", 3840 "location": "uri", 3841 "locationName": "backendEnvironmentName", 3842 "documentation": "<p>The name of the backend environment.</p>" 3843 }, 3844 "JobId": { 3845 "shape": "__string", 3846 "locationName": "jobId", 3847 "documentation": "<p>The ID for the job.</p>" 3848 }, 3849 "MaxResults": { 3850 "shape": "__integerMin1Max25", 3851 "locationName": "maxResults", 3852 "documentation": "<p>The maximum number of results that you want in the response.</p>" 3853 }, 3854 "NextToken": { 3855 "shape": "__string", 3856 "locationName": "nextToken", 3857 "documentation": "<p>The token for the next set of results.</p>" 3858 }, 3859 "Operation": { 3860 "shape": "__string", 3861 "locationName": "operation", 3862 "documentation": "<p>Filters the list of response objects to include only those with the specified operation name.</p>" 3863 }, 3864 "Status": { 3865 "shape": "__string", 3866 "locationName": "status", 3867 "documentation": "<p>Filters the list of response objects to include only those with the specified status.</p>" 3868 } 3869 }, 3870 "documentation": "<p>The request body for ListBackendJobs.</p>", 3871 "required": [ 3872 "AppId", 3873 "BackendEnvironmentName" 3874 ] 3875 }, 3876 "ListBackendJobsResponse": { 3877 "type": "structure", 3878 "members": { 3879 "Jobs": { 3880 "shape": "ListOfBackendJobRespObj", 3881 "locationName": "jobs", 3882 "documentation": "<p>An array of jobs and their properties.</p>" 3883 }, 3884 "NextToken": { 3885 "shape": "__string", 3886 "locationName": "nextToken", 3887 "documentation": "<p>The token for the next set of results.</p>" 3888 } 3889 } 3890 }, 3891 "ListS3BucketsReqObj": { 3892 "type": "structure", 3893 "members": { 3894 "NextToken": { 3895 "shape": "__string", 3896 "locationName": "nextToken", 3897 "documentation": "<p>Reserved for future use.</p>" 3898 } 3899 }, 3900 "documentation": "<p>The request object for this operation.</p>" 3901 }, 3902 "ListS3BucketsRequest": { 3903 "type": "structure", 3904 "members": { 3905 "NextToken": { 3906 "shape": "__string", 3907 "locationName": "nextToken", 3908 "documentation": "<p>Reserved for future use.</p>" 3909 } 3910 }, 3911 "documentation": "<p>The request body for S3Buckets.</p>" 3912 }, 3913 "ListS3BucketsRespObj": { 3914 "type": "structure", 3915 "members": { 3916 "Buckets": { 3917 "shape": "ListOfS3BucketInfo", 3918 "locationName": "buckets", 3919 "documentation": "<p>The list of S3 buckets.</p>" 3920 }, 3921 "NextToken": { 3922 "shape": "__string", 3923 "locationName": "nextToken", 3924 "documentation": "<p>Reserved for future use.</p>" 3925 } 3926 }, 3927 "documentation": "<p>The response object for this operation.</p>", 3928 "required": [ 3929 "Buckets" 3930 ] 3931 }, 3932 "ListS3BucketsResponse": { 3933 "type": "structure", 3934 "members": { 3935 "Buckets": { 3936 "shape": "ListOfS3BucketInfo", 3937 "locationName": "buckets", 3938 "documentation": "<p>The list of S3 buckets.</p>" 3939 }, 3940 "NextToken": { 3941 "shape": "__string", 3942 "locationName": "nextToken", 3943 "documentation": "<p>Reserved for future use.</p>" 3944 } 3945 } 3946 }, 3947 "LoginAuthConfigReqObj": { 3948 "type": "structure", 3949 "members": { 3950 "AwsCognitoIdentityPoolId": { 3951 "shape": "__string", 3952 "locationName": "aws_cognito_identity_pool_id", 3953 "documentation": "<p>The Amazon Cognito identity pool ID used for the Amplify Admin UI login authorization.</p>" 3954 }, 3955 "AwsCognitoRegion": { 3956 "shape": "__string", 3957 "locationName": "aws_cognito_region", 3958 "documentation": "<p>The AWS Region for the Amplify Admin UI login.</p>" 3959 }, 3960 "AwsUserPoolsId": { 3961 "shape": "__string", 3962 "locationName": "aws_user_pools_id", 3963 "documentation": "<p>The Amazon Cognito user pool ID used for Amplify Admin UI login authentication.</p>" 3964 }, 3965 "AwsUserPoolsWebClientId": { 3966 "shape": "__string", 3967 "locationName": "aws_user_pools_web_client_id", 3968 "documentation": "<p>The web client ID for the Amazon Cognito user pools.</p>" 3969 } 3970 }, 3971 "documentation": "<p>The request object for this operation.</p>" 3972 }, 3973 "MFAMode": { 3974 "type": "string", 3975 "enum": [ 3976 "ON", 3977 "OFF", 3978 "OPTIONAL" 3979 ] 3980 }, 3981 "Mode": { 3982 "type": "string", 3983 "enum": [ 3984 "API_KEY", 3985 "AWS_IAM", 3986 "AMAZON_COGNITO_USER_POOLS", 3987 "OPENID_CONNECT" 3988 ] 3989 }, 3990 "NotFoundException": { 3991 "type": "structure", 3992 "members": { 3993 "Message": { 3994 "shape": "__string", 3995 "locationName": "message", 3996 "documentation": "<p>An error message to inform that the request has failed.</p>" 3997 }, 3998 "ResourceType": { 3999 "shape": "__string", 4000 "locationName": "resourceType", 4001 "documentation": "<p>The type of resource that is not found.</p>" 4002 } 4003 }, 4004 "documentation": "<p>An error returned when a specific resource type is not found.</p>", 4005 "exception": true, 4006 "error": { 4007 "httpStatusCode": 404 4008 } 4009 }, 4010 "OAuthGrantType": { 4011 "type": "string", 4012 "enum": [ 4013 "CODE", 4014 "IMPLICIT" 4015 ] 4016 }, 4017 "RemoveAllBackendsReqObj": { 4018 "type": "structure", 4019 "members": { 4020 "CleanAmplifyApp": { 4021 "shape": "__boolean", 4022 "locationName": "cleanAmplifyApp", 4023 "documentation": "<p>Cleans up the Amplify Console app if this value is set to true.</p>" 4024 } 4025 }, 4026 "documentation": "<p>The request object for this operation.</p>" 4027 }, 4028 "RemoveAllBackendsRequest": { 4029 "type": "structure", 4030 "members": { 4031 "AppId": { 4032 "shape": "__string", 4033 "location": "uri", 4034 "locationName": "appId", 4035 "documentation": "<p>The app ID.</p>" 4036 }, 4037 "CleanAmplifyApp": { 4038 "shape": "__boolean", 4039 "locationName": "cleanAmplifyApp", 4040 "documentation": "<p>Cleans up the Amplify Console app if this value is set to true.</p>" 4041 } 4042 }, 4043 "documentation": "<p>The request body for RemoveAllBackends.</p>", 4044 "required": [ 4045 "AppId" 4046 ] 4047 }, 4048 "RemoveAllBackendsRespObj": { 4049 "type": "structure", 4050 "members": { 4051 "AppId": { 4052 "shape": "__string", 4053 "locationName": "appId", 4054 "documentation": "<p>The app ID.</p>" 4055 }, 4056 "Error": { 4057 "shape": "__string", 4058 "locationName": "error", 4059 "documentation": "<p>If the request fails, this error is returned.</p>" 4060 }, 4061 "JobId": { 4062 "shape": "__string", 4063 "locationName": "jobId", 4064 "documentation": "<p>The ID for the job.</p>" 4065 }, 4066 "Operation": { 4067 "shape": "__string", 4068 "locationName": "operation", 4069 "documentation": "<p>The name of the operation.</p>" 4070 }, 4071 "Status": { 4072 "shape": "__string", 4073 "locationName": "status", 4074 "documentation": "<p>The current status of the request.</p>" 4075 } 4076 }, 4077 "documentation": "<p>The response object for this operation.</p>", 4078 "required": [ 4079 "AppId" 4080 ] 4081 }, 4082 "RemoveAllBackendsResponse": { 4083 "type": "structure", 4084 "members": { 4085 "AppId": { 4086 "shape": "__string", 4087 "locationName": "appId", 4088 "documentation": "<p>The app ID.</p>" 4089 }, 4090 "Error": { 4091 "shape": "__string", 4092 "locationName": "error", 4093 "documentation": "<p>If the request fails, this error is returned.</p>" 4094 }, 4095 "JobId": { 4096 "shape": "__string", 4097 "locationName": "jobId", 4098 "documentation": "<p>The ID for the job.</p>" 4099 }, 4100 "Operation": { 4101 "shape": "__string", 4102 "locationName": "operation", 4103 "documentation": "<p>The name of the operation.</p>" 4104 }, 4105 "Status": { 4106 "shape": "__string", 4107 "locationName": "status", 4108 "documentation": "<p>The current status of the request.</p>" 4109 } 4110 } 4111 }, 4112 "RemoveBackendAuthReqObj": { 4113 "type": "structure", 4114 "members": { 4115 "ResourceName": { 4116 "shape": "__string", 4117 "locationName": "resourceName", 4118 "documentation": "<p>The name of this resource.</p>" 4119 } 4120 }, 4121 "documentation": "<p>The request object for this operation.</p>", 4122 "required": [ 4123 "ResourceName" 4124 ] 4125 }, 4126 "RemoveBackendConfigRequest": { 4127 "type": "structure", 4128 "members": { 4129 "AppId": { 4130 "shape": "__string", 4131 "location": "uri", 4132 "locationName": "appId", 4133 "documentation": "<p>The app ID.</p>" 4134 } 4135 }, 4136 "required": [ 4137 "AppId" 4138 ] 4139 }, 4140 "RemoveBackendConfigRespObj": { 4141 "type": "structure", 4142 "members": { 4143 "Error": { 4144 "shape": "__string", 4145 "locationName": "error", 4146 "documentation": "<p>If the request fails, this error is returned.</p>" 4147 } 4148 }, 4149 "documentation": "<p>The response object for this operation.</p>" 4150 }, 4151 "RemoveBackendConfigResponse": { 4152 "type": "structure", 4153 "members": { 4154 "Error": { 4155 "shape": "__string", 4156 "locationName": "error", 4157 "documentation": "<p>If the request fails, this error is returned.</p>" 4158 } 4159 } 4160 }, 4161 "RemoveBackendStorageReqObj": { 4162 "type": "structure", 4163 "members": { 4164 "ResourceName": { 4165 "shape": "__string", 4166 "locationName": "resourceName", 4167 "documentation": "<p>The name of the storage resource.</p>" 4168 }, 4169 "ServiceName": { 4170 "shape": "ServiceName", 4171 "locationName": "serviceName", 4172 "documentation": "<p>The name of the storage service.</p>" 4173 } 4174 }, 4175 "documentation": "<p>The request object for this operation.</p>", 4176 "required": [ 4177 "ServiceName", 4178 "ResourceName" 4179 ] 4180 }, 4181 "ResolutionStrategy": { 4182 "type": "string", 4183 "enum": [ 4184 "OPTIMISTIC_CONCURRENCY", 4185 "LAMBDA", 4186 "AUTOMERGE", 4187 "NONE" 4188 ] 4189 }, 4190 "ResourceConfig": { 4191 "type": "structure", 4192 "members": {}, 4193 "documentation": "<p>Defines the resource configuration for the data model in your Amplify project.</p>" 4194 }, 4195 "S3BucketInfo": { 4196 "type": "structure", 4197 "members": { 4198 "CreationDate": { 4199 "shape": "__string", 4200 "locationName": "creationDate", 4201 "documentation": "<p>The creation date of the S3 bucket.</p>" 4202 }, 4203 "Name": { 4204 "shape": "__string", 4205 "locationName": "name", 4206 "documentation": "<p>The name of the S3 bucket.</p>" 4207 } 4208 }, 4209 "documentation": "<p>Describes the metadata of the S3 bucket.</p>" 4210 }, 4211 "Service": { 4212 "type": "string", 4213 "enum": [ 4214 "COGNITO" 4215 ] 4216 }, 4217 "ServiceName": { 4218 "type": "string", 4219 "enum": [ 4220 "S3" 4221 ] 4222 }, 4223 "Settings": { 4224 "type": "structure", 4225 "members": { 4226 "MfaTypes": { 4227 "shape": "ListOfMfaTypesElement", 4228 "locationName": "mfaTypes", 4229 "documentation": "<p>The supported MFA types.</p>" 4230 }, 4231 "SmsMessage": { 4232 "shape": "__string", 4233 "locationName": "smsMessage", 4234 "documentation": "<p>The body of the SMS message.</p>" 4235 } 4236 }, 4237 "documentation": "<p>The settings of your MFA configuration for the backend of your Amplify project.</p>" 4238 }, 4239 "SignInMethod": { 4240 "type": "string", 4241 "enum": [ 4242 "EMAIL", 4243 "EMAIL_AND_PHONE_NUMBER", 4244 "PHONE_NUMBER", 4245 "USERNAME" 4246 ] 4247 }, 4248 "SmsSettings": { 4249 "type": "structure", 4250 "sensitive": true, 4251 "members": { 4252 "SmsMessage": { 4253 "shape": "__string", 4254 "locationName": "smsMessage", 4255 "documentation": "<p>The contents of the SMS message.</p>" 4256 } 4257 }, 4258 "documentation": "<p>SMS settings for authentication.</p>" 4259 }, 4260 "SocialProviderSettings": { 4261 "type": "structure", 4262 "members": { 4263 "Facebook": { 4264 "shape": "BackendAuthSocialProviderConfig" 4265 }, 4266 "Google": { 4267 "shape": "BackendAuthSocialProviderConfig" 4268 }, 4269 "LoginWithAmazon": { 4270 "shape": "BackendAuthSocialProviderConfig" 4271 }, 4272 "SignInWithApple": { 4273 "shape": "BackendAuthAppleProviderConfig" 4274 } 4275 }, 4276 "documentation": "<p>The settings for using the social identity providers for access to your Amplify app.</p>" 4277 }, 4278 "Status": { 4279 "type": "string", 4280 "enum": [ 4281 "LATEST", 4282 "STALE" 4283 ] 4284 }, 4285 "TooManyRequestsException": { 4286 "type": "structure", 4287 "members": { 4288 "LimitType": { 4289 "shape": "__string", 4290 "locationName": "limitType", 4291 "documentation": "<p>The type of limit that was exceeded.</p>" 4292 }, 4293 "Message": { 4294 "shape": "__string", 4295 "locationName": "message", 4296 "documentation": "<p>An error message to inform that the request has failed.</p>" 4297 } 4298 }, 4299 "documentation": "<p>An error that is returned when a limit of a specific type has been exceeded.</p>", 4300 "exception": true, 4301 "error": { 4302 "httpStatusCode": 429 4303 } 4304 }, 4305 "UpdateBackendAPIRequest": { 4306 "type": "structure", 4307 "members": { 4308 "AppId": { 4309 "shape": "__string", 4310 "location": "uri", 4311 "locationName": "appId", 4312 "documentation": "<p>The app ID.</p>" 4313 }, 4314 "BackendEnvironmentName": { 4315 "shape": "__string", 4316 "location": "uri", 4317 "locationName": "backendEnvironmentName", 4318 "documentation": "<p>The name of the backend environment.</p>" 4319 }, 4320 "ResourceConfig": { 4321 "shape": "BackendAPIResourceConfig", 4322 "locationName": "resourceConfig", 4323 "documentation": "<p>Defines the resource configuration for the data model in your Amplify project.</p>" 4324 }, 4325 "ResourceName": { 4326 "shape": "__string", 4327 "locationName": "resourceName", 4328 "documentation": "<p>The name of this resource.</p>" 4329 } 4330 }, 4331 "documentation": "<p>The request body for UpdateBackendAPI.</p>", 4332 "required": [ 4333 "AppId", 4334 "BackendEnvironmentName", 4335 "ResourceName" 4336 ] 4337 }, 4338 "UpdateBackendAPIResponse": { 4339 "type": "structure", 4340 "members": { 4341 "AppId": { 4342 "shape": "__string", 4343 "locationName": "appId", 4344 "documentation": "<p>The app ID.</p>" 4345 }, 4346 "BackendEnvironmentName": { 4347 "shape": "__string", 4348 "locationName": "backendEnvironmentName", 4349 "documentation": "<p>The name of the backend environment.</p>" 4350 }, 4351 "Error": { 4352 "shape": "__string", 4353 "locationName": "error", 4354 "documentation": "<p>If the request fails, this error is returned.</p>" 4355 }, 4356 "JobId": { 4357 "shape": "__string", 4358 "locationName": "jobId", 4359 "documentation": "<p>The ID for the job.</p>" 4360 }, 4361 "Operation": { 4362 "shape": "__string", 4363 "locationName": "operation", 4364 "documentation": "<p>The name of the operation.</p>" 4365 }, 4366 "Status": { 4367 "shape": "__string", 4368 "locationName": "status", 4369 "documentation": "<p>The current status of the request.</p>" 4370 } 4371 } 4372 }, 4373 "UpdateBackendAuthForgotPasswordConfig": { 4374 "type": "structure", 4375 "members": { 4376 "DeliveryMethod": { 4377 "shape": "DeliveryMethod", 4378 "locationName": "deliveryMethod", 4379 "documentation": "<p><b>(DEPRECATED)</b> Describes which mode to use (either SMS or email) to deliver messages to app users that want to recover their password.</p>" 4380 }, 4381 "EmailSettings": { 4382 "shape": "EmailSettings", 4383 "locationName": "emailSettings", 4384 "documentation": "<p><b>(DEPRECATED)</b> The configuration for the email sent when an app user forgets their password.</p>" 4385 }, 4386 "SmsSettings": { 4387 "shape": "SmsSettings", 4388 "locationName": "smsSettings", 4389 "documentation": "<p><b>(DEPRECATED)</b> The configuration for the SMS message sent when an Amplify app user forgets their password.</p>" 4390 } 4391 }, 4392 "documentation": "<p><b>(DEPRECATED)</b> Describes the forgot password policy for authenticating into the Amplify app.</p>" 4393 }, 4394 "UpdateBackendAuthIdentityPoolConfig": { 4395 "type": "structure", 4396 "members": { 4397 "UnauthenticatedLogin": { 4398 "shape": "__boolean", 4399 "locationName": "unauthenticatedLogin", 4400 "documentation": "<p>A boolean value that can be set to allow or disallow guest-level authorization into your Amplify app.</p>" 4401 } 4402 }, 4403 "documentation": "<p>Describes the authorization configuration for the Amazon Cognito identity pool, provisioned as a part of your auth resource in the Amplify project.</p>" 4404 }, 4405 "UpdateBackendAuthMFAConfig": { 4406 "type": "structure", 4407 "members": { 4408 "MFAMode": { 4409 "shape": "MFAMode", 4410 "documentation": "<p>The MFA mode for the backend of your Amplify project.</p>" 4411 }, 4412 "Settings": { 4413 "shape": "Settings", 4414 "locationName": "settings", 4415 "documentation": "<p>The settings of your MFA configuration for the backend of your Amplify project.</p>" 4416 } 4417 }, 4418 "documentation": "<p>Updates the multi-factor authentication (MFA) configuration for the backend of your Amplify project.</p>" 4419 }, 4420 "UpdateBackendAuthOAuthConfig": { 4421 "type": "structure", 4422 "members": { 4423 "DomainPrefix": { 4424 "shape": "__string", 4425 "locationName": "domainPrefix", 4426 "documentation": "<p>The Amazon Cognito domain prefix used to create a hosted UI for authentication.</p>" 4427 }, 4428 "OAuthGrantType": { 4429 "shape": "OAuthGrantType", 4430 "locationName": "oAuthGrantType", 4431 "documentation": "<p>The OAuth grant type to allow app users to authenticate from your Amplify app.</p>" 4432 }, 4433 "OAuthScopes": { 4434 "shape": "ListOfOAuthScopesElement", 4435 "locationName": "oAuthScopes", 4436 "documentation": "<p>The list of OAuth-related flows that can allow users to authenticate from your Amplify app.</p>" 4437 }, 4438 "RedirectSignInURIs": { 4439 "shape": "ListOf__string", 4440 "locationName": "redirectSignInURIs", 4441 "documentation": "<p>Redirect URLs that OAuth uses when a user signs in to an Amplify app.</p>" 4442 }, 4443 "RedirectSignOutURIs": { 4444 "shape": "ListOf__string", 4445 "locationName": "redirectSignOutURIs", 4446 "documentation": "<p>Redirect URLs that OAuth uses when a user signs out of an Amplify app.</p>" 4447 }, 4448 "SocialProviderSettings": { 4449 "shape": "SocialProviderSettings", 4450 "locationName": "socialProviderSettings", 4451 "documentation": "<p>Describes third-party social federation configurations for allowing your users to sign in with OAuth.</p>" 4452 } 4453 }, 4454 "documentation": "<p>The OAuth configurations for authenticating users into your Amplify app.</p>" 4455 }, 4456 "UpdateBackendAuthPasswordPolicyConfig": { 4457 "type": "structure", 4458 "members": { 4459 "AdditionalConstraints": { 4460 "shape": "ListOfAdditionalConstraintsElement", 4461 "locationName": "additionalConstraints", 4462 "documentation": "<p>Describes additional constraints on password requirements to sign in to the auth resource, configured as a part of your Amplify project.</p>" 4463 }, 4464 "MinimumLength": { 4465 "shape": "__double", 4466 "locationName": "minimumLength", 4467 "documentation": "<p>Describes the minimum length of the password required to sign in to the auth resource, configured as a part of your Amplify project.</p>" 4468 } 4469 }, 4470 "documentation": "<p>Describes the password policy for your Amazon Cognito user pool configured as a part of your Amplify project.</p>" 4471 }, 4472 "UpdateBackendAuthReqObj": { 4473 "type": "structure", 4474 "members": { 4475 "ResourceConfig": { 4476 "shape": "UpdateBackendAuthResourceConfig", 4477 "locationName": "resourceConfig", 4478 "documentation": "<p>The resource configuration for this request object.</p>" 4479 }, 4480 "ResourceName": { 4481 "shape": "__string", 4482 "locationName": "resourceName", 4483 "documentation": "<p>The name of this resource.</p>" 4484 } 4485 }, 4486 "documentation": "<p>The request object for this operation.</p>", 4487 "required": [ 4488 "ResourceName", 4489 "ResourceConfig" 4490 ] 4491 }, 4492 "UpdateBackendAuthRequest": { 4493 "type": "structure", 4494 "members": { 4495 "AppId": { 4496 "shape": "__string", 4497 "location": "uri", 4498 "locationName": "appId", 4499 "documentation": "<p>The app ID.</p>" 4500 }, 4501 "BackendEnvironmentName": { 4502 "shape": "__string", 4503 "location": "uri", 4504 "locationName": "backendEnvironmentName", 4505 "documentation": "<p>The name of the backend environment.</p>" 4506 }, 4507 "ResourceConfig": { 4508 "shape": "UpdateBackendAuthResourceConfig", 4509 "locationName": "resourceConfig", 4510 "documentation": "<p>The resource configuration for this request object.</p>" 4511 }, 4512 "ResourceName": { 4513 "shape": "__string", 4514 "locationName": "resourceName", 4515 "documentation": "<p>The name of this resource.</p>" 4516 } 4517 }, 4518 "documentation": "<p>The request body for UpdateBackendAuth.</p>", 4519 "required": [ 4520 "AppId", 4521 "BackendEnvironmentName", 4522 "ResourceName", 4523 "ResourceConfig" 4524 ] 4525 }, 4526 "UpdateBackendAuthResourceConfig": { 4527 "type": "structure", 4528 "members": { 4529 "AuthResources": { 4530 "shape": "AuthResources", 4531 "locationName": "authResources", 4532 "documentation": "<p>Defines the service name to use when configuring an authentication resource in your Amplify project.</p>" 4533 }, 4534 "IdentityPoolConfigs": { 4535 "shape": "UpdateBackendAuthIdentityPoolConfig", 4536 "locationName": "identityPoolConfigs", 4537 "documentation": "<p>Describes the authorization configuration for the Amazon Cognito identity pool, provisioned as a part of your auth resource in the Amplify project.</p>" 4538 }, 4539 "Service": { 4540 "shape": "Service", 4541 "locationName": "service", 4542 "documentation": "<p>Defines the service name to use when configuring an authentication resource in your Amplify project.</p>" 4543 }, 4544 "UserPoolConfigs": { 4545 "shape": "UpdateBackendAuthUserPoolConfig", 4546 "locationName": "userPoolConfigs", 4547 "documentation": "<p>Describes the authentication configuration for the Amazon Cognito user pool, provisioned as a part of your auth resource in the Amplify project.</p>" 4548 } 4549 }, 4550 "documentation": "<p>Defines the resource configuration when updating an authentication resource in your Amplify project.</p>", 4551 "required": [ 4552 "AuthResources", 4553 "UserPoolConfigs", 4554 "Service" 4555 ] 4556 }, 4557 "UpdateBackendAuthResponse": { 4558 "type": "structure", 4559 "members": { 4560 "AppId": { 4561 "shape": "__string", 4562 "locationName": "appId", 4563 "documentation": "<p>The app ID.</p>" 4564 }, 4565 "BackendEnvironmentName": { 4566 "shape": "__string", 4567 "locationName": "backendEnvironmentName", 4568 "documentation": "<p>The name of the backend environment.</p>" 4569 }, 4570 "Error": { 4571 "shape": "__string", 4572 "locationName": "error", 4573 "documentation": "<p>If the request fails, this error is returned.</p>" 4574 }, 4575 "JobId": { 4576 "shape": "__string", 4577 "locationName": "jobId", 4578 "documentation": "<p>The ID for the job.</p>" 4579 }, 4580 "Operation": { 4581 "shape": "__string", 4582 "locationName": "operation", 4583 "documentation": "<p>The name of the operation.</p>" 4584 }, 4585 "Status": { 4586 "shape": "__string", 4587 "locationName": "status", 4588 "documentation": "<p>The current status of the request.</p>" 4589 } 4590 } 4591 }, 4592 "UpdateBackendAuthUserPoolConfig": { 4593 "type": "structure", 4594 "members": { 4595 "ForgotPassword": { 4596 "shape": "UpdateBackendAuthForgotPasswordConfig", 4597 "locationName": "forgotPassword", 4598 "documentation": "<p><b>(DEPRECATED)</b> Describes the forgot password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.</p>" 4599 }, 4600 "Mfa": { 4601 "shape": "UpdateBackendAuthMFAConfig", 4602 "locationName": "mfa", 4603 "documentation": "<p>Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.</p>" 4604 }, 4605 "OAuth": { 4606 "shape": "UpdateBackendAuthOAuthConfig", 4607 "locationName": "oAuth", 4608 "documentation": "<p>Describes the OAuth policy and rules for your Amazon Cognito user pool, configured as a part of your Amplify project.</p>" 4609 }, 4610 "PasswordPolicy": { 4611 "shape": "UpdateBackendAuthPasswordPolicyConfig", 4612 "locationName": "passwordPolicy", 4613 "documentation": "<p>Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.</p>" 4614 }, 4615 "VerificationMessage": { 4616 "shape": "UpdateBackendAuthVerificationMessageConfig", 4617 "locationName": "verificationMessage", 4618 "documentation": "<p>Describes the email or SMS verification message for your Amazon Cognito user pool, configured as a part of your Amplify project.</p>" 4619 } 4620 }, 4621 "documentation": "<p>Describes the Amazon Cognito user pool configuration for the authorization resource to be configured for your Amplify project on an update.</p>" 4622 }, 4623 "UpdateBackendAuthVerificationMessageConfig": { 4624 "type": "structure", 4625 "members": { 4626 "DeliveryMethod": { 4627 "shape": "DeliveryMethod", 4628 "locationName": "deliveryMethod", 4629 "documentation": "<p>The type of verification message to send.</p>" 4630 }, 4631 "EmailSettings": { 4632 "shape": "EmailSettings", 4633 "locationName": "emailSettings", 4634 "documentation": "<p>The settings for the email message.</p>" 4635 }, 4636 "SmsSettings": { 4637 "shape": "SmsSettings", 4638 "locationName": "smsSettings", 4639 "documentation": "<p>The settings for the SMS message.</p>" 4640 } 4641 }, 4642 "documentation": "<p>Updates the configuration of the email or SMS message for the auth resource configured for your Amplify project.</p>", 4643 "required": [ 4644 "DeliveryMethod" 4645 ] 4646 }, 4647 "UpdateBackendConfigReqObj": { 4648 "type": "structure", 4649 "members": { 4650 "LoginAuthConfig": { 4651 "shape": "LoginAuthConfigReqObj", 4652 "locationName": "loginAuthConfig", 4653 "documentation": "<p>Describes the Amazon Cognito configuration for Admin UI access.</p>" 4654 } 4655 }, 4656 "documentation": "<p>The request object for this operation.</p>" 4657 }, 4658 "UpdateBackendConfigRequest": { 4659 "type": "structure", 4660 "members": { 4661 "AppId": { 4662 "shape": "__string", 4663 "location": "uri", 4664 "locationName": "appId", 4665 "documentation": "<p>The app ID.</p>" 4666 }, 4667 "LoginAuthConfig": { 4668 "shape": "LoginAuthConfigReqObj", 4669 "locationName": "loginAuthConfig", 4670 "documentation": "<p>Describes the Amazon Cognito configuration for Admin UI access.</p>" 4671 } 4672 }, 4673 "documentation": "<p>The request body for UpdateBackendConfig.</p>", 4674 "required": [ 4675 "AppId" 4676 ] 4677 }, 4678 "UpdateBackendConfigResponse": { 4679 "type": "structure", 4680 "members": { 4681 "AppId": { 4682 "shape": "__string", 4683 "locationName": "appId", 4684 "documentation": "<p>The app ID.</p>" 4685 }, 4686 "BackendManagerAppId": { 4687 "shape": "__string", 4688 "locationName": "backendManagerAppId", 4689 "documentation": "<p>The app ID for the backend manager.</p>" 4690 }, 4691 "Error": { 4692 "shape": "__string", 4693 "locationName": "error", 4694 "documentation": "<p>If the request fails, this error is returned.</p>" 4695 }, 4696 "LoginAuthConfig": { 4697 "shape": "LoginAuthConfigReqObj", 4698 "locationName": "loginAuthConfig", 4699 "documentation": "<p>Describes the Amazon Cognito configurations for the Admin UI auth resource to log in with.</p>" 4700 } 4701 } 4702 }, 4703 "UpdateBackendJobRequest": { 4704 "type": "structure", 4705 "members": { 4706 "AppId": { 4707 "shape": "__string", 4708 "location": "uri", 4709 "locationName": "appId", 4710 "documentation": "<p>The app ID.</p>" 4711 }, 4712 "BackendEnvironmentName": { 4713 "shape": "__string", 4714 "location": "uri", 4715 "locationName": "backendEnvironmentName", 4716 "documentation": "<p>The name of the backend environment.</p>" 4717 }, 4718 "JobId": { 4719 "shape": "__string", 4720 "location": "uri", 4721 "locationName": "jobId", 4722 "documentation": "<p>The ID for the job.</p>" 4723 }, 4724 "Operation": { 4725 "shape": "__string", 4726 "locationName": "operation", 4727 "documentation": "<p>Filters the list of response objects to include only those with the specified operation name.</p>" 4728 }, 4729 "Status": { 4730 "shape": "__string", 4731 "locationName": "status", 4732 "documentation": "<p>Filters the list of response objects to include only those with the specified status.</p>" 4733 } 4734 }, 4735 "documentation": "<p>The request body for GetBackendJob.</p>", 4736 "required": [ 4737 "AppId", 4738 "BackendEnvironmentName", 4739 "JobId" 4740 ] 4741 }, 4742 "UpdateBackendJobResponse": { 4743 "type": "structure", 4744 "members": { 4745 "AppId": { 4746 "shape": "__string", 4747 "locationName": "appId", 4748 "documentation": "<p>The app ID.</p>" 4749 }, 4750 "BackendEnvironmentName": { 4751 "shape": "__string", 4752 "locationName": "backendEnvironmentName", 4753 "documentation": "<p>The name of the backend environment.</p>" 4754 }, 4755 "CreateTime": { 4756 "shape": "__string", 4757 "locationName": "createTime", 4758 "documentation": "<p>The time when the job was created.</p>" 4759 }, 4760 "Error": { 4761 "shape": "__string", 4762 "locationName": "error", 4763 "documentation": "<p>If the request fails, this error is returned.</p>" 4764 }, 4765 "JobId": { 4766 "shape": "__string", 4767 "locationName": "jobId", 4768 "documentation": "<p>The ID for the job.</p>" 4769 }, 4770 "Operation": { 4771 "shape": "__string", 4772 "locationName": "operation", 4773 "documentation": "<p>The name of the operation.</p>" 4774 }, 4775 "Status": { 4776 "shape": "__string", 4777 "locationName": "status", 4778 "documentation": "<p>The current status of the request.</p>" 4779 }, 4780 "UpdateTime": { 4781 "shape": "__string", 4782 "locationName": "updateTime", 4783 "documentation": "<p>The time when the job was last updated.</p>" 4784 } 4785 } 4786 }, 4787 "UpdateBackendStorageReqObj": { 4788 "type": "structure", 4789 "members": { 4790 "ResourceConfig": { 4791 "shape": "UpdateBackendStorageResourceConfig", 4792 "locationName": "resourceConfig", 4793 "documentation": "<p>The resource configuration for updating backend storage.</p>" 4794 }, 4795 "ResourceName": { 4796 "shape": "__string", 4797 "locationName": "resourceName", 4798 "documentation": "<p>The name of the storage resource.</p>" 4799 } 4800 }, 4801 "documentation": "<p>The request object for this operation.</p>", 4802 "required": [ 4803 "ResourceName", 4804 "ResourceConfig" 4805 ] 4806 }, 4807 "UpdateBackendStorageRequest": { 4808 "type": "structure", 4809 "members": { 4810 "AppId": { 4811 "shape": "__string", 4812 "location": "uri", 4813 "locationName": "appId", 4814 "documentation": "<p>The app ID.</p>" 4815 }, 4816 "BackendEnvironmentName": { 4817 "shape": "__string", 4818 "location": "uri", 4819 "locationName": "backendEnvironmentName", 4820 "documentation": "<p>The name of the backend environment.</p>" 4821 }, 4822 "ResourceConfig": { 4823 "shape": "UpdateBackendStorageResourceConfig", 4824 "locationName": "resourceConfig", 4825 "documentation": "<p>The resource configuration for updating backend storage.</p>" 4826 }, 4827 "ResourceName": { 4828 "shape": "__string", 4829 "locationName": "resourceName", 4830 "documentation": "<p>The name of the storage resource.</p>" 4831 } 4832 }, 4833 "documentation": "<p>The request body for UpdateBackendStorage.</p>", 4834 "required": [ 4835 "AppId", 4836 "BackendEnvironmentName", 4837 "ResourceName", 4838 "ResourceConfig" 4839 ] 4840 }, 4841 "UpdateBackendStorageResourceConfig": { 4842 "type": "structure", 4843 "members": { 4844 "Permissions": { 4845 "shape": "BackendStoragePermissions", 4846 "locationName": "permissions", 4847 "documentation": "<p>The authorization configuration for the storage S3 bucket.</p>" 4848 }, 4849 "ServiceName": { 4850 "shape": "ServiceName", 4851 "locationName": "serviceName", 4852 "documentation": "<p>The name of the storage service.</p>" 4853 } 4854 }, 4855 "documentation": "<p>The resource configuration for updating backend storage.</p>", 4856 "required": [ 4857 "ServiceName", 4858 "Permissions" 4859 ] 4860 }, 4861 "UpdateBackendStorageResponse": { 4862 "type": "structure", 4863 "members": { 4864 "AppId": { 4865 "shape": "__string", 4866 "locationName": "appId", 4867 "documentation": "<p>The app ID.</p>" 4868 }, 4869 "BackendEnvironmentName": { 4870 "shape": "__string", 4871 "locationName": "backendEnvironmentName", 4872 "documentation": "<p>The name of the backend environment.</p>" 4873 }, 4874 "JobId": { 4875 "shape": "__string", 4876 "locationName": "jobId", 4877 "documentation": "<p>The ID for the job.</p>" 4878 }, 4879 "Status": { 4880 "shape": "__string", 4881 "locationName": "status", 4882 "documentation": "<p>The current status of the request.</p>" 4883 } 4884 } 4885 }, 4886 "AdditionalConstraintsElement": { 4887 "type": "string", 4888 "enum": [ 4889 "REQUIRE_DIGIT", 4890 "REQUIRE_LOWERCASE", 4891 "REQUIRE_SYMBOL", 4892 "REQUIRE_UPPERCASE" 4893 ] 4894 }, 4895 "AuthenticatedElement": { 4896 "type": "string", 4897 "enum": [ 4898 "READ", 4899 "CREATE_AND_UPDATE", 4900 "DELETE" 4901 ] 4902 }, 4903 "MfaTypesElement": { 4904 "type": "string", 4905 "enum": [ 4906 "SMS", 4907 "TOTP" 4908 ] 4909 }, 4910 "OAuthScopesElement": { 4911 "type": "string", 4912 "enum": [ 4913 "PHONE", 4914 "EMAIL", 4915 "OPENID", 4916 "PROFILE", 4917 "AWS_COGNITO_SIGNIN_USER_ADMIN" 4918 ] 4919 }, 4920 "RequiredSignUpAttributesElement": { 4921 "type": "string", 4922 "enum": [ 4923 "ADDRESS", 4924 "BIRTHDATE", 4925 "EMAIL", 4926 "FAMILY_NAME", 4927 "GENDER", 4928 "GIVEN_NAME", 4929 "LOCALE", 4930 "MIDDLE_NAME", 4931 "NAME", 4932 "NICKNAME", 4933 "PHONE_NUMBER", 4934 "PICTURE", 4935 "PREFERRED_USERNAME", 4936 "PROFILE", 4937 "UPDATED_AT", 4938 "WEBSITE", 4939 "ZONE_INFO" 4940 ] 4941 }, 4942 "UnAuthenticatedElement": { 4943 "type": "string", 4944 "enum": [ 4945 "READ", 4946 "CREATE_AND_UPDATE", 4947 "DELETE" 4948 ] 4949 }, 4950 "__boolean": { 4951 "type": "boolean" 4952 }, 4953 "__double": { 4954 "type": "double" 4955 }, 4956 "__integer": { 4957 "type": "integer" 4958 }, 4959 "__integerMin1Max25": { 4960 "type": "integer", 4961 "min": 1, 4962 "max": 25 4963 }, 4964 "ListOfBackendAPIAuthType": { 4965 "type": "list", 4966 "member": { 4967 "shape": "BackendAPIAuthType" 4968 } 4969 }, 4970 "ListOfBackendJobRespObj": { 4971 "type": "list", 4972 "member": { 4973 "shape": "BackendJobRespObj" 4974 } 4975 }, 4976 "ListOfS3BucketInfo": { 4977 "type": "list", 4978 "member": { 4979 "shape": "S3BucketInfo" 4980 } 4981 }, 4982 "ListOfAdditionalConstraintsElement": { 4983 "type": "list", 4984 "member": { 4985 "shape": "AdditionalConstraintsElement" 4986 } 4987 }, 4988 "ListOfAuthenticatedElement": { 4989 "type": "list", 4990 "member": { 4991 "shape": "AuthenticatedElement" 4992 } 4993 }, 4994 "ListOfMfaTypesElement": { 4995 "type": "list", 4996 "member": { 4997 "shape": "MfaTypesElement" 4998 } 4999 }, 5000 "ListOfOAuthScopesElement": { 5001 "type": "list", 5002 "member": { 5003 "shape": "OAuthScopesElement" 5004 } 5005 }, 5006 "ListOfRequiredSignUpAttributesElement": { 5007 "type": "list", 5008 "member": { 5009 "shape": "RequiredSignUpAttributesElement" 5010 } 5011 }, 5012 "ListOfUnAuthenticatedElement": { 5013 "type": "list", 5014 "member": { 5015 "shape": "UnAuthenticatedElement" 5016 } 5017 }, 5018 "ListOf__string": { 5019 "type": "list", 5020 "member": { 5021 "shape": "__string" 5022 } 5023 }, 5024 "__long": { 5025 "type": "long" 5026 }, 5027 "__string": { 5028 "type": "string" 5029 }, 5030 "__timestampIso8601": { 5031 "type": "timestamp", 5032 "timestampFormat": "iso8601" 5033 }, 5034 "__timestampUnix": { 5035 "type": "timestamp", 5036 "timestampFormat": "unixTimestamp" 5037 } 5038 }, 5039 "documentation": "<p>AWS Amplify Admin API</p>" 5040} 5041