route53_list_resource_record_sets: Lists the resource record sets in a specified hosted zone

Description Usage Arguments Value Request syntax

View source: R/route53_operations.R

Description

Lists the resource record sets in a specified hosted zone.

list_resource_record_sets returns up to 100 resource record sets at a time in ASCII order, beginning at a position specified by the name and type elements.

Sort order

list_resource_record_sets sorts results first by DNS name with the labels reversed, for example:

com.example.www.

Note the trailing dot, which can change the sort order when the record name contains characters that appear before . (decimal 46) in the ASCII table. These characters include the following: ! \" # $ % & \' ( ) * + , -

When multiple records have the same DNS name, list_resource_record_sets sorts results by the record type.

Specifying where to start listing records

You can use the name and type elements to specify the resource record set that the list begins with:

If you do not specify Name or Type

The results begin with the first resource record set that the hosted zone contains.

If you specify Name but not Type

The results begin with the first resource record set in the list whose name is greater than or equal to Name.

If you specify Type but not Name

Amazon Route 53 returns the InvalidInput error.

If you specify both Name and Type

The results begin with the first resource record set in the list whose name is greater than or equal to Name, and whose type is greater than or equal to Type.

Resource record sets that are PENDING

This action returns the most current version of the records. This includes records that are PENDING, and that are not yet available on all Route 53 DNS servers.

Changing resource record sets

To ensure that you get an accurate listing of the resource record sets for a hosted zone at a point in time, do not submit a change_resource_record_sets request while you're paging through the results of a list_resource_record_sets request. If you do, some pages may display results without the latest changes while other pages display results with the latest changes.

Displaying the next page of results

If a list_resource_record_sets command returns more than one page of results, the value of IsTruncated is true. To display the next page of results, get the values of NextRecordName, NextRecordType, and NextRecordIdentifier (if any) from the response. Then submit another list_resource_record_sets request, and specify those values for StartRecordName, StartRecordType, and StartRecordIdentifier.

Usage

1
2
route53_list_resource_record_sets(HostedZoneId, StartRecordName,
  StartRecordType, StartRecordIdentifier, MaxItems)

Arguments

HostedZoneId

[required] The ID of the hosted zone that contains the resource record sets that you want to list.

StartRecordName

The first name in the lexicographic ordering of resource record sets that you want to list. If the specified record name doesn't exist, the results begin with the first resource record set that has a name greater than the value of name.

StartRecordType

The type of resource record set to begin the record listing from.

Valid values for basic resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | NS | PTR | SOA | SPF | SRV | TXT

Values for weighted, latency, geolocation, and failover resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | PTR | SPF | SRV | TXT

Values for alias resource record sets:

  • API Gateway custom regional API or edge-optimized API: A

  • CloudFront distribution: A or AAAA

  • Elastic Beanstalk environment that has a regionalized subdomain: A

  • Elastic Load Balancing load balancer: A | AAAA

  • S3 bucket: A

  • VPC interface VPC endpoint: A

  • Another resource record set in this hosted zone: The type of the resource record set that the alias references.

Constraint: Specifying type without specifying name returns an InvalidInput error.

StartRecordIdentifier

Resource record sets that have a routing policy other than simple: If results were truncated for a given DNS name and type, specify the value of NextRecordIdentifier from the previous response to get the next resource record set that has the current DNS name and type.

MaxItems

(Optional) The maximum number of resource records sets to include in the response body for this request. If the response includes more than maxitems resource record sets, the value of the IsTruncated element in the response is true, and the values of the NextRecordName and NextRecordType elements in the response identify the first resource record set in the next group of maxitems resource record sets.

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
list(
  ResourceRecordSets = list(
    list(
      Name = "string",
      Type = "SOA"|"A"|"TXT"|"NS"|"CNAME"|"MX"|"NAPTR"|"PTR"|"SRV"|"SPF"|"AAAA"|"CAA"|"DS",
      SetIdentifier = "string",
      Weight = 123,
      Region = "us-east-1"|"us-east-2"|"us-west-1"|"us-west-2"|"ca-central-1"|"eu-west-1"|"eu-west-2"|"eu-west-3"|"eu-central-1"|"ap-southeast-1"|"ap-southeast-2"|"ap-northeast-1"|"ap-northeast-2"|"ap-northeast-3"|"eu-north-1"|"sa-east-1"|"cn-north-1"|"cn-northwest-1"|"ap-east-1"|"me-south-1"|"ap-south-1"|"af-south-1"|"eu-south-1",
      GeoLocation = list(
        ContinentCode = "string",
        CountryCode = "string",
        SubdivisionCode = "string"
      ),
      Failover = "PRIMARY"|"SECONDARY",
      MultiValueAnswer = TRUE|FALSE,
      TTL = 123,
      ResourceRecords = list(
        list(
          Value = "string"
        )
      ),
      AliasTarget = list(
        HostedZoneId = "string",
        DNSName = "string",
        EvaluateTargetHealth = TRUE|FALSE
      ),
      HealthCheckId = "string",
      TrafficPolicyInstanceId = "string"
    )
  ),
  IsTruncated = TRUE|FALSE,
  NextRecordName = "string",
  NextRecordType = "SOA"|"A"|"TXT"|"NS"|"CNAME"|"MX"|"NAPTR"|"PTR"|"SRV"|"SPF"|"AAAA"|"CAA"|"DS",
  NextRecordIdentifier = "string",
  MaxItems = "string"
)

Request syntax

1
2
3
4
5
6
7
svc$list_resource_record_sets(
  HostedZoneId = "string",
  StartRecordName = "string",
  StartRecordType = "SOA"|"A"|"TXT"|"NS"|"CNAME"|"MX"|"NAPTR"|"PTR"|"SRV"|"SPF"|"AAAA"|"CAA"|"DS",
  StartRecordIdentifier = "string",
  MaxItems = "string"
)

paws.networking documentation built on March 7, 2021, 5:08 p.m.