Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Lists the resource record sets in a specified hosted zone.
ListResourceRecordSets
returns up to 100 resource record sets at a time in ASCII order, beginning at a position specified by the name
and type
elements. The action 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 in some circumstances.
When multiple records have the same DNS name, the action sorts results by the record type.
You can use the name and type elements to adjust the beginning position of the list of resource record sets returned:
- 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 toType
.
This action returns the most current version of the records. This includes records that are PENDING
, and that are not yet available on all Amazon Route 53 DNS servers.
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 ChangeResourceRecordSets
request while you're paging through the results of a ListResourceRecordSets
request. If you do, some pages may display results without the latest changes while other pages display results with the latest changes.
This operation returns paginated results.
- listResourceRecordSets :: ResourceId -> ListResourceRecordSets
- data ListResourceRecordSets
- lrrsStartRecordName :: Lens' ListResourceRecordSets (Maybe Text)
- lrrsStartRecordType :: Lens' ListResourceRecordSets (Maybe RecordType)
- lrrsStartRecordIdentifier :: Lens' ListResourceRecordSets (Maybe Text)
- lrrsMaxItems :: Lens' ListResourceRecordSets (Maybe Text)
- lrrsHostedZoneId :: Lens' ListResourceRecordSets ResourceId
- listResourceRecordSetsResponse :: Int -> Bool -> Text -> ListResourceRecordSetsResponse
- data ListResourceRecordSetsResponse
- lrrsrsNextRecordType :: Lens' ListResourceRecordSetsResponse (Maybe RecordType)
- lrrsrsNextRecordName :: Lens' ListResourceRecordSetsResponse (Maybe Text)
- lrrsrsNextRecordIdentifier :: Lens' ListResourceRecordSetsResponse (Maybe Text)
- lrrsrsResponseStatus :: Lens' ListResourceRecordSetsResponse Int
- lrrsrsResourceRecordSets :: Lens' ListResourceRecordSetsResponse [ResourceRecordSet]
- lrrsrsIsTruncated :: Lens' ListResourceRecordSetsResponse Bool
- lrrsrsMaxItems :: Lens' ListResourceRecordSetsResponse Text
Creating a Request
listResourceRecordSets Source #
Creates a value of ListResourceRecordSets
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lrrsStartRecordName
- The first name in the lexicographic ordering of domain names that you want theListResourceRecordSets
request to list.lrrsStartRecordType
- The type of resource record set to begin the record listing from. Valid values for basic resource record sets:A
|AAAA
|CNAME
|MX
|NAPTR
|NS
|PTR
|SOA
|SPF
|SRV
|TXT
Values for weighted, latency, geo, and failover resource record sets:A
|AAAA
|CNAME
|MX
|NAPTR
|PTR
|SPF
|SRV
|TXT
Values for alias resource record sets: * CloudFront distribution : A or AAAA * Elastic Beanstalk environment that has a regionalized subdomain : A * ELB load balancer : A | AAAA * Amazon S3 bucket : A Constraint: Specifyingtype
without specifyingname
returns anInvalidInput
error.lrrsStartRecordIdentifier
- Weighted resource record sets only: If results were truncated for a given DNS name and type, specify the value ofNextRecordIdentifier
from the previous response to get the next resource record set that has the current DNS name and type.lrrsMaxItems
- (Optional) The maximum number of resource records sets to include in the response body for this request. If the response includes more thanmaxitems
resource record sets, the value of theIsTruncated
element in the response istrue
, and the values of theNextRecordName
andNextRecordType
elements in the response identify the first resource record set in the next group ofmaxitems
resource record sets.lrrsHostedZoneId
- The ID of the hosted zone that contains the resource record sets that you want to get.
data ListResourceRecordSets Source #
The input for a ListResourceRecordSets request.
See: listResourceRecordSets
smart constructor.
Request Lenses
lrrsStartRecordName :: Lens' ListResourceRecordSets (Maybe Text) Source #
The first name in the lexicographic ordering of domain names that you want the ListResourceRecordSets
request to list.
lrrsStartRecordType :: Lens' ListResourceRecordSets (Maybe RecordType) Source #
The type of resource record set to begin the record listing from. Valid values for basic resource record sets: A
| AAAA
| CNAME
| MX
| NAPTR
| NS
| PTR
| SOA
| SPF
| SRV
| TXT
Values for weighted, latency, geo, and failover resource record sets: A
| AAAA
| CNAME
| MX
| NAPTR
| PTR
| SPF
| SRV
| TXT
Values for alias resource record sets: * CloudFront distribution : A or AAAA * Elastic Beanstalk environment that has a regionalized subdomain : A * ELB load balancer : A | AAAA * Amazon S3 bucket : A Constraint: Specifying type
without specifying name
returns an InvalidInput
error.
lrrsStartRecordIdentifier :: Lens' ListResourceRecordSets (Maybe Text) Source #
Weighted resource record sets only: 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.
lrrsMaxItems :: Lens' ListResourceRecordSets (Maybe Text) Source #
(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.
lrrsHostedZoneId :: Lens' ListResourceRecordSets ResourceId Source #
The ID of the hosted zone that contains the resource record sets that you want to get.
Destructuring the Response
listResourceRecordSetsResponse Source #
:: Int | |
-> Bool | |
-> Text | |
-> ListResourceRecordSetsResponse |
Creates a value of ListResourceRecordSetsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lrrsrsNextRecordType
- If the results were truncated, the type of the next record in the list. This element is present only ifIsTruncated
is true.lrrsrsNextRecordName
- If the results were truncated, the name of the next record in the list. This element is present only ifIsTruncated
is true.lrrsrsNextRecordIdentifier
- Weighted, latency, geolocation, and failover resource record sets only : If results were truncated for a given DNS name and type, the value ofSetIdentifier
for the next resource record set that has the current DNS name and type.lrrsrsResponseStatus
- -- | The response status code.lrrsrsResourceRecordSets
- Information about multiple resource record sets.lrrsrsIsTruncated
- A flag that indicates whether more resource record sets remain to be listed. If your results were truncated, you can make a follow-up pagination request by using theNextRecordName
element.lrrsrsMaxItems
- The maximum number of records you requested.
data ListResourceRecordSetsResponse Source #
A complex type that contains list information for the resource record set.
See: listResourceRecordSetsResponse
smart constructor.
Response Lenses
lrrsrsNextRecordType :: Lens' ListResourceRecordSetsResponse (Maybe RecordType) Source #
If the results were truncated, the type of the next record in the list. This element is present only if IsTruncated
is true.
lrrsrsNextRecordName :: Lens' ListResourceRecordSetsResponse (Maybe Text) Source #
If the results were truncated, the name of the next record in the list. This element is present only if IsTruncated
is true.
lrrsrsNextRecordIdentifier :: Lens' ListResourceRecordSetsResponse (Maybe Text) Source #
Weighted, latency, geolocation, and failover resource record sets only : If results were truncated for a given DNS name and type, the value of SetIdentifier
for the next resource record set that has the current DNS name and type.
lrrsrsResponseStatus :: Lens' ListResourceRecordSetsResponse Int Source #
- - | The response status code.
lrrsrsResourceRecordSets :: Lens' ListResourceRecordSetsResponse [ResourceRecordSet] Source #
Information about multiple resource record sets.
lrrsrsIsTruncated :: Lens' ListResourceRecordSetsResponse Bool Source #
A flag that indicates whether more resource record sets remain to be listed. If your results were truncated, you can make a follow-up pagination request by using the NextRecordName
element.
lrrsrsMaxItems :: Lens' ListResourceRecordSetsResponse Text Source #
The maximum number of records you requested.