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
 

Classes

NameDescription
Class AliasTarget Alias resource record sets only: Information about the CloudFront distribution, ELB load balancer, Amazon S3 bucket, or Amazon Route 53 resource record set to which you are routing traffic.

If you're creating resource record sets for a private hosted zone, note the following:

  • You can create alias resource record sets only for Amazon Route 53 resource record sets in the same private hosted zone. Creating alias resource record sets for CloudFront distributions, ELB load balancers, and Amazon S3 buckets is not supported.
  • You can't create alias resource record sets for failover, geolocation, or latency resource record sets in a private hosted zone.

For more information and an example, see Example: Creating Alias Resource Record Sets in the Amazon Route 53 API Reference.

Class AssociateVPCWithHostedZoneRequest Container for the parameters to the AssociateVPCWithHostedZone operation. 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.

Class AssociateVPCWithHostedZoneResponse Configuration for accessing Amazon AssociateVPCWithHostedZone service
Class AssociateVPCWithHostedZoneResult A complex type containing the response information for the request.
Class Change A complex type that contains the information for each change in a change batch request.
Class ChangeBatch A complex type that contains an optional comment and the changes that you want to make with a change batch request.
Class ChangeBatchRecord A complex type that lists the changes and information for a ChangeBatch.
Class ChangeInfo A complex type that describes change information about changes made to your hosted zone.

This element contains an ID that you use when performing a GetChange action to get detailed information about the change.

Class ChangeResourceRecordSetsRequest Container for the parameters to the ChangeResourceRecordSets operation. 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.
Class ChangeResourceRecordSetsResponse Configuration for accessing Amazon ChangeResourceRecordSets service
Class ChangeResourceRecordSetsResult A complex type containing the response for the request.
Class ChangeTagsForResourceRequest Container for the parameters to the ChangeTagsForResource operation.
Class ChangeTagsForResourceResponse Configuration for accessing Amazon ChangeTagsForResource service
Class ChangeTagsForResourceResult Empty response for the request.
Class ConcurrentModificationException Route53 exception
Class ConflictingDomainExistsException Route53 exception
Class ConflictingTypesException Route53 exception
Class CreateHealthCheckRequest Container for the parameters to the CreateHealthCheck operation. 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.

Class CreateHealthCheckResponse Configuration for accessing Amazon CreateHealthCheck service
Class CreateHealthCheckResult A complex type containing the response information for the new health check.
Class CreateHostedZoneRequest Container for the parameters to the CreateHostedZone operation. 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.

Class CreateHostedZoneResponse Configuration for accessing Amazon CreateHostedZone service
Class CreateHostedZoneResult A complex type containing the response information for the new hosted zone.
Class CreateReusableDelegationSetRequest Container for the parameters to the CreateReusableDelegationSet operation. 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.

Class CreateReusableDelegationSetResponse Configuration for accessing Amazon CreateReusableDelegationSet service
Class CreateReusableDelegationSetResult
Class CreateTrafficPolicyInstanceRequest Container for the parameters to the CreateTrafficPolicyInstance operation. 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.

Class CreateTrafficPolicyInstanceResponse Configuration for accessing Amazon CreateTrafficPolicyInstance service
Class CreateTrafficPolicyInstanceResult A complex type that contains the response information for the CreateTrafficPolicyInstance request.
Class CreateTrafficPolicyRequest Container for the parameters to the CreateTrafficPolicy operation. 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.

Class CreateTrafficPolicyResponse Configuration for accessing Amazon CreateTrafficPolicy service
Class CreateTrafficPolicyResult A complex type that contains the response information for the CreateTrafficPolicy request.
Class CreateTrafficPolicyVersionRequest Container for the parameters to the CreateTrafficPolicyVersion operation. 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.

Class CreateTrafficPolicyVersionResponse Configuration for accessing Amazon CreateTrafficPolicyVersion service
Class CreateTrafficPolicyVersionResult A complex type that contains the response information for the CreateTrafficPolicyVersion request.
Class DelegationSet A complex type that contains name server information.
Class DelegationSetAlreadyCreatedException Route53 exception
Class DelegationSetAlreadyReusableException Route53 exception
Class DelegationSetInUseException Route53 exception
Class DelegationSetNotAvailableException Route53 exception
Class DelegationSetNotReusableException Route53 exception
Class DeleteHealthCheckRequest Container for the parameters to the DeleteHealthCheck operation. 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.
Class DeleteHealthCheckResponse Configuration for accessing Amazon DeleteHealthCheck service
Class DeleteHealthCheckResult Empty response for the request.
Class DeleteHostedZoneRequest Container for the parameters to the DeleteHostedZone operation. 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.
Class DeleteHostedZoneResponse Configuration for accessing Amazon DeleteHostedZone service
Class DeleteHostedZoneResult A complex type containing the response information for the request.
Class DeleteReusableDelegationSetRequest Container for the parameters to the DeleteReusableDelegationSet operation. 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.
Class DeleteReusableDelegationSetResponse Configuration for accessing Amazon DeleteReusableDelegationSet service
Class DeleteReusableDelegationSetResult Empty response for the request.
Class DeleteTrafficPolicyInstanceRequest Container for the parameters to the DeleteTrafficPolicyInstance operation. 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.
Class DeleteTrafficPolicyInstanceResponse Configuration for accessing Amazon DeleteTrafficPolicyInstance service
Class DeleteTrafficPolicyInstanceResult An empty element.
Class DeleteTrafficPolicyRequest Container for the parameters to the DeleteTrafficPolicy operation. Deletes a traffic policy. To delete a traffic policy, send a DELETE request to the /Route 53 API version/trafficpolicy resource.
Class DeleteTrafficPolicyResponse Configuration for accessing Amazon DeleteTrafficPolicy service
Class DeleteTrafficPolicyResult An empty element.
Class DisassociateVPCFromHostedZoneRequest Container for the parameters to the DisassociateVPCFromHostedZone operation. 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.

Class DisassociateVPCFromHostedZoneResponse Configuration for accessing Amazon DisassociateVPCFromHostedZone service
Class DisassociateVPCFromHostedZoneResult A complex type containing the response information for the request.
Class GeoLocation A complex type that contains information about a geo location.
Class GeoLocationDetails A complex type that contains information about a GeoLocation.
Class GetChangeDetailsRequest Container for the parameters to the GetChangeDetails operation. This action returns the status and changes of a change batch request.
Class GetChangeDetailsResponse Configuration for accessing Amazon GetChangeDetails service
Class GetChangeDetailsResult A complex type that contains the ChangeBatchRecord element.
Class GetChangeRequest Container for the parameters to the GetChange operation. 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.

Class GetChangeResponse Configuration for accessing Amazon GetChange service
Class GetChangeResult A complex type that contains the ChangeInfo element.
Class GetCheckerIpRangesRequest Container for the parameters to the GetCheckerIpRanges operation. 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.
Class GetCheckerIpRangesResponse Configuration for accessing Amazon GetCheckerIpRanges service
Class GetCheckerIpRangesResult A complex type that contains the CheckerIpRanges element.
Class GetGeoLocationRequest Container for the parameters to the GetGeoLocation operation. 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.
Class GetGeoLocationResponse Configuration for accessing Amazon GetGeoLocation service
Class GetGeoLocationResult A complex type containing information about the specified geo location.
Class GetHealthCheckCountRequest Container for the parameters to the GetHealthCheckCount operation. To retrieve a count of all your health checks, send a GET request to the /Route 53 API version/healthcheckcount resource.
Class GetHealthCheckCountResponse Configuration for accessing Amazon GetHealthCheckCount service
Class GetHealthCheckCountResult A complex type that contains the count of health checks associated with the current AWS account.
Class GetHealthCheckLastFailureReasonRequest Container for the parameters to the GetHealthCheckLastFailureReason operation. 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.
Class GetHealthCheckLastFailureReasonResponse Configuration for accessing Amazon GetHealthCheckLastFailureReason service
Class GetHealthCheckLastFailureReasonResult A complex type that contains information about the most recent failure for the specified health check.
Class GetHealthCheckRequest Container for the parameters to the GetHealthCheck operation. To retrieve the health check, send a GET request to the
/Route
            53 API version/healthcheck/health check ID
resource.
Class GetHealthCheckResponse Configuration for accessing Amazon GetHealthCheck service
Class GetHealthCheckResult A complex type containing information about the specified health check.
Class GetHealthCheckStatusRequest Container for the parameters to the GetHealthCheckStatus operation. 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.
Class GetHealthCheckStatusResponse Configuration for accessing Amazon GetHealthCheckStatus service
Class GetHealthCheckStatusResult A complex type that contains information about the status of the specified health check.
Class GetHostedZoneCountRequest Container for the parameters to the GetHostedZoneCount operation. To retrieve a count of all your hosted zones, send a GET request to the /Route 53 API version/hostedzonecount resource.
Class GetHostedZoneCountResponse Configuration for accessing Amazon GetHostedZoneCount service
Class GetHostedZoneCountResult A complex type that contains the count of hosted zones associated with the current AWS account.
Class GetHostedZoneRequest Container for the parameters to the GetHostedZone operation. 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.
Class GetHostedZoneResponse Configuration for accessing Amazon GetHostedZone service
Class GetHostedZoneResult A complex type containing information about the specified hosted zone.
Class GetReusableDelegationSetRequest Container for the parameters to the GetReusableDelegationSet operation. To retrieve the reusable delegation set, send a GET request to the
/Route
            53 API version/delegationset/delegation set ID
resource.
Class GetReusableDelegationSetResponse Configuration for accessing Amazon GetReusableDelegationSet service
Class GetReusableDelegationSetResult A complex type containing information about the specified reusable delegation set.
Class GetTrafficPolicyInstanceCountRequest Container for the parameters to the GetTrafficPolicyInstanceCount operation. 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.

Class GetTrafficPolicyInstanceCountResponse Configuration for accessing Amazon GetTrafficPolicyInstanceCount service
Class GetTrafficPolicyInstanceCountResult A complex type that contains information about the number of traffic policy instances that are associated with the current AWS account.
Class GetTrafficPolicyInstanceRequest Container for the parameters to the GetTrafficPolicyInstance operation. 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.
Class GetTrafficPolicyInstanceResponse Configuration for accessing Amazon GetTrafficPolicyInstance service
Class GetTrafficPolicyInstanceResult A complex type that contains information about the resource record sets that Amazon Route 53 created based on a specified traffic policy.
Class GetTrafficPolicyRequest Container for the parameters to the GetTrafficPolicy operation. Gets information about a specific traffic policy version. To get the information, send a GET request to the /Route 53 API version/trafficpolicy resource.
Class GetTrafficPolicyResponse Configuration for accessing Amazon GetTrafficPolicy service
Class GetTrafficPolicyResult A complex type that contains the response information for the request.
Class HealthCheck A complex type that contains identifying information about the health check.
Class HealthCheckAlreadyExistsException Route53 exception
Class HealthCheckConfig A complex type that contains the health check configuration.
Class HealthCheckInUseException Route53 exception
Class HealthCheckObservation A complex type that contains the IP address of a Amazon Route 53 health checker and the reason for the health check status.
Class HealthCheckVersionMismatchException Route53 exception
Class HostedZone A complex type that contain information about the specified hosted zone.
Class HostedZoneAlreadyExistsException Route53 exception
Class HostedZoneConfig A complex type that contains an optional comment about your hosted zone. If you don't want to specify a comment, you can omit the HostedZoneConfig and Comment elements from the XML document.
Class HostedZoneNotEmptyException Route53 exception
Class HostedZoneNotFoundException Route53 exception
Class IncompatibleVersionException Route53 exception
Class InvalidArgumentException Route53 exception
Class InvalidChangeBatchException Route53 exception
Class InvalidDomainNameException Route53 exception
Class InvalidInputException Route53 exception
Class InvalidTrafficPolicyDocumentException Route53 exception
Class InvalidVPCIdException Route53 exception
Class LastVPCAssociationException Route53 exception
Class LimitsExceededException Route53 exception
Class ListChangeBatchesByHostedZoneRequest Container for the parameters to the ListChangeBatchesByHostedZone operation. This action gets the list of ChangeBatches in a given time period for a given hosted zone.
Class ListChangeBatchesByHostedZoneResponse Configuration for accessing Amazon ListChangeBatchesByHostedZone service
Class ListChangeBatchesByHostedZoneResult The input for a ListChangeBatchesByHostedZone request.
Class ListChangeBatchesByRRSetRequest Container for the parameters to the ListChangeBatchesByRRSet operation. This action gets the list of ChangeBatches in a given time period for a given hosted zone and RRSet.
Class ListChangeBatchesByRRSetResponse Configuration for accessing Amazon ListChangeBatchesByRRSet service
Class ListChangeBatchesByRRSetResult The input for a ListChangeBatchesByRRSet request.
Class ListGeoLocationsRequest Container for the parameters to the ListGeoLocations operation. 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.

Class ListGeoLocationsResponse Configuration for accessing Amazon ListGeoLocations service
Class ListGeoLocationsResult A complex type that contains information about the geo locations that are returned by the request and information about the response.
Class ListHealthChecksRequest Container for the parameters to the ListHealthChecks operation. 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.
Class ListHealthChecksResponse Configuration for accessing Amazon ListHealthChecks service
Class ListHealthChecksResult A complex type that contains the response for the request.
Class ListHostedZonesByNameRequest Container for the parameters to the ListHostedZonesByName operation. 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.
Class ListHostedZonesByNameResponse Configuration for accessing Amazon ListHostedZonesByName service
Class ListHostedZonesByNameResult A complex type that contains the response for the request.
Class ListHostedZonesRequest Container for the parameters to the ListHostedZones operation. 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.
Class ListHostedZonesResponse Configuration for accessing Amazon ListHostedZones service
Class ListHostedZonesResult A complex type that contains the response for the request.
Class ListResourceRecordSetsRequest Container for the parameters to the ListResourceRecordSets operation. 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.

Class ListResourceRecordSetsResponse Configuration for accessing Amazon ListResourceRecordSets service
Class ListResourceRecordSetsResult A complex type that contains information about the resource record sets that are returned by the request and information about the response.
Class ListReusableDelegationSetsRequest Container for the parameters to the ListReusableDelegationSets operation. 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.
Class ListReusableDelegationSetsResponse Configuration for accessing Amazon ListReusableDelegationSets service
Class ListReusableDelegationSetsResult A complex type that contains the response for the request.
Class ListTagsForResourceRequest Container for the parameters to the ListTagsForResource operation.
Class ListTagsForResourceResponse Configuration for accessing Amazon ListTagsForResource service
Class ListTagsForResourceResult A complex type containing tags for the specified resource.
Class ListTagsForResourcesRequest Container for the parameters to the ListTagsForResources operation.
Class ListTagsForResourcesResponse Configuration for accessing Amazon ListTagsForResources service
Class ListTagsForResourcesResult A complex type containing tags for the specified resources.
Class ListTrafficPoliciesRequest Container for the parameters to the ListTrafficPolicies operation. 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.

Class ListTrafficPoliciesResponse Configuration for accessing Amazon ListTrafficPolicies service
Class ListTrafficPoliciesResult A complex type that contains the response information for the request.
Class ListTrafficPolicyInstancesByHostedZoneRequest Container for the parameters to the ListTrafficPolicyInstancesByHostedZone operation. 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.

Class ListTrafficPolicyInstancesByHostedZoneResponse Configuration for accessing Amazon ListTrafficPolicyInstancesByHostedZone service
Class ListTrafficPolicyInstancesByHostedZoneResult A complex type that contains the response information for the request.
Class ListTrafficPolicyInstancesByPolicyRequest Container for the parameters to the ListTrafficPolicyInstancesByPolicy operation. 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.

Class ListTrafficPolicyInstancesByPolicyResponse Configuration for accessing Amazon ListTrafficPolicyInstancesByPolicy service
Class ListTrafficPolicyInstancesByPolicyResult A complex type that contains the response information for the request.
Class ListTrafficPolicyInstancesRequest Container for the parameters to the ListTrafficPolicyInstances operation. 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.

Class ListTrafficPolicyInstancesResponse Configuration for accessing Amazon ListTrafficPolicyInstances service
Class ListTrafficPolicyInstancesResult A complex type that contains the response information for the request.
Class ListTrafficPolicyVersionsRequest Container for the parameters to the ListTrafficPolicyVersions operation. 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.

Class ListTrafficPolicyVersionsResponse Configuration for accessing Amazon ListTrafficPolicyVersions service
Class ListTrafficPolicyVersionsResult A complex type that contains the response information for the request.
Class NoSuchChangeException Route53 exception
Class NoSuchDelegationSetException Route53 exception
Class NoSuchGeoLocationException Route53 exception
Class NoSuchHealthCheckException Route53 exception
Class NoSuchHostedZoneException Route53 exception
Class NoSuchTrafficPolicyException Route53 exception
Class NoSuchTrafficPolicyInstanceException Route53 exception
Class PriorRequestNotCompleteException Route53 exception
Class PublicZoneVPCAssociationException Route53 exception
Class ResourceRecord A complex type that contains the value of the Value element for the current resource record set.
Class ResourceRecordSet A complex type that contains information about the current resource record set.
Class ResourceTagSet A complex type containing a resource and its associated tags.
Class StatusReport A complex type that contains information about the health check status for the current observation.
Class Tag A single tag containing a key and value.
Class ThrottlingException Route53 exception
Class TooManyHealthChecksException Route53 exception
Class TooManyHostedZonesException Route53 exception
Class TooManyTrafficPoliciesException Route53 exception
Class TooManyTrafficPolicyInstancesException Route53 exception
Class TrafficPolicy
Class TrafficPolicyAlreadyExistsException Route53 exception
Class TrafficPolicyInstance
Class TrafficPolicyInstanceAlreadyExistsException Route53 exception
Class TrafficPolicyInUseException Route53 exception
Class TrafficPolicySummary
Class UpdateHealthCheckRequest Container for the parameters to the UpdateHealthCheck operation. 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.

Class UpdateHealthCheckResponse Configuration for accessing Amazon UpdateHealthCheck service
Class UpdateHealthCheckResult
Class UpdateHostedZoneCommentRequest Container for the parameters to the UpdateHostedZoneComment operation. 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.
Class UpdateHostedZoneCommentResponse Configuration for accessing Amazon UpdateHostedZoneComment service
Class UpdateHostedZoneCommentResult A complex type containing information about the specified hosted zone after the update.
Class UpdateTrafficPolicyCommentRequest Container for the parameters to the UpdateTrafficPolicyComment operation. 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.

Class UpdateTrafficPolicyCommentResponse Configuration for accessing Amazon UpdateTrafficPolicyComment service
Class UpdateTrafficPolicyCommentResult A complex type that contains the response information for the traffic policy.
Class UpdateTrafficPolicyInstanceRequest Container for the parameters to the UpdateTrafficPolicyInstance operation. 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.

Class UpdateTrafficPolicyInstanceResponse Configuration for accessing Amazon UpdateTrafficPolicyInstance service
Class UpdateTrafficPolicyInstanceResult A complex type that contains information about the resource record sets that Amazon Route 53 created based on a specified traffic policy.
Class VPC
Class VPCAssociationNotFoundException Route53 exception