Amazon Amplify

Amazon Amplify Amplify Domains API

The Amplify Domains API from Amazon Amplify — 2 operation(s) for amplify domains.

GitHub OpenAPI

Operations 5

POST /apps/{appId}/domains Create Domain Association #
GET /apps/{appId}/domains List Domain Associations #
DELETE /apps/{appId}/domains/{domainName} Delete Domain Association #
GET /apps/{appId}/domains/{domainName} Get Domain Association #
POST /apps/{appId}/domains/{domainName} Update Domain Association #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/amazon-amplify/openapi/amazon-amplify-domains-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/amazon-amplify:amazon-amplify-domains-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amazon-amplify-domains-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: AWS Amplify Domains API
  version: '2017-07-25'
  description: Generated from AWS's published Smithy model for AWS Amplify. 5 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://amplify.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /apps/{appId}/domains:
    post:
      operationId: CreateDomainAssociation
      summary: Create Domain Association
      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'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '503':
          description: DependentServiceFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DependentServiceFailureException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '429':
          description: LimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDomainAssociationRequest'
      tags:
      - Domains
    get:
      operationId: ListDomainAssociations
      summary: List Domain Associations
      description: Returns the domain associations for an Amplify app.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDomainAssociationsResult'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListDomainAssociationsRequest'
      tags:
      - Domains
  /apps/{appId}/domains/{domainName}:
    delete:
      operationId: DeleteDomainAssociation
      summary: Delete Domain Association
      description: Deletes a domain association for an Amplify app.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteDomainAssociationResult'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '503':
          description: DependentServiceFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DependentServiceFailureException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteDomainAssociationRequest'
      tags:
      - Domains
    get:
      operationId: GetDomainAssociation
      summary: Get Domain Association
      description: Returns the domain information for an Amplify app.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDomainAssociationResult'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetDomainAssociationRequest'
      tags:
      - Domains
    post:
      operationId: UpdateDomainAssociation
      summary: Update Domain Association
      description: Creates a new domain association for an Amplify app.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateDomainAssociationResult'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '503':
          description: DependentServiceFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DependentServiceFailureException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDomainAssociationRequest'
      tags:
      - Domains
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: amplify
  schemas:
    BadRequestException:
      type: object
      properties:
        message:
          type: string
    Certificate:
      type: object
      properties:
        type:
          type: string
          enum:
          - AMPLIFY_MANAGED
          - CUSTOM
          description: The type of SSL/TLS certificate that you want to use. Specify AMPLIFY_MANAGED to use the default certificate
            that Amplify provisions for you. Specify CUSTOM to use your own certificate that you have already added to Certificate
            Manager in your Amazon Web Services account. Make sure you request (or import) the certificate in the US East
            (N. Virginia) Region (us-east-1). For more information about using ACM, see Importing certificates into Certificate
            Manager in the ACM User guide.
        customCertificateArn:
          type: string
          description: The Amazon resource name (ARN) for a custom certificate that you have already added to Certificate
            Manager in your Amazon Web Services account. This field is required only when the certificate type is CUSTOM.
        certificateVerificationDNSRecord:
          type: string
          description: The DNS record for certificate verification.
      required:
      - type
    CertificateSettings:
      type: object
      properties:
        type:
          type: string
          enum:
          - AMPLIFY_MANAGED
          - CUSTOM
          description: The certificate type. Specify AMPLIFY_MANAGED to use the default certificate that Amplify provisions
            for you. Specify CUSTOM to use your own certificate that you have already added to Certificate Manager in your
            Amazon Web Services account. Make sure you request (or import) the certificate in the US East (N. Virginia) Region
            (us-east-1). For more information about using ACM, see Importing certificates into Certificate Manager in the
            ACM User guide.
        customCertificateArn:
          type: string
          description: The Amazon resource name (ARN) for the custom certificate that you have already added to Certificate
            Manager in your Amazon Web Services account. This field is required only when the certificate type is CUSTOM.
      required:
      - type
    CreateDomainAssociationRequest:
      type: object
      properties:
        appId:
          type: string
          description: The unique ID for an Amplify app.
        domainName:
          type: string
          description: The domain name for the domain association.
        enableAutoSubDomain:
          type: boolean
          description: Enables the automated creation of subdomains for branches.
        subDomainSettings:
          type: array
          items:
            $ref: '#/components/schemas/SubDomainSetting'
          description: The setting for the subdomain.
        autoSubDomainCreationPatterns:
          type: array
          items:
            type: string
          description: Sets the branch patterns for automatic subdomain creation.
        autoSubDomainIAMRole:
          type: string
          description: The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN)
            for automatically creating subdomains.
        certificateSettings:
          $ref: '#/components/schemas/CertificateSettings'
      required:
      - appId
      - domainName
      - subDomainSettings
    CreateDomainAssociationResult:
      type: object
      properties:
        domainAssociation:
          $ref: '#/components/schemas/DomainAssociation'
      required:
      - domainAssociation
    DeleteDomainAssociationRequest:
      type: object
      properties:
        appId:
          type: string
          description: The unique id for an Amplify app.
        domainName:
          type: string
          description: The name of the domain.
      required:
      - appId
      - domainName
    DeleteDomainAssociationResult:
      type: object
      properties:
        domainAssociation:
          $ref: '#/components/schemas/DomainAssociation'
      required:
      - domainAssociation
    DependentServiceFailureException:
      type: object
      properties:
        message:
          type: string
    DomainAssociation:
      type: object
      properties:
        domainAssociationArn:
          type: string
          description: The Amazon Resource Name (ARN) for the domain association.
        domainName:
          type: string
          description: The name of the domain.
        enableAutoSubDomain:
          type: boolean
          description: Enables the automated creation of subdomains for branches.
        autoSubDomainCreationPatterns:
          type: array
          items:
            type: string
          description: Sets branch patterns for automatic subdomain creation.
        autoSubDomainIAMRole:
          type: string
          description: The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN)
            for automatically creating subdomains.
        domainStatus:
          type: string
          enum:
          - PENDING_VERIFICATION
          - IN_PROGRESS
          - AVAILABLE
          - IMPORTING_CUSTOM_CERTIFICATE
          - PENDING_DEPLOYMENT
          - AWAITING_APP_CNAME
          - FAILED
          - CREATING
          - REQUESTING_CERTIFICATE
          - UPDATING
          description: The current status of the domain association.
        updateStatus:
          type: string
          enum:
          - REQUESTING_CERTIFICATE
          - PENDING_VERIFICATION
          - IMPORTING_CUSTOM_CERTIFICATE
          - PENDING_DEPLOYMENT
          - AWAITING_APP_CNAME
          - UPDATE_COMPLETE
          - UPDATE_FAILED
          description: The status of the domain update operation that is currently in progress. The following list describes
            the valid update states. REQUESTING_CERTIFICATE The certificate is in the process of being updated. PENDING_VERIFICATION
            Indicates that an Amplify managed certificate is in the process of being verified. This occurs during the creation
            of a custom domain or when a custom domain is updated to use a managed certificate. IMPORTING_CUSTOM_CERTIFICATE
            Indicates that an Amplify custom certificate is in the process of being imported. This occurs during the creation
            of a custom domain or when a custom
        statusReason:
          type: string
          description: Additional information that describes why the domain association is in the current state.
        certificateVerificationDNSRecord:
          type: string
          description: The DNS record for certificate verification.
        subDomains:
          type: array
          items:
            $ref: '#/components/schemas/SubDomain'
          description: The subdomains for the domain association.
        certificate:
          $ref: '#/components/schemas/Certificate'
      required:
      - domainAssociationArn
      - domainName
      - enableAutoSubDomain
      - domainStatus
      - statusReason
      - subDomains
    GetDomainAssociationRequest:
      type: object
      properties:
        appId:
          type: string
          description: The unique id for an Amplify app.
        domainName:
          type: string
          description: The name of the domain.
      required:
      - appId
      - domainName
    GetDomainAssociationResult:
      type: object
      properties:
        domainAssociation:
          $ref: '#/components/schemas/DomainAssociation'
      required:
      - domainAssociation
    InternalFailureException:
      type: object
      properties:
        message:
          type: string
    LimitExceededException:
      type: object
      properties:
        message:
          type: string
    ListDomainAssociationsRequest:
      type: object
      properties:
        appId:
          type: string
          description: The unique ID for an Amplify app.
        nextToken:
          type: string
          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.
        maxResults:
          type: integer
          description: The maximum number of records to list in a single response.
      required:
      - appId
    ListDomainAssociationsResult:
      type: object
      properties:
        domainAssociations:
          type: array
          items:
            $ref: '#/components/schemas/DomainAssociation'
          description: A list of domain associations.
        nextToken:
          type: string
          description: A pagination token. If non-null, a pagination token is returned in a result. Pass its value in another
            request to retrieve more entries.
      required:
      - domainAssociations
    NotFoundException:
      type: object
      properties:
        message:
          type: string
    SubDomain:
      type: object
      properties:
        subDomainSetting:
          $ref: '#/components/schemas/SubDomainSetting'
        verified:
          type: boolean
          description: The verified status of the subdomain
        dnsRecord:
          type: string
          description: The DNS record for the subdomain.
      required:
      - subDomainSetting
      - verified
      - dnsRecord
    SubDomainSetting:
      type: object
      properties:
        prefix:
          type: string
          description: The prefix setting for the subdomain.
        branchName:
          type: string
          description: The branch name setting for the subdomain.
      required:
      - prefix
      - branchName
    UnauthorizedException:
      type: object
      properties:
        message:
          type: string
    UpdateDomainAssociationRequest:
      type: object
      properties:
        appId:
          type: string
          description: The unique ID for an Amplify app.
        domainName:
          type: string
          description: The name of the domain.
        enableAutoSubDomain:
          type: boolean
          description: Enables the automated creation of subdomains for branches.
        subDomainSettings:
          type: array
          items:
            $ref: '#/components/schemas/SubDomainSetting'
          description: Describes the settings for the subdomain.
        autoSubDomainCreationPatterns:
          type: array
          items:
            type: string
          description: Sets the branch patterns for automatic subdomain creation.
        autoSubDomainIAMRole:
          type: string
          description: The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN)
            for automatically creating subdomains.
        certificateSettings:
          $ref: '#/components/schemas/CertificateSettings'
      required:
      - appId
      - domainName
    UpdateDomainAssociationResult:
      type: object
      properties:
        domainAssociation:
          $ref: '#/components/schemas/DomainAssociation'
      required:
      - domainAssociation
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/amplify/service/2017-07-25/amplify-2017-07-25.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)