Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14120262383.5 KB

Changes information about the DomainName resource.

patch/domainnames/{domain_name}

Path parameters

domain_namestring required

The name of the DomainName resource to be changed.

Request body

Response

Success

domainNamestring

The custom domain name as an API host name, for example, <code>my-api.example.com</code>.

certificateNamestring

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

certificateArnstring

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

certificateUploadDatestring date-time

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

regionalDomainNamestring

The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when you create a regional endpoint.

regionalHostedZoneIdstring

The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.

regionalCertificateNamestring

The name of the certificate that will be used for validating the regional domain name.

regionalCertificateArnstring

The reference to an AWS-managed certificate that will be used for validating the regional domain name. AWS Certificate Manager is the only supported source.

distributionDomainNamestring

The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the Amazon CloudFront documentation.

distributionHostedZoneIdstring

The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is <code>Z2FDTNDATAQYW2</code> for all the regions. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.

domainNameStatus'AVAILABLE' | 'UPDATING' | 'PENDING' | 'PENDING_CERTIFICATE_REIMPORT' | 'PENDING_OWNERSHIP_VERIFICATION'

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

domainNameStatusMessagestring

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

securityPolicy'TLS_1_0' | 'TLS_1_2'

The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are <code>TLS_1_0</code> and <code>TLS_1_2</code>.

tagsobject

The collection of tags. Each tag element is associated with a given resource.

ownershipVerificationCertificateArnstring

The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn.