Amazon AppSync

Amazon AppSync Domain Names API

Manage custom domain names for AppSync APIs

Documentation GitHub OpenAPI

Operations 8

POST /v1/domainnames Create Domain Name #

GET /v1/domainnames List Domain Names #

DELETE /v1/domainnames/{domainName} Delete Domain Name #

GET /v1/domainnames/{domainName} Get Domain Name #

POST /v1/domainnames/{domainName} Update Domain Name #

POST /v1/domainnames/{domainName}/apiassociation Associate Api #

DELETE /v1/domainnames/{domainName}/apiassociation Disassociate Api #

GET /v1/domainnames/{domainName}/apiassociation Get Api Association #

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-appsync:amazon-appsync-domain-names-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

openapi: 3.1.0
info:
  title: AWS AppSync Domain Names API
  version: '2017-07-25'
  description: Generated from AWS's published Smithy model for AWS AppSync. 8 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://appsync.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /v1/domainnames:
    post:
      operationId: CreateDomainName
      summary: Create Domain Name
      description: Creates a custom DomainName object.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateDomainNameResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDomainNameRequest'
      tags:
      - Domain Names
    get:
      operationId: ListDomainNames
      summary: List Domain Names
      description: Lists multiple custom domain names.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDomainNamesResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListDomainNamesRequest'
      tags:
      - Domain Names
  /v1/domainnames/{domainName}:
    delete:
      operationId: DeleteDomainName
      summary: Delete Domain Name
      description: Deletes a custom DomainName object.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteDomainNameResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '409':
          description: ConcurrentModificationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConcurrentModificationException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteDomainNameRequest'
      tags:
      - Domain Names
    get:
      operationId: GetDomainName
      summary: Get Domain Name
      description: Retrieves a custom DomainName object.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDomainNameResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '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'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetDomainNameRequest'
      tags:
      - Domain Names
    post:
      operationId: UpdateDomainName
      summary: Update Domain Name
      description: Updates a custom DomainName object.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateDomainNameResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '409':
          description: ConcurrentModificationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConcurrentModificationException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDomainNameRequest'
      tags:
      - Domain Names
  /v1/domainnames/{domainName}/apiassociation:
    post:
      operationId: AssociateApi
      summary: Associate Api
      description: Maps an endpoint to your custom domain.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssociateApiResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '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'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AssociateApiRequest'
      tags:
      - Domain Names
    delete:
      operationId: DisassociateApi
      summary: Disassociate Api
      description: Removes an ApiAssociation object from a custom domain.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DisassociateApiResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '409':
          description: ConcurrentModificationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConcurrentModificationException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DisassociateApiRequest'
      tags:
      - Domain Names
    get:
      operationId: GetApiAssociation
      summary: Get Api Association
      description: Retrieves an ApiAssociation object.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiAssociationResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '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'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetApiAssociationRequest'
      tags:
      - Domain Names
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: appsync
  schemas:
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
    ApiAssociation:
      type: object
      properties:
        domainName:
          type: string
          description: The domain name.
        apiId:
          type: string
          description: The API ID.
        associationStatus:
          type: string
          enum:
          - PROCESSING
          - FAILED
          - SUCCESS
          description: 'Identifies the status of an association. PROCESSING: The API association is being created. You cannot
            modify association requests during processing. SUCCESS: The API association was successful. You can modify associations
            after success. FAILED: The API association has failed. You can modify associations after failure.'
        deploymentDetail:
          type: string
          description: Details about the last deployment status.
    AssociateApiRequest:
      type: object
      properties:
        domainName:
          type: string
          description: The domain name.
        apiId:
          type: string
          description: The API ID. Private APIs can not be associated with custom domains.
      required:
      - domainName
      - apiId
    AssociateApiResponse:
      type: object
      properties:
        apiAssociation:
          $ref: '#/components/schemas/ApiAssociation'
    BadRequestDetail:
      type: object
      properties:
        codeErrors:
          type: array
          items:
            $ref: '#/components/schemas/CodeError'
          description: Contains the list of errors in the request.
    BadRequestException:
      type: object
      properties:
        message:
          type: string
        reason:
          type: string
          enum:
          - CODE_ERROR
        detail:
          $ref: '#/components/schemas/BadRequestDetail'
    CodeError:
      type: object
      properties:
        errorType:
          type: string
          description: 'The type of code error. Examples include, but aren''t limited to: LINT_ERROR, PARSER_ERROR.'
        value:
          type: string
          description: 'A user presentable error. Examples include, but aren''t limited to: Parsing error: Unterminated string
            literal.'
        location:
          $ref: '#/components/schemas/CodeErrorLocation'
    CodeErrorLocation:
      type: object
      properties:
        line:
          type: integer
          description: The line number in the code. Defaults to 0 if unknown.
        column:
          type: integer
          description: The column number in the code. Defaults to 0 if unknown.
        span:
          type: integer
          description: The span/length of the error. Defaults to -1 if unknown.
    ConcurrentModificationException:
      type: object
      properties:
        message:
          type: string
    CreateDomainNameRequest:
      type: object
      properties:
        domainName:
          type: string
          description: The domain name.
        certificateArn:
          type: string
          description: The Amazon Resource Name (ARN) of the certificate. This can be an Certificate Manager (ACM) certificate
            or an Identity and Access Management (IAM) server certificate.
        description:
          type: string
          description: A description of the DomainName.
        tags:
          type: object
          additionalProperties:
            type: string
      required:
      - domainName
      - certificateArn
    CreateDomainNameResponse:
      type: object
      properties:
        domainNameConfig:
          $ref: '#/components/schemas/DomainNameConfig'
    DeleteDomainNameRequest:
      type: object
      properties:
        domainName:
          type: string
          description: The domain name.
      required:
      - domainName
    DeleteDomainNameResponse:
      type: object
      properties: {}
    DisassociateApiRequest:
      type: object
      properties:
        domainName:
          type: string
          description: The domain name.
      required:
      - domainName
    DisassociateApiResponse:
      type: object
      properties: {}
    DomainNameConfig:
      type: object
      properties:
        domainName:
          type: string
          description: The domain name.
        description:
          type: string
          description: A description of the DomainName configuration.
        certificateArn:
          type: string
          description: The Amazon Resource Name (ARN) of the certificate. This can be an Certificate Manager (ACM) certificate
            or an Identity and Access Management (IAM) server certificate.
        appsyncDomainName:
          type: string
          description: The domain name that AppSync provides.
        hostedZoneId:
          type: string
          description: The ID of your Amazon Route 53 hosted zone.
        tags:
          type: object
          additionalProperties:
            type: string
        domainNameArn:
          type: string
          description: The Amazon Resource Name (ARN) of the domain name.
    GetApiAssociationRequest:
      type: object
      properties:
        domainName:
          type: string
          description: The domain name.
      required:
      - domainName
    GetApiAssociationResponse:
      type: object
      properties:
        apiAssociation:
          $ref: '#/components/schemas/ApiAssociation'
    GetDomainNameRequest:
      type: object
      properties:
        domainName:
          type: string
          description: The domain name.
      required:
      - domainName
    GetDomainNameResponse:
      type: object
      properties:
        domainNameConfig:
          $ref: '#/components/schemas/DomainNameConfig'
    InternalFailureException:
      type: object
      properties:
        message:
          type: string
    ListDomainNamesRequest:
      type: object
      properties:
        nextToken:
          type: string
          description: An identifier that was returned from the previous call to this operation, which you can use to return
            the next set of items in the list.
        maxResults:
          type: integer
          description: The maximum number of results that you want the request to return.
    ListDomainNamesResponse:
      type: object
      properties:
        domainNameConfigs:
          type: array
          items:
            $ref: '#/components/schemas/DomainNameConfig'
          description: Lists configurations for multiple domain names.
        nextToken:
          type: string
          description: An identifier that was returned from the previous call to this operation, which you can use to return
            the next set of items in the list.
    NotFoundException:
      type: object
      properties:
        message:
          type: string
    UpdateDomainNameRequest:
      type: object
      properties:
        domainName:
          type: string
          description: The domain name.
        description:
          type: string
          description: A description of the DomainName.
      required:
      - domainName
    UpdateDomainNameResponse:
      type: object
      properties:
        domainNameConfig:
          $ref: '#/components/schemas/DomainNameConfig'
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/appsync/service/2017-07-25/appsync-2017-07-25.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)

Amazon AppSync Domain Names API

Operations 8

Specifications

Examples

Schemas & Data

Other Resources