Network.AWS.Route53.ListHostedZonesByName

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.

Creating a Request

listHostedZonesByName :: ListHostedZonesByName

Creates a value of ListHostedZonesByName with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• lhzbnHostedZoneId
• lhzbnMaxItems
• lhzbnDNSName

data ListHostedZonesByName

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.

For more information about listing hosted zones, see Listing the Hosted Zones for an AWS Account in the Amazon Route 53 Developer Guide.

See: listHostedZonesByName smart constructor.

Instances

Eq ListHostedZonesByName

Methods

(==) :: ListHostedZonesByName -> ListHostedZonesByName -> Bool

(/=) :: ListHostedZonesByName -> ListHostedZonesByName -> Bool

Data ListHostedZonesByName

Methods

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

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

toConstr :: ListHostedZonesByName -> Constr

dataTypeOf :: ListHostedZonesByName -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListHostedZonesByName)

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

gmapT :: (forall b. Data b => b -> b) -> ListHostedZonesByName -> ListHostedZonesByName

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

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

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

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

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

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

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

Read ListHostedZonesByName

Methods

readsPrec :: Int -> ReadS ListHostedZonesByName

readList :: ReadS [ListHostedZonesByName]

readPrec :: ReadPrec ListHostedZonesByName

readListPrec :: ReadPrec [ListHostedZonesByName]

Show ListHostedZonesByName

Methods

showsPrec :: Int -> ListHostedZonesByName -> ShowS

show :: ListHostedZonesByName -> String

showList :: [ListHostedZonesByName] -> ShowS

Generic ListHostedZonesByName

Associated Types

type Rep ListHostedZonesByName :: * -> *

Methods

from :: ListHostedZonesByName -> Rep ListHostedZonesByName x

to :: Rep ListHostedZonesByName x -> ListHostedZonesByName

Hashable ListHostedZonesByName

Methods

hashWithSalt :: Int -> ListHostedZonesByName -> Int

hash :: ListHostedZonesByName -> Int

NFData ListHostedZonesByName

Methods

rnf :: ListHostedZonesByName -> ()

AWSRequest ListHostedZonesByName

Associated Types

type Rs ListHostedZonesByName :: *

Methods

request :: ListHostedZonesByName -> Request ListHostedZonesByName

response :: MonadResource m => Logger -> Service -> Proxy * ListHostedZonesByName -> ClientResponse -> m (Response ListHostedZonesByName)

ToPath ListHostedZonesByName

Methods

toPath :: ListHostedZonesByName -> ByteString

ToHeaders ListHostedZonesByName

Methods

toHeaders :: ListHostedZonesByName -> [Header]

ToQuery ListHostedZonesByName

Methods

toQuery :: ListHostedZonesByName -> QueryString

type Rep ListHostedZonesByName

type Rep ListHostedZonesByName = D1 (MetaData "ListHostedZonesByName" "Network.AWS.Route53.ListHostedZonesByName" "amazonka-route53-1.4.3-GVCZrM1VgYbI4WdWSABHKg" False) (C1 (MetaCons "ListHostedZonesByName'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_lhzbnHostedZoneId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_lhzbnMaxItems") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_lhzbnDNSName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))

type Rs ListHostedZonesByName

type Rs ListHostedZonesByName = ListHostedZonesByNameResponse

Request Lenses

lhzbnHostedZoneId :: Lens' ListHostedZonesByName (Maybe Text)

If the request returned more than one page of results, submit another request and specify the value of NextDNSName and NextHostedZoneId from the last response in the DNSName and HostedZoneId parameters to get the next page of results.

lhzbnMaxItems :: Lens' ListHostedZonesByName (Maybe Text)

Specify the maximum number of hosted zones to return per page of results.

lhzbnDNSName :: Lens' ListHostedZonesByName (Maybe Text)

The first name in the lexicographic ordering of domain names that you want the ListHostedZonesByNameRequest request to list.

If the request returned more than one page of results, submit another request and specify the value of NextDNSName and NextHostedZoneId from the last response in the DNSName and HostedZoneId parameters to get the next page of results.

Destructuring the Response

listHostedZonesByNameResponse

Arguments

:: Int

lhzbnrsResponseStatus

-> Bool

lhzbnrsIsTruncated

-> Text

lhzbnrsMaxItems

-> ListHostedZonesByNameResponse

Creates a value of ListHostedZonesByNameResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• lhzbnrsHostedZoneId
• lhzbnrsNextHostedZoneId
• lhzbnrsDNSName
• lhzbnrsNextDNSName
• lhzbnrsResponseStatus
• lhzbnrsHostedZones
• lhzbnrsIsTruncated
• lhzbnrsMaxItems

data ListHostedZonesByNameResponse

A complex type that contains the response for the request.

See: listHostedZonesByNameResponse smart constructor.

Instances

Eq ListHostedZonesByNameResponse

Methods

(==) :: ListHostedZonesByNameResponse -> ListHostedZonesByNameResponse -> Bool

(/=) :: ListHostedZonesByNameResponse -> ListHostedZonesByNameResponse -> Bool

Data ListHostedZonesByNameResponse

Methods

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

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

toConstr :: ListHostedZonesByNameResponse -> Constr

dataTypeOf :: ListHostedZonesByNameResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListHostedZonesByNameResponse)

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

gmapT :: (forall b. Data b => b -> b) -> ListHostedZonesByNameResponse -> ListHostedZonesByNameResponse

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

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

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

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

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

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

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

Read ListHostedZonesByNameResponse

Methods

readsPrec :: Int -> ReadS ListHostedZonesByNameResponse

readList :: ReadS [ListHostedZonesByNameResponse]

readPrec :: ReadPrec ListHostedZonesByNameResponse

readListPrec :: ReadPrec [ListHostedZonesByNameResponse]

Show ListHostedZonesByNameResponse

Methods

showsPrec :: Int -> ListHostedZonesByNameResponse -> ShowS

show :: ListHostedZonesByNameResponse -> String

showList :: [ListHostedZonesByNameResponse] -> ShowS

Generic ListHostedZonesByNameResponse

Associated Types

type Rep ListHostedZonesByNameResponse :: * -> *

Methods

from :: ListHostedZonesByNameResponse -> Rep ListHostedZonesByNameResponse x

to :: Rep ListHostedZonesByNameResponse x -> ListHostedZonesByNameResponse

NFData ListHostedZonesByNameResponse

Methods

rnf :: ListHostedZonesByNameResponse -> ()

type Rep ListHostedZonesByNameResponse

type Rep ListHostedZonesByNameResponse = D1 (MetaData "ListHostedZonesByNameResponse" "Network.AWS.Route53.ListHostedZonesByName" "amazonka-route53-1.4.3-GVCZrM1VgYbI4WdWSABHKg" False) (C1 (MetaCons "ListHostedZonesByNameResponse'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_lhzbnrsHostedZoneId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_lhzbnrsNextHostedZoneId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_lhzbnrsDNSName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_lhzbnrsNextDNSName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_lhzbnrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)) (S1 (MetaSel (Just Symbol "_lhzbnrsHostedZones") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [HostedZone]))) ((:*:) (S1 (MetaSel (Just Symbol "_lhzbnrsIsTruncated") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool)) (S1 (MetaSel (Just Symbol "_lhzbnrsMaxItems") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))

Response Lenses

lhzbnrsHostedZoneId :: Lens' ListHostedZonesByNameResponse (Maybe Text)

The HostedZoneId value sent in the request.

lhzbnrsNextHostedZoneId :: Lens' ListHostedZonesByNameResponse (Maybe Text)

If ListHostedZonesByNameResponseIsTruncated> is true, there are more hosted zones associated with the current AWS account. To get the next page of results, make another request to ListHostedZonesByName. Specify the value of ListHostedZonesByNameResponseNextDNSName> in the ListHostedZonesByNameRequestDNSName> element and ListHostedZonesByNameResponseNextHostedZoneId> in the ListHostedZonesByNameRequestHostedZoneId> element.

lhzbnrsDNSName :: Lens' ListHostedZonesByNameResponse (Maybe Text)

The DNSName value sent in the request.

lhzbnrsNextDNSName :: Lens' ListHostedZonesByNameResponse (Maybe Text)

If ListHostedZonesByNameResponseIsTruncated> is true, there are more hosted zones associated with the current AWS account. To get the next page of results, make another request to ListHostedZonesByName. Specify the value of ListHostedZonesByNameResponseNextDNSName> in the ListHostedZonesByNameRequestDNSName> element and ListHostedZonesByNameResponseNextHostedZoneId> in the ListHostedZonesByNameRequestHostedZoneId> element.

lhzbnrsResponseStatus :: Lens' ListHostedZonesByNameResponse Int

The response status code.

lhzbnrsHostedZones :: Lens' ListHostedZonesByNameResponse [HostedZone]

A complex type that contains information about the hosted zones associated with the current AWS account.

lhzbnrsIsTruncated :: Lens' ListHostedZonesByNameResponse Bool

A flag indicating whether there are more hosted zones to be listed. If your results were truncated, you can make a follow-up request for the next page of results by using the NextDNSName and NextHostedZoneId elements.

Valid Values: true | false

lhzbnrsMaxItems :: Lens' ListHostedZonesByNameResponse Text

The maximum number of hosted zones to be included in the response body. If the number of hosted zones associated with this AWS account exceeds MaxItems, the value of ListHostedZonesByNameResponseIsTruncated> in the response is true. Call ListHostedZonesByName again and specify the value of ListHostedZonesByNameResponseNextDNSName> and ListHostedZonesByNameResponseNextHostedZoneId> elements respectively to get the next page of results.