Amazon API Gateway
API Reference

HTTP APIs are in beta for Amazon API Gateway and are subject to change.

DomainName

Represents a domain name. See Set up Custom Domain Name for an API in API Gateway.

URI

/v2/domainnames/domainName

HTTP Methods

GET

Operation ID: GetDomainName

Gets a domain name.

Path Parameters

Name Type Required Description
domainName String True

The domain name.

Responses

Status Code Response Model Description
200 DomainName

Success

404 NotFoundException

The resource specified in the request was not found.

429 LimitExceededException

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

DELETE

Operation ID: DeleteDomainName

Deletes a domain name.

Path Parameters

Name Type Required Description
domainName String True

The domain name.

Responses

Status Code Response Model Description
204 None

The request has succeeded, and there is no additional content to send in the response payload body.

404 NotFoundException

The resource specified in the request was not found.

429 LimitExceededException

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

PATCH

Operation ID: UpdateDomainName

Updates a domain name.

Path Parameters

Name Type Required Description
domainName String True

The domain name.

Responses

Status Code Response Model Description
200 DomainName

Success

400 BadRequestException

One of the parameters in the request is invalid.

404 NotFoundException

The resource specified in the request was not found.

409 ConflictException

The resource already exists.

429 LimitExceededException

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

Schemas

Request Bodies

Example PATCH

{ "domainNameConfigurations": [ { "endpointType": enum, "certificateName": "string", "certificateArn": "string", "apiGatewayDomainName": "string", "hostedZoneId": "string", "certificateUploadDate": "string", "securityPolicy": enum, "domainNameStatus": enum, "domainNameStatusMessage": "string" } ] }

Response Bodies

Example DomainName

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

Example BadRequestException

{ "message": "string" }

Example NotFoundException

{ "message": "string", "resourceType": "string" }

Example ConflictException

{ "message": "string" }

Example LimitExceededException

{ "message": "string", "limitType": "string" }

Properties

BadRequestException

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

Property Type Required Description
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.

Property Type Required Description
message

string

False

Describes the error encountered.

DomainName

Represents a domain name.

Property Type Required Description
domainName

string

True

The name of the DomainName resource.

domainNameConfigurations

Array of type DomainNameConfiguration

False

The domain name configurations.

apiMappingSelectionExpression

string

False

The API mapping selection expression.

tags

Tags

False

The collection of tags associated with a domain name.

DomainNameConfiguration

The domain name configuration.

Property Type Required Description
endpointType

EndpointType

False

The endpoint type.

certificateName

string

False

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

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.

apiGatewayDomainName

string

False

A domain name for the API.

hostedZoneId

string

False

The Amazon Route 53 Hosted Zone ID of the endpoint.

certificateUploadDate

string

Format: date-time

False

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

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

DomainNameStatus

False

The status of the domain name migration. The valid values are AVAILABLE and UPDATING. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.

domainNameStatusMessage

string

False

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

DomainNameStatus

The status of the domain name migration. The valid values are AVAILABLE and UPDATING. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.

  • AVAILABLE

  • UPDATING

EndpointType

Represents an endpoint type.

  • REGIONAL

  • EDGE

LimitExceededException

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

Property Type Required Description
message

string

False

Describes the error encountered.

limitType

string

False

The limit type.

NotFoundException

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

Property Type Required Description
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.

Property Type Required Description

*

string

False

UpdateDomainNameInput

Represents the input parameters for an UpdateDomainName request.

Property Type Required Description
domainNameConfigurations

Array of type DomainNameConfiguration

False

The domain name configurations.

See Also

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

GetDomainName

DeleteDomainName

UpdateDomainName