openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

github.com/httptoolkit/openapi-directory-js

1 lines • 156 kB

JSON

{"openapi":"3.0.0","info":{"version":"2017-07-25","x-release":"v4","title":"AWS Amplify","description":"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> ","x-logo":{"url":"https://twitter.com/awscloud/profile_image?size=original","backgroundColor":"#FFFFFF"},"termsOfService":"https://aws.amazon.com/service-terms/","contact":{"name":"Mike Ralphson","email":"mike.ralphson@gmail.com","url":"https://github.com/mermade/aws2openapi","x-twitter":"PermittedSoc"},"license":{"name":"Apache 2.0 License","url":"http://www.apache.org/licenses/"},"x-providerName":"amazonaws.com","x-serviceName":"amplify","x-aws-signingName":"amplify","x-origin":[{"contentType":"application/json","url":"https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/amplify-2017-07-25.normal.json","converter":{"url":"https://github.com/mermade/aws2openapi","version":"1.0.0"},"x-apisguru-driver":"external"}],"x-apiClientRegistration":{"url":"https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct"},"x-apisguru-categories":["cloud"],"x-preferred":true},"externalDocs":{"description":"Amazon Web Services documentation","url":"https://docs.aws.amazon.com/amplify/"},"servers":[{"url":"http://amplify.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The Amplify multi-region endpoint"},{"url":"https://amplify.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The Amplify multi-region endpoint"},{"url":"http://amplify.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The Amplify endpoint for China (Beijing) and China (Ningxia)"},{"url":"https://amplify.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The Amplify endpoint for China (Beijing) and China (Ningxia)"}],"x-hasEquivalentPaths":true,"paths":{"/apps":{"post":{"operationId":"CreateApp","description":" Creates a new Amplify app. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAppResult"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"482":{"description":"InternalFailureException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalFailureException"}}}},"483":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"484":{"description":"DependentServiceFailureException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DependentServiceFailureException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"description":" The name for an Amplify app. ","type":"string","pattern":"\$\\?s\$.\\+","minLength":1,"maxLength":255},"description":{"description":" The description for an Amplify app. ","type":"string","pattern":"\$\\?s\$.*","maxLength":1000},"repository":{"description":" The repository for an Amplify app. ","type":"string","pattern":"\$\\?s\$.*","maxLength":1000},"platform":{"description":" The platform for the Amplify app. For a static app, set the platform type to <code>WEB</code>. For a dynamic server-side rendered (SSR) app, set the platform type to <code>WEB_COMPUTE</code>. For an app requiring Amplify Hosting's original SSR support only, set the platform type to <code>WEB_DYNAMIC</code>.","type":"string","enum":["WEB","WEB_DYNAMIC","WEB_COMPUTE"]},"iamServiceRoleArn":{"description":" The AWS Identity and Access Management (IAM) service role for an Amplify app. ","type":"string","pattern":"\$\\?s\$.*","minLength":0,"maxLength":1000},"oauthToken":{"description":"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 using SSH cloning. The OAuth token is not stored. Use <code>oauthToken</code> for repository providers other than GitHub, such as Bitbucket or CodeCommit. To authorize access to GitHub as your repository provider, use <code>accessToken</code>. You must specify either <code>oauthToken</code> or <code>accessToken</code> when you create a new app. Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see <a href=\"https://docs.aws.amazon.com/amplify/latest/UserGuide/setting-up-GitHub-access.html#migrating-to-github-app-auth\">Migrating an existing OAuth app to the Amplify GitHub App</a> in the Amplify User Guide .","type":"string","pattern":"\$\\?s\$.*","maxLength":1000,"format":"password"},"accessToken":{"description":"The personal access token for a GitHub repository for an Amplify app. The personal access token is used to authorize access to a GitHub repository using the Amplify GitHub App. The token is not stored. Use <code>accessToken</code> for GitHub repositories only. To authorize access to a repository provider such as Bitbucket or CodeCommit, use <code>oauthToken</code>. You must specify either <code>accessToken</code> or <code>oauthToken</code> when you create a new app. Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see <a href=\"https://docs.aws.amazon.com/amplify/latest/UserGuide/setting-up-GitHub-access.html#migrating-to-github-app-auth\">Migrating an existing OAuth app to the Amplify GitHub App</a> in the Amplify User Guide .","type":"string","pattern":"\$\\?s\$.\\+","minLength":1,"maxLength":255,"format":"password"},"environmentVariables":{"description":" The environment variables map for an Amplify app. ","type":"object","additionalProperties":{"$ref":"#/components/schemas/EnvValue"}},"enableBranchAutoBuild":{"description":" Enables the auto building of branches for an Amplify app. ","type":"boolean"},"enableBranchAutoDeletion":{"description":" Automatically disconnects a branch in the Amplify Console when you delete a branch from your Git repository. ","type":"boolean"},"enableBasicAuth":{"description":" Enables basic authorization for an Amplify app. This will apply to all branches that are part of this app. ","type":"boolean"},"basicAuthCredentials":{"description":" The credentials for basic authorization for an Amplify app. You must base64-encode the authorization credentials and provide them in the format <code>user:password</code>.","type":"string","pattern":"\$\\?s\$.*","maxLength":2000,"format":"password"},"customRules":{"description":" The custom rewrite and redirect rules for an Amplify app. ","type":"array","items":{"$ref":"#/components/schemas/CustomRule"}},"tags":{"description":" The tag for an Amplify app. ","type":"object","minProperties":0,"maxProperties":50,"additionalProperties":{"$ref":"#/components/schemas/TagValue"}},"buildSpec":{"description":" The build specification (build spec) file for an Amplify app build. ","type":"string","pattern":"\$\\?s\$.\\+","minLength":1,"maxLength":25000,"format":"password"},"customHeaders":{"description":"The custom HTTP headers for an Amplify app.","type":"string","pattern":"\$\\?s\$.*","minLength":0,"maxLength":25000},"enableAutoBranchCreation":{"description":" Enables automated branch creation for an Amplify app. ","type":"boolean"},"autoBranchCreationPatterns":{"description":" The automated branch creation glob patterns for an Amplify app. ","type":"array","items":{"$ref":"#/components/schemas/AutoBranchCreationPattern"}},"autoBranchCreationConfig":{"description":" Describes the automated branch creation configuration. ","type":"object","properties":{"stage":{"allOf":[{"$ref":"#/components/schemas/Stage"},{"description":" Describes the current stage for the autocreated branch. "}]},"framework":{"allOf":[{"$ref":"#/components/schemas/Framework"},{"description":" The framework for the autocreated branch. "}]},"enableAutoBuild":{"allOf":[{"$ref":"#/components/schemas/EnableAutoBuild"},{"description":" Enables auto building for the autocreated branch. "}]},"environmentVariables":{"allOf":[{"$ref":"#/components/schemas/EnvironmentVariables"},{"description":" The environment variables for the autocreated branch. "}]},"basicAuthCredentials":{"allOf":[{"$ref":"#/components/schemas/BasicAuthCredentials"},{"description":" The basic authorization credentials for the autocreated branch. You must base64-encode the authorization credentials and provide them in the format <code>user:password</code>."}]},"enableBasicAuth":{"allOf":[{"$ref":"#/components/schemas/EnableBasicAuth"},{"description":" Enables basic authorization for the autocreated branch. "}]},"enablePerformanceMode":{"allOf":[{"$ref":"#/components/schemas/EnablePerformanceMode"},{"description":"Enables performance mode for the branch. 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. "}]},"buildSpec":{"allOf":[{"$ref":"#/components/schemas/BuildSpec"},{"description":" The build specification (build spec) for the autocreated branch. "}]},"enablePullRequestPreview":{"allOf":[{"$ref":"#/components/schemas/EnablePullRequestPreview"},{"description":" Enables pull request previews for the autocreated branch. "}]},"pullRequestEnvironmentName":{"allOf":[{"$ref":"#/components/schemas/PullRequestEnvironmentName"},{"description":" The Amplify environment name for the pull request. "}]}}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"ListApps","description":" Returns a list of the existing Amplify apps. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAppsResult"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"482":{"description":"InternalFailureException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalFailureException"}}}}},"parameters":[{"name":"nextToken","in":"query","required":false,"description":" A pagination token. If non-null, the pagination token is returned in a result. Pass its value in another request to retrieve more entries. ","schema":{"type":"string","pattern":"\$\\?s\$.*","maxLength":2000}},{"name":"maxResults","in":"query","required":false,"description":" The maximum number of records to list in a single response. ","schema":{"type":"integer","minimum":0,"maximum":100}}]}},"/apps/{appId}/backendenvironments":{"post":{"operationId":"CreateBackendEnvironment","description":" Creates a new backend environment for an Amplify app. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBackendEnvironmentResult"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"482":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"483":{"description":"InternalFailureException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalFailureException"}}}},"484":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}}},"parameters":[{"name":"appId","in":"path","required":true,"description":" The unique ID for an Amplify app. ","schema":{"type":"string","pattern":"d[a-z0-9]+","minLength":1,"maxLength":20}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["environmentName"],"properties":{"environmentName":{"description":" The name for the backend environment. ","type":"string","pattern":"\$\\?s\$.\\+","minLength":1,"maxLength":255},"stackName":{"description":" The AWS CloudFormation stack name of a backend environment. ","type":"string","pattern":"\$\\?s\$.\\+","minLength":1,"maxLength":255},"deploymentArtifacts":{"description":" The name of deployment artifacts. ","type":"string","pattern":"\$\\?s\$.\\+","minLength":1,"maxLength":1000}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"ListBackendEnvironments","description":" Lists the backend environments for an Amplify app. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBackendEnvironmentsResult"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"482":{"description":"InternalFailureException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalFailureException"}}}}},"parameters":[{"name":"appId","in":"path","required":true,"description":" The unique ID for an Amplify app. ","schema":{"type":"string","pattern":"d[a-z0-9]+","minLength":1,"maxLength":20}},{"name":"environmentName","in":"query","required":false,"description":" The name of the backend environment ","schema":{"type":"string","pattern":"\$\\?s\$.\\+","minLength":1,"maxLength":255}},{"name":"nextToken","in":"query","required":false,"description":" 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. ","schema":{"type":"string","pattern":"\$\\?s\$.*","maxLength":2000}},{"name":"maxResults","in":"query","required":false,"description":" The maximum number of records to list in a single response. ","schema":{"type":"integer","minimum":0,"maximum":100}}]}},"/apps/{appId}/branches":{"post":{"operationId":"CreateBranch","description":" Creates a new branch for an Amplify app. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBranchResult"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"482":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"483":{"description":"InternalFailureException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalFailureException"}}}},"484":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"485":{"description":"DependentServiceFailureException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DependentServiceFailureException"}}}}},"parameters":[{"name":"appId","in":"path","required":true,"description":" The unique ID for an Amplify app. ","schema":{"type":"string","pattern":"d[a-z0-9]+","minLength":1,"maxLength":20}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["branchName"],"properties":{"branchName":{"description":" The name for the branch. ","type":"string","pattern":"\$\\?s\$.\\+","minLength":1,"maxLength":255},"description":{"description":" The description for the branch. ","type":"string","pattern":"\$\\?s\$.*","maxLength":1000},"stage":{"description":" Describes the current stage for the branch. ","type":"string","enum":["PRODUCTION","BETA","DEVELOPMENT","EXPERIMENTAL","PULL_REQUEST"]},"framework":{"description":" The framework for the branch. ","type":"string","pattern":"\$\\?s\$.*","maxLength":255},"enableNotification":{"description":" Enables notifications for the branch. ","type":"boolean"},"enableAutoBuild":{"description":" Enables auto building for the branch. ","type":"boolean"},"environmentVariables":{"description":" The environment variables for the branch. ","type":"object","additionalProperties":{"$ref":"#/components/schemas/EnvValue"}},"basicAuthCredentials":{"description":" The basic authorization credentials for the branch. You must base64-encode the authorization credentials and provide them in the format <code>user:password</code>.","type":"string","pattern":"\$\\?s\$.*","maxLength":2000,"format":"password"},"enableBasicAuth":{"description":" Enables basic authorization for the branch. ","type":"boolean"},"enablePerformanceMode":{"description":"Enables performance mode for the branch. 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. ","type":"boolean"},"tags":{"description":" The tag for the branch. ","type":"object","minProperties":0,"maxProperties":50,"additionalProperties":{"$ref":"#/components/schemas/TagValue"}},"buildSpec":{"description":" The build specification (build spec) file for an Amplify app build. ","type":"string","pattern":"\$\\?s\$.\\+","minLength":1,"maxLength":25000,"format":"password"},"ttl":{"description":" The content Time to Live (TTL) for the website in seconds. ","type":"string","pattern":"\\d*","minLength":0,"maxLength":32},"displayName":{"description":" The display name for a branch. This is used as the default domain prefix. ","type":"string","pattern":"\$\\?s\$.*","maxLength":255},"enablePullRequestPreview":{"description":" Enables pull request previews for this branch. ","type":"boolean"},"pullRequestEnvironmentName":{"description":" The Amplify environment name for the pull request. ","type":"string","pattern":"\$\\?s\$.*","maxLength":20},"backendEnvironmentArn":{"description":" The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app. ","type":"string","pattern":"\$\\?s\$.*","minLength":0,"maxLength":1000}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"ListBranches","description":" Lists the branches of an Amplify app. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBranchesResult"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"482":{"description":"InternalFailureException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalFailureException"}}}}},"parameters":[{"name":"appId","in":"path","required":true,"description":" The unique ID for an Amplify app. ","schema":{"type":"string","pattern":"d[a-z0-9]+","minLength":1,"maxLength":20}},{"name":"nextToken","in":"query","required":false,"description":" 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. ","schema":{"type":"string","pattern":"\$\\?s\$.*","maxLength":2000}},{"name":"maxResults","in":"query","required":false,"description":" The maximum number of records to list in a single response. ","schema":{"type":"integer","minimum":0,"maximum":100}}]}},"/apps/{appId}/branches/{branchName}/deployments":{"post":{"operationId":"CreateDeployment","description":" Creates a deployment for a manually deployed Amplify app. Manually deployed apps are not connected to a repository. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDeploymentResult"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"482":{"description":"InternalFailureException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalFailureException"}}}},"483":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}}},"parameters":[{"name":"appId","in":"path","required":true,"description":" The unique ID for an Amplify app. ","schema":{"type":"string","pattern":"d[a-z0-9]+","minLength":1,"maxLength":20}},{"name":"branchName","in":"path","required":true,"description":" The name for the branch, for the job. ","schema":{"type":"string","pattern":"\$\\?s\$.\\+","minLength":1,"maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"fileMap":{"description":" 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. ","type":"object","additionalProperties":{"$ref":"#/components/schemas/MD5Hash"}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/apps/{appId}/domains":{"post":{"operationId":"CreateDomainAssociation","description":" Creates a new domain association for an Amplify app. This action associates a custom domain with the Amplify app ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDomainAssociationResult"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"482":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"483":{"description":"InternalFailureException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalFailureException"}}}},"484":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"485":{"description":"DependentServiceFailureException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DependentServiceFailureException"}}}}},"parameters":[{"name":"appId","in":"path","required":true,"description":" The unique ID for an Amplify app. ","schema":{"type":"string","pattern":"d[a-z0-9]+","minLength":1,"maxLength":20}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domainName","subDomainSettings"],"properties":{"domainName":{"description":" The domain name for the domain association. ","type":"string","pattern":"^(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\\.)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])(\\.)?$","maxLength":64},"enableAutoSubDomain":{"description":" Enables the automated creation of subdomains for branches. ","type":"boolean"},"subDomainSettings":{"description":" The setting for the subdomain. ","type":"array","items":{"$ref":"#/components/schemas/SubDomainSetting"},"maxItems":500},"autoSubDomainCreationPatterns":{"description":" Sets the branch patterns for automatic subdomain creation. ","type":"array","items":{"$ref":"#/components/schemas/AutoSubDomainCreationPattern"}},"autoSubDomainIAMRole":{"description":" The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains. ","type":"string","pattern":"^$|^arn:aws:iam::\\d{12}:role.+","maxLength":1000}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"ListDomainAssociations","description":" Returns the domain associations for an Amplify app. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDomainAssociationsResult"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"482":{"description":"InternalFailureException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalFailureException"}}}}},"parameters":[{"name":"appId","in":"path","required":true,"description":" The unique ID for an Amplify app. ","schema":{"type":"string","pattern":"d[a-z0-9]+","minLength":1,"maxLength":20}},{"name":"nextToken","in":"query","required":false,"description":" 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. ","schema":{"type":"string","pattern":"\$\\?s\$.*","maxLength":2000}},{"name":"maxResults","in":"query","required":false,"description":" The maximum number of records to list in a single response. ","schema":{"type":"integer","minimum":0,"maximum":100}}]}},"/apps/{appId}/webhooks":{"post":{"operationId":"CreateWebhook","description":" Creates a new webhook on an Amplify app. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWebhookResult"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"482":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"483":{"description":"InternalFailureException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalFailureException"}}}},"484":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"485":{"description":"DependentServiceFailureException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DependentServiceFailureException"}}}}},"parameters":[{"name":"appId","in":"path","required":true,"description":" The unique ID for an Amplify app. ","schema":{"type":"string","pattern":"d[a-z0-9]+","minLength":1,"maxLength":20}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["branchName"],"properties":{"branchName":{"description":" The name for a branch that is part of an Amplify app. ","type":"string","pattern":"\$\\?s\$.\\+","minLength":1,"maxLength":255},"description":{"description":" The description for a webhook. ","type":"string","pattern":"\$\\?s\$.*","maxLength":1000}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"ListWebhooks","description":" Returns a list of webhooks for an Amplify app. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListWebhooksResult"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"482":{"description":"InternalFailureException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalFailureException"}}}},"483":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}}},"parameters":[{"name":"appId","in":"path","required":true,"description":" The unique ID for an Amplify app. ","schema":{"type":"string","pattern":"d[a-z0-9]+","minLength":1,"maxLength":20}},{"name":"nextToken","in":"query","required":false,"description":" 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. ","schema":{"type":"string","pattern":"\$\\?s\$.*","maxLength":2000}},{"name":"maxResults","in":"query","required":false,"description":" The maximum number of records to list in a single response. ","schema":{"type":"integer","minimum":0,"maximum":100}}]}},"/apps/{appId}":{"delete":{"operationId":"DeleteApp","description":" Deletes an existing Amplify app specified by an app ID. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteAppResult"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"482":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"483":{"description":"InternalFailureException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalFailureException"}}}},"484":{"description":"DependentServiceFailureException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DependentServiceFailureException"}}}}},"parameters":[{"name":"appId","in":"path","required":true,"description":" The unique ID for an Amplify app. ","schema":{"type":"string","pattern":"d[a-z0-9]+","minLength":1,"maxLength":20}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetApp","description":" Returns an existing Amplify app by appID. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAppResult"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"482":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"483":{"description":"InternalFailureException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalFailureException"}}}}},"parameters":[{"name":"appId","in":"path","required":true,"description":" The unique ID for an Amplify app. ","schema":{"type":"string","pattern":"d[a-z0-9]+","minLength":1,"maxLength":20}}]},"post":{"operationId":"UpdateApp","description":" Updates an existing Amplify app. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAppResult"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"482":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"483":{"description":"InternalFailureException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalFailureException"}}}}},"parameters":[{"name":"appId","in":"path","required":true,"description":" The unique ID for an Amplify app. ","schema":{"type":"string","pattern":"d[a-z0-9]+","minLength":1,"maxLength":20}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"description":" The name for an Amplify app. ","type":"string","pattern":"\$\\?s\$.\\+","minLength":1,"maxLength":255},"description":{"description":" The description for an Amplify app. ","type":"string","pattern":"\$\\?s\$.*","maxLength":1000},"platform":{"description":" The platform for the Amplify app. For a static app, set the platform type to <code>WEB</code>. For a dynamic server-side rendered (SSR) app, set the platform type to <code>WEB_COMPUTE</code>. For an app requiring Amplify Hosting's original SSR support only, set the platform type to <code>WEB_DYNAMIC</code>.","type":"string","enum":["WEB","WEB_DYNAMIC","WEB_COMPUTE"]},"iamServiceRoleArn":{"description":" The AWS Identity and Access Management (IAM) service role for an Amplify app. ","type":"string","pattern":"\$\\?s\$.*","minLength":0,"maxLength":1000},"environmentVariables":{"description":" The environment variables for an Amplify app. ","type":"object","additionalProperties":{"$ref":"#/components/schemas/EnvValue"}},"enableBranchAutoBuild":{"description":" Enables branch auto-building for an Amplify app. ","type":"boolean"},"enableBranchAutoDeletion":{"description":" Automatically disconnects a branch in the Amplify Console when you delete a branch from your Git repository. ","type":"boolean"},"enableBasicAuth":{"description":" Enables basic authorization for an Amplify app. ","type":"boolean"},"basicAuthCredentials":{"description":" The basic authorization credentials for an Amplify app. You must base64-encode the authorization credentials and provide them in the format <code>user:password</code>.","type":"string","pattern":"\$\\?s\$.*","maxLength":2000,"format":"password"},"customRules":{"description":" The custom redirect and rewrite rules for an Amplify app. ","type":"array","items":{"$ref":"#/components/schemas/CustomRule"}},"buildSpec":{"description":" The build specification (build spec) file for an Amplify app build. ","type":"string","pattern":"\$\\?s\$.\\+","minLength":1,"maxLength":25000,"format":"password"},"customHeaders":{"description":"The custom HTTP headers for an Amplify app.","type":"string","pattern":"\$\\?s\$.*","minLength":0,"maxLength":25000},"enableAutoBranchCreation":{"description":" Enables automated branch creation for an Amplify app. ","type":"boolean"},"autoBranchCreationPatterns":{"description":" Describes the automated branch creation glob patterns for an Amplify app. ","type":"array","items":{"$ref":"#/components/schemas/AutoBranchCreationPattern"}},"autoBranchCreationConfig":{"description":" Describes the automated branch creation configuration. ","type":"object","properties":{"stage":{"allOf":[{"$ref":"#/components/schemas/Stage"},{"description":" Describes the current stage for the autocreated branch. "}]},"framework":{"allOf":[{"$ref":"#/components/schemas/Framework"},{"description":" The framework for the autocreated branch. "}]},"enableAutoBuild":{"allOf":[{"$ref":"#/components/schemas/EnableAutoBuild"},{"description":" Enables auto building for the autocreated branch. "}]},"environmentVariables":{"allOf":[{"$ref":"#/components/schemas/EnvironmentVariables"},{"description":" The environment variables for the autocreated branch. "}]},"basicAuthCredentials":{"allOf":[{"$ref":"#/components/schemas/BasicAuthCredentials"},{"description":" The basic authorization credentials for the autocreated branch. You must base64-encode the authorization credentials and provide them in the format <code>user:password</code>."}]},"enableBasicAuth":{"allOf":[{"$ref":"#/components/schemas/EnableBasicAuth"},{"description":" Enables basic authorization for the autocreated branch. "}]},"enablePerformanceMode":{"allOf":[{"$ref":"#/components/schemas/EnablePerformanceMode"},{"description":"Enables performance mode for the branch. 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. "}]},"buildSpec":{"allOf":[{"$ref":"#/components/schemas/BuildSpec"},{"description":" The build specification (build spec) for the autocreated branch. "}]},"enablePullRequestPreview":{"allOf":[{"$ref":"#/components/schemas/EnablePullRequestPreview"},{"description":" Enables pull request previews for the autocreated branch. "}]},"pullRequestEnvironmentName":{"allOf":[{"$ref":"#/components/schemas/PullRequestEnvironmentName"},{"description":" The Amplify environment name for the pull request. "}]}}},"repository":{"description":" The name of the repository for an Amplify app ","type":"string","pattern":"\$\\?s\$.*","maxLength":1000},"oauthToken":{"description":"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 using SSH cloning. The OAuth token is not stored. Use <code>oauthToken</code> for repository providers other than GitHub, such as Bitbucket or CodeCommit. To authorize access to GitHub as your repository provider, use <code>accessToken</code>. You must specify either <code>oauthToken</code> or <code>accessToken</code> when you update an app. Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see <a href=\"https://docs.aws.amazon.com/amplify/latest/UserGuide/setting-up-GitHub-access.html#migrating-to-github-app-auth\">Migrating an existing OAuth app to the Amplify GitHub App</a> in the Amplify User Guide .","type":"string","pattern":"\$\\?s\$.*","maxLength":1000,"format":"password"},"accessToken":{"description":"The personal access token for a GitHub repository for an Amplify app. The personal access token is used to authorize access to a GitHub repository using the Amplify GitHub App. The token is not stored. Use <code>accessToken</code> for GitHub repositories only. To authorize access to a repository provider such as Bitbucket or CodeCommit, use <code>oauthToken</code>. You must specify either <code>accessToken</code> or <code>oauthToken</code> when you update an app. Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see <a href=\"https://docs.aws.amazon.com/amplify/latest/UserGuide/setting-up-GitHub-access.html#migrating-to-github-app-auth\">Migrating an existing OAuth app to the Amplify GitHub App</a> in the Amplify User Guide .","type":"string","pattern":"\$\\?s\$.\\+","minLength":1,"maxLength":255,"format":"password"}}}}}}}},"/apps/{appId}/backendenvironments/{environmentName}":{"delete":{"operationId":"DeleteBackendEnvironment","description":" Deletes a backend environment for an Amplify app. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteBackendEnvironmentResult"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"482":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"483":{"description":"InternalFailureException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalFailureException"}}}},"484":{"description":"DependentServiceFailureException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DependentServiceFailureException"}}}}},"parameters":[{"name":"appId","in":"path","required":true,"description":" The unique ID of an Amplify app. ","schema":{"type":"string","pattern":"d[a-z0-9]+","minLength":1,"maxLength":20}},{"name":"environmentName","in":"path","required":true,"description":" The name of a backend environment of an Amplify app. ","schema":{"type":"string","pattern":"\$\\?s\$.\\+","minLength":1,"maxLength":255}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetBackendEnvironment","description":" Returns a backend environment for an Amplify app. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBackendEnvironmentResult"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"482":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"483":{"description":"InternalFailureException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalFailureException"}}}}},"parameters":[{"name":"appId","in":"path","required":true,"description":" The unique id for an Amplify app. ","schema":{"type":"string","pattern":"d[a-z0-9]+","minLength":1,"maxLength":20}},{"name":"environmentName","in":"path","required":true,"description":" The name for the backend environment. ","schema":{"type":"string","pattern":"\$\\?s\$.\\+","minLength":1,"maxLength":255}}]}},"/apps/{appId}/branches/{branchName}":{"delete":{"operationId":"DeleteBranch","description":" Deletes a branch for an Amplify app. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteBranchResult"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"482":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"483":{"description":"InternalFailureException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalFailureException"}}}},"484":{"description":"DependentServiceFailureException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DependentServiceFailureException"}}}}},"parameters":[{"name":"appId","in":"path","required":true,"description":" The unique ID for an Amplify app. ","schema":{"type":"string","pattern":"d[a-z0-9]+","minLength":1,"maxLength":20}},{"name":"branchName","in":"path","required":true,"description":" The name for the branch. ","schema":{"type":"string","pattern":"\$\\?s\$.\\+","minLength":1,"maxLength":255}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetBranch","description":" Returns a branch for an Amplify app. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBranchResult"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"482":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"483":{"description":"InternalFailureException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalFailureException"}}}}},"parameters":[{"name":"appId","in":"path","required":true,"description":" The unique ID for an Amplify app. ","schema":{"type":"string","pattern":"d[a-z0-9]+","minLength":1,"maxLength":20}},{"name":"branchName","in":"path","required":true,"description":" The name for the branch. ","schema":{"type":"string","pattern":"\$\\?s\$.\\+","minLength":1,"maxLength":255}}]},"post":{"operationId":"UpdateBranch","description":" Updates a branch for an Amplify app. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBranchResult"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"482":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"483":{"description":"InternalFailureException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalFailureException"}}}},"484":{"description":"DependentServiceFailureException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DependentServiceFailureException"}}}}},"