1{ 2 "version": "2.0", 3 "service": "<p>Amplify enables developers to develop and deploy cloud-powered mobile and web apps. The Amplify Console provides a continuous delivery and hosting service for web applications. For more information, see the <a href=\"https://docs.aws.amazon.com/amplify/latest/userguide/welcome.html\">Amplify Console User Guide</a>. The Amplify Framework is a comprehensive set of SDKs, libraries, tools, and documentation for client app development. For more information, see the <a href=\"https://docs.amplify.aws/\">Amplify Framework.</a> </p>", 4 "operations": { 5 "CreateApp": "<p> Creates a new Amplify app. </p>", 6 "CreateBackendEnvironment": "<p> Creates a new backend environment for an Amplify app. </p>", 7 "CreateBranch": "<p> Creates a new branch for an Amplify app. </p>", 8 "CreateDeployment": "<p> Creates a deployment for a manually deployed Amplify app. Manually deployed apps are not connected to a repository. </p>", 9 "CreateDomainAssociation": "<p> Creates a new domain association for an Amplify app. This action associates a custom domain with the Amplify app </p>", 10 "CreateWebhook": "<p> Creates a new webhook on an Amplify app. </p>", 11 "DeleteApp": "<p> Deletes an existing Amplify app specified by an app ID. </p>", 12 "DeleteBackendEnvironment": "<p> Deletes a backend environment for an Amplify app. </p>", 13 "DeleteBranch": "<p> Deletes a branch for an Amplify app. </p>", 14 "DeleteDomainAssociation": "<p> Deletes a domain association for an Amplify app. </p>", 15 "DeleteJob": "<p> Deletes a job for a branch of an Amplify app. </p>", 16 "DeleteWebhook": "<p> Deletes a webhook. </p>", 17 "GenerateAccessLogs": "<p> Returns the website access logs for a specific time range using a presigned URL. </p>", 18 "GetApp": "<p> Returns an existing Amplify app by appID. </p>", 19 "GetArtifactUrl": "<p> Returns the artifact info that corresponds to an artifact id. </p>", 20 "GetBackendEnvironment": "<p> Returns a backend environment for an Amplify app. </p>", 21 "GetBranch": "<p> Returns a branch for an Amplify app. </p>", 22 "GetDomainAssociation": "<p> Returns the domain information for an Amplify app. </p>", 23 "GetJob": "<p> Returns a job for a branch of an Amplify app. </p>", 24 "GetWebhook": "<p> Returns the webhook information that corresponds to a specified webhook ID. </p>", 25 "ListApps": "<p> Returns a list of the existing Amplify apps. </p>", 26 "ListArtifacts": "<p> Returns a list of artifacts for a specified app, branch, and job. </p>", 27 "ListBackendEnvironments": "<p> Lists the backend environments for an Amplify app. </p>", 28 "ListBranches": "<p> Lists the branches of an Amplify app. </p>", 29 "ListDomainAssociations": "<p> Returns the domain associations for an Amplify app. </p>", 30 "ListJobs": "<p> Lists the jobs for a branch of an Amplify app. </p>", 31 "ListTagsForResource": "<p> Returns a list of tags for a specified Amazon Resource Name (ARN). </p>", 32 "ListWebhooks": "<p> Returns a list of webhooks for an Amplify app. </p>", 33 "StartDeployment": "<p> Starts a deployment for a manually deployed app. Manually deployed apps are not connected to a repository. </p>", 34 "StartJob": "<p> Starts a new job for a branch of an Amplify app. </p>", 35 "StopJob": "<p> Stops a job that is in progress for a branch of an Amplify app. </p>", 36 "TagResource": "<p> Tags the resource with a tag key and value. </p>", 37 "UntagResource": "<p> Untags a resource with a specified Amazon Resource Name (ARN). </p>", 38 "UpdateApp": "<p> Updates an existing Amplify app. </p>", 39 "UpdateBranch": "<p> Updates a branch for an Amplify app. </p>", 40 "UpdateDomainAssociation": "<p> Creates a new domain association for an Amplify app.</p>", 41 "UpdateWebhook": "<p> Updates a webhook. </p>" 42 }, 43 "shapes": { 44 "AccessToken": { 45 "base": null, 46 "refs": { 47 "CreateAppRequest$accessToken": "<p> The personal access token for a third-party source control system for an Amplify app. The personal access token is used to create a webhook and a read-only deploy key. The token is not stored. </p>", 48 "UpdateAppRequest$accessToken": "<p> The personal access token for a third-party source control system for an Amplify app. The token is used to create webhook and a read-only deploy key. The token is not stored. </p>" 49 } 50 }, 51 "ActiveJobId": { 52 "base": null, 53 "refs": { 54 "Branch$activeJobId": "<p> The ID of the active job for a branch of an Amplify app. </p>" 55 } 56 }, 57 "App": { 58 "base": "<p> Represents the different branches of a repository for building, deploying, and hosting an Amplify app. </p>", 59 "refs": { 60 "Apps$member": null, 61 "CreateAppResult$app": null, 62 "DeleteAppResult$app": null, 63 "GetAppResult$app": null, 64 "UpdateAppResult$app": "<p> Represents the updated Amplify app. </p>" 65 } 66 }, 67 "AppArn": { 68 "base": null, 69 "refs": { 70 "App$appArn": "<p> The Amazon Resource Name (ARN) of the Amplify app. </p>" 71 } 72 }, 73 "AppId": { 74 "base": null, 75 "refs": { 76 "App$appId": "<p> The unique ID of the Amplify app. </p>", 77 "CreateBackendEnvironmentRequest$appId": "<p> The unique ID for an Amplify app. </p>", 78 "CreateBranchRequest$appId": "<p> The unique ID for an Amplify app. </p>", 79 "CreateDeploymentRequest$appId": "<p> The unique ID for an Amplify app. </p>", 80 "CreateDomainAssociationRequest$appId": "<p> The unique ID for an Amplify app. </p>", 81 "CreateWebhookRequest$appId": "<p> The unique ID for an Amplify app. </p>", 82 "DeleteAppRequest$appId": "<p> The unique ID for an Amplify app. </p>", 83 "DeleteBackendEnvironmentRequest$appId": "<p> The unique ID of an Amplify app. </p>", 84 "DeleteBranchRequest$appId": "<p> The unique ID for an Amplify app. </p>", 85 "DeleteDomainAssociationRequest$appId": "<p> The unique id for an Amplify app. </p>", 86 "DeleteJobRequest$appId": "<p> The unique ID for an Amplify app. </p>", 87 "GenerateAccessLogsRequest$appId": "<p> The unique ID for an Amplify app. </p>", 88 "GetAppRequest$appId": "<p> The unique ID for an Amplify app. </p>", 89 "GetBackendEnvironmentRequest$appId": "<p> The unique id for an Amplify app. </p>", 90 "GetBranchRequest$appId": "<p> The unique ID for an Amplify app. </p>", 91 "GetDomainAssociationRequest$appId": "<p> The unique id for an Amplify app. </p>", 92 "GetJobRequest$appId": "<p> The unique ID for an Amplify app. </p>", 93 "ListArtifactsRequest$appId": "<p> The unique ID for an Amplify app. </p>", 94 "ListBackendEnvironmentsRequest$appId": "<p> The unique ID for an Amplify app. </p>", 95 "ListBranchesRequest$appId": "<p> The unique ID for an Amplify app. </p>", 96 "ListDomainAssociationsRequest$appId": "<p> The unique ID for an Amplify app. </p>", 97 "ListJobsRequest$appId": "<p> The unique ID for an Amplify app. </p>", 98 "ListWebhooksRequest$appId": "<p> The unique ID for an Amplify app. </p>", 99 "StartDeploymentRequest$appId": "<p> The unique ID for an Amplify app. </p>", 100 "StartJobRequest$appId": "<p> The unique ID for an Amplify app. </p>", 101 "StopJobRequest$appId": "<p> The unique ID for an Amplify app. </p>", 102 "UpdateAppRequest$appId": "<p> The unique ID for an Amplify app. </p>", 103 "UpdateBranchRequest$appId": "<p> The unique ID for an Amplify app. </p>", 104 "UpdateDomainAssociationRequest$appId": "<p> The unique ID for an Amplify app. </p>" 105 } 106 }, 107 "Apps": { 108 "base": null, 109 "refs": { 110 "ListAppsResult$apps": "<p> A list of Amplify apps. </p>" 111 } 112 }, 113 "Artifact": { 114 "base": "<p> Describes an artifact. </p>", 115 "refs": { 116 "Artifacts$member": null 117 } 118 }, 119 "ArtifactFileName": { 120 "base": null, 121 "refs": { 122 "Artifact$artifactFileName": "<p> The file name for the artifact. </p>" 123 } 124 }, 125 "ArtifactId": { 126 "base": null, 127 "refs": { 128 "Artifact$artifactId": "<p> The unique ID for the artifact. </p>", 129 "GetArtifactUrlRequest$artifactId": "<p> The unique ID for an artifact. </p>", 130 "GetArtifactUrlResult$artifactId": "<p> The unique ID for an artifact. </p>" 131 } 132 }, 133 "ArtifactUrl": { 134 "base": null, 135 "refs": { 136 "GetArtifactUrlResult$artifactUrl": "<p> The presigned URL for the artifact. </p>" 137 } 138 }, 139 "Artifacts": { 140 "base": null, 141 "refs": { 142 "ListArtifactsResult$artifacts": "<p> A list of artifacts. </p>" 143 } 144 }, 145 "ArtifactsUrl": { 146 "base": null, 147 "refs": { 148 "Step$artifactsUrl": "<p> The URL to the artifact for the execution step. </p>" 149 } 150 }, 151 "AssociatedResource": { 152 "base": null, 153 "refs": { 154 "AssociatedResources$member": null 155 } 156 }, 157 "AssociatedResources": { 158 "base": null, 159 "refs": { 160 "Branch$associatedResources": "<p> A list of custom resources that are linked to this branch. </p>" 161 } 162 }, 163 "AutoBranchCreationConfig": { 164 "base": "<p> Describes the automated branch creation configuration. </p>", 165 "refs": { 166 "App$autoBranchCreationConfig": "<p> Describes the automated branch creation configuration for the Amplify app. </p>", 167 "CreateAppRequest$autoBranchCreationConfig": "<p> The automated branch creation configuration for an Amplify app. </p>", 168 "UpdateAppRequest$autoBranchCreationConfig": "<p> The automated branch creation configuration for an Amplify app. </p>" 169 } 170 }, 171 "AutoBranchCreationPattern": { 172 "base": null, 173 "refs": { 174 "AutoBranchCreationPatterns$member": null 175 } 176 }, 177 "AutoBranchCreationPatterns": { 178 "base": null, 179 "refs": { 180 "App$autoBranchCreationPatterns": "<p> Describes the automated branch creation glob patterns for the Amplify app. </p>", 181 "CreateAppRequest$autoBranchCreationPatterns": "<p> The automated branch creation glob patterns for an Amplify app. </p>", 182 "UpdateAppRequest$autoBranchCreationPatterns": "<p> Describes the automated branch creation glob patterns for an Amplify app. </p>" 183 } 184 }, 185 "AutoSubDomainCreationPattern": { 186 "base": null, 187 "refs": { 188 "AutoSubDomainCreationPatterns$member": null 189 } 190 }, 191 "AutoSubDomainCreationPatterns": { 192 "base": null, 193 "refs": { 194 "CreateDomainAssociationRequest$autoSubDomainCreationPatterns": "<p> Sets the branch patterns for automatic subdomain creation. </p>", 195 "DomainAssociation$autoSubDomainCreationPatterns": "<p> Sets branch patterns for automatic subdomain creation. </p>", 196 "UpdateDomainAssociationRequest$autoSubDomainCreationPatterns": "<p> Sets the branch patterns for automatic subdomain creation. </p>" 197 } 198 }, 199 "AutoSubDomainIAMRole": { 200 "base": null, 201 "refs": { 202 "CreateDomainAssociationRequest$autoSubDomainIAMRole": "<p> The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains. </p>", 203 "DomainAssociation$autoSubDomainIAMRole": "<p> The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains. </p>", 204 "UpdateDomainAssociationRequest$autoSubDomainIAMRole": "<p> The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains. </p>" 205 } 206 }, 207 "BackendEnvironment": { 208 "base": "<p> Describes the backend environment for an Amplify app. </p>", 209 "refs": { 210 "BackendEnvironments$member": null, 211 "CreateBackendEnvironmentResult$backendEnvironment": "<p> Describes the backend environment for an Amplify app. </p>", 212 "DeleteBackendEnvironmentResult$backendEnvironment": "<p> Describes the backend environment for an Amplify app. </p>", 213 "GetBackendEnvironmentResult$backendEnvironment": "<p> Describes the backend environment for an Amplify app. </p>" 214 } 215 }, 216 "BackendEnvironmentArn": { 217 "base": null, 218 "refs": { 219 "BackendEnvironment$backendEnvironmentArn": "<p> The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app. </p>", 220 "Branch$backendEnvironmentArn": "<p> The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app. </p>", 221 "CreateBranchRequest$backendEnvironmentArn": "<p> The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app. </p>", 222 "UpdateBranchRequest$backendEnvironmentArn": "<p> The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app. </p>" 223 } 224 }, 225 "BackendEnvironments": { 226 "base": null, 227 "refs": { 228 "ListBackendEnvironmentsResult$backendEnvironments": "<p> The list of backend environments for an Amplify app. </p>" 229 } 230 }, 231 "BadRequestException": { 232 "base": "<p> A request contains unexpected data. </p>", 233 "refs": { 234 } 235 }, 236 "BasicAuthCredentials": { 237 "base": null, 238 "refs": { 239 "App$basicAuthCredentials": "<p> The basic authorization credentials for branches for the Amplify app. </p>", 240 "AutoBranchCreationConfig$basicAuthCredentials": "<p> The basic authorization credentials for the autocreated branch. </p>", 241 "Branch$basicAuthCredentials": "<p> The basic authorization credentials for a branch of an Amplify app. </p>", 242 "CreateAppRequest$basicAuthCredentials": "<p> The credentials for basic authorization for an Amplify app. </p>", 243 "CreateBranchRequest$basicAuthCredentials": "<p> The basic authorization credentials for the branch. </p>", 244 "UpdateAppRequest$basicAuthCredentials": "<p> The basic authorization credentials for an Amplify app. </p>", 245 "UpdateBranchRequest$basicAuthCredentials": "<p> The basic authorization credentials for the branch. </p>" 246 } 247 }, 248 "Branch": { 249 "base": "<p> The branch for an Amplify app, which maps to a third-party repository branch. </p>", 250 "refs": { 251 "Branches$member": null, 252 "CreateBranchResult$branch": "<p> Describes the branch for an Amplify app, which maps to a third-party repository branch. </p>", 253 "DeleteBranchResult$branch": "<p> The branch for an Amplify app, which maps to a third-party repository branch. </p>", 254 "GetBranchResult$branch": null, 255 "UpdateBranchResult$branch": "<p> The branch for an Amplify app, which maps to a third-party repository branch. </p>" 256 } 257 }, 258 "BranchArn": { 259 "base": null, 260 "refs": { 261 "Branch$branchArn": "<p> The Amazon Resource Name (ARN) for a branch that is part of an Amplify app. </p>" 262 } 263 }, 264 "BranchName": { 265 "base": null, 266 "refs": { 267 "Branch$branchName": "<p> The name for the branch that is part of an Amplify app. </p>", 268 "Branch$destinationBranch": "<p> The destination branch if the branch is a pull request branch. </p>", 269 "Branch$sourceBranch": "<p> The source branch if the branch is a pull request branch. </p>", 270 "CreateBranchRequest$branchName": "<p> The name for the branch. </p>", 271 "CreateDeploymentRequest$branchName": "<p> The name for the branch, for the job. </p>", 272 "CreateWebhookRequest$branchName": "<p> The name for a branch that is part of an Amplify app. </p>", 273 "DeleteBranchRequest$branchName": "<p> The name for the branch. </p>", 274 "DeleteJobRequest$branchName": "<p> The name for the branch, for the job. </p>", 275 "GetBranchRequest$branchName": "<p> The name for the branch. </p>", 276 "GetJobRequest$branchName": "<p> The branch name for the job. </p>", 277 "ListArtifactsRequest$branchName": "<p> The name of a branch that is part of an Amplify app. </p>", 278 "ListJobsRequest$branchName": "<p> The name for a branch. </p>", 279 "ProductionBranch$branchName": "<p> The branch name for the production branch. </p>", 280 "StartDeploymentRequest$branchName": "<p> The name for the branch, for the job. </p>", 281 "StartJobRequest$branchName": "<p> The branch name for the job. </p>", 282 "StopJobRequest$branchName": "<p> The name for the branch, for the job. </p>", 283 "SubDomainSetting$branchName": "<p> The branch name setting for the subdomain. </p>", 284 "UpdateBranchRequest$branchName": "<p> The name for the branch. </p>", 285 "UpdateWebhookRequest$branchName": "<p> The name for a branch that is part of an Amplify app. </p>", 286 "Webhook$branchName": "<p> The name for a branch that is part of an Amplify app. </p>" 287 } 288 }, 289 "Branches": { 290 "base": null, 291 "refs": { 292 "ListBranchesResult$branches": "<p> A list of branches for an Amplify app. </p>" 293 } 294 }, 295 "BuildSpec": { 296 "base": "<p> The build specification (build spec) file for an Amplify app build. </p>", 297 "refs": { 298 "App$buildSpec": "<p> Describes the content of the build specification (build spec) for the Amplify app. </p>", 299 "AutoBranchCreationConfig$buildSpec": "<p> The build specification (build spec) for the autocreated branch. </p>", 300 "Branch$buildSpec": "<p> The build specification (build spec) content for the branch of an Amplify app. </p>", 301 "CreateAppRequest$buildSpec": "<p> The build specification (build spec) for an Amplify app. </p>", 302 "CreateBranchRequest$buildSpec": "<p> The build specification (build spec) for the branch. </p>", 303 "UpdateAppRequest$buildSpec": "<p> The build specification (build spec) for an Amplify app. </p>", 304 "UpdateBranchRequest$buildSpec": "<p> The build specification (build spec) for the branch. </p>" 305 } 306 }, 307 "CertificateVerificationDNSRecord": { 308 "base": null, 309 "refs": { 310 "DomainAssociation$certificateVerificationDNSRecord": "<p> The DNS record for certificate verification. </p>" 311 } 312 }, 313 "Code": { 314 "base": null, 315 "refs": { 316 "ResourceNotFoundException$code": null 317 } 318 }, 319 "CommitId": { 320 "base": null, 321 "refs": { 322 "JobSummary$commitId": "<p> The commit ID from a third-party repository provider for the job. </p>", 323 "StartJobRequest$commitId": "<p> The commit ID from a third-party repository provider for the job. </p>" 324 } 325 }, 326 "CommitMessage": { 327 "base": null, 328 "refs": { 329 "JobSummary$commitMessage": "<p> The commit message from a third-party repository provider for the job. </p>", 330 "StartJobRequest$commitMessage": "<p> The commit message from a third-party repository provider for the job. </p>" 331 } 332 }, 333 "CommitTime": { 334 "base": null, 335 "refs": { 336 "JobSummary$commitTime": "<p> The commit date and time for the job. </p>", 337 "StartJobRequest$commitTime": "<p> The commit date and time for the job. </p>" 338 } 339 }, 340 "Condition": { 341 "base": null, 342 "refs": { 343 "CustomRule$condition": "<p> The condition for a URL rewrite or redirect rule, such as a country code. </p>" 344 } 345 }, 346 "Context": { 347 "base": null, 348 "refs": { 349 "Step$context": "<p> The context for the current step. Includes a build image if the step is build. </p>" 350 } 351 }, 352 "CreateAppRequest": { 353 "base": "<p> The request structure used to create apps in Amplify. </p>", 354 "refs": { 355 } 356 }, 357 "CreateAppResult": { 358 "base": null, 359 "refs": { 360 } 361 }, 362 "CreateBackendEnvironmentRequest": { 363 "base": "<p> The request structure for the backend environment create request. </p>", 364 "refs": { 365 } 366 }, 367 "CreateBackendEnvironmentResult": { 368 "base": "<p> The result structure for the create backend environment request. </p>", 369 "refs": { 370 } 371 }, 372 "CreateBranchRequest": { 373 "base": "<p> The request structure for the create branch request. </p>", 374 "refs": { 375 } 376 }, 377 "CreateBranchResult": { 378 "base": "<p> The result structure for create branch request. </p>", 379 "refs": { 380 } 381 }, 382 "CreateDeploymentRequest": { 383 "base": "<p> The request structure for the create a new deployment request. </p>", 384 "refs": { 385 } 386 }, 387 "CreateDeploymentResult": { 388 "base": "<p> The result structure for the create a new deployment request. </p>", 389 "refs": { 390 } 391 }, 392 "CreateDomainAssociationRequest": { 393 "base": "<p> The request structure for the create domain association request. </p>", 394 "refs": { 395 } 396 }, 397 "CreateDomainAssociationResult": { 398 "base": "<p> The result structure for the create domain association request. </p>", 399 "refs": { 400 } 401 }, 402 "CreateTime": { 403 "base": null, 404 "refs": { 405 "App$createTime": "<p> Creates a date and time for the Amplify app. </p>", 406 "BackendEnvironment$createTime": "<p> The creation date and time for a backend environment that is part of an Amplify app. </p>", 407 "Branch$createTime": "<p> The creation date and time for a branch that is part of an Amplify app. </p>", 408 "Webhook$createTime": "<p> The create date and time for a webhook. </p>" 409 } 410 }, 411 "CreateWebhookRequest": { 412 "base": "<p> The request structure for the create webhook request. </p>", 413 "refs": { 414 } 415 }, 416 "CreateWebhookResult": { 417 "base": "<p> The result structure for the create webhook request. </p>", 418 "refs": { 419 } 420 }, 421 "CustomDomain": { 422 "base": null, 423 "refs": { 424 "CustomDomains$member": null 425 } 426 }, 427 "CustomDomains": { 428 "base": null, 429 "refs": { 430 "Branch$customDomains": "<p> The custom domains for a branch of an Amplify app. </p>" 431 } 432 }, 433 "CustomHeaders": { 434 "base": null, 435 "refs": { 436 "App$customHeaders": "<p>Describes the custom HTTP headers for the Amplify app.</p>", 437 "CreateAppRequest$customHeaders": "<p>The custom HTTP headers for an Amplify app.</p>", 438 "UpdateAppRequest$customHeaders": "<p>The custom HTTP headers for an Amplify app.</p>" 439 } 440 }, 441 "CustomRule": { 442 "base": "<p> Describes a custom rewrite or redirect rule. </p>", 443 "refs": { 444 "CustomRules$member": null 445 } 446 }, 447 "CustomRules": { 448 "base": null, 449 "refs": { 450 "App$customRules": "<p> Describes the custom redirect and rewrite rules for the Amplify app. </p>", 451 "CreateAppRequest$customRules": "<p> The custom rewrite and redirect rules for an Amplify app. </p>", 452 "UpdateAppRequest$customRules": "<p> The custom redirect and rewrite rules for an Amplify app. </p>" 453 } 454 }, 455 "DNSRecord": { 456 "base": null, 457 "refs": { 458 "SubDomain$dnsRecord": "<p> The DNS record for the subdomain. </p>" 459 } 460 }, 461 "DefaultDomain": { 462 "base": null, 463 "refs": { 464 "App$defaultDomain": "<p> The default domain for the Amplify app. </p>" 465 } 466 }, 467 "DeleteAppRequest": { 468 "base": "<p> Describes the request structure for the delete app request. </p>", 469 "refs": { 470 } 471 }, 472 "DeleteAppResult": { 473 "base": "<p> The result structure for the delete app request. </p>", 474 "refs": { 475 } 476 }, 477 "DeleteBackendEnvironmentRequest": { 478 "base": "<p> The request structure for the delete backend environment request. </p>", 479 "refs": { 480 } 481 }, 482 "DeleteBackendEnvironmentResult": { 483 "base": "<p> The result structure of the delete backend environment result. </p>", 484 "refs": { 485 } 486 }, 487 "DeleteBranchRequest": { 488 "base": "<p> The request structure for the delete branch request. </p>", 489 "refs": { 490 } 491 }, 492 "DeleteBranchResult": { 493 "base": "<p> The result structure for the delete branch request. </p>", 494 "refs": { 495 } 496 }, 497 "DeleteDomainAssociationRequest": { 498 "base": "<p> The request structure for the delete domain association request. </p>", 499 "refs": { 500 } 501 }, 502 "DeleteDomainAssociationResult": { 503 "base": null, 504 "refs": { 505 } 506 }, 507 "DeleteJobRequest": { 508 "base": "<p> The request structure for the delete job request. </p>", 509 "refs": { 510 } 511 }, 512 "DeleteJobResult": { 513 "base": "<p> The result structure for the delete job request. </p>", 514 "refs": { 515 } 516 }, 517 "DeleteWebhookRequest": { 518 "base": "<p> The request structure for the delete webhook request. </p>", 519 "refs": { 520 } 521 }, 522 "DeleteWebhookResult": { 523 "base": "<p> The result structure for the delete webhook request. </p>", 524 "refs": { 525 } 526 }, 527 "DependentServiceFailureException": { 528 "base": "<p> An operation failed because a dependent service threw an exception. </p>", 529 "refs": { 530 } 531 }, 532 "DeploymentArtifacts": { 533 "base": null, 534 "refs": { 535 "BackendEnvironment$deploymentArtifacts": "<p> The name of deployment artifacts. </p>", 536 "CreateBackendEnvironmentRequest$deploymentArtifacts": "<p> The name of deployment artifacts. </p>" 537 } 538 }, 539 "Description": { 540 "base": null, 541 "refs": { 542 "App$description": "<p> The description for the Amplify app. </p>", 543 "Branch$description": "<p> The description for the branch that is part of an Amplify app. </p>", 544 "CreateAppRequest$description": "<p> The description for an Amplify app. </p>", 545 "CreateBranchRequest$description": "<p> The description for the branch. </p>", 546 "CreateWebhookRequest$description": "<p> The description for a webhook. </p>", 547 "UpdateAppRequest$description": "<p> The description for an Amplify app. </p>", 548 "UpdateBranchRequest$description": "<p> The description for the branch. </p>", 549 "UpdateWebhookRequest$description": "<p> The description for a webhook. </p>", 550 "Webhook$description": "<p> The description for a webhook. </p>" 551 } 552 }, 553 "DisplayName": { 554 "base": null, 555 "refs": { 556 "Branch$displayName": "<p> The display name for the branch. This is used as the default domain prefix. </p>", 557 "CreateBranchRequest$displayName": "<p> The display name for a branch. This is used as the default domain prefix. </p>", 558 "UpdateBranchRequest$displayName": "<p> The display name for a branch. This is used as the default domain prefix. </p>" 559 } 560 }, 561 "DomainAssociation": { 562 "base": "<p> Describes a domain association that associates a custom domain with an Amplify app. </p>", 563 "refs": { 564 "CreateDomainAssociationResult$domainAssociation": "<p> Describes the structure of a domain association, which associates a custom domain with an Amplify app. </p>", 565 "DeleteDomainAssociationResult$domainAssociation": null, 566 "DomainAssociations$member": null, 567 "GetDomainAssociationResult$domainAssociation": "<p> Describes the structure of a domain association, which associates a custom domain with an Amplify app. </p>", 568 "UpdateDomainAssociationResult$domainAssociation": "<p> Describes a domain association, which associates a custom domain with an Amplify app. </p>" 569 } 570 }, 571 "DomainAssociationArn": { 572 "base": null, 573 "refs": { 574 "DomainAssociation$domainAssociationArn": "<p> The Amazon Resource Name (ARN) for the domain association. </p>" 575 } 576 }, 577 "DomainAssociations": { 578 "base": null, 579 "refs": { 580 "ListDomainAssociationsResult$domainAssociations": "<p> A list of domain associations. </p>" 581 } 582 }, 583 "DomainName": { 584 "base": null, 585 "refs": { 586 "CreateDomainAssociationRequest$domainName": "<p> The domain name for the domain association. </p>", 587 "DeleteDomainAssociationRequest$domainName": "<p> The name of the domain. </p>", 588 "DomainAssociation$domainName": "<p> The name of the domain. </p>", 589 "GenerateAccessLogsRequest$domainName": "<p> The name of the domain. </p>", 590 "GetDomainAssociationRequest$domainName": "<p> The name of the domain. </p>", 591 "UpdateDomainAssociationRequest$domainName": "<p> The name of the domain. </p>" 592 } 593 }, 594 "DomainPrefix": { 595 "base": null, 596 "refs": { 597 "SubDomainSetting$prefix": "<p> The prefix setting for the subdomain. </p>" 598 } 599 }, 600 "DomainStatus": { 601 "base": null, 602 "refs": { 603 "DomainAssociation$domainStatus": "<p> The current status of the domain association. </p>" 604 } 605 }, 606 "EnableAutoBranchCreation": { 607 "base": null, 608 "refs": { 609 "App$enableAutoBranchCreation": "<p> Enables automated branch creation for the Amplify app. </p>", 610 "CreateAppRequest$enableAutoBranchCreation": "<p> Enables automated branch creation for an Amplify app. </p>", 611 "UpdateAppRequest$enableAutoBranchCreation": "<p> Enables automated branch creation for an Amplify app. </p>" 612 } 613 }, 614 "EnableAutoBuild": { 615 "base": null, 616 "refs": { 617 "AutoBranchCreationConfig$enableAutoBuild": "<p> Enables auto building for the autocreated branch. </p>", 618 "Branch$enableAutoBuild": "<p> Enables auto-building on push for a branch of an Amplify app. </p>", 619 "CreateBranchRequest$enableAutoBuild": "<p> Enables auto building for the branch. </p>", 620 "UpdateAppRequest$enableBranchAutoBuild": "<p> Enables branch auto-building for an Amplify app. </p>", 621 "UpdateBranchRequest$enableAutoBuild": "<p> Enables auto building for the branch. </p>" 622 } 623 }, 624 "EnableAutoSubDomain": { 625 "base": null, 626 "refs": { 627 "CreateDomainAssociationRequest$enableAutoSubDomain": "<p> Enables the automated creation of subdomains for branches. </p>", 628 "DomainAssociation$enableAutoSubDomain": "<p> Enables the automated creation of subdomains for branches. </p>", 629 "UpdateDomainAssociationRequest$enableAutoSubDomain": "<p> Enables the automated creation of subdomains for branches. </p>" 630 } 631 }, 632 "EnableBasicAuth": { 633 "base": null, 634 "refs": { 635 "App$enableBasicAuth": "<p> Enables basic authorization for the Amplify app's branches. </p>", 636 "AutoBranchCreationConfig$enableBasicAuth": "<p> Enables basic authorization for the autocreated branch. </p>", 637 "Branch$enableBasicAuth": "<p> Enables basic authorization for a branch of an Amplify app. </p>", 638 "CreateAppRequest$enableBasicAuth": "<p> Enables basic authorization for an Amplify app. This will apply to all branches that are part of this app. </p>", 639 "CreateBranchRequest$enableBasicAuth": "<p> Enables basic authorization for the branch. </p>", 640 "UpdateAppRequest$enableBasicAuth": "<p> Enables basic authorization for an Amplify app. </p>", 641 "UpdateBranchRequest$enableBasicAuth": "<p> Enables basic authorization for the branch. </p>" 642 } 643 }, 644 "EnableBranchAutoBuild": { 645 "base": null, 646 "refs": { 647 "App$enableBranchAutoBuild": "<p> Enables the auto-building of branches for the Amplify app. </p>", 648 "CreateAppRequest$enableBranchAutoBuild": "<p> Enables the auto building of branches for an Amplify app. </p>" 649 } 650 }, 651 "EnableBranchAutoDeletion": { 652 "base": null, 653 "refs": { 654 "App$enableBranchAutoDeletion": "<p> Automatically disconnect a branch in the Amplify Console when you delete a branch from your Git repository. </p>", 655 "CreateAppRequest$enableBranchAutoDeletion": "<p> Automatically disconnects a branch in the Amplify Console when you delete a branch from your Git repository. </p>", 656 "UpdateAppRequest$enableBranchAutoDeletion": "<p> Automatically disconnects a branch in the Amplify Console when you delete a branch from your Git repository. </p>" 657 } 658 }, 659 "EnableNotification": { 660 "base": null, 661 "refs": { 662 "Branch$enableNotification": "<p> Enables notifications for a branch that is part of an Amplify app. </p>", 663 "CreateBranchRequest$enableNotification": "<p> Enables notifications for the branch. </p>", 664 "UpdateBranchRequest$enableNotification": "<p> Enables notifications for the branch. </p>" 665 } 666 }, 667 "EnablePerformanceMode": { 668 "base": null, 669 "refs": { 670 "AutoBranchCreationConfig$enablePerformanceMode": "<p>Enables performance mode for the branch.</p> <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>", 671 "Branch$enablePerformanceMode": "<p>Enables performance mode for the branch.</p> <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>", 672 "CreateBranchRequest$enablePerformanceMode": "<p>Enables performance mode for the branch.</p> <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>", 673 "UpdateBranchRequest$enablePerformanceMode": "<p>Enables performance mode for the branch.</p> <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>" 674 } 675 }, 676 "EnablePullRequestPreview": { 677 "base": null, 678 "refs": { 679 "AutoBranchCreationConfig$enablePullRequestPreview": "<p> Enables pull request previews for the autocreated branch. </p>", 680 "Branch$enablePullRequestPreview": "<p> Enables pull request previews for the branch. </p>", 681 "CreateBranchRequest$enablePullRequestPreview": "<p> Enables pull request previews for this branch. </p>", 682 "UpdateBranchRequest$enablePullRequestPreview": "<p> Enables pull request previews for this branch. </p>" 683 } 684 }, 685 "EndTime": { 686 "base": null, 687 "refs": { 688 "GenerateAccessLogsRequest$endTime": "<p> The time at which the logs should end. The time range specified is inclusive of the end time. </p>", 689 "JobSummary$endTime": "<p> The end date and time for the job. </p>", 690 "Step$endTime": "<p> The end date and time of the execution step. </p>" 691 } 692 }, 693 "EnvKey": { 694 "base": null, 695 "refs": { 696 "EnvironmentVariables$key": null 697 } 698 }, 699 "EnvValue": { 700 "base": null, 701 "refs": { 702 "EnvironmentVariables$value": null 703 } 704 }, 705 "EnvironmentName": { 706 "base": null, 707 "refs": { 708 "BackendEnvironment$environmentName": "<p> The name for a backend environment that is part of an Amplify app. </p>", 709 "CreateBackendEnvironmentRequest$environmentName": "<p> The name for the backend environment. </p>", 710 "DeleteBackendEnvironmentRequest$environmentName": "<p> The name of a backend environment of an Amplify app. </p>", 711 "GetBackendEnvironmentRequest$environmentName": "<p> The name for the backend environment. </p>", 712 "ListBackendEnvironmentsRequest$environmentName": "<p> The name of the backend environment </p>" 713 } 714 }, 715 "EnvironmentVariables": { 716 "base": null, 717 "refs": { 718 "App$environmentVariables": "<p> The environment variables for the Amplify app. </p>", 719 "AutoBranchCreationConfig$environmentVariables": "<p> The environment variables for the autocreated branch. </p>", 720 "Branch$environmentVariables": "<p> The environment variables specific to a branch of an Amplify app. </p>", 721 "CreateAppRequest$environmentVariables": "<p> The environment variables map for an Amplify app. </p>", 722 "CreateBranchRequest$environmentVariables": "<p> The environment variables for the branch. </p>", 723 "UpdateAppRequest$environmentVariables": "<p> The environment variables for an Amplify app. </p>", 724 "UpdateBranchRequest$environmentVariables": "<p> The environment variables for the branch. </p>" 725 } 726 }, 727 "ErrorMessage": { 728 "base": null, 729 "refs": { 730 "BadRequestException$message": null, 731 "DependentServiceFailureException$message": null, 732 "InternalFailureException$message": null, 733 "LimitExceededException$message": null, 734 "NotFoundException$message": null, 735 "ResourceNotFoundException$message": null, 736 "UnauthorizedException$message": null 737 } 738 }, 739 "FileMap": { 740 "base": null, 741 "refs": { 742 "CreateDeploymentRequest$fileMap": "<p> An optional file map that contains the file name as the key and the file content md5 hash as the value. If this argument is provided, the service will generate a unique upload URL per file. Otherwise, the service will only generate a single upload URL for the zipped files. </p>" 743 } 744 }, 745 "FileName": { 746 "base": null, 747 "refs": { 748 "FileMap$key": null, 749 "FileUploadUrls$key": null 750 } 751 }, 752 "FileUploadUrls": { 753 "base": null, 754 "refs": { 755 "CreateDeploymentResult$fileUploadUrls": "<p> When the <code>fileMap</code> argument is provided in the request, <code>fileUploadUrls</code> will contain a map of file names to upload URLs. </p>" 756 } 757 }, 758 "Framework": { 759 "base": null, 760 "refs": { 761 "AutoBranchCreationConfig$framework": "<p> The framework for the autocreated branch. </p>", 762 "Branch$framework": "<p> The framework for a branch of an Amplify app. </p>", 763 "CreateBranchRequest$framework": "<p> The framework for the branch. </p>", 764 "UpdateBranchRequest$framework": "<p> The framework for the branch. </p>" 765 } 766 }, 767 "GenerateAccessLogsRequest": { 768 "base": "<p> The request structure for the generate access logs request. </p>", 769 "refs": { 770 } 771 }, 772 "GenerateAccessLogsResult": { 773 "base": "<p> The result structure for the generate access logs request. </p>", 774 "refs": { 775 } 776 }, 777 "GetAppRequest": { 778 "base": "<p> The request structure for the get app request. </p>", 779 "refs": { 780 } 781 }, 782 "GetAppResult": { 783 "base": null, 784 "refs": { 785 } 786 }, 787 "GetArtifactUrlRequest": { 788 "base": "<p> Returns the request structure for the get artifact request. </p>", 789 "refs": { 790 } 791 }, 792 "GetArtifactUrlResult": { 793 "base": "<p> Returns the result structure for the get artifact request. </p>", 794 "refs": { 795 } 796 }, 797 "GetBackendEnvironmentRequest": { 798 "base": "<p> The request structure for the get backend environment request. </p>", 799 "refs": { 800 } 801 }, 802 "GetBackendEnvironmentResult": { 803 "base": "<p> The result structure for the get backend environment result. </p>", 804 "refs": { 805 } 806 }, 807 "GetBranchRequest": { 808 "base": "<p> The request structure for the get branch request. </p>", 809 "refs": { 810 } 811 }, 812 "GetBranchResult": { 813 "base": null, 814 "refs": { 815 } 816 }, 817 "GetDomainAssociationRequest": { 818 "base": "<p> The request structure for the get domain association request. </p>", 819 "refs": { 820 } 821 }, 822 "GetDomainAssociationResult": { 823 "base": "<p> The result structure for the get domain association request. </p>", 824 "refs": { 825 } 826 }, 827 "GetJobRequest": { 828 "base": "<p> The request structure for the get job request. </p>", 829 "refs": { 830 } 831 }, 832 "GetJobResult": { 833 "base": null, 834 "refs": { 835 } 836 }, 837 "GetWebhookRequest": { 838 "base": "<p> The request structure for the get webhook request. </p>", 839 "refs": { 840 } 841 }, 842 "GetWebhookResult": { 843 "base": "<p> The result structure for the get webhook request. </p>", 844 "refs": { 845 } 846 }, 847 "InternalFailureException": { 848 "base": "<p> The service failed to perform an operation due to an internal issue. </p>", 849 "refs": { 850 } 851 }, 852 "Job": { 853 "base": "<p> Describes an execution job for an Amplify app. </p>", 854 "refs": { 855 "GetJobResult$job": null 856 } 857 }, 858 "JobArn": { 859 "base": null, 860 "refs": { 861 "JobSummary$jobArn": "<p> The Amazon Resource Name (ARN) for the job. </p>" 862 } 863 }, 864 "JobId": { 865 "base": null, 866 "refs": { 867 "CreateDeploymentResult$jobId": "<p> The job ID for this deployment. will supply to start deployment api. </p>", 868 "DeleteJobRequest$jobId": "<p> The unique ID for the job. </p>", 869 "GetJobRequest$jobId": "<p> The unique ID for the job. </p>", 870 "JobSummary$jobId": "<p> The unique ID for the job. </p>", 871 "ListArtifactsRequest$jobId": "<p> The unique ID for a job. </p>", 872 "StartDeploymentRequest$jobId": "<p> The job ID for this deployment, generated by the create deployment request. </p>", 873 "StartJobRequest$jobId": "<p> The unique ID for an existing job. This is required if the value of <code>jobType</code> is <code>RETRY</code>. </p>", 874 "StopJobRequest$jobId": "<p> The unique id for the job. </p>" 875 } 876 }, 877 "JobReason": { 878 "base": null, 879 "refs": { 880 "StartJobRequest$jobReason": "<p> A descriptive reason for starting this job. </p>" 881 } 882 }, 883 "JobStatus": { 884 "base": null, 885 "refs": { 886 "JobSummary$status": "<p> The current status for the job. </p>", 887 "Step$status": "<p> The status of the execution step. </p>" 888 } 889 }, 890 "JobSummaries": { 891 "base": null, 892 "refs": { 893 "ListJobsResult$jobSummaries": "<p> The result structure for the list job result request. </p>" 894 } 895 }, 896 "JobSummary": { 897 "base": "<p> Describes the summary for an execution job for an Amplify app. </p>", 898 "refs": { 899 "DeleteJobResult$jobSummary": null, 900 "Job$summary": "<p> Describes the summary for an execution job for an Amplify app. </p>", 901 "JobSummaries$member": null, 902 "StartDeploymentResult$jobSummary": "<p> The summary for the job. </p>", 903 "StartJobResult$jobSummary": "<p> The summary for the job. </p>", 904 "StopJobResult$jobSummary": "<p> The summary for the job. </p>" 905 } 906 }, 907 "JobType": { 908 "base": null, 909 "refs": { 910 "JobSummary$jobType": "<p> The type for the job. If the value is <code>RELEASE</code>, the job was manually released from its source by using the <code>StartJob</code> API. If the value is <code>RETRY</code>, the job was manually retried using the <code>StartJob</code> API. If the value is <code>WEB_HOOK</code>, the job was automatically triggered by webhooks. </p>", 911 "StartJobRequest$jobType": "<p> Describes the type for the job. The job type <code>RELEASE</code> starts a new job with the latest change from the specified branch. This value is available only for apps that are connected to a repository. The job type <code>RETRY</code> retries an existing job. If the job type value is <code>RETRY</code>, the <code>jobId</code> is also required. </p>" 912 } 913 }, 914 "LastDeployTime": { 915 "base": null, 916 "refs": { 917 "ProductionBranch$lastDeployTime": "<p> The last deploy time of the production branch. </p>" 918 } 919 }, 920 "LimitExceededException": { 921 "base": "<p> A resource could not be created because service quotas were exceeded. </p>", 922 "refs": { 923 } 924 }, 925 "ListAppsRequest": { 926 "base": "<p> The request structure for the list apps request. </p>", 927 "refs": { 928 } 929 }, 930 "ListAppsResult": { 931 "base": "<p> The result structure for an Amplify app list request. </p>", 932 "refs": { 933 } 934 }, 935 "ListArtifactsRequest": { 936 "base": "<p> Describes the request structure for the list artifacts request. </p>", 937 "refs": { 938 } 939 }, 940 "ListArtifactsResult": { 941 "base": "<p> The result structure for the list artifacts request. </p>", 942 "refs": { 943 } 944 }, 945 "ListBackendEnvironmentsRequest": { 946 "base": "<p> The request structure for the list backend environments request. </p>", 947 "refs": { 948 } 949 }, 950 "ListBackendEnvironmentsResult": { 951 "base": "<p> The result structure for the list backend environments result. </p>", 952 "refs": { 953 } 954 }, 955 "ListBranchesRequest": { 956 "base": "<p> The request structure for the list branches request. </p>", 957 "refs": { 958 } 959 }, 960 "ListBranchesResult": { 961 "base": "<p> The result structure for the list branches request. </p>", 962 "refs": { 963 } 964 }, 965 "ListDomainAssociationsRequest": { 966 "base": "<p> The request structure for the list domain associations request. </p>", 967 "refs": { 968 } 969 }, 970 "ListDomainAssociationsResult": { 971 "base": "<p> The result structure for the list domain association request. </p>", 972 "refs": { 973 } 974 }, 975 "ListJobsRequest": { 976 "base": "<p> The request structure for the list jobs request. </p>", 977 "refs": { 978 } 979 }, 980 "ListJobsResult": { 981 "base": "<p> The maximum number of records to list in a single response. </p>", 982 "refs": { 983 } 984 }, 985 "ListTagsForResourceRequest": { 986 "base": "<p> The request structure to use to list tags for a resource. </p>", 987 "refs": { 988 } 989 }, 990 "ListTagsForResourceResponse": { 991 "base": "<p> The response for the list tags for resource request. </p>", 992 "refs": { 993 } 994 }, 995 "ListWebhooksRequest": { 996 "base": "<p> The request structure for the list webhooks request. </p>", 997 "refs": { 998 } 999 }, 1000 "ListWebhooksResult": { 1001 "base": "<p> The result structure for the list webhooks request. </p>", 1002 "refs": { 1003 } 1004 }, 1005 "LogUrl": { 1006 "base": null, 1007 "refs": { 1008 "GenerateAccessLogsResult$logUrl": "<p> The pre-signed URL for the requested access logs. </p>", 1009 "Step$logUrl": "<p> The URL to the logs for the execution step. </p>" 1010 } 1011 }, 1012 "MD5Hash": { 1013 "base": null, 1014 "refs": { 1015 "FileMap$value": null 1016 } 1017 }, 1018 "MaxResults": { 1019 "base": null, 1020 "refs": { 1021 "ListAppsRequest$maxResults": "<p> The maximum number of records to list in a single response. </p>", 1022 "ListArtifactsRequest$maxResults": "<p> The maximum number of records to list in a single response. </p>", 1023 "ListBackendEnvironmentsRequest$maxResults": "<p> The maximum number of records to list in a single response. </p>", 1024 "ListBranchesRequest$maxResults": "<p> The maximum number of records to list in a single response. </p>", 1025 "ListDomainAssociationsRequest$maxResults": "<p> The maximum number of records to list in a single response. </p>", 1026 "ListJobsRequest$maxResults": "<p> The maximum number of records to list in a single response. </p>", 1027 "ListWebhooksRequest$maxResults": "<p> The maximum number of records to list in a single response. </p>" 1028 } 1029 }, 1030 "Name": { 1031 "base": null, 1032 "refs": { 1033 "App$name": "<p> The name for the Amplify app. </p>", 1034 "CreateAppRequest$name": "<p> The name for an Amplify app. </p>", 1035 "UpdateAppRequest$name": "<p> The name for an Amplify app. </p>" 1036 } 1037 }, 1038 "NextToken": { 1039 "base": null, 1040 "refs": { 1041 "ListAppsRequest$nextToken": "<p> A pagination token. If non-null, the pagination token is returned in a result. Pass its value in another request to retrieve more entries. </p>", 1042 "ListAppsResult$nextToken": "<p> A pagination token. Set to null to start listing apps from start. If non-null, the pagination token is returned in a result. Pass its value in here to list more projects. </p>", 1043 "ListArtifactsRequest$nextToken": "<p> A pagination token. Set to null to start listing artifacts from start. If a non-null pagination token is returned in a result, pass its value in here to list more artifacts. </p>", 1044 "ListArtifactsResult$nextToken": "<p> A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries. </p>", 1045 "ListBackendEnvironmentsRequest$nextToken": "<p> A pagination token. Set to null to start listing backend environments from the start. If a non-null pagination token is returned in a result, pass its value in here to list more backend environments. </p>", 1046 "ListBackendEnvironmentsResult$nextToken": "<p> A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries. </p>", 1047 "ListBranchesRequest$nextToken": "<p> A pagination token. Set to null to start listing branches from the start. If a non-null pagination token is returned in a result, pass its value in here to list more branches. </p>", 1048 "ListBranchesResult$nextToken": "<p> A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries. </p>", 1049 "ListDomainAssociationsRequest$nextToken": "<p> A pagination token. Set to null to start listing apps from the start. If non-null, a pagination token is returned in a result. Pass its value in here to list more projects. </p>", 1050 "ListDomainAssociationsResult$nextToken": "<p> A pagination token. If non-null, a pagination token is returned in a result. Pass its value in another request to retrieve more entries. </p>", 1051 "ListJobsRequest$nextToken": "<p> A pagination token. Set to null to start listing steps from the start. If a non-null pagination token is returned in a result, pass its value in here to list more steps. </p>", 1052 "ListJobsResult$nextToken": "<p> A pagination token. If non-null the pagination token is returned in a result. Pass its value in another request to retrieve more entries. </p>", 1053 "ListWebhooksRequest$nextToken": "<p> A pagination token. Set to null to start listing webhooks from the start. If non-null,the pagination token is returned in a result. Pass its value in here to list more webhooks. </p>", 1054 "ListWebhooksResult$nextToken": "<p> A pagination token. If non-null, the pagination token is returned in a result. Pass its value in another request to retrieve more entries. </p>" 1055 } 1056 }, 1057 "NotFoundException": { 1058 "base": "<p> An entity was not found during an operation. </p>", 1059 "refs": { 1060 } 1061 }, 1062 "OauthToken": { 1063 "base": null, 1064 "refs": { 1065 "CreateAppRequest$oauthToken": "<p> The OAuth token for a third-party source control system for an Amplify app. The OAuth token is used to create a webhook and a read-only deploy key. The OAuth token is not stored. </p>", 1066 "UpdateAppRequest$oauthToken": "<p> The OAuth token for a third-party source control system for an Amplify app. The token is used to create a webhook and a read-only deploy key. The OAuth token is not stored. </p>" 1067 } 1068 }, 1069 "Platform": { 1070 "base": null, 1071 "refs": { 1072 "App$platform": "<p> The platform for the Amplify app. </p>", 1073 "CreateAppRequest$platform": "<p> The platform or framework for an Amplify app. </p>", 1074 "UpdateAppRequest$platform": "<p> The platform for an Amplify app. </p>" 1075 } 1076 }, 1077 "ProductionBranch": { 1078 "base": "<p> Describes the information about a production branch for an Amplify app. </p>", 1079 "refs": { 1080 "App$productionBranch": "<p> Describes the information about a production branch of the Amplify app. </p>" 1081 } 1082 }, 1083 "PullRequestEnvironmentName": { 1084 "base": null, 1085 "refs": { 1086 "AutoBranchCreationConfig$pullRequestEnvironmentName": "<p> The Amplify environment name for the pull request. </p>", 1087 "Branch$pullRequestEnvironmentName": "<p> The Amplify environment name for the pull request. </p>", 1088 "CreateBranchRequest$pullRequestEnvironmentName": "<p> The Amplify environment name for the pull request. </p>", 1089 "UpdateBranchRequest$pullRequestEnvironmentName": "<p> The Amplify environment name for the pull request. </p>" 1090 } 1091 }, 1092 "Repository": { 1093 "base": null, 1094 "refs": { 1095 "App$repository": "<p> The repository for the Amplify app. </p>", 1096 "CreateAppRequest$repository": "<p> The repository for an Amplify app. </p>", 1097 "UpdateAppRequest$repository": "<p> The name of the repository for an Amplify app </p>" 1098 } 1099 }, 1100 "ResourceArn": { 1101 "base": null, 1102 "refs": { 1103 "ListTagsForResourceRequest$resourceArn": "<p> The Amazon Resource Name (ARN) to use to list tags. </p>", 1104 "TagResourceRequest$resourceArn": "<p> The Amazon Resource Name (ARN) to use to tag a resource. </p>", 1105 "UntagResourceRequest$resourceArn": "<p> The Amazon Resource Name (ARN) to use to untag a resource. </p>" 1106 } 1107 }, 1108 "ResourceNotFoundException": { 1109 "base": "<p> An operation failed due to a non-existent resource. </p>", 1110 "refs": { 1111 } 1112 }, 1113 "Screenshots": { 1114 "base": null, 1115 "refs": { 1116 "Step$screenshots": "<p> The list of screenshot URLs for the execution step, if relevant. </p>" 1117 } 1118 }, 1119 "ServiceRoleArn": { 1120 "base": null, 1121 "refs": { 1122 "App$iamServiceRoleArn": "<p> The AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) of the Amplify app. </p>", 1123 "CreateAppRequest$iamServiceRoleArn": "<p> The AWS Identity and Access Management (IAM) service role for an Amplify app. </p>", 1124 "UpdateAppRequest$iamServiceRoleArn": "<p> The AWS Identity and Access Management (IAM) service role for an Amplify app. </p>" 1125 } 1126 }, 1127 "Source": { 1128 "base": null, 1129 "refs": { 1130 "CustomRule$source": "<p> The source pattern for a URL rewrite or redirect rule. </p>" 1131 } 1132 }, 1133 "SourceUrl": { 1134 "base": null, 1135 "refs": { 1136 "StartDeploymentRequest$sourceUrl": "<p> The source URL for this deployment, used when calling start deployment without create deployment. The source URL can be any HTTP GET URL that is publicly accessible and downloads a single .zip file. </p>" 1137 } 1138 }, 1139 "StackName": { 1140 "base": null, 1141 "refs": { 1142 "BackendEnvironment$stackName": "<p> The AWS CloudFormation stack name of a backend environment. </p>", 1143 "CreateBackendEnvironmentRequest$stackName": "<p> The AWS CloudFormation stack name of a backend environment. </p>" 1144 } 1145 }, 1146 "Stage": { 1147 "base": null, 1148 "refs": { 1149 "AutoBranchCreationConfig$stage": "<p> Describes the current stage for the autocreated branch. </p>", 1150 "Branch$stage": "<p> The current stage for the branch that is part of an Amplify app. </p>", 1151 "CreateBranchRequest$stage": "<p> Describes the current stage for the branch. </p>", 1152 "UpdateBranchRequest$stage": "<p> Describes the current stage for the branch. </p>" 1153 } 1154 }, 1155 "StartDeploymentRequest": { 1156 "base": "<p> The request structure for the start a deployment request. </p>", 1157 "refs": { 1158 } 1159 }, 1160 "StartDeploymentResult": { 1161 "base": "<p> The result structure for the start a deployment request. </p>", 1162 "refs": { 1163 } 1164 }, 1165 "StartJobRequest": { 1166 "base": "<p> The request structure for the start job request. </p>", 1167 "refs": { 1168 } 1169 }, 1170 "StartJobResult": { 1171 "base": "<p> The result structure for the run job request. </p>", 1172 "refs": { 1173 } 1174 }, 1175 "StartTime": { 1176 "base": null, 1177 "refs": { 1178 "GenerateAccessLogsRequest$startTime": "<p> The time at which the logs should start. The time range specified is inclusive of the start time. </p>", 1179 "JobSummary$startTime": "<p> The start date and time for the job. </p>", 1180 "Step$startTime": "<p> The start date and time of the execution step. </p>" 1181 } 1182 }, 1183 "Status": { 1184 "base": null, 1185 "refs": { 1186 "CustomRule$status": "<p> The status code for a URL rewrite or redirect rule. </p> <dl> <dt>200</dt> <dd> <p>Represents a 200 rewrite rule.</p> </dd> <dt>301</dt> <dd> <p>Represents a 301 (moved pemanently) redirect rule. This and all future requests should be directed to the target URL. </p> </dd> <dt>302</dt> <dd> <p>Represents a 302 temporary redirect rule.</p> </dd> <dt>404</dt> <dd> <p>Represents a 404 redirect rule.</p> </dd> <dt>404-200</dt> <dd> <p>Represents a 404 rewrite rule.</p> </dd> </dl>", 1187 "ProductionBranch$status": "<p> The status of the production branch. </p>" 1188 } 1189 }, 1190 "StatusReason": { 1191 "base": null, 1192 "refs": { 1193 "DomainAssociation$statusReason": "<p> The reason for the current status of the domain association. </p>", 1194 "Step$statusReason": "<p> The reason for the current step status. </p>" 1195 } 1196 }, 1197 "Step": { 1198 "base": "<p> Describes an execution step, for an execution job, for an Amplify app. </p>", 1199 "refs": { 1200 "Steps$member": null 1201 } 1202 }, 1203 "StepName": { 1204 "base": null, 1205 "refs": { 1206 "Step$stepName": "<p> The name of the execution step. </p>" 1207 } 1208 }, 1209 "Steps": { 1210 "base": null, 1211 "refs": { 1212 "Job$steps": "<p> The execution steps for an execution job, for an Amplify app. </p>" 1213 } 1214 }, 1215 "StopJobRequest": { 1216 "base": "<p> The request structure for the stop job request. </p>", 1217 "refs": { 1218 } 1219 }, 1220 "StopJobResult": { 1221 "base": "<p> The result structure for the stop job request. </p>", 1222 "refs": { 1223 } 1224 }, 1225 "SubDomain": { 1226 "base": "<p> The subdomain for the domain association. </p>", 1227 "refs": { 1228 "SubDomains$member": null 1229 } 1230 }, 1231 "SubDomainSetting": { 1232 "base": "<p> Describes the settings for the subdomain. </p>", 1233 "refs": { 1234 "SubDomain$subDomainSetting": "<p> Describes the settings for the subdomain. </p>", 1235 "SubDomainSettings$member": null 1236 } 1237 }, 1238 "SubDomainSettings": { 1239 "base": null, 1240 "refs": { 1241 "CreateDomainAssociationRequest$subDomainSettings": "<p> The setting for the subdomain. </p>", 1242 "UpdateDomainAssociationRequest$subDomainSettings": "<p> Describes the settings for the subdomain. </p>" 1243 } 1244 }, 1245 "SubDomains": { 1246 "base": null, 1247 "refs": { 1248 "DomainAssociation$subDomains": "<p> The subdomains for the domain association. </p>" 1249 } 1250 }, 1251 "TTL": { 1252 "base": "<p> The content Time to Live (TTL) for the website in seconds. </p>", 1253 "refs": { 1254 "Branch$ttl": "<p> The content Time to Live (TTL) for the website in seconds. </p>", 1255 "CreateBranchRequest$ttl": "<p> The content Time To Live (TTL) for the website in seconds. </p>", 1256 "UpdateBranchRequest$ttl": "<p> The content Time to Live (TTL) for the website in seconds. </p>" 1257 } 1258 }, 1259 "TagKey": { 1260 "base": null, 1261 "refs": { 1262 "TagKeyList$member": null, 1263 "TagMap$key": null 1264 } 1265 }, 1266 "TagKeyList": { 1267 "base": null, 1268 "refs": { 1269 "UntagResourceRequest$tagKeys": "<p> The tag keys to use to untag a resource. </p>" 1270 } 1271 }, 1272 "TagMap": { 1273 "base": null, 1274 "refs": { 1275 "App$tags": "<p> The tag for the Amplify app. </p>", 1276 "Branch$tags": "<p> The tag for the branch of an Amplify app. </p>", 1277 "CreateAppRequest$tags": "<p> The tag for an Amplify app. </p>", 1278 "CreateBranchRequest$tags": "<p> The tag for the branch. </p>", 1279 "ListTagsForResourceResponse$tags": "<p> A list of tags for the specified The Amazon Resource Name (ARN). </p>", 1280 "TagResourceRequest$tags": "<p> The tags used to tag the resource. </p>" 1281 } 1282 }, 1283 "TagResourceRequest": { 1284 "base": "<p> The request structure to tag a resource with a tag key and value. </p>", 1285 "refs": { 1286 } 1287 }, 1288 "TagResourceResponse": { 1289 "base": "<p> The response for the tag resource request. </p>", 1290 "refs": { 1291 } 1292 }, 1293 "TagValue": { 1294 "base": null, 1295 "refs": { 1296 "TagMap$value": null 1297 } 1298 }, 1299 "Target": { 1300 "base": null, 1301 "refs": { 1302 "CustomRule$target": "<p> The target pattern for a URL rewrite or redirect rule. </p>" 1303 } 1304 }, 1305 "TestArtifactsUrl": { 1306 "base": null, 1307 "refs": { 1308 "Step$testArtifactsUrl": "<p> The URL to the test artifact for the execution step. </p>" 1309 } 1310 }, 1311 "TestConfigUrl": { 1312 "base": null, 1313 "refs": { 1314 "Step$testConfigUrl": "<p> The URL to the test configuration for the execution step. </p>" 1315 } 1316 }, 1317 "ThumbnailName": { 1318 "base": null, 1319 "refs": { 1320 "Screenshots$key": null 1321 } 1322 }, 1323 "ThumbnailUrl": { 1324 "base": null, 1325 "refs": { 1326 "Branch$thumbnailUrl": "<p> The thumbnail URL for the branch of an Amplify app. </p>", 1327 "ProductionBranch$thumbnailUrl": "<p> The thumbnail URL for the production branch. </p>", 1328 "Screenshots$value": null 1329 } 1330 }, 1331 "TotalNumberOfJobs": { 1332 "base": null, 1333 "refs": { 1334 "Branch$totalNumberOfJobs": "<p> The total number of jobs that are part of an Amplify app. </p>" 1335 } 1336 }, 1337 "UnauthorizedException": { 1338 "base": "<p> An operation failed due to a lack of access. </p>", 1339 "refs": { 1340 } 1341 }, 1342 "UntagResourceRequest": { 1343 "base": "<p> The request structure for the untag resource request. </p>", 1344 "refs": { 1345 } 1346 }, 1347 "UntagResourceResponse": { 1348 "base": "<p> The response for the untag resource request. </p>", 1349 "refs": { 1350 } 1351 }, 1352 "UpdateAppRequest": { 1353 "base": "<p> The request structure for the update app request. </p>", 1354 "refs": { 1355 } 1356 }, 1357 "UpdateAppResult": { 1358 "base": "<p> The result structure for an Amplify app update request. </p>", 1359 "refs": { 1360 } 1361 }, 1362 "UpdateBranchRequest": { 1363 "base": "<p> The request structure for the update branch request. </p>", 1364 "refs": { 1365 } 1366 }, 1367 "UpdateBranchResult": { 1368 "base": "<p> The result structure for the update branch request. </p>", 1369 "refs": { 1370 } 1371 }, 1372 "UpdateDomainAssociationRequest": { 1373 "base": "<p> The request structure for the update domain association request. </p>", 1374 "refs": { 1375 } 1376 }, 1377 "UpdateDomainAssociationResult": { 1378 "base": "<p> The result structure for the update domain association request. </p>", 1379 "refs": { 1380 } 1381 }, 1382 "UpdateTime": { 1383 "base": null, 1384 "refs": { 1385 "App$updateTime": "<p> Updates the date and time for the Amplify app. </p>", 1386 "BackendEnvironment$updateTime": "<p> The last updated date and time for a backend environment that is part of an Amplify app. </p>", 1387 "Branch$updateTime": "<p> The last updated date and time for a branch that is part of an Amplify app. </p>", 1388 "Webhook$updateTime": "<p> Updates the date and time for a webhook. </p>" 1389 } 1390 }, 1391 "UpdateWebhookRequest": { 1392 "base": "<p> The request structure for the update webhook request. </p>", 1393 "refs": { 1394 } 1395 }, 1396 "UpdateWebhookResult": { 1397 "base": "<p> The result structure for the update webhook request. </p>", 1398 "refs": { 1399 } 1400 }, 1401 "UploadUrl": { 1402 "base": null, 1403 "refs": { 1404 "CreateDeploymentResult$zipUploadUrl": "<p> When the <code>fileMap</code> argument is not provided in the request, this <code>zipUploadUrl</code> is returned. </p>", 1405 "FileUploadUrls$value": null 1406 } 1407 }, 1408 "Verified": { 1409 "base": null, 1410 "refs": { 1411 "SubDomain$verified": "<p> The verified status of the subdomain </p>" 1412 } 1413 }, 1414 "Webhook": { 1415 "base": "<p> Describes a webhook that connects repository events to an Amplify app. </p>", 1416 "refs": { 1417 "CreateWebhookResult$webhook": "<p> Describes a webhook that connects repository events to an Amplify app. </p>", 1418 "DeleteWebhookResult$webhook": "<p> Describes a webhook that connects repository events to an Amplify app. </p>", 1419 "GetWebhookResult$webhook": "<p> Describes the structure of a webhook. </p>", 1420 "UpdateWebhookResult$webhook": "<p> Describes a webhook that connects repository events to an Amplify app. </p>", 1421 "Webhooks$member": null 1422 } 1423 }, 1424 "WebhookArn": { 1425 "base": null, 1426 "refs": { 1427 "Webhook$webhookArn": "<p> The Amazon Resource Name (ARN) for the webhook. </p>" 1428 } 1429 }, 1430 "WebhookId": { 1431 "base": null, 1432 "refs": { 1433 "DeleteWebhookRequest$webhookId": "<p> The unique ID for a webhook. </p>", 1434 "GetWebhookRequest$webhookId": "<p> The unique ID for a webhook. </p>", 1435 "UpdateWebhookRequest$webhookId": "<p> The unique ID for a webhook. </p>", 1436 "Webhook$webhookId": "<p> The ID of the webhook. </p>" 1437 } 1438 }, 1439 "WebhookUrl": { 1440 "base": null, 1441 "refs": { 1442 "Webhook$webhookUrl": "<p> The URL of the webhook. </p>" 1443 } 1444 }, 1445 "Webhooks": { 1446 "base": null, 1447 "refs": { 1448 "ListWebhooksResult$webhooks": "<p> A list of webhooks. </p>" 1449 } 1450 } 1451 } 1452} 1453