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 |
Returns a list of all domains in the user's account.
This operation returns paginated results.
Synopsis
- data GetDomains = GetDomains' {}
- newGetDomains :: GetDomains
- getDomains_pageToken :: Lens' GetDomains (Maybe Text)
- data GetDomainsResponse = GetDomainsResponse' {
- domains :: Maybe [Domain]
- nextPageToken :: Maybe Text
- httpStatus :: Int
- newGetDomainsResponse :: Int -> GetDomainsResponse
- getDomainsResponse_domains :: Lens' GetDomainsResponse (Maybe [Domain])
- getDomainsResponse_nextPageToken :: Lens' GetDomainsResponse (Maybe Text)
- getDomainsResponse_httpStatus :: Lens' GetDomainsResponse Int
Creating a Request
data GetDomains Source #
See: newGetDomains
smart constructor.
Instances
newGetDomains :: GetDomains Source #
Create a value of GetDomains
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:pageToken:GetDomains'
, getDomains_pageToken
- The token to advance to the next page of results from your request.
To get a page token, perform an initial GetDomains
request. If your
results are paginated, the response will return a next page token that
you can specify as the page token in a subsequent request.
Request Lenses
getDomains_pageToken :: Lens' GetDomains (Maybe Text) Source #
The token to advance to the next page of results from your request.
To get a page token, perform an initial GetDomains
request. If your
results are paginated, the response will return a next page token that
you can specify as the page token in a subsequent request.
Destructuring the Response
data GetDomainsResponse Source #
See: newGetDomainsResponse
smart constructor.
GetDomainsResponse' | |
|
Instances
newGetDomainsResponse Source #
Create a value of GetDomainsResponse
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:domains:GetDomainsResponse'
, getDomainsResponse_domains
- An array of key-value pairs containing information about each of the
domain entries in the user's account.
$sel:nextPageToken:GetDomainsResponse'
, getDomainsResponse_nextPageToken
- The token to advance to the next page of results from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another GetDomains
request
and specify the next page token using the pageToken
parameter.
$sel:httpStatus:GetDomainsResponse'
, getDomainsResponse_httpStatus
- The response's http status code.
Response Lenses
getDomainsResponse_domains :: Lens' GetDomainsResponse (Maybe [Domain]) Source #
An array of key-value pairs containing information about each of the domain entries in the user's account.
getDomainsResponse_nextPageToken :: Lens' GetDomainsResponse (Maybe Text) Source #
The token to advance to the next page of results from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another GetDomains
request
and specify the next page token using the pageToken
parameter.
getDomainsResponse_httpStatus :: Lens' GetDomainsResponse Int Source #
The response's http status code.