DomainNames - Amazon API Gateway
URIHTTP methodsSchemasPropertiesSee also

DomainNames

Represents a collection of domain names. See Set up Custom Domain Name for an API in API Gateway.

URI

/v2/domainnames

HTTP methods

GET

Operation ID: GetDomainNames

Gets the domain names for an AWS account.

Query parameters
NameTypeRequiredDescription
nextTokenStringFalse

The next page of elements from this collection. Not valid for the last element of the collection.

maxResultsStringFalse

The maximum number of elements to be returned for this resource.

Responses
Status codeResponse modelDescription
200DomainNames

Success

400BadRequestException

One of the parameters in the request is invalid.

404NotFoundException

The resource specified in the request was not found.

429LimitExceededException

The client is sending more than the allowed number of requests per unit of time.

POST

Operation ID: CreateDomainName

Creates a domain name.

Responses
Status codeResponse modelDescription
201DomainName

The request has succeeded and has resulted in the creation of a resource.

400BadRequestException

One of the parameters in the request is invalid.

403AccessDeniedException

403 response

404NotFoundException

The resource specified in the request was not found.

409ConflictException

The resource already exists.

429LimitExceededException

The client is sending more than the allowed number of requests per unit of time.

Schemas

Request bodies

{
  "domainName": "string",
  "domainNameConfigurations": [
    {
      "apiGatewayDomainName": "string",
      "certificateArn": "string",
      "certificateName": "string",
      "certificateUploadDate": "string",
      "domainNameStatus": enum,
      "domainNameStatusMessage": "string",
      "endpointType": enum,
      "hostedZoneId": "string",
      "ownershipVerificationCertificateArn": "string",
      "securityPolicy": enum
    }
  ],
  "tags": {
  },
  "mutualTlsAuthentication": {
    "truststoreUri": "string",
    "truststoreVersion": "string"
  }
}

Response bodies

{
  "items": [
    {
      "domainName": "string",
      "domainNameConfigurations": [
        {
          "apiGatewayDomainName": "string",
          "certificateArn": "string",
          "certificateName": "string",
          "certificateUploadDate": "string",
          "domainNameStatus": enum,
          "domainNameStatusMessage": "string",
          "endpointType": enum,
          "hostedZoneId": "string",
          "ownershipVerificationCertificateArn": "string",
          "securityPolicy": enum
        }
      ],
      "apiMappingSelectionExpression": "string",
      "tags": {
      },
      "mutualTlsAuthentication": {
        "truststoreUri": "string",
        "truststoreVersion": "string",
        "truststoreWarnings": [
          "string"
        ]
      }
    }
  ],
  "nextToken": "string"
}
{
  "domainName": "string",
  "domainNameConfigurations": [
    {
      "apiGatewayDomainName": "string",
      "certificateArn": "string",
      "certificateName": "string",
      "certificateUploadDate": "string",
      "domainNameStatus": enum,
      "domainNameStatusMessage": "string",
      "endpointType": enum,
      "hostedZoneId": "string",
      "ownershipVerificationCertificateArn": "string",
      "securityPolicy": enum
    }
  ],
  "apiMappingSelectionExpression": "string",
  "tags": {
  },
  "mutualTlsAuthentication": {
    "truststoreUri": "string",
    "truststoreVersion": "string",
    "truststoreWarnings": [
      "string"
    ]
  }
}
{
  "message": "string"
}
{
  "message": "string"
}
{
  "message": "string",
  "resourceType": "string"
}
{
  "message": "string"
}
{
  "message": "string",
  "limitType": "string"
}

Properties

AccessDeniedException

PropertyTypeRequiredDescription
message

string

False

BadRequestException

The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

PropertyTypeRequiredDescription
message

string

False

Describes the error encountered.

ConflictException

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.

PropertyTypeRequiredDescription
message

string

False

Describes the error encountered.

CreateDomainNameInput

Represents the input parameters for a CreateDomainName request.

PropertyTypeRequiredDescription
domainName

string

True

The domain name.

domainNameConfigurations

Array of type DomainNameConfiguration

False

The domain name configurations.

mutualTlsAuthentication

MutualTlsAuthenticationInput

False

The mutual TLS authentication configuration for a custom domain name.

tags

Tags

False

The collection of tags associated with a domain name.

DomainName

Represents a domain name.

PropertyTypeRequiredDescription
apiMappingSelectionExpression

string

False

The API mapping selection expression.

domainName

string

True

The name of the DomainName resource.

domainNameConfigurations

Array of type DomainNameConfiguration

False

The domain name configurations.

mutualTlsAuthentication

MutualTlsAuthentication

False

The mutual TLS authentication configuration for a custom domain name.

tags

Tags

False

The collection of tags associated with a domain name.

DomainNameConfiguration

The domain name configuration.

PropertyTypeRequiredDescription
apiGatewayDomainName

string

False

A domain name for the API.

certificateArn

string

False

An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.

certificateName

string

False

The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.

certificateUploadDate

string

Format: date-time

False

The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.

domainNameStatus

DomainNameStatus

False

Identifies the status of a domain name migration. Statuses can have a value of AVAILABLE, UPDATING, PENDING_CERTIFICATE_REIMPORT, or PENDING_OWNERSHIP VERIFICATION. A domain can be modified if its status is AVAILABLE. If the domain's status is UPDATING, you must wait until the current operation is complete.

domainNameStatusMessage

string

False

An optional text message containing detailed information about status of the domain name migration.

endpointType

EndpointType

False

The endpoint type.

hostedZoneId

string

False

The Amazon Route 53 Hosted Zone ID of the endpoint.

ownershipVerificationCertificateArn

string

False

The Amazon resource name (ARN) for the public certificate issued by AWS Certificate Manager. This ARN is used to validate custom domain ownership. It's required only if you configure mutual TLS and use either an ACM-imported or a private CA certificate ARN as the regionalCertificateArn.

securityPolicy

SecurityPolicy

False

The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are TLS_1_0 and TLS_1_2.

DomainNameStatus

Identifies the status of a domain name migration. Statuses can have a value of AVAILABLE, UPDATING, PENDING_CERTIFICATE_REIMPORT, or PENDING_OWNERSHIP VERIFICATION. A domain can be modified if its status is AVAILABLE. If the domain's status is UPDATING, you must wait until the current operation is complete.

  • AVAILABLE

  • UPDATING

  • PENDING_CERTIFICATE_REIMPORT

  • PENDING_OWNERSHIP_VERIFICATION

DomainNames

Represents a collection of domain names.

PropertyTypeRequiredDescription
items

Array of type DomainName

False

The elements from this collection.

nextToken

string

False

The next page of elements from this collection. Not valid for the last element of the collection.

EndpointType

Represents an endpoint type.

  • REGIONAL

  • EDGE

LimitExceededException

A limit has been exceeded. See the accompanying error message for details.

PropertyTypeRequiredDescription
limitType

string

False

The limit type.

message

string

False

Describes the error encountered.

MutualTlsAuthentication

If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.

PropertyTypeRequiredDescription
truststoreUri

string

False

An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, s3://bucket-name/key-name . The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.

truststoreVersion

string

False

The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.

truststoreWarnings

Array of type string

False

A list of warnings that API Gateway returns while processing your truststore. Invalid certificates produce warnings. Mutual TLS is still enabled, but some clients might not be able to access your API. To resolve warnings, upload a new truststore to S3, and then update you domain name to use the new version.

MutualTlsAuthenticationInput

If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.

PropertyTypeRequiredDescription
truststoreUri

string

False

An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, s3://bucket-name/key-name . The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.

truststoreVersion

string

False

The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.

NotFoundException

The resource specified in the request was not found. See the message field for more information.

PropertyTypeRequiredDescription
message

string

False

Describes the error encountered.

resourceType

string

False

The resource type.

SecurityPolicy

The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are TLS_1_0 and TLS_1_2.

  • TLS_1_0

  • TLS_1_2

Tags

Represents a collection of tags associated with the resource.

PropertyTypeRequiredDescription

*

string

False

See also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

GetDomainNames

CreateDomainName