Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Route53.ListHostedZonesByName

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves a list of your hosted zones in lexicographic order. The response includes a HostedZones child element for each hosted zone created by the current Amazon Web Services account.

ListHostedZonesByName sorts hosted zones by name with the labels reversed. For example:

com.example.www.

Note the trailing dot, which can change the sort order in some circumstances.

If the domain name includes escape characters or Punycode, ListHostedZonesByName alphabetizes the domain name using the escaped or Punycoded value, which is the format that Amazon Route 53 saves in its database. For example, to create a hosted zone for exämple.com, you specify ex\344mple.com for the domain name. ListHostedZonesByName alphabetizes it as:

com.ex\344mple.

The labels are reversed and alphabetized using the escaped value. For more information about valid domain name formats, including internationalized domain names, see DNS Domain Name Format in the Amazon Route 53 Developer Guide.

Route 53 returns up to 100 items in each response. If you have a lot of hosted zones, use the MaxItems parameter to list them in groups of up to 100. The response includes values that help navigate from one group of MaxItems hosted zones to the next:

The DNSName and HostedZoneId elements in the response contain the values, if any, specified for the dnsname and hostedzoneid parameters in the request that produced the current response.
The MaxItems element in the response contains the value, if any, that you specified for the maxitems parameter in the request that produced the current response.
If the value of IsTruncated in the response is true, there are more hosted zones associated with the current Amazon Web Services account.
If IsTruncated is false, this response includes the last hosted zone that is associated with the current account. The NextDNSName element and NextHostedZoneId elements are omitted from the response.
The NextDNSName and NextHostedZoneId elements in the response contain the domain name and the hosted zone ID of the next hosted zone that is associated with the current Amazon Web Services account. If you want to list more hosted zones, make another call to ListHostedZonesByName, and specify the value of NextDNSName and NextHostedZoneId in the dnsname and hostedzoneid parameters, respectively.

Synopsis

Creating a Request

data ListHostedZonesByName Source #

Retrieves a list of the public and private hosted zones that are associated with the current Amazon Web Services account in ASCII order by domain name.

See: newListHostedZonesByName smart constructor.

Constructors

ListHostedZonesByName'

Fields

dNSName :: Maybe Text
(Optional) For your first request to ListHostedZonesByName, include the dnsname parameter only if you want to specify the name of the first hosted zone in the response. If you don't include the dnsname parameter, Amazon Route 53 returns all of the hosted zones that were created by the current Amazon Web Services account, in ASCII order. For subsequent requests, include both dnsname and hostedzoneid parameters. For dnsname, specify the value of NextDNSName from the previous response.
hostedZoneId :: Maybe ResourceId
(Optional) For your first request to ListHostedZonesByName, do not include the hostedzoneid parameter.
If you have more hosted zones than the value of maxitems, ListHostedZonesByName returns only the first maxitems hosted zones. To get the next group of maxitems hosted zones, submit another request to ListHostedZonesByName and include both dnsname and hostedzoneid parameters. For the value of hostedzoneid, specify the value of the NextHostedZoneId element from the previous response.
maxItems :: Maybe Text
The maximum number of hosted zones to be included in the response body for this request. If you have more than maxitems hosted zones, then the value of the IsTruncated element in the response is true, and the values of NextDNSName and NextHostedZoneId specify the first hosted zone in the next group of maxitems hosted zones.

Instances

Instances details

ToHeaders ListHostedZonesByName Source #
Instance details Defined in Amazonka.Route53.ListHostedZonesByName Methods toHeaders :: ListHostedZonesByName -> [Header] #
ToPath ListHostedZonesByName Source #
Instance details Defined in Amazonka.Route53.ListHostedZonesByName Methods toPath :: ListHostedZonesByName -> ByteString #
ToQuery ListHostedZonesByName Source #
Instance details Defined in Amazonka.Route53.ListHostedZonesByName Methods toQuery :: ListHostedZonesByName -> QueryString #
AWSRequest ListHostedZonesByName Source #
Instance details Defined in Amazonka.Route53.ListHostedZonesByName Associated Types type AWSResponse ListHostedZonesByName # Methods request :: (Service -> Service) -> ListHostedZonesByName -> Request ListHostedZonesByName # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListHostedZonesByName -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListHostedZonesByName))) #
Generic ListHostedZonesByName Source #
Instance details Defined in Amazonka.Route53.ListHostedZonesByName Associated Types type Rep ListHostedZonesByName :: Type -> Type # Methods from :: ListHostedZonesByName -> Rep ListHostedZonesByName x # to :: Rep ListHostedZonesByName x -> ListHostedZonesByName #
Read ListHostedZonesByName Source #
Instance details Defined in Amazonka.Route53.ListHostedZonesByName Methods readsPrec :: Int -> ReadS ListHostedZonesByName # readList :: ReadS [ListHostedZonesByName] # readPrec :: ReadPrec ListHostedZonesByName # readListPrec :: ReadPrec [ListHostedZonesByName] #
Show ListHostedZonesByName Source #
Instance details Defined in Amazonka.Route53.ListHostedZonesByName Methods showsPrec :: Int -> ListHostedZonesByName -> ShowS # show :: ListHostedZonesByName -> String # showList :: [ListHostedZonesByName] -> ShowS #
NFData ListHostedZonesByName Source #
Instance details Defined in Amazonka.Route53.ListHostedZonesByName Methods rnf :: ListHostedZonesByName -> () #
Eq ListHostedZonesByName Source #
Instance details Defined in Amazonka.Route53.ListHostedZonesByName Methods (==) :: ListHostedZonesByName -> ListHostedZonesByName -> Bool # (/=) :: ListHostedZonesByName -> ListHostedZonesByName -> Bool #
Hashable ListHostedZonesByName Source #
Instance details Defined in Amazonka.Route53.ListHostedZonesByName Methods hashWithSalt :: Int -> ListHostedZonesByName -> Int # hash :: ListHostedZonesByName -> Int #
type AWSResponse ListHostedZonesByName Source #
Instance details Defined in Amazonka.Route53.ListHostedZonesByName type AWSResponse ListHostedZonesByName = ListHostedZonesByNameResponse
type Rep ListHostedZonesByName Source #
Instance details Defined in Amazonka.Route53.ListHostedZonesByName type Rep ListHostedZonesByName = D1 ('MetaData "ListHostedZonesByName" "Amazonka.Route53.ListHostedZonesByName" "amazonka-route53-2.0-8wP357MyuPX6rh87d4wklb" 'False) (C1 ('MetaCons "ListHostedZonesByName'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dNSName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "hostedZoneId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResourceId)) :: S1 ('MetaSel ('Just "maxItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newListHostedZonesByName :: ListHostedZonesByName Source #

Create a value of ListHostedZonesByName with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ListHostedZonesByName, listHostedZonesByName_dNSName - (Optional) For your first request to ListHostedZonesByName, include the dnsname parameter only if you want to specify the name of the first hosted zone in the response. If you don't include the dnsname parameter, Amazon Route 53 returns all of the hosted zones that were created by the current Amazon Web Services account, in ASCII order. For subsequent requests, include both dnsname and hostedzoneid parameters. For dnsname, specify the value of NextDNSName from the previous response.

ListHostedZonesByName, listHostedZonesByName_hostedZoneId - (Optional) For your first request to ListHostedZonesByName, do not include the hostedzoneid parameter.

If you have more hosted zones than the value of maxitems, ListHostedZonesByName returns only the first maxitems hosted zones. To get the next group of maxitems hosted zones, submit another request to ListHostedZonesByName and include both dnsname and hostedzoneid parameters. For the value of hostedzoneid, specify the value of the NextHostedZoneId element from the previous response.

ListHostedZonesByName, listHostedZonesByName_maxItems - The maximum number of hosted zones to be included in the response body for this request. If you have more than maxitems hosted zones, then the value of the IsTruncated element in the response is true, and the values of NextDNSName and NextHostedZoneId specify the first hosted zone in the next group of maxitems hosted zones.

Request Lenses

listHostedZonesByName_dNSName :: Lens' ListHostedZonesByName (Maybe Text) Source #

(Optional) For your first request to ListHostedZonesByName, include the dnsname parameter only if you want to specify the name of the first hosted zone in the response. If you don't include the dnsname parameter, Amazon Route 53 returns all of the hosted zones that were created by the current Amazon Web Services account, in ASCII order. For subsequent requests, include both dnsname and hostedzoneid parameters. For dnsname, specify the value of NextDNSName from the previous response.

listHostedZonesByName_hostedZoneId :: Lens' ListHostedZonesByName (Maybe ResourceId) Source #

(Optional) For your first request to ListHostedZonesByName, do not include the hostedzoneid parameter.

If you have more hosted zones than the value of maxitems, ListHostedZonesByName returns only the first maxitems hosted zones. To get the next group of maxitems hosted zones, submit another request to ListHostedZonesByName and include both dnsname and hostedzoneid parameters. For the value of hostedzoneid, specify the value of the NextHostedZoneId element from the previous response.

listHostedZonesByName_maxItems :: Lens' ListHostedZonesByName (Maybe Text) Source #

The maximum number of hosted zones to be included in the response body for this request. If you have more than maxitems hosted zones, then the value of the IsTruncated element in the response is true, and the values of NextDNSName and NextHostedZoneId specify the first hosted zone in the next group of maxitems hosted zones.

Destructuring the Response

data ListHostedZonesByNameResponse Source #

A complex type that contains the response information for the request.

See: newListHostedZonesByNameResponse smart constructor.

Constructors

ListHostedZonesByNameResponse'

Fields

dNSName :: Maybe Text
For the second and subsequent calls to ListHostedZonesByName, DNSName is the value that you specified for the dnsname parameter in the request that produced the current response.
hostedZoneId :: Maybe ResourceId
The ID that Amazon Route 53 assigned to the hosted zone when you created it.
nextDNSName :: Maybe Text
If IsTruncated is true, the value of NextDNSName is the name of the first hosted zone in the next group of maxitems hosted zones. Call ListHostedZonesByName again and specify the value of NextDNSName and NextHostedZoneId in the dnsname and hostedzoneid parameters, respectively.
This element is present only if IsTruncated is true.
nextHostedZoneId :: Maybe ResourceId
If IsTruncated is true, the value of NextHostedZoneId identifies the first hosted zone in the next group of maxitems hosted zones. Call ListHostedZonesByName again and specify the value of NextDNSName and NextHostedZoneId in the dnsname and hostedzoneid parameters, respectively.
This element is present only if IsTruncated is true.
httpStatus :: Int
The response's http status code.
hostedZones :: [HostedZone]
A complex type that contains general information about the hosted zone.
isTruncated :: Bool
A flag that indicates whether there are more hosted zones to be listed. If the response was truncated, you can get the next group of maxitems hosted zones by calling ListHostedZonesByName again and specifying the values of NextDNSName and NextHostedZoneId elements in the dnsname and hostedzoneid parameters.
maxItems :: Text
The value that you specified for the maxitems parameter in the call to ListHostedZonesByName that produced the current response.

Instances

Instances details

Generic ListHostedZonesByNameResponse Source #
Instance details Defined in Amazonka.Route53.ListHostedZonesByName Associated Types type Rep ListHostedZonesByNameResponse :: Type -> Type # Methods from :: ListHostedZonesByNameResponse -> Rep ListHostedZonesByNameResponse x # to :: Rep ListHostedZonesByNameResponse x -> ListHostedZonesByNameResponse #
Read ListHostedZonesByNameResponse Source #
Instance details Defined in Amazonka.Route53.ListHostedZonesByName Methods readsPrec :: Int -> ReadS ListHostedZonesByNameResponse # readList :: ReadS [ListHostedZonesByNameResponse] # readPrec :: ReadPrec ListHostedZonesByNameResponse # readListPrec :: ReadPrec [ListHostedZonesByNameResponse] #
Show ListHostedZonesByNameResponse Source #
Instance details Defined in Amazonka.Route53.ListHostedZonesByName Methods showsPrec :: Int -> ListHostedZonesByNameResponse -> ShowS # show :: ListHostedZonesByNameResponse -> String # showList :: [ListHostedZonesByNameResponse] -> ShowS #
NFData ListHostedZonesByNameResponse Source #
Instance details Defined in Amazonka.Route53.ListHostedZonesByName Methods rnf :: ListHostedZonesByNameResponse -> () #
Eq ListHostedZonesByNameResponse Source #
Instance details Defined in Amazonka.Route53.ListHostedZonesByName Methods (==) :: ListHostedZonesByNameResponse -> ListHostedZonesByNameResponse -> Bool # (/=) :: ListHostedZonesByNameResponse -> ListHostedZonesByNameResponse -> Bool #
type Rep ListHostedZonesByNameResponse Source #
Instance details Defined in Amazonka.Route53.ListHostedZonesByName type Rep ListHostedZonesByNameResponse = D1 ('MetaData "ListHostedZonesByNameResponse" "Amazonka.Route53.ListHostedZonesByName" "amazonka-route53-2.0-8wP357MyuPX6rh87d4wklb" 'False) (C1 ('MetaCons "ListHostedZonesByNameResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "dNSName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "hostedZoneId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResourceId))) :: (S1 ('MetaSel ('Just "nextDNSName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "nextHostedZoneId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResourceId)))) :: ((S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "hostedZones") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [HostedZone])) :: (S1 ('MetaSel ('Just "isTruncated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "maxItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newListHostedZonesByNameResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListHostedZonesByNameResponse'`
-> Bool	`$sel:isTruncated:ListHostedZonesByNameResponse'`
-> Text	`ListHostedZonesByName`
-> ListHostedZonesByNameResponse

Create a value of ListHostedZonesByNameResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ListHostedZonesByName, listHostedZonesByNameResponse_dNSName - For the second and subsequent calls to ListHostedZonesByName, DNSName is the value that you specified for the dnsname parameter in the request that produced the current response.

ListHostedZonesByName, listHostedZonesByNameResponse_hostedZoneId - The ID that Amazon Route 53 assigned to the hosted zone when you created it.

$sel:nextDNSName:ListHostedZonesByNameResponse', listHostedZonesByNameResponse_nextDNSName - If IsTruncated is true, the value of NextDNSName is the name of the first hosted zone in the next group of maxitems hosted zones. Call ListHostedZonesByName again and specify the value of NextDNSName and NextHostedZoneId in the dnsname and hostedzoneid parameters, respectively.

This element is present only if IsTruncated is true.

$sel:nextHostedZoneId:ListHostedZonesByNameResponse', listHostedZonesByNameResponse_nextHostedZoneId - If IsTruncated is true, the value of NextHostedZoneId identifies the first hosted zone in the next group of maxitems hosted zones. Call ListHostedZonesByName again and specify the value of NextDNSName and NextHostedZoneId in the dnsname and hostedzoneid parameters, respectively.

This element is present only if IsTruncated is true.

$sel:httpStatus:ListHostedZonesByNameResponse', listHostedZonesByNameResponse_httpStatus - The response's http status code.

$sel:hostedZones:ListHostedZonesByNameResponse', listHostedZonesByNameResponse_hostedZones - A complex type that contains general information about the hosted zone.

$sel:isTruncated:ListHostedZonesByNameResponse', listHostedZonesByNameResponse_isTruncated - A flag that indicates whether there are more hosted zones to be listed. If the response was truncated, you can get the next group of maxitems hosted zones by calling ListHostedZonesByName again and specifying the values of NextDNSName and NextHostedZoneId elements in the dnsname and hostedzoneid parameters.

ListHostedZonesByName, listHostedZonesByNameResponse_maxItems - The value that you specified for the maxitems parameter in the call to ListHostedZonesByName that produced the current response.

Response Lenses

listHostedZonesByNameResponse_dNSName :: Lens' ListHostedZonesByNameResponse (Maybe Text) Source #

For the second and subsequent calls to ListHostedZonesByName, DNSName is the value that you specified for the dnsname parameter in the request that produced the current response.

listHostedZonesByNameResponse_hostedZoneId :: Lens' ListHostedZonesByNameResponse (Maybe ResourceId) Source #

The ID that Amazon Route 53 assigned to the hosted zone when you created it.

listHostedZonesByNameResponse_nextDNSName :: Lens' ListHostedZonesByNameResponse (Maybe Text) Source #

If IsTruncated is true, the value of NextDNSName is the name of the first hosted zone in the next group of maxitems hosted zones. Call ListHostedZonesByName again and specify the value of NextDNSName and NextHostedZoneId in the dnsname and hostedzoneid parameters, respectively.

This element is present only if IsTruncated is true.

listHostedZonesByNameResponse_nextHostedZoneId :: Lens' ListHostedZonesByNameResponse (Maybe ResourceId) Source #

If IsTruncated is true, the value of NextHostedZoneId identifies the first hosted zone in the next group of maxitems hosted zones. Call ListHostedZonesByName again and specify the value of NextDNSName and NextHostedZoneId in the dnsname and hostedzoneid parameters, respectively.

This element is present only if IsTruncated is true.

listHostedZonesByNameResponse_httpStatus :: Lens' ListHostedZonesByNameResponse Int Source #

The response's http status code.

listHostedZonesByNameResponse_hostedZones :: Lens' ListHostedZonesByNameResponse [HostedZone] Source #

A complex type that contains general information about the hosted zone.

listHostedZonesByNameResponse_isTruncated :: Lens' ListHostedZonesByNameResponse Bool Source #

A flag that indicates whether there are more hosted zones to be listed. If the response was truncated, you can get the next group of maxitems hosted zones by calling ListHostedZonesByName again and specifying the values of NextDNSName and NextHostedZoneId elements in the dnsname and hostedzoneid parameters.

listHostedZonesByNameResponse_maxItems :: Lens' ListHostedZonesByNameResponse Text Source #

The value that you specified for the maxitems parameter in the call to ListHostedZonesByName that produced the current response.