AWS SDK Version 2 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

.NET Framework 4.5
 
 
Implementation for accessing Route53

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.Route53.AmazonRoute53Client

Namespace: Amazon.Route53
Assembly: AWSSDK.dll
Version: (assembly version)

Syntax

C# 
public class AmazonRoute53Client : AmazonServiceClient
         IAmazonRoute53, IDisposable

The AmazonRoute53Client type exposes the following members

Constructors

NameDescription
Public Method AmazonRoute53Client() Constructs AmazonRoute53Client with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. 
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>
Public Method AmazonRoute53Client(RegionEndpoint) Constructs AmazonRoute53Client with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. 
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>
Public Method AmazonRoute53Client(AmazonRoute53Config) Constructs AmazonRoute53Client with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. 
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>
Public Method AmazonRoute53Client(AWSCredentials) Constructs AmazonRoute53Client with AWS Credentials
Public Method AmazonRoute53Client(AWSCredentials, RegionEndpoint) Constructs AmazonRoute53Client with AWS Credentials
Public Method AmazonRoute53Client(AWSCredentials, AmazonRoute53Config) Constructs AmazonRoute53Client with AWS Credentials and an AmazonRoute53Client Configuration object.
Public Method AmazonRoute53Client(string, string) Constructs AmazonRoute53Client with AWS Access Key ID and AWS Secret Key
Public Method AmazonRoute53Client(string, string, RegionEndpoint) Constructs AmazonRoute53Client with AWS Access Key ID and AWS Secret Key
Public Method AmazonRoute53Client(string, string, AmazonRoute53Config) Constructs AmazonRoute53Client with AWS Access Key ID, AWS Secret Key and an AmazonRoute53Client Configuration object.
Public Method AmazonRoute53Client(string, string, string) Constructs AmazonRoute53Client with AWS Access Key ID and AWS Secret Key
Public Method AmazonRoute53Client(string, string, string, RegionEndpoint) Constructs AmazonRoute53Client with AWS Access Key ID and AWS Secret Key
Public Method AmazonRoute53Client(string, string, string, AmazonRoute53Config) Constructs AmazonRoute53Client with AWS Access Key ID, AWS Secret Key and an AmazonRoute53Client Configuration object.

Methods

NameDescription
Public Method AssociateVPCWithHostedZone(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 a AssociateVPCWithHostedZoneRequest element. The response returns the AssociateVPCWithHostedZoneResponse element that contains ChangeInfo for you to track the progress of the AssociateVPCWithHostedZoneRequest you made. See GetChange operation for how to track the progress of your change.

Public Method AssociateVPCWithHostedZoneAsync(AssociateVPCWithHostedZoneRequest, CancellationToken) Initiates the asynchronous execution of the AssociateVPCWithHostedZone operation.
Public Method ChangeResourceRecordSets(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 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 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 is PENDING. 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 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.
Public Method ChangeResourceRecordSetsAsync(ChangeResourceRecordSetsRequest, CancellationToken) Initiates the asynchronous execution of the ChangeResourceRecordSets operation.
Public Method ChangeTagsForResource(ChangeTagsForResourceRequest)
Public Method ChangeTagsForResourceAsync(ChangeTagsForResourceRequest, CancellationToken) Initiates the asynchronous execution of the ChangeTagsForResource operation.
Public Method CreateHealthCheck(CreateHealthCheckRequest) 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 a CreateHealthCheckRequest element. The response returns the CreateHealthCheckResponse element that contains metadata about the health check.

Public Method CreateHealthCheckAsync(CreateHealthCheckRequest, CancellationToken) Initiates the asynchronous execution of the CreateHealthCheck operation.
Public Method CreateHostedZone(CreateHostedZoneRequest) 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 a CreateHostedZoneRequest element. The response returns the CreateHostedZoneResponse 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 to INSYNC when the NS and SOA records are available on all Amazon Route 53 DNS servers.

When trying to create a hosted zone using a reusable delegation set, you could specify an optional DelegationSetId, and Route53 would assign those 4 NS records for the zone, instead of alloting a new one.

Public Method CreateHostedZoneAsync(CreateHostedZoneRequest, CancellationToken) Initiates the asynchronous execution of the CreateHostedZone operation.
Public Method CreateReusableDelegationSet(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 a CreateReusableDelegationSetRequest element. The response returns the CreateReusableDelegationSetResponse 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.

Public Method CreateReusableDelegationSetAsync(CreateReusableDelegationSetRequest, CancellationToken) Initiates the asynchronous execution of the CreateReusableDelegationSet operation.
Public Method CreateTrafficPolicy(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 a CreateTrafficPolicyRequest element. The response includes the CreateTrafficPolicyResponse element, which contains information about the new traffic policy.

Public Method CreateTrafficPolicyAsync(CreateTrafficPolicyRequest, CancellationToken) Initiates the asynchronous execution of the CreateTrafficPolicy operation.
Public Method CreateTrafficPolicyInstance(CreateTrafficPolicyInstanceRequest) Creates resource record sets in a specified hosted zone based on the settings in a specified traffic policy version. In addition, CreateTrafficPolicyInstance associates the resource record sets with a specified domain name (such as example.com) or subdomain name (such as www.example.com). Amazon Route 53 responds to DNS queries for the domain or subdomain name by using the resource record sets that CreateTrafficPolicyInstance created.

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 a CreateTrafficPolicyRequest element. The response returns the CreateTrafficPolicyInstanceResponse element, which contains information about the traffic policy instance.

Public Method CreateTrafficPolicyInstanceAsync(CreateTrafficPolicyInstanceRequest, CancellationToken) Initiates the asynchronous execution of the CreateTrafficPolicyInstance operation.
Public Method CreateTrafficPolicyVersion(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 a CreateTrafficPolicyVersionRequest element. The response returns the CreateTrafficPolicyVersionResponse element, which contains information about the new version of the traffic policy.

Public Method CreateTrafficPolicyVersionAsync(CreateTrafficPolicyVersionRequest, CancellationToken) Initiates the asynchronous execution of the CreateTrafficPolicyVersion operation.
Public Method DeleteHealthCheck(DeleteHealthCheckRequest) 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.
Public Method DeleteHealthCheckAsync(DeleteHealthCheckRequest, CancellationToken) Initiates the asynchronous execution of the DeleteHealthCheck operation.
Public Method DeleteHostedZone(DeleteHostedZoneRequest) 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.
Public Method DeleteHostedZoneAsync(DeleteHostedZoneRequest, CancellationToken) Initiates the asynchronous execution of the DeleteHostedZone operation.
Public Method DeleteReusableDelegationSet(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.
Public Method DeleteReusableDelegationSetAsync(DeleteReusableDelegationSetRequest, CancellationToken) Initiates the asynchronous execution of the DeleteReusableDelegationSet operation.
Public Method DeleteTrafficPolicy(DeleteTrafficPolicyRequest) Deletes a traffic policy. To delete a traffic policy, send a DELETE request to the /Route 53 API version/trafficpolicy resource.
Public Method DeleteTrafficPolicyAsync(DeleteTrafficPolicyRequest, CancellationToken) Initiates the asynchronous execution of the DeleteTrafficPolicy operation.
Public Method DeleteTrafficPolicyInstance(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.
Public Method DeleteTrafficPolicyInstanceAsync(DeleteTrafficPolicyInstanceRequest, CancellationToken) Initiates the asynchronous execution of the DeleteTrafficPolicyInstance operation.
Public Method DisassociateVPCFromHostedZone(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 a DisassociateVPCFromHostedZoneRequest element. The response returns the DisassociateVPCFromHostedZoneResponse element that contains ChangeInfo for you to track the progress of the DisassociateVPCFromHostedZoneRequest you made. See GetChange operation for how to track the progress of your change.

Public Method DisassociateVPCFromHostedZoneAsync(DisassociateVPCFromHostedZoneRequest, CancellationToken) Initiates the asynchronous execution of the DisassociateVPCFromHostedZone operation.
Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method GetChange(GetChangeRequest) 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.

Public Method GetChangeAsync(GetChangeRequest, CancellationToken) Initiates the asynchronous execution of the GetChange operation.
Public Method GetChangeDetails(GetChangeDetailsRequest) This action returns the status and changes of a change batch request.
Public Method GetChangeDetailsAsync(GetChangeDetailsRequest, CancellationToken) Initiates the asynchronous execution of the GetChangeDetails operation.
Public Method GetCheckerIpRanges(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.
Public Method GetCheckerIpRangesAsync(GetCheckerIpRangesRequest, CancellationToken) Initiates the asynchronous execution of the GetCheckerIpRanges operation.
Public Method GetGeoLocation(GetGeoLocationRequest) 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.
Public Method GetGeoLocationAsync(GetGeoLocationRequest, CancellationToken) Initiates the asynchronous execution of the GetGeoLocation operation.
Public Method GetHealthCheck(GetHealthCheckRequest) To retrieve the health check, send a GET request to the 
/Route
            53 API version/healthcheck/health check ID
resource.
Public Method GetHealthCheckAsync(GetHealthCheckRequest, CancellationToken) Initiates the asynchronous execution of the GetHealthCheck operation.
Public Method GetHealthCheckCount(GetHealthCheckCountRequest) To retrieve a count of all your health checks, send a GET request to the /Route 53 API version/healthcheckcount resource.
Public Method GetHealthCheckCountAsync(GetHealthCheckCountRequest, CancellationToken) Initiates the asynchronous execution of the GetHealthCheckCount operation.
Public Method GetHealthCheckLastFailureReason(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.
Public Method GetHealthCheckLastFailureReasonAsync(GetHealthCheckLastFailureReasonRequest, CancellationToken) Initiates the asynchronous execution of the GetHealthCheckLastFailureReason operation.
Public Method GetHealthCheckStatus(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.
Public Method GetHealthCheckStatusAsync(GetHealthCheckStatusRequest, CancellationToken) Initiates the asynchronous execution of the GetHealthCheckStatus operation.
Public Method GetHostedZone(GetHostedZoneRequest) 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.
Public Method GetHostedZoneAsync(GetHostedZoneRequest, CancellationToken) Initiates the asynchronous execution of the GetHostedZone operation.
Public Method GetHostedZoneCount() To retrieve a count of all your hosted zones, send a GET request to the /Route 53 API version/hostedzonecount resource.
Public Method GetHostedZoneCount(GetHostedZoneCountRequest) To retrieve a count of all your hosted zones, send a GET request to the /Route 53 API version/hostedzonecount resource.
Public Method GetHostedZoneCountAsync(GetHostedZoneCountRequest, CancellationToken) Initiates the asynchronous execution of the GetHostedZoneCount operation.
Public Method GetReusableDelegationSet(GetReusableDelegationSetRequest) To retrieve the reusable delegation set, send a GET request to the 
/Route
            53 API version/delegationset/delegation set ID
resource.
Public Method GetReusableDelegationSetAsync(GetReusableDelegationSetRequest, CancellationToken) Initiates the asynchronous execution of the GetReusableDelegationSet operation.
Public Method GetTrafficPolicy(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.
Public Method GetTrafficPolicyAsync(GetTrafficPolicyRequest, CancellationToken) Initiates the asynchronous execution of the GetTrafficPolicy operation.
Public Method GetTrafficPolicyInstance(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 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.
Public Method GetTrafficPolicyInstanceAsync(GetTrafficPolicyInstanceRequest, CancellationToken) Initiates the asynchronous execution of the GetTrafficPolicyInstance operation.
Public Method GetTrafficPolicyInstanceCount(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.

Public Method GetTrafficPolicyInstanceCountAsync(GetTrafficPolicyInstanceCountRequest, CancellationToken) Initiates the asynchronous execution of the GetTrafficPolicyInstanceCount operation.
Public Method ListChangeBatchesByHostedZone(ListChangeBatchesByHostedZoneRequest) This action gets the list of ChangeBatches in a given time period for a given hosted zone.
Public Method ListChangeBatchesByHostedZoneAsync(ListChangeBatchesByHostedZoneRequest, CancellationToken) Initiates the asynchronous execution of the ListChangeBatchesByHostedZone operation.
Public Method ListChangeBatchesByRRSet(ListChangeBatchesByRRSetRequest) This action gets the list of ChangeBatches in a given time period for a given hosted zone and RRSet.
Public Method ListChangeBatchesByRRSetAsync(ListChangeBatchesByRRSetRequest, CancellationToken) Initiates the asynchronous execution of the ListChangeBatchesByRRSet operation.
Public Method 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 a GeoLocationDetailsList element with zero, one, or multiple GeoLocationDetails 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 of NextContinentCode, NextCountryCode, NextSubdivisionCode will be populated. You can pass these as parameters to 

StartContinentCode, StartCountryCode,
            StartSubdivisionCode
to control the geo location that the list begins with.

Public Method ListGeoLocations(ListGeoLocationsRequest) 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 a GeoLocationDetailsList element with zero, one, or multiple GeoLocationDetails 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 of NextContinentCode, NextCountryCode, NextSubdivisionCode will be populated. You can pass these as parameters to 

StartContinentCode, StartCountryCode,
            StartSubdivisionCode
to control the geo location that the list begins with.

Public Method ListGeoLocationsAsync(ListGeoLocationsRequest, CancellationToken) Initiates the asynchronous execution of the ListGeoLocations operation.
Public Method 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 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. 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.
Public Method ListHealthChecks(ListHealthChecksRequest) 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 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. 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.
Public Method ListHealthChecksAsync(ListHealthChecksRequest, CancellationToken) Initiates the asynchronous execution of the ListHealthChecks operation.
Public Method 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 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. 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.
Public Method ListHostedZones(ListHostedZonesRequest) 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 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. 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.
Public Method ListHostedZonesAsync(ListHostedZonesRequest, CancellationToken) Initiates the asynchronous execution of the ListHostedZones operation.
Public Method ListHostedZonesByName(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 a HostedZones element with zero or more HostedZone 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 the MaxItems parameter. You can use the DNSName and HostedZoneId 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.
Public Method ListHostedZonesByNameAsync(ListHostedZonesByNameRequest, CancellationToken) Initiates the asynchronous execution of the ListHostedZonesByName operation.
Public Method ListResourceRecordSets(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.

Public Method ListResourceRecordSetsAsync(ListResourceRecordSetsRequest, CancellationToken) Initiates the asynchronous execution of the ListResourceRecordSets operation.
Public Method ListReusableDelegationSets() 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 a DelegationSets element with zero, one, or multiple DelegationSet child elements. By default, the list of delegation sets is displayed on a single page. You can control the length of the page that is displayed by using the MaxItems parameter. You can use the Marker parameter to control the delegation set that the list begins with. Amazon Route 53 returns a maximum of 100 items. If you set MaxItems to a value greater than 100, Amazon Route 53 returns only the first 100.
Public Method ListReusableDelegationSets(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 a DelegationSets element with zero, one, or multiple DelegationSet child elements. By default, the list of delegation sets is displayed on a single page. You can control the length of the page that is displayed by using the MaxItems parameter. You can use the Marker parameter to control the delegation set that the list begins with. Amazon Route 53 returns a maximum of 100 items. If you set MaxItems to a value greater than 100, Amazon Route 53 returns only the first 100.
Public Method ListReusableDelegationSetsAsync(ListReusableDelegationSetsRequest, CancellationToken) Initiates the asynchronous execution of the ListReusableDelegationSets operation.
Public Method ListTagsForResource(ListTagsForResourceRequest)
Public Method ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken) Initiates the asynchronous execution of the ListTagsForResource operation.
Public Method ListTagsForResources(ListTagsForResourcesRequest)
Public Method ListTagsForResourcesAsync(ListTagsForResourcesRequest, CancellationToken) Initiates the asynchronous execution of the ListTagsForResources operation.
Public Method ListTrafficPolicies(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

    • If the value of IsTruncated in the response is true, there are more traffic policies associated with the current AWS account.

    If IsTruncated is false, this response includes the last traffic policy that is associated with the current account.

  • TrafficPolicyIdMarker

    • If IsTruncated is true, TrafficPolicyIdMarker is the ID of the first traffic policy in the next group of MaxItems traffic policies. If you want to list more traffic policies, make another call to ListTrafficPolicies, and specify the value of the TrafficPolicyIdMarker element from the response in the TrafficPolicyIdMarker request parameter.

    If IsTruncated is false, the TrafficPolicyIdMarker element is omitted from the response.

  • MaxItems

    • The value that you specified for the MaxItems parameter in the request that produced the current response.

Public Method ListTrafficPoliciesAsync(ListTrafficPoliciesRequest, CancellationToken) Initiates the asynchronous execution of the ListTrafficPolicies operation.
Public Method ListTrafficPolicyInstances(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

    • If the value of IsTruncated in the response is true, there are more traffic policy instances associated with the current AWS account.

    If IsTruncated is false, this response includes the last traffic policy instance that is associated with the current account.

  • MaxItems

    • The value that you specified for the MaxItems parameter in the request that produced the current response.

  • HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker

    • If IsTruncated is true, these three values in the response represent the first traffic policy instance in the next group of MaxItems traffic policy instances. To list more traffic policy instances, make another call to ListTrafficPolicyInstances, and specify these values in the corresponding request parameters.

    If IsTruncated is false, all three elements are omitted from the response.

Public Method ListTrafficPolicyInstancesAsync(ListTrafficPolicyInstancesRequest, CancellationToken) Initiates the asynchronous execution of the ListTrafficPolicyInstances operation.
Public Method ListTrafficPolicyInstancesByHostedZone(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

    • If the value of IsTruncated in the response is true, there are more traffic policy instances associated with the current AWS account.

    If IsTruncated is false, this response includes the last traffic policy instance that is associated with the current account.

  • MaxItems

    • The value that you specified for the MaxItems parameter in the request that produced the current response.

  • TrafficPolicyInstanceNameMarker and TrafficPolicyInstanceTypeMarker

    • If IsTruncated is true, these two values in the response represent the first traffic policy instance in the next group of MaxItems traffic policy instances. To list more traffic policy instances, make another call to ListTrafficPolicyInstancesByHostedZone, and specify these values in the corresponding request parameters.

    If IsTruncated is false, all three elements are omitted from the response.

Public Method ListTrafficPolicyInstancesByHostedZoneAsync(ListTrafficPolicyInstancesByHostedZoneRequest, CancellationToken) Initiates the asynchronous execution of the ListTrafficPolicyInstancesByHostedZone operation.
Public Method ListTrafficPolicyInstancesByPolicy(ListTrafficPolicyInstancesByPolicyRequest) Gets information about the traffic policy instances that you created by using a specify traffic policy version. After you submit a CreateTrafficPolicyInstance or an UpdateTrafficPolicyInstance request, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, see the State response element.

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 is true, there are more traffic policy instances associated with the specified traffic policy.

    If IsTruncated is false, this response includes the last traffic policy instance that is associated with the specified traffic policy.

  • MaxItems

    The value that you specified for the MaxItems parameter in the request that produced the current response.

  • HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker

    If IsTruncated is true, these values in the response represent the first traffic policy instance in the next group of MaxItems traffic policy instances. To list more traffic policy instances, make another call to ListTrafficPolicyInstancesByPolicy, and specify these values in the corresponding request parameters.

    If IsTruncated is false, all three elements are omitted from the response.

Public Method ListTrafficPolicyInstancesByPolicyAsync(ListTrafficPolicyInstancesByPolicyRequest, CancellationToken) Initiates the asynchronous execution of the ListTrafficPolicyInstancesByPolicy operation.
Public Method ListTrafficPolicyVersions(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 maxitemsmaxitems traffic policies to the next:

  • IsTruncated

    • If the value of IsTruncated in the response is true, there are more traffic policy versions associated with the specified traffic policy.

    If IsTruncated is false, this response includes the last traffic policy version that is associated with the specified traffic policy.

  • TrafficPolicyVersionMarker

    • The ID of the next traffic policy version that is associated with the current AWS account. If you want to list more traffic policies, make another call to ListTrafficPolicyVersions, and specify the value of the TrafficPolicyVersionMarker element in the TrafficPolicyVersionMarker request parameter.

    If IsTruncated is false, Amazon Route 53 omits the TrafficPolicyVersionMarker element from the response.

  • MaxItems

    • The value that you specified for the MaxItems parameter in the request that produced the current response.

Public Method ListTrafficPolicyVersionsAsync(ListTrafficPolicyVersionsRequest, CancellationToken) Initiates the asynchronous execution of the ListTrafficPolicyVersions operation.
Public Method UpdateHealthCheck(UpdateHealthCheckRequest) 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 an UpdateHealthCheckRequest element. The response returns an UpdateHealthCheckResponse element, which contains metadata about the health check.

Public Method UpdateHealthCheckAsync(UpdateHealthCheckRequest, CancellationToken) Initiates the asynchronous execution of the UpdateHealthCheck operation.
Public Method UpdateHostedZoneComment(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 a UpdateHostedZoneCommentRequest element. The response to this request includes the modified HostedZone element. The comment can have a maximum length of 256 characters.
Public Method UpdateHostedZoneCommentAsync(UpdateHostedZoneCommentRequest, CancellationToken) Initiates the asynchronous execution of the UpdateHostedZoneComment operation.
Public Method UpdateTrafficPolicyComment(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.

Public Method UpdateTrafficPolicyCommentAsync(UpdateTrafficPolicyCommentRequest, CancellationToken) Initiates the asynchronous execution of the UpdateTrafficPolicyComment operation.
Public Method UpdateTrafficPolicyInstance(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:

  1. 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.
  2. 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.
  3. 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 an UpdateTrafficPolicyInstanceRequest element.

Public Method UpdateTrafficPolicyInstanceAsync(UpdateTrafficPolicyInstanceRequest, CancellationToken) Initiates the asynchronous execution of the UpdateTrafficPolicyInstance operation.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

.NET for Windows Store apps:
Supported in: Windows 8