Copyright | (c) 2013-2015 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 |
This operation returns all the domain names registered with Amazon Route 53 for the current AWS account.
See: AWS API Reference for ListDomains.
This operation returns paginated results.
- listDomains :: ListDomains
- data ListDomains
- ldMarker :: Lens' ListDomains (Maybe Text)
- ldMaxItems :: Lens' ListDomains (Maybe Int)
- listDomainsResponse :: Int -> ListDomainsResponse
- data ListDomainsResponse
- ldrsNextPageMarker :: Lens' ListDomainsResponse (Maybe Text)
- ldrsResponseStatus :: Lens' ListDomainsResponse Int
- ldrsDomains :: Lens' ListDomainsResponse [DomainSummary]
Creating a Request
listDomains :: ListDomains Source
Creates a value of ListDomains
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data ListDomains Source
The ListDomains request includes the following elements.
See: listDomains
smart constructor.
Request Lenses
ldMarker :: 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.
Type: String
Default: None
Constraints: The marker must match the value specified in the previous request.
Required: No
ldMaxItems :: Lens' ListDomains (Maybe Int) Source
Number of domains to be returned.
Type: Integer
Default: 20
Constraints: A numeral between 1 and 100.
Required: No
Destructuring the Response
Creates a value of ListDomainsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data ListDomainsResponse Source
The ListDomains response includes the following elements.
See: listDomainsResponse
smart constructor.
Response Lenses
ldrsNextPageMarker :: 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
.
Type: String
Parent: Operations
ldrsResponseStatus :: Lens' ListDomainsResponse Int Source
The response status code.
ldrsDomains :: Lens' ListDomainsResponse [DomainSummary] Source
A summary of domains.
Type: Complex type containing a list of domain summaries.
Children: AutoRenew
, DomainName
, Expiry
, TransferLock