| 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.Route53Domains.ListDomains
Description
This operation returns all the domain names registered with Amazon Route 53 for the current Amazon Web Services account if no filtering conditions are used.
This operation returns paginated results.
Synopsis
- data ListDomains = ListDomains' {}
- newListDomains :: ListDomains
- listDomains_filterConditions :: Lens' ListDomains (Maybe [FilterCondition])
- listDomains_marker :: Lens' ListDomains (Maybe Text)
- listDomains_maxItems :: Lens' ListDomains (Maybe Int)
- listDomains_sortCondition :: Lens' ListDomains (Maybe SortCondition)
- data ListDomainsResponse = ListDomainsResponse' {
- domains :: Maybe [DomainSummary]
- nextPageMarker :: Maybe Text
- httpStatus :: Int
- newListDomainsResponse :: Int -> ListDomainsResponse
- listDomainsResponse_domains :: Lens' ListDomainsResponse (Maybe [DomainSummary])
- listDomainsResponse_nextPageMarker :: Lens' ListDomainsResponse (Maybe Text)
- listDomainsResponse_httpStatus :: Lens' ListDomainsResponse Int
Creating a Request
data ListDomains Source #
The ListDomains request includes the following elements.
See: newListDomains smart constructor.
Constructors
| ListDomains' | |
Fields
| |
Instances
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:filterConditions:ListDomains', listDomains_filterConditions - A complex type that contains information about the filters applied
during the ListDomains request. The filter conditions can include
domain name and domain expiration.
$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 Amazon Web
Services 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
$sel:sortCondition:ListDomains', listDomains_sortCondition - A complex type that contains information about the requested ordering of
domains in the returned list.
Request Lenses
listDomains_filterConditions :: Lens' ListDomains (Maybe [FilterCondition]) Source #
A complex type that contains information about the filters applied
during the ListDomains request. The filter conditions can include
domain name and domain expiration.
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 Amazon Web
Services 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
listDomains_sortCondition :: Lens' ListDomains (Maybe SortCondition) Source #
A complex type that contains information about the requested ordering of domains in the returned list.
Destructuring the Response
data ListDomainsResponse Source #
The ListDomains response includes the following elements.
See: newListDomainsResponse smart constructor.
Constructors
| ListDomainsResponse' | |
Fields
| |
Instances
newListDomainsResponse Source #
Arguments
| :: Int | |
| -> 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:domains:ListDomainsResponse', listDomainsResponse_domains - A list of domains.
$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.
Response Lenses
listDomainsResponse_domains :: Lens' ListDomainsResponse (Maybe [DomainSummary]) Source #
A list of domains.
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.