|
Did this page help you?Yes No Tell us about it... |
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.amazonaws.AmazonWebServiceClient
com.amazonaws.services.route53.AmazonRoute53Client
public class AmazonRoute53Client
Client for accessing AmazonRoute53. All service calls made using this client are blocking, and will not return until the service call completes.
Constructor Summary | |
---|---|
AmazonRoute53Client()
Constructs a new client to invoke service methods on AmazonRoute53. |
|
AmazonRoute53Client(AWSCredentials awsCredentials)
Constructs a new client to invoke service methods on AmazonRoute53 using the specified AWS account credentials. |
|
AmazonRoute53Client(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on AmazonRoute53 using the specified AWS account credentials and client configuration options. |
|
AmazonRoute53Client(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new client to invoke service methods on AmazonRoute53 using the specified AWS account credentials provider. |
|
AmazonRoute53Client(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on AmazonRoute53 using the specified AWS account credentials provider and client configuration options. |
|
AmazonRoute53Client(ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on AmazonRoute53. |
Method Summary | |
---|---|
ChangeResourceRecordSetsResult |
changeResourceRecordSets(ChangeResourceRecordSetsRequest changeResourceRecordSetsRequest)
Use this action to create or change your authoritative DNS information. |
CreateHealthCheckResult |
createHealthCheck(CreateHealthCheckRequest createHealthCheckRequest)
This action creates a new health check. |
CreateHostedZoneResult |
createHostedZone(CreateHostedZoneRequest createHostedZoneRequest)
This action creates a new hosted zone. |
DeleteHealthCheckResult |
deleteHealthCheck(DeleteHealthCheckRequest deleteHealthCheckRequest)
This action deletes a health check. |
DeleteHostedZoneResult |
deleteHostedZone(DeleteHostedZoneRequest deleteHostedZoneRequest)
This action deletes a 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)
This action returns the current status of a change batch request. |
GetHealthCheckResult |
getHealthCheck(GetHealthCheckRequest getHealthCheckRequest)
To retrieve the health check, send a GET request to the
2012-12-12/healthcheck/health check ID resource. |
GetHostedZoneResult |
getHostedZone(GetHostedZoneRequest getHostedZoneRequest)
To retrieve the delegation set for a hosted zone, send a GET request to the 2012-12-12/hostedzone/hosted
zone ID resource. |
ListHealthChecksResult |
listHealthChecks()
To retrieve a list of your health checks, send a GET
request to the 2012-12-12/healthcheck resource. |
ListHealthChecksResult |
listHealthChecks(ListHealthChecksRequest listHealthChecksRequest)
To retrieve a list of your health checks, send a GET
request to the 2012-12-12/healthcheck resource. |
ListHostedZonesResult |
listHostedZones()
To retrieve a list of your hosted zones, send a GET
request to the 2012-12-12/hostedzone resource. |
ListHostedZonesResult |
listHostedZones(ListHostedZonesRequest listHostedZonesRequest)
To retrieve a list of your hosted zones, send a GET
request to the 2012-12-12/hostedzone resource. |
ListResourceRecordSetsResult |
listResourceRecordSets(ListResourceRecordSetsRequest listResourceRecordSetsRequest)
Imagine all the resource record sets in a zone listed out in front of you. |
Methods inherited from class com.amazonaws.AmazonWebServiceClient |
---|
addRequestHandler, getTimeOffset, removeRequestHandler, setConfiguration, setEndpoint, setRegion, setTimeOffset, shutdown, withTimeOffset |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.amazonaws.services.route53.AmazonRoute53 |
---|
setEndpoint, setRegion, shutdown |
Constructor Detail |
---|
public AmazonRoute53Client()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProvider
public AmazonRoute53Client(ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration
- The client configuration options controlling how this
client connects to AmazonRoute53
(ex: proxy settings, retry counts, etc.).DefaultAWSCredentialsProvider
public AmazonRoute53Client(AWSCredentials awsCredentials)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use
when authenticating with AWS services.public AmazonRoute53Client(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
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 AmazonRoute53
(ex: proxy settings, retry counts, etc.).public AmazonRoute53Client(AWSCredentialsProvider awsCredentialsProvider)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials
to authenticate requests with AWS services.public AmazonRoute53Client(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
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 AmazonRoute53
(ex: proxy settings, retry counts, etc.).Method Detail |
---|
public ListResourceRecordSetsResult listResourceRecordSets(ListResourceRecordSetsRequest listResourceRecordSetsRequest) throws AmazonServiceException, AmazonClientException
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:
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.
listResourceRecordSets
in interface AmazonRoute53
listResourceRecordSetsRequest
- Container for the necessary
parameters to execute the ListResourceRecordSets service method on
AmazonRoute53.
InvalidInputException
NoSuchHostedZoneException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AmazonRoute53 indicating
either a problem with the data in the request, or a server side issue.public ChangeResourceRecordSetsResult changeResourceRecordSets(ChangeResourceRecordSetsRequest changeResourceRecordSetsRequest) throws AmazonServiceException, AmazonClientException
Use this action to create or change your authoritative DNS
information. To use this action, send a POST
request to
the 2012-12-12/hostedzone/hosted Zone ID/rrset
resource.
The request body must include an XML document with a
ChangeResourceRecordSetsRequest
element.
Changes are a list of change items and are considered transactional. For more information on transactional changes, also known as change batches, see Creating, Changing, and Deleting Resource Record Sets Using the Route 53 API in the Amazon Route 53 Developer Guide .
IMPORTANT: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, Route 53 returns an InvalidChangeBatch error.
In response to a ChangeResourceRecordSets
request, your
DNS data is changed on all Route 53 DNS servers. Initially, the status
of a change is PENDING
. This means the change has not
yet propagated to all the authoritative Route 53 DNS servers. When the
change is propagated to all hosts, the change returns a status of
INSYNC
.
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.
changeResourceRecordSets
in interface AmazonRoute53
changeResourceRecordSetsRequest
- Container for the necessary
parameters to execute the ChangeResourceRecordSets service method on
AmazonRoute53.
InvalidInputException
NoSuchHostedZoneException
InvalidChangeBatchException
NoSuchHealthCheckException
PriorRequestNotCompleteException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AmazonRoute53 indicating
either a problem with the data in the request, or a server side issue.public CreateHostedZoneResult createHostedZone(CreateHostedZoneRequest createHostedZoneRequest) throws AmazonServiceException, AmazonClientException
This action creates a new hosted zone.
To create a new hosted zone, send a POST
request to the
2012-12-12/hostedzone
resource. The request body must
include an XML document with a CreateHostedZoneRequest
element. The response returns the
CreateHostedZoneResponse
element that contains metadata
about the hosted zone.
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 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 to INSYNC
when the NS and SOA records
are available on all Route 53 DNS servers.
createHostedZone
in interface AmazonRoute53
createHostedZoneRequest
- Container for the necessary parameters
to execute the CreateHostedZone service method on AmazonRoute53.
HostedZoneAlreadyExistsException
InvalidInputException
InvalidDomainNameException
TooManyHostedZonesException
DelegationSetNotAvailableException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AmazonRoute53 indicating
either a problem with the data in the request, or a server side issue.public GetHealthCheckResult getHealthCheck(GetHealthCheckRequest getHealthCheckRequest) throws AmazonServiceException, AmazonClientException
To retrieve the health check, send a GET
request to the
2012-12-12/healthcheck/health check ID
resource.
getHealthCheck
in interface AmazonRoute53
getHealthCheckRequest
- Container for the necessary parameters to
execute the GetHealthCheck service method on AmazonRoute53.
InvalidInputException
NoSuchHealthCheckException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AmazonRoute53 indicating
either a problem with the data in the request, or a server side issue.public CreateHealthCheckResult createHealthCheck(CreateHealthCheckRequest createHealthCheckRequest) throws AmazonServiceException, AmazonClientException
This action creates a new health check.
To create a new health check, send a POST
request to the
2012-12-12/healthcheck
resource. The request body must
include an XML document with a CreateHealthCheckRequest
element. The response returns the
CreateHealthCheckResponse
element that contains metadata
about the health check.
createHealthCheck
in interface AmazonRoute53
createHealthCheckRequest
- Container for the necessary parameters
to execute the CreateHealthCheck service method on AmazonRoute53.
InvalidInputException
HealthCheckAlreadyExistsException
TooManyHealthChecksException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AmazonRoute53 indicating
either a problem with the data in the request, or a server side issue.public GetChangeResult getChange(GetChangeRequest getChangeRequest) throws AmazonServiceException, AmazonClientException
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 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.
getChange
in interface AmazonRoute53
getChangeRequest
- Container for the necessary parameters to
execute the GetChange service method on AmazonRoute53.
NoSuchChangeException
InvalidInputException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AmazonRoute53 indicating
either a problem with the data in the request, or a server side issue.public DeleteHealthCheckResult deleteHealthCheck(DeleteHealthCheckRequest deleteHealthCheckRequest) throws AmazonServiceException, AmazonClientException
This action deletes a health check. To delete a health check, send a
DELETE
request to the 2012-12-12/healthcheck/health
check ID
resource.
IMPORTANT: 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, Route 53 will deny your request with a HealthCheckInUse error. For information about disassociating the records from your health check, see ChangeResourceRecordSets.
deleteHealthCheck
in interface AmazonRoute53
deleteHealthCheckRequest
- Container for the necessary parameters
to execute the DeleteHealthCheck service method on AmazonRoute53.
InvalidInputException
HealthCheckInUseException
NoSuchHealthCheckException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AmazonRoute53 indicating
either a problem with the data in the request, or a server side issue.public GetHostedZoneResult getHostedZone(GetHostedZoneRequest getHostedZoneRequest) throws AmazonServiceException, AmazonClientException
To retrieve the delegation set for a hosted zone, send a
GET
request to the 2012-12-12/hostedzone/hosted
zone ID
resource. The delegation set is the four Route 53 name
servers that were assigned to the hosted zone when you created it.
getHostedZone
in interface AmazonRoute53
getHostedZoneRequest
- Container for the necessary parameters to
execute the GetHostedZone service method on AmazonRoute53.
InvalidInputException
NoSuchHostedZoneException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AmazonRoute53 indicating
either a problem with the data in the request, or a server side issue.public ListHostedZonesResult listHostedZones(ListHostedZonesRequest listHostedZonesRequest) throws AmazonServiceException, AmazonClientException
To retrieve a list of your hosted zones, send a GET
request to the 2012-12-12/hostedzone
resource. The
response to this request includes a HostedZones
element
with zero, one, or multiple HostedZone
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 the
MaxItems
parameter. You can use the Marker
parameter to control the hosted zone that the list begins with.
NOTE: 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.
listHostedZones
in interface AmazonRoute53
listHostedZonesRequest
- Container for the necessary parameters
to execute the ListHostedZones service method on AmazonRoute53.
InvalidInputException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AmazonRoute53 indicating
either a problem with the data in the request, or a server side issue.public DeleteHostedZoneResult deleteHostedZone(DeleteHostedZoneRequest deleteHostedZoneRequest) throws AmazonServiceException, AmazonClientException
This action deletes a hosted zone. To delete a hosted zone, send a
DELETE
request to the 2012-12-12/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 .
IMPORTANT: 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, Route 53 will deny your request with a HostedZoneNotEmpty error. For information about deleting records from your hosted zone, see ChangeResourceRecordSets.
deleteHostedZone
in interface AmazonRoute53
deleteHostedZoneRequest
- Container for the necessary parameters
to execute the DeleteHostedZone service method on AmazonRoute53.
HostedZoneNotEmptyException
InvalidInputException
NoSuchHostedZoneException
PriorRequestNotCompleteException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AmazonRoute53 indicating
either a problem with the data in the request, or a server side issue.public ListHealthChecksResult listHealthChecks(ListHealthChecksRequest listHealthChecksRequest) throws AmazonServiceException, AmazonClientException
To retrieve a list of your health checks, send a GET
request to the 2012-12-12/healthcheck
resource. The
response to this request includes a HealthChecks
element
with zero, one, or multiple 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.
NOTE: 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.
listHealthChecks
in interface AmazonRoute53
listHealthChecksRequest
- Container for the necessary parameters
to execute the ListHealthChecks service method on AmazonRoute53.
InvalidInputException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AmazonRoute53 indicating
either a problem with the data in the request, or a server side issue.public ListHostedZonesResult listHostedZones() throws AmazonServiceException, AmazonClientException
To retrieve a list of your hosted zones, send a GET
request to the 2012-12-12/hostedzone
resource. The
response to this request includes a HostedZones
element
with zero, one, or multiple HostedZone
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 the
MaxItems
parameter. You can use the Marker
parameter to control the hosted zone that the list begins with.
NOTE: 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.
listHostedZones
in interface AmazonRoute53
InvalidInputException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AmazonRoute53 indicating
either a problem with the data in the request, or a server side issue.public ListHealthChecksResult listHealthChecks() throws AmazonServiceException, AmazonClientException
To retrieve a list of your health checks, send a GET
request to the 2012-12-12/healthcheck
resource. The
response to this request includes a HealthChecks
element
with zero, one, or multiple 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.
NOTE: 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.
listHealthChecks
in interface AmazonRoute53
InvalidInputException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AmazonRoute53 indicating
either a problem with the data in the request, or a server side issue.public 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 the request.
getCachedResponseMetadata
in interface AmazonRoute53
request
- The originally executed request
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |