Class AmazonRoute53Client
- All Implemented Interfaces:
AmazonRoute53
- Direct Known Subclasses:
AmazonRoute53AsyncClient
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected static final ClientConfigurationFactory
Client configuration factory providing ClientConfigurations tailored to this clientprotected final List
<com.amazonaws.transform.Unmarshaller<AmazonServiceException, Node>> List of exception unmarshallers for all modeled exceptionsFields inherited from class com.amazonaws.AmazonWebServiceClient
client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
-
Constructor Summary
ConstructorsConstructorDescriptionConstructs a new client to invoke service methods on Route 53.AmazonRoute53Client
(AWSCredentials awsCredentials) Constructs a new client to invoke service methods on Route 53 using the specified AWS account credentials.AmazonRoute53Client
(AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on Route 53 using the specified AWS account credentials provider.AmazonRoute53Client
(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on Route 53 using the specified AWS account credentials provider and client configuration options.AmazonRoute53Client
(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Constructs a new client to invoke service methods on Route 53 using the specified AWS account credentials provider, client configuration options, and request metric collector.AmazonRoute53Client
(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on Route 53 using the specified AWS account credentials and client configuration options.AmazonRoute53Client
(ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on Route 53. -
Method Summary
Modifier and TypeMethodDescriptionassociateVPCWithHostedZone
(AssociateVPCWithHostedZoneRequest associateVPCWithHostedZoneRequest) This action associates a VPC with an hosted zone.changeResourceRecordSets
(ChangeResourceRecordSetsRequest changeResourceRecordSetsRequest) Use this action to create or change your authoritative DNS information.changeTagsForResource
(ChangeTagsForResourceRequest changeTagsForResourceRequest) createHealthCheck
(CreateHealthCheckRequest createHealthCheckRequest) This action creates a new health check.createHostedZone
(CreateHostedZoneRequest createHostedZoneRequest) This action creates a new hosted zone.createReusableDelegationSet
(CreateReusableDelegationSetRequest createReusableDelegationSetRequest) This action creates a reusable delegationSet.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).createTrafficPolicyInstance
(CreateTrafficPolicyInstanceRequest createTrafficPolicyInstanceRequest) Creates resource record sets in a specified hosted zone based on the settings in a specified traffic policy version.createTrafficPolicyVersion
(CreateTrafficPolicyVersionRequest createTrafficPolicyVersionRequest) Creates a new version of an existing traffic policy.deleteHealthCheck
(DeleteHealthCheckRequest deleteHealthCheckRequest) This action deletes a health check.deleteHostedZone
(DeleteHostedZoneRequest deleteHostedZoneRequest) This action deletes a hosted zone.deleteReusableDelegationSet
(DeleteReusableDelegationSetRequest deleteReusableDelegationSetRequest) This action deletes a reusable delegation set.deleteTrafficPolicy
(DeleteTrafficPolicyRequest deleteTrafficPolicyRequest) Deletes a traffic policy.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.disassociateVPCFromHostedZone
(DisassociateVPCFromHostedZoneRequest disassociateVPCFromHostedZoneRequest) This action disassociates a VPC from an hosted zone.Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.getChange
(GetChangeRequest getChangeRequest) This action returns the current status of a change batch request.getChangeDetails
(GetChangeDetailsRequest getChangeDetailsRequest) Deprecated.Simplified method form for invoking the GetCheckerIpRanges operation.getCheckerIpRanges
(GetCheckerIpRangesRequest getCheckerIpRangesRequest) To retrieve a list of the IP ranges used by Amazon Route 53 health checkers to check the health of your resources, send aGET
request to the/Route 53 API version/checkeripranges
resource.Simplified method form for invoking the GetGeoLocation operation.getGeoLocation
(GetGeoLocationRequest getGeoLocationRequest) To retrieve a single geo location, send aGET
request to the/Route 53 API version/geolocation
resource with one of these options: continentcode | countrycode | countrycode and subdivisioncode.getHealthCheck
(GetHealthCheckRequest getHealthCheckRequest) To retrieve the health check, send aGET
request to the/Route 53 API version/healthcheck/health check ID
resource.Simplified method form for invoking the GetHealthCheckCount operation.getHealthCheckCount
(GetHealthCheckCountRequest getHealthCheckCountRequest) To retrieve a count of all your health checks, send aGET
request to the/Route 53 API version/healthcheckcount
resource.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.getHealthCheckStatus
(GetHealthCheckStatusRequest getHealthCheckStatusRequest) To retrieve the health check status, send aGET
request to the/Route 53 API version/healthcheck/health check ID/status
resource.getHostedZone
(GetHostedZoneRequest getHostedZoneRequest) To retrieve the delegation set for a hosted zone, send aGET
request to the/Route 53 API version/hostedzone/hosted zone ID
resource.Simplified method form for invoking the GetHostedZoneCount operation.getHostedZoneCount
(GetHostedZoneCountRequest getHostedZoneCountRequest) To retrieve a count of all your hosted zones, send aGET
request to the/Route 53 API version/hostedzonecount
resource.getReusableDelegationSet
(GetReusableDelegationSetRequest getReusableDelegationSetRequest) To retrieve the reusable delegation set, send aGET
request to the/Route 53 API version/delegationset/delegation set ID
resource.getTrafficPolicy
(GetTrafficPolicyRequest getTrafficPolicyRequest) Gets information about a specific traffic policy version.getTrafficPolicyInstance
(GetTrafficPolicyInstanceRequest getTrafficPolicyInstanceRequest) Gets information about a specified traffic policy instance.Simplified method form for invoking the GetTrafficPolicyInstanceCount operation.getTrafficPolicyInstanceCount
(GetTrafficPolicyInstanceCountRequest getTrafficPolicyInstanceCountRequest) Gets the number of traffic policy instances that are associated with the current AWS account.listChangeBatchesByHostedZone
(ListChangeBatchesByHostedZoneRequest listChangeBatchesByHostedZoneRequest) Deprecated.listChangeBatchesByRRSet
(ListChangeBatchesByRRSetRequest listChangeBatchesByRRSetRequest) Deprecated.Simplified method form for invoking the ListGeoLocations operation.listGeoLocations
(ListGeoLocationsRequest listGeoLocationsRequest) To retrieve a list of supported geo locations, send aGET
request to the/Route 53 API version/geolocations
resource.Simplified method form for invoking the ListHealthChecks operation.listHealthChecks
(ListHealthChecksRequest listHealthChecksRequest) To retrieve a list of your health checks, send aGET
request to the/Route 53 API version/healthcheck
resource.Simplified method form for invoking the ListHostedZones operation.listHostedZones
(ListHostedZonesRequest listHostedZonesRequest) To retrieve a list of your hosted zones, send aGET
request to the/Route 53 API version/hostedzone
resource.Simplified method form for invoking the ListHostedZonesByName operation.listHostedZonesByName
(ListHostedZonesByNameRequest listHostedZonesByNameRequest) To retrieve a list of your hosted zones in lexicographic order, send aGET
request to the/Route 53 API version/hostedzonesbyname
resource.listResourceRecordSets
(ListResourceRecordSetsRequest listResourceRecordSetsRequest) Imagine all the resource record sets in a zone listed out in front of you.Simplified method form for invoking the ListReusableDelegationSets operation.listReusableDelegationSets
(ListReusableDelegationSetsRequest listReusableDelegationSetsRequest) To retrieve a list of your reusable delegation sets, send aGET
request to the/Route 53 API version/delegationset
resource.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) listTagsForResources
(ListTagsForResourcesRequest listTagsForResourcesRequest) Simplified method form for invoking the ListTrafficPolicies operation.listTrafficPolicies
(ListTrafficPoliciesRequest listTrafficPoliciesRequest) Gets information about the latest version for every traffic policy that is associated with the current AWS account.Simplified method form for invoking the ListTrafficPolicyInstances operation.listTrafficPolicyInstances
(ListTrafficPolicyInstancesRequest listTrafficPolicyInstancesRequest) Gets information about the traffic policy instances that you created by using the current AWS account.listTrafficPolicyInstancesByHostedZone
(ListTrafficPolicyInstancesByHostedZoneRequest listTrafficPolicyInstancesByHostedZoneRequest) Gets information about the traffic policy instances that you created in a specified hosted zone.listTrafficPolicyInstancesByPolicy
(ListTrafficPolicyInstancesByPolicyRequest listTrafficPolicyInstancesByPolicyRequest) Gets information about the traffic policy instances that you created by using a specify traffic policy version.listTrafficPolicyVersions
(ListTrafficPolicyVersionsRequest listTrafficPolicyVersionsRequest) Gets information about all of the versions for a specified traffic policy.updateHealthCheck
(UpdateHealthCheckRequest updateHealthCheckRequest) This action updates an existing health check.updateHostedZoneComment
(UpdateHostedZoneCommentRequest updateHostedZoneCommentRequest) To update the hosted zone comment, send aPOST
request to the/Route 53 API version/hostedzone/hosted zone ID
resource.updateTrafficPolicyComment
(UpdateTrafficPolicyCommentRequest updateTrafficPolicyCommentRequest) Updates the comment for a specified traffic policy version.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.Methods inherited from class com.amazonaws.AmazonWebServiceClient
addRequestHandler, addRequestHandler, beforeMarshalling, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getEndpointPrefix, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.amazonaws.services.route53.AmazonRoute53
setEndpoint, setRegion, shutdown
-
Field Details
-
configFactory
Client configuration factory providing ClientConfigurations tailored to this client -
exceptionUnmarshallers
protected final List<com.amazonaws.transform.Unmarshaller<AmazonServiceException,Node>> exceptionUnmarshallersList of exception unmarshallers for all modeled exceptions
-
-
Constructor Details
-
AmazonRoute53Client
public AmazonRoute53Client()Constructs a new client to invoke service methods on Route 53. A credentials provider chain will be used that searches for credentials in this order:- Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
- Java System Properties - aws.accessKeyId and aws.secretKey
- Instance profile credentials delivered through the Amazon EC2 metadata service
All service calls made using this new client object are blocking, and will not return until the service call completes.
- See Also:
-
AmazonRoute53Client
Constructs a new client to invoke service methods on Route 53. A credentials provider chain will be used that searches for credentials in this order:- Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
- Java System Properties - aws.accessKeyId and aws.secretKey
- Instance profile credentials delivered through the Amazon EC2 metadata service
All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
clientConfiguration
- The client configuration options controlling how this client connects to Route 53 (ex: proxy settings, retry counts, etc.).- See Also:
-
AmazonRoute53Client
Constructs a new client to invoke service methods on Route 53 using the specified AWS account credentials.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
-
AmazonRoute53Client
Constructs a new client to invoke service methods on Route 53 using the specified AWS account credentials and client configuration options.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to Route 53 (ex: proxy settings, retry counts, etc.).
-
AmazonRoute53Client
Constructs a new client to invoke service methods on Route 53 using the specified AWS account credentials provider.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
-
AmazonRoute53Client
public AmazonRoute53Client(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on Route 53 using the specified AWS account credentials provider and client configuration options.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to Route 53 (ex: proxy settings, retry counts, etc.).
-
AmazonRoute53Client
public AmazonRoute53Client(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Constructs a new client to invoke service methods on Route 53 using the specified AWS account credentials provider, client configuration options, and request metric collector.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to Route 53 (ex: proxy settings, retry counts, etc.).requestMetricCollector
- optional request metric collector
-
-
Method Details
-
associateVPCWithHostedZone
public AssociateVPCWithHostedZoneResult associateVPCWithHostedZone(AssociateVPCWithHostedZoneRequest associateVPCWithHostedZoneRequest) This action associates a VPC with an hosted zone.
To associate a VPC with an hosted zone, send a
POST
request to the/Route 53 API version/hostedzone/hosted zone ID/associatevpc
resource. The request body must include a document with aAssociateVPCWithHostedZoneRequest
element. The response returns theAssociateVPCWithHostedZoneResponse
element that containsChangeInfo
for you to track the progress of theAssociateVPCWithHostedZoneRequest
you made. SeeGetChange
operation for how to track the progress of your change.- Specified by:
associateVPCWithHostedZone
in interfaceAmazonRoute53
- Parameters:
associateVPCWithHostedZoneRequest
- A complex type that contains information about the request to associate a VPC with an hosted zone.- Returns:
- Result of the AssociateVPCWithHostedZone operation returned by the service.
- Throws:
NoSuchHostedZoneException
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 byVPCId
does not belong to you.InvalidInputException
- Some value specified in the request is invalid or the XML document is malformed.PublicZoneVPCAssociationException
- The hosted zone you are trying to associate VPC with doesn't have any VPC association. Amazon Route 53 currently doesn't support associate a VPC with a public hosted zone.ConflictingDomainExistsException
LimitsExceededException
- The limits specified for a resource have been exceeded.
-
changeResourceRecordSets
public ChangeResourceRecordSetsResult changeResourceRecordSets(ChangeResourceRecordSetsRequest changeResourceRecordSetsRequest) Use this action to create or change your authoritative DNS information. To use this action, send a
POST
request to the/Route 53 API version/hostedzone/hosted Zone ID/rrset
resource. The request body must include a document with aChangeResourceRecordSetsRequest
element.Changes are a list of change items and are considered transactional. For more information on transactional changes, also known as change batches, see POST ChangeResourceRecordSets in the Amazon Route 53 API Reference.
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.In response to a
ChangeResourceRecordSets
request, your DNS data is changed on all Amazon Route 53 DNS servers. Initially, the status of a change isPENDING
. This means 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 ofINSYNC
.Note the following limitations on a
ChangeResourceRecordSets
request:- A request cannot contain more than 100 Change elements.
- A request cannot contain more than 1000 ResourceRecord elements.
- The sum of the number of characters (including spaces) in all
Value
elements in a request cannot exceed 32,000 characters.
- Specified by:
changeResourceRecordSets
in interfaceAmazonRoute53
- Parameters:
changeResourceRecordSetsRequest
- A complex type that contains a change batch.- Returns:
- Result of the ChangeResourceRecordSets operation returned by the service.
- Throws:
NoSuchHostedZoneException
NoSuchHealthCheckException
- The health check you are trying to get or delete does not exist.InvalidChangeBatchException
- This error contains a list of one or more error messages. Each error message indicates one error in the change batch. For more information, see Example InvalidChangeBatch Errors.InvalidInputException
- Some value specified in the request is invalid or the XML document is malformed.PriorRequestNotCompleteException
- The request was rejected because Amazon Route 53 was still processing a prior request.
-
changeTagsForResource
public ChangeTagsForResourceResult changeTagsForResource(ChangeTagsForResourceRequest changeTagsForResourceRequest) - Specified by:
changeTagsForResource
in interfaceAmazonRoute53
- Parameters:
changeTagsForResourceRequest
- A complex type containing information about a request to add, change, or delete the tags that are associated with a resource.- Returns:
- Result of the ChangeTagsForResource operation returned by the service.
- Throws:
InvalidInputException
- Some value specified in the request is invalid or the XML document is malformed.NoSuchHealthCheckException
- The health check you are trying to get or delete does not exist.NoSuchHostedZoneException
PriorRequestNotCompleteException
- The request was rejected because Amazon Route 53 was still processing a prior request.ThrottlingException
-
createHealthCheck
This action creates a new health check.
To create a new health check, send a
POST
request to the/Route 53 API version/healthcheck
resource. The request body must include a document with aCreateHealthCheckRequest
element. The response returns theCreateHealthCheckResponse
element that contains metadata about the health check.- Specified by:
createHealthCheck
in interfaceAmazonRoute53
- Parameters:
createHealthCheckRequest
- >A complex type that contains information about the request to create a health check.- Returns:
- Result of the CreateHealthCheck operation returned by the service.
- Throws:
TooManyHealthChecksException
HealthCheckAlreadyExistsException
- The health check you are trying to create already exists. Amazon Route 53 returns this error when a health check has already been created with the specifiedCallerReference
.InvalidInputException
- Some value specified in the request is invalid or the XML document is malformed.
-
createHostedZone
This action creates a new hosted zone.
To create a new hosted zone, send a
POST
request to the/Route 53 API version/hostedzone
resource. The request body must include a document with aCreateHostedZoneRequest
element. The response returns theCreateHostedZoneResponse
element that contains metadata about the hosted zone.Amazon Route 53 automatically creates a default SOA record and four NS records for the zone. The NS records in the hosted zone are the name servers you give your registrar to delegate your domain to. 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.
When you create 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 toINSYNC
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, you could specify an optional DelegationSetId, and Route53 would assign those 4 NS records for the zone, instead of alloting a new one.
- Specified by:
createHostedZone
in interfaceAmazonRoute53
- Parameters:
createHostedZoneRequest
- A complex type that contains information about the request to create a hosted zone.- Returns:
- Result of the CreateHostedZone operation returned by the service.
- Throws:
InvalidDomainNameException
- This error indicates that 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 specifiedCallerReference
.TooManyHostedZonesException
- This error indicates that you've reached the maximum number of hosted zones that can be created for the current AWS account. You can request an increase to the limit on the 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 byVPCId
does not belong to you.InvalidInputException
- Some value specified in the request is invalid or the XML document is malformed.DelegationSetNotAvailableException
- Amazon Route 53 allows some duplicate domain names, but there is a maximum number of duplicate names. This error indicates that you have reached that maximum. If you want to create another hosted zone with the same name and Amazon Route 53 generates this error, you can request an increase to the limit on the Contact Us page.ConflictingDomainExistsException
NoSuchDelegationSetException
- The specified delegation set does not exist.DelegationSetNotReusableException
- The specified delegation set has not been marked as reusable.
-
createReusableDelegationSet
public CreateReusableDelegationSetResult createReusableDelegationSet(CreateReusableDelegationSetRequest createReusableDelegationSetRequest) This action creates a reusable delegationSet.
To create a new reusable delegationSet, send a
POST
request to the/Route 53 API version/delegationset
resource. The request body must include a document with aCreateReusableDelegationSetRequest
element. The response returns theCreateReusableDelegationSetResponse
element that contains metadata about the delegationSet.If the optional parameter HostedZoneId is specified, it marks the delegationSet associated with that particular hosted zone as reusable.
- Specified by:
createReusableDelegationSet
in interfaceAmazonRoute53
- Parameters:
createReusableDelegationSetRequest
-- Returns:
- Result of the CreateReusableDelegationSet operation returned by the service.
- Throws:
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
- At least one of the specified arguments is invalid.InvalidInputException
- Some value specified in the request is invalid or the XML document is malformed.DelegationSetNotAvailableException
- Amazon Route 53 allows some duplicate domain names, but there is a maximum number of duplicate names. This error indicates that you have reached that maximum. If you want to create another hosted zone with the same name and Amazon Route 53 generates this error, you can request an increase to the limit on the Contact Us page.DelegationSetAlreadyReusableException
- The specified delegation set has already been marked as reusable.
-
createTrafficPolicy
public 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).
To create a traffic policy, send a
POST
request to the/Route 53 API version/trafficpolicy
resource. The request body must include a document with aCreateTrafficPolicyRequest
element. The response includes theCreateTrafficPolicyResponse
element, which contains information about the new traffic policy.- Specified by:
createTrafficPolicy
in interfaceAmazonRoute53
- Parameters:
createTrafficPolicyRequest
- A complex type that contains information about the traffic policy that you want to create.- Returns:
- Result of the CreateTrafficPolicy operation returned by the service.
- Throws:
InvalidInputException
- Some value specified in the request is invalid or the XML document is malformed.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 forName
already exists.InvalidTrafficPolicyDocumentException
- The format of the traffic policy document that you specified in theDocument
element is invalid.
-
createTrafficPolicyInstance
public 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 thatCreateTrafficPolicyInstance
created.To create a traffic policy instance, send a
POST
request to the/Route 53 API version/trafficpolicyinstance
resource. The request body must include a document with aCreateTrafficPolicyRequest
element. The response returns theCreateTrafficPolicyInstanceResponse
element, which contains information about the traffic policy instance.- Specified by:
createTrafficPolicyInstance
in interfaceAmazonRoute53
- Parameters:
createTrafficPolicyInstanceRequest
- A complex type that contains information about the resource record sets that you want to create based on a specified traffic policy.- Returns:
- Result of the CreateTrafficPolicyInstance operation returned by the service.
- Throws:
NoSuchHostedZoneException
InvalidInputException
- Some value specified in the request is invalid or the XML document is malformed.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.
-
createTrafficPolicyVersion
public 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).
To create a new version, send a
POST
request to the/Route 53 API version/trafficpolicy/
resource. The request body includes a document with aCreateTrafficPolicyVersionRequest
element. The response returns theCreateTrafficPolicyVersionResponse
element, which contains information about the new version of the traffic policy.- Specified by:
createTrafficPolicyVersion
in interfaceAmazonRoute53
- Parameters:
createTrafficPolicyVersionRequest
- A complex type that contains information about the traffic policy for which you want to create a new version.- Returns:
- Result of the CreateTrafficPolicyVersion operation returned by the service.
-
deleteHealthCheck
This action deletes a health check. To delete a health check, send a
DELETE
request to the/Route 53 API version/healthcheck/health check ID
resource.You can delete a health check only if there are no resource record sets associated with this health check. If resource record sets are associated with this health check, you must disassociate them before you can delete your health check. If you try to delete a health check that is associated with resource record sets, Amazon Route 53 will deny your request with a HealthCheckInUse
error. For information about disassociating the records from your health check, see ChangeResourceRecordSets.- Specified by:
deleteHealthCheck
in interfaceAmazonRoute53
- Parameters:
deleteHealthCheckRequest
- A complex type containing the request information for delete health check.- Returns:
- Result of the DeleteHealthCheck operation returned by the service.
- Throws:
NoSuchHealthCheckException
- The health check you are trying to get or delete does not exist.HealthCheckInUseException
- There are resource records associated with this health check. Before you can delete the health check, you must disassociate it from the resource record sets.InvalidInputException
- Some value specified in the request is invalid or the XML document is malformed.
-
deleteHostedZone
This action deletes a hosted zone. To delete a hosted zone, send a
DELETE
request to the/Route 53 API version/hostedzone/hosted zone ID
resource.For more information about deleting a hosted zone, see Deleting a Hosted Zone in the Amazon Route 53 Developer Guide.
You can delete a hosted zone only if there are no resource record sets other than the default SOA record and NS resource record sets. If your hosted zone contains other resource record sets, you must delete them before you can delete your hosted zone. If you try to delete a hosted zone that contains other resource record sets, Amazon Route 53 will deny your request with a HostedZoneNotEmpty
error. For information about deleting records from your hosted zone, see ChangeResourceRecordSets.- Specified by:
deleteHostedZone
in interfaceAmazonRoute53
- Parameters:
deleteHostedZoneRequest
- A complex type that contains information about the hosted zone that you want to delete.- Returns:
- Result of the DeleteHostedZone operation returned by the service.
- Throws:
NoSuchHostedZoneException
HostedZoneNotEmptyException
- The hosted zone contains resource record sets in addition to the default NS and SOA resource record sets. Before you can delete the hosted zone, you must delete the additional resource record sets.PriorRequestNotCompleteException
- The request was rejected because Amazon Route 53 was still processing a prior request.InvalidInputException
- Some value specified in the request is invalid or the XML document is malformed.
-
deleteReusableDelegationSet
public DeleteReusableDelegationSetResult deleteReusableDelegationSet(DeleteReusableDelegationSetRequest deleteReusableDelegationSetRequest) This action deletes a reusable delegation set. To delete a reusable delegation set, send a
DELETE
request to the/Route 53 API version/delegationset/delegation set ID
resource.You can delete a reusable delegation set only if there are no associated hosted zones. If your reusable delegation set contains associated hosted zones, you must delete them before you can delete your reusable delegation set. If you try to delete a reusable delegation set that contains associated hosted zones, Amazon Route 53 will deny your request with a DelegationSetInUse
error.- Specified by:
deleteReusableDelegationSet
in interfaceAmazonRoute53
- Parameters:
deleteReusableDelegationSetRequest
- A complex type containing the information for the delete request.- Returns:
- Result of the DeleteReusableDelegationSet operation returned by the service.
- Throws:
NoSuchDelegationSetException
- The specified delegation set does not exist.DelegationSetInUseException
- The specified delegation contains associated hosted zones which must be deleted before the reusable delegation set can be deleted.DelegationSetNotReusableException
- The specified delegation set has not been marked as reusable.InvalidInputException
- Some value specified in the request is invalid or the XML document is malformed.
-
deleteTrafficPolicy
public DeleteTrafficPolicyResult deleteTrafficPolicy(DeleteTrafficPolicyRequest deleteTrafficPolicyRequest) Deletes a traffic policy. To delete a traffic policy, send a
DELETE
request to the/Route 53 API version/trafficpolicy
resource.- Specified by:
deleteTrafficPolicy
in interfaceAmazonRoute53
- Parameters:
deleteTrafficPolicyRequest
- A request to delete a specified traffic policy version.- Returns:
- Result of the DeleteTrafficPolicy operation returned by the service.
-
deleteTrafficPolicyInstance
public 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.
To delete a traffic policy instance, send a
DELETE
request to the/Route 53 API version/trafficpolicy/traffic policy instance ID
resource.When you delete a traffic policy instance, Amazon Route 53 also deletes all of the resource record sets that were created when you created the traffic policy instance. - Specified by:
deleteTrafficPolicyInstance
in interfaceAmazonRoute53
- Parameters:
deleteTrafficPolicyInstanceRequest
- A complex type that contains information about the traffic policy instance that you want to delete.- Returns:
- Result of the DeleteTrafficPolicyInstance operation returned by the service.
- Throws:
NoSuchTrafficPolicyInstanceException
- No traffic policy instance exists with the specified ID.InvalidInputException
- Some value specified in the request is invalid or the XML document is malformed.PriorRequestNotCompleteException
- The request was rejected because Amazon Route 53 was still processing a prior request.
-
disassociateVPCFromHostedZone
public DisassociateVPCFromHostedZoneResult disassociateVPCFromHostedZone(DisassociateVPCFromHostedZoneRequest disassociateVPCFromHostedZoneRequest) This action disassociates a VPC from an hosted zone.
To disassociate a VPC to a hosted zone, send a
POST
request to the/Route 53 API version/hostedzone/hosted zone ID/disassociatevpc
resource. The request body must include a document with aDisassociateVPCFromHostedZoneRequest
element. The response returns theDisassociateVPCFromHostedZoneResponse
element that containsChangeInfo
for you to track the progress of theDisassociateVPCFromHostedZoneRequest
you made. SeeGetChange
operation for how to track the progress of your change.- Specified by:
disassociateVPCFromHostedZone
in interfaceAmazonRoute53
- Parameters:
disassociateVPCFromHostedZoneRequest
- A complex type that contains information about the request to disassociate a VPC from an hosted zone.- Returns:
- Result of the DisassociateVPCFromHostedZone operation returned by the service.
- Throws:
NoSuchHostedZoneException
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 byVPCId
does not belong to you.VPCAssociationNotFoundException
- The VPC you specified is not currently associated with the hosted zone.LastVPCAssociationException
- The VPC you are trying to disassociate from the hosted zone is the last the VPC that is associated with the hosted zone. Amazon Route 53 currently doesn't support disassociate the last VPC from the hosted zone.InvalidInputException
- Some value specified in the request is invalid or the XML document is malformed.
-
getChange
This action 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.- Specified by:
getChange
in interfaceAmazonRoute53
- Parameters:
getChangeRequest
- The input for a GetChange request.- Returns:
- Result of the GetChange operation returned by the service.
- Throws:
NoSuchChangeException
InvalidInputException
- Some value specified in the request is invalid or the XML document is malformed.
-
getChangeDetails
@Deprecated public GetChangeDetailsResult getChangeDetails(GetChangeDetailsRequest getChangeDetailsRequest) Deprecated.This action returns the status and changes of a change batch request.
- Specified by:
getChangeDetails
in interfaceAmazonRoute53
- Parameters:
getChangeDetailsRequest
- The input for a GetChangeDetails request.- Returns:
- Result of the GetChangeDetails operation returned by the service.
- Throws:
NoSuchChangeException
InvalidInputException
- Some value specified in the request is invalid or the XML document is malformed.
-
getCheckerIpRanges
public GetCheckerIpRangesResult getCheckerIpRanges(GetCheckerIpRangesRequest getCheckerIpRangesRequest) To retrieve 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/Route 53 API version/checkeripranges
resource. You can use these IP addresses to configure router and firewall rules to allow health checkers to check the health of your resources.- Specified by:
getCheckerIpRanges
in interfaceAmazonRoute53
- Parameters:
getCheckerIpRangesRequest
- Empty request.- Returns:
- Result of the GetCheckerIpRanges operation returned by the service.
-
getCheckerIpRanges
Description copied from interface:AmazonRoute53
Simplified method form for invoking the GetCheckerIpRanges operation.- Specified by:
getCheckerIpRanges
in interfaceAmazonRoute53
- See Also:
-
getGeoLocation
To retrieve a single geo location, send a
GET
request to the/Route 53 API version/geolocation
resource with one of these options: continentcode | countrycode | countrycode and subdivisioncode.- Specified by:
getGeoLocation
in interfaceAmazonRoute53
- Parameters:
getGeoLocationRequest
- A complex type that contains information about the request to get a geo location.- Returns:
- Result of the GetGeoLocation operation returned by the service.
- Throws:
NoSuchGeoLocationException
- The geo location you are trying to get does not exist.InvalidInputException
- Some value specified in the request is invalid or the XML document is malformed.
-
getGeoLocation
Description copied from interface:AmazonRoute53
Simplified method form for invoking the GetGeoLocation operation.- Specified by:
getGeoLocation
in interfaceAmazonRoute53
- See Also:
-
getHealthCheck
To retrieve the health check, send a
GET
request to the/Route 53 API version/healthcheck/health check ID
resource.- Specified by:
getHealthCheck
in interfaceAmazonRoute53
- Parameters:
getHealthCheckRequest
- A complex type that contains information about the request to get a health check.- Returns:
- Result of the GetHealthCheck operation returned by the service.
- Throws:
NoSuchHealthCheckException
- The health check you are trying to get or delete does not exist.InvalidInputException
- Some value specified in the request is invalid or the XML document is malformed.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.
-
getHealthCheckCount
public GetHealthCheckCountResult getHealthCheckCount(GetHealthCheckCountRequest getHealthCheckCountRequest) To retrieve a count of all your health checks, send a
GET
request to the/Route 53 API version/healthcheckcount
resource.- Specified by:
getHealthCheckCount
in interfaceAmazonRoute53
- Parameters:
getHealthCheckCountRequest
- To retrieve a count of all your health checks, send aGET
request to the/Route 53 API version/healthcheckcount
resource.- Returns:
- Result of the GetHealthCheckCount operation returned by the service.
-
getHealthCheckCount
Description copied from interface:AmazonRoute53
Simplified method form for invoking the GetHealthCheckCount operation.- Specified by:
getHealthCheckCount
in interfaceAmazonRoute53
- See Also:
-
getHealthCheckLastFailureReason
public 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/Route 53 API version/healthcheck/health check ID/lastfailurereason
resource.- Specified by:
getHealthCheckLastFailureReason
in interfaceAmazonRoute53
- Parameters:
getHealthCheckLastFailureReasonRequest
- A complex type that contains information about the request to get the most recent failure reason for a health check.- Returns:
- Result of the GetHealthCheckLastFailureReason operation returned by the service.
- Throws:
NoSuchHealthCheckException
- The health check you are trying to get or delete does not exist.InvalidInputException
- Some value specified in the request is invalid or the XML document is malformed.
-
getHealthCheckStatus
public GetHealthCheckStatusResult getHealthCheckStatus(GetHealthCheckStatusRequest getHealthCheckStatusRequest) To retrieve the health check status, send a
GET
request to the/Route 53 API version/healthcheck/health check ID/status
resource. You can use this call to get a health check's current status.- Specified by:
getHealthCheckStatus
in interfaceAmazonRoute53
- Parameters:
getHealthCheckStatusRequest
- A complex type that contains information about the request to get health check status for a health check.- Returns:
- Result of the GetHealthCheckStatus operation returned by the service.
- Throws:
NoSuchHealthCheckException
- The health check you are trying to get or delete does not exist.InvalidInputException
- Some value specified in the request is invalid or the XML document is malformed.
-
getHostedZone
To retrieve the delegation set for a hosted zone, send a
GET
request to the/Route 53 API version/hostedzone/hosted zone ID
resource. The delegation set is the four Amazon Route 53 name servers that were assigned to the hosted zone when you created it.- Specified by:
getHostedZone
in interfaceAmazonRoute53
- Parameters:
getHostedZoneRequest
- The input for a GetHostedZone request.- Returns:
- Result of the GetHostedZone operation returned by the service.
- Throws:
NoSuchHostedZoneException
InvalidInputException
- Some value specified in the request is invalid or the XML document is malformed.
-
getHostedZoneCount
public GetHostedZoneCountResult getHostedZoneCount(GetHostedZoneCountRequest getHostedZoneCountRequest) To retrieve a count of all your hosted zones, send a
GET
request to the/Route 53 API version/hostedzonecount
resource.- Specified by:
getHostedZoneCount
in interfaceAmazonRoute53
- Parameters:
getHostedZoneCountRequest
- To retrieve a count of all your hosted zones, send aGET
request to the/Route 53 API version/hostedzonecount
resource.- Returns:
- Result of the GetHostedZoneCount operation returned by the service.
- Throws:
InvalidInputException
- Some value specified in the request is invalid or the XML document is malformed.
-
getHostedZoneCount
Description copied from interface:AmazonRoute53
Simplified method form for invoking the GetHostedZoneCount operation.- Specified by:
getHostedZoneCount
in interfaceAmazonRoute53
- See Also:
-
getReusableDelegationSet
public GetReusableDelegationSetResult getReusableDelegationSet(GetReusableDelegationSetRequest getReusableDelegationSetRequest) To retrieve the reusable delegation set, send a
GET
request to the/Route 53 API version/delegationset/delegation set ID
resource.- Specified by:
getReusableDelegationSet
in interfaceAmazonRoute53
- Parameters:
getReusableDelegationSetRequest
- The input for aGetReusableDelegationSet
request.- Returns:
- Result of the GetReusableDelegationSet operation returned by the service.
- Throws:
NoSuchDelegationSetException
- The specified delegation set does not exist.DelegationSetNotReusableException
- The specified delegation set has not been marked as reusable.InvalidInputException
- Some value specified in the request is invalid or the XML document is malformed.
-
getTrafficPolicy
Gets information about a specific traffic policy version. To get the information, send a
GET
request to the/Route 53 API version/trafficpolicy
resource.- Specified by:
getTrafficPolicy
in interfaceAmazonRoute53
- Parameters:
getTrafficPolicyRequest
- Gets information about a specific traffic policy version. To get the information, send a GET request to the /Route 53 API version/trafficpolicy resource, and specify the ID and the version of the traffic policy.- Returns:
- Result of the GetTrafficPolicy operation returned by the service.
- Throws:
NoSuchTrafficPolicyException
- No traffic policy exists with the specified ID.InvalidInputException
- Some value specified in the request is invalid or the XML document is malformed.
-
getTrafficPolicyInstance
public GetTrafficPolicyInstanceResult getTrafficPolicyInstance(GetTrafficPolicyInstanceRequest getTrafficPolicyInstanceRequest) Gets information about a specified traffic policy instance.
To get information about the traffic policy instance, send a
GET
request to the/Route 53 API version/trafficpolicyinstance
resource.After you submit a CreateTrafficPolicyInstance
or anUpdateTrafficPolicyInstance
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.- Specified by:
getTrafficPolicyInstance
in interfaceAmazonRoute53
- Parameters:
getTrafficPolicyInstanceRequest
- Gets information about a specified traffic policy instance.To get information about a traffic policy instance, send a
GET
request to the/Route 53 API version/trafficpolicyinstance/Id
resource.- Returns:
- Result of the GetTrafficPolicyInstance operation returned by the service.
- Throws:
NoSuchTrafficPolicyInstanceException
- No traffic policy instance exists with the specified ID.InvalidInputException
- Some value specified in the request is invalid or the XML document is malformed.
-
getTrafficPolicyInstanceCount
public 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/Route 53 API version/trafficpolicyinstancecount
resource.- Specified by:
getTrafficPolicyInstanceCount
in interfaceAmazonRoute53
- Parameters:
getTrafficPolicyInstanceCountRequest
- To retrieve a count of all your traffic policy instances, send aGET
request to the/Route 53 API version/trafficpolicyinstancecount
resource.- Returns:
- Result of the GetTrafficPolicyInstanceCount operation returned by the service.
-
getTrafficPolicyInstanceCount
Description copied from interface:AmazonRoute53
Simplified method form for invoking the GetTrafficPolicyInstanceCount operation.- Specified by:
getTrafficPolicyInstanceCount
in interfaceAmazonRoute53
- See Also:
-
listChangeBatchesByHostedZone
@Deprecated public ListChangeBatchesByHostedZoneResult listChangeBatchesByHostedZone(ListChangeBatchesByHostedZoneRequest listChangeBatchesByHostedZoneRequest) Deprecated.This action gets the list of ChangeBatches in a given time period for a given hosted zone.
- Specified by:
listChangeBatchesByHostedZone
in interfaceAmazonRoute53
- Parameters:
listChangeBatchesByHostedZoneRequest
- The input for a ListChangeBatchesByHostedZone request.- Returns:
- Result of the ListChangeBatchesByHostedZone operation returned by the service.
- Throws:
NoSuchHostedZoneException
InvalidInputException
- Some value specified in the request is invalid or the XML document is malformed.
-
listChangeBatchesByRRSet
@Deprecated public ListChangeBatchesByRRSetResult listChangeBatchesByRRSet(ListChangeBatchesByRRSetRequest listChangeBatchesByRRSetRequest) Deprecated.This action gets the list of ChangeBatches in a given time period for a given hosted zone and RRSet.
- Specified by:
listChangeBatchesByRRSet
in interfaceAmazonRoute53
- Parameters:
listChangeBatchesByRRSetRequest
- The input for a ListChangeBatchesByRRSet request.- Returns:
- Result of the ListChangeBatchesByRRSet operation returned by the service.
- Throws:
NoSuchHostedZoneException
InvalidInputException
- Some value specified in the request is invalid or the XML document is malformed.
-
listGeoLocations
To retrieve a list of supported geo locations, send a
GET
request to the/Route 53 API version/geolocations
resource. The response to this request includes aGeoLocationDetailsList
element with zero, one, or multipleGeoLocationDetails
child elements. The list is sorted by country code, and then subdivision code, followed by continents at the end of the list.By default, the list of geo locations is displayed on a single page. You can control the length of the page that is displayed by using the
MaxItems
parameter. If the list is truncated,IsTruncated
will be set to true and a combination ofNextContinentCode, NextCountryCode, NextSubdivisionCode
will be populated. You can pass these as parameters toStartContinentCode, StartCountryCode, StartSubdivisionCode
to control the geo location that the list begins with.- Specified by:
listGeoLocations
in interfaceAmazonRoute53
- Parameters:
listGeoLocationsRequest
- The input for aListGeoLocations
request.- Returns:
- Result of the ListGeoLocations operation returned by the service.
- Throws:
InvalidInputException
- Some value specified in the request is invalid or the XML document is malformed.
-
listGeoLocations
Description copied from interface:AmazonRoute53
Simplified method form for invoking the ListGeoLocations operation.- Specified by:
listGeoLocations
in interfaceAmazonRoute53
- See Also:
-
listHealthChecks
To retrieve a list of your health checks, send a
GET
request to the/Route 53 API version/healthcheck
resource. The response to this request includes aHealthChecks
element with zero, one, or multipleHealthCheck
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 theMaxItems
parameter. You can use theMarker
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. - Specified by:
listHealthChecks
in interfaceAmazonRoute53
- Parameters:
listHealthChecksRequest
- To retrieve a list of your health checks, send aGET
request to the/Route 53 API version/healthcheck
resource. The response to this request includes aHealthChecks
element with zero or moreHealthCheck
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 theMaxItems
parameter. You can use theMarker
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.- Returns:
- Result of the ListHealthChecks operation returned by the service.
- Throws:
InvalidInputException
- Some value specified in the request is invalid or the XML document is malformed.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.
-
listHealthChecks
Description copied from interface:AmazonRoute53
Simplified method form for invoking the ListHealthChecks operation.- Specified by:
listHealthChecks
in interfaceAmazonRoute53
- See Also:
-
listHostedZones
To retrieve a list of your hosted zones, send a
GET
request to the/Route 53 API version/hostedzone
resource. The response to this request includes aHostedZones
element with zero, one, or multipleHostedZone
child elements. By default, the list of hosted zones is displayed on a single page. You can control the length of the page that is displayed by using theMaxItems
parameter. You can use theMarker
parameter to control the hosted zone 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. - Specified by:
listHostedZones
in interfaceAmazonRoute53
- Parameters:
listHostedZonesRequest
- To retrieve a list of your hosted zones, send aGET
request to the/Route 53 API version/hostedzone
resource. The response to this request includes aHostedZones
element with zero or moreHostedZone
child elements. By default, the list of hosted zones is displayed on a single page. You can control the length of the page that is displayed by using theMaxItems
parameter. You can use theMarker
parameter to control the hosted zone that the list begins with. For more information about listing hosted zones, see Listing the Hosted Zones for an AWS Account in the Amazon Route 53 Developer Guide.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.- Returns:
- Result of the ListHostedZones operation returned by the service.
- Throws:
InvalidInputException
- Some value specified in the request is invalid or the XML document is malformed.NoSuchDelegationSetException
- The specified delegation set does not exist.DelegationSetNotReusableException
- The specified delegation set has not been marked as reusable.
-
listHostedZones
Description copied from interface:AmazonRoute53
Simplified method form for invoking the ListHostedZones operation.- Specified by:
listHostedZones
in interfaceAmazonRoute53
- See Also:
-
listHostedZonesByName
public ListHostedZonesByNameResult listHostedZonesByName(ListHostedZonesByNameRequest listHostedZonesByNameRequest) To retrieve a list of your hosted zones in lexicographic order, send a
GET
request to the/Route 53 API version/hostedzonesbyname
resource. The response to this request includes aHostedZones
element with zero or moreHostedZone
child elements lexicographically ordered by DNS name. By default, the list of hosted zones is displayed on a single page. You can control the length of the page that is displayed by using theMaxItems
parameter. You can use theDNSName
andHostedZoneId
parameters to control the hosted zone 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. - Specified by:
listHostedZonesByName
in interfaceAmazonRoute53
- Parameters:
listHostedZonesByNameRequest
- To retrieve a list of your hosted zones in lexicographic order, send aGET
request to the/Route 53 API version/hostedzonesbyname
resource. The response to this request includes aHostedZones
element with zero or moreHostedZone
child elements lexicographically ordered by DNS name. By default, the list of hosted zones is displayed on a single page. You can control the length of the page that is displayed by using theMaxItems
parameter. You can use theDNSName
andHostedZoneId
parameters to control the hosted zone that the list begins with.For more information about listing hosted zones, see Listing the Hosted Zones for an AWS Account in the Amazon Route 53 Developer Guide.
- Returns:
- Result of the ListHostedZonesByName operation returned by the service.
- Throws:
InvalidInputException
- Some value specified in the request is invalid or the XML document is malformed.InvalidDomainNameException
- This error indicates that the specified domain name is not valid.
-
listHostedZonesByName
Description copied from interface:AmazonRoute53
Simplified method form for invoking the ListHostedZonesByName operation.- Specified by:
listHostedZonesByName
in interfaceAmazonRoute53
- See Also:
-
listResourceRecordSets
public ListResourceRecordSetsResult listResourceRecordSets(ListResourceRecordSetsRequest listResourceRecordSetsRequest) Imagine all the resource record sets in a zone listed out in front of you. Imagine them sorted lexicographically first by DNS name (with the labels reversed, like "com.amazon.www" for example), and secondarily, lexicographically by record type. This operation retrieves at most MaxItems resource record sets from this list, in order, starting at a position specified by the Name and Type arguments:
- If both Name and Type are omitted, this means start the results at the first RRSET in the HostedZone.
- If Name is specified but Type is omitted, this means start the results at the first RRSET in the list whose name is greater than or equal to Name.
- If both Name and Type are specified, this means start the results at the first RRSET in the list whose name is greater than or equal to Name and whose type is greater than or equal to Type.
- It is an error to specify the Type but not the Name.
Use ListResourceRecordSets to retrieve a single known record set by specifying the record set's name and type, and setting MaxItems = 1
To retrieve all the records in a HostedZone, first pause any processes making calls to ChangeResourceRecordSets. Initially call ListResourceRecordSets without a Name and Type to get the first page of record sets. For subsequent calls, set Name and Type to the NextName and NextType values returned by the previous response.
In the presence of concurrent ChangeResourceRecordSets calls, there is no consistency of results across calls to ListResourceRecordSets. The only way to get a consistent multi-page snapshot of all RRSETs in a zone is to stop making changes while pagination is in progress.
However, the results from ListResourceRecordSets are consistent within a page. If MakeChange calls are taking place concurrently, the result of each one will either be completely visible in your results or not at all. You will not see partial changes, or changes that do not ultimately succeed. (This follows from the fact that MakeChange is atomic)
The results from ListResourceRecordSets are strongly consistent with ChangeResourceRecordSets. To be precise, if a single process makes a call to ChangeResourceRecordSets and receives a successful response, the effects of that change will be visible in a subsequent call to ListResourceRecordSets by that process.
- Specified by:
listResourceRecordSets
in interfaceAmazonRoute53
- Parameters:
listResourceRecordSetsRequest
- The input for a ListResourceRecordSets request.- Returns:
- Result of the ListResourceRecordSets operation returned by the service.
- Throws:
NoSuchHostedZoneException
InvalidInputException
- Some value specified in the request is invalid or the XML document is malformed.
-
listReusableDelegationSets
public ListReusableDelegationSetsResult listReusableDelegationSets(ListReusableDelegationSetsRequest listReusableDelegationSetsRequest) To retrieve a list of your reusable delegation sets, send a
GET
request to the/Route 53 API version/delegationset
resource. The response to this request includes aDelegationSets
element with zero, one, or multipleDelegationSet
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 theMaxItems
parameter. You can use theMarker
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. - Specified by:
listReusableDelegationSets
in interfaceAmazonRoute53
- Parameters:
listReusableDelegationSetsRequest
- To retrieve a list of your reusable delegation sets, send aGET
request to the/Route 53 API version/delegationset
resource. The response to this request includes aDelegationSets
element with zero or moreDelegationSet
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 theMaxItems
parameter. You can use theMarker
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.- Returns:
- Result of the ListReusableDelegationSets operation returned by the service.
- Throws:
InvalidInputException
- Some value specified in the request is invalid or the XML document is malformed.
-
listReusableDelegationSets
Description copied from interface:AmazonRoute53
Simplified method form for invoking the ListReusableDelegationSets operation.- Specified by:
listReusableDelegationSets
in interfaceAmazonRoute53
- See Also:
-
listTagsForResource
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) - Specified by:
listTagsForResource
in interfaceAmazonRoute53
- Parameters:
listTagsForResourceRequest
- A complex type containing information about a request for a list of the tags that are associated with an individual resource.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
InvalidInputException
- Some value specified in the request is invalid or the XML document is malformed.NoSuchHealthCheckException
- The health check you are trying to get or delete does not exist.NoSuchHostedZoneException
PriorRequestNotCompleteException
- The request was rejected because Amazon Route 53 was still processing a prior request.ThrottlingException
-
listTagsForResources
public ListTagsForResourcesResult listTagsForResources(ListTagsForResourcesRequest listTagsForResourcesRequest) - Specified by:
listTagsForResources
in interfaceAmazonRoute53
- Parameters:
listTagsForResourcesRequest
- A complex type containing information about a request for a list of the tags that are associated with up to 10 specified resources.- Returns:
- Result of the ListTagsForResources operation returned by the service.
- Throws:
InvalidInputException
- Some value specified in the request is invalid or the XML document is malformed.NoSuchHealthCheckException
- The health check you are trying to get or delete does not exist.NoSuchHostedZoneException
PriorRequestNotCompleteException
- The request was rejected because Amazon Route 53 was still processing a prior request.ThrottlingException
-
listTrafficPolicies
public ListTrafficPoliciesResult listTrafficPolicies(ListTrafficPoliciesRequest listTrafficPoliciesRequest) Gets information about the latest version for every traffic policy that is associated with the current AWS account. To get the information, send a
GET
request to the/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
- TrafficPolicyIdMarker
- MaxItems
If the value of
IsTruncated
in the response istrue
, there are more traffic policies associated with the current AWS account.If
IsTruncated
isfalse
, this response includes the last traffic policy that is associated with the current account.If
IsTruncated
istrue
,TrafficPolicyIdMarker
is the ID of the first traffic policy in the next group ofMaxItems
traffic policies. If you want to list more traffic policies, make another call toListTrafficPolicies
, and specify the value of theTrafficPolicyIdMarker
element from the response in theTrafficPolicyIdMarker
request parameter.If
IsTruncated
isfalse
, theTrafficPolicyIdMarker
element is omitted from the response.The value that you specified for the
MaxItems
parameter in the request that produced the current response.- Specified by:
listTrafficPolicies
in interfaceAmazonRoute53
- Parameters:
listTrafficPoliciesRequest
- A complex type that contains the information about the request to list the traffic policies that are associated with the current AWS account.- Returns:
- Result of the ListTrafficPolicies operation returned by the service.
- Throws:
InvalidInputException
- Some value specified in the request is invalid or the XML document is malformed.
-
listTrafficPolicies
Description copied from interface:AmazonRoute53
Simplified method form for invoking the ListTrafficPolicies operation.- Specified by:
listTrafficPolicies
in interfaceAmazonRoute53
- See Also:
-
listTrafficPolicyInstances
public 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.To get information about the traffic policy instances that are associated with the current AWS account, send a
GET
request to the/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
- MaxItems
- HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker
If the value of
IsTruncated
in the response istrue
, there are more traffic policy instances associated with the current AWS account.If
IsTruncated
isfalse
, this response includes the last traffic policy instance that is associated with the current account.The value that you specified for the
MaxItems
parameter in the request that produced the current response.If
IsTruncated
istrue
, these three values in the response represent the first traffic policy instance in the next group ofMaxItems
traffic policy instances. To list more traffic policy instances, make another call toListTrafficPolicyInstances
, and specify these values in the corresponding request parameters.If
IsTruncated
isfalse
, all three elements are omitted from the response.- Specified by:
listTrafficPolicyInstances
in interfaceAmazonRoute53
- Parameters:
listTrafficPolicyInstancesRequest
- A complex type that contains the information about the request to list your traffic policy instances.- Returns:
- Result of the ListTrafficPolicyInstances operation returned by the service.
- Throws:
InvalidInputException
- Some value specified in the request is invalid or the XML document is malformed.NoSuchTrafficPolicyInstanceException
- No traffic policy instance exists with the specified ID.
-
listTrafficPolicyInstances
Description copied from interface:AmazonRoute53
Simplified method form for invoking the ListTrafficPolicyInstances operation.- Specified by:
listTrafficPolicyInstances
in interfaceAmazonRoute53
- See Also:
-
listTrafficPolicyInstancesByHostedZone
public 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.To get information about the traffic policy instances that you created in a specified hosted zone, send a
GET
request to the/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
- MaxItems
- TrafficPolicyInstanceNameMarker and TrafficPolicyInstanceTypeMarker
If the value of
IsTruncated in the response is
true
, there are more traffic policy instances associated with the current AWS account.If
IsTruncated
isfalse
, this response includes the last traffic policy instance that is associated with the current account.The value that you specified for the
MaxItems
parameter in the request that produced the current response.If
IsTruncated
istrue
, these two values in the response represent the first traffic policy instance in the next group ofMaxItems
traffic policy instances. To list more traffic policy instances, make another call toListTrafficPolicyInstancesByHostedZone
, and specify these values in the corresponding request parameters.If
IsTruncated
isfalse
, all three elements are omitted from the response.- Specified by:
listTrafficPolicyInstancesByHostedZone
in interfaceAmazonRoute53
- Parameters:
listTrafficPolicyInstancesByHostedZoneRequest
- A request for the traffic policy instances that you created in a specified hosted zone.- Returns:
- Result of the ListTrafficPolicyInstancesByHostedZone operation returned by the service.
- Throws:
InvalidInputException
- Some value specified in the request is invalid or the XML document is malformed.NoSuchTrafficPolicyInstanceException
- No traffic policy instance exists with the specified ID.NoSuchHostedZoneException
-
listTrafficPolicyInstancesByPolicy
public 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 anUpdateTrafficPolicyInstance
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.To get information about the traffic policy instances that you created by using a specify traffic policy version, 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 istrue
, there are more traffic policy instances associated with the specified traffic policy.If
IsTruncated
isfalse
, 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
istrue
, these values in the response represent the first traffic policy instance in the next group ofMaxItems
traffic policy instances. To list more traffic policy instances, make another call toListTrafficPolicyInstancesByPolicy
, and specify these values in the corresponding request parameters.If
IsTruncated
isfalse
, all three elements are omitted from the response.
- Specified by:
listTrafficPolicyInstancesByPolicy
in interfaceAmazonRoute53
- Parameters:
listTrafficPolicyInstancesByPolicyRequest
- A complex type that contains the information about the request to list your traffic policy instances.- Returns:
- Result of the ListTrafficPolicyInstancesByPolicy operation returned by the service.
- Throws:
InvalidInputException
- Some value specified in the request is invalid or the XML document is malformed.NoSuchTrafficPolicyInstanceException
- No traffic policy instance exists with the specified ID.NoSuchTrafficPolicyException
- No traffic policy exists with the specified ID.
- IsTruncated
-
listTrafficPolicyVersions
public ListTrafficPolicyVersionsResult listTrafficPolicyVersions(ListTrafficPolicyVersionsRequest listTrafficPolicyVersionsRequest) Gets information about all of the versions for a specified traffic policy.
ListTrafficPolicyVersions
lists only versions that have not been deleted.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
maxitems traffic policies to the next:- IsTruncated
- TrafficPolicyVersionMarker
- MaxItems
If the value of
IsTruncated
in the response istrue
, there are more traffic policy versions associated with the specified traffic policy.If
IsTruncated
isfalse
, this response includes the last traffic policy version that is associated with the specified traffic policy.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 theTrafficPolicyVersionMarker
element in theTrafficPolicyVersionMarker
request parameter.If
IsTruncated
isfalse
, Amazon Route 53 omits theTrafficPolicyVersionMarker
element from the response.The value that you specified for the
MaxItems
parameter in the request that produced the current response.- Specified by:
listTrafficPolicyVersions
in interfaceAmazonRoute53
- Parameters:
listTrafficPolicyVersionsRequest
- A complex type that contains the information about the request to list your traffic policies.- Returns:
- Result of the ListTrafficPolicyVersions operation returned by the service.
- Throws:
InvalidInputException
- Some value specified in the request is invalid or the XML document is malformed.NoSuchTrafficPolicyException
- No traffic policy exists with the specified ID.
-
updateHealthCheck
This action updates an existing health check.
To update a health check, send a
POST
request to the/Route 53 API version/healthcheck/health check ID
resource. The request body must include a document with anUpdateHealthCheckRequest
element. The response returns anUpdateHealthCheckResponse
element, which contains metadata about the health check.- Specified by:
updateHealthCheck
in interfaceAmazonRoute53
- Parameters:
updateHealthCheckRequest
- >A complex type that contains information about the request to update a health check.- Returns:
- Result of the UpdateHealthCheck operation returned by the service.
- Throws:
NoSuchHealthCheckException
- The health check you are trying to get or delete does not exist.InvalidInputException
- Some value specified in the request is invalid or the XML document is malformed.HealthCheckVersionMismatchException
-
updateHostedZoneComment
public UpdateHostedZoneCommentResult updateHostedZoneComment(UpdateHostedZoneCommentRequest updateHostedZoneCommentRequest) To update the hosted zone comment, send a
POST
request to the/Route 53 API version/hostedzone/hosted zone ID
resource. The request body must include a document with aUpdateHostedZoneCommentRequest
element. The response to this request includes the modifiedHostedZone
element.The comment can have a maximum length of 256 characters. - Specified by:
updateHostedZoneComment
in interfaceAmazonRoute53
- Parameters:
updateHostedZoneCommentRequest
- A complex type that contains information about the request to update a hosted zone comment.- Returns:
- Result of the UpdateHostedZoneComment operation returned by the service.
- Throws:
NoSuchHostedZoneException
InvalidInputException
- Some value specified in the request is invalid or the XML document is malformed.
-
updateTrafficPolicyComment
public UpdateTrafficPolicyCommentResult updateTrafficPolicyComment(UpdateTrafficPolicyCommentRequest updateTrafficPolicyCommentRequest) Updates the comment for a specified traffic policy version.
To update the comment, send a
POST
request to the/Route 53 API version/trafficpolicy/
resource.The request body must include a document with an
UpdateTrafficPolicyCommentRequest
element.- Specified by:
updateTrafficPolicyComment
in interfaceAmazonRoute53
- Parameters:
updateTrafficPolicyCommentRequest
- A complex type that contains information about the traffic policy for which you want to update the comment.- Returns:
- Result of the UpdateTrafficPolicyComment operation returned by the service.
-
updateTrafficPolicyInstance
public 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.
The DNS type of the resource record sets that you're updating must match the DNS type in the JSON document that is associated with the traffic policy version that you're using to update the traffic policy instance. 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.
To update a traffic policy instance, send a
POST
request to the/Route 53 API version/trafficpolicyinstance/traffic policy ID
resource. The request body must include a document with anUpdateTrafficPolicyInstanceRequest
element.- Specified by:
updateTrafficPolicyInstance
in interfaceAmazonRoute53
- Parameters:
updateTrafficPolicyInstanceRequest
- A complex type that contains information about the resource record sets that you want to update based on a specified traffic policy instance.- Returns:
- Result of the UpdateTrafficPolicyInstance operation returned by the service.
- Throws:
InvalidInputException
- Some value specified in the request is invalid or the XML document is malformed.NoSuchTrafficPolicyException
- No traffic policy exists with the specified ID.NoSuchTrafficPolicyInstanceException
- No traffic policy instance exists with the specified ID.PriorRequestNotCompleteException
- The request was rejected because Amazon Route 53 was still processing a prior request.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 theCreateTrafficPolicy
orCreateTrafficPolicyVersion
request.
-
getCachedResponseMetadata
Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.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 the request.
- Specified by:
getCachedResponseMetadata
in interfaceAmazonRoute53
- Parameters:
request
- The originally executed request- Returns:
- The response metadata for the specified request, or null if none is available.
-