public interface AmazonRoute53
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| Modifier and Type | Method and Description |
|---|---|
AssociateVPCWithHostedZoneResult |
associateVPCWithHostedZone(AssociateVPCWithHostedZoneRequest associateVPCWithHostedZoneRequest)
Associates an Amazon VPC with a private hosted zone.
|
ChangeResourceRecordSetsResult |
changeResourceRecordSets(ChangeResourceRecordSetsRequest changeResourceRecordSetsRequest)
Create, change, update, or delete authoritative DNS information on all Amazon Route 53 servers.
|
ChangeTagsForResourceResult |
changeTagsForResource(ChangeTagsForResourceRequest changeTagsForResourceRequest)
Adds, edits, or deletes tags for a health check or a hosted zone.
|
CreateHealthCheckResult |
createHealthCheck(CreateHealthCheckRequest createHealthCheckRequest)
Creates a new health check.
|
CreateHostedZoneResult |
createHostedZone(CreateHostedZoneRequest createHostedZoneRequest)
Creates a new public hosted zone, used to specify how the Domain Name System (DNS) routes traffic on the Internet
for a domain, such as example.com, and its subdomains.
|
CreateReusableDelegationSetResult |
createReusableDelegationSet(CreateReusableDelegationSetRequest createReusableDelegationSetRequest)
Creates a delegation set (a group of four name servers) that can be reused by multiple hosted zones.
|
CreateTrafficPolicyResult |
createTrafficPolicy(CreateTrafficPolicyRequest createTrafficPolicyRequest)
Creates a traffic policy, which you use to create multiple DNS resource record sets for one domain name (such as
example.com) or one subdomain name (such as www.example.com).
|
CreateTrafficPolicyInstanceResult |
createTrafficPolicyInstance(CreateTrafficPolicyInstanceRequest createTrafficPolicyInstanceRequest)
Creates resource record sets in a specified hosted zone based on the settings in a specified traffic policy
version.
|
CreateTrafficPolicyVersionResult |
createTrafficPolicyVersion(CreateTrafficPolicyVersionRequest createTrafficPolicyVersionRequest)
Creates a new version of an existing traffic policy.
|
DeleteHealthCheckResult |
deleteHealthCheck(DeleteHealthCheckRequest deleteHealthCheckRequest)
Deletes a health check.
|
DeleteHostedZoneResult |
deleteHostedZone(DeleteHostedZoneRequest deleteHostedZoneRequest)
Deletes a hosted zone.
|
DeleteReusableDelegationSetResult |
deleteReusableDelegationSet(DeleteReusableDelegationSetRequest deleteReusableDelegationSetRequest)
Deletes a reusable delegation set.
|
DeleteTrafficPolicyResult |
deleteTrafficPolicy(DeleteTrafficPolicyRequest deleteTrafficPolicyRequest)
Deletes a traffic policy.
|
DeleteTrafficPolicyInstanceResult |
deleteTrafficPolicyInstance(DeleteTrafficPolicyInstanceRequest deleteTrafficPolicyInstanceRequest)
Deletes a traffic policy instance and all of the resource record sets that Amazon Route 53 created when you
created the instance.
|
DisassociateVPCFromHostedZoneResult |
disassociateVPCFromHostedZone(DisassociateVPCFromHostedZoneRequest disassociateVPCFromHostedZoneRequest)
Disassociates a VPC from a Amazon Route 53 private hosted zone.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetChangeResult |
getChange(GetChangeRequest getChangeRequest)
Returns the current status of a change batch request.
|
GetChangeDetailsResult |
getChangeDetails(GetChangeDetailsRequest getChangeDetailsRequest)
Deprecated.
|
GetCheckerIpRangesResult |
getCheckerIpRanges()
Simplified method form for invoking the GetCheckerIpRanges operation.
|
GetCheckerIpRangesResult |
getCheckerIpRanges(GetCheckerIpRangesRequest getCheckerIpRangesRequest)
Retrieves a list of the IP ranges used by Amazon Route 53 health checkers to check the health of your resources.
|
GetGeoLocationResult |
getGeoLocation()
Simplified method form for invoking the GetGeoLocation operation.
|
GetGeoLocationResult |
getGeoLocation(GetGeoLocationRequest getGeoLocationRequest)
Retrieves a single geo location.
|
GetHealthCheckResult |
getHealthCheck(GetHealthCheckRequest getHealthCheckRequest)
Gets information about a specified health check.
|
GetHealthCheckCountResult |
getHealthCheckCount()
Simplified method form for invoking the GetHealthCheckCount operation.
|
GetHealthCheckCountResult |
getHealthCheckCount(GetHealthCheckCountRequest getHealthCheckCountRequest)
To retrieve a count of all your health checks, send a
GET request to the
/2013-04-01/healthcheckcount resource. |
GetHealthCheckLastFailureReasonResult |
getHealthCheckLastFailureReason(GetHealthCheckLastFailureReasonRequest getHealthCheckLastFailureReasonRequest)
If you want to learn why a health check is currently failing or why it failed most recently (if at all), you can
get the failure reason for the most recent failure.
|
GetHealthCheckStatusResult |
getHealthCheckStatus(GetHealthCheckStatusRequest getHealthCheckStatusRequest)
Gets status of a specified health check.
|
GetHostedZoneResult |
getHostedZone(GetHostedZoneRequest getHostedZoneRequest)
Retrieves the delegation set for a hosted zone, including the four name servers assigned to the hosted zone.
|
GetHostedZoneCountResult |
getHostedZoneCount()
Simplified method form for invoking the GetHostedZoneCount operation.
|
GetHostedZoneCountResult |
getHostedZoneCount(GetHostedZoneCountRequest getHostedZoneCountRequest)
Retrieves a count of all your hosted zones.
|
GetReusableDelegationSetResult |
getReusableDelegationSet(GetReusableDelegationSetRequest getReusableDelegationSetRequest)
Retrieves the reusable delegation set.
|
GetTrafficPolicyResult |
getTrafficPolicy(GetTrafficPolicyRequest getTrafficPolicyRequest)
Gets information about a specific traffic policy version.
|
GetTrafficPolicyInstanceResult |
getTrafficPolicyInstance(GetTrafficPolicyInstanceRequest getTrafficPolicyInstanceRequest)
Gets information about a specified traffic policy instance.
|
GetTrafficPolicyInstanceCountResult |
getTrafficPolicyInstanceCount()
Simplified method form for invoking the GetTrafficPolicyInstanceCount operation.
|
GetTrafficPolicyInstanceCountResult |
getTrafficPolicyInstanceCount(GetTrafficPolicyInstanceCountRequest getTrafficPolicyInstanceCountRequest)
Gets the number of traffic policy instances that are associated with the current AWS account.
|
ListChangeBatchesByHostedZoneResult |
listChangeBatchesByHostedZone(ListChangeBatchesByHostedZoneRequest listChangeBatchesByHostedZoneRequest)
Deprecated.
|
ListChangeBatchesByRRSetResult |
listChangeBatchesByRRSet(ListChangeBatchesByRRSetRequest listChangeBatchesByRRSetRequest)
Deprecated.
|
ListGeoLocationsResult |
listGeoLocations()
Simplified method form for invoking the ListGeoLocations operation.
|
ListGeoLocationsResult |
listGeoLocations(ListGeoLocationsRequest listGeoLocationsRequest)
Retrieves a list of supported geo locations.
|
ListHealthChecksResult |
listHealthChecks()
Simplified method form for invoking the ListHealthChecks operation.
|
ListHealthChecksResult |
listHealthChecks(ListHealthChecksRequest listHealthChecksRequest)
Retrieve a list of your health checks.
|
ListHostedZonesResult |
listHostedZones()
Simplified method form for invoking the ListHostedZones operation.
|
ListHostedZonesResult |
listHostedZones(ListHostedZonesRequest listHostedZonesRequest)
To retrieve a list of your public and private hosted zones, send a
GET request to the
/2013-04-01/hostedzone resource. |
ListHostedZonesByNameResult |
listHostedZonesByName()
Simplified method form for invoking the ListHostedZonesByName operation.
|
ListHostedZonesByNameResult |
listHostedZonesByName(ListHostedZonesByNameRequest listHostedZonesByNameRequest)
Retrieves a list of your hosted zones in lexicographic order.
|
ListResourceRecordSetsResult |
listResourceRecordSets(ListResourceRecordSetsRequest listResourceRecordSetsRequest)
Lists the resource record sets in a specified hosted zone.
|
ListReusableDelegationSetsResult |
listReusableDelegationSets()
Simplified method form for invoking the ListReusableDelegationSets operation.
|
ListReusableDelegationSetsResult |
listReusableDelegationSets(ListReusableDelegationSetsRequest listReusableDelegationSetsRequest)
To retrieve a list of your reusable delegation sets, send a
GET request to the
/2013-04-01/delegationset resource. |
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists tags for one health check or hosted zone.
|
ListTagsForResourcesResult |
listTagsForResources(ListTagsForResourcesRequest listTagsForResourcesRequest)
Lists tags for up to 10 health checks or hosted zones.
|
ListTrafficPoliciesResult |
listTrafficPolicies()
Simplified method form for invoking the ListTrafficPolicies operation.
|
ListTrafficPoliciesResult |
listTrafficPolicies(ListTrafficPoliciesRequest listTrafficPoliciesRequest)
Gets information about the latest version for every traffic policy that is associated with the current AWS
account.
|
ListTrafficPolicyInstancesResult |
listTrafficPolicyInstances()
Simplified method form for invoking the ListTrafficPolicyInstances operation.
|
ListTrafficPolicyInstancesResult |
listTrafficPolicyInstances(ListTrafficPolicyInstancesRequest listTrafficPolicyInstancesRequest)
Gets information about the traffic policy instances that you created by using the current AWS account.
|
ListTrafficPolicyInstancesByHostedZoneResult |
listTrafficPolicyInstancesByHostedZone(ListTrafficPolicyInstancesByHostedZoneRequest listTrafficPolicyInstancesByHostedZoneRequest)
Gets information about the traffic policy instances that you created in a specified hosted zone.
|
ListTrafficPolicyInstancesByPolicyResult |
listTrafficPolicyInstancesByPolicy(ListTrafficPolicyInstancesByPolicyRequest listTrafficPolicyInstancesByPolicyRequest)
Gets information about the traffic policy instances that you created by using a specify traffic policy version.
|
ListTrafficPolicyVersionsResult |
listTrafficPolicyVersions(ListTrafficPolicyVersionsRequest listTrafficPolicyVersionsRequest)
Gets information about all of the versions for a specified traffic policy.
|
void |
setEndpoint(String endpoint)
Overrides the default endpoint for this client ("https://route53.amazonaws.com").
|
void |
setRegion(Region region)
An alternative to
setEndpoint(String), sets the regional endpoint for this client's service
calls. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
TestDNSAnswerResult |
testDNSAnswer(TestDNSAnswerRequest testDNSAnswerRequest)
Gets the value that Amazon Route 53 returns in response to a DNS request for a specified record name and type.
|
UpdateHealthCheckResult |
updateHealthCheck(UpdateHealthCheckRequest updateHealthCheckRequest)
Updates an existing health check.
|
UpdateHostedZoneCommentResult |
updateHostedZoneComment(UpdateHostedZoneCommentRequest updateHostedZoneCommentRequest)
Updates the hosted zone comment.
|
UpdateTrafficPolicyCommentResult |
updateTrafficPolicyComment(UpdateTrafficPolicyCommentRequest updateTrafficPolicyCommentRequest)
Updates the comment for a specified traffic policy version.
|
UpdateTrafficPolicyInstanceResult |
updateTrafficPolicyInstance(UpdateTrafficPolicyInstanceRequest updateTrafficPolicyInstanceRequest)
Updates the resource record sets in a specified hosted zone that were created based on the settings in a
specified traffic policy version.
|
AmazonRoute53Waiters |
waiters() |
static final String ENDPOINT_PREFIX
void setEndpoint(String endpoint)
Callers can pass in just the endpoint (ex: "route53.amazonaws.com") or a full URL, including the protocol (ex:
"https://route53.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's
ClientConfiguration will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
endpoint - The endpoint (ex: "route53.amazonaws.com") or a full URL, including the protocol (ex:
"https://route53.amazonaws.com") of the region specific AWS endpoint this client will communicate with.void setRegion(Region region)
setEndpoint(String), sets the regional endpoint for this client's service
calls. Callers can use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration),
Region.isServiceSupported(String)AssociateVPCWithHostedZoneResult associateVPCWithHostedZone(AssociateVPCWithHostedZoneRequest associateVPCWithHostedZoneRequest)
Associates an Amazon VPC with a private hosted zone.
The VPC and the hosted zone must already exist, and you must have created a private hosted zone. You cannot convert a public hosted zone into a private hosted zone.
Send a POST request to the /2013-04-01/hostedzone/hosted zone ID/associatevpc
resource. The request body must include an XML document with a AssociateVPCWithHostedZoneRequest
element. The response returns the AssociateVPCWithHostedZoneResponse element.
If you used different accounts to create the hosted zone and to create the Amazon VPCs that you want to associate with the hosted zone, we need to update account permissions for you. For more information, see Associating Amazon VPCs and Private Hosted Zones That You Create with Different AWS Accounts in the Amazon Route 53 Developer Guide.
associateVPCWithHostedZoneRequest - A complex type that contains information about the VPC and the hosted zone that you want to associate.NoSuchHostedZoneException - No hosted zone exists with the ID that you specified.InvalidVPCIdException - The hosted zone you are trying to create for your VPC_ID does not belong to you. Amazon Route 53 returns
this error when the VPC specified by VPCId does not belong to you.InvalidInputException - The input is not valid.PublicZoneVPCAssociationException - The hosted zone specified in HostedZoneId is a public hosted zone.ConflictingDomainExistsException - You specified an Amazon VPC that you're already using for another hosted zone, and the domain that you
specified for one of the hosted zones is a subdomain of the domain that you specified for the other
hosted zone. For example, you cannot use the same Amazon VPC for the hosted zones for example.com and
test.example.com.LimitsExceededException - The limits specified for a resource have been exceeded.ChangeResourceRecordSetsResult changeResourceRecordSets(ChangeResourceRecordSetsRequest changeResourceRecordSetsRequest)
Create, change, update, or delete authoritative DNS information on all Amazon Route 53 servers. Send a
POST request to:
/2013-04-01/hostedzone/Amazon Route 53 hosted Zone ID/rrset resource.
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, Amazon Route 53 either makes all or
none of the changes in a change batch request. This ensures that Amazon 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. Amazon 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 cannot 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, Amazon Route 53 returns an
InvalidChangeBatch error.
To create resource record sets for complex routing configurations, use either the traffic flow visual editor in the Amazon 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.
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 for Name,
Type, Set Identifier (for code latency, weighted, geolocation, and failover resource
record sets), and TTL (except alias resource record sets, for which the TTL is determined by the AWS
resource you're routing queries to).
UPSERT: If a resource record set does not already exist, AWS creates it. If a resource set does
exist, Amazon Route 53 updates it with the values in the request. Amazon Route 53 can update an existing resource
record set only when all of the following values match: Name, Type, and
Set Identifier (for weighted, latency, geolocation, and failover resource record sets).
In response to a ChangeResourceRecordSets request, the DNS data is changed on all Amazon Route 53
DNS servers. Initially, the status of a change is PENDING, meaning the change has not yet propagated
to all the authoritative Amazon Route 53 DNS servers. When the change is propagated to all hosts, the change
returns a status of INSYNC.
After sending a change request, confirm your change has propagated to all Amazon Route 53 DNS servers. Changes generally propagate to all Amazon Route 53 name servers in a few minutes. In rare circumstances, propagation can take up to 30 minutes. For more information, see GetChange.
For information about the limits on a ChangeResourceRecordSets request, see Limits in the Amazon
Route 53 Developer Guide.
changeResourceRecordSetsRequest - A complex type that contains change information for the resource record set.NoSuchHostedZoneException - No hosted zone exists with the ID that you specified.NoSuchHealthCheckException - No health check exists with the ID that you specified in the DeleteHealthCheck request.InvalidChangeBatchException - This exception contains a list of messages that might contain one or more error messages. Each error
message indicates one error in the change batch.InvalidInputException - The input is not valid.PriorRequestNotCompleteException - If Amazon Route 53 can't process a request before the next request arrives, it will reject subsequent
requests for the same hosted zone and return an HTTP 400 error (Bad request).
If Amazon Route 53 returns this error repeatedly for the same request, we recommend that you wait, in
intervals of increasing duration, before you try the request again.ChangeTagsForResourceResult changeTagsForResource(ChangeTagsForResourceRequest changeTagsForResourceRequest)
Adds, edits, or deletes tags for a health check or a hosted zone.
For information about using tags for cost allocation, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
changeTagsForResourceRequest - A complex type that contains information about the tags that you want to add, edit, or delete.InvalidInputException - The input is not valid.NoSuchHealthCheckException - No health check exists with the ID that you specified in the DeleteHealthCheck request.NoSuchHostedZoneException - No hosted zone exists with the ID that you specified.PriorRequestNotCompleteException - If Amazon Route 53 can't process a request before the next request arrives, it will reject subsequent
requests for the same hosted zone and return an HTTP 400 error (Bad request).
If Amazon Route 53 returns this error repeatedly for the same request, we recommend that you wait, in
intervals of increasing duration, before you try the request again.ThrottlingExceptionCreateHealthCheckResult createHealthCheck(CreateHealthCheckRequest createHealthCheckRequest)
Creates a new health check.
To create a new health check, send a POST request to the /2013-04-01/healthcheck
resource. The request body must include an XML document with a CreateHealthCheckRequest element. The
response returns the CreateHealthCheckResponse element, containing the health check ID specified
when adding health check to a resource record set. For information about adding health checks to resource record
sets, see ResourceRecordSet$HealthCheckId in ChangeResourceRecordSets.
If you are registering Amazon EC2 instances with an Elastic Load Balancing (ELB) load balancer, do not create Amazon Route 53 health checks for the Amazon EC2 instances. When you register an Amazon EC2 instance with a load balancer, you configure settings for an ELB health check, which performs a similar function to an Amazon Route 53 health check.
You can associate health checks with failover resource record sets in a private hosted zone. Note the following:
Amazon 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
Developer Guide.
createHealthCheckRequest - A complex type that contains the health check request information.TooManyHealthChecksException - You have reached the maximum number of active health checks for an AWS account. The default limit is 100.
To request a higher limit, create a case with the AWS
Support Center.HealthCheckAlreadyExistsException - The health check you're attempting to create already exists.
Amazon Route 53 returns this error when a health check has already been created with the specified value
for CallerReference.
InvalidInputException - The input is not valid.CreateHostedZoneResult createHostedZone(CreateHostedZoneRequest createHostedZoneRequest)
Creates a new public hosted zone, used to specify how the Domain Name System (DNS) routes traffic on the Internet for a domain, such as example.com, and its subdomains.
Public hosted zones cannot be converted to a private hosted zone or vice versa. Instead, create a new hosted zone with the same name and create new resource record sets.
Send a POST request to the /2013-04-01/hostedzone resource. The request body must
include an XML document with a CreateHostedZoneRequest element. The response returns the
CreateHostedZoneResponse element containing metadata about the hosted zone.
Fore more information about charges for hosted zones, see Amazon Route 53 Pricing.
Note the following:
You cannot create a hosted zone for a top-level domain (TLD).
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 Amazon Route 53 Creates for a Hosted Zone in the Amazon Route 53 Developer Guide.
If your domain is registered with a registrar other than Amazon Route 53, you must update the name servers with your registrar to make Amazon Route 53 your DNS service. For more information, see Configuring Amazon Route 53 as your DNS Service in the Amazon Route 53 Developer's Guide.
After creating a zone, its initial status is PENDING. This means that it is not yet available on all
DNS servers. The status of the zone changes to INSYNC when the NS and SOA records are available on
all Amazon Route 53 DNS servers.
When trying to create a hosted zone using a reusable delegation set, specify an optional DelegationSetId, and Amazon Route 53 would assign those 4 NS records for the zone, instead of allotting a new one.
createHostedZoneRequest - A complex type containing the hosted zone request information.InvalidDomainNameException - The specified domain name is not valid.HostedZoneAlreadyExistsException - The hosted zone you are trying to create already exists. Amazon Route 53 returns this error when a hosted
zone has already been created with the specified CallerReference.TooManyHostedZonesException - This hosted zone cannot be created because the hosted zone limit is exceeded. To request a limit
increase, go to the Amazon Route 53 Contact Us page.InvalidVPCIdException - The hosted zone you are trying to create for your VPC_ID does not belong to you. Amazon Route 53 returns
this error when the VPC specified by VPCId does not belong to you.InvalidInputException - The input is not valid.DelegationSetNotAvailableException - You can create a hosted zone that has the same name as an existing hosted zone (example.com is common),
but there is a limit to the number of hosted zones that have the same name. If you get this error, Amazon
Route 53 has reached that limit. If you own the domain name and Amazon Route 53 generates this error,
contact Customer Support.ConflictingDomainExistsException - You specified an Amazon VPC that you're already using for another hosted zone, and the domain that you
specified for one of the hosted zones is a subdomain of the domain that you specified for the other
hosted zone. For example, you cannot use the same Amazon VPC for the hosted zones for example.com and
test.example.com.NoSuchDelegationSetException - A reusable delegation set with the specified ID does not exist.DelegationSetNotReusableException - A reusable delegation set with the specified ID does not exist.CreateReusableDelegationSetResult createReusableDelegationSet(CreateReusableDelegationSetRequest createReusableDelegationSetRequest)
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
Send a POST request to the /2013-04-01/delegationset resource. The request body must
include an XML document with a CreateReusableDelegationSetRequest element.
A reusable delegation set cannot be associated with a private hosted zone/
For more information, including a procedure on how to create and configure a reusable delegation set (also known as white label name servers), see Configuring White Label Name Servers.
createReusableDelegationSetRequest - DelegationSetAlreadyCreatedException - A delegation set with the same owner and caller reference combination has already been created.LimitsExceededException - The limits specified for a resource have been exceeded.HostedZoneNotFoundException - The specified HostedZone cannot be found.InvalidArgumentException - Parameter name and problem.InvalidInputException - The input is not valid.DelegationSetNotAvailableException - You can create a hosted zone that has the same name as an existing hosted zone (example.com is common),
but there is a limit to the number of hosted zones that have the same name. If you get this error, Amazon
Route 53 has reached that limit. If you own the domain name and Amazon Route 53 generates this error,
contact Customer Support.DelegationSetAlreadyReusableException - The specified delegation set has already been marked as reusable.CreateTrafficPolicyResult createTrafficPolicy(CreateTrafficPolicyRequest createTrafficPolicyRequest)
Creates a traffic policy, which you use to create multiple DNS resource record sets for one domain name (such as example.com) or one subdomain name (such as www.example.com).
Send a POST request to the /2013-04-01/trafficpolicy resource. The request body must
include a document with a CreateTrafficPolicyRequest element. The response includes the
CreateTrafficPolicyResponse element, which contains information about the new traffic policy.
createTrafficPolicyRequest - A complex type that contains information about the traffic policy that you want to create.InvalidInputException - The input is not valid.TooManyTrafficPoliciesException - You've created the maximum number of traffic policies that can be created for the current AWS account.
You can request an increase to the limit on the Contact
Us page.TrafficPolicyAlreadyExistsException - A traffic policy that has the same value for Name already exists.InvalidTrafficPolicyDocumentException - The format of the traffic policy document that you specified in the Document element is
invalid.CreateTrafficPolicyInstanceResult createTrafficPolicyInstance(CreateTrafficPolicyInstanceRequest createTrafficPolicyInstanceRequest)
Creates resource record sets in a specified hosted zone based on the settings in a specified traffic policy
version. In addition, CreateTrafficPolicyInstance associates the resource record sets with a
specified domain name (such as example.com) or subdomain name (such as www.example.com). Amazon Route 53 responds
to DNS queries for the domain or subdomain name by using the resource record sets that
CreateTrafficPolicyInstance created.
Send a POST request to the /2013-04-01/trafficpolicyinstance resource. The request body
must include a document with a CreateTrafficPolicyRequest element. The response returns the
CreateTrafficPolicyInstanceResponse element, which contains information about the traffic policy
instance.
createTrafficPolicyInstanceRequest - A complex type that contains information about the resource record sets that you want to create based on a
specified traffic policy.NoSuchHostedZoneException - No hosted zone exists with the ID that you specified.InvalidInputException - The input is not valid.TooManyTrafficPolicyInstancesException - You've created the maximum number of traffic policy instances that can be created for the current AWS
account. You can request an increase to the limit on the Contact Us page.NoSuchTrafficPolicyException - No traffic policy exists with the specified ID.TrafficPolicyInstanceAlreadyExistsException - Traffic policy instance with given Id already exists.CreateTrafficPolicyVersionResult createTrafficPolicyVersion(CreateTrafficPolicyVersionRequest createTrafficPolicyVersionRequest)
Creates a new version of an existing traffic policy. When you create a new version of a traffic policy, you specify the ID of the traffic policy that you want to update and a JSON-formatted document that describes the new version. You use traffic policies to create multiple DNS resource record sets for one domain name (such as example.com) or one subdomain name (such as www.example.com). You can create a maximum of 1000 versions of a traffic policy. If you reach the limit and need to create another version, you'll need to start a new traffic policy.
Send a POST request to the /2013-04-01/trafficpolicy/ resource. The request body
includes a document with a CreateTrafficPolicyVersionRequest element. The response returns the
CreateTrafficPolicyVersionResponse element, which contains information about the new version of the
traffic policy.
createTrafficPolicyVersionRequest - A complex type that contains information about the traffic policy for which you want to create a new
version.NoSuchTrafficPolicyException - No traffic policy exists with the specified ID.InvalidInputException - The input is not valid.ConcurrentModificationException - Another user submitted a request to update the object at the same time that you did. Retry the request.InvalidTrafficPolicyDocumentException - The format of the traffic policy document that you specified in the Document element is
invalid.DeleteHealthCheckResult deleteHealthCheck(DeleteHealthCheckRequest deleteHealthCheckRequest)
Deletes a health check. Send a DELETE request to the
/2013-04-01/healthcheck/health check ID resource.
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 cannot 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.
deleteHealthCheckRequest - This action deletes a health check. Send a DELETE request to the
/2013-04-01/DeleteHealthCheckRequest resource.NoSuchHealthCheckException - No health check exists with the ID that you specified in the DeleteHealthCheck request.HealthCheckInUseException - The health check ID for this health check is referenced in the HealthCheckId element in one
of the resource record sets in one of the hosted zones that are owned by the current AWS account.InvalidInputException - The input is not valid.DeleteHostedZoneResult deleteHostedZone(DeleteHostedZoneRequest deleteHostedZoneRequest)
Deletes a hosted zone. Send a DELETE request to the
/Amazon Route 53 API version/hostedzone/hosted zone ID resource.
Delete a hosted zone only if there are no resource record sets other than the default SOA record and NS resource
record sets. If the hosted zone contains other resource record sets, delete them before deleting the hosted zone.
If you try to delete a hosted zone that contains other resource record sets, Amazon Route 53 denies your request
with a HostedZoneNotEmpty error. For information about deleting records from your hosted zone, see
ChangeResourceRecordSets.
deleteHostedZoneRequest - A complex type that contains information about the hosted zone that you want to delete.NoSuchHostedZoneException - No hosted zone exists with the ID that you specified.HostedZoneNotEmptyException - The hosted zone contains resource records that are not SOA or NS records.PriorRequestNotCompleteException - If Amazon Route 53 can't process a request before the next request arrives, it will reject subsequent
requests for the same hosted zone and return an HTTP 400 error (Bad request).
If Amazon Route 53 returns this error repeatedly for the same request, we recommend that you wait, in
intervals of increasing duration, before you try the request again.InvalidInputException - The input is not valid.InvalidDomainNameException - The specified domain name is not valid.DeleteReusableDelegationSetResult deleteReusableDelegationSet(DeleteReusableDelegationSetRequest deleteReusableDelegationSetRequest)
Deletes a reusable delegation set. Send a DELETE request to the
/2013-04-01/delegationset/delegation set ID resource.
You can delete a reusable delegation set only if there are no associated hosted zones.
To verify that the reusable delegation set is not associated with any hosted zones, run the GetReusableDelegationSet action and specify the ID of the reusable delegation set that you want to delete.
deleteReusableDelegationSetRequest - A complex type containing the information for the delete request.NoSuchDelegationSetException - A reusable delegation set with the specified ID does not exist.DelegationSetInUseException - The specified delegation contains associated hosted zones which must be deleted before the reusable
delegation set can be deleted.DelegationSetNotReusableException - A reusable delegation set with the specified ID does not exist.InvalidInputException - The input is not valid.DeleteTrafficPolicyResult deleteTrafficPolicy(DeleteTrafficPolicyRequest deleteTrafficPolicyRequest)
Deletes a traffic policy.
Send a DELETE request to the /Amazon Route 53 API version/trafficpolicy
resource.
deleteTrafficPolicyRequest - A request to delete a specified traffic policy version.NoSuchTrafficPolicyException - No traffic policy exists with the specified ID.InvalidInputException - The input is not valid.TrafficPolicyInUseException - One or more traffic policy instances were created by using the specified traffic policy.ConcurrentModificationException - Another user submitted a request to update the object at the same time that you did. Retry the request.DeleteTrafficPolicyInstanceResult deleteTrafficPolicyInstance(DeleteTrafficPolicyInstanceRequest deleteTrafficPolicyInstanceRequest)
Deletes a traffic policy instance and all of the resource record sets that Amazon Route 53 created when you created the instance.
Send a DELETE request to the
/Amazon Route 53 API version/trafficpolicy/traffic policy instance ID resource.
In the Amazon Route 53 console, traffic policy instances are known as policy records.
deleteTrafficPolicyInstanceRequest - A complex type that contains information about the traffic policy instance that you want to delete.NoSuchTrafficPolicyInstanceException - No traffic policy instance exists with the specified ID.InvalidInputException - The input is not valid.PriorRequestNotCompleteException - If Amazon Route 53 can't process a request before the next request arrives, it will reject subsequent
requests for the same hosted zone and return an HTTP 400 error (Bad request).
If Amazon Route 53 returns this error repeatedly for the same request, we recommend that you wait, in
intervals of increasing duration, before you try the request again.DisassociateVPCFromHostedZoneResult disassociateVPCFromHostedZone(DisassociateVPCFromHostedZoneRequest disassociateVPCFromHostedZoneRequest)
Disassociates a VPC from a Amazon Route 53 private hosted zone.
Send a POST request to the /2013-04-01/hostedzone/hosted zone ID/disassociatevpc
resource. The request body must include an XML document with a DisassociateVPCFromHostedZoneRequest
element. The response returns the DisassociateVPCFromHostedZoneResponse element.
You can only disassociate a VPC from a private hosted zone when two or more VPCs are associated with that hosted zone. You cannot convert a private hosted zone into a public hosted zone.
disassociateVPCFromHostedZoneRequest - A complex type that contains information about the VPC and the hosted zone that you want to disassociate.NoSuchHostedZoneException - No hosted zone exists with the ID that you specified.InvalidVPCIdException - The hosted zone you are trying to create for your VPC_ID does not belong to you. Amazon Route 53 returns
this error when the VPC specified by VPCId does not belong to you.VPCAssociationNotFoundException - The specified VPC and hosted zone are not currently associated.LastVPCAssociationException - Only one VPC is currently associated with the hosted zone. You cannot convert a private hosted zone into
a public hosted zone by disassociating the last VPC from a hosted zone.InvalidInputException - The input is not valid.GetChangeResult getChange(GetChangeRequest getChangeRequest)
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 replicated to all Amazon Route 53 DNS
servers. This is the initial status of all change batch requests.
INSYNC indicates that the changes have replicated to all Amazon Route 53 DNS servers.
getChangeRequest - The input for a GetChange request.NoSuchChangeException - A change with the specified change ID does not exist.InvalidInputException - The input is not valid.@Deprecated GetChangeDetailsResult getChangeDetails(GetChangeDetailsRequest getChangeDetailsRequest)
Returns the status and changes of a change batch request.
getChangeDetailsRequest - The input for a GetChangeDetails request.NoSuchChangeException - A change with the specified change ID does not exist.InvalidInputException - The input is not valid.GetCheckerIpRangesResult getCheckerIpRanges(GetCheckerIpRangesRequest getCheckerIpRangesRequest)
Retrieves a list of the IP ranges used by Amazon Route 53 health checkers to check the health of your resources.
Send a GET request to the /Amazon Route 53 API version/checkeripranges resource.
Use these IP addresses to configure router and firewall rules to allow health checkers to check the health of
your resources.
getCheckerIpRangesRequest - Empty request.GetCheckerIpRangesResult getCheckerIpRanges()
GetGeoLocationResult getGeoLocation(GetGeoLocationRequest getGeoLocationRequest)
Retrieves a single geo location. Send a GET request to the /2013-04-01/geolocation
resource with one of these options: continentcode | countrycode | countrycode and subdivisioncode.
getGeoLocationRequest - A complex type that contains information about the request to get a geo location.NoSuchGeoLocationException - Amazon Route 53 doesn't support the specified geolocation.InvalidInputException - The input is not valid.GetGeoLocationResult getGeoLocation()
getGeoLocation(GetGeoLocationRequest)GetHealthCheckResult getHealthCheck(GetHealthCheckRequest getHealthCheckRequest)
Gets information about a specified health check. Send a GET request to the
/2013-04-01/healthcheck/health check ID resource. For more information about using the
console to perform this operation, see Amazon Route 53 Health Checks
and DNS Failover in the Amazon Route 53 Developer Guide.
getHealthCheckRequest - This action gets information about a specified health check.
Send a GET request to the
/Amazon Route 53 API version/gethealthcheckrequest resource.
For information about getting information about a health check using the Amazon Route 53 console, see Amazon Route 53 Health Checks and DNS Failover in the Amazon Route 53 Developer Guide.
NoSuchHealthCheckException - No health check exists with the ID that you specified in the DeleteHealthCheck request.InvalidInputException - The input is not valid.IncompatibleVersionException - The resource you are trying to access is unsupported on this Amazon Route 53 endpoint. Please consider
using a newer endpoint or a tool that does so.GetHealthCheckCountResult getHealthCheckCount(GetHealthCheckCountRequest getHealthCheckCountRequest)
To retrieve a count of all your health checks, send a GET request to the
/2013-04-01/healthcheckcount resource.
getHealthCheckCountRequest - To retrieve a count of all your health checks, send a GET request to the
/2013-04-01/healthcheckcount resource.GetHealthCheckCountResult getHealthCheckCount()
GetHealthCheckLastFailureReasonResult getHealthCheckLastFailureReason(GetHealthCheckLastFailureReasonRequest getHealthCheckLastFailureReasonRequest)
If you want to learn why a health check is currently failing or why it failed most recently (if at all), you can
get the failure reason for the most recent failure. Send a GET request to the
/Amazon Route 53 API version/healthcheck/health check ID/lastfailurereason resource.
getHealthCheckLastFailureReasonRequest - This action gets the reason that a specified health check failed most recently.
To get the reason for the last failure of a health check, send a GET request to the /2013-04-01/healthcheck/health check ID/lastfailurereason resource.
For information about viewing the last failure reason for a health check using the Amazon Route 53 console, see Viewing Health Check Status and the Reason for Health Check Failures in the Amazon Route 53 Developer Guide.
NoSuchHealthCheckException - No health check exists with the ID that you specified in the DeleteHealthCheck request.InvalidInputException - The input is not valid.GetHealthCheckStatusResult getHealthCheckStatus(GetHealthCheckStatusRequest getHealthCheckStatusRequest)
Gets status of a specified health check. Send a GET request to the
/2013-04-01/healthcheck/health check ID/status resource. You can use this call to get a
health check's current status.
getHealthCheckStatusRequest - A complex type that contains information about the request to get health check status for a health check.NoSuchHealthCheckException - No health check exists with the ID that you specified in the DeleteHealthCheck request.InvalidInputException - The input is not valid.GetHostedZoneResult getHostedZone(GetHostedZoneRequest getHostedZoneRequest)
Retrieves the delegation set for a hosted zone, including the four name servers assigned to the hosted zone. Send
a GET request to the
/Amazon Route 53 API version/hostedzone/hosted zone ID resource.
getHostedZoneRequest - The input for a GetHostedZone request.NoSuchHostedZoneException - No hosted zone exists with the ID that you specified.InvalidInputException - The input is not valid.GetHostedZoneCountResult getHostedZoneCount(GetHostedZoneCountRequest getHostedZoneCountRequest)
Retrieves a count of all your hosted zones. Send a GET request to the
/2013-04-01/hostedzonecount resource.
getHostedZoneCountRequest - To retrieve a count of all your hosted zones, send a GET request to the
/2013-04-01/hostedzonecount resource.InvalidInputException - The input is not valid.GetHostedZoneCountResult getHostedZoneCount()
GetReusableDelegationSetResult getReusableDelegationSet(GetReusableDelegationSetRequest getReusableDelegationSetRequest)
Retrieves the reusable delegation set. Send a GET request to the
/2013-04-01/delegationset/delegation set ID resource.
getReusableDelegationSetRequest - The input for a GetReusableDelegationSet request.NoSuchDelegationSetException - A reusable delegation set with the specified ID does not exist.DelegationSetNotReusableException - A reusable delegation set with the specified ID does not exist.InvalidInputException - The input is not valid.GetTrafficPolicyResult getTrafficPolicy(GetTrafficPolicyRequest getTrafficPolicyRequest)
Gets information about a specific traffic policy version.
Send a GET request to the /Amazon Route 53 API version/trafficpolicy resource.
getTrafficPolicyRequest - Gets information about a specific traffic policy version. To get the information, send a GET request to
the /2013-04-01/trafficpolicy resource, and specify the ID and the version of the traffic policy.NoSuchTrafficPolicyException - No traffic policy exists with the specified ID.InvalidInputException - The input is not valid.GetTrafficPolicyInstanceResult getTrafficPolicyInstance(GetTrafficPolicyInstanceRequest getTrafficPolicyInstanceRequest)
Gets information about a specified traffic policy instance.
Send a GET request to the /Amazon Route 53 API version/trafficpolicyinstance
resource.
After you submit a CreateTrafficPolicyInstance or an UpdateTrafficPolicyInstance
request, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the
traffic policy definition. For more information, see the State response element.
In the Amazon Route 53 console, traffic policy instances are known as policy records.
getTrafficPolicyInstanceRequest - Gets information about a specified traffic policy instance.
To get information about a traffic policy instance, send a GET request to the
/Amazon Route 53 API version/trafficpolicyinstance/Id resource.
NoSuchTrafficPolicyInstanceException - No traffic policy instance exists with the specified ID.InvalidInputException - The input is not valid.GetTrafficPolicyInstanceCountResult getTrafficPolicyInstanceCount(GetTrafficPolicyInstanceCountRequest getTrafficPolicyInstanceCountRequest)
Gets the number of traffic policy instances that are associated with the current AWS account.
To get the number of traffic policy instances, send a GET request to the
/2013-04-01/trafficpolicyinstancecount resource.
getTrafficPolicyInstanceCountRequest - To retrieve a count of all your traffic policy instances, send a GET request to the
/2013-04-01/trafficpolicyinstancecount resource.GetTrafficPolicyInstanceCountResult getTrafficPolicyInstanceCount()
@Deprecated ListChangeBatchesByHostedZoneResult listChangeBatchesByHostedZone(ListChangeBatchesByHostedZoneRequest listChangeBatchesByHostedZoneRequest)
Gets the list of ChangeBatches in a given time period for a given hosted zone.
listChangeBatchesByHostedZoneRequest - The input for a ListChangeBatchesByHostedZone request.NoSuchHostedZoneException - No hosted zone exists with the ID that you specified.InvalidInputException - The input is not valid.@Deprecated ListChangeBatchesByRRSetResult listChangeBatchesByRRSet(ListChangeBatchesByRRSetRequest listChangeBatchesByRRSetRequest)
Gets the list of ChangeBatches in a given time period for a given hosted zone and RRSet.
listChangeBatchesByRRSetRequest - The input for a ListChangeBatchesByRRSet request.NoSuchHostedZoneException - No hosted zone exists with the ID that you specified.InvalidInputException - The input is not valid.ListGeoLocationsResult listGeoLocations(ListGeoLocationsRequest listGeoLocationsRequest)
Retrieves a list of supported geo locations. Send a GET request to the
/2013-04-01/geolocations resource. The response to this request includes a
GeoLocationDetailsList element for each location that Amazon Route 53 supports.
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.
listGeoLocationsRequest - To get a list of geographic locations that Amazon Route 53 supports for geolocation, send a
GET request to the /Amazon Route 53 API version/geolocations resource.
The response to this request includes a GeoLocationDetails element for each location that
Amazon Route 53 supports.
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.
InvalidInputException - The input is not valid.ListGeoLocationsResult listGeoLocations()
ListHealthChecksResult listHealthChecks(ListHealthChecksRequest listHealthChecksRequest)
Retrieve a list of your health checks. Send a GET request to the
/2013-04-01/healthcheck resource. The response to this request includes a HealthChecks
element with zero or more HealthCheck child elements. By default, the list of health checks is
displayed on a single page. You can control the length of the page that is displayed by using the
MaxItems parameter. You can use the Marker parameter to control the health check that
the list begins with.
For information about listing health checks using the Amazon Route 53 console, see Amazon Route 53 Health Checks and DNS Failover.
listHealthChecksRequest - To retrieve a list of your health checks, send a GET request to the
/2013-04-01/healthcheck resource. The response to this request includes a
HealthChecks element with zero or more HealthCheck child elements. By default,
the list of health checks is displayed on a single page. You can control the length of the page that is
displayed by using the MaxItems parameter. You can use the Marker parameter to
control the health check that the list begins with.
Amazon Route 53 returns a maximum of 100 items. If you set MaxItems to a value greater than
100, Amazon Route 53 returns only the first 100.
InvalidInputException - The input is not valid.IncompatibleVersionException - The resource you are trying to access is unsupported on this Amazon Route 53 endpoint. Please consider
using a newer endpoint or a tool that does so.ListHealthChecksResult listHealthChecks()
ListHostedZonesResult listHostedZones(ListHostedZonesRequest listHostedZonesRequest)
To retrieve a list of your public and private hosted zones, send a GET request to the
/2013-04-01/hostedzone resource. The response to this request includes a HostedZones
child element for each hosted zone created by the current AWS account.
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. The response includes four values that
help navigate from one group of maxitems hosted zones to the next:
MaxItems is the value specified for the maxitems parameter in the request that produced
the current response.
If the value of IsTruncated in the response is true, there are more hosted zones associated with the
current AWS account.
NextMarker is the hosted zone ID of the next hosted zone that is associated with the current AWS
account. If you want to list more hosted zones, make another call to ListHostedZones, and specify
the value of the NextMarker element in the marker parameter.
If IsTruncated is false, the NextMarker element is omitted from the response.
If you're making the second or subsequent call to ListHostedZones, the Marker element
matches the value that you specified in the marker parameter in the previous request.
listHostedZonesRequest - To retrieve a list of your public and private hosted zones, send a GET request to the
/2013-04-01/hostedzone resource. The response to this request includes a HostedZone child
element for each hosted zone that was created by the current AWS account.
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. The response includes four values that help you navigate from one group of maxitems hosted zones to the next:
MaxItems is the value that you specified for the maxitems parameter in the
request that produced the current response.
If the value of IsTruncated in the response is true, there are more hosted zones
associated with the current AWS account.
If IsTruncated is false, this response includes the last hosted zone that is
associated with the current account.
NextMarker is the hosted zone ID of the next hosted zone that is associated with the current
AWS account. If you want to list more hosted zones, make another call to ListHostedZones, and
specify the value of the NextMarker element in the marker parameter.
If IsTruncated is false, the NextMarker element is omitted from the
response.
If you're making the second or subsequent call to ListHostedZones, the Marker
element matches the value that you specified in the marker parameter in the previous request.
InvalidInputException - The input is not valid.NoSuchDelegationSetException - A reusable delegation set with the specified ID does not exist.DelegationSetNotReusableException - A reusable delegation set with the specified ID does not exist.ListHostedZonesResult listHostedZones()
listHostedZones(ListHostedZonesRequest)ListHostedZonesByNameResult listHostedZonesByName(ListHostedZonesByNameRequest listHostedZonesByNameRequest)
Retrieves a list of your hosted zones in lexicographic order. Send a GET request to the
/2013-04-01/hostedzonesbyname resource. The response includes a HostedZones child
element for each hosted zone created by the current AWS account.
ListHostedZonesByName sorts hosted zones by name with the labels reversed. For example:
com.example.www.
Note the trailing dot, which can change the sort order in some circumstances.
If the domain name includes escape characters or Punycode, ListHostedZonesByName alphabetizes the
domain name using the escaped or Punycoded value, which is the format that Amazon Route 53 saves in its database.
For example, to create a hosted zone for example.com, specify ex\344mple.com for the domain name.
ListHostedZonesByName alphabetizes it as:
com.ex\344mple.
The labels are reversed and alphabetized using the escaped value. For more information about valid domain name formats, including internationalized domain names, see DNS Domain Name Format in the Amazon Route 53 Developer Guide.
Amazon Route 53 returns up to 100 items in each response. If you have a lot of hosted zones, use the
MaxItems parameter to list them in groups of up to 100. The response includes values that help
navigate from one group of MaxItems hosted zones to the next:
The DNSName and HostedZoneId elements in the response contain the values, if any,
specified for the dnsname and hostedzoneid parameters in the request that produced the
current response.
The MaxItems element in the response contains the value, if any, that you specified for the
maxitems parameter in the request that produced the current response.
If the value of IsTruncated in the response is true, there are more hosted zones associated with the
current AWS account.
If IsTruncated is false, this response includes the last hosted zone that is associated with the
current account. The NextDNSName element and NextHostedZoneId elements are omitted from
the response.
The NextDNSName and NextHostedZoneId elements in the response contain the domain name
and the hosted zone ID of the next hosted zone that is associated with the current AWS account. If you want to
list more hosted zones, make another call to ListHostedZonesByName, and specify the value of
NextDNSName and NextHostedZoneId in the dnsname and
hostedzoneid parameters, respectively.
listHostedZonesByNameRequest - To retrieve a list of your public and private hosted zones in ASCII order by domain name, send a
GET request to the /Amazon Route 53 API version/hostedzonesbyname
resource. The response to this request includes a HostedZone child element for each hosted
zone that was created by the current AWS account. ListHostedZonesByName sorts hosted zones by
name with the labels reversed, for example:
com.example.www.
Note the trailing dot, which can change the sort order in some circumstances.
If the domain name includes escape characters or Punycode, ListHostedZonesByName alphabetizes
the domain name using the escaped or Punycoded value, which is the format that Amazon Route 53 saves in
its database. For example, to create a hosted zone for exämple.com, you specify
ex\344mple.com for the domain name. ListHostedZonesByName alphabetizes it as:
com.ex\344mple. The labels are reversed, and it's alphabetized using the escaped value. For
more information about valid domain name formats, including internationalized domain names, see DNS Domain Name
Format in the Amazon Route 53 Developer Guide.
Amazon Route 53 returns up to 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. The response includes values that
help you navigate from one group of MaxItems hosted zones to the next:
The DNSName and HostedZoneId elements in the response contain the values, if
any, that you specified for the dnsname and hostedzoneid parameters in the
request that produced the current response.
The MaxItems element in the response contains the value, if any, that you specified for the
maxitems parameter in the request that produced the current response.
If the value of IsTruncated in the response is true, there are more hosted zones associated
with the current Amazon Route 53 account.
If IsTruncated is false, this response includes the last hosted zone that is
associated with the current account. The NextDNSName element and
NextHostedZoneId elements are omitted from the response.
The NextDNSName and NextHostedZoneId elements in the response contain the domain
name and the hosted zone ID of the next hosted zone that is associated with the current AWS account. If
you want to list more hosted zones, make another call to ListHostedZonesByName, and specify
the value of NextDNSName and NextHostedZoneId in the dnsname and
hostedzoneid parameters, respectively.
InvalidInputException - The input is not valid.InvalidDomainNameException - The specified domain name is not valid.ListHostedZonesByNameResult listHostedZonesByName()
ListResourceRecordSetsResult listResourceRecordSets(ListResourceRecordSetsRequest listResourceRecordSetsRequest)
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. The action 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 in some circumstances.
When multiple records have the same DNS name, the action sorts results by the record type.
You can use the name and type elements to adjust the beginning position of the list of resource record sets returned:
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.
This action returns the most current version of the records. This includes records that are PENDING,
and that are not yet available on all Amazon Route 53 DNS servers.
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.
listResourceRecordSetsRequest - The input for a ListResourceRecordSets request.NoSuchHostedZoneException - No hosted zone exists with the ID that you specified.InvalidInputException - The input is not valid.ListReusableDelegationSetsResult listReusableDelegationSets(ListReusableDelegationSetsRequest listReusableDelegationSetsRequest)
To retrieve a list of your reusable delegation sets, send a GET request to the
/2013-04-01/delegationset resource. The response to this request includes a
DelegationSets element with zero, one, or multiple DelegationSet child elements. By
default, the list of delegation sets is displayed on a single page. You can control the length of the page that
is displayed by using the MaxItems parameter. You can use the Marker parameter to
control the delegation set that the list begins with.
Amazon Route 53 returns a maximum of 100 items. If you set MaxItems to a value greater than 100, Amazon Route 53 returns only the first 100.
listReusableDelegationSetsRequest - To retrieve a list of your reusable delegation sets, send a GET request to the
/2013-04-01/delegationset resource. The response to this request includes a
DelegationSets element with zero or more DelegationSet child elements. By
default, the list of reusable delegation sets is displayed on a single page. You can control the length of
the page that is displayed by using the MaxItems parameter. You can use the
Marker parameter to control the delegation set that the list begins with.
Amazon Route 53 returns a maximum of 100 items. If you set MaxItems to a value greater than
100, Amazon Route 53 returns only the first 100.
InvalidInputException - The input is not valid.ListReusableDelegationSetsResult listReusableDelegationSets()
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists tags for one health check or hosted zone.
For information about using tags for cost allocation, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
listTagsForResourceRequest - A complex type containing information about a request for a list of the tags that are associated with an
individual resource.InvalidInputException - The input is not valid.NoSuchHealthCheckException - No health check exists with the ID that you specified in the DeleteHealthCheck request.NoSuchHostedZoneException - No hosted zone exists with the ID that you specified.PriorRequestNotCompleteException - If Amazon Route 53 can't process a request before the next request arrives, it will reject subsequent
requests for the same hosted zone and return an HTTP 400 error (Bad request).
If Amazon Route 53 returns this error repeatedly for the same request, we recommend that you wait, in
intervals of increasing duration, before you try the request again.ThrottlingExceptionListTagsForResourcesResult listTagsForResources(ListTagsForResourcesRequest listTagsForResourcesRequest)
Lists tags for up to 10 health checks or hosted zones.
For information about using tags for cost allocation, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
listTagsForResourcesRequest - A complex type that contains information about the health checks or hosted zones for which you want to
list tags.InvalidInputException - The input is not valid.NoSuchHealthCheckException - No health check exists with the ID that you specified in the DeleteHealthCheck request.NoSuchHostedZoneException - No hosted zone exists with the ID that you specified.PriorRequestNotCompleteException - If Amazon Route 53 can't process a request before the next request arrives, it will reject subsequent
requests for the same hosted zone and return an HTTP 400 error (Bad request).
If Amazon Route 53 returns this error repeatedly for the same request, we recommend that you wait, in
intervals of increasing duration, before you try the request again.ThrottlingExceptionListTrafficPoliciesResult listTrafficPolicies(ListTrafficPoliciesRequest listTrafficPoliciesRequest)
Gets information about the latest version for every traffic policy that is associated with the current AWS
account. Send a GET request to the /Amazon Route 53 API version/trafficpolicy
resource.
Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policies, you can
use the maxitems parameter to list them in groups of up to 100.
The response includes three values that help you navigate from one group of maxitems traffic
policies to the next:
IsTruncated
If the value of IsTruncated in the response is true, there are more traffic policies
associated with the current AWS account.
If IsTruncated is false, this response includes the last traffic policy that is
associated with the current account.
TrafficPolicyIdMarker
If IsTruncated is true, TrafficPolicyIdMarker is the ID of the first
traffic policy in the next group of MaxItems traffic policies. If you want to list more traffic
policies, make another call to ListTrafficPolicies, and specify the value of the
TrafficPolicyIdMarker element from the response in the TrafficPolicyIdMarker request
parameter.
If IsTruncated is false, the TrafficPolicyIdMarker element is omitted from
the response.
MaxItems
The value that you specified for the MaxItems parameter in the request that produced the current
response.
listTrafficPoliciesRequest - A complex type that contains the information about the request to list the traffic policies that are
associated with the current AWS account.InvalidInputException - The input is not valid.ListTrafficPoliciesResult listTrafficPolicies()
ListTrafficPolicyInstancesResult listTrafficPolicyInstances(ListTrafficPolicyInstancesRequest listTrafficPolicyInstancesRequest)
Gets information about the traffic policy instances that you created by using the current AWS account.
After you submit an UpdateTrafficPolicyInstance request, there's a brief delay while Amazon Route 53
creates the resource record sets that are specified in the traffic policy definition. For more information, see
the State response element.
Send a GET request to the /Amazon Route 53 API version/trafficpolicyinstance
resource.
Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances,
you can use the MaxItems parameter to list them in groups of up to 100.
The response includes five values that help you navigate from one group of MaxItems traffic policy
instances to the next:
IsTruncated
If the value of IsTruncated in the response is true, there are more traffic policy
instances associated with the current AWS account.
If IsTruncated is false, this response includes the last traffic policy instance that
is associated with the current account.
MaxItems
The value that you specified for the MaxItems parameter in the request that produced the current
response.
HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker
If IsTruncated is true, these three values in the response represent the first traffic
policy instance in the next group of MaxItems traffic policy instances. To list more traffic policy
instances, make another call to ListTrafficPolicyInstances, and specify these values in the
corresponding request parameters.
If IsTruncated is false, all three elements are omitted from the response.
listTrafficPolicyInstancesRequest - A complex type that contains the information about the request to list your traffic policy instances.InvalidInputException - The input is not valid.NoSuchTrafficPolicyInstanceException - No traffic policy instance exists with the specified ID.ListTrafficPolicyInstancesResult listTrafficPolicyInstances()
ListTrafficPolicyInstancesByHostedZoneResult listTrafficPolicyInstancesByHostedZone(ListTrafficPolicyInstancesByHostedZoneRequest listTrafficPolicyInstancesByHostedZoneRequest)
Gets information about the traffic policy instances that you created in a specified hosted zone.
After you submit an UpdateTrafficPolicyInstance request, there's a brief delay while Amazon Route 53
creates the resource record sets that are specified in the traffic policy definition. For more information, see
the State response element.
Send a GET request to the /Amazon Route 53 API version/trafficpolicyinstance
resource and include the ID of the hosted zone.
Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances,
you can use the MaxItems parameter to list them in groups of up to 100.
The response includes four values that help you navigate from one group of MaxItems traffic policy
instances to the next:
IsTruncated
If the value of IsTruncated in the response is true, there are more traffic policy instances
associated with the current AWS account.
If IsTruncated is false, this response includes the last traffic policy instance that
is associated with the current account.
MaxItems
The value that you specified for the MaxItems parameter in the request that produced the current
response.
TrafficPolicyInstanceNameMarker and TrafficPolicyInstanceTypeMarker
If IsTruncated is true, these two values in the response represent the first traffic
policy instance in the next group of MaxItems traffic policy instances. To list more traffic policy
instances, make another call to ListTrafficPolicyInstancesByHostedZone, and specify these values in
the corresponding request parameters.
If IsTruncated is false, all three elements are omitted from the response.
listTrafficPolicyInstancesByHostedZoneRequest - A request for the traffic policy instances that you created in a specified hosted zone.InvalidInputException - The input is not valid.NoSuchTrafficPolicyInstanceException - No traffic policy instance exists with the specified ID.NoSuchHostedZoneException - No hosted zone exists with the ID that you specified.ListTrafficPolicyInstancesByPolicyResult listTrafficPolicyInstancesByPolicy(ListTrafficPolicyInstancesByPolicyRequest listTrafficPolicyInstancesByPolicyRequest)
Gets information about the traffic policy instances that you created by using a specify traffic policy version.
After you submit a CreateTrafficPolicyInstance or an UpdateTrafficPolicyInstance
request, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the
traffic policy definition. For more information, see the State response element.
Send a GET request to the /Route 53 API version/trafficpolicyinstance resource
and include the ID and version of the traffic policy.
Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances,
you can use the MaxItems parameter to list them in groups of up to 100.
The response includes five values that help you navigate from one group of MaxItems traffic policy
instances to the next:
IsTruncated
If the value of IsTruncated in the response is true, there are more traffic policy
instances associated with the specified traffic policy.
If IsTruncated is false, this response includes the last traffic policy instance that
is associated with the specified traffic policy.
MaxItems
The value that you specified for the MaxItems parameter in the request that produced the current
response.
HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker
If IsTruncated is true, these values in the response represent the first traffic policy
instance in the next group of MaxItems traffic policy instances. To list more traffic policy
instances, make another call to ListTrafficPolicyInstancesByPolicy, and specify these values in the
corresponding request parameters.
If IsTruncated is false, all three elements are omitted from the response.
listTrafficPolicyInstancesByPolicyRequest - A complex type that contains the information about the request to list your traffic policy instances.InvalidInputException - The input is not valid.NoSuchTrafficPolicyInstanceException - No traffic policy instance exists with the specified ID.NoSuchTrafficPolicyException - No traffic policy exists with the specified ID.ListTrafficPolicyVersionsResult listTrafficPolicyVersions(ListTrafficPolicyVersionsRequest listTrafficPolicyVersionsRequest)
Gets information about all of the versions for a specified traffic policy.
Send a GET request to the /Amazon Route 53 API version/trafficpolicy resource
and specify the ID of the traffic policy for which you want to list versions.
Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policies, you can
use the maxitems parameter to list them in groups of up to 100.
The response includes three values that help you navigate from one group of maxitems traffic
policies to the next:
IsTruncated
If the value of IsTruncated in the response is true, there are more traffic policy
versions associated with the specified traffic policy.
If IsTruncated is false, this response includes the last traffic policy version that is
associated with the specified traffic policy.
TrafficPolicyVersionMarker
The ID of the next traffic policy version that is associated with the current AWS account. If you want to list
more traffic policies, make another call to ListTrafficPolicyVersions, and specify the value of the
TrafficPolicyVersionMarker element in the TrafficPolicyVersionMarker request parameter.
If IsTruncated is false, Amazon Route 53 omits the
TrafficPolicyVersionMarker element from the response.
MaxItems
The value that you specified for the MaxItems parameter in the request that produced the current
response.
listTrafficPolicyVersionsRequest - A complex type that contains the information about the request to list your traffic policies.InvalidInputException - The input is not valid.NoSuchTrafficPolicyException - No traffic policy exists with the specified ID.TestDNSAnswerResult testDNSAnswer(TestDNSAnswerRequest testDNSAnswerRequest)
Gets the value that Amazon Route 53 returns in response to a DNS request for a specified record name and type. You can optionally specify the IP address of a DNS resolver, an EDNS0 client subnet IP address, and a subnet mask.
testDNSAnswerRequest - Gets the value that Amazon Route 53 returns in response to a DNS request for a specified record name and
type. You can optionally specify the IP address of a DNS resolver, an EDNS0 client subnet IP address, and
a subnet mask.
Parameters
The ID of the hosted zone that you want Amazon Route 53 to simulate a query for.
The name of the resource record set that you want Amazon Route 53 to simulate a query for.
The type of the resource record set.
If you want to simulate a request from a specific DNS resolver, specify the IP address for that resolver.
If you omit this value, TestDNSAnswer uses the IP address of a DNS resolver in the AWS US
East region.
If the resolver that you specified for resolverip supports EDNS0, specify the IP address of a
client in the applicable location.
If you specify an IP address for edns0clientsubnetip, you can optionally specify the number
of bits of the IP address that you want the checking tool to include in the DNS query. For example, if you
specify 192.0.2.44 for edns0clientsubnetip and 24 for
edns0clientsubnetmask, the checking tool will simulate a request from
192.0.2.0/24. The default value is 24 bits.
NoSuchHostedZoneException - No hosted zone exists with the ID that you specified.InvalidInputException - The input is not valid.UpdateHealthCheckResult updateHealthCheck(UpdateHealthCheckRequest updateHealthCheckRequest)
Updates an existing health check.
Send a POST request to the /2013-04-01/healthcheck/health check ID resource.
The request body must include an XML document with an UpdateHealthCheckRequest element. For more
information about updating health checks, see Creating,
Updating, and Deleting Health Checks in the Amazon Route 53 Developer Guide.
updateHealthCheckRequest - A complex type that contains the health check request information.NoSuchHealthCheckException - No health check exists with the ID that you specified in the DeleteHealthCheck request.InvalidInputException - The input is not valid.HealthCheckVersionMismatchException - The value of HealthCheckVersion in the request doesn't match the value of
HealthCheckVersion in the health check.UpdateHostedZoneCommentResult updateHostedZoneComment(UpdateHostedZoneCommentRequest updateHostedZoneCommentRequest)
Updates the hosted zone comment. Send a POST request to the
/2013-04-01/hostedzone/hosted zone ID resource.
updateHostedZoneCommentRequest - A complex type that contains the hosted zone request information.NoSuchHostedZoneException - No hosted zone exists with the ID that you specified.InvalidInputException - The input is not valid.UpdateTrafficPolicyCommentResult updateTrafficPolicyComment(UpdateTrafficPolicyCommentRequest updateTrafficPolicyCommentRequest)
Updates the comment for a specified traffic policy version.
Send a POST request to the /2013-04-01/trafficpolicy/ resource.
The request body must include a document with an UpdateTrafficPolicyCommentRequest element.
updateTrafficPolicyCommentRequest - A complex type that contains information about the traffic policy for which you want to update the
comment.InvalidInputException - The input is not valid.NoSuchTrafficPolicyException - No traffic policy exists with the specified ID.ConcurrentModificationException - Another user submitted a request to update the object at the same time that you did. Retry the request.UpdateTrafficPolicyInstanceResult updateTrafficPolicyInstance(UpdateTrafficPolicyInstanceRequest updateTrafficPolicyInstanceRequest)
Updates the resource record sets in a specified hosted zone that were created based on the settings in a specified traffic policy version.
Send a POST request to the /2013-04-01/trafficpolicyinstance/traffic policy ID
resource. The request body must include a document with an UpdateTrafficPolicyInstanceRequest
element.
When you update a traffic policy instance, Amazon Route 53 continues to respond to DNS queries for the root resource record set name (such as example.com) while it replaces one group of resource record sets with another. Amazon Route 53 performs the following operations:
Amazon Route 53 creates a new group of resource record sets based on the specified traffic policy. This is true regardless of how substantial the differences are between the existing resource record sets and the new resource record sets.
When all of the new resource record sets have been created, Amazon Route 53 starts to respond to DNS queries for the root resource record set name (such as example.com) by using the new resource record sets.
Amazon Route 53 deletes the old group of resource record sets that are associated with the root resource record set name.
updateTrafficPolicyInstanceRequest - A complex type that contains information about the resource record sets that you want to update based on a
specified traffic policy instance.InvalidInputException - The input is not valid.NoSuchTrafficPolicyException - No traffic policy exists with the specified ID.NoSuchTrafficPolicyInstanceException - No traffic policy instance exists with the specified ID.PriorRequestNotCompleteException - If Amazon Route 53 can't process a request before the next request arrives, it will reject subsequent
requests for the same hosted zone and return an HTTP 400 error (Bad request).
If Amazon Route 53 returns this error repeatedly for the same request, we recommend that you wait, in
intervals of increasing duration, before you try the request again.ConflictingTypesException - You tried to update a traffic policy instance by using a traffic policy version that has a different DNS
type than the current type for the instance. You specified the type in the JSON document in the
CreateTrafficPolicy or CreateTrafficPolicyVersionrequest.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request - The originally executed request.AmazonRoute53Waiters waiters()
Copyright © 2016. All rights reserved.