1{ 2 "smithy": "1.0", 3 "metadata": { 4 "suppressions": [ 5 { 6 "id": "HttpMethodSemantics", 7 "namespace": "*" 8 }, 9 { 10 "id": "HttpResponseCodeSemantics", 11 "namespace": "*" 12 }, 13 { 14 "id": "PaginatedTrait", 15 "namespace": "*" 16 }, 17 { 18 "id": "HttpHeaderTrait", 19 "namespace": "*" 20 }, 21 { 22 "id": "HttpUriConflict", 23 "namespace": "*" 24 }, 25 { 26 "id": "Service", 27 "namespace": "*" 28 } 29 ] 30 }, 31 "shapes": { 32 "com.amazonaws.amplify#AccessToken": { 33 "type": "string", 34 "traits": { 35 "smithy.api#length": { 36 "min": 1, 37 "max": 255 38 }, 39 "smithy.api#sensitive": {} 40 } 41 }, 42 "com.amazonaws.amplify#ActiveJobId": { 43 "type": "string", 44 "traits": { 45 "smithy.api#length": { 46 "min": 0, 47 "max": 1000 48 } 49 } 50 }, 51 "com.amazonaws.amplify#Amplify": { 52 "type": "service", 53 "version": "2017-07-25", 54 "operations": [ 55 { 56 "target": "com.amazonaws.amplify#CreateApp" 57 }, 58 { 59 "target": "com.amazonaws.amplify#CreateBackendEnvironment" 60 }, 61 { 62 "target": "com.amazonaws.amplify#CreateBranch" 63 }, 64 { 65 "target": "com.amazonaws.amplify#CreateDeployment" 66 }, 67 { 68 "target": "com.amazonaws.amplify#CreateDomainAssociation" 69 }, 70 { 71 "target": "com.amazonaws.amplify#CreateWebhook" 72 }, 73 { 74 "target": "com.amazonaws.amplify#DeleteApp" 75 }, 76 { 77 "target": "com.amazonaws.amplify#DeleteBackendEnvironment" 78 }, 79 { 80 "target": "com.amazonaws.amplify#DeleteBranch" 81 }, 82 { 83 "target": "com.amazonaws.amplify#DeleteDomainAssociation" 84 }, 85 { 86 "target": "com.amazonaws.amplify#DeleteJob" 87 }, 88 { 89 "target": "com.amazonaws.amplify#DeleteWebhook" 90 }, 91 { 92 "target": "com.amazonaws.amplify#GenerateAccessLogs" 93 }, 94 { 95 "target": "com.amazonaws.amplify#GetApp" 96 }, 97 { 98 "target": "com.amazonaws.amplify#GetArtifactUrl" 99 }, 100 { 101 "target": "com.amazonaws.amplify#GetBackendEnvironment" 102 }, 103 { 104 "target": "com.amazonaws.amplify#GetBranch" 105 }, 106 { 107 "target": "com.amazonaws.amplify#GetDomainAssociation" 108 }, 109 { 110 "target": "com.amazonaws.amplify#GetJob" 111 }, 112 { 113 "target": "com.amazonaws.amplify#GetWebhook" 114 }, 115 { 116 "target": "com.amazonaws.amplify#ListApps" 117 }, 118 { 119 "target": "com.amazonaws.amplify#ListArtifacts" 120 }, 121 { 122 "target": "com.amazonaws.amplify#ListBackendEnvironments" 123 }, 124 { 125 "target": "com.amazonaws.amplify#ListBranches" 126 }, 127 { 128 "target": "com.amazonaws.amplify#ListDomainAssociations" 129 }, 130 { 131 "target": "com.amazonaws.amplify#ListJobs" 132 }, 133 { 134 "target": "com.amazonaws.amplify#ListTagsForResource" 135 }, 136 { 137 "target": "com.amazonaws.amplify#ListWebhooks" 138 }, 139 { 140 "target": "com.amazonaws.amplify#StartDeployment" 141 }, 142 { 143 "target": "com.amazonaws.amplify#StartJob" 144 }, 145 { 146 "target": "com.amazonaws.amplify#StopJob" 147 }, 148 { 149 "target": "com.amazonaws.amplify#TagResource" 150 }, 151 { 152 "target": "com.amazonaws.amplify#UntagResource" 153 }, 154 { 155 "target": "com.amazonaws.amplify#UpdateApp" 156 }, 157 { 158 "target": "com.amazonaws.amplify#UpdateBranch" 159 }, 160 { 161 "target": "com.amazonaws.amplify#UpdateDomainAssociation" 162 }, 163 { 164 "target": "com.amazonaws.amplify#UpdateWebhook" 165 } 166 ], 167 "traits": { 168 "aws.api#service": { 169 "sdkId": "Amplify", 170 "arnNamespace": "amplify", 171 "cloudFormationName": "Amplify", 172 "cloudTrailEventSource": "amplify.amazonaws.com", 173 "endpointPrefix": "amplify" 174 }, 175 "aws.auth#sigv4": { 176 "name": "amplify" 177 }, 178 "aws.protocols#restJson1": {}, 179 "smithy.api#documentation": "<p>Amplify enables developers to develop and deploy cloud-powered mobile and web apps.\n The Amplify Console provides a continuous delivery and hosting service for web\n applications. For more information, see the <a href=\"https://docs.aws.amazon.com/amplify/latest/userguide/welcome.html\">Amplify Console User Guide</a>. The\n Amplify Framework is a comprehensive set of SDKs, libraries, tools, and documentation\n for client app development. For more information, see the <a href=\"https://docs.amplify.aws/\">Amplify Framework.</a>\n </p>", 180 "smithy.api#title": "AWS Amplify", 181 "smithy.api#xmlNamespace": { 182 "uri": "http://amplify.amazonaws.com" 183 } 184 } 185 }, 186 "com.amazonaws.amplify#App": { 187 "type": "structure", 188 "members": { 189 "appId": { 190 "target": "com.amazonaws.amplify#AppId", 191 "traits": { 192 "smithy.api#documentation": "<p> The unique ID of the Amplify app. </p>", 193 "smithy.api#required": {} 194 } 195 }, 196 "appArn": { 197 "target": "com.amazonaws.amplify#AppArn", 198 "traits": { 199 "smithy.api#documentation": "<p> The Amazon Resource Name (ARN) of the Amplify app. </p>", 200 "smithy.api#required": {} 201 } 202 }, 203 "name": { 204 "target": "com.amazonaws.amplify#Name", 205 "traits": { 206 "smithy.api#documentation": "<p> The name for the Amplify app. </p>", 207 "smithy.api#required": {} 208 } 209 }, 210 "tags": { 211 "target": "com.amazonaws.amplify#TagMap", 212 "traits": { 213 "smithy.api#documentation": "<p> The tag for the Amplify app. </p>" 214 } 215 }, 216 "description": { 217 "target": "com.amazonaws.amplify#Description", 218 "traits": { 219 "smithy.api#documentation": "<p> The description for the Amplify app. </p>", 220 "smithy.api#required": {} 221 } 222 }, 223 "repository": { 224 "target": "com.amazonaws.amplify#Repository", 225 "traits": { 226 "smithy.api#documentation": "<p> The repository for the Amplify app. </p>", 227 "smithy.api#required": {} 228 } 229 }, 230 "platform": { 231 "target": "com.amazonaws.amplify#Platform", 232 "traits": { 233 "smithy.api#documentation": "<p> The platform for the Amplify app. </p>", 234 "smithy.api#required": {} 235 } 236 }, 237 "createTime": { 238 "target": "com.amazonaws.amplify#CreateTime", 239 "traits": { 240 "smithy.api#documentation": "<p> Creates a date and time for the Amplify app. </p>", 241 "smithy.api#required": {} 242 } 243 }, 244 "updateTime": { 245 "target": "com.amazonaws.amplify#UpdateTime", 246 "traits": { 247 "smithy.api#documentation": "<p> Updates the date and time for the Amplify app. </p>", 248 "smithy.api#required": {} 249 } 250 }, 251 "iamServiceRoleArn": { 252 "target": "com.amazonaws.amplify#ServiceRoleArn", 253 "traits": { 254 "smithy.api#documentation": "<p> The AWS Identity and Access Management (IAM) service role for the Amazon Resource\n Name (ARN) of the Amplify app. </p>" 255 } 256 }, 257 "environmentVariables": { 258 "target": "com.amazonaws.amplify#EnvironmentVariables", 259 "traits": { 260 "smithy.api#documentation": "<p> The environment variables for the Amplify app. </p>", 261 "smithy.api#required": {} 262 } 263 }, 264 "defaultDomain": { 265 "target": "com.amazonaws.amplify#DefaultDomain", 266 "traits": { 267 "smithy.api#documentation": "<p> The default domain for the Amplify app. </p>", 268 "smithy.api#required": {} 269 } 270 }, 271 "enableBranchAutoBuild": { 272 "target": "com.amazonaws.amplify#EnableBranchAutoBuild", 273 "traits": { 274 "smithy.api#documentation": "<p> Enables the auto-building of branches for the Amplify app. </p>", 275 "smithy.api#required": {} 276 } 277 }, 278 "enableBranchAutoDeletion": { 279 "target": "com.amazonaws.amplify#EnableBranchAutoDeletion", 280 "traits": { 281 "smithy.api#documentation": "<p> Automatically disconnect a branch in the Amplify Console when you delete a branch\n from your Git repository. </p>" 282 } 283 }, 284 "enableBasicAuth": { 285 "target": "com.amazonaws.amplify#EnableBasicAuth", 286 "traits": { 287 "smithy.api#documentation": "<p> Enables basic authorization for the Amplify app's branches. </p>", 288 "smithy.api#required": {} 289 } 290 }, 291 "basicAuthCredentials": { 292 "target": "com.amazonaws.amplify#BasicAuthCredentials", 293 "traits": { 294 "smithy.api#documentation": "<p> The basic authorization credentials for branches for the Amplify app. </p>" 295 } 296 }, 297 "customRules": { 298 "target": "com.amazonaws.amplify#CustomRules", 299 "traits": { 300 "smithy.api#documentation": "<p> Describes the custom redirect and rewrite rules for the Amplify app. </p>" 301 } 302 }, 303 "productionBranch": { 304 "target": "com.amazonaws.amplify#ProductionBranch", 305 "traits": { 306 "smithy.api#documentation": "<p> Describes the information about a production branch of the Amplify app. </p>" 307 } 308 }, 309 "buildSpec": { 310 "target": "com.amazonaws.amplify#BuildSpec", 311 "traits": { 312 "smithy.api#documentation": "<p> Describes the content of the build specification (build spec) for the Amplify app.\n </p>" 313 } 314 }, 315 "customHeaders": { 316 "target": "com.amazonaws.amplify#CustomHeaders", 317 "traits": { 318 "smithy.api#documentation": "<p>Describes the custom HTTP headers for the Amplify app.</p>" 319 } 320 }, 321 "enableAutoBranchCreation": { 322 "target": "com.amazonaws.amplify#EnableAutoBranchCreation", 323 "traits": { 324 "smithy.api#documentation": "<p> Enables automated branch creation for the Amplify app. </p>" 325 } 326 }, 327 "autoBranchCreationPatterns": { 328 "target": "com.amazonaws.amplify#AutoBranchCreationPatterns", 329 "traits": { 330 "smithy.api#documentation": "<p> Describes the automated branch creation glob patterns for the Amplify app. </p>" 331 } 332 }, 333 "autoBranchCreationConfig": { 334 "target": "com.amazonaws.amplify#AutoBranchCreationConfig", 335 "traits": { 336 "smithy.api#documentation": "<p> Describes the automated branch creation configuration for the Amplify app. </p>" 337 } 338 } 339 }, 340 "traits": { 341 "smithy.api#documentation": "<p> Represents the different branches of a repository for building, deploying, and\n hosting an Amplify app. </p>" 342 } 343 }, 344 "com.amazonaws.amplify#AppArn": { 345 "type": "string", 346 "traits": { 347 "smithy.api#length": { 348 "min": 0, 349 "max": 1000 350 } 351 } 352 }, 353 "com.amazonaws.amplify#AppId": { 354 "type": "string", 355 "traits": { 356 "smithy.api#length": { 357 "min": 1, 358 "max": 20 359 }, 360 "smithy.api#pattern": "d[a-z0-9]+" 361 } 362 }, 363 "com.amazonaws.amplify#Apps": { 364 "type": "list", 365 "member": { 366 "target": "com.amazonaws.amplify#App" 367 } 368 }, 369 "com.amazonaws.amplify#Artifact": { 370 "type": "structure", 371 "members": { 372 "artifactFileName": { 373 "target": "com.amazonaws.amplify#ArtifactFileName", 374 "traits": { 375 "smithy.api#documentation": "<p> The file name for the artifact. </p>", 376 "smithy.api#required": {} 377 } 378 }, 379 "artifactId": { 380 "target": "com.amazonaws.amplify#ArtifactId", 381 "traits": { 382 "smithy.api#documentation": "<p> The unique ID for the artifact. </p>", 383 "smithy.api#required": {} 384 } 385 } 386 }, 387 "traits": { 388 "smithy.api#documentation": "<p> Describes an artifact. </p>" 389 } 390 }, 391 "com.amazonaws.amplify#ArtifactFileName": { 392 "type": "string", 393 "traits": { 394 "smithy.api#length": { 395 "min": 0, 396 "max": 1000 397 } 398 } 399 }, 400 "com.amazonaws.amplify#ArtifactId": { 401 "type": "string", 402 "traits": { 403 "smithy.api#length": { 404 "min": 0, 405 "max": 255 406 } 407 } 408 }, 409 "com.amazonaws.amplify#ArtifactUrl": { 410 "type": "string", 411 "traits": { 412 "smithy.api#length": { 413 "min": 0, 414 "max": 1000 415 } 416 } 417 }, 418 "com.amazonaws.amplify#Artifacts": { 419 "type": "list", 420 "member": { 421 "target": "com.amazonaws.amplify#Artifact" 422 } 423 }, 424 "com.amazonaws.amplify#ArtifactsUrl": { 425 "type": "string", 426 "traits": { 427 "smithy.api#length": { 428 "min": 0, 429 "max": 1000 430 } 431 } 432 }, 433 "com.amazonaws.amplify#AssociatedResource": { 434 "type": "string", 435 "traits": { 436 "smithy.api#length": { 437 "min": 1, 438 "max": 2048 439 } 440 } 441 }, 442 "com.amazonaws.amplify#AssociatedResources": { 443 "type": "list", 444 "member": { 445 "target": "com.amazonaws.amplify#AssociatedResource" 446 } 447 }, 448 "com.amazonaws.amplify#AutoBranchCreationConfig": { 449 "type": "structure", 450 "members": { 451 "stage": { 452 "target": "com.amazonaws.amplify#Stage", 453 "traits": { 454 "smithy.api#documentation": "<p> Describes the current stage for the autocreated branch. </p>" 455 } 456 }, 457 "framework": { 458 "target": "com.amazonaws.amplify#Framework", 459 "traits": { 460 "smithy.api#documentation": "<p> The framework for the autocreated branch. </p>" 461 } 462 }, 463 "enableAutoBuild": { 464 "target": "com.amazonaws.amplify#EnableAutoBuild", 465 "traits": { 466 "smithy.api#documentation": "<p> Enables auto building for the autocreated branch. </p>" 467 } 468 }, 469 "environmentVariables": { 470 "target": "com.amazonaws.amplify#EnvironmentVariables", 471 "traits": { 472 "smithy.api#documentation": "<p> The environment variables for the autocreated branch. </p>" 473 } 474 }, 475 "basicAuthCredentials": { 476 "target": "com.amazonaws.amplify#BasicAuthCredentials", 477 "traits": { 478 "smithy.api#documentation": "<p> The basic authorization credentials for the autocreated branch. </p>" 479 } 480 }, 481 "enableBasicAuth": { 482 "target": "com.amazonaws.amplify#EnableBasicAuth", 483 "traits": { 484 "smithy.api#documentation": "<p> Enables basic authorization for the autocreated branch. </p>" 485 } 486 }, 487 "enablePerformanceMode": { 488 "target": "com.amazonaws.amplify#EnablePerformanceMode", 489 "traits": { 490 "smithy.api#documentation": "<p>Enables performance mode for the branch.</p>\n <p>Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out. </p>" 491 } 492 }, 493 "buildSpec": { 494 "target": "com.amazonaws.amplify#BuildSpec", 495 "traits": { 496 "smithy.api#documentation": "<p> The build specification (build spec) for the autocreated branch. </p>" 497 } 498 }, 499 "enablePullRequestPreview": { 500 "target": "com.amazonaws.amplify#EnablePullRequestPreview", 501 "traits": { 502 "smithy.api#documentation": "<p> Enables pull request previews for the autocreated branch. </p>" 503 } 504 }, 505 "pullRequestEnvironmentName": { 506 "target": "com.amazonaws.amplify#PullRequestEnvironmentName", 507 "traits": { 508 "smithy.api#documentation": "<p> The Amplify environment name for the pull request. </p>" 509 } 510 } 511 }, 512 "traits": { 513 "smithy.api#documentation": "<p> Describes the automated branch creation configuration. </p>" 514 } 515 }, 516 "com.amazonaws.amplify#AutoBranchCreationPattern": { 517 "type": "string", 518 "traits": { 519 "smithy.api#length": { 520 "min": 1, 521 "max": 2048 522 } 523 } 524 }, 525 "com.amazonaws.amplify#AutoBranchCreationPatterns": { 526 "type": "list", 527 "member": { 528 "target": "com.amazonaws.amplify#AutoBranchCreationPattern" 529 } 530 }, 531 "com.amazonaws.amplify#AutoSubDomainCreationPattern": { 532 "type": "string", 533 "traits": { 534 "smithy.api#length": { 535 "min": 1, 536 "max": 2048 537 } 538 } 539 }, 540 "com.amazonaws.amplify#AutoSubDomainCreationPatterns": { 541 "type": "list", 542 "member": { 543 "target": "com.amazonaws.amplify#AutoSubDomainCreationPattern" 544 } 545 }, 546 "com.amazonaws.amplify#AutoSubDomainIAMRole": { 547 "type": "string", 548 "traits": { 549 "smithy.api#length": { 550 "min": 0, 551 "max": 1000 552 }, 553 "smithy.api#pattern": "^$|^arn:aws:iam::\\d{12}:role.+" 554 } 555 }, 556 "com.amazonaws.amplify#BackendEnvironment": { 557 "type": "structure", 558 "members": { 559 "backendEnvironmentArn": { 560 "target": "com.amazonaws.amplify#BackendEnvironmentArn", 561 "traits": { 562 "smithy.api#documentation": "<p> The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify\n app. </p>", 563 "smithy.api#required": {} 564 } 565 }, 566 "environmentName": { 567 "target": "com.amazonaws.amplify#EnvironmentName", 568 "traits": { 569 "smithy.api#documentation": "<p> The name for a backend environment that is part of an Amplify app. </p>", 570 "smithy.api#required": {} 571 } 572 }, 573 "stackName": { 574 "target": "com.amazonaws.amplify#StackName", 575 "traits": { 576 "smithy.api#documentation": "<p> The AWS CloudFormation stack name of a backend environment. </p>" 577 } 578 }, 579 "deploymentArtifacts": { 580 "target": "com.amazonaws.amplify#DeploymentArtifacts", 581 "traits": { 582 "smithy.api#documentation": "<p> The name of deployment artifacts. </p>" 583 } 584 }, 585 "createTime": { 586 "target": "com.amazonaws.amplify#CreateTime", 587 "traits": { 588 "smithy.api#documentation": "<p> The creation date and time for a backend environment that is part of an Amplify app.\n </p>", 589 "smithy.api#required": {} 590 } 591 }, 592 "updateTime": { 593 "target": "com.amazonaws.amplify#UpdateTime", 594 "traits": { 595 "smithy.api#documentation": "<p> The last updated date and time for a backend environment that is part of an Amplify\n app. </p>", 596 "smithy.api#required": {} 597 } 598 } 599 }, 600 "traits": { 601 "smithy.api#documentation": "<p> Describes the backend environment for an Amplify app. </p>" 602 } 603 }, 604 "com.amazonaws.amplify#BackendEnvironmentArn": { 605 "type": "string", 606 "traits": { 607 "smithy.api#length": { 608 "min": 1, 609 "max": 1000 610 } 611 } 612 }, 613 "com.amazonaws.amplify#BackendEnvironments": { 614 "type": "list", 615 "member": { 616 "target": "com.amazonaws.amplify#BackendEnvironment" 617 } 618 }, 619 "com.amazonaws.amplify#BadRequestException": { 620 "type": "structure", 621 "members": { 622 "message": { 623 "target": "com.amazonaws.amplify#ErrorMessage" 624 } 625 }, 626 "traits": { 627 "smithy.api#documentation": "<p> A request contains unexpected data. </p>", 628 "smithy.api#error": "client", 629 "smithy.api#httpError": 400 630 } 631 }, 632 "com.amazonaws.amplify#BasicAuthCredentials": { 633 "type": "string", 634 "traits": { 635 "smithy.api#length": { 636 "min": 0, 637 "max": 2000 638 }, 639 "smithy.api#sensitive": {} 640 } 641 }, 642 "com.amazonaws.amplify#Branch": { 643 "type": "structure", 644 "members": { 645 "branchArn": { 646 "target": "com.amazonaws.amplify#BranchArn", 647 "traits": { 648 "smithy.api#documentation": "<p> The Amazon Resource Name (ARN) for a branch that is part of an Amplify app. </p>", 649 "smithy.api#required": {} 650 } 651 }, 652 "branchName": { 653 "target": "com.amazonaws.amplify#BranchName", 654 "traits": { 655 "smithy.api#documentation": "<p> The name for the branch that is part of an Amplify app. </p>", 656 "smithy.api#required": {} 657 } 658 }, 659 "description": { 660 "target": "com.amazonaws.amplify#Description", 661 "traits": { 662 "smithy.api#documentation": "<p> The description for the branch that is part of an Amplify app. </p>", 663 "smithy.api#required": {} 664 } 665 }, 666 "tags": { 667 "target": "com.amazonaws.amplify#TagMap", 668 "traits": { 669 "smithy.api#documentation": "<p> The tag for the branch of an Amplify app. </p>" 670 } 671 }, 672 "stage": { 673 "target": "com.amazonaws.amplify#Stage", 674 "traits": { 675 "smithy.api#documentation": "<p> The current stage for the branch that is part of an Amplify app. </p>", 676 "smithy.api#required": {} 677 } 678 }, 679 "displayName": { 680 "target": "com.amazonaws.amplify#DisplayName", 681 "traits": { 682 "smithy.api#documentation": "<p> The display name for the branch. This is used as the default domain prefix. </p>", 683 "smithy.api#required": {} 684 } 685 }, 686 "enableNotification": { 687 "target": "com.amazonaws.amplify#EnableNotification", 688 "traits": { 689 "smithy.api#documentation": "<p> Enables notifications for a branch that is part of an Amplify app. </p>", 690 "smithy.api#required": {} 691 } 692 }, 693 "createTime": { 694 "target": "com.amazonaws.amplify#CreateTime", 695 "traits": { 696 "smithy.api#documentation": "<p> The creation date and time for a branch that is part of an Amplify app. </p>", 697 "smithy.api#required": {} 698 } 699 }, 700 "updateTime": { 701 "target": "com.amazonaws.amplify#UpdateTime", 702 "traits": { 703 "smithy.api#documentation": "<p> The last updated date and time for a branch that is part of an Amplify app. </p>", 704 "smithy.api#required": {} 705 } 706 }, 707 "environmentVariables": { 708 "target": "com.amazonaws.amplify#EnvironmentVariables", 709 "traits": { 710 "smithy.api#documentation": "<p> The environment variables specific to a branch of an Amplify app. </p>", 711 "smithy.api#required": {} 712 } 713 }, 714 "enableAutoBuild": { 715 "target": "com.amazonaws.amplify#EnableAutoBuild", 716 "traits": { 717 "smithy.api#documentation": "<p> Enables auto-building on push for a branch of an Amplify app. </p>", 718 "smithy.api#required": {} 719 } 720 }, 721 "customDomains": { 722 "target": "com.amazonaws.amplify#CustomDomains", 723 "traits": { 724 "smithy.api#documentation": "<p> The custom domains for a branch of an Amplify app. </p>", 725 "smithy.api#required": {} 726 } 727 }, 728 "framework": { 729 "target": "com.amazonaws.amplify#Framework", 730 "traits": { 731 "smithy.api#documentation": "<p> The framework for a branch of an Amplify app. </p>", 732 "smithy.api#required": {} 733 } 734 }, 735 "activeJobId": { 736 "target": "com.amazonaws.amplify#ActiveJobId", 737 "traits": { 738 "smithy.api#documentation": "<p> The ID of the active job for a branch of an Amplify app. </p>", 739 "smithy.api#required": {} 740 } 741 }, 742 "totalNumberOfJobs": { 743 "target": "com.amazonaws.amplify#TotalNumberOfJobs", 744 "traits": { 745 "smithy.api#documentation": "<p> The total number of jobs that are part of an Amplify app. </p>", 746 "smithy.api#required": {} 747 } 748 }, 749 "enableBasicAuth": { 750 "target": "com.amazonaws.amplify#EnableBasicAuth", 751 "traits": { 752 "smithy.api#documentation": "<p> Enables basic authorization for a branch of an Amplify app. </p>", 753 "smithy.api#required": {} 754 } 755 }, 756 "enablePerformanceMode": { 757 "target": "com.amazonaws.amplify#EnablePerformanceMode", 758 "traits": { 759 "smithy.api#documentation": "<p>Enables performance mode for the branch.</p>\n <p>Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out. </p>" 760 } 761 }, 762 "thumbnailUrl": { 763 "target": "com.amazonaws.amplify#ThumbnailUrl", 764 "traits": { 765 "smithy.api#documentation": "<p> The thumbnail URL for the branch of an Amplify app. </p>" 766 } 767 }, 768 "basicAuthCredentials": { 769 "target": "com.amazonaws.amplify#BasicAuthCredentials", 770 "traits": { 771 "smithy.api#documentation": "<p> The basic authorization credentials for a branch of an Amplify app. </p>" 772 } 773 }, 774 "buildSpec": { 775 "target": "com.amazonaws.amplify#BuildSpec", 776 "traits": { 777 "smithy.api#documentation": "<p> The build specification (build spec) content for the branch of an Amplify app.\n </p>" 778 } 779 }, 780 "ttl": { 781 "target": "com.amazonaws.amplify#TTL", 782 "traits": { 783 "smithy.api#documentation": "<p> The content Time to Live (TTL) for the website in seconds. </p>", 784 "smithy.api#required": {} 785 } 786 }, 787 "associatedResources": { 788 "target": "com.amazonaws.amplify#AssociatedResources", 789 "traits": { 790 "smithy.api#documentation": "<p> A list of custom resources that are linked to this branch. </p>" 791 } 792 }, 793 "enablePullRequestPreview": { 794 "target": "com.amazonaws.amplify#EnablePullRequestPreview", 795 "traits": { 796 "smithy.api#documentation": "<p> Enables pull request previews for the branch. </p>", 797 "smithy.api#required": {} 798 } 799 }, 800 "pullRequestEnvironmentName": { 801 "target": "com.amazonaws.amplify#PullRequestEnvironmentName", 802 "traits": { 803 "smithy.api#documentation": "<p> The Amplify environment name for the pull request. </p>" 804 } 805 }, 806 "destinationBranch": { 807 "target": "com.amazonaws.amplify#BranchName", 808 "traits": { 809 "smithy.api#documentation": "<p> The destination branch if the branch is a pull request branch. </p>" 810 } 811 }, 812 "sourceBranch": { 813 "target": "com.amazonaws.amplify#BranchName", 814 "traits": { 815 "smithy.api#documentation": "<p> The source branch if the branch is a pull request branch. </p>" 816 } 817 }, 818 "backendEnvironmentArn": { 819 "target": "com.amazonaws.amplify#BackendEnvironmentArn", 820 "traits": { 821 "smithy.api#documentation": "<p> The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify\n app. </p>" 822 } 823 } 824 }, 825 "traits": { 826 "smithy.api#documentation": "<p> The branch for an Amplify app, which maps to a third-party repository branch. </p>" 827 } 828 }, 829 "com.amazonaws.amplify#BranchArn": { 830 "type": "string", 831 "traits": { 832 "smithy.api#length": { 833 "min": 0, 834 "max": 1000 835 } 836 } 837 }, 838 "com.amazonaws.amplify#BranchName": { 839 "type": "string", 840 "traits": { 841 "smithy.api#length": { 842 "min": 1, 843 "max": 255 844 } 845 } 846 }, 847 "com.amazonaws.amplify#Branches": { 848 "type": "list", 849 "member": { 850 "target": "com.amazonaws.amplify#Branch" 851 }, 852 "traits": { 853 "smithy.api#length": { 854 "min": 0, 855 "max": 255 856 } 857 } 858 }, 859 "com.amazonaws.amplify#BuildSpec": { 860 "type": "string", 861 "traits": { 862 "smithy.api#documentation": "<p> The build specification (build spec) file for an Amplify app build. </p>", 863 "smithy.api#length": { 864 "min": 1, 865 "max": 25000 866 } 867 } 868 }, 869 "com.amazonaws.amplify#CertificateVerificationDNSRecord": { 870 "type": "string", 871 "traits": { 872 "smithy.api#length": { 873 "min": 0, 874 "max": 1000 875 } 876 } 877 }, 878 "com.amazonaws.amplify#Code": { 879 "type": "string" 880 }, 881 "com.amazonaws.amplify#CommitId": { 882 "type": "string", 883 "traits": { 884 "smithy.api#length": { 885 "min": 0, 886 "max": 255 887 } 888 } 889 }, 890 "com.amazonaws.amplify#CommitMessage": { 891 "type": "string", 892 "traits": { 893 "smithy.api#length": { 894 "min": 0, 895 "max": 10000 896 } 897 } 898 }, 899 "com.amazonaws.amplify#CommitTime": { 900 "type": "timestamp" 901 }, 902 "com.amazonaws.amplify#Condition": { 903 "type": "string", 904 "traits": { 905 "smithy.api#length": { 906 "min": 1, 907 "max": 2048 908 } 909 } 910 }, 911 "com.amazonaws.amplify#Context": { 912 "type": "string" 913 }, 914 "com.amazonaws.amplify#CreateApp": { 915 "type": "operation", 916 "input": { 917 "target": "com.amazonaws.amplify#CreateAppRequest" 918 }, 919 "output": { 920 "target": "com.amazonaws.amplify#CreateAppResult" 921 }, 922 "errors": [ 923 { 924 "target": "com.amazonaws.amplify#BadRequestException" 925 }, 926 { 927 "target": "com.amazonaws.amplify#DependentServiceFailureException" 928 }, 929 { 930 "target": "com.amazonaws.amplify#InternalFailureException" 931 }, 932 { 933 "target": "com.amazonaws.amplify#LimitExceededException" 934 }, 935 { 936 "target": "com.amazonaws.amplify#UnauthorizedException" 937 } 938 ], 939 "traits": { 940 "smithy.api#documentation": "<p> Creates a new Amplify app. </p>", 941 "smithy.api#http": { 942 "method": "POST", 943 "uri": "/apps", 944 "code": 200 945 } 946 } 947 }, 948 "com.amazonaws.amplify#CreateAppRequest": { 949 "type": "structure", 950 "members": { 951 "name": { 952 "target": "com.amazonaws.amplify#Name", 953 "traits": { 954 "smithy.api#documentation": "<p> The name for an Amplify app. </p>", 955 "smithy.api#required": {} 956 } 957 }, 958 "description": { 959 "target": "com.amazonaws.amplify#Description", 960 "traits": { 961 "smithy.api#documentation": "<p> The description for an Amplify app. </p>" 962 } 963 }, 964 "repository": { 965 "target": "com.amazonaws.amplify#Repository", 966 "traits": { 967 "smithy.api#documentation": "<p> The repository for an Amplify app. </p>" 968 } 969 }, 970 "platform": { 971 "target": "com.amazonaws.amplify#Platform", 972 "traits": { 973 "smithy.api#documentation": "<p> The platform or framework for an Amplify app. </p>" 974 } 975 }, 976 "iamServiceRoleArn": { 977 "target": "com.amazonaws.amplify#ServiceRoleArn", 978 "traits": { 979 "smithy.api#documentation": "<p> The AWS Identity and Access Management (IAM) service role for an Amplify app. </p>" 980 } 981 }, 982 "oauthToken": { 983 "target": "com.amazonaws.amplify#OauthToken", 984 "traits": { 985 "smithy.api#documentation": "<p> The OAuth token for a third-party source control system for an Amplify app. The OAuth\n token is used to create a webhook and a read-only deploy key. The OAuth token is not\n stored. </p>" 986 } 987 }, 988 "accessToken": { 989 "target": "com.amazonaws.amplify#AccessToken", 990 "traits": { 991 "smithy.api#documentation": "<p> The personal access token for a third-party source control system for an Amplify app.\n The personal access token is used to create a webhook and a read-only deploy key. The\n token is not stored. </p>" 992 } 993 }, 994 "environmentVariables": { 995 "target": "com.amazonaws.amplify#EnvironmentVariables", 996 "traits": { 997 "smithy.api#documentation": "<p> The environment variables map for an Amplify app. </p>" 998 } 999 }, 1000 "enableBranchAutoBuild": { 1001 "target": "com.amazonaws.amplify#EnableBranchAutoBuild", 1002 "traits": { 1003 "smithy.api#documentation": "<p> Enables the auto building of branches for an Amplify app. </p>" 1004 } 1005 }, 1006 "enableBranchAutoDeletion": { 1007 "target": "com.amazonaws.amplify#EnableBranchAutoDeletion", 1008 "traits": { 1009 "smithy.api#documentation": "<p> Automatically disconnects a branch in the Amplify Console when you delete a branch\n from your Git repository. </p>" 1010 } 1011 }, 1012 "enableBasicAuth": { 1013 "target": "com.amazonaws.amplify#EnableBasicAuth", 1014 "traits": { 1015 "smithy.api#documentation": "<p> Enables basic authorization for an Amplify app. This will apply to all branches that\n are part of this app. </p>" 1016 } 1017 }, 1018 "basicAuthCredentials": { 1019 "target": "com.amazonaws.amplify#BasicAuthCredentials", 1020 "traits": { 1021 "smithy.api#documentation": "<p> The credentials for basic authorization for an Amplify app. </p>" 1022 } 1023 }, 1024 "customRules": { 1025 "target": "com.amazonaws.amplify#CustomRules", 1026 "traits": { 1027 "smithy.api#documentation": "<p> The custom rewrite and redirect rules for an Amplify app. </p>" 1028 } 1029 }, 1030 "tags": { 1031 "target": "com.amazonaws.amplify#TagMap", 1032 "traits": { 1033 "smithy.api#documentation": "<p> The tag for an Amplify app. </p>" 1034 } 1035 }, 1036 "buildSpec": { 1037 "target": "com.amazonaws.amplify#BuildSpec", 1038 "traits": { 1039 "smithy.api#documentation": "<p> The build specification (build spec) for an Amplify app. </p>" 1040 } 1041 }, 1042 "customHeaders": { 1043 "target": "com.amazonaws.amplify#CustomHeaders", 1044 "traits": { 1045 "smithy.api#documentation": "<p>The custom HTTP headers for an Amplify app.</p>" 1046 } 1047 }, 1048 "enableAutoBranchCreation": { 1049 "target": "com.amazonaws.amplify#EnableAutoBranchCreation", 1050 "traits": { 1051 "smithy.api#documentation": "<p> Enables automated branch creation for an Amplify app. </p>" 1052 } 1053 }, 1054 "autoBranchCreationPatterns": { 1055 "target": "com.amazonaws.amplify#AutoBranchCreationPatterns", 1056 "traits": { 1057 "smithy.api#documentation": "<p> The automated branch creation glob patterns for an Amplify app. </p>" 1058 } 1059 }, 1060 "autoBranchCreationConfig": { 1061 "target": "com.amazonaws.amplify#AutoBranchCreationConfig", 1062 "traits": { 1063 "smithy.api#documentation": "<p> The automated branch creation configuration for an Amplify app. </p>" 1064 } 1065 } 1066 }, 1067 "traits": { 1068 "smithy.api#documentation": "<p> The request structure used to create apps in Amplify. </p>" 1069 } 1070 }, 1071 "com.amazonaws.amplify#CreateAppResult": { 1072 "type": "structure", 1073 "members": { 1074 "app": { 1075 "target": "com.amazonaws.amplify#App", 1076 "traits": { 1077 "smithy.api#required": {} 1078 } 1079 } 1080 } 1081 }, 1082 "com.amazonaws.amplify#CreateBackendEnvironment": { 1083 "type": "operation", 1084 "input": { 1085 "target": "com.amazonaws.amplify#CreateBackendEnvironmentRequest" 1086 }, 1087 "output": { 1088 "target": "com.amazonaws.amplify#CreateBackendEnvironmentResult" 1089 }, 1090 "errors": [ 1091 { 1092 "target": "com.amazonaws.amplify#BadRequestException" 1093 }, 1094 { 1095 "target": "com.amazonaws.amplify#InternalFailureException" 1096 }, 1097 { 1098 "target": "com.amazonaws.amplify#LimitExceededException" 1099 }, 1100 { 1101 "target": "com.amazonaws.amplify#NotFoundException" 1102 }, 1103 { 1104 "target": "com.amazonaws.amplify#UnauthorizedException" 1105 } 1106 ], 1107 "traits": { 1108 "smithy.api#documentation": "<p> Creates a new backend environment for an Amplify app. </p>", 1109 "smithy.api#http": { 1110 "method": "POST", 1111 "uri": "/apps/{appId}/backendenvironments", 1112 "code": 200 1113 } 1114 } 1115 }, 1116 "com.amazonaws.amplify#CreateBackendEnvironmentRequest": { 1117 "type": "structure", 1118 "members": { 1119 "appId": { 1120 "target": "com.amazonaws.amplify#AppId", 1121 "traits": { 1122 "smithy.api#documentation": "<p> The unique ID for an Amplify app. </p>", 1123 "smithy.api#httpLabel": {}, 1124 "smithy.api#required": {} 1125 } 1126 }, 1127 "environmentName": { 1128 "target": "com.amazonaws.amplify#EnvironmentName", 1129 "traits": { 1130 "smithy.api#documentation": "<p> The name for the backend environment. </p>", 1131 "smithy.api#required": {} 1132 } 1133 }, 1134 "stackName": { 1135 "target": "com.amazonaws.amplify#StackName", 1136 "traits": { 1137 "smithy.api#documentation": "<p> The AWS CloudFormation stack name of a backend environment. </p>" 1138 } 1139 }, 1140 "deploymentArtifacts": { 1141 "target": "com.amazonaws.amplify#DeploymentArtifacts", 1142 "traits": { 1143 "smithy.api#documentation": "<p> The name of deployment artifacts. </p>" 1144 } 1145 } 1146 }, 1147 "traits": { 1148 "smithy.api#documentation": "<p> The request structure for the backend environment create request. </p>" 1149 } 1150 }, 1151 "com.amazonaws.amplify#CreateBackendEnvironmentResult": { 1152 "type": "structure", 1153 "members": { 1154 "backendEnvironment": { 1155 "target": "com.amazonaws.amplify#BackendEnvironment", 1156 "traits": { 1157 "smithy.api#documentation": "<p> Describes the backend environment for an Amplify app. </p>", 1158 "smithy.api#required": {} 1159 } 1160 } 1161 }, 1162 "traits": { 1163 "smithy.api#documentation": "<p> The result structure for the create backend environment request. </p>" 1164 } 1165 }, 1166 "com.amazonaws.amplify#CreateBranch": { 1167 "type": "operation", 1168 "input": { 1169 "target": "com.amazonaws.amplify#CreateBranchRequest" 1170 }, 1171 "output": { 1172 "target": "com.amazonaws.amplify#CreateBranchResult" 1173 }, 1174 "errors": [ 1175 { 1176 "target": "com.amazonaws.amplify#BadRequestException" 1177 }, 1178 { 1179 "target": "com.amazonaws.amplify#DependentServiceFailureException" 1180 }, 1181 { 1182 "target": "com.amazonaws.amplify#InternalFailureException" 1183 }, 1184 { 1185 "target": "com.amazonaws.amplify#LimitExceededException" 1186 }, 1187 { 1188 "target": "com.amazonaws.amplify#NotFoundException" 1189 }, 1190 { 1191 "target": "com.amazonaws.amplify#UnauthorizedException" 1192 } 1193 ], 1194 "traits": { 1195 "smithy.api#documentation": "<p> Creates a new branch for an Amplify app. </p>", 1196 "smithy.api#http": { 1197 "method": "POST", 1198 "uri": "/apps/{appId}/branches", 1199 "code": 200 1200 } 1201 } 1202 }, 1203 "com.amazonaws.amplify#CreateBranchRequest": { 1204 "type": "structure", 1205 "members": { 1206 "appId": { 1207 "target": "com.amazonaws.amplify#AppId", 1208 "traits": { 1209 "smithy.api#documentation": "<p> The unique ID for an Amplify app. </p>", 1210 "smithy.api#httpLabel": {}, 1211 "smithy.api#required": {} 1212 } 1213 }, 1214 "branchName": { 1215 "target": "com.amazonaws.amplify#BranchName", 1216 "traits": { 1217 "smithy.api#documentation": "<p> The name for the branch. </p>", 1218 "smithy.api#required": {} 1219 } 1220 }, 1221 "description": { 1222 "target": "com.amazonaws.amplify#Description", 1223 "traits": { 1224 "smithy.api#documentation": "<p> The description for the branch. </p>" 1225 } 1226 }, 1227 "stage": { 1228 "target": "com.amazonaws.amplify#Stage", 1229 "traits": { 1230 "smithy.api#documentation": "<p> Describes the current stage for the branch. </p>" 1231 } 1232 }, 1233 "framework": { 1234 "target": "com.amazonaws.amplify#Framework", 1235 "traits": { 1236 "smithy.api#documentation": "<p> The framework for the branch. </p>" 1237 } 1238 }, 1239 "enableNotification": { 1240 "target": "com.amazonaws.amplify#EnableNotification", 1241 "traits": { 1242 "smithy.api#documentation": "<p> Enables notifications for the branch. </p>" 1243 } 1244 }, 1245 "enableAutoBuild": { 1246 "target": "com.amazonaws.amplify#EnableAutoBuild", 1247 "traits": { 1248 "smithy.api#documentation": "<p> Enables auto building for the branch. </p>" 1249 } 1250 }, 1251 "environmentVariables": { 1252 "target": "com.amazonaws.amplify#EnvironmentVariables", 1253 "traits": { 1254 "smithy.api#documentation": "<p> The environment variables for the branch. </p>" 1255 } 1256 }, 1257 "basicAuthCredentials": { 1258 "target": "com.amazonaws.amplify#BasicAuthCredentials", 1259 "traits": { 1260 "smithy.api#documentation": "<p> The basic authorization credentials for the branch. </p>" 1261 } 1262 }, 1263 "enableBasicAuth": { 1264 "target": "com.amazonaws.amplify#EnableBasicAuth", 1265 "traits": { 1266 "smithy.api#documentation": "<p> Enables basic authorization for the branch. </p>" 1267 } 1268 }, 1269 "enablePerformanceMode": { 1270 "target": "com.amazonaws.amplify#EnablePerformanceMode", 1271 "traits": { 1272 "smithy.api#documentation": "<p>Enables performance mode for the branch.</p>\n <p>Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out. </p>" 1273 } 1274 }, 1275 "tags": { 1276 "target": "com.amazonaws.amplify#TagMap", 1277 "traits": { 1278 "smithy.api#documentation": "<p> The tag for the branch. </p>" 1279 } 1280 }, 1281 "buildSpec": { 1282 "target": "com.amazonaws.amplify#BuildSpec", 1283 "traits": { 1284 "smithy.api#documentation": "<p> The build specification (build spec) for the branch. </p>" 1285 } 1286 }, 1287 "ttl": { 1288 "target": "com.amazonaws.amplify#TTL", 1289 "traits": { 1290 "smithy.api#documentation": "<p> The content Time To Live (TTL) for the website in seconds. </p>" 1291 } 1292 }, 1293 "displayName": { 1294 "target": "com.amazonaws.amplify#DisplayName", 1295 "traits": { 1296 "smithy.api#documentation": "<p> The display name for a branch. This is used as the default domain prefix. </p>" 1297 } 1298 }, 1299 "enablePullRequestPreview": { 1300 "target": "com.amazonaws.amplify#EnablePullRequestPreview", 1301 "traits": { 1302 "smithy.api#documentation": "<p> Enables pull request previews for this branch. </p>" 1303 } 1304 }, 1305 "pullRequestEnvironmentName": { 1306 "target": "com.amazonaws.amplify#PullRequestEnvironmentName", 1307 "traits": { 1308 "smithy.api#documentation": "<p> The Amplify environment name for the pull request. </p>" 1309 } 1310 }, 1311 "backendEnvironmentArn": { 1312 "target": "com.amazonaws.amplify#BackendEnvironmentArn", 1313 "traits": { 1314 "smithy.api#documentation": "<p> The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify\n app. </p>" 1315 } 1316 } 1317 }, 1318 "traits": { 1319 "smithy.api#documentation": "<p> The request structure for the create branch request. </p>" 1320 } 1321 }, 1322 "com.amazonaws.amplify#CreateBranchResult": { 1323 "type": "structure", 1324 "members": { 1325 "branch": { 1326 "target": "com.amazonaws.amplify#Branch", 1327 "traits": { 1328 "smithy.api#documentation": "<p> Describes the branch for an Amplify app, which maps to a third-party repository\n branch. </p>", 1329 "smithy.api#required": {} 1330 } 1331 } 1332 }, 1333 "traits": { 1334 "smithy.api#documentation": "<p> The result structure for create branch request. </p>" 1335 } 1336 }, 1337 "com.amazonaws.amplify#CreateDeployment": { 1338 "type": "operation", 1339 "input": { 1340 "target": "com.amazonaws.amplify#CreateDeploymentRequest" 1341 }, 1342 "output": { 1343 "target": "com.amazonaws.amplify#CreateDeploymentResult" 1344 }, 1345 "errors": [ 1346 { 1347 "target": "com.amazonaws.amplify#BadRequestException" 1348 }, 1349 { 1350 "target": "com.amazonaws.amplify#InternalFailureException" 1351 }, 1352 { 1353 "target": "com.amazonaws.amplify#LimitExceededException" 1354 }, 1355 { 1356 "target": "com.amazonaws.amplify#UnauthorizedException" 1357 } 1358 ], 1359 "traits": { 1360 "smithy.api#documentation": "<p> Creates a deployment for a manually deployed Amplify app. Manually deployed apps are\n not connected to a repository. </p>", 1361 "smithy.api#http": { 1362 "method": "POST", 1363 "uri": "/apps/{appId}/branches/{branchName}/deployments", 1364 "code": 200 1365 } 1366 } 1367 }, 1368 "com.amazonaws.amplify#CreateDeploymentRequest": { 1369 "type": "structure", 1370 "members": { 1371 "appId": { 1372 "target": "com.amazonaws.amplify#AppId", 1373 "traits": { 1374 "smithy.api#documentation": "<p> The unique ID for an Amplify app. </p>", 1375 "smithy.api#httpLabel": {}, 1376 "smithy.api#required": {} 1377 } 1378 }, 1379 "branchName": { 1380 "target": "com.amazonaws.amplify#BranchName", 1381 "traits": { 1382 "smithy.api#documentation": "<p> The name for the branch, for the job. </p>", 1383 "smithy.api#httpLabel": {}, 1384 "smithy.api#required": {} 1385 } 1386 }, 1387 "fileMap": { 1388 "target": "com.amazonaws.amplify#FileMap", 1389 "traits": { 1390 "smithy.api#documentation": "<p> An optional file map that contains the file name as the key and the file content md5\n hash as the value. If this argument is provided, the service will generate a unique\n upload URL per file. Otherwise, the service will only generate a single upload URL for\n the zipped files. </p>" 1391 } 1392 } 1393 }, 1394 "traits": { 1395 "smithy.api#documentation": "<p> The request structure for the create a new deployment request. </p>" 1396 } 1397 }, 1398 "com.amazonaws.amplify#CreateDeploymentResult": { 1399 "type": "structure", 1400 "members": { 1401 "jobId": { 1402 "target": "com.amazonaws.amplify#JobId", 1403 "traits": { 1404 "smithy.api#documentation": "<p> The job ID for this deployment. will supply to start deployment api. </p>" 1405 } 1406 }, 1407 "fileUploadUrls": { 1408 "target": "com.amazonaws.amplify#FileUploadUrls", 1409 "traits": { 1410 "smithy.api#documentation": "<p> When the <code>fileMap</code> argument is provided in the request,\n <code>fileUploadUrls</code> will contain a map of file names to upload URLs. </p>", 1411 "smithy.api#required": {} 1412 } 1413 }, 1414 "zipUploadUrl": { 1415 "target": "com.amazonaws.amplify#UploadUrl", 1416 "traits": { 1417 "smithy.api#documentation": "<p> When the <code>fileMap</code> argument is not provided in the request, this\n <code>zipUploadUrl</code> is returned. </p>", 1418 "smithy.api#required": {} 1419 } 1420 } 1421 }, 1422 "traits": { 1423 "smithy.api#documentation": "<p> The result structure for the create a new deployment request. </p>" 1424 } 1425 }, 1426 "com.amazonaws.amplify#CreateDomainAssociation": { 1427 "type": "operation", 1428 "input": { 1429 "target": "com.amazonaws.amplify#CreateDomainAssociationRequest" 1430 }, 1431 "output": { 1432 "target": "com.amazonaws.amplify#CreateDomainAssociationResult" 1433 }, 1434 "errors": [ 1435 { 1436 "target": "com.amazonaws.amplify#BadRequestException" 1437 }, 1438 { 1439 "target": "com.amazonaws.amplify#DependentServiceFailureException" 1440 }, 1441 { 1442 "target": "com.amazonaws.amplify#InternalFailureException" 1443 }, 1444 { 1445 "target": "com.amazonaws.amplify#LimitExceededException" 1446 }, 1447 { 1448 "target": "com.amazonaws.amplify#NotFoundException" 1449 }, 1450 { 1451 "target": "com.amazonaws.amplify#UnauthorizedException" 1452 } 1453 ], 1454 "traits": { 1455 "smithy.api#documentation": "<p> Creates a new domain association for an Amplify app. This action associates a custom\n domain with the Amplify app </p>", 1456 "smithy.api#http": { 1457 "method": "POST", 1458 "uri": "/apps/{appId}/domains", 1459 "code": 200 1460 } 1461 } 1462 }, 1463 "com.amazonaws.amplify#CreateDomainAssociationRequest": { 1464 "type": "structure", 1465 "members": { 1466 "appId": { 1467 "target": "com.amazonaws.amplify#AppId", 1468 "traits": { 1469 "smithy.api#documentation": "<p> The unique ID for an Amplify app. </p>", 1470 "smithy.api#httpLabel": {}, 1471 "smithy.api#required": {} 1472 } 1473 }, 1474 "domainName": { 1475 "target": "com.amazonaws.amplify#DomainName", 1476 "traits": { 1477 "smithy.api#documentation": "<p> The domain name for the domain association. </p>", 1478 "smithy.api#required": {} 1479 } 1480 }, 1481 "enableAutoSubDomain": { 1482 "target": "com.amazonaws.amplify#EnableAutoSubDomain", 1483 "traits": { 1484 "smithy.api#documentation": "<p> Enables the automated creation of subdomains for branches. </p>" 1485 } 1486 }, 1487 "subDomainSettings": { 1488 "target": "com.amazonaws.amplify#SubDomainSettings", 1489 "traits": { 1490 "smithy.api#documentation": "<p> The setting for the subdomain. </p>", 1491 "smithy.api#required": {} 1492 } 1493 }, 1494 "autoSubDomainCreationPatterns": { 1495 "target": "com.amazonaws.amplify#AutoSubDomainCreationPatterns", 1496 "traits": { 1497 "smithy.api#documentation": "<p> Sets the branch patterns for automatic subdomain creation. </p>" 1498 } 1499 }, 1500 "autoSubDomainIAMRole": { 1501 "target": "com.amazonaws.amplify#AutoSubDomainIAMRole", 1502 "traits": { 1503 "smithy.api#documentation": "<p> The required AWS Identity and Access Management (IAM) service role for the Amazon\n Resource Name (ARN) for automatically creating subdomains. </p>" 1504 } 1505 } 1506 }, 1507 "traits": { 1508 "smithy.api#documentation": "<p> The request structure for the create domain association request. </p>" 1509 } 1510 }, 1511 "com.amazonaws.amplify#CreateDomainAssociationResult": { 1512 "type": "structure", 1513 "members": { 1514 "domainAssociation": { 1515 "target": "com.amazonaws.amplify#DomainAssociation", 1516 "traits": { 1517 "smithy.api#documentation": "<p> Describes the structure of a domain association, which associates a custom domain\n with an Amplify app. </p>", 1518 "smithy.api#required": {} 1519 } 1520 } 1521 }, 1522 "traits": { 1523 "smithy.api#documentation": "<p> The result structure for the create domain association request. </p>" 1524 } 1525 }, 1526 "com.amazonaws.amplify#CreateTime": { 1527 "type": "timestamp" 1528 }, 1529 "com.amazonaws.amplify#CreateWebhook": { 1530 "type": "operation", 1531 "input": { 1532 "target": "com.amazonaws.amplify#CreateWebhookRequest" 1533 }, 1534 "output": { 1535 "target": "com.amazonaws.amplify#CreateWebhookResult" 1536 }, 1537 "errors": [ 1538 { 1539 "target": "com.amazonaws.amplify#BadRequestException" 1540 }, 1541 { 1542 "target": "com.amazonaws.amplify#DependentServiceFailureException" 1543 }, 1544 { 1545 "target": "com.amazonaws.amplify#InternalFailureException" 1546 }, 1547 { 1548 "target": "com.amazonaws.amplify#LimitExceededException" 1549 }, 1550 { 1551 "target": "com.amazonaws.amplify#NotFoundException" 1552 }, 1553 { 1554 "target": "com.amazonaws.amplify#UnauthorizedException" 1555 } 1556 ], 1557 "traits": { 1558 "smithy.api#documentation": "<p> Creates a new webhook on an Amplify app. </p>", 1559 "smithy.api#http": { 1560 "method": "POST", 1561 "uri": "/apps/{appId}/webhooks", 1562 "code": 200 1563 } 1564 } 1565 }, 1566 "com.amazonaws.amplify#CreateWebhookRequest": { 1567 "type": "structure", 1568 "members": { 1569 "appId": { 1570 "target": "com.amazonaws.amplify#AppId", 1571 "traits": { 1572 "smithy.api#documentation": "<p> The unique ID for an Amplify app. </p>", 1573 "smithy.api#httpLabel": {}, 1574 "smithy.api#required": {} 1575 } 1576 }, 1577 "branchName": { 1578 "target": "com.amazonaws.amplify#BranchName", 1579 "traits": { 1580 "smithy.api#documentation": "<p> The name for a branch that is part of an Amplify app. </p>", 1581 "smithy.api#required": {} 1582 } 1583 }, 1584 "description": { 1585 "target": "com.amazonaws.amplify#Description", 1586 "traits": { 1587 "smithy.api#documentation": "<p> The description for a webhook. </p>" 1588 } 1589 } 1590 }, 1591 "traits": { 1592 "smithy.api#documentation": "<p> The request structure for the create webhook request. </p>" 1593 } 1594 }, 1595 "com.amazonaws.amplify#CreateWebhookResult": { 1596 "type": "structure", 1597 "members": { 1598 "webhook": { 1599 "target": "com.amazonaws.amplify#Webhook", 1600 "traits": { 1601 "smithy.api#documentation": "<p> Describes a webhook that connects repository events to an Amplify app. </p>", 1602 "smithy.api#required": {} 1603 } 1604 } 1605 }, 1606 "traits": { 1607 "smithy.api#documentation": "<p> The result structure for the create webhook request. </p>" 1608 } 1609 }, 1610 "com.amazonaws.amplify#CustomDomain": { 1611 "type": "string", 1612 "traits": { 1613 "smithy.api#length": { 1614 "min": 0, 1615 "max": 255 1616 } 1617 } 1618 }, 1619 "com.amazonaws.amplify#CustomDomains": { 1620 "type": "list", 1621 "member": { 1622 "target": "com.amazonaws.amplify#CustomDomain" 1623 }, 1624 "traits": { 1625 "smithy.api#length": { 1626 "min": 0, 1627 "max": 255 1628 } 1629 } 1630 }, 1631 "com.amazonaws.amplify#CustomHeaders": { 1632 "type": "string", 1633 "traits": { 1634 "smithy.api#length": { 1635 "min": 1, 1636 "max": 25000 1637 } 1638 } 1639 }, 1640 "com.amazonaws.amplify#CustomRule": { 1641 "type": "structure", 1642 "members": { 1643 "source": { 1644 "target": "com.amazonaws.amplify#Source", 1645 "traits": { 1646 "smithy.api#documentation": "<p> The source pattern for a URL rewrite or redirect rule. </p>", 1647 "smithy.api#required": {} 1648 } 1649 }, 1650 "target": { 1651 "target": "com.amazonaws.amplify#Target", 1652 "traits": { 1653 "smithy.api#documentation": "<p> The target pattern for a URL rewrite or redirect rule. </p>", 1654 "smithy.api#required": {} 1655 } 1656 }, 1657 "status": { 1658 "target": "com.amazonaws.amplify#Status", 1659 "traits": { 1660 "smithy.api#documentation": "<p> The status code for a URL rewrite or redirect rule. </p>\n \n <dl>\n <dt>200</dt>\n <dd>\n <p>Represents a 200 rewrite rule.</p>\n </dd>\n <dt>301</dt>\n <dd>\n <p>Represents a 301 (moved pemanently) redirect rule. This and all future requests should be directed to the target URL. </p>\n </dd>\n <dt>302</dt>\n <dd>\n <p>Represents a 302 temporary redirect rule.</p>\n </dd>\n <dt>404</dt>\n <dd>\n <p>Represents a 404 redirect rule.</p>\n </dd>\n <dt>404-200</dt>\n <dd>\n <p>Represents a 404 rewrite rule.</p>\n </dd>\n </dl>" 1661 } 1662 }, 1663 "condition": { 1664 "target": "com.amazonaws.amplify#Condition", 1665 "traits": { 1666 "smithy.api#documentation": "<p> The condition for a URL rewrite or redirect rule, such as a country code. </p>" 1667 } 1668 } 1669 }, 1670 "traits": { 1671 "smithy.api#documentation": "<p> Describes a custom rewrite or redirect rule. </p>" 1672 } 1673 }, 1674 "com.amazonaws.amplify#CustomRules": { 1675 "type": "list", 1676 "member": { 1677 "target": "com.amazonaws.amplify#CustomRule" 1678 } 1679 }, 1680 "com.amazonaws.amplify#DNSRecord": { 1681 "type": "string", 1682 "traits": { 1683 "smithy.api#length": { 1684 "min": 0, 1685 "max": 1000 1686 } 1687 } 1688 }, 1689 "com.amazonaws.amplify#DefaultDomain": { 1690 "type": "string", 1691 "traits": { 1692 "smithy.api#length": { 1693 "min": 1, 1694 "max": 1000 1695 } 1696 } 1697 }, 1698 "com.amazonaws.amplify#DeleteApp": { 1699 "type": "operation", 1700 "input": { 1701 "target": "com.amazonaws.amplify#DeleteAppRequest" 1702 }, 1703 "output": { 1704 "target": "com.amazonaws.amplify#DeleteAppResult" 1705 }, 1706 "errors": [ 1707 { 1708 "target": "com.amazonaws.amplify#BadRequestException" 1709 }, 1710 { 1711 "target": "com.amazonaws.amplify#DependentServiceFailureException" 1712 }, 1713 { 1714 "target": "com.amazonaws.amplify#InternalFailureException" 1715 }, 1716 { 1717 "target": "com.amazonaws.amplify#NotFoundException" 1718 }, 1719 { 1720 "target": "com.amazonaws.amplify#UnauthorizedException" 1721 } 1722 ], 1723 "traits": { 1724 "smithy.api#documentation": "<p> Deletes an existing Amplify app specified by an app ID. </p>", 1725 "smithy.api#http": { 1726 "method": "DELETE", 1727 "uri": "/apps/{appId}", 1728 "code": 200 1729 } 1730 } 1731 }, 1732 "com.amazonaws.amplify#DeleteAppRequest": { 1733 "type": "structure", 1734 "members": { 1735 "appId": { 1736 "target": "com.amazonaws.amplify#AppId", 1737 "traits": { 1738 "smithy.api#documentation": "<p> The unique ID for an Amplify app. </p>", 1739 "smithy.api#httpLabel": {}, 1740 "smithy.api#required": {} 1741 } 1742 } 1743 }, 1744 "traits": { 1745 "smithy.api#documentation": "<p> Describes the request structure for the delete app request. </p>" 1746 } 1747 }, 1748 "com.amazonaws.amplify#DeleteAppResult": { 1749 "type": "structure", 1750 "members": { 1751 "app": { 1752 "target": "com.amazonaws.amplify#App", 1753 "traits": { 1754 "smithy.api#required": {} 1755 } 1756 } 1757 }, 1758 "traits": { 1759 "smithy.api#documentation": "<p> The result structure for the delete app request. </p>" 1760 } 1761 }, 1762 "com.amazonaws.amplify#DeleteBackendEnvironment": { 1763 "type": "operation", 1764 "input": { 1765 "target": "com.amazonaws.amplify#DeleteBackendEnvironmentRequest" 1766 }, 1767 "output": { 1768 "target": "com.amazonaws.amplify#DeleteBackendEnvironmentResult" 1769 }, 1770 "errors": [ 1771 { 1772 "target": "com.amazonaws.amplify#BadRequestException" 1773 }, 1774 { 1775 "target": "com.amazonaws.amplify#DependentServiceFailureException" 1776 }, 1777 { 1778 "target": "com.amazonaws.amplify#InternalFailureException" 1779 }, 1780 { 1781 "target": "com.amazonaws.amplify#NotFoundException" 1782 }, 1783 { 1784 "target": "com.amazonaws.amplify#UnauthorizedException" 1785 } 1786 ], 1787 "traits": { 1788 "smithy.api#documentation": "<p> Deletes a backend environment for an Amplify app. </p>", 1789 "smithy.api#http": { 1790 "method": "DELETE", 1791 "uri": "/apps/{appId}/backendenvironments/{environmentName}", 1792 "code": 200 1793 } 1794 } 1795 }, 1796 "com.amazonaws.amplify#DeleteBackendEnvironmentRequest": { 1797 "type": "structure", 1798 "members": { 1799 "appId": { 1800 "target": "com.amazonaws.amplify#AppId", 1801 "traits": { 1802 "smithy.api#documentation": "<p> The unique ID of an Amplify app. </p>", 1803 "smithy.api#httpLabel": {}, 1804 "smithy.api#required": {} 1805 } 1806 }, 1807 "environmentName": { 1808 "target": "com.amazonaws.amplify#EnvironmentName", 1809 "traits": { 1810 "smithy.api#documentation": "<p> The name of a backend environment of an Amplify app. </p>", 1811 "smithy.api#httpLabel": {}, 1812 "smithy.api#required": {} 1813 } 1814 } 1815 }, 1816 "traits": { 1817 "smithy.api#documentation": "<p> The request structure for the delete backend environment request. </p>" 1818 } 1819 }, 1820 "com.amazonaws.amplify#DeleteBackendEnvironmentResult": { 1821 "type": "structure", 1822 "members": { 1823 "backendEnvironment": { 1824 "target": "com.amazonaws.amplify#BackendEnvironment", 1825 "traits": { 1826 "smithy.api#documentation": "<p> Describes the backend environment for an Amplify app. </p>", 1827 "smithy.api#required": {} 1828 } 1829 } 1830 }, 1831 "traits": { 1832 "smithy.api#documentation": "<p> The result structure of the delete backend environment result. </p>" 1833 } 1834 }, 1835 "com.amazonaws.amplify#DeleteBranch": { 1836 "type": "operation", 1837 "input": { 1838 "target": "com.amazonaws.amplify#DeleteBranchRequest" 1839 }, 1840 "output": { 1841 "target": "com.amazonaws.amplify#DeleteBranchResult" 1842 }, 1843 "errors": [ 1844 { 1845 "target": "com.amazonaws.amplify#BadRequestException" 1846 }, 1847 { 1848 "target": "com.amazonaws.amplify#DependentServiceFailureException" 1849 }, 1850 { 1851 "target": "com.amazonaws.amplify#InternalFailureException" 1852 }, 1853 { 1854 "target": "com.amazonaws.amplify#NotFoundException" 1855 }, 1856 { 1857 "target": "com.amazonaws.amplify#UnauthorizedException" 1858 } 1859 ], 1860 "traits": { 1861 "smithy.api#documentation": "<p> Deletes a branch for an Amplify app. </p>", 1862 "smithy.api#http": { 1863 "method": "DELETE", 1864 "uri": "/apps/{appId}/branches/{branchName}", 1865 "code": 200 1866 } 1867 } 1868 }, 1869 "com.amazonaws.amplify#DeleteBranchRequest": { 1870 "type": "structure", 1871 "members": { 1872 "appId": { 1873 "target": "com.amazonaws.amplify#AppId", 1874 "traits": { 1875 "smithy.api#documentation": "<p> The unique ID for an Amplify app. </p>", 1876 "smithy.api#httpLabel": {}, 1877 "smithy.api#required": {} 1878 } 1879 }, 1880 "branchName": { 1881 "target": "com.amazonaws.amplify#BranchName", 1882 "traits": { 1883 "smithy.api#documentation": "<p> The name for the branch. </p>", 1884 "smithy.api#httpLabel": {}, 1885 "smithy.api#required": {} 1886 } 1887 } 1888 }, 1889 "traits": { 1890 "smithy.api#documentation": "<p> The request structure for the delete branch request. </p>" 1891 } 1892 }, 1893 "com.amazonaws.amplify#DeleteBranchResult": { 1894 "type": "structure", 1895 "members": { 1896 "branch": { 1897 "target": "com.amazonaws.amplify#Branch", 1898 "traits": { 1899 "smithy.api#documentation": "<p> The branch for an Amplify app, which maps to a third-party repository branch. </p>", 1900 "smithy.api#required": {} 1901 } 1902 } 1903 }, 1904 "traits": { 1905 "smithy.api#documentation": "<p> The result structure for the delete branch request. </p>" 1906 } 1907 }, 1908 "com.amazonaws.amplify#DeleteDomainAssociation": { 1909 "type": "operation", 1910 "input": { 1911 "target": "com.amazonaws.amplify#DeleteDomainAssociationRequest" 1912 }, 1913 "output": { 1914 "target": "com.amazonaws.amplify#DeleteDomainAssociationResult" 1915 }, 1916 "errors": [ 1917 { 1918 "target": "com.amazonaws.amplify#BadRequestException" 1919 }, 1920 { 1921 "target": "com.amazonaws.amplify#DependentServiceFailureException" 1922 }, 1923 { 1924 "target": "com.amazonaws.amplify#InternalFailureException" 1925 }, 1926 { 1927 "target": "com.amazonaws.amplify#NotFoundException" 1928 }, 1929 { 1930 "target": "com.amazonaws.amplify#UnauthorizedException" 1931 } 1932 ], 1933 "traits": { 1934 "smithy.api#documentation": "<p> Deletes a domain association for an Amplify app. </p>", 1935 "smithy.api#http": { 1936 "method": "DELETE", 1937 "uri": "/apps/{appId}/domains/{domainName}", 1938 "code": 200 1939 } 1940 } 1941 }, 1942 "com.amazonaws.amplify#DeleteDomainAssociationRequest": { 1943 "type": "structure", 1944 "members": { 1945 "appId": { 1946 "target": "com.amazonaws.amplify#AppId", 1947 "traits": { 1948 "smithy.api#documentation": "<p> The unique id for an Amplify app. </p>", 1949 "smithy.api#httpLabel": {}, 1950 "smithy.api#required": {} 1951 } 1952 }, 1953 "domainName": { 1954 "target": "com.amazonaws.amplify#DomainName", 1955 "traits": { 1956 "smithy.api#documentation": "<p> The name of the domain. </p>", 1957 "smithy.api#httpLabel": {}, 1958 "smithy.api#required": {} 1959 } 1960 } 1961 }, 1962 "traits": { 1963 "smithy.api#documentation": "<p> The request structure for the delete domain association request. </p>" 1964 } 1965 }, 1966 "com.amazonaws.amplify#DeleteDomainAssociationResult": { 1967 "type": "structure", 1968 "members": { 1969 "domainAssociation": { 1970 "target": "com.amazonaws.amplify#DomainAssociation", 1971 "traits": { 1972 "smithy.api#required": {} 1973 } 1974 } 1975 } 1976 }, 1977 "com.amazonaws.amplify#DeleteJob": { 1978 "type": "operation", 1979 "input": { 1980 "target": "com.amazonaws.amplify#DeleteJobRequest" 1981 }, 1982 "output": { 1983 "target": "com.amazonaws.amplify#DeleteJobResult" 1984 }, 1985 "errors": [ 1986 { 1987 "target": "com.amazonaws.amplify#BadRequestException" 1988 }, 1989 { 1990 "target": "com.amazonaws.amplify#InternalFailureException" 1991 }, 1992 { 1993 "target": "com.amazonaws.amplify#LimitExceededException" 1994 }, 1995 { 1996 "target": "com.amazonaws.amplify#NotFoundException" 1997 }, 1998 { 1999 "target": "com.amazonaws.amplify#UnauthorizedException" 2000 } 2001 ], 2002 "traits": { 2003 "smithy.api#documentation": "<p> Deletes a job for a branch of an Amplify app. </p>", 2004 "smithy.api#http": { 2005 "method": "DELETE", 2006 "uri": "/apps/{appId}/branches/{branchName}/jobs/{jobId}", 2007 "code": 200 2008 } 2009 } 2010 }, 2011 "com.amazonaws.amplify#DeleteJobRequest": { 2012 "type": "structure", 2013 "members": { 2014 "appId": { 2015 "target": "com.amazonaws.amplify#AppId", 2016 "traits": { 2017 "smithy.api#documentation": "<p> The unique ID for an Amplify app. </p>", 2018 "smithy.api#httpLabel": {}, 2019 "smithy.api#required": {} 2020 } 2021 }, 2022 "branchName": { 2023 "target": "com.amazonaws.amplify#BranchName", 2024 "traits": { 2025 "smithy.api#documentation": "<p> The name for the branch, for the job. </p>", 2026 "smithy.api#httpLabel": {}, 2027 "smithy.api#required": {} 2028 } 2029 }, 2030 "jobId": { 2031 "target": "com.amazonaws.amplify#JobId", 2032 "traits": { 2033 "smithy.api#documentation": "<p> The unique ID for the job. </p>", 2034 "smithy.api#httpLabel": {}, 2035 "smithy.api#required": {} 2036 } 2037 } 2038 }, 2039 "traits": { 2040 "smithy.api#documentation": "<p> The request structure for the delete job request. </p>" 2041 } 2042 }, 2043 "com.amazonaws.amplify#DeleteJobResult": { 2044 "type": "structure", 2045 "members": { 2046 "jobSummary": { 2047 "target": "com.amazonaws.amplify#JobSummary", 2048 "traits": { 2049 "smithy.api#required": {} 2050 } 2051 } 2052 }, 2053 "traits": { 2054 "smithy.api#documentation": "<p> The result structure for the delete job request. </p>" 2055 } 2056 }, 2057 "com.amazonaws.amplify#DeleteWebhook": { 2058 "type": "operation", 2059 "input": { 2060 "target": "com.amazonaws.amplify#DeleteWebhookRequest" 2061 }, 2062 "output": { 2063 "target": "com.amazonaws.amplify#DeleteWebhookResult" 2064 }, 2065 "errors": [ 2066 { 2067 "target": "com.amazonaws.amplify#BadRequestException" 2068 }, 2069 { 2070 "target": "com.amazonaws.amplify#InternalFailureException" 2071 }, 2072 { 2073 "target": "com.amazonaws.amplify#LimitExceededException" 2074 }, 2075 { 2076 "target": "com.amazonaws.amplify#NotFoundException" 2077 }, 2078 { 2079 "target": "com.amazonaws.amplify#UnauthorizedException" 2080 } 2081 ], 2082 "traits": { 2083 "smithy.api#documentation": "<p> Deletes a webhook. </p>", 2084 "smithy.api#http": { 2085 "method": "DELETE", 2086 "uri": "/webhooks/{webhookId}", 2087 "code": 200 2088 } 2089 } 2090 }, 2091 "com.amazonaws.amplify#DeleteWebhookRequest": { 2092 "type": "structure", 2093 "members": { 2094 "webhookId": { 2095 "target": "com.amazonaws.amplify#WebhookId", 2096 "traits": { 2097 "smithy.api#documentation": "<p> The unique ID for a webhook. </p>", 2098 "smithy.api#httpLabel": {}, 2099 "smithy.api#required": {} 2100 } 2101 } 2102 }, 2103 "traits": { 2104 "smithy.api#documentation": "<p> The request structure for the delete webhook request. </p>" 2105 } 2106 }, 2107 "com.amazonaws.amplify#DeleteWebhookResult": { 2108 "type": "structure", 2109 "members": { 2110 "webhook": { 2111 "target": "com.amazonaws.amplify#Webhook", 2112 "traits": { 2113 "smithy.api#documentation": "<p> Describes a webhook that connects repository events to an Amplify app. </p>", 2114 "smithy.api#required": {} 2115 } 2116 } 2117 }, 2118 "traits": { 2119 "smithy.api#documentation": "<p> The result structure for the delete webhook request. </p>" 2120 } 2121 }, 2122 "com.amazonaws.amplify#DependentServiceFailureException": { 2123 "type": "structure", 2124 "members": { 2125 "message": { 2126 "target": "com.amazonaws.amplify#ErrorMessage" 2127 } 2128 }, 2129 "traits": { 2130 "smithy.api#documentation": "<p> An operation failed because a dependent service threw an exception. </p>", 2131 "smithy.api#error": "server", 2132 "smithy.api#httpError": 503 2133 } 2134 }, 2135 "com.amazonaws.amplify#DeploymentArtifacts": { 2136 "type": "string", 2137 "traits": { 2138 "smithy.api#length": { 2139 "min": 1, 2140 "max": 1000 2141 } 2142 } 2143 }, 2144 "com.amazonaws.amplify#Description": { 2145 "type": "string", 2146 "traits": { 2147 "smithy.api#length": { 2148 "min": 0, 2149 "max": 1000 2150 } 2151 } 2152 }, 2153 "com.amazonaws.amplify#DisplayName": { 2154 "type": "string", 2155 "traits": { 2156 "smithy.api#length": { 2157 "min": 0, 2158 "max": 255 2159 } 2160 } 2161 }, 2162 "com.amazonaws.amplify#DomainAssociation": { 2163 "type": "structure", 2164 "members": { 2165 "domainAssociationArn": { 2166 "target": "com.amazonaws.amplify#DomainAssociationArn", 2167 "traits": { 2168 "smithy.api#documentation": "<p> The Amazon Resource Name (ARN) for the domain association. </p>", 2169 "smithy.api#required": {} 2170 } 2171 }, 2172 "domainName": { 2173 "target": "com.amazonaws.amplify#DomainName", 2174 "traits": { 2175 "smithy.api#documentation": "<p> The name of the domain. </p>", 2176 "smithy.api#required": {} 2177 } 2178 }, 2179 "enableAutoSubDomain": { 2180 "target": "com.amazonaws.amplify#EnableAutoSubDomain", 2181 "traits": { 2182 "smithy.api#documentation": "<p> Enables the automated creation of subdomains for branches. </p>", 2183 "smithy.api#required": {} 2184 } 2185 }, 2186 "autoSubDomainCreationPatterns": { 2187 "target": "com.amazonaws.amplify#AutoSubDomainCreationPatterns", 2188 "traits": { 2189 "smithy.api#documentation": "<p> Sets branch patterns for automatic subdomain creation. </p>" 2190 } 2191 }, 2192 "autoSubDomainIAMRole": { 2193 "target": "com.amazonaws.amplify#AutoSubDomainIAMRole", 2194 "traits": { 2195 "smithy.api#documentation": "<p> The required AWS Identity and Access Management (IAM) service role for the Amazon\n Resource Name (ARN) for automatically creating subdomains. </p>" 2196 } 2197 }, 2198 "domainStatus": { 2199 "target": "com.amazonaws.amplify#DomainStatus", 2200 "traits": { 2201 "smithy.api#documentation": "<p> The current status of the domain association. </p>", 2202 "smithy.api#required": {} 2203 } 2204 }, 2205 "statusReason": { 2206 "target": "com.amazonaws.amplify#StatusReason", 2207 "traits": { 2208 "smithy.api#documentation": "<p> The reason for the current status of the domain association. </p>", 2209 "smithy.api#required": {} 2210 } 2211 }, 2212 "certificateVerificationDNSRecord": { 2213 "target": "com.amazonaws.amplify#CertificateVerificationDNSRecord", 2214 "traits": { 2215 "smithy.api#documentation": "<p> The DNS record for certificate verification. </p>" 2216 } 2217 }, 2218 "subDomains": { 2219 "target": "com.amazonaws.amplify#SubDomains", 2220 "traits": { 2221 "smithy.api#documentation": "<p> The subdomains for the domain association. </p>", 2222 "smithy.api#required": {} 2223 } 2224 } 2225 }, 2226 "traits": { 2227 "smithy.api#documentation": "<p> Describes a domain association that associates a custom domain with an Amplify app.\n </p>" 2228 } 2229 }, 2230 "com.amazonaws.amplify#DomainAssociationArn": { 2231 "type": "string", 2232 "traits": { 2233 "smithy.api#length": { 2234 "min": 0, 2235 "max": 1000 2236 } 2237 } 2238 }, 2239 "com.amazonaws.amplify#DomainAssociations": { 2240 "type": "list", 2241 "member": { 2242 "target": "com.amazonaws.amplify#DomainAssociation" 2243 }, 2244 "traits": { 2245 "smithy.api#length": { 2246 "min": 0, 2247 "max": 255 2248 } 2249 } 2250 }, 2251 "com.amazonaws.amplify#DomainName": { 2252 "type": "string", 2253 "traits": { 2254 "smithy.api#length": { 2255 "min": 0, 2256 "max": 255 2257 } 2258 } 2259 }, 2260 "com.amazonaws.amplify#DomainPrefix": { 2261 "type": "string", 2262 "traits": { 2263 "smithy.api#length": { 2264 "min": 0, 2265 "max": 255 2266 } 2267 } 2268 }, 2269 "com.amazonaws.amplify#DomainStatus": { 2270 "type": "string", 2271 "traits": { 2272 "smithy.api#enum": [ 2273 { 2274 "value": "PENDING_VERIFICATION", 2275 "name": "PENDING_VERIFICATION" 2276 }, 2277 { 2278 "value": "IN_PROGRESS", 2279 "name": "IN_PROGRESS" 2280 }, 2281 { 2282 "value": "AVAILABLE", 2283 "name": "AVAILABLE" 2284 }, 2285 { 2286 "value": "PENDING_DEPLOYMENT", 2287 "name": "PENDING_DEPLOYMENT" 2288 }, 2289 { 2290 "value": "FAILED", 2291 "name": "FAILED" 2292 }, 2293 { 2294 "value": "CREATING", 2295 "name": "CREATING" 2296 }, 2297 { 2298 "value": "REQUESTING_CERTIFICATE", 2299 "name": "REQUESTING_CERTIFICATE" 2300 }, 2301 { 2302 "value": "UPDATING", 2303 "name": "UPDATING" 2304 } 2305 ] 2306 } 2307 }, 2308 "com.amazonaws.amplify#EnableAutoBranchCreation": { 2309 "type": "boolean", 2310 "traits": { 2311 "smithy.api#box": {} 2312 } 2313 }, 2314 "com.amazonaws.amplify#EnableAutoBuild": { 2315 "type": "boolean", 2316 "traits": { 2317 "smithy.api#box": {} 2318 } 2319 }, 2320 "com.amazonaws.amplify#EnableAutoSubDomain": { 2321 "type": "boolean", 2322 "traits": { 2323 "smithy.api#box": {} 2324 } 2325 }, 2326 "com.amazonaws.amplify#EnableBasicAuth": { 2327 "type": "boolean", 2328 "traits": { 2329 "smithy.api#box": {} 2330 } 2331 }, 2332 "com.amazonaws.amplify#EnableBranchAutoBuild": { 2333 "type": "boolean", 2334 "traits": { 2335 "smithy.api#box": {} 2336 } 2337 }, 2338 "com.amazonaws.amplify#EnableBranchAutoDeletion": { 2339 "type": "boolean", 2340 "traits": { 2341 "smithy.api#box": {} 2342 } 2343 }, 2344 "com.amazonaws.amplify#EnableNotification": { 2345 "type": "boolean", 2346 "traits": { 2347 "smithy.api#box": {} 2348 } 2349 }, 2350 "com.amazonaws.amplify#EnablePerformanceMode": { 2351 "type": "boolean", 2352 "traits": { 2353 "smithy.api#box": {} 2354 } 2355 }, 2356 "com.amazonaws.amplify#EnablePullRequestPreview": { 2357 "type": "boolean", 2358 "traits": { 2359 "smithy.api#box": {} 2360 } 2361 }, 2362 "com.amazonaws.amplify#EndTime": { 2363 "type": "timestamp" 2364 }, 2365 "com.amazonaws.amplify#EnvKey": { 2366 "type": "string", 2367 "traits": { 2368 "smithy.api#length": { 2369 "min": 0, 2370 "max": 255 2371 } 2372 } 2373 }, 2374 "com.amazonaws.amplify#EnvValue": { 2375 "type": "string", 2376 "traits": { 2377 "smithy.api#length": { 2378 "min": 0, 2379 "max": 1000 2380 } 2381 } 2382 }, 2383 "com.amazonaws.amplify#EnvironmentName": { 2384 "type": "string", 2385 "traits": { 2386 "smithy.api#length": { 2387 "min": 1, 2388 "max": 255 2389 } 2390 } 2391 }, 2392 "com.amazonaws.amplify#EnvironmentVariables": { 2393 "type": "map", 2394 "key": { 2395 "target": "com.amazonaws.amplify#EnvKey" 2396 }, 2397 "value": { 2398 "target": "com.amazonaws.amplify#EnvValue" 2399 } 2400 }, 2401 "com.amazonaws.amplify#ErrorMessage": { 2402 "type": "string", 2403 "traits": { 2404 "smithy.api#length": { 2405 "min": 0, 2406 "max": 255 2407 } 2408 } 2409 }, 2410 "com.amazonaws.amplify#FileMap": { 2411 "type": "map", 2412 "key": { 2413 "target": "com.amazonaws.amplify#FileName" 2414 }, 2415 "value": { 2416 "target": "com.amazonaws.amplify#MD5Hash" 2417 } 2418 }, 2419 "com.amazonaws.amplify#FileName": { 2420 "type": "string", 2421 "traits": { 2422 "smithy.api#length": { 2423 "min": 0, 2424 "max": 255 2425 } 2426 } 2427 }, 2428 "com.amazonaws.amplify#FileUploadUrls": { 2429 "type": "map", 2430 "key": { 2431 "target": "com.amazonaws.amplify#FileName" 2432 }, 2433 "value": { 2434 "target": "com.amazonaws.amplify#UploadUrl" 2435 } 2436 }, 2437 "com.amazonaws.amplify#Framework": { 2438 "type": "string", 2439 "traits": { 2440 "smithy.api#length": { 2441 "min": 0, 2442 "max": 255 2443 } 2444 } 2445 }, 2446 "com.amazonaws.amplify#GenerateAccessLogs": { 2447 "type": "operation", 2448 "input": { 2449 "target": "com.amazonaws.amplify#GenerateAccessLogsRequest" 2450 }, 2451 "output": { 2452 "target": "com.amazonaws.amplify#GenerateAccessLogsResult" 2453 }, 2454 "errors": [ 2455 { 2456 "target": "com.amazonaws.amplify#BadRequestException" 2457 }, 2458 { 2459 "target": "com.amazonaws.amplify#InternalFailureException" 2460 }, 2461 { 2462 "target": "com.amazonaws.amplify#NotFoundException" 2463 }, 2464 { 2465 "target": "com.amazonaws.amplify#UnauthorizedException" 2466 } 2467 ], 2468 "traits": { 2469 "smithy.api#documentation": "<p> Returns the website access logs for a specific time range using a presigned URL.\n </p>", 2470 "smithy.api#http": { 2471 "method": "POST", 2472 "uri": "/apps/{appId}/accesslogs", 2473 "code": 200 2474 } 2475 } 2476 }, 2477 "com.amazonaws.amplify#GenerateAccessLogsRequest": { 2478 "type": "structure", 2479 "members": { 2480 "startTime": { 2481 "target": "com.amazonaws.amplify#StartTime", 2482 "traits": { 2483 "smithy.api#documentation": "<p> The time at which the logs should start. The time range specified is inclusive of the\n start time. </p>" 2484 } 2485 }, 2486 "endTime": { 2487 "target": "com.amazonaws.amplify#EndTime", 2488 "traits": { 2489 "smithy.api#documentation": "<p> The time at which the logs should end. The time range specified is inclusive of the\n end time. </p>" 2490 } 2491 }, 2492 "domainName": { 2493 "target": "com.amazonaws.amplify#DomainName", 2494 "traits": { 2495 "smithy.api#documentation": "<p> The name of the domain. </p>", 2496 "smithy.api#required": {} 2497 } 2498 }, 2499 "appId": { 2500 "target": "com.amazonaws.amplify#AppId", 2501 "traits": { 2502 "smithy.api#documentation": "<p> The unique ID for an Amplify app. </p>", 2503 "smithy.api#httpLabel": {}, 2504 "smithy.api#required": {} 2505 } 2506 } 2507 }, 2508 "traits": { 2509 "smithy.api#documentation": "<p> The request structure for the generate access logs request. </p>" 2510 } 2511 }, 2512 "com.amazonaws.amplify#GenerateAccessLogsResult": { 2513 "type": "structure", 2514 "members": { 2515 "logUrl": { 2516 "target": "com.amazonaws.amplify#LogUrl", 2517 "traits": { 2518 "smithy.api#documentation": "<p> The pre-signed URL for the requested access logs. </p>" 2519 } 2520 } 2521 }, 2522 "traits": { 2523 "smithy.api#documentation": "<p> The result structure for the generate access logs request. </p>" 2524 } 2525 }, 2526 "com.amazonaws.amplify#GetApp": { 2527 "type": "operation", 2528 "input": { 2529 "target": "com.amazonaws.amplify#GetAppRequest" 2530 }, 2531 "output": { 2532 "target": "com.amazonaws.amplify#GetAppResult" 2533 }, 2534 "errors": [ 2535 { 2536 "target": "com.amazonaws.amplify#BadRequestException" 2537 }, 2538 { 2539 "target": "com.amazonaws.amplify#InternalFailureException" 2540 }, 2541 { 2542 "target": "com.amazonaws.amplify#NotFoundException" 2543 }, 2544 { 2545 "target": "com.amazonaws.amplify#UnauthorizedException" 2546 } 2547 ], 2548 "traits": { 2549 "smithy.api#documentation": "<p> Returns an existing Amplify app by appID. </p>", 2550 "smithy.api#http": { 2551 "method": "GET", 2552 "uri": "/apps/{appId}", 2553 "code": 200 2554 } 2555 } 2556 }, 2557 "com.amazonaws.amplify#GetAppRequest": { 2558 "type": "structure", 2559 "members": { 2560 "appId": { 2561 "target": "com.amazonaws.amplify#AppId", 2562 "traits": { 2563 "smithy.api#documentation": "<p> The unique ID for an Amplify app. </p>", 2564 "smithy.api#httpLabel": {}, 2565 "smithy.api#required": {} 2566 } 2567 } 2568 }, 2569 "traits": { 2570 "smithy.api#documentation": "<p> The request structure for the get app request. </p>" 2571 } 2572 }, 2573 "com.amazonaws.amplify#GetAppResult": { 2574 "type": "structure", 2575 "members": { 2576 "app": { 2577 "target": "com.amazonaws.amplify#App", 2578 "traits": { 2579 "smithy.api#required": {} 2580 } 2581 } 2582 } 2583 }, 2584 "com.amazonaws.amplify#GetArtifactUrl": { 2585 "type": "operation", 2586 "input": { 2587 "target": "com.amazonaws.amplify#GetArtifactUrlRequest" 2588 }, 2589 "output": { 2590 "target": "com.amazonaws.amplify#GetArtifactUrlResult" 2591 }, 2592 "errors": [ 2593 { 2594 "target": "com.amazonaws.amplify#BadRequestException" 2595 }, 2596 { 2597 "target": "com.amazonaws.amplify#InternalFailureException" 2598 }, 2599 { 2600 "target": "com.amazonaws.amplify#LimitExceededException" 2601 }, 2602 { 2603 "target": "com.amazonaws.amplify#NotFoundException" 2604 }, 2605 { 2606 "target": "com.amazonaws.amplify#UnauthorizedException" 2607 } 2608 ], 2609 "traits": { 2610 "smithy.api#documentation": "<p> Returns the artifact info that corresponds to an artifact id. </p>", 2611 "smithy.api#http": { 2612 "method": "GET", 2613 "uri": "/artifacts/{artifactId}", 2614 "code": 200 2615 } 2616 } 2617 }, 2618 "com.amazonaws.amplify#GetArtifactUrlRequest": { 2619 "type": "structure", 2620 "members": { 2621 "artifactId": { 2622 "target": "com.amazonaws.amplify#ArtifactId", 2623 "traits": { 2624 "smithy.api#documentation": "<p> The unique ID for an artifact. </p>", 2625 "smithy.api#httpLabel": {}, 2626 "smithy.api#required": {} 2627 } 2628 } 2629 }, 2630 "traits": { 2631 "smithy.api#documentation": "<p> Returns the request structure for the get artifact request. </p>" 2632 } 2633 }, 2634 "com.amazonaws.amplify#GetArtifactUrlResult": { 2635 "type": "structure", 2636 "members": { 2637 "artifactId": { 2638 "target": "com.amazonaws.amplify#ArtifactId", 2639 "traits": { 2640 "smithy.api#documentation": "<p> The unique ID for an artifact. </p>", 2641 "smithy.api#required": {} 2642 } 2643 }, 2644 "artifactUrl": { 2645 "target": "com.amazonaws.amplify#ArtifactUrl", 2646 "traits": { 2647 "smithy.api#documentation": "<p> The presigned URL for the artifact. </p>", 2648 "smithy.api#required": {} 2649 } 2650 } 2651 }, 2652 "traits": { 2653 "smithy.api#documentation": "<p> Returns the result structure for the get artifact request. </p>" 2654 } 2655 }, 2656 "com.amazonaws.amplify#GetBackendEnvironment": { 2657 "type": "operation", 2658 "input": { 2659 "target": "com.amazonaws.amplify#GetBackendEnvironmentRequest" 2660 }, 2661 "output": { 2662 "target": "com.amazonaws.amplify#GetBackendEnvironmentResult" 2663 }, 2664 "errors": [ 2665 { 2666 "target": "com.amazonaws.amplify#BadRequestException" 2667 }, 2668 { 2669 "target": "com.amazonaws.amplify#InternalFailureException" 2670 }, 2671 { 2672 "target": "com.amazonaws.amplify#NotFoundException" 2673 }, 2674 { 2675 "target": "com.amazonaws.amplify#UnauthorizedException" 2676 } 2677 ], 2678 "traits": { 2679 "smithy.api#documentation": "<p> Returns a backend environment for an Amplify app. </p>", 2680 "smithy.api#http": { 2681 "method": "GET", 2682 "uri": "/apps/{appId}/backendenvironments/{environmentName}", 2683 "code": 200 2684 } 2685 } 2686 }, 2687 "com.amazonaws.amplify#GetBackendEnvironmentRequest": { 2688 "type": "structure", 2689 "members": { 2690 "appId": { 2691 "target": "com.amazonaws.amplify#AppId", 2692 "traits": { 2693 "smithy.api#documentation": "<p> The unique id for an Amplify app. </p>", 2694 "smithy.api#httpLabel": {}, 2695 "smithy.api#required": {} 2696 } 2697 }, 2698 "environmentName": { 2699 "target": "com.amazonaws.amplify#EnvironmentName", 2700 "traits": { 2701 "smithy.api#documentation": "<p> The name for the backend environment. </p>", 2702 "smithy.api#httpLabel": {}, 2703 "smithy.api#required": {} 2704 } 2705 } 2706 }, 2707 "traits": { 2708 "smithy.api#documentation": "<p> The request structure for the get backend environment request. </p>" 2709 } 2710 }, 2711 "com.amazonaws.amplify#GetBackendEnvironmentResult": { 2712 "type": "structure", 2713 "members": { 2714 "backendEnvironment": { 2715 "target": "com.amazonaws.amplify#BackendEnvironment", 2716 "traits": { 2717 "smithy.api#documentation": "<p> Describes the backend environment for an Amplify app. </p>", 2718 "smithy.api#required": {} 2719 } 2720 } 2721 }, 2722 "traits": { 2723 "smithy.api#documentation": "<p> The result structure for the get backend environment result. </p>" 2724 } 2725 }, 2726 "com.amazonaws.amplify#GetBranch": { 2727 "type": "operation", 2728 "input": { 2729 "target": "com.amazonaws.amplify#GetBranchRequest" 2730 }, 2731 "output": { 2732 "target": "com.amazonaws.amplify#GetBranchResult" 2733 }, 2734 "errors": [ 2735 { 2736 "target": "com.amazonaws.amplify#BadRequestException" 2737 }, 2738 { 2739 "target": "com.amazonaws.amplify#InternalFailureException" 2740 }, 2741 { 2742 "target": "com.amazonaws.amplify#NotFoundException" 2743 }, 2744 { 2745 "target": "com.amazonaws.amplify#UnauthorizedException" 2746 } 2747 ], 2748 "traits": { 2749 "smithy.api#documentation": "<p> Returns a branch for an Amplify app. </p>", 2750 "smithy.api#http": { 2751 "method": "GET", 2752 "uri": "/apps/{appId}/branches/{branchName}", 2753 "code": 200 2754 } 2755 } 2756 }, 2757 "com.amazonaws.amplify#GetBranchRequest": { 2758 "type": "structure", 2759 "members": { 2760 "appId": { 2761 "target": "com.amazonaws.amplify#AppId", 2762 "traits": { 2763 "smithy.api#documentation": "<p> The unique ID for an Amplify app. </p>", 2764 "smithy.api#httpLabel": {}, 2765 "smithy.api#required": {} 2766 } 2767 }, 2768 "branchName": { 2769 "target": "com.amazonaws.amplify#BranchName", 2770 "traits": { 2771 "smithy.api#documentation": "<p> The name for the branch. </p>", 2772 "smithy.api#httpLabel": {}, 2773 "smithy.api#required": {} 2774 } 2775 } 2776 }, 2777 "traits": { 2778 "smithy.api#documentation": "<p> The request structure for the get branch request. </p>" 2779 } 2780 }, 2781 "com.amazonaws.amplify#GetBranchResult": { 2782 "type": "structure", 2783 "members": { 2784 "branch": { 2785 "target": "com.amazonaws.amplify#Branch", 2786 "traits": { 2787 "smithy.api#required": {} 2788 } 2789 } 2790 } 2791 }, 2792 "com.amazonaws.amplify#GetDomainAssociation": { 2793 "type": "operation", 2794 "input": { 2795 "target": "com.amazonaws.amplify#GetDomainAssociationRequest" 2796 }, 2797 "output": { 2798 "target": "com.amazonaws.amplify#GetDomainAssociationResult" 2799 }, 2800 "errors": [ 2801 { 2802 "target": "com.amazonaws.amplify#BadRequestException" 2803 }, 2804 { 2805 "target": "com.amazonaws.amplify#InternalFailureException" 2806 }, 2807 { 2808 "target": "com.amazonaws.amplify#NotFoundException" 2809 }, 2810 { 2811 "target": "com.amazonaws.amplify#UnauthorizedException" 2812 } 2813 ], 2814 "traits": { 2815 "smithy.api#documentation": "<p> Returns the domain information for an Amplify app. </p>", 2816 "smithy.api#http": { 2817 "method": "GET", 2818 "uri": "/apps/{appId}/domains/{domainName}", 2819 "code": 200 2820 } 2821 } 2822 }, 2823 "com.amazonaws.amplify#GetDomainAssociationRequest": { 2824 "type": "structure", 2825 "members": { 2826 "appId": { 2827 "target": "com.amazonaws.amplify#AppId", 2828 "traits": { 2829 "smithy.api#documentation": "<p> The unique id for an Amplify app. </p>", 2830 "smithy.api#httpLabel": {}, 2831 "smithy.api#required": {} 2832 } 2833 }, 2834 "domainName": { 2835 "target": "com.amazonaws.amplify#DomainName", 2836 "traits": { 2837 "smithy.api#documentation": "<p> The name of the domain. </p>", 2838 "smithy.api#httpLabel": {}, 2839 "smithy.api#required": {} 2840 } 2841 } 2842 }, 2843 "traits": { 2844 "smithy.api#documentation": "<p> The request structure for the get domain association request. </p>" 2845 } 2846 }, 2847 "com.amazonaws.amplify#GetDomainAssociationResult": { 2848 "type": "structure", 2849 "members": { 2850 "domainAssociation": { 2851 "target": "com.amazonaws.amplify#DomainAssociation", 2852 "traits": { 2853 "smithy.api#documentation": "<p> Describes the structure of a domain association, which associates a custom domain\n with an Amplify app. </p>", 2854 "smithy.api#required": {} 2855 } 2856 } 2857 }, 2858 "traits": { 2859 "smithy.api#documentation": "<p> The result structure for the get domain association request. </p>" 2860 } 2861 }, 2862 "com.amazonaws.amplify#GetJob": { 2863 "type": "operation", 2864 "input": { 2865 "target": "com.amazonaws.amplify#GetJobRequest" 2866 }, 2867 "output": { 2868 "target": "com.amazonaws.amplify#GetJobResult" 2869 }, 2870 "errors": [ 2871 { 2872 "target": "com.amazonaws.amplify#BadRequestException" 2873 }, 2874 { 2875 "target": "com.amazonaws.amplify#InternalFailureException" 2876 }, 2877 { 2878 "target": "com.amazonaws.amplify#LimitExceededException" 2879 }, 2880 { 2881 "target": "com.amazonaws.amplify#NotFoundException" 2882 }, 2883 { 2884 "target": "com.amazonaws.amplify#UnauthorizedException" 2885 } 2886 ], 2887 "traits": { 2888 "smithy.api#documentation": "<p> Returns a job for a branch of an Amplify app. </p>", 2889 "smithy.api#http": { 2890 "method": "GET", 2891 "uri": "/apps/{appId}/branches/{branchName}/jobs/{jobId}", 2892 "code": 200 2893 } 2894 } 2895 }, 2896 "com.amazonaws.amplify#GetJobRequest": { 2897 "type": "structure", 2898 "members": { 2899 "appId": { 2900 "target": "com.amazonaws.amplify#AppId", 2901 "traits": { 2902 "smithy.api#documentation": "<p> The unique ID for an Amplify app. </p>", 2903 "smithy.api#httpLabel": {}, 2904 "smithy.api#required": {} 2905 } 2906 }, 2907 "branchName": { 2908 "target": "com.amazonaws.amplify#BranchName", 2909 "traits": { 2910 "smithy.api#documentation": "<p> The branch name for the job. </p>", 2911 "smithy.api#httpLabel": {}, 2912 "smithy.api#required": {} 2913 } 2914 }, 2915 "jobId": { 2916 "target": "com.amazonaws.amplify#JobId", 2917 "traits": { 2918 "smithy.api#documentation": "<p> The unique ID for the job. </p>", 2919 "smithy.api#httpLabel": {}, 2920 "smithy.api#required": {} 2921 } 2922 } 2923 }, 2924 "traits": { 2925 "smithy.api#documentation": "<p> The request structure for the get job request. </p>" 2926 } 2927 }, 2928 "com.amazonaws.amplify#GetJobResult": { 2929 "type": "structure", 2930 "members": { 2931 "job": { 2932 "target": "com.amazonaws.amplify#Job", 2933 "traits": { 2934 "smithy.api#required": {} 2935 } 2936 } 2937 } 2938 }, 2939 "com.amazonaws.amplify#GetWebhook": { 2940 "type": "operation", 2941 "input": { 2942 "target": "com.amazonaws.amplify#GetWebhookRequest" 2943 }, 2944 "output": { 2945 "target": "com.amazonaws.amplify#GetWebhookResult" 2946 }, 2947 "errors": [ 2948 { 2949 "target": "com.amazonaws.amplify#BadRequestException" 2950 }, 2951 { 2952 "target": "com.amazonaws.amplify#InternalFailureException" 2953 }, 2954 { 2955 "target": "com.amazonaws.amplify#LimitExceededException" 2956 }, 2957 { 2958 "target": "com.amazonaws.amplify#NotFoundException" 2959 }, 2960 { 2961 "target": "com.amazonaws.amplify#UnauthorizedException" 2962 } 2963 ], 2964 "traits": { 2965 "smithy.api#documentation": "<p> Returns the webhook information that corresponds to a specified webhook ID. </p>", 2966 "smithy.api#http": { 2967 "method": "GET", 2968 "uri": "/webhooks/{webhookId}", 2969 "code": 200 2970 } 2971 } 2972 }, 2973 "com.amazonaws.amplify#GetWebhookRequest": { 2974 "type": "structure", 2975 "members": { 2976 "webhookId": { 2977 "target": "com.amazonaws.amplify#WebhookId", 2978 "traits": { 2979 "smithy.api#documentation": "<p> The unique ID for a webhook. </p>", 2980 "smithy.api#httpLabel": {}, 2981 "smithy.api#required": {} 2982 } 2983 } 2984 }, 2985 "traits": { 2986 "smithy.api#documentation": "<p> The request structure for the get webhook request. </p>" 2987 } 2988 }, 2989 "com.amazonaws.amplify#GetWebhookResult": { 2990 "type": "structure", 2991 "members": { 2992 "webhook": { 2993 "target": "com.amazonaws.amplify#Webhook", 2994 "traits": { 2995 "smithy.api#documentation": "<p> Describes the structure of a webhook. </p>", 2996 "smithy.api#required": {} 2997 } 2998 } 2999 }, 3000 "traits": { 3001 "smithy.api#documentation": "<p> The result structure for the get webhook request. </p>" 3002 } 3003 }, 3004 "com.amazonaws.amplify#InternalFailureException": { 3005 "type": "structure", 3006 "members": { 3007 "message": { 3008 "target": "com.amazonaws.amplify#ErrorMessage" 3009 } 3010 }, 3011 "traits": { 3012 "smithy.api#documentation": "<p> The service failed to perform an operation due to an internal issue. </p>", 3013 "smithy.api#error": "server", 3014 "smithy.api#httpError": 500 3015 } 3016 }, 3017 "com.amazonaws.amplify#Job": { 3018 "type": "structure", 3019 "members": { 3020 "summary": { 3021 "target": "com.amazonaws.amplify#JobSummary", 3022 "traits": { 3023 "smithy.api#documentation": "<p> Describes the summary for an execution job for an Amplify app. </p>", 3024 "smithy.api#required": {} 3025 } 3026 }, 3027 "steps": { 3028 "target": "com.amazonaws.amplify#Steps", 3029 "traits": { 3030 "smithy.api#documentation": "<p> The execution steps for an execution job, for an Amplify app. </p>", 3031 "smithy.api#required": {} 3032 } 3033 } 3034 }, 3035 "traits": { 3036 "smithy.api#documentation": "<p> Describes an execution job for an Amplify app. </p>" 3037 } 3038 }, 3039 "com.amazonaws.amplify#JobArn": { 3040 "type": "string", 3041 "traits": { 3042 "smithy.api#length": { 3043 "min": 0, 3044 "max": 1000 3045 } 3046 } 3047 }, 3048 "com.amazonaws.amplify#JobId": { 3049 "type": "string", 3050 "traits": { 3051 "smithy.api#length": { 3052 "min": 0, 3053 "max": 255 3054 } 3055 } 3056 }, 3057 "com.amazonaws.amplify#JobReason": { 3058 "type": "string", 3059 "traits": { 3060 "smithy.api#length": { 3061 "min": 0, 3062 "max": 255 3063 } 3064 } 3065 }, 3066 "com.amazonaws.amplify#JobStatus": { 3067 "type": "string", 3068 "traits": { 3069 "smithy.api#enum": [ 3070 { 3071 "value": "PENDING", 3072 "name": "PENDING" 3073 }, 3074 { 3075 "value": "PROVISIONING", 3076 "name": "PROVISIONING" 3077 }, 3078 { 3079 "value": "RUNNING", 3080 "name": "RUNNING" 3081 }, 3082 { 3083 "value": "FAILED", 3084 "name": "FAILED" 3085 }, 3086 { 3087 "value": "SUCCEED", 3088 "name": "SUCCEED" 3089 }, 3090 { 3091 "value": "CANCELLING", 3092 "name": "CANCELLING" 3093 }, 3094 { 3095 "value": "CANCELLED", 3096 "name": "CANCELLED" 3097 } 3098 ] 3099 } 3100 }, 3101 "com.amazonaws.amplify#JobSummaries": { 3102 "type": "list", 3103 "member": { 3104 "target": "com.amazonaws.amplify#JobSummary" 3105 } 3106 }, 3107 "com.amazonaws.amplify#JobSummary": { 3108 "type": "structure", 3109 "members": { 3110 "jobArn": { 3111 "target": "com.amazonaws.amplify#JobArn", 3112 "traits": { 3113 "smithy.api#documentation": "<p> The Amazon Resource Name (ARN) for the job. </p>", 3114 "smithy.api#required": {} 3115 } 3116 }, 3117 "jobId": { 3118 "target": "com.amazonaws.amplify#JobId", 3119 "traits": { 3120 "smithy.api#documentation": "<p> The unique ID for the job. </p>", 3121 "smithy.api#required": {} 3122 } 3123 }, 3124 "commitId": { 3125 "target": "com.amazonaws.amplify#CommitId", 3126 "traits": { 3127 "smithy.api#documentation": "<p> The commit ID from a third-party repository provider for the job. </p>", 3128 "smithy.api#required": {} 3129 } 3130 }, 3131 "commitMessage": { 3132 "target": "com.amazonaws.amplify#CommitMessage", 3133 "traits": { 3134 "smithy.api#documentation": "<p> The commit message from a third-party repository provider for the job. </p>", 3135 "smithy.api#required": {} 3136 } 3137 }, 3138 "commitTime": { 3139 "target": "com.amazonaws.amplify#CommitTime", 3140 "traits": { 3141 "smithy.api#documentation": "<p> The commit date and time for the job. </p>", 3142 "smithy.api#required": {} 3143 } 3144 }, 3145 "startTime": { 3146 "target": "com.amazonaws.amplify#StartTime", 3147 "traits": { 3148 "smithy.api#documentation": "<p> The start date and time for the job. </p>", 3149 "smithy.api#required": {} 3150 } 3151 }, 3152 "status": { 3153 "target": "com.amazonaws.amplify#JobStatus", 3154 "traits": { 3155 "smithy.api#documentation": "<p> The current status for the job. </p>", 3156 "smithy.api#required": {} 3157 } 3158 }, 3159 "endTime": { 3160 "target": "com.amazonaws.amplify#EndTime", 3161 "traits": { 3162 "smithy.api#documentation": "<p> The end date and time for the job. </p>" 3163 } 3164 }, 3165 "jobType": { 3166 "target": "com.amazonaws.amplify#JobType", 3167 "traits": { 3168 "smithy.api#documentation": "<p> The type for the job. If the value is <code>RELEASE</code>, the job was manually\n released from its source by using the <code>StartJob</code> API. If the value is\n <code>RETRY</code>, the job was manually retried using the <code>StartJob</code>\n API. If the value is <code>WEB_HOOK</code>, the job was automatically triggered by\n webhooks. </p>", 3169 "smithy.api#required": {} 3170 } 3171 } 3172 }, 3173 "traits": { 3174 "smithy.api#documentation": "<p> Describes the summary for an execution job for an Amplify app. </p>" 3175 } 3176 }, 3177 "com.amazonaws.amplify#JobType": { 3178 "type": "string", 3179 "traits": { 3180 "smithy.api#enum": [ 3181 { 3182 "value": "RELEASE", 3183 "name": "RELEASE" 3184 }, 3185 { 3186 "value": "RETRY", 3187 "name": "RETRY" 3188 }, 3189 { 3190 "value": "MANUAL", 3191 "name": "MANUAL" 3192 }, 3193 { 3194 "value": "WEB_HOOK", 3195 "name": "WEB_HOOK" 3196 } 3197 ], 3198 "smithy.api#length": { 3199 "min": 0, 3200 "max": 10 3201 } 3202 } 3203 }, 3204 "com.amazonaws.amplify#LastDeployTime": { 3205 "type": "timestamp" 3206 }, 3207 "com.amazonaws.amplify#LimitExceededException": { 3208 "type": "structure", 3209 "members": { 3210 "message": { 3211 "target": "com.amazonaws.amplify#ErrorMessage" 3212 } 3213 }, 3214 "traits": { 3215 "smithy.api#documentation": "<p> A resource could not be created because service quotas were exceeded. </p>", 3216 "smithy.api#error": "client", 3217 "smithy.api#httpError": 429 3218 } 3219 }, 3220 "com.amazonaws.amplify#ListApps": { 3221 "type": "operation", 3222 "input": { 3223 "target": "com.amazonaws.amplify#ListAppsRequest" 3224 }, 3225 "output": { 3226 "target": "com.amazonaws.amplify#ListAppsResult" 3227 }, 3228 "errors": [ 3229 { 3230 "target": "com.amazonaws.amplify#BadRequestException" 3231 }, 3232 { 3233 "target": "com.amazonaws.amplify#InternalFailureException" 3234 }, 3235 { 3236 "target": "com.amazonaws.amplify#UnauthorizedException" 3237 } 3238 ], 3239 "traits": { 3240 "smithy.api#documentation": "<p> Returns a list of the existing Amplify apps. </p>", 3241 "smithy.api#http": { 3242 "method": "GET", 3243 "uri": "/apps", 3244 "code": 200 3245 } 3246 } 3247 }, 3248 "com.amazonaws.amplify#ListAppsRequest": { 3249 "type": "structure", 3250 "members": { 3251 "nextToken": { 3252 "target": "com.amazonaws.amplify#NextToken", 3253 "traits": { 3254 "smithy.api#documentation": "<p> A pagination token. If non-null, the pagination token is returned in a result. Pass\n its value in another request to retrieve more entries. </p>", 3255 "smithy.api#httpQuery": "nextToken" 3256 } 3257 }, 3258 "maxResults": { 3259 "target": "com.amazonaws.amplify#MaxResults", 3260 "traits": { 3261 "smithy.api#documentation": "<p> The maximum number of records to list in a single response. </p>", 3262 "smithy.api#httpQuery": "maxResults" 3263 } 3264 } 3265 }, 3266 "traits": { 3267 "smithy.api#documentation": "<p> The request structure for the list apps request. </p>" 3268 } 3269 }, 3270 "com.amazonaws.amplify#ListAppsResult": { 3271 "type": "structure", 3272 "members": { 3273 "apps": { 3274 "target": "com.amazonaws.amplify#Apps", 3275 "traits": { 3276 "smithy.api#documentation": "<p> A list of Amplify apps. </p>", 3277 "smithy.api#required": {} 3278 } 3279 }, 3280 "nextToken": { 3281 "target": "com.amazonaws.amplify#NextToken", 3282 "traits": { 3283 "smithy.api#documentation": "<p> A pagination token. Set to null to start listing apps from start. If non-null, the\n pagination token is returned in a result. Pass its value in here to list more projects.\n </p>" 3284 } 3285 } 3286 }, 3287 "traits": { 3288 "smithy.api#documentation": "<p> The result structure for an Amplify app list request. </p>" 3289 } 3290 }, 3291 "com.amazonaws.amplify#ListArtifacts": { 3292 "type": "operation", 3293 "input": { 3294 "target": "com.amazonaws.amplify#ListArtifactsRequest" 3295 }, 3296 "output": { 3297 "target": "com.amazonaws.amplify#ListArtifactsResult" 3298 }, 3299 "errors": [ 3300 { 3301 "target": "com.amazonaws.amplify#BadRequestException" 3302 }, 3303 { 3304 "target": "com.amazonaws.amplify#InternalFailureException" 3305 }, 3306 { 3307 "target": "com.amazonaws.amplify#LimitExceededException" 3308 }, 3309 { 3310 "target": "com.amazonaws.amplify#UnauthorizedException" 3311 } 3312 ], 3313 "traits": { 3314 "smithy.api#documentation": "<p> Returns a list of artifacts for a specified app, branch, and job. </p>", 3315 "smithy.api#http": { 3316 "method": "GET", 3317 "uri": "/apps/{appId}/branches/{branchName}/jobs/{jobId}/artifacts", 3318 "code": 200 3319 } 3320 } 3321 }, 3322 "com.amazonaws.amplify#ListArtifactsRequest": { 3323 "type": "structure", 3324 "members": { 3325 "appId": { 3326 "target": "com.amazonaws.amplify#AppId", 3327 "traits": { 3328 "smithy.api#documentation": "<p> The unique ID for an Amplify app. </p>", 3329 "smithy.api#httpLabel": {}, 3330 "smithy.api#required": {} 3331 } 3332 }, 3333 "branchName": { 3334 "target": "com.amazonaws.amplify#BranchName", 3335 "traits": { 3336 "smithy.api#documentation": "<p> The name of a branch that is part of an Amplify app. </p>", 3337 "smithy.api#httpLabel": {}, 3338 "smithy.api#required": {} 3339 } 3340 }, 3341 "jobId": { 3342 "target": "com.amazonaws.amplify#JobId", 3343 "traits": { 3344 "smithy.api#documentation": "<p> The unique ID for a job. </p>", 3345 "smithy.api#httpLabel": {}, 3346 "smithy.api#required": {} 3347 } 3348 }, 3349 "nextToken": { 3350 "target": "com.amazonaws.amplify#NextToken", 3351 "traits": { 3352 "smithy.api#documentation": "<p> A pagination token. Set to null to start listing artifacts from start. If a non-null\n pagination token is returned in a result, pass its value in here to list more artifacts.\n </p>", 3353 "smithy.api#httpQuery": "nextToken" 3354 } 3355 }, 3356 "maxResults": { 3357 "target": "com.amazonaws.amplify#MaxResults", 3358 "traits": { 3359 "smithy.api#documentation": "<p> The maximum number of records to list in a single response. </p>", 3360 "smithy.api#httpQuery": "maxResults" 3361 } 3362 } 3363 }, 3364 "traits": { 3365 "smithy.api#documentation": "<p> Describes the request structure for the list artifacts request. </p>" 3366 } 3367 }, 3368 "com.amazonaws.amplify#ListArtifactsResult": { 3369 "type": "structure", 3370 "members": { 3371 "artifacts": { 3372 "target": "com.amazonaws.amplify#Artifacts", 3373 "traits": { 3374 "smithy.api#documentation": "<p> A list of artifacts. </p>", 3375 "smithy.api#required": {} 3376 } 3377 }, 3378 "nextToken": { 3379 "target": "com.amazonaws.amplify#NextToken", 3380 "traits": { 3381 "smithy.api#documentation": "<p> A pagination token. If a non-null pagination token is returned in a result, pass its\n value in another request to retrieve more entries. </p>" 3382 } 3383 } 3384 }, 3385 "traits": { 3386 "smithy.api#documentation": "<p> The result structure for the list artifacts request. </p>" 3387 } 3388 }, 3389 "com.amazonaws.amplify#ListBackendEnvironments": { 3390 "type": "operation", 3391 "input": { 3392 "target": "com.amazonaws.amplify#ListBackendEnvironmentsRequest" 3393 }, 3394 "output": { 3395 "target": "com.amazonaws.amplify#ListBackendEnvironmentsResult" 3396 }, 3397 "errors": [ 3398 { 3399 "target": "com.amazonaws.amplify#BadRequestException" 3400 }, 3401 { 3402 "target": "com.amazonaws.amplify#InternalFailureException" 3403 }, 3404 { 3405 "target": "com.amazonaws.amplify#UnauthorizedException" 3406 } 3407 ], 3408 "traits": { 3409 "smithy.api#documentation": "<p> Lists the backend environments for an Amplify app. </p>", 3410 "smithy.api#http": { 3411 "method": "GET", 3412 "uri": "/apps/{appId}/backendenvironments", 3413 "code": 200 3414 } 3415 } 3416 }, 3417 "com.amazonaws.amplify#ListBackendEnvironmentsRequest": { 3418 "type": "structure", 3419 "members": { 3420 "appId": { 3421 "target": "com.amazonaws.amplify#AppId", 3422 "traits": { 3423 "smithy.api#documentation": "<p> The unique ID for an Amplify app. </p>", 3424 "smithy.api#httpLabel": {}, 3425 "smithy.api#required": {} 3426 } 3427 }, 3428 "environmentName": { 3429 "target": "com.amazonaws.amplify#EnvironmentName", 3430 "traits": { 3431 "smithy.api#documentation": "<p> The name of the backend environment </p>", 3432 "smithy.api#httpQuery": "environmentName" 3433 } 3434 }, 3435 "nextToken": { 3436 "target": "com.amazonaws.amplify#NextToken", 3437 "traits": { 3438 "smithy.api#documentation": "<p> A pagination token. Set to null to start listing backend environments from the start.\n If a non-null pagination token is returned in a result, pass its value in here to list\n more backend environments. </p>", 3439 "smithy.api#httpQuery": "nextToken" 3440 } 3441 }, 3442 "maxResults": { 3443 "target": "com.amazonaws.amplify#MaxResults", 3444 "traits": { 3445 "smithy.api#documentation": "<p> The maximum number of records to list in a single response. </p>", 3446 "smithy.api#httpQuery": "maxResults" 3447 } 3448 } 3449 }, 3450 "traits": { 3451 "smithy.api#documentation": "<p> The request structure for the list backend environments request. </p>" 3452 } 3453 }, 3454 "com.amazonaws.amplify#ListBackendEnvironmentsResult": { 3455 "type": "structure", 3456 "members": { 3457 "backendEnvironments": { 3458 "target": "com.amazonaws.amplify#BackendEnvironments", 3459 "traits": { 3460 "smithy.api#documentation": "<p> The list of backend environments for an Amplify app. </p>", 3461 "smithy.api#required": {} 3462 } 3463 }, 3464 "nextToken": { 3465 "target": "com.amazonaws.amplify#NextToken", 3466 "traits": { 3467 "smithy.api#documentation": "<p> A pagination token. If a non-null pagination token is returned in a result, pass its\n value in another request to retrieve more entries. </p>" 3468 } 3469 } 3470 }, 3471 "traits": { 3472 "smithy.api#documentation": "<p> The result structure for the list backend environments result. </p>" 3473 } 3474 }, 3475 "com.amazonaws.amplify#ListBranches": { 3476 "type": "operation", 3477 "input": { 3478 "target": "com.amazonaws.amplify#ListBranchesRequest" 3479 }, 3480 "output": { 3481 "target": "com.amazonaws.amplify#ListBranchesResult" 3482 }, 3483 "errors": [ 3484 { 3485 "target": "com.amazonaws.amplify#BadRequestException" 3486 }, 3487 { 3488 "target": "com.amazonaws.amplify#InternalFailureException" 3489 }, 3490 { 3491 "target": "com.amazonaws.amplify#UnauthorizedException" 3492 } 3493 ], 3494 "traits": { 3495 "smithy.api#documentation": "<p> Lists the branches of an Amplify app. </p>", 3496 "smithy.api#http": { 3497 "method": "GET", 3498 "uri": "/apps/{appId}/branches", 3499 "code": 200 3500 } 3501 } 3502 }, 3503 "com.amazonaws.amplify#ListBranchesRequest": { 3504 "type": "structure", 3505 "members": { 3506 "appId": { 3507 "target": "com.amazonaws.amplify#AppId", 3508 "traits": { 3509 "smithy.api#documentation": "<p> The unique ID for an Amplify app. </p>", 3510 "smithy.api#httpLabel": {}, 3511 "smithy.api#required": {} 3512 } 3513 }, 3514 "nextToken": { 3515 "target": "com.amazonaws.amplify#NextToken", 3516 "traits": { 3517 "smithy.api#documentation": "<p> A pagination token. Set to null to start listing branches from the start. If a\n non-null pagination token is returned in a result, pass its value in here to list more\n branches. </p>", 3518 "smithy.api#httpQuery": "nextToken" 3519 } 3520 }, 3521 "maxResults": { 3522 "target": "com.amazonaws.amplify#MaxResults", 3523 "traits": { 3524 "smithy.api#documentation": "<p> The maximum number of records to list in a single response. </p>", 3525 "smithy.api#httpQuery": "maxResults" 3526 } 3527 } 3528 }, 3529 "traits": { 3530 "smithy.api#documentation": "<p> The request structure for the list branches request. </p>" 3531 } 3532 }, 3533 "com.amazonaws.amplify#ListBranchesResult": { 3534 "type": "structure", 3535 "members": { 3536 "branches": { 3537 "target": "com.amazonaws.amplify#Branches", 3538 "traits": { 3539 "smithy.api#documentation": "<p> A list of branches for an Amplify app. </p>", 3540 "smithy.api#required": {} 3541 } 3542 }, 3543 "nextToken": { 3544 "target": "com.amazonaws.amplify#NextToken", 3545 "traits": { 3546 "smithy.api#documentation": "<p> A pagination token. If a non-null pagination token is returned in a result, pass its\n value in another request to retrieve more entries. </p>" 3547 } 3548 } 3549 }, 3550 "traits": { 3551 "smithy.api#documentation": "<p> The result structure for the list branches request. </p>" 3552 } 3553 }, 3554 "com.amazonaws.amplify#ListDomainAssociations": { 3555 "type": "operation", 3556 "input": { 3557 "target": "com.amazonaws.amplify#ListDomainAssociationsRequest" 3558 }, 3559 "output": { 3560 "target": "com.amazonaws.amplify#ListDomainAssociationsResult" 3561 }, 3562 "errors": [ 3563 { 3564 "target": "com.amazonaws.amplify#BadRequestException" 3565 }, 3566 { 3567 "target": "com.amazonaws.amplify#InternalFailureException" 3568 }, 3569 { 3570 "target": "com.amazonaws.amplify#UnauthorizedException" 3571 } 3572 ], 3573 "traits": { 3574 "smithy.api#documentation": "<p> Returns the domain associations for an Amplify app. </p>", 3575 "smithy.api#http": { 3576 "method": "GET", 3577 "uri": "/apps/{appId}/domains", 3578 "code": 200 3579 } 3580 } 3581 }, 3582 "com.amazonaws.amplify#ListDomainAssociationsRequest": { 3583 "type": "structure", 3584 "members": { 3585 "appId": { 3586 "target": "com.amazonaws.amplify#AppId", 3587 "traits": { 3588 "smithy.api#documentation": "<p> The unique ID for an Amplify app. </p>", 3589 "smithy.api#httpLabel": {}, 3590 "smithy.api#required": {} 3591 } 3592 }, 3593 "nextToken": { 3594 "target": "com.amazonaws.amplify#NextToken", 3595 "traits": { 3596 "smithy.api#documentation": "<p> A pagination token. Set to null to start listing apps from the start. If non-null, a\n pagination token is returned in a result. Pass its value in here to list more projects.\n </p>", 3597 "smithy.api#httpQuery": "nextToken" 3598 } 3599 }, 3600 "maxResults": { 3601 "target": "com.amazonaws.amplify#MaxResults", 3602 "traits": { 3603 "smithy.api#documentation": "<p> The maximum number of records to list in a single response. </p>", 3604 "smithy.api#httpQuery": "maxResults" 3605 } 3606 } 3607 }, 3608 "traits": { 3609 "smithy.api#documentation": "<p> The request structure for the list domain associations request. </p>" 3610 } 3611 }, 3612 "com.amazonaws.amplify#ListDomainAssociationsResult": { 3613 "type": "structure", 3614 "members": { 3615 "domainAssociations": { 3616 "target": "com.amazonaws.amplify#DomainAssociations", 3617 "traits": { 3618 "smithy.api#documentation": "<p> A list of domain associations. </p>", 3619 "smithy.api#required": {} 3620 } 3621 }, 3622 "nextToken": { 3623 "target": "com.amazonaws.amplify#NextToken", 3624 "traits": { 3625 "smithy.api#documentation": "<p> A pagination token. If non-null, a pagination token is returned in a result. Pass its\n value in another request to retrieve more entries. </p>" 3626 } 3627 } 3628 }, 3629 "traits": { 3630 "smithy.api#documentation": "<p> The result structure for the list domain association request. </p>" 3631 } 3632 }, 3633 "com.amazonaws.amplify#ListJobs": { 3634 "type": "operation", 3635 "input": { 3636 "target": "com.amazonaws.amplify#ListJobsRequest" 3637 }, 3638 "output": { 3639 "target": "com.amazonaws.amplify#ListJobsResult" 3640 }, 3641 "errors": [ 3642 { 3643 "target": "com.amazonaws.amplify#BadRequestException" 3644 }, 3645 { 3646 "target": "com.amazonaws.amplify#InternalFailureException" 3647 }, 3648 { 3649 "target": "com.amazonaws.amplify#LimitExceededException" 3650 }, 3651 { 3652 "target": "com.amazonaws.amplify#UnauthorizedException" 3653 } 3654 ], 3655 "traits": { 3656 "smithy.api#documentation": "<p> Lists the jobs for a branch of an Amplify app. </p>", 3657 "smithy.api#http": { 3658 "method": "GET", 3659 "uri": "/apps/{appId}/branches/{branchName}/jobs", 3660 "code": 200 3661 } 3662 } 3663 }, 3664 "com.amazonaws.amplify#ListJobsRequest": { 3665 "type": "structure", 3666 "members": { 3667 "appId": { 3668 "target": "com.amazonaws.amplify#AppId", 3669 "traits": { 3670 "smithy.api#documentation": "<p> The unique ID for an Amplify app. </p>", 3671 "smithy.api#httpLabel": {}, 3672 "smithy.api#required": {} 3673 } 3674 }, 3675 "branchName": { 3676 "target": "com.amazonaws.amplify#BranchName", 3677 "traits": { 3678 "smithy.api#documentation": "<p> The name for a branch. </p>", 3679 "smithy.api#httpLabel": {}, 3680 "smithy.api#required": {} 3681 } 3682 }, 3683 "nextToken": { 3684 "target": "com.amazonaws.amplify#NextToken", 3685 "traits": { 3686 "smithy.api#documentation": "<p> A pagination token. Set to null to start listing steps from the start. If a non-null\n pagination token is returned in a result, pass its value in here to list more steps.\n </p>", 3687 "smithy.api#httpQuery": "nextToken" 3688 } 3689 }, 3690 "maxResults": { 3691 "target": "com.amazonaws.amplify#MaxResults", 3692 "traits": { 3693 "smithy.api#documentation": "<p> The maximum number of records to list in a single response. </p>", 3694 "smithy.api#httpQuery": "maxResults" 3695 } 3696 } 3697 }, 3698 "traits": { 3699 "smithy.api#documentation": "<p> The request structure for the list jobs request. </p>" 3700 } 3701 }, 3702 "com.amazonaws.amplify#ListJobsResult": { 3703 "type": "structure", 3704 "members": { 3705 "jobSummaries": { 3706 "target": "com.amazonaws.amplify#JobSummaries", 3707 "traits": { 3708 "smithy.api#documentation": "<p> The result structure for the list job result request. </p>", 3709 "smithy.api#required": {} 3710 } 3711 }, 3712 "nextToken": { 3713 "target": "com.amazonaws.amplify#NextToken", 3714 "traits": { 3715 "smithy.api#documentation": "<p> A pagination token. If non-null the pagination token is returned in a result. Pass\n its value in another request to retrieve more entries. </p>" 3716 } 3717 } 3718 }, 3719 "traits": { 3720 "smithy.api#documentation": "<p> The maximum number of records to list in a single response. </p>" 3721 } 3722 }, 3723 "com.amazonaws.amplify#ListTagsForResource": { 3724 "type": "operation", 3725 "input": { 3726 "target": "com.amazonaws.amplify#ListTagsForResourceRequest" 3727 }, 3728 "output": { 3729 "target": "com.amazonaws.amplify#ListTagsForResourceResponse" 3730 }, 3731 "errors": [ 3732 { 3733 "target": "com.amazonaws.amplify#BadRequestException" 3734 }, 3735 { 3736 "target": "com.amazonaws.amplify#InternalFailureException" 3737 }, 3738 { 3739 "target": "com.amazonaws.amplify#ResourceNotFoundException" 3740 } 3741 ], 3742 "traits": { 3743 "smithy.api#documentation": "<p> Returns a list of tags for a specified Amazon Resource Name (ARN). </p>", 3744 "smithy.api#http": { 3745 "method": "GET", 3746 "uri": "/tags/{resourceArn}", 3747 "code": 200 3748 } 3749 } 3750 }, 3751 "com.amazonaws.amplify#ListTagsForResourceRequest": { 3752 "type": "structure", 3753 "members": { 3754 "resourceArn": { 3755 "target": "com.amazonaws.amplify#ResourceArn", 3756 "traits": { 3757 "smithy.api#documentation": "<p> The Amazon Resource Name (ARN) to use to list tags. </p>", 3758 "smithy.api#httpLabel": {}, 3759 "smithy.api#required": {} 3760 } 3761 } 3762 }, 3763 "traits": { 3764 "smithy.api#documentation": "<p> The request structure to use to list tags for a resource. </p>" 3765 } 3766 }, 3767 "com.amazonaws.amplify#ListTagsForResourceResponse": { 3768 "type": "structure", 3769 "members": { 3770 "tags": { 3771 "target": "com.amazonaws.amplify#TagMap", 3772 "traits": { 3773 "smithy.api#documentation": "<p> A list of tags for the specified The Amazon Resource Name (ARN). </p>" 3774 } 3775 } 3776 }, 3777 "traits": { 3778 "smithy.api#documentation": "<p> The response for the list tags for resource request. </p>" 3779 } 3780 }, 3781 "com.amazonaws.amplify#ListWebhooks": { 3782 "type": "operation", 3783 "input": { 3784 "target": "com.amazonaws.amplify#ListWebhooksRequest" 3785 }, 3786 "output": { 3787 "target": "com.amazonaws.amplify#ListWebhooksResult" 3788 }, 3789 "errors": [ 3790 { 3791 "target": "com.amazonaws.amplify#BadRequestException" 3792 }, 3793 { 3794 "target": "com.amazonaws.amplify#InternalFailureException" 3795 }, 3796 { 3797 "target": "com.amazonaws.amplify#LimitExceededException" 3798 }, 3799 { 3800 "target": "com.amazonaws.amplify#UnauthorizedException" 3801 } 3802 ], 3803 "traits": { 3804 "smithy.api#documentation": "<p> Returns a list of webhooks for an Amplify app. </p>", 3805 "smithy.api#http": { 3806 "method": "GET", 3807 "uri": "/apps/{appId}/webhooks", 3808 "code": 200 3809 } 3810 } 3811 }, 3812 "com.amazonaws.amplify#ListWebhooksRequest": { 3813 "type": "structure", 3814 "members": { 3815 "appId": { 3816 "target": "com.amazonaws.amplify#AppId", 3817 "traits": { 3818 "smithy.api#documentation": "<p> The unique ID for an Amplify app. </p>", 3819 "smithy.api#httpLabel": {}, 3820 "smithy.api#required": {} 3821 } 3822 }, 3823 "nextToken": { 3824 "target": "com.amazonaws.amplify#NextToken", 3825 "traits": { 3826 "smithy.api#documentation": "<p> A pagination token. Set to null to start listing webhooks from the start. If\n non-null,the pagination token is returned in a result. Pass its value in here to list\n more webhooks. </p>", 3827 "smithy.api#httpQuery": "nextToken" 3828 } 3829 }, 3830 "maxResults": { 3831 "target": "com.amazonaws.amplify#MaxResults", 3832 "traits": { 3833 "smithy.api#documentation": "<p> The maximum number of records to list in a single response. </p>", 3834 "smithy.api#httpQuery": "maxResults" 3835 } 3836 } 3837 }, 3838 "traits": { 3839 "smithy.api#documentation": "<p> The request structure for the list webhooks request. </p>" 3840 } 3841 }, 3842 "com.amazonaws.amplify#ListWebhooksResult": { 3843 "type": "structure", 3844 "members": { 3845 "webhooks": { 3846 "target": "com.amazonaws.amplify#Webhooks", 3847 "traits": { 3848 "smithy.api#documentation": "<p> A list of webhooks. </p>", 3849 "smithy.api#required": {} 3850 } 3851 }, 3852 "nextToken": { 3853 "target": "com.amazonaws.amplify#NextToken", 3854 "traits": { 3855 "smithy.api#documentation": "<p> A pagination token. If non-null, the pagination token is returned in a result. Pass\n its value in another request to retrieve more entries. </p>" 3856 } 3857 } 3858 }, 3859 "traits": { 3860 "smithy.api#documentation": "<p> The result structure for the list webhooks request. </p>" 3861 } 3862 }, 3863 "com.amazonaws.amplify#LogUrl": { 3864 "type": "string", 3865 "traits": { 3866 "smithy.api#length": { 3867 "min": 0, 3868 "max": 1000 3869 } 3870 } 3871 }, 3872 "com.amazonaws.amplify#MD5Hash": { 3873 "type": "string", 3874 "traits": { 3875 "smithy.api#length": { 3876 "min": 0, 3877 "max": 32 3878 } 3879 } 3880 }, 3881 "com.amazonaws.amplify#MaxResults": { 3882 "type": "integer", 3883 "traits": { 3884 "smithy.api#range": { 3885 "min": 0, 3886 "max": 100 3887 } 3888 } 3889 }, 3890 "com.amazonaws.amplify#Name": { 3891 "type": "string", 3892 "traits": { 3893 "smithy.api#length": { 3894 "min": 1, 3895 "max": 255 3896 } 3897 } 3898 }, 3899 "com.amazonaws.amplify#NextToken": { 3900 "type": "string", 3901 "traits": { 3902 "smithy.api#length": { 3903 "min": 0, 3904 "max": 2000 3905 } 3906 } 3907 }, 3908 "com.amazonaws.amplify#NotFoundException": { 3909 "type": "structure", 3910 "members": { 3911 "message": { 3912 "target": "com.amazonaws.amplify#ErrorMessage" 3913 } 3914 }, 3915 "traits": { 3916 "smithy.api#documentation": "<p> An entity was not found during an operation. </p>", 3917 "smithy.api#error": "client", 3918 "smithy.api#httpError": 404 3919 } 3920 }, 3921 "com.amazonaws.amplify#OauthToken": { 3922 "type": "string", 3923 "traits": { 3924 "smithy.api#length": { 3925 "min": 0, 3926 "max": 1000 3927 }, 3928 "smithy.api#sensitive": {} 3929 } 3930 }, 3931 "com.amazonaws.amplify#Platform": { 3932 "type": "string", 3933 "traits": { 3934 "smithy.api#enum": [ 3935 { 3936 "value": "WEB", 3937 "name": "WEB" 3938 } 3939 ] 3940 } 3941 }, 3942 "com.amazonaws.amplify#ProductionBranch": { 3943 "type": "structure", 3944 "members": { 3945 "lastDeployTime": { 3946 "target": "com.amazonaws.amplify#LastDeployTime", 3947 "traits": { 3948 "smithy.api#documentation": "<p> The last deploy time of the production branch. </p>" 3949 } 3950 }, 3951 "status": { 3952 "target": "com.amazonaws.amplify#Status", 3953 "traits": { 3954 "smithy.api#documentation": "<p> The status of the production branch. </p>" 3955 } 3956 }, 3957 "thumbnailUrl": { 3958 "target": "com.amazonaws.amplify#ThumbnailUrl", 3959 "traits": { 3960 "smithy.api#documentation": "<p> The thumbnail URL for the production branch. </p>" 3961 } 3962 }, 3963 "branchName": { 3964 "target": "com.amazonaws.amplify#BranchName", 3965 "traits": { 3966 "smithy.api#documentation": "<p> The branch name for the production branch. </p>" 3967 } 3968 } 3969 }, 3970 "traits": { 3971 "smithy.api#documentation": "<p> Describes the information about a production branch for an Amplify app. </p>" 3972 } 3973 }, 3974 "com.amazonaws.amplify#PullRequestEnvironmentName": { 3975 "type": "string", 3976 "traits": { 3977 "smithy.api#length": { 3978 "min": 0, 3979 "max": 20 3980 } 3981 } 3982 }, 3983 "com.amazonaws.amplify#Repository": { 3984 "type": "string", 3985 "traits": { 3986 "smithy.api#length": { 3987 "min": 0, 3988 "max": 1000 3989 } 3990 } 3991 }, 3992 "com.amazonaws.amplify#ResourceArn": { 3993 "type": "string", 3994 "traits": { 3995 "smithy.api#pattern": "^arn:aws:amplify:.*" 3996 } 3997 }, 3998 "com.amazonaws.amplify#ResourceNotFoundException": { 3999 "type": "structure", 4000 "members": { 4001 "code": { 4002 "target": "com.amazonaws.amplify#Code", 4003 "traits": { 4004 "smithy.api#required": {} 4005 } 4006 }, 4007 "message": { 4008 "target": "com.amazonaws.amplify#ErrorMessage", 4009 "traits": { 4010 "smithy.api#required": {} 4011 } 4012 } 4013 }, 4014 "traits": { 4015 "smithy.api#documentation": "<p> An operation failed due to a non-existent resource. </p>", 4016 "smithy.api#error": "client", 4017 "smithy.api#httpError": 404 4018 } 4019 }, 4020 "com.amazonaws.amplify#Screenshots": { 4021 "type": "map", 4022 "key": { 4023 "target": "com.amazonaws.amplify#ThumbnailName" 4024 }, 4025 "value": { 4026 "target": "com.amazonaws.amplify#ThumbnailUrl" 4027 } 4028 }, 4029 "com.amazonaws.amplify#ServiceRoleArn": { 4030 "type": "string", 4031 "traits": { 4032 "smithy.api#length": { 4033 "min": 1, 4034 "max": 1000 4035 } 4036 } 4037 }, 4038 "com.amazonaws.amplify#Source": { 4039 "type": "string", 4040 "traits": { 4041 "smithy.api#length": { 4042 "min": 1, 4043 "max": 2048 4044 } 4045 } 4046 }, 4047 "com.amazonaws.amplify#SourceUrl": { 4048 "type": "string", 4049 "traits": { 4050 "smithy.api#length": { 4051 "min": 0, 4052 "max": 1000 4053 } 4054 } 4055 }, 4056 "com.amazonaws.amplify#StackName": { 4057 "type": "string", 4058 "traits": { 4059 "smithy.api#length": { 4060 "min": 1, 4061 "max": 255 4062 } 4063 } 4064 }, 4065 "com.amazonaws.amplify#Stage": { 4066 "type": "string", 4067 "traits": { 4068 "smithy.api#enum": [ 4069 { 4070 "value": "PRODUCTION", 4071 "name": "PRODUCTION" 4072 }, 4073 { 4074 "value": "BETA", 4075 "name": "BETA" 4076 }, 4077 { 4078 "value": "DEVELOPMENT", 4079 "name": "DEVELOPMENT" 4080 }, 4081 { 4082 "value": "EXPERIMENTAL", 4083 "name": "EXPERIMENTAL" 4084 }, 4085 { 4086 "value": "PULL_REQUEST", 4087 "name": "PULL_REQUEST" 4088 } 4089 ] 4090 } 4091 }, 4092 "com.amazonaws.amplify#StartDeployment": { 4093 "type": "operation", 4094 "input": { 4095 "target": "com.amazonaws.amplify#StartDeploymentRequest" 4096 }, 4097 "output": { 4098 "target": "com.amazonaws.amplify#StartDeploymentResult" 4099 }, 4100 "errors": [ 4101 { 4102 "target": "com.amazonaws.amplify#BadRequestException" 4103 }, 4104 { 4105 "target": "com.amazonaws.amplify#InternalFailureException" 4106 }, 4107 { 4108 "target": "com.amazonaws.amplify#LimitExceededException" 4109 }, 4110 { 4111 "target": "com.amazonaws.amplify#NotFoundException" 4112 }, 4113 { 4114 "target": "com.amazonaws.amplify#UnauthorizedException" 4115 } 4116 ], 4117 "traits": { 4118 "smithy.api#documentation": "<p> Starts a deployment for a manually deployed app. Manually deployed apps are not\n connected to a repository. </p>", 4119 "smithy.api#http": { 4120 "method": "POST", 4121 "uri": "/apps/{appId}/branches/{branchName}/deployments/start", 4122 "code": 200 4123 } 4124 } 4125 }, 4126 "com.amazonaws.amplify#StartDeploymentRequest": { 4127 "type": "structure", 4128 "members": { 4129 "appId": { 4130 "target": "com.amazonaws.amplify#AppId", 4131 "traits": { 4132 "smithy.api#documentation": "<p> The unique ID for an Amplify app. </p>", 4133 "smithy.api#httpLabel": {}, 4134 "smithy.api#required": {} 4135 } 4136 }, 4137 "branchName": { 4138 "target": "com.amazonaws.amplify#BranchName", 4139 "traits": { 4140 "smithy.api#documentation": "<p> The name for the branch, for the job. </p>", 4141 "smithy.api#httpLabel": {}, 4142 "smithy.api#required": {} 4143 } 4144 }, 4145 "jobId": { 4146 "target": "com.amazonaws.amplify#JobId", 4147 "traits": { 4148 "smithy.api#documentation": "<p> The job ID for this deployment, generated by the create deployment request. </p>" 4149 } 4150 }, 4151 "sourceUrl": { 4152 "target": "com.amazonaws.amplify#SourceUrl", 4153 "traits": { 4154 "smithy.api#documentation": "<p> The source URL for this deployment, used when calling start deployment without create\n deployment. The source URL can be any HTTP GET URL that is publicly accessible and\n downloads a single .zip file. </p>" 4155 } 4156 } 4157 }, 4158 "traits": { 4159 "smithy.api#documentation": "<p> The request structure for the start a deployment request. </p>" 4160 } 4161 }, 4162 "com.amazonaws.amplify#StartDeploymentResult": { 4163 "type": "structure", 4164 "members": { 4165 "jobSummary": { 4166 "target": "com.amazonaws.amplify#JobSummary", 4167 "traits": { 4168 "smithy.api#documentation": "<p> The summary for the job. </p>", 4169 "smithy.api#required": {} 4170 } 4171 } 4172 }, 4173 "traits": { 4174 "smithy.api#documentation": "<p> The result structure for the start a deployment request. </p>" 4175 } 4176 }, 4177 "com.amazonaws.amplify#StartJob": { 4178 "type": "operation", 4179 "input": { 4180 "target": "com.amazonaws.amplify#StartJobRequest" 4181 }, 4182 "output": { 4183 "target": "com.amazonaws.amplify#StartJobResult" 4184 }, 4185 "errors": [ 4186 { 4187 "target": "com.amazonaws.amplify#BadRequestException" 4188 }, 4189 { 4190 "target": "com.amazonaws.amplify#InternalFailureException" 4191 }, 4192 { 4193 "target": "com.amazonaws.amplify#LimitExceededException" 4194 }, 4195 { 4196 "target": "com.amazonaws.amplify#NotFoundException" 4197 }, 4198 { 4199 "target": "com.amazonaws.amplify#UnauthorizedException" 4200 } 4201 ], 4202 "traits": { 4203 "smithy.api#documentation": "<p> Starts a new job for a branch of an Amplify app. </p>", 4204 "smithy.api#http": { 4205 "method": "POST", 4206 "uri": "/apps/{appId}/branches/{branchName}/jobs", 4207 "code": 200 4208 } 4209 } 4210 }, 4211 "com.amazonaws.amplify#StartJobRequest": { 4212 "type": "structure", 4213 "members": { 4214 "appId": { 4215 "target": "com.amazonaws.amplify#AppId", 4216 "traits": { 4217 "smithy.api#documentation": "<p> The unique ID for an Amplify app. </p>", 4218 "smithy.api#httpLabel": {}, 4219 "smithy.api#required": {} 4220 } 4221 }, 4222 "branchName": { 4223 "target": "com.amazonaws.amplify#BranchName", 4224 "traits": { 4225 "smithy.api#documentation": "<p> The branch name for the job. </p>", 4226 "smithy.api#httpLabel": {}, 4227 "smithy.api#required": {} 4228 } 4229 }, 4230 "jobId": { 4231 "target": "com.amazonaws.amplify#JobId", 4232 "traits": { 4233 "smithy.api#documentation": "<p> The unique ID for an existing job. This is required if the value of\n <code>jobType</code> is <code>RETRY</code>. </p>" 4234 } 4235 }, 4236 "jobType": { 4237 "target": "com.amazonaws.amplify#JobType", 4238 "traits": { 4239 "smithy.api#documentation": "<p> Describes the type for the job. The job type <code>RELEASE</code> starts a new job\n with the latest change from the specified branch. This value is available only for apps\n that are connected to a repository. The job type <code>RETRY</code> retries an existing\n job. If the job type value is <code>RETRY</code>, the <code>jobId</code> is also\n required. </p>", 4240 "smithy.api#required": {} 4241 } 4242 }, 4243 "jobReason": { 4244 "target": "com.amazonaws.amplify#JobReason", 4245 "traits": { 4246 "smithy.api#documentation": "<p> A descriptive reason for starting this job. </p>" 4247 } 4248 }, 4249 "commitId": { 4250 "target": "com.amazonaws.amplify#CommitId", 4251 "traits": { 4252 "smithy.api#documentation": "<p> The commit ID from a third-party repository provider for the job. </p>" 4253 } 4254 }, 4255 "commitMessage": { 4256 "target": "com.amazonaws.amplify#CommitMessage", 4257 "traits": { 4258 "smithy.api#documentation": "<p> The commit message from a third-party repository provider for the job. </p>" 4259 } 4260 }, 4261 "commitTime": { 4262 "target": "com.amazonaws.amplify#CommitTime", 4263 "traits": { 4264 "smithy.api#documentation": "<p> The commit date and time for the job. </p>" 4265 } 4266 } 4267 }, 4268 "traits": { 4269 "smithy.api#documentation": "<p> The request structure for the start job request. </p>" 4270 } 4271 }, 4272 "com.amazonaws.amplify#StartJobResult": { 4273 "type": "structure", 4274 "members": { 4275 "jobSummary": { 4276 "target": "com.amazonaws.amplify#JobSummary", 4277 "traits": { 4278 "smithy.api#documentation": "<p> The summary for the job. </p>", 4279 "smithy.api#required": {} 4280 } 4281 } 4282 }, 4283 "traits": { 4284 "smithy.api#documentation": "<p> The result structure for the run job request. </p>" 4285 } 4286 }, 4287 "com.amazonaws.amplify#StartTime": { 4288 "type": "timestamp" 4289 }, 4290 "com.amazonaws.amplify#Status": { 4291 "type": "string", 4292 "traits": { 4293 "smithy.api#length": { 4294 "min": 3, 4295 "max": 7 4296 } 4297 } 4298 }, 4299 "com.amazonaws.amplify#StatusReason": { 4300 "type": "string", 4301 "traits": { 4302 "smithy.api#length": { 4303 "min": 0, 4304 "max": 1000 4305 } 4306 } 4307 }, 4308 "com.amazonaws.amplify#Step": { 4309 "type": "structure", 4310 "members": { 4311 "stepName": { 4312 "target": "com.amazonaws.amplify#StepName", 4313 "traits": { 4314 "smithy.api#documentation": "<p> The name of the execution step. </p>", 4315 "smithy.api#required": {} 4316 } 4317 }, 4318 "startTime": { 4319 "target": "com.amazonaws.amplify#StartTime", 4320 "traits": { 4321 "smithy.api#documentation": "<p> The start date and time of the execution step. </p>", 4322 "smithy.api#required": {} 4323 } 4324 }, 4325 "status": { 4326 "target": "com.amazonaws.amplify#JobStatus", 4327 "traits": { 4328 "smithy.api#documentation": "<p> The status of the execution step. </p>", 4329 "smithy.api#required": {} 4330 } 4331 }, 4332 "endTime": { 4333 "target": "com.amazonaws.amplify#EndTime", 4334 "traits": { 4335 "smithy.api#documentation": "<p> The end date and time of the execution step. </p>", 4336 "smithy.api#required": {} 4337 } 4338 }, 4339 "logUrl": { 4340 "target": "com.amazonaws.amplify#LogUrl", 4341 "traits": { 4342 "smithy.api#documentation": "<p> The URL to the logs for the execution step. </p>" 4343 } 4344 }, 4345 "artifactsUrl": { 4346 "target": "com.amazonaws.amplify#ArtifactsUrl", 4347 "traits": { 4348 "smithy.api#documentation": "<p> The URL to the artifact for the execution step. </p>" 4349 } 4350 }, 4351 "testArtifactsUrl": { 4352 "target": "com.amazonaws.amplify#TestArtifactsUrl", 4353 "traits": { 4354 "smithy.api#documentation": "<p> The URL to the test artifact for the execution step. </p>" 4355 } 4356 }, 4357 "testConfigUrl": { 4358 "target": "com.amazonaws.amplify#TestConfigUrl", 4359 "traits": { 4360 "smithy.api#documentation": "<p> The URL to the test configuration for the execution step. </p>" 4361 } 4362 }, 4363 "screenshots": { 4364 "target": "com.amazonaws.amplify#Screenshots", 4365 "traits": { 4366 "smithy.api#documentation": "<p> The list of screenshot URLs for the execution step, if relevant. </p>" 4367 } 4368 }, 4369 "statusReason": { 4370 "target": "com.amazonaws.amplify#StatusReason", 4371 "traits": { 4372 "smithy.api#documentation": "<p> The reason for the current step status. </p>" 4373 } 4374 }, 4375 "context": { 4376 "target": "com.amazonaws.amplify#Context", 4377 "traits": { 4378 "smithy.api#documentation": "<p> The context for the current step. Includes a build image if the step is build.\n </p>" 4379 } 4380 } 4381 }, 4382 "traits": { 4383 "smithy.api#documentation": "<p> Describes an execution step, for an execution job, for an Amplify app. </p>" 4384 } 4385 }, 4386 "com.amazonaws.amplify#StepName": { 4387 "type": "string", 4388 "traits": { 4389 "smithy.api#length": { 4390 "min": 0, 4391 "max": 255 4392 } 4393 } 4394 }, 4395 "com.amazonaws.amplify#Steps": { 4396 "type": "list", 4397 "member": { 4398 "target": "com.amazonaws.amplify#Step" 4399 } 4400 }, 4401 "com.amazonaws.amplify#StopJob": { 4402 "type": "operation", 4403 "input": { 4404 "target": "com.amazonaws.amplify#StopJobRequest" 4405 }, 4406 "output": { 4407 "target": "com.amazonaws.amplify#StopJobResult" 4408 }, 4409 "errors": [ 4410 { 4411 "target": "com.amazonaws.amplify#BadRequestException" 4412 }, 4413 { 4414 "target": "com.amazonaws.amplify#InternalFailureException" 4415 }, 4416 { 4417 "target": "com.amazonaws.amplify#LimitExceededException" 4418 }, 4419 { 4420 "target": "com.amazonaws.amplify#NotFoundException" 4421 }, 4422 { 4423 "target": "com.amazonaws.amplify#UnauthorizedException" 4424 } 4425 ], 4426 "traits": { 4427 "smithy.api#documentation": "<p> Stops a job that is in progress for a branch of an Amplify app. </p>", 4428 "smithy.api#http": { 4429 "method": "DELETE", 4430 "uri": "/apps/{appId}/branches/{branchName}/jobs/{jobId}/stop", 4431 "code": 200 4432 } 4433 } 4434 }, 4435 "com.amazonaws.amplify#StopJobRequest": { 4436 "type": "structure", 4437 "members": { 4438 "appId": { 4439 "target": "com.amazonaws.amplify#AppId", 4440 "traits": { 4441 "smithy.api#documentation": "<p> The unique ID for an Amplify app. </p>", 4442 "smithy.api#httpLabel": {}, 4443 "smithy.api#required": {} 4444 } 4445 }, 4446 "branchName": { 4447 "target": "com.amazonaws.amplify#BranchName", 4448 "traits": { 4449 "smithy.api#documentation": "<p> The name for the branch, for the job. </p>", 4450 "smithy.api#httpLabel": {}, 4451 "smithy.api#required": {} 4452 } 4453 }, 4454 "jobId": { 4455 "target": "com.amazonaws.amplify#JobId", 4456 "traits": { 4457 "smithy.api#documentation": "<p> The unique id for the job. </p>", 4458 "smithy.api#httpLabel": {}, 4459 "smithy.api#required": {} 4460 } 4461 } 4462 }, 4463 "traits": { 4464 "smithy.api#documentation": "<p> The request structure for the stop job request. </p>" 4465 } 4466 }, 4467 "com.amazonaws.amplify#StopJobResult": { 4468 "type": "structure", 4469 "members": { 4470 "jobSummary": { 4471 "target": "com.amazonaws.amplify#JobSummary", 4472 "traits": { 4473 "smithy.api#documentation": "<p> The summary for the job. </p>", 4474 "smithy.api#required": {} 4475 } 4476 } 4477 }, 4478 "traits": { 4479 "smithy.api#documentation": "<p> The result structure for the stop job request. </p>" 4480 } 4481 }, 4482 "com.amazonaws.amplify#SubDomain": { 4483 "type": "structure", 4484 "members": { 4485 "subDomainSetting": { 4486 "target": "com.amazonaws.amplify#SubDomainSetting", 4487 "traits": { 4488 "smithy.api#documentation": "<p> Describes the settings for the subdomain. </p>", 4489 "smithy.api#required": {} 4490 } 4491 }, 4492 "verified": { 4493 "target": "com.amazonaws.amplify#Verified", 4494 "traits": { 4495 "smithy.api#documentation": "<p> The verified status of the subdomain </p>", 4496 "smithy.api#required": {} 4497 } 4498 }, 4499 "dnsRecord": { 4500 "target": "com.amazonaws.amplify#DNSRecord", 4501 "traits": { 4502 "smithy.api#documentation": "<p> The DNS record for the subdomain. </p>", 4503 "smithy.api#required": {} 4504 } 4505 } 4506 }, 4507 "traits": { 4508 "smithy.api#documentation": "<p> The subdomain for the domain association. </p>" 4509 } 4510 }, 4511 "com.amazonaws.amplify#SubDomainSetting": { 4512 "type": "structure", 4513 "members": { 4514 "prefix": { 4515 "target": "com.amazonaws.amplify#DomainPrefix", 4516 "traits": { 4517 "smithy.api#documentation": "<p> The prefix setting for the subdomain. </p>", 4518 "smithy.api#required": {} 4519 } 4520 }, 4521 "branchName": { 4522 "target": "com.amazonaws.amplify#BranchName", 4523 "traits": { 4524 "smithy.api#documentation": "<p> The branch name setting for the subdomain. </p>", 4525 "smithy.api#required": {} 4526 } 4527 } 4528 }, 4529 "traits": { 4530 "smithy.api#documentation": "<p> Describes the settings for the subdomain. </p>" 4531 } 4532 }, 4533 "com.amazonaws.amplify#SubDomainSettings": { 4534 "type": "list", 4535 "member": { 4536 "target": "com.amazonaws.amplify#SubDomainSetting" 4537 }, 4538 "traits": { 4539 "smithy.api#length": { 4540 "min": 0, 4541 "max": 255 4542 } 4543 } 4544 }, 4545 "com.amazonaws.amplify#SubDomains": { 4546 "type": "list", 4547 "member": { 4548 "target": "com.amazonaws.amplify#SubDomain" 4549 }, 4550 "traits": { 4551 "smithy.api#length": { 4552 "min": 0, 4553 "max": 255 4554 } 4555 } 4556 }, 4557 "com.amazonaws.amplify#TTL": { 4558 "type": "string", 4559 "traits": { 4560 "smithy.api#documentation": "<p> The content Time to Live (TTL) for the website in seconds. </p>" 4561 } 4562 }, 4563 "com.amazonaws.amplify#TagKey": { 4564 "type": "string", 4565 "traits": { 4566 "smithy.api#length": { 4567 "min": 1, 4568 "max": 128 4569 }, 4570 "smithy.api#pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$" 4571 } 4572 }, 4573 "com.amazonaws.amplify#TagKeyList": { 4574 "type": "list", 4575 "member": { 4576 "target": "com.amazonaws.amplify#TagKey" 4577 }, 4578 "traits": { 4579 "smithy.api#length": { 4580 "min": 1, 4581 "max": 50 4582 } 4583 } 4584 }, 4585 "com.amazonaws.amplify#TagMap": { 4586 "type": "map", 4587 "key": { 4588 "target": "com.amazonaws.amplify#TagKey" 4589 }, 4590 "value": { 4591 "target": "com.amazonaws.amplify#TagValue" 4592 }, 4593 "traits": { 4594 "smithy.api#length": { 4595 "min": 1, 4596 "max": 50 4597 } 4598 } 4599 }, 4600 "com.amazonaws.amplify#TagResource": { 4601 "type": "operation", 4602 "input": { 4603 "target": "com.amazonaws.amplify#TagResourceRequest" 4604 }, 4605 "output": { 4606 "target": "com.amazonaws.amplify#TagResourceResponse" 4607 }, 4608 "errors": [ 4609 { 4610 "target": "com.amazonaws.amplify#BadRequestException" 4611 }, 4612 { 4613 "target": "com.amazonaws.amplify#InternalFailureException" 4614 }, 4615 { 4616 "target": "com.amazonaws.amplify#ResourceNotFoundException" 4617 } 4618 ], 4619 "traits": { 4620 "smithy.api#documentation": "<p> Tags the resource with a tag key and value. </p>", 4621 "smithy.api#http": { 4622 "method": "POST", 4623 "uri": "/tags/{resourceArn}", 4624 "code": 200 4625 } 4626 } 4627 }, 4628 "com.amazonaws.amplify#TagResourceRequest": { 4629 "type": "structure", 4630 "members": { 4631 "resourceArn": { 4632 "target": "com.amazonaws.amplify#ResourceArn", 4633 "traits": { 4634 "smithy.api#documentation": "<p> The Amazon Resource Name (ARN) to use to tag a resource. </p>", 4635 "smithy.api#httpLabel": {}, 4636 "smithy.api#required": {} 4637 } 4638 }, 4639 "tags": { 4640 "target": "com.amazonaws.amplify#TagMap", 4641 "traits": { 4642 "smithy.api#documentation": "<p> The tags used to tag the resource. </p>", 4643 "smithy.api#required": {} 4644 } 4645 } 4646 }, 4647 "traits": { 4648 "smithy.api#documentation": "<p> The request structure to tag a resource with a tag key and value. </p>" 4649 } 4650 }, 4651 "com.amazonaws.amplify#TagResourceResponse": { 4652 "type": "structure", 4653 "members": {}, 4654 "traits": { 4655 "smithy.api#documentation": "<p> The response for the tag resource request. </p>" 4656 } 4657 }, 4658 "com.amazonaws.amplify#TagValue": { 4659 "type": "string", 4660 "traits": { 4661 "smithy.api#length": { 4662 "min": 0, 4663 "max": 256 4664 } 4665 } 4666 }, 4667 "com.amazonaws.amplify#Target": { 4668 "type": "string", 4669 "traits": { 4670 "smithy.api#length": { 4671 "min": 1, 4672 "max": 2048 4673 } 4674 } 4675 }, 4676 "com.amazonaws.amplify#TestArtifactsUrl": { 4677 "type": "string", 4678 "traits": { 4679 "smithy.api#length": { 4680 "min": 0, 4681 "max": 1000 4682 } 4683 } 4684 }, 4685 "com.amazonaws.amplify#TestConfigUrl": { 4686 "type": "string", 4687 "traits": { 4688 "smithy.api#length": { 4689 "min": 0, 4690 "max": 1000 4691 } 4692 } 4693 }, 4694 "com.amazonaws.amplify#ThumbnailName": { 4695 "type": "string", 4696 "traits": { 4697 "smithy.api#length": { 4698 "min": 0, 4699 "max": 256 4700 } 4701 } 4702 }, 4703 "com.amazonaws.amplify#ThumbnailUrl": { 4704 "type": "string", 4705 "traits": { 4706 "smithy.api#length": { 4707 "min": 1, 4708 "max": 2000 4709 } 4710 } 4711 }, 4712 "com.amazonaws.amplify#TotalNumberOfJobs": { 4713 "type": "string", 4714 "traits": { 4715 "smithy.api#length": { 4716 "min": 0, 4717 "max": 1000 4718 } 4719 } 4720 }, 4721 "com.amazonaws.amplify#UnauthorizedException": { 4722 "type": "structure", 4723 "members": { 4724 "message": { 4725 "target": "com.amazonaws.amplify#ErrorMessage" 4726 } 4727 }, 4728 "traits": { 4729 "smithy.api#documentation": "<p> An operation failed due to a lack of access. </p>", 4730 "smithy.api#error": "client", 4731 "smithy.api#httpError": 401 4732 } 4733 }, 4734 "com.amazonaws.amplify#UntagResource": { 4735 "type": "operation", 4736 "input": { 4737 "target": "com.amazonaws.amplify#UntagResourceRequest" 4738 }, 4739 "output": { 4740 "target": "com.amazonaws.amplify#UntagResourceResponse" 4741 }, 4742 "errors": [ 4743 { 4744 "target": "com.amazonaws.amplify#BadRequestException" 4745 }, 4746 { 4747 "target": "com.amazonaws.amplify#InternalFailureException" 4748 }, 4749 { 4750 "target": "com.amazonaws.amplify#ResourceNotFoundException" 4751 } 4752 ], 4753 "traits": { 4754 "smithy.api#documentation": "<p> Untags a resource with a specified Amazon Resource Name (ARN). </p>", 4755 "smithy.api#http": { 4756 "method": "DELETE", 4757 "uri": "/tags/{resourceArn}", 4758 "code": 200 4759 } 4760 } 4761 }, 4762 "com.amazonaws.amplify#UntagResourceRequest": { 4763 "type": "structure", 4764 "members": { 4765 "resourceArn": { 4766 "target": "com.amazonaws.amplify#ResourceArn", 4767 "traits": { 4768 "smithy.api#documentation": "<p> The Amazon Resource Name (ARN) to use to untag a resource. </p>", 4769 "smithy.api#httpLabel": {}, 4770 "smithy.api#required": {} 4771 } 4772 }, 4773 "tagKeys": { 4774 "target": "com.amazonaws.amplify#TagKeyList", 4775 "traits": { 4776 "smithy.api#documentation": "<p> The tag keys to use to untag a resource. </p>", 4777 "smithy.api#httpQuery": "tagKeys", 4778 "smithy.api#required": {} 4779 } 4780 } 4781 }, 4782 "traits": { 4783 "smithy.api#documentation": "<p> The request structure for the untag resource request. </p>" 4784 } 4785 }, 4786 "com.amazonaws.amplify#UntagResourceResponse": { 4787 "type": "structure", 4788 "members": {}, 4789 "traits": { 4790 "smithy.api#documentation": "<p> The response for the untag resource request. </p>" 4791 } 4792 }, 4793 "com.amazonaws.amplify#UpdateApp": { 4794 "type": "operation", 4795 "input": { 4796 "target": "com.amazonaws.amplify#UpdateAppRequest" 4797 }, 4798 "output": { 4799 "target": "com.amazonaws.amplify#UpdateAppResult" 4800 }, 4801 "errors": [ 4802 { 4803 "target": "com.amazonaws.amplify#BadRequestException" 4804 }, 4805 { 4806 "target": "com.amazonaws.amplify#InternalFailureException" 4807 }, 4808 { 4809 "target": "com.amazonaws.amplify#NotFoundException" 4810 }, 4811 { 4812 "target": "com.amazonaws.amplify#UnauthorizedException" 4813 } 4814 ], 4815 "traits": { 4816 "smithy.api#documentation": "<p> Updates an existing Amplify app. </p>", 4817 "smithy.api#http": { 4818 "method": "POST", 4819 "uri": "/apps/{appId}", 4820 "code": 200 4821 } 4822 } 4823 }, 4824 "com.amazonaws.amplify#UpdateAppRequest": { 4825 "type": "structure", 4826 "members": { 4827 "appId": { 4828 "target": "com.amazonaws.amplify#AppId", 4829 "traits": { 4830 "smithy.api#documentation": "<p> The unique ID for an Amplify app. </p>", 4831 "smithy.api#httpLabel": {}, 4832 "smithy.api#required": {} 4833 } 4834 }, 4835 "name": { 4836 "target": "com.amazonaws.amplify#Name", 4837 "traits": { 4838 "smithy.api#documentation": "<p> The name for an Amplify app. </p>" 4839 } 4840 }, 4841 "description": { 4842 "target": "com.amazonaws.amplify#Description", 4843 "traits": { 4844 "smithy.api#documentation": "<p> The description for an Amplify app. </p>" 4845 } 4846 }, 4847 "platform": { 4848 "target": "com.amazonaws.amplify#Platform", 4849 "traits": { 4850 "smithy.api#documentation": "<p> The platform for an Amplify app. </p>" 4851 } 4852 }, 4853 "iamServiceRoleArn": { 4854 "target": "com.amazonaws.amplify#ServiceRoleArn", 4855 "traits": { 4856 "smithy.api#documentation": "<p> The AWS Identity and Access Management (IAM) service role for an Amplify app. </p>" 4857 } 4858 }, 4859 "environmentVariables": { 4860 "target": "com.amazonaws.amplify#EnvironmentVariables", 4861 "traits": { 4862 "smithy.api#documentation": "<p> The environment variables for an Amplify app. </p>" 4863 } 4864 }, 4865 "enableBranchAutoBuild": { 4866 "target": "com.amazonaws.amplify#EnableAutoBuild", 4867 "traits": { 4868 "smithy.api#documentation": "<p> Enables branch auto-building for an Amplify app. </p>" 4869 } 4870 }, 4871 "enableBranchAutoDeletion": { 4872 "target": "com.amazonaws.amplify#EnableBranchAutoDeletion", 4873 "traits": { 4874 "smithy.api#documentation": "<p> Automatically disconnects a branch in the Amplify Console when you delete a branch\n from your Git repository. </p>" 4875 } 4876 }, 4877 "enableBasicAuth": { 4878 "target": "com.amazonaws.amplify#EnableBasicAuth", 4879 "traits": { 4880 "smithy.api#documentation": "<p> Enables basic authorization for an Amplify app. </p>" 4881 } 4882 }, 4883 "basicAuthCredentials": { 4884 "target": "com.amazonaws.amplify#BasicAuthCredentials", 4885 "traits": { 4886 "smithy.api#documentation": "<p> The basic authorization credentials for an Amplify app. </p>" 4887 } 4888 }, 4889 "customRules": { 4890 "target": "com.amazonaws.amplify#CustomRules", 4891 "traits": { 4892 "smithy.api#documentation": "<p> The custom redirect and rewrite rules for an Amplify app. </p>" 4893 } 4894 }, 4895 "buildSpec": { 4896 "target": "com.amazonaws.amplify#BuildSpec", 4897 "traits": { 4898 "smithy.api#documentation": "<p> The build specification (build spec) for an Amplify app. </p>" 4899 } 4900 }, 4901 "customHeaders": { 4902 "target": "com.amazonaws.amplify#CustomHeaders", 4903 "traits": { 4904 "smithy.api#documentation": "<p>The custom HTTP headers for an Amplify app.</p>" 4905 } 4906 }, 4907 "enableAutoBranchCreation": { 4908 "target": "com.amazonaws.amplify#EnableAutoBranchCreation", 4909 "traits": { 4910 "smithy.api#documentation": "<p> Enables automated branch creation for an Amplify app. </p>" 4911 } 4912 }, 4913 "autoBranchCreationPatterns": { 4914 "target": "com.amazonaws.amplify#AutoBranchCreationPatterns", 4915 "traits": { 4916 "smithy.api#documentation": "<p> Describes the automated branch creation glob patterns for an Amplify app. </p>" 4917 } 4918 }, 4919 "autoBranchCreationConfig": { 4920 "target": "com.amazonaws.amplify#AutoBranchCreationConfig", 4921 "traits": { 4922 "smithy.api#documentation": "<p> The automated branch creation configuration for an Amplify app. </p>" 4923 } 4924 }, 4925 "repository": { 4926 "target": "com.amazonaws.amplify#Repository", 4927 "traits": { 4928 "smithy.api#documentation": "<p> The name of the repository for an Amplify app </p>" 4929 } 4930 }, 4931 "oauthToken": { 4932 "target": "com.amazonaws.amplify#OauthToken", 4933 "traits": { 4934 "smithy.api#documentation": "<p> The OAuth token for a third-party source control system for an Amplify app. The token\n is used to create a webhook and a read-only deploy key. The OAuth token is not stored.\n </p>" 4935 } 4936 }, 4937 "accessToken": { 4938 "target": "com.amazonaws.amplify#AccessToken", 4939 "traits": { 4940 "smithy.api#documentation": "<p> The personal access token for a third-party source control system for an Amplify app.\n The token is used to create webhook and a read-only deploy key. The token is not stored.\n </p>" 4941 } 4942 } 4943 }, 4944 "traits": { 4945 "smithy.api#documentation": "<p> The request structure for the update app request. </p>" 4946 } 4947 }, 4948 "com.amazonaws.amplify#UpdateAppResult": { 4949 "type": "structure", 4950 "members": { 4951 "app": { 4952 "target": "com.amazonaws.amplify#App", 4953 "traits": { 4954 "smithy.api#documentation": "<p> Represents the updated Amplify app. </p>", 4955 "smithy.api#required": {} 4956 } 4957 } 4958 }, 4959 "traits": { 4960 "smithy.api#documentation": "<p> The result structure for an Amplify app update request. </p>" 4961 } 4962 }, 4963 "com.amazonaws.amplify#UpdateBranch": { 4964 "type": "operation", 4965 "input": { 4966 "target": "com.amazonaws.amplify#UpdateBranchRequest" 4967 }, 4968 "output": { 4969 "target": "com.amazonaws.amplify#UpdateBranchResult" 4970 }, 4971 "errors": [ 4972 { 4973 "target": "com.amazonaws.amplify#BadRequestException" 4974 }, 4975 { 4976 "target": "com.amazonaws.amplify#DependentServiceFailureException" 4977 }, 4978 { 4979 "target": "com.amazonaws.amplify#InternalFailureException" 4980 }, 4981 { 4982 "target": "com.amazonaws.amplify#NotFoundException" 4983 }, 4984 { 4985 "target": "com.amazonaws.amplify#UnauthorizedException" 4986 } 4987 ], 4988 "traits": { 4989 "smithy.api#documentation": "<p> Updates a branch for an Amplify app. </p>", 4990 "smithy.api#http": { 4991 "method": "POST", 4992 "uri": "/apps/{appId}/branches/{branchName}", 4993 "code": 200 4994 } 4995 } 4996 }, 4997 "com.amazonaws.amplify#UpdateBranchRequest": { 4998 "type": "structure", 4999 "members": { 5000 "appId": { 5001 "target": "com.amazonaws.amplify#AppId", 5002 "traits": { 5003 "smithy.api#documentation": "<p> The unique ID for an Amplify app. </p>", 5004 "smithy.api#httpLabel": {}, 5005 "smithy.api#required": {} 5006 } 5007 }, 5008 "branchName": { 5009 "target": "com.amazonaws.amplify#BranchName", 5010 "traits": { 5011 "smithy.api#documentation": "<p> The name for the branch. </p>", 5012 "smithy.api#httpLabel": {}, 5013 "smithy.api#required": {} 5014 } 5015 }, 5016 "description": { 5017 "target": "com.amazonaws.amplify#Description", 5018 "traits": { 5019 "smithy.api#documentation": "<p> The description for the branch. </p>" 5020 } 5021 }, 5022 "framework": { 5023 "target": "com.amazonaws.amplify#Framework", 5024 "traits": { 5025 "smithy.api#documentation": "<p> The framework for the branch. </p>" 5026 } 5027 }, 5028 "stage": { 5029 "target": "com.amazonaws.amplify#Stage", 5030 "traits": { 5031 "smithy.api#documentation": "<p> Describes the current stage for the branch. </p>" 5032 } 5033 }, 5034 "enableNotification": { 5035 "target": "com.amazonaws.amplify#EnableNotification", 5036 "traits": { 5037 "smithy.api#documentation": "<p> Enables notifications for the branch. </p>" 5038 } 5039 }, 5040 "enableAutoBuild": { 5041 "target": "com.amazonaws.amplify#EnableAutoBuild", 5042 "traits": { 5043 "smithy.api#documentation": "<p> Enables auto building for the branch. </p>" 5044 } 5045 }, 5046 "environmentVariables": { 5047 "target": "com.amazonaws.amplify#EnvironmentVariables", 5048 "traits": { 5049 "smithy.api#documentation": "<p> The environment variables for the branch. </p>" 5050 } 5051 }, 5052 "basicAuthCredentials": { 5053 "target": "com.amazonaws.amplify#BasicAuthCredentials", 5054 "traits": { 5055 "smithy.api#documentation": "<p> The basic authorization credentials for the branch. </p>" 5056 } 5057 }, 5058 "enableBasicAuth": { 5059 "target": "com.amazonaws.amplify#EnableBasicAuth", 5060 "traits": { 5061 "smithy.api#documentation": "<p> Enables basic authorization for the branch. </p>" 5062 } 5063 }, 5064 "enablePerformanceMode": { 5065 "target": "com.amazonaws.amplify#EnablePerformanceMode", 5066 "traits": { 5067 "smithy.api#documentation": "<p>Enables performance mode for the branch.</p>\n <p>Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out. </p>" 5068 } 5069 }, 5070 "buildSpec": { 5071 "target": "com.amazonaws.amplify#BuildSpec", 5072 "traits": { 5073 "smithy.api#documentation": "<p> The build specification (build spec) for the branch. </p>" 5074 } 5075 }, 5076 "ttl": { 5077 "target": "com.amazonaws.amplify#TTL", 5078 "traits": { 5079 "smithy.api#documentation": "<p> The content Time to Live (TTL) for the website in seconds. </p>" 5080 } 5081 }, 5082 "displayName": { 5083 "target": "com.amazonaws.amplify#DisplayName", 5084 "traits": { 5085 "smithy.api#documentation": "<p> The display name for a branch. This is used as the default domain prefix. </p>" 5086 } 5087 }, 5088 "enablePullRequestPreview": { 5089 "target": "com.amazonaws.amplify#EnablePullRequestPreview", 5090 "traits": { 5091 "smithy.api#documentation": "<p> Enables pull request previews for this branch. </p>" 5092 } 5093 }, 5094 "pullRequestEnvironmentName": { 5095 "target": "com.amazonaws.amplify#PullRequestEnvironmentName", 5096 "traits": { 5097 "smithy.api#documentation": "<p> The Amplify environment name for the pull request. </p>" 5098 } 5099 }, 5100 "backendEnvironmentArn": { 5101 "target": "com.amazonaws.amplify#BackendEnvironmentArn", 5102 "traits": { 5103 "smithy.api#documentation": "<p> The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify\n app. </p>" 5104 } 5105 } 5106 }, 5107 "traits": { 5108 "smithy.api#documentation": "<p> The request structure for the update branch request. </p>" 5109 } 5110 }, 5111 "com.amazonaws.amplify#UpdateBranchResult": { 5112 "type": "structure", 5113 "members": { 5114 "branch": { 5115 "target": "com.amazonaws.amplify#Branch", 5116 "traits": { 5117 "smithy.api#documentation": "<p> The branch for an Amplify app, which maps to a third-party repository branch. </p>", 5118 "smithy.api#required": {} 5119 } 5120 } 5121 }, 5122 "traits": { 5123 "smithy.api#documentation": "<p> The result structure for the update branch request. </p>" 5124 } 5125 }, 5126 "com.amazonaws.amplify#UpdateDomainAssociation": { 5127 "type": "operation", 5128 "input": { 5129 "target": "com.amazonaws.amplify#UpdateDomainAssociationRequest" 5130 }, 5131 "output": { 5132 "target": "com.amazonaws.amplify#UpdateDomainAssociationResult" 5133 }, 5134 "errors": [ 5135 { 5136 "target": "com.amazonaws.amplify#BadRequestException" 5137 }, 5138 { 5139 "target": "com.amazonaws.amplify#DependentServiceFailureException" 5140 }, 5141 { 5142 "target": "com.amazonaws.amplify#InternalFailureException" 5143 }, 5144 { 5145 "target": "com.amazonaws.amplify#NotFoundException" 5146 }, 5147 { 5148 "target": "com.amazonaws.amplify#UnauthorizedException" 5149 } 5150 ], 5151 "traits": { 5152 "smithy.api#documentation": "<p> Creates a new domain association for an Amplify app.</p>", 5153 "smithy.api#http": { 5154 "method": "POST", 5155 "uri": "/apps/{appId}/domains/{domainName}", 5156 "code": 200 5157 } 5158 } 5159 }, 5160 "com.amazonaws.amplify#UpdateDomainAssociationRequest": { 5161 "type": "structure", 5162 "members": { 5163 "appId": { 5164 "target": "com.amazonaws.amplify#AppId", 5165 "traits": { 5166 "smithy.api#documentation": "<p> The unique ID for an Amplify app. </p>", 5167 "smithy.api#httpLabel": {}, 5168 "smithy.api#required": {} 5169 } 5170 }, 5171 "domainName": { 5172 "target": "com.amazonaws.amplify#DomainName", 5173 "traits": { 5174 "smithy.api#documentation": "<p> The name of the domain. </p>", 5175 "smithy.api#httpLabel": {}, 5176 "smithy.api#required": {} 5177 } 5178 }, 5179 "enableAutoSubDomain": { 5180 "target": "com.amazonaws.amplify#EnableAutoSubDomain", 5181 "traits": { 5182 "smithy.api#documentation": "<p> Enables the automated creation of subdomains for branches. </p>" 5183 } 5184 }, 5185 "subDomainSettings": { 5186 "target": "com.amazonaws.amplify#SubDomainSettings", 5187 "traits": { 5188 "smithy.api#documentation": "<p> Describes the settings for the subdomain. </p>", 5189 "smithy.api#required": {} 5190 } 5191 }, 5192 "autoSubDomainCreationPatterns": { 5193 "target": "com.amazonaws.amplify#AutoSubDomainCreationPatterns", 5194 "traits": { 5195 "smithy.api#documentation": "<p> Sets the branch patterns for automatic subdomain creation. </p>" 5196 } 5197 }, 5198 "autoSubDomainIAMRole": { 5199 "target": "com.amazonaws.amplify#AutoSubDomainIAMRole", 5200 "traits": { 5201 "smithy.api#documentation": "<p> The required AWS Identity and Access Management (IAM) service role for the Amazon\n Resource Name (ARN) for automatically creating subdomains. </p>" 5202 } 5203 } 5204 }, 5205 "traits": { 5206 "smithy.api#documentation": "<p> The request structure for the update domain association request. </p>" 5207 } 5208 }, 5209 "com.amazonaws.amplify#UpdateDomainAssociationResult": { 5210 "type": "structure", 5211 "members": { 5212 "domainAssociation": { 5213 "target": "com.amazonaws.amplify#DomainAssociation", 5214 "traits": { 5215 "smithy.api#documentation": "<p> Describes a domain association, which associates a custom domain with an Amplify app.\n </p>", 5216 "smithy.api#required": {} 5217 } 5218 } 5219 }, 5220 "traits": { 5221 "smithy.api#documentation": "<p> The result structure for the update domain association request. </p>" 5222 } 5223 }, 5224 "com.amazonaws.amplify#UpdateTime": { 5225 "type": "timestamp" 5226 }, 5227 "com.amazonaws.amplify#UpdateWebhook": { 5228 "type": "operation", 5229 "input": { 5230 "target": "com.amazonaws.amplify#UpdateWebhookRequest" 5231 }, 5232 "output": { 5233 "target": "com.amazonaws.amplify#UpdateWebhookResult" 5234 }, 5235 "errors": [ 5236 { 5237 "target": "com.amazonaws.amplify#BadRequestException" 5238 }, 5239 { 5240 "target": "com.amazonaws.amplify#DependentServiceFailureException" 5241 }, 5242 { 5243 "target": "com.amazonaws.amplify#InternalFailureException" 5244 }, 5245 { 5246 "target": "com.amazonaws.amplify#NotFoundException" 5247 }, 5248 { 5249 "target": "com.amazonaws.amplify#UnauthorizedException" 5250 } 5251 ], 5252 "traits": { 5253 "smithy.api#documentation": "<p> Updates a webhook. </p>", 5254 "smithy.api#http": { 5255 "method": "POST", 5256 "uri": "/webhooks/{webhookId}", 5257 "code": 200 5258 } 5259 } 5260 }, 5261 "com.amazonaws.amplify#UpdateWebhookRequest": { 5262 "type": "structure", 5263 "members": { 5264 "webhookId": { 5265 "target": "com.amazonaws.amplify#WebhookId", 5266 "traits": { 5267 "smithy.api#documentation": "<p> The unique ID for a webhook. </p>", 5268 "smithy.api#httpLabel": {}, 5269 "smithy.api#required": {} 5270 } 5271 }, 5272 "branchName": { 5273 "target": "com.amazonaws.amplify#BranchName", 5274 "traits": { 5275 "smithy.api#documentation": "<p> The name for a branch that is part of an Amplify app. </p>" 5276 } 5277 }, 5278 "description": { 5279 "target": "com.amazonaws.amplify#Description", 5280 "traits": { 5281 "smithy.api#documentation": "<p> The description for a webhook. </p>" 5282 } 5283 } 5284 }, 5285 "traits": { 5286 "smithy.api#documentation": "<p> The request structure for the update webhook request. </p>" 5287 } 5288 }, 5289 "com.amazonaws.amplify#UpdateWebhookResult": { 5290 "type": "structure", 5291 "members": { 5292 "webhook": { 5293 "target": "com.amazonaws.amplify#Webhook", 5294 "traits": { 5295 "smithy.api#documentation": "<p> Describes a webhook that connects repository events to an Amplify app. </p>", 5296 "smithy.api#required": {} 5297 } 5298 } 5299 }, 5300 "traits": { 5301 "smithy.api#documentation": "<p> The result structure for the update webhook request. </p>" 5302 } 5303 }, 5304 "com.amazonaws.amplify#UploadUrl": { 5305 "type": "string", 5306 "traits": { 5307 "smithy.api#length": { 5308 "min": 0, 5309 "max": 1000 5310 } 5311 } 5312 }, 5313 "com.amazonaws.amplify#Verified": { 5314 "type": "boolean", 5315 "traits": { 5316 "smithy.api#box": {} 5317 } 5318 }, 5319 "com.amazonaws.amplify#Webhook": { 5320 "type": "structure", 5321 "members": { 5322 "webhookArn": { 5323 "target": "com.amazonaws.amplify#WebhookArn", 5324 "traits": { 5325 "smithy.api#documentation": "<p> The Amazon Resource Name (ARN) for the webhook. </p>", 5326 "smithy.api#required": {} 5327 } 5328 }, 5329 "webhookId": { 5330 "target": "com.amazonaws.amplify#WebhookId", 5331 "traits": { 5332 "smithy.api#documentation": "<p> The ID of the webhook. </p>", 5333 "smithy.api#required": {} 5334 } 5335 }, 5336 "webhookUrl": { 5337 "target": "com.amazonaws.amplify#WebhookUrl", 5338 "traits": { 5339 "smithy.api#documentation": "<p> The URL of the webhook. </p>", 5340 "smithy.api#required": {} 5341 } 5342 }, 5343 "branchName": { 5344 "target": "com.amazonaws.amplify#BranchName", 5345 "traits": { 5346 "smithy.api#documentation": "<p> The name for a branch that is part of an Amplify app. </p>", 5347 "smithy.api#required": {} 5348 } 5349 }, 5350 "description": { 5351 "target": "com.amazonaws.amplify#Description", 5352 "traits": { 5353 "smithy.api#documentation": "<p> The description for a webhook. </p>", 5354 "smithy.api#required": {} 5355 } 5356 }, 5357 "createTime": { 5358 "target": "com.amazonaws.amplify#CreateTime", 5359 "traits": { 5360 "smithy.api#documentation": "<p> The create date and time for a webhook. </p>", 5361 "smithy.api#required": {} 5362 } 5363 }, 5364 "updateTime": { 5365 "target": "com.amazonaws.amplify#UpdateTime", 5366 "traits": { 5367 "smithy.api#documentation": "<p> Updates the date and time for a webhook. </p>", 5368 "smithy.api#required": {} 5369 } 5370 } 5371 }, 5372 "traits": { 5373 "smithy.api#documentation": "<p> Describes a webhook that connects repository events to an Amplify app. </p>" 5374 } 5375 }, 5376 "com.amazonaws.amplify#WebhookArn": { 5377 "type": "string", 5378 "traits": { 5379 "smithy.api#length": { 5380 "min": 0, 5381 "max": 1000 5382 } 5383 } 5384 }, 5385 "com.amazonaws.amplify#WebhookId": { 5386 "type": "string", 5387 "traits": { 5388 "smithy.api#length": { 5389 "min": 0, 5390 "max": 255 5391 } 5392 } 5393 }, 5394 "com.amazonaws.amplify#WebhookUrl": { 5395 "type": "string", 5396 "traits": { 5397 "smithy.api#length": { 5398 "min": 0, 5399 "max": 1000 5400 } 5401 } 5402 }, 5403 "com.amazonaws.amplify#Webhooks": { 5404 "type": "list", 5405 "member": { 5406 "target": "com.amazonaws.amplify#Webhook" 5407 } 5408 } 5409 } 5410} 5411