amazonka-route53-1.6.1: Amazon Route 53 SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.Route53.ListResourceRecordSets

Contents

Description

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 to Type .

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.

Synopsis

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 resource record sets that you want to list.
  • lrrsStartRecordType - 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, geo, and failover resource record sets: A | AAAA | CAA | 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 * 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.
  • lrrsStartRecordIdentifier - 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 - (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 - The ID of the hosted zone that contains the resource record sets that you want to list.

data ListResourceRecordSets Source #

A request for the resource record sets that are associated with a specified hosted zone.

See: listResourceRecordSets smart constructor.

Instances
Eq ListResourceRecordSets Source # 
Instance details

Defined in Network.AWS.Route53.ListResourceRecordSets

Data ListResourceRecordSets Source # 
Instance details

Defined in Network.AWS.Route53.ListResourceRecordSets

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListResourceRecordSets -> c ListResourceRecordSets #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListResourceRecordSets #

toConstr :: ListResourceRecordSets -> Constr #

dataTypeOf :: ListResourceRecordSets -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ListResourceRecordSets) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListResourceRecordSets) #

gmapT :: (forall b. Data b => b -> b) -> ListResourceRecordSets -> ListResourceRecordSets #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListResourceRecordSets -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListResourceRecordSets -> r #

gmapQ :: (forall d. Data d => d -> u) -> ListResourceRecordSets -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListResourceRecordSets -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListResourceRecordSets -> m ListResourceRecordSets #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListResourceRecordSets -> m ListResourceRecordSets #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListResourceRecordSets -> m ListResourceRecordSets #

Read ListResourceRecordSets Source # 
Instance details

Defined in Network.AWS.Route53.ListResourceRecordSets

Show ListResourceRecordSets Source # 
Instance details

Defined in Network.AWS.Route53.ListResourceRecordSets

Generic ListResourceRecordSets Source # 
Instance details

Defined in Network.AWS.Route53.ListResourceRecordSets

Associated Types

type Rep ListResourceRecordSets :: Type -> Type #

Hashable ListResourceRecordSets Source # 
Instance details

Defined in Network.AWS.Route53.ListResourceRecordSets

AWSPager ListResourceRecordSets Source # 
Instance details

Defined in Network.AWS.Route53.ListResourceRecordSets

AWSRequest ListResourceRecordSets Source # 
Instance details

Defined in Network.AWS.Route53.ListResourceRecordSets

Associated Types

type Rs ListResourceRecordSets :: Type #

ToHeaders ListResourceRecordSets Source # 
Instance details

Defined in Network.AWS.Route53.ListResourceRecordSets

ToPath ListResourceRecordSets Source # 
Instance details

Defined in Network.AWS.Route53.ListResourceRecordSets

ToQuery ListResourceRecordSets Source # 
Instance details

Defined in Network.AWS.Route53.ListResourceRecordSets

NFData ListResourceRecordSets Source # 
Instance details

Defined in Network.AWS.Route53.ListResourceRecordSets

Methods

rnf :: ListResourceRecordSets -> () #

type Rep ListResourceRecordSets Source # 
Instance details

Defined in Network.AWS.Route53.ListResourceRecordSets

type Rep ListResourceRecordSets = D1 (MetaData "ListResourceRecordSets" "Network.AWS.Route53.ListResourceRecordSets" "amazonka-route53-1.6.1-FKj3w6bny4r4NCyL7bsSVl" False) (C1 (MetaCons "ListResourceRecordSets'" PrefixI True) ((S1 (MetaSel (Just "_lrrsStartRecordName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_lrrsStartRecordType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe RecordType))) :*: (S1 (MetaSel (Just "_lrrsStartRecordIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_lrrsMaxItems") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_lrrsHostedZoneId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ResourceId)))))
type Rs ListResourceRecordSets Source # 
Instance details

Defined in Network.AWS.Route53.ListResourceRecordSets

Request Lenses

lrrsStartRecordName :: Lens' ListResourceRecordSets (Maybe Text) Source #

The first name in the lexicographic ordering of resource record sets that you want 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 | CAA | CNAME | MX | NAPTR | NS | PTR | SOA | SPF | SRV | TXT Values for weighted, latency, geo, and failover resource record sets: A | AAAA | CAA | 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 * 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.

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 list.

Destructuring the Response

listResourceRecordSetsResponse Source #

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 if IsTruncated is true.
  • lrrsrsNextRecordName - If the results were truncated, the name of the next record in the list. This element is present only if IsTruncated 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 of SetIdentifier 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 the NextRecordName 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.

Instances
Eq ListResourceRecordSetsResponse Source # 
Instance details

Defined in Network.AWS.Route53.ListResourceRecordSets

Data ListResourceRecordSetsResponse Source # 
Instance details

Defined in Network.AWS.Route53.ListResourceRecordSets

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListResourceRecordSetsResponse -> c ListResourceRecordSetsResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListResourceRecordSetsResponse #

toConstr :: ListResourceRecordSetsResponse -> Constr #

dataTypeOf :: ListResourceRecordSetsResponse -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ListResourceRecordSetsResponse) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListResourceRecordSetsResponse) #

gmapT :: (forall b. Data b => b -> b) -> ListResourceRecordSetsResponse -> ListResourceRecordSetsResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListResourceRecordSetsResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListResourceRecordSetsResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> ListResourceRecordSetsResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListResourceRecordSetsResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListResourceRecordSetsResponse -> m ListResourceRecordSetsResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListResourceRecordSetsResponse -> m ListResourceRecordSetsResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListResourceRecordSetsResponse -> m ListResourceRecordSetsResponse #

Read ListResourceRecordSetsResponse Source # 
Instance details

Defined in Network.AWS.Route53.ListResourceRecordSets

Show ListResourceRecordSetsResponse Source # 
Instance details

Defined in Network.AWS.Route53.ListResourceRecordSets

Generic ListResourceRecordSetsResponse Source # 
Instance details

Defined in Network.AWS.Route53.ListResourceRecordSets

Associated Types

type Rep ListResourceRecordSetsResponse :: Type -> Type #

NFData ListResourceRecordSetsResponse Source # 
Instance details

Defined in Network.AWS.Route53.ListResourceRecordSets

type Rep ListResourceRecordSetsResponse Source # 
Instance details

Defined in Network.AWS.Route53.ListResourceRecordSets

type Rep ListResourceRecordSetsResponse = D1 (MetaData "ListResourceRecordSetsResponse" "Network.AWS.Route53.ListResourceRecordSets" "amazonka-route53-1.6.1-FKj3w6bny4r4NCyL7bsSVl" False) (C1 (MetaCons "ListResourceRecordSetsResponse'" PrefixI True) ((S1 (MetaSel (Just "_lrrsrsNextRecordType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe RecordType)) :*: (S1 (MetaSel (Just "_lrrsrsNextRecordName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_lrrsrsNextRecordIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_lrrsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int) :*: S1 (MetaSel (Just "_lrrsrsResourceRecordSets") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [ResourceRecordSet])) :*: (S1 (MetaSel (Just "_lrrsrsIsTruncated") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool) :*: S1 (MetaSel (Just "_lrrsrsMaxItems") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))

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.

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.