Gets the specified limit for the current account, for example, the maximum number of health checks that you can create using the account.
For the default limit, see Limits in the Amazon Route 53 Developer Guide. To request a higher limit, open a case.
Name | Data Type | Description |
---|---|---|
Type
|
string |
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
GetAccountLimitRequest
|
object |
A complex type that contains information about the request to create a hosted zone. |
Name | Data Type | Description |
---|---|---|
GetAccountLimitResponse
|
object |
A complex type that contains the requested limit. |
Count
|
UsageCount |
The current number of entities that you have created of the specified type. For example, if you specified |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
Limit
|
AccountLimit |
The current setting for the specified limit. For example, if you specified |
||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
InvalidInput
|
Returns the current status of a change batch request. The status is one of the following values:
PENDING
indicates that the changes in this request have not propagated to all Amazon Route 53 DNS servers. This is the initial status of all change batch requests.
INSYNC
indicates that the changes have propagated to all Route 53 DNS servers.
Name | Data Type | Description |
---|---|---|
Id
|
string |
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
GetChangeRequest
|
object |
The input for a GetChange request. |
Name | Data Type | Description |
---|---|---|
GetChangeResponse
|
object |
A complex type that contains the |
ChangeInfo
|
ChangeInfo |
A complex type that contains information about the specified change batch. |
||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
NoSuchChange
|
Name | Data Type | Description |
---|---|---|
InvalidInput
|
GetCheckerIpRanges
still works, but we recommend that you download ip-ranges.json, which includes IP address ranges for all AWS services. For more information, see IP Address Ranges of Amazon Route 53 Servers in the Amazon Route 53 Developer Guide.
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
GetCheckerIpRangesRequest
|
object |
Name | Data Type | Description |
---|---|---|
GetCheckerIpRangesResponse
|
object |
CheckerIpRanges
|
CheckerIpRanges | ||||||||||||
|
Deletes a reusable delegation set.
You can delete a reusable delegation set only if it isn't associated with any hosted zones.
To verify that the reusable delegation set is not associated with any hosted zones, submit a GetReusableDelegationSet request and specify the ID of the reusable delegation set that you want to delete.
Name | Data Type | Description |
---|---|---|
Id
|
string |
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
DeleteReusableDelegationSetRequest
|
object |
A request to delete a reusable delegation set. |
Name | Data Type | Description |
---|---|---|
DeleteReusableDelegationSetResponse
|
object |
An empty element. |
Name | Data Type | Description |
---|---|---|
NoSuchDelegationSet
|
Name | Data Type | Description |
---|---|---|
DelegationSetInUse
|
Name | Data Type | Description |
---|---|---|
DelegationSetNotReusable
|
Name | Data Type | Description |
---|---|---|
InvalidInput
|
Retrieves information about a specified reusable delegation set, including the four name servers that are assigned to the delegation set.
Name | Data Type | Description |
---|---|---|
Id
|
string |
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
GetReusableDelegationSetRequest
|
object |
A request to get information about a specified reusable delegation set. |
Name | Data Type | Description |
---|---|---|
GetReusableDelegationSetResponse
|
object |
A complex type that contains the response to the |
DelegationSet
|
DelegationSet |
A complex type that contains information about the reusable delegation set. |
||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
NoSuchDelegationSet
|
Name | Data Type | Description |
---|---|---|
DelegationSetNotReusable
|
Name | Data Type | Description |
---|---|---|
InvalidInput
|
Retrieves a list of the reusable delegation sets that are associated with the current AWS account.
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
ListReusableDelegationSetsRequest
|
object |
A request to get a list of the reusable delegation sets that are associated with the current AWS account. |
Name | Data Type | Description |
---|---|---|
ListReusableDelegationSetsResponse
|
object |
A complex type that contains information about the reusable delegation sets that are associated with the current AWS account. |
MaxItems
|
PageMaxItems |
The value that you specified for the |
||||||||||||||||||||
|
||||||||||||||||||||||
NextMarker
|
PageMarker |
If |
||||||||||||||||||||
|
||||||||||||||||||||||
IsTruncated
|
PageTruncated |
A flag that indicates whether there are more reusable delegation sets to be listed. |
||||||||||||||||||||
|
||||||||||||||||||||||
Marker
|
PageMarker |
For the second and subsequent calls to |
||||||||||||||||||||
|
||||||||||||||||||||||
DelegationSets
|
DelegationSets |
A complex type that contains one |
||||||||||||||||||||
|
Name | Data Type | Description |
---|---|---|
InvalidInput
|
Creates a delegation set (a group of four name servers) that can be reused by multiple hosted zones. If a hosted zoned ID is specified, CreateReusableDelegationSet
marks the delegation set associated with that zone as reusable.
You can't associate a reusable delegation set with a private hosted zone.
For information about using a reusable delegation set to configure white label name servers, see Configuring White Label Name Servers.
The process for migrating existing hosted zones to use a reusable delegation set is comparable to the process for configuring white label name servers. You need to perform the following steps:
Create a reusable delegation set.
Recreate hosted zones, and reduce the TTL to 60 seconds or less.
Recreate resource record sets in the new hosted zones.
Change the registrar's name servers to use the name servers for the new hosted zones.
Monitor traffic for the website or application.
Change TTLs back to their original values.
If you want to migrate existing hosted zones to use a reusable delegation set, the existing hosted zones can't use any of the name servers that are assigned to the reusable delegation set. If one or more hosted zones do use one or more name servers that are assigned to the reusable delegation set, you can do one of the following:
For small numbers of hosted zones—up to a few hundred—it's relatively easy to create reusable delegation sets until you get one that has four name servers that don't overlap with any of the name servers in your hosted zones.
For larger numbers of hosted zones, the easiest solution is to use more than one reusable delegation set.
For larger numbers of hosted zones, you can also migrate hosted zones that have overlapping name servers to hosted zones that don't have overlapping name servers, then migrate the hosted zones again to use the reusable delegation set.
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
CreateReusableDelegationSetRequest
|
object |
HostedZoneId
|
ResourceId |
If you want to mark the delegation set for an existing hosted zone as reusable, the ID for that hosted zone. |
||||
|
||||||
CallerReference
|
Nonce |
A unique string that identifies the request, and that allows you to retry failed |
||||
|
Name | Data Type | Description |
---|---|---|
CreateReusableDelegationSetResponse
|
object |
DelegationSet
|
DelegationSet |
A complex type that contains name server information. |
||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
DelegationSetAlreadyCreated
|
Name | Data Type | Description |
---|---|---|
LimitsExceeded
|
Name | Data Type | Description |
---|---|---|
HostedZoneNotFound
|
Name | Data Type | Description |
---|---|---|
InvalidArgument
|
Name | Data Type | Description |
---|---|---|
InvalidInput
|
Name | Data Type | Description |
---|---|---|
DelegationSetNotAvailable
|
Name | Data Type | Description |
---|---|---|
DelegationSetAlreadyReusable
|
Gets information about whether a specified geographic location is supported for Amazon Route 53 geolocation resource record sets.
Use the following syntax to determine whether a continent is supported for geolocation:
GET /2013-04-01/geolocation?continentcode=two-letter abbreviation for a continent
Use the following syntax to determine whether a country is supported for geolocation:
GET /2013-04-01/geolocation?countrycode=two-character country code
Use the following syntax to determine whether a subdivision of a country is supported for geolocation:
GET /2013-04-01/geolocation?countrycode=two-character country code&subdivisioncode=subdivision code
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
GetGeoLocationRequest
|
object |
A request for information about whether a specified geographic location is supported for Amazon Route 53 geolocation resource record sets. |
Name | Data Type | Description |
---|---|---|
GetGeoLocationResponse
|
object |
A complex type that contains the response information for the specified geolocation code. |
GeoLocationDetails
|
GeoLocationDetails |
A complex type that contains the codes and full continent, country, and subdivision names for the specified geolocation code. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
NoSuchGeoLocation
|
Name | Data Type | Description |
---|---|---|
InvalidInput
|
Retrieves a list of supported geographic locations.
Countries are listed first, and continents are listed last. If Amazon Route 53 supports subdivisions for a country (for example, states or provinces), the subdivisions for that country are listed in alphabetical order immediately after the corresponding country.
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
ListGeoLocationsRequest
|
object |
A request to get a list of geographic locations that Amazon Route 53 supports for geolocation resource record sets. |
Name | Data Type | Description |
---|---|---|
ListGeoLocationsResponse
|
object |
A complex type containing the response information for the request. |
MaxItems
|
PageMaxItems |
The value that you specified for |
|||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||
NextSubdivisionCode
|
GeoLocationSubdivisionCode |
If |
|||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||
NextCountryCode
|
GeoLocationCountryCode |
If |
|||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||
NextContinentCode
|
GeoLocationContinentCode |
If |
|||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||
IsTruncated
|
PageTruncated |
A value that indicates whether more locations remain to be listed after the last location in this response. If so, the value of |
|||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||
GeoLocationDetailsList
|
GeoLocationDetailsList |
A complex type that contains one |
|||||||||||||||||||||||||||||
|
Name | Data Type | Description |
---|---|---|
InvalidInput
|
Gets the reason that a specified health check failed most recently.
Name | Data Type | Description |
---|---|---|
HealthCheckId
|
string |
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
GetHealthCheckLastFailureReasonRequest
|
object |
A request for the reason that a health check failed most recently. |
Name | Data Type | Description |
---|---|---|
GetHealthCheckLastFailureReasonResponse
|
object |
A complex type that contains the response to a |
HealthCheckObservations
|
HealthCheckObservations |
A list that contains one |
||||||||||||||||||||
|
Name | Data Type | Description |
---|---|---|
NoSuchHealthCheck
|
Name | Data Type | Description |
---|---|---|
InvalidInput
|
Gets status of a specified health check.
Name | Data Type | Description |
---|---|---|
HealthCheckId
|
string |
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
GetHealthCheckStatusRequest
|
object |
A request to get the status for a health check. |
Name | Data Type | Description |
---|---|---|
GetHealthCheckStatusResponse
|
object |
A complex type that contains the response to a |
HealthCheckObservations
|
HealthCheckObservations |
A list that contains one |
||||||||||||||||||||
|
Name | Data Type | Description |
---|---|---|
NoSuchHealthCheck
|
Name | Data Type | Description |
---|---|---|
InvalidInput
|
Deletes a health check.
Amazon Route 53 does not prevent you from deleting a health check even if the health check is associated with one or more resource record sets. If you delete a health check and you don't update the associated resource record sets, the future status of the health check can't be predicted and may change. This will affect the routing of DNS queries for your DNS failover configuration. For more information, see Replacing and Deleting Health Checks in the Amazon Route 53 Developer Guide.
Name | Data Type | Description |
---|---|---|
HealthCheckId
|
string |
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
DeleteHealthCheckRequest
|
object |
This action deletes a health check. |
Name | Data Type | Description |
---|---|---|
DeleteHealthCheckResponse
|
object |
An empty element. |
Name | Data Type | Description |
---|---|---|
NoSuchHealthCheck
|
Name | Data Type | Description |
---|---|---|
HealthCheckInUse
|
Name | Data Type | Description |
---|---|---|
InvalidInput
|
Gets information about a specified health check.
Name | Data Type | Description |
---|---|---|
HealthCheckId
|
string |
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
GetHealthCheckRequest
|
object |
A request to get information about a specified health check. |
Name | Data Type | Description |
---|---|---|
GetHealthCheckResponse
|
object |
A complex type that contains the response to a |
HealthCheck
|
HealthCheck |
A complex type that contains information about one health check that is associated with the current AWS account. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
NoSuchHealthCheck
|
Name | Data Type | Description |
---|---|---|
InvalidInput
|
Name | Data Type | Description |
---|---|---|
IncompatibleVersion
|
Updates an existing health check. Note that some values can't be updated.
For more information about updating health checks, see Creating, Updating, and Deleting Health Checks in the Amazon Route 53 Developer Guide.
Name | Data Type | Description |
---|---|---|
HealthCheckId
|
string |
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
UpdateHealthCheckRequest
|
object |
A complex type that contains information about a request to update a health check. |
ResetElements
|
ResettableElementNameList |
A complex type that contains one
|
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
InsufficientDataHealthStatus
|
InsufficientDataHealthStatus |
When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign to the health check:
|
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
AlarmIdentifier
|
AlarmIdentifier |
A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether the specified health check is healthy. |
||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||
Regions
|
HealthCheckRegionList |
A complex type that contains one |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
EnableSNI
|
EnableSNI |
Specify whether you want Amazon Route 53 to send the value of Some endpoints require that HTTPS requests include the host name in the The SSL/TLS certificate on your endpoint includes a domain name in the |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
ChildHealthChecks
|
ChildHealthCheckList |
A complex type that contains one |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
HealthThreshold
|
HealthThreshold |
The number of child health checks that are associated with a Note the following:
|
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
Disabled
|
Disabled |
Stops Route 53 from performing health checks. When you disable a health check, here's what happens:
After you disable a health check, Route 53 considers the status of the health check to always be healthy. If you configured DNS failover, Route 53 continues to route traffic to the corresponding resources. If you want to stop routing traffic to a resource, change the value of UpdateHealthCheckRequest$Inverted. Charges for a health check still apply when the health check is disabled. For more information, see Amazon Route 53 Pricing. |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
Inverted
|
Inverted |
Specify whether you want Amazon Route 53 to invert the status of a health check, for example, to consider a health check unhealthy when it otherwise would be considered healthy. |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
FailureThreshold
|
FailureThreshold |
The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide. If you don't specify a value for |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
SearchString
|
SearchString |
If the value of |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
FullyQualifiedDomainName
|
FullyQualifiedDomainName |
Amazon Route 53 behavior depends on whether you specify a value for If a health check already has a value for If you specify a value for Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of When Route 53 checks the health of an endpoint, here is how it constructs the
If you don't specify a value for If you don't specify a value for If you don't specify a value for If you don't specify a value for If you want to check the health of weighted, latency, or failover resource record sets and you choose to specify the endpoint only by In this configuration, if the value of In addition, if the value of |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
ResourcePath
|
ResourcePath |
The path that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example the file /docs/route53-health-check.html. You can also include query string parameters, for example, Specify this value only if you want to change it. |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
Port
|
Port |
The port on the endpoint on which you want Amazon Route 53 to perform health checks. |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
IPAddress
|
IPAddress |
The IPv4 or IPv6 IP address for the endpoint that you want Amazon Route 53 to perform health checks on. If you don't specify a value for Use one of the following formats for the value of
If the endpoint is an EC2 instance, we recommend that you create an Elastic IP address, associate it with your EC2 instance, and specify the Elastic IP address for
If a health check already has a value for For more information, see UpdateHealthCheckRequest$FullyQualifiedDomainName. Constraints: Route 53 can't check the health of endpoints for which the IP address is in local, private, non-routable, or multicast ranges. For more information about IP addresses for which you can't create health checks, see the following documents: |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
HealthCheckVersion
|
HealthCheckVersion |
A sequential counter that Amazon Route 53 sets to We recommend that you use
|
||||||||||||||||||||||||
|
Name | Data Type | Description |
---|---|---|
UpdateHealthCheckResponse
|
object |
HealthCheck
|
HealthCheck |
A complex type that contains the response to an |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
NoSuchHealthCheck
|
Name | Data Type | Description |
---|---|---|
InvalidInput
|
Name | Data Type | Description |
---|---|---|
HealthCheckVersionMismatch
|
Retrieve a list of the health checks that are associated with the current AWS account.
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string | |
Marker
|
string |
Pagination token |
MaxItems
|
string |
Pagination limit |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
ListHealthChecksRequest
|
object |
A request to retrieve a list of the health checks that are associated with the current AWS account. |
Name | Data Type | Description |
---|---|---|
ListHealthChecksResponse
|
object |
A complex type that contains the response to a |
MaxItems
|
PageMaxItems |
The value that you specified for the |
|||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||
NextMarker
|
PageMarker |
If |
|||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||
IsTruncated
|
PageTruncated |
A flag that indicates whether there are more health checks to be listed. If the response was truncated, you can get the next group of health checks by submitting another |
|||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||
Marker
|
PageMarker |
For the second and subsequent calls to |
|||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||
HealthChecks
|
HealthChecks |
A complex type that contains one |
|||||||||||||||||||||||||||||
|
Name | Data Type | Description |
---|---|---|
InvalidInput
|
Name | Data Type | Description |
---|---|---|
IncompatibleVersion
|
Creates a new health check.
For information about adding health checks to resource record sets, see ResourceRecordSet$HealthCheckId in ChangeResourceRecordSets.
ELB Load Balancers
If you're registering EC2 instances with an Elastic Load Balancing (ELB) load balancer, do not create Amazon Route 53 health checks for the EC2 instances. When you register an EC2 instance with a load balancer, you configure settings for an ELB health check, which performs a similar function to a Route 53 health check.
Private Hosted Zones
You can associate health checks with failover resource record sets in a private hosted zone. Note the following:
Route 53 health checkers are outside the VPC. To check the health of an endpoint within a VPC by IP address, you must assign a public IP address to the instance in the VPC.
You can configure a health checker to check the health of an external resource that the instance relies on, such as a database server.
You can create a CloudWatch metric, associate an alarm with the metric, and then create a health check that is based on the state of the alarm. For example, you might create a CloudWatch metric that checks the status of the Amazon EC2 StatusCheckFailed
metric, add an alarm to the metric, and then create a health check that is based on the state of the alarm. For information about creating CloudWatch metrics and alarms by using the CloudWatch console, see the Amazon CloudWatch User Guide.
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
CreateHealthCheckRequest
|
object |
A complex type that contains the health check request information. |
HealthCheckConfig
|
HealthCheckConfig |
A complex type that contains settings for a new health check. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CallerReference
|
HealthCheckNonce |
A unique string that identifies the request and that allows you to retry a failed
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Name | Data Type | Description |
---|---|---|
CreateHealthCheckResponse
|
object |
A complex type containing the response information for the new health check. |
HealthCheck
|
HealthCheck |
A complex type that contains identifying information about the health check. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
TooManyHealthChecks
|
Name | Data Type | Description |
---|---|---|
HealthCheckAlreadyExists
|
Name | Data Type | Description |
---|---|---|
InvalidInput
|
Retrieves the number of health checks that are associated with the current AWS account.
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
GetHealthCheckCountRequest
|
object |
A request for the number of health checks that are associated with the current AWS account. |
Name | Data Type | Description |
---|---|---|
GetHealthCheckCountResponse
|
object |
A complex type that contains the response to a |
HealthCheckCount
|
HealthCheckCount |
The number of health checks associated with the current AWS account. |
||||
|
Associates an Amazon VPC with a private hosted zone.
To perform the association, the VPC and the private hosted zone must already exist. You can't convert a public hosted zone into a private hosted zone.
If you want to associate a VPC that was created by using one AWS account with a private hosted zone that was created by using a different account, the AWS account that created the private hosted zone must first submit a CreateVPCAssociationAuthorization
request. Then the account that created the VPC must submit an AssociateVPCWithHostedZone
request.
Name | Data Type | Description |
---|---|---|
Id
|
string |
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
AssociateVPCWithHostedZoneRequest
|
object |
A complex type that contains information about the request to associate a VPC with a private hosted zone. |
Comment
|
AssociateVPCComment |
Optional: A comment about the association request. |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
VPC
|
VPC |
A complex type that contains information about the VPC that you want to associate with a private hosted zone. |
||||||||||||||||||||||||
Properties
|
{
"Comment": "",
"HostedZoneId": "Z3M3LMPEXAMPLE",
"VPC": {
"VPCId": "vpc-1a2b3c4d",
"VPCRegion": "us-east-2"
}
}
Name | Data Type | Description |
---|---|---|
AssociateVPCWithHostedZoneResponse
|
object |
A complex type that contains the response information for the |
ChangeInfo
|
ChangeInfo |
A complex type that describes the changes made to your hosted zone. |
||||||||||||||||||||||||||||||||||||||||||||
Properties
|
{
"ChangeInfo": {
"Comment": "",
"Id": "\/change\/C3HC6WDB2UANE2",
"Status": "INSYNC",
"SubmittedAt": "2017-01-31T01:36:41.958Z"
}
}
Name | Data Type | Description |
---|---|---|
NoSuchHostedZone
|
Name | Data Type | Description |
---|---|---|
NotAuthorizedException
|
Name | Data Type | Description |
---|---|---|
InvalidVPCId
|
Name | Data Type | Description |
---|---|---|
InvalidInput
|
Name | Data Type | Description |
---|---|---|
PublicZoneVPCAssociation
|
Name | Data Type | Description |
---|---|---|
ConflictingDomainExists
|
Name | Data Type | Description |
---|---|---|
LimitsExceeded
|
Gets a list of the VPCs that were created by other accounts and that can be associated with a specified hosted zone because you've submitted one or more CreateVPCAssociationAuthorization
requests.
The response includes a VPCs
element with a VPC
child element for each VPC that can be associated with the hosted zone.
Name | Data Type | Description |
---|---|---|
Id
|
string |
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
ListVPCAssociationAuthorizationsRequest
|
object |
A complex type that contains information about that can be associated with your hosted zone. |
Name | Data Type | Description |
---|---|---|
ListVPCAssociationAuthorizationsResponse
|
object |
A complex type that contains the response information for the request. |
VPCs
|
VPCs |
The list of VPCs that are authorized to be associated with the specified hosted zone. |
|||||||||||||||||
|
|||||||||||||||||||
NextToken
|
PaginationToken |
When the response includes a |
|||||||||||||||||
|
|||||||||||||||||||
HostedZoneId
|
ResourceId |
The ID of the hosted zone that you can associate the listed VPCs with. |
|||||||||||||||||
|
Name | Data Type | Description |
---|---|---|
NoSuchHostedZone
|
Name | Data Type | Description |
---|---|---|
InvalidInput
|
Name | Data Type | Description |
---|---|---|
InvalidPaginationToken
|
Authorizes the AWS account that created a specified VPC to submit an AssociateVPCWithHostedZone
request to associate the VPC with a specified hosted zone that was created by a different account. To submit a CreateVPCAssociationAuthorization
request, you must use the account that created the hosted zone. After you authorize the association, use the account that created the VPC to submit an AssociateVPCWithHostedZone
request.
If you want to associate multiple VPCs that you created by using one account with a hosted zone that you created by using a different account, you must submit one authorization request for each VPC.
Name | Data Type | Description |
---|---|---|
Id
|
string |
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
CreateVPCAssociationAuthorizationRequest
|
object |
A complex type that contains information about the request to authorize associating a VPC with your private hosted zone. Authorization is only required when a private hosted zone and a VPC were created by using different accounts. |
VPC
|
VPC |
A complex type that contains the VPC ID and region for the VPC that you want to authorize associating with your hosted zone. |
||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
CreateVPCAssociationAuthorizationResponse
|
object |
A complex type that contains the response information from a |
VPC
|
VPC |
The VPC that you authorized associating with a hosted zone. |
||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||
HostedZoneId
|
ResourceId |
The ID of the hosted zone that you authorized associating a VPC with. |
||||||||||||||||||||||||
|
Name | Data Type | Description |
---|---|---|
ConcurrentModification
|
Name | Data Type | Description |
---|---|---|
TooManyVPCAssociationAuthorizations
|
Name | Data Type | Description |
---|---|---|
NoSuchHostedZone
|
Name | Data Type | Description |
---|---|---|
InvalidVPCId
|
Name | Data Type | Description |
---|---|---|
InvalidInput
|
Removes authorization to submit an AssociateVPCWithHostedZone
request to associate a specified VPC with a hosted zone that was created by a different account. You must use the account that created the hosted zone to submit a DeleteVPCAssociationAuthorization
request.
Sending this request only prevents the AWS account that created the VPC from associating the VPC with the Amazon Route 53 hosted zone in the future. If the VPC is already associated with the hosted zone, DeleteVPCAssociationAuthorization
won't disassociate the VPC from the hosted zone. If you want to delete an existing association, use DisassociateVPCFromHostedZone
.
Name | Data Type | Description |
---|---|---|
Id
|
string |
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
DeleteVPCAssociationAuthorizationRequest
|
object |
A complex type that contains information about the request to remove authorization to associate a VPC that was created by one AWS account with a hosted zone that was created with a different AWS account. |
VPC
|
VPC |
When removing authorization to associate a VPC that was created by one AWS account with a hosted zone that was created with a different AWS account, a complex type that includes the ID and region of the VPC. |
||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
DeleteVPCAssociationAuthorizationResponse
|
object |
Empty response for the request. |
Name | Data Type | Description |
---|---|---|
ConcurrentModification
|
Name | Data Type | Description |
---|---|---|
VPCAssociationAuthorizationNotFound
|
Name | Data Type | Description |
---|---|---|
NoSuchHostedZone
|
Name | Data Type | Description |
---|---|---|
InvalidVPCId
|
Name | Data Type | Description |
---|---|---|
InvalidInput
|
Disassociates a VPC from a Amazon Route 53 private hosted zone. Note the following:
You can't disassociate the last VPC from a private hosted zone.
You can't convert a private hosted zone into a public hosted zone.
You can submit a DisassociateVPCFromHostedZone
request using either the account that created the hosted zone or the account that created the VPC.
Name | Data Type | Description |
---|---|---|
Id
|
string |
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
DisassociateVPCFromHostedZoneRequest
|
object |
A complex type that contains information about the VPC that you want to disassociate from a specified private hosted zone. |
Comment
|
DisassociateVPCComment |
Optional: A comment about the disassociation request. |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
VPC
|
VPC |
A complex type that contains information about the VPC that you're disassociating from the specified hosted zone. |
||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
DisassociateVPCFromHostedZoneResponse
|
object |
A complex type that contains the response information for the disassociate request. |
ChangeInfo
|
ChangeInfo |
A complex type that describes the changes made to the specified private hosted zone. |
||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
NoSuchHostedZone
|
Name | Data Type | Description |
---|---|---|
InvalidVPCId
|
Name | Data Type | Description |
---|---|---|
VPCAssociationNotFound
|
Name | Data Type | Description |
---|---|---|
LastVPCAssociation
|
Name | Data Type | Description |
---|---|---|
InvalidInput
|
Creates, changes, or deletes a resource record set, which contains authoritative DNS information for a specified domain name or subdomain name. For example, you can use ChangeResourceRecordSets
to create a resource record set that routes traffic for test.example.com to a web server that has an IP address of 192.0.2.44.
Change Batches and Transactional Changes
The request body must include a document with a ChangeResourceRecordSetsRequest
element. The request body contains a list of change items, known as a change batch. Change batches are considered transactional changes. When using the Amazon Route 53 API to change resource record sets, Route 53 either makes all or none of the changes in a change batch request. This ensures that Route 53 never partially implements the intended changes to the resource record sets in a hosted zone.
For example, a change batch request that deletes the CNAME
record for www.example.com and creates an alias resource record set for www.example.com. Route 53 deletes the first resource record set and creates the second resource record set in a single operation. If either the DELETE
or the CREATE
action fails, then both changes (plus any other changes in the batch) fail, and the original CNAME
record continues to exist.
Due to the nature of transactional changes, you can't delete the same resource record set more than once in a single change batch. If you attempt to delete the same change batch more than once, Route 53 returns an InvalidChangeBatch
error.
Traffic Flow
To create resource record sets for complex routing configurations, use either the traffic flow visual editor in the Route 53 console or the API actions for traffic policies and traffic policy instances. Save the configuration as a traffic policy, then associate the traffic policy with one or more domain names (such as example.com) or subdomain names (such as www.example.com), in the same hosted zone or in multiple hosted zones. You can roll back the updates if the new configuration isn't performing as expected. For more information, see Using Traffic Flow to Route DNS Traffic in the Amazon Route 53 Developer Guide.
Create, Delete, and Upsert
Use ChangeResourceRecordsSetsRequest
to perform the following actions:
CREATE
: Creates a resource record set that has the specified values.
DELETE
: Deletes an existing resource record set that has the specified values.
UPSERT
: If a resource record set does not already exist, AWS creates it. If a resource set does exist, Route 53 updates it with the values in the request.
Syntaxes for Creating, Updating, and Deleting Resource Record Sets
The syntax for a request depends on the type of resource record set that you want to create, delete, or update, such as weighted, alias, or failover. The XML elements in your request must appear in the order listed in the syntax.
For an example for each type of resource record set, see "Examples."
Don't refer to the syntax in the "Parameter Syntax" section, which includes all of the elements for every kind of resource record set that you can create, delete, or update by using ChangeResourceRecordSets
.
Change Propagation to Route 53 DNS Servers
When you submit a ChangeResourceRecordSets
request, Route 53 propagates your changes to all of the Route 53 authoritative DNS servers. While your changes are propagating, GetChange
returns a status of PENDING
. When propagation is complete, GetChange
returns a status of INSYNC
. Changes generally propagate to all Route 53 name servers within 60 seconds. For more information, see GetChange.
Limits on ChangeResourceRecordSets Requests
For information about the limits on a ChangeResourceRecordSets
request, see Limits in the Amazon Route 53 Developer Guide.
Name | Data Type | Description |
---|---|---|
Id
|
string |
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
ChangeResourceRecordSetsRequest
|
object |
A complex type that contains change information for the resource record set. |
ChangeBatch
|
ChangeBatch |
A complex type that contains an optional comment and the |
||||||||||||||||||||||||
Properties
|
{
"ChangeBatch": {
"Changes": [
{
"Action": "CREATE",
"ResourceRecordSet": {
"AliasTarget": {
"DNSName": "example-com-123456789.us-east-2.elb.amazonaws.com ",
"EvaluateTargetHealth": true,
"HostedZoneId": "Z3AADJGX6KTTL2"
},
"GeoLocation": {
"ContinentCode": "NA"
},
"Name": "example.com",
"SetIdentifier": "North America",
"Type": "A"
}
},
{
"Action": "CREATE",
"ResourceRecordSet": {
"AliasTarget": {
"DNSName": "example-com-234567890.sa-east-1.elb.amazonaws.com ",
"EvaluateTargetHealth": true,
"HostedZoneId": "Z2P70J7HTTTPLU"
},
"GeoLocation": {
"ContinentCode": "SA"
},
"Name": "example.com",
"SetIdentifier": "South America",
"Type": "A"
}
},
{
"Action": "CREATE",
"ResourceRecordSet": {
"AliasTarget": {
"DNSName": "example-com-234567890.eu-central-1.elb.amazonaws.com ",
"EvaluateTargetHealth": true,
"HostedZoneId": "Z215JYRZR1TBD5"
},
"GeoLocation": {
"ContinentCode": "EU"
},
"Name": "example.com",
"SetIdentifier": "Europe",
"Type": "A"
}
},
{
"Action": "CREATE",
"ResourceRecordSet": {
"AliasTarget": {
"DNSName": "example-com-234567890.ap-southeast-1.elb.amazonaws.com ",
"EvaluateTargetHealth": true,
"HostedZoneId": "Z1LMS91P8CMLE5"
},
"GeoLocation": {
"CountryCode": "*"
},
"Name": "example.com",
"SetIdentifier": "Other locations",
"Type": "A"
}
}
],
"Comment": "Geolocation alias configuration for example.com"
},
"HostedZoneId": "Z3M3LMPEXAMPLE"
}
Name | Data Type | Description |
---|---|---|
ChangeResourceRecordSetsResponse
|
object |
A complex type containing the response for the request. |
ChangeInfo
|
ChangeInfo |
A complex type that contains information about changes made to your hosted zone. This element contains an ID that you use when performing a GetChange action to get detailed information about the change. |
||||||||||||||||||||||||||||||||||||||||||||
Properties
|
{
"ChangeInfo": {
"Comment": "Geolocation alias configuration for example.com",
"Id": "\/change\/C2682N5HXP0BZ4",
"Status": "PENDING",
"SubmittedAt": "2017-02-10T01:36:41.958Z"
}
}
Name | Data Type | Description |
---|---|---|
NoSuchHostedZone
|
Name | Data Type | Description |
---|---|---|
NoSuchHealthCheck
|
Name | Data Type | Description |
---|---|---|
InvalidChangeBatch
|
Name | Data Type | Description |
---|---|---|
InvalidInput
|
Name | Data Type | Description |
---|---|---|
PriorRequestNotComplete
|
Lists the resource record sets in a specified hosted zone.
ListResourceRecordSets
returns up to 100 resource record sets at a time in ASCII order, beginning at a position specified by the name
and type
elements.
Sort order
ListResourceRecordSets
sorts results first by DNS name with the labels reversed, for example:
com.example.www.
Note the trailing dot, which can change the sort order when the record name contains characters that appear before .
(decimal 46) in the ASCII table. These characters include the following: ! " # $ % & ' ( ) * + , -
When multiple records have the same DNS name, ListResourceRecordSets
sorts results by the record type.
Specifying where to start listing records
You can use the name and type elements to specify the resource record set that the list begins with:
The results begin with the first resource record set that the hosted zone contains.
The results begin with the first resource record set in the list whose name is greater than or equal to Name
.
Amazon Route 53 returns the InvalidInput
error.
The results begin with the first resource record set in the list whose name is greater than or equal to Name
, and whose type is greater than or equal to Type
.
Resource record sets that are PENDING
This action returns the most current version of the records. This includes records that are PENDING
, and that are not yet available on all Route 53 DNS servers.
Changing resource record sets
To ensure that you get an accurate listing of the resource record sets for a hosted zone at a point in time, do not submit a ChangeResourceRecordSets
request while you're paging through the results of a ListResourceRecordSets
request. If you do, some pages may display results without the latest changes while other pages display results with the latest changes.
Displaying the next page of results
If a ListResourceRecordSets
command returns more than one page of results, the value of IsTruncated
is true
. To display the next page of results, get the values of NextRecordName
, NextRecordType
, and NextRecordIdentifier
(if any) from the response. Then submit another ListResourceRecordSets
request, and specify those values for StartRecordName
, StartRecordType
, and StartRecordIdentifier
.
Name | Data Type | Description |
---|---|---|
Id
|
string |
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string | |
StartRecordIdentifier
|
string |
Pagination token |
StartRecordType
|
string |
Pagination token |
StartRecordName
|
string |
Pagination token |
MaxItems
|
string |
Pagination limit |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
ListResourceRecordSetsRequest
|
object |
A request for the resource record sets that are associated with a specified hosted zone. |
Name | Data Type | Description |
---|---|---|
ListResourceRecordSetsResponse
|
object |
A complex type that contains list information for the resource record set. |
MaxItems
|
PageMaxItems |
The maximum number of records you requested. |
||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||
NextRecordIdentifier
|
ResourceRecordSetIdentifier |
Resource record sets that have a routing policy other than simple: If results were truncated for a given DNS name and type, the value of For information about routing policies, see Choosing a Routing Policy in the Amazon Route 53 Developer Guide. |
||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||
NextRecordType
|
RRType |
If the results were truncated, the type of the next record in the list. This element is present only if |
||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||
NextRecordName
|
DNSName |
If the results were truncated, the name of the next record in the list. This element is present only if |
||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||
IsTruncated
|
PageTruncated |
A flag that indicates whether more resource record sets remain to be listed. If your results were truncated, you can make a follow-up pagination request by using the |
||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||
ResourceRecordSets
|
ResourceRecordSets |
Information about multiple resource record sets. |
||||||||||||||||||||||||||||||||||||||||||||||||||
|
Name | Data Type | Description |
---|---|---|
NoSuchHostedZone
|
Name | Data Type | Description |
---|---|---|
InvalidInput
|
Deletes a hosted zone.
If the name servers for the hosted zone are associated with a domain and if you want to make the domain unavailable on the Internet, we recommend that you delete the name servers from the domain to prevent future DNS queries from possibly being misrouted. If the domain is registered with Amazon Route 53, see UpdateDomainNameservers
. If the domain is registered with another registrar, use the method provided by the registrar to delete name servers for the domain.
Some domain registries don't allow you to remove all of the name servers for a domain. If the registry for your domain requires one or more name servers, we recommend that you delete the hosted zone only if you transfer DNS service to another service provider, and you replace the name servers for the domain with name servers from the new provider.
You can delete a hosted zone only if it contains only the default SOA record and NS resource record sets. If the hosted zone contains other resource record sets, you must delete them before you can delete the hosted zone. If you try to delete a hosted zone that contains other resource record sets, the request fails, and Route 53 returns a HostedZoneNotEmpty
error. For information about deleting records from your hosted zone, see ChangeResourceRecordSets.
To verify that the hosted zone has been deleted, do one of the following:
Use the GetHostedZone
action to request information about the hosted zone.
Use the ListHostedZones
action to get a list of the hosted zones associated with the current AWS account.
Name | Data Type | Description |
---|---|---|
Id
|
string |
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
DeleteHostedZoneRequest
|
object |
A request to delete a hosted zone. |
Name | Data Type | Description |
---|---|---|
DeleteHostedZoneResponse
|
object |
A complex type that contains the response to a |
ChangeInfo
|
ChangeInfo |
A complex type that contains the ID, the status, and the date and time of a request to delete a hosted zone. |
||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
NoSuchHostedZone
|
Name | Data Type | Description |
---|---|---|
HostedZoneNotEmpty
|
Name | Data Type | Description |
---|---|---|
PriorRequestNotComplete
|
Name | Data Type | Description |
---|---|---|
InvalidInput
|
Name | Data Type | Description |
---|---|---|
InvalidDomainName
|
Gets information about a specified hosted zone including the four name servers assigned to the hosted zone.
Name | Data Type | Description |
---|---|---|
Id
|
string |
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
GetHostedZoneRequest
|
object |
A request to get information about a specified hosted zone. |
{
"Id": "Z3M3LMPEXAMPLE"
}
Name | Data Type | Description |
---|---|---|
GetHostedZoneResponse
|
object |
A complex type that contain the response to a |
VPCs
|
VPCs |
A complex type that contains information about the VPCs that are associated with the specified hosted zone. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DelegationSet
|
DelegationSet |
A complex type that lists the Amazon Route 53 name servers for the specified hosted zone. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HostedZone
|
HostedZone |
A complex type that contains general information about the specified hosted zone. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
{
"DelegationSet": {
"NameServers": [
"ns-2048.awsdns-64.com",
"ns-2049.awsdns-65.net",
"ns-2050.awsdns-66.org",
"ns-2051.awsdns-67.co.uk"
]
},
"HostedZone": {
"CallerReference": "C741617D-04E4-F8DE-B9D7-0D150FC61C2E",
"Config": {
"PrivateZone": false
},
"Id": "\/hostedzone\/Z3M3LMPEXAMPLE",
"Name": "myawsbucket.com.",
"ResourceRecordSetCount": 8
}
}
Name | Data Type | Description |
---|---|---|
NoSuchHostedZone
|
Name | Data Type | Description |
---|---|---|
InvalidInput
|
Updates the comment for a specified hosted zone.
Name | Data Type | Description |
---|---|---|
Id
|
string |
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
UpdateHostedZoneCommentRequest
|
object |
A request to update the comment for a hosted zone. |
Comment
|
ResourceDescription |
The new comment for the hosted zone. If you don't specify a value for |
||||
|
Name | Data Type | Description |
---|---|---|
UpdateHostedZoneCommentResponse
|
object |
A complex type that contains the response to the |
HostedZone
|
HostedZone |
A complex type that contains the response to the |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
NoSuchHostedZone
|
Name | Data Type | Description |
---|---|---|
InvalidInput
|
Retrieves a list of the public and private hosted zones that are associated with the current AWS account. The response includes a HostedZones
child element for each hosted zone.
Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of hosted zones, you can use the maxitems
parameter to list them in groups of up to 100.
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string | |
Marker
|
string |
Pagination token |
MaxItems
|
string |
Pagination limit |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
ListHostedZonesRequest
|
object |
A request to retrieve a list of the public and private hosted zones that are associated with the current AWS account. |
Name | Data Type | Description |
---|---|---|
ListHostedZonesResponse
|
object |
MaxItems
|
PageMaxItems |
The value that you specified for the |
|||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||
NextMarker
|
PageMarker |
If This element is present only if |
|||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||
IsTruncated
|
PageTruncated |
A flag indicating whether there are more hosted zones to be listed. If the response was truncated, you can get more hosted zones by submitting another |
|||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||
Marker
|
PageMarker |
For the second and subsequent calls to |
|||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||
HostedZones
|
HostedZones |
A complex type that contains general information about the hosted zone. |
|||||||||||||||||||||||||||||
|
Name | Data Type | Description |
---|---|---|
InvalidInput
|
Name | Data Type | Description |
---|---|---|
NoSuchDelegationSet
|
Name | Data Type | Description |
---|---|---|
DelegationSetNotReusable
|
Creates a new public or private hosted zone. You create records in a public hosted zone to define how you want to route traffic on the internet for a domain, such as example.com, and its subdomains (apex.example.com, acme.example.com). You create records in a private hosted zone to define how you want to route traffic for a domain and its subdomains within one or more Amazon Virtual Private Clouds (Amazon VPCs).
You can't convert a public hosted zone to a private hosted zone or vice versa. Instead, you must create a new hosted zone with the same name and create new resource record sets.
For more information about charges for hosted zones, see Amazon Route 53 Pricing.
Note the following:
You can't create a hosted zone for a top-level domain (TLD) such as .com.
For public hosted zones, Amazon Route 53 automatically creates a default SOA record and four NS records for the zone. For more information about SOA and NS records, see NS and SOA Records that Route 53 Creates for a Hosted Zone in the Amazon Route 53 Developer Guide.
If you want to use the same name servers for multiple public hosted zones, you can optionally associate a reusable delegation set with the hosted zone. See the DelegationSetId
element.
If your domain is registered with a registrar other than Route 53, you must update the name servers with your registrar to make Route 53 the DNS service for the domain. For more information, see Migrating DNS Service for an Existing Domain to Amazon Route 53 in the Amazon Route 53 Developer Guide.
When you submit a CreateHostedZone
request, the initial status of the hosted zone is PENDING
. For public hosted zones, this means that the NS and SOA records are not yet available on all Route 53 DNS servers. When the NS and SOA records are available, the status of the zone changes to INSYNC
.
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
CreateHostedZoneRequest
|
object |
A complex type that contains information about the request to create a public or private hosted zone. |
DelegationSetId
|
ResourceId |
If you want to associate a reusable delegation set with this hosted zone, the ID that Amazon Route 53 assigned to the reusable delegation set when you created it. For more information about reusable delegation sets, see CreateReusableDelegationSet. |
|||||||||||||||||||||
|
|||||||||||||||||||||||
HostedZoneConfig
|
HostedZoneConfig |
(Optional) A complex type that contains the following optional values:
If you don't specify a comment or the |
|||||||||||||||||||||
Properties
|