Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Route53Domains.ListDomains

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

This operation returns all the domain names registered with Amazon Route 53 for the current AWS account.

This operation returns paginated results.

Synopsis

Creating a Request

data ListDomains Source #

The ListDomains request includes the following elements.

See: newListDomains smart constructor.

Constructors

ListDomains'

Fields

marker :: Maybe Text
For an initial request for a list of domains, omit this element. If the number of domains that are associated with the current AWS account is greater than the value that you specified for MaxItems, you can use Marker to return additional domains. Get the value of NextPageMarker from the previous response, and submit another request that includes the value of NextPageMarker in the Marker element.
Constraints: The marker must match the value specified in the previous request.
maxItems :: Maybe Int
Number of domains to be returned.
Default: 20

Instances

Instances details

Eq ListDomains Source #
Instance details Defined in Amazonka.Route53Domains.ListDomains Methods (==) :: ListDomains -> ListDomains -> Bool # (/=) :: ListDomains -> ListDomains -> Bool #
Read ListDomains Source #
Instance details Defined in Amazonka.Route53Domains.ListDomains Methods readsPrec :: Int -> ReadS ListDomains # readList :: ReadS [ListDomains] # readPrec :: ReadPrec ListDomains # readListPrec :: ReadPrec [ListDomains] #
Show ListDomains Source #
Instance details Defined in Amazonka.Route53Domains.ListDomains Methods showsPrec :: Int -> ListDomains -> ShowS # show :: ListDomains -> String # showList :: [ListDomains] -> ShowS #
Generic ListDomains Source #
Instance details Defined in Amazonka.Route53Domains.ListDomains Associated Types type Rep ListDomains :: Type -> Type # Methods from :: ListDomains -> Rep ListDomains x # to :: Rep ListDomains x -> ListDomains #
NFData ListDomains Source #
Instance details Defined in Amazonka.Route53Domains.ListDomains Methods rnf :: ListDomains -> () #
Hashable ListDomains Source #
Instance details Defined in Amazonka.Route53Domains.ListDomains Methods hashWithSalt :: Int -> ListDomains -> Int # hash :: ListDomains -> Int #
ToJSON ListDomains Source #
Instance details Defined in Amazonka.Route53Domains.ListDomains Methods toJSON :: ListDomains -> Value # toEncoding :: ListDomains -> Encoding # toJSONList :: [ListDomains] -> Value # toEncodingList :: [ListDomains] -> Encoding #
AWSPager ListDomains Source #
Instance details Defined in Amazonka.Route53Domains.ListDomains Methods page :: ListDomains -> AWSResponse ListDomains -> Maybe ListDomains #
AWSRequest ListDomains Source #
Instance details Defined in Amazonka.Route53Domains.ListDomains Associated Types type AWSResponse ListDomains # Methods request :: ListDomains -> Request ListDomains # response :: MonadResource m => Logger -> Service -> Proxy ListDomains -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListDomains))) #
ToHeaders ListDomains Source #
Instance details Defined in Amazonka.Route53Domains.ListDomains Methods toHeaders :: ListDomains -> [Header] #
ToPath ListDomains Source #
Instance details Defined in Amazonka.Route53Domains.ListDomains Methods toPath :: ListDomains -> ByteString #
ToQuery ListDomains Source #
Instance details Defined in Amazonka.Route53Domains.ListDomains Methods toQuery :: ListDomains -> QueryString #
type Rep ListDomains Source #
Instance details Defined in Amazonka.Route53Domains.ListDomains type Rep ListDomains = D1 ('MetaData "ListDomains" "Amazonka.Route53Domains.ListDomains" "libZSservicesZSamazonka-route53-domainsZSamazonka-route53-domains" 'False) (C1 ('MetaCons "ListDomains'" 'PrefixI 'True) (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))
type AWSResponse ListDomains Source #
Instance details Defined in Amazonka.Route53Domains.ListDomains type AWSResponse ListDomains = ListDomainsResponse

newListDomains :: ListDomains Source #

Create a value of ListDomains 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:

$sel:marker:ListDomains', listDomains_marker - For an initial request for a list of domains, omit this element. If the number of domains that are associated with the current AWS account is greater than the value that you specified for MaxItems, you can use Marker to return additional domains. Get the value of NextPageMarker from the previous response, and submit another request that includes the value of NextPageMarker in the Marker element.

Constraints: The marker must match the value specified in the previous request.

$sel:maxItems:ListDomains', listDomains_maxItems - Number of domains to be returned.

Default: 20

Request Lenses

listDomains_marker :: Lens' ListDomains (Maybe Text) Source #

For an initial request for a list of domains, omit this element. If the number of domains that are associated with the current AWS account is greater than the value that you specified for MaxItems, you can use Marker to return additional domains. Get the value of NextPageMarker from the previous response, and submit another request that includes the value of NextPageMarker in the Marker element.

Constraints: The marker must match the value specified in the previous request.

listDomains_maxItems :: Lens' ListDomains (Maybe Int) Source #

Number of domains to be returned.

Default: 20

Destructuring the Response

data ListDomainsResponse Source #

The ListDomains response includes the following elements.

See: newListDomainsResponse smart constructor.

Constructors

ListDomainsResponse'
Fields nextPageMarker :: Maybe Text If there are more domains than you specified for `MaxItems` in the request, submit another request and include the value of `NextPageMarker` in the value of `Marker`. httpStatus :: Int The response's http status code. domains :: [DomainSummary] A summary of domains.

Instances

Instances details

Eq ListDomainsResponse Source #
Instance details Defined in Amazonka.Route53Domains.ListDomains Methods (==) :: ListDomainsResponse -> ListDomainsResponse -> Bool # (/=) :: ListDomainsResponse -> ListDomainsResponse -> Bool #
Read ListDomainsResponse Source #
Instance details Defined in Amazonka.Route53Domains.ListDomains Methods readsPrec :: Int -> ReadS ListDomainsResponse # readList :: ReadS [ListDomainsResponse] # readPrec :: ReadPrec ListDomainsResponse # readListPrec :: ReadPrec [ListDomainsResponse] #
Show ListDomainsResponse Source #
Instance details Defined in Amazonka.Route53Domains.ListDomains Methods showsPrec :: Int -> ListDomainsResponse -> ShowS # show :: ListDomainsResponse -> String # showList :: [ListDomainsResponse] -> ShowS #
Generic ListDomainsResponse Source #
Instance details Defined in Amazonka.Route53Domains.ListDomains Associated Types type Rep ListDomainsResponse :: Type -> Type # Methods from :: ListDomainsResponse -> Rep ListDomainsResponse x # to :: Rep ListDomainsResponse x -> ListDomainsResponse #
NFData ListDomainsResponse Source #
Instance details Defined in Amazonka.Route53Domains.ListDomains Methods rnf :: ListDomainsResponse -> () #
type Rep ListDomainsResponse Source #
Instance details Defined in Amazonka.Route53Domains.ListDomains type Rep ListDomainsResponse = D1 ('MetaData "ListDomainsResponse" "Amazonka.Route53Domains.ListDomains" "libZSservicesZSamazonka-route53-domainsZSamazonka-route53-domains" 'False) (C1 ('MetaCons "ListDomainsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextPageMarker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "domains") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [DomainSummary]))))

newListDomainsResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListDomainsResponse'`
-> ListDomainsResponse

Create a value of ListDomainsResponse 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:

$sel:nextPageMarker:ListDomainsResponse', listDomainsResponse_nextPageMarker - If there are more domains than you specified for MaxItems in the request, submit another request and include the value of NextPageMarker in the value of Marker.

$sel:httpStatus:ListDomainsResponse', listDomainsResponse_httpStatus - The response's http status code.

$sel:domains:ListDomainsResponse', listDomainsResponse_domains - A summary of domains.

Response Lenses

listDomainsResponse_nextPageMarker :: Lens' ListDomainsResponse (Maybe Text) Source #

If there are more domains than you specified for MaxItems in the request, submit another request and include the value of NextPageMarker in the value of Marker.

listDomainsResponse_httpStatus :: Lens' ListDomainsResponse Int Source #

The response's http status code.

listDomainsResponse_domains :: Lens' ListDomainsResponse [DomainSummary] Source #

A summary of domains.