| 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.CloudSearch.DescribeDomains
Description
Gets information about the search domains owned by this account. Can be
limited to specific domains. Shows all domains by default. To get the
number of searchable documents in a domain, use the console or submit a
matchall request to your domain's search endpoint:
q=matchall&q.parser=structured&size=0. For more information,
see
Getting Information about a Search Domain
in the Amazon CloudSearch Developer Guide.
Synopsis
- data DescribeDomains = DescribeDomains' {
- domainNames :: Maybe [Text]
- newDescribeDomains :: DescribeDomains
- describeDomains_domainNames :: Lens' DescribeDomains (Maybe [Text])
- data DescribeDomainsResponse = DescribeDomainsResponse' {}
- newDescribeDomainsResponse :: Int -> DescribeDomainsResponse
- describeDomainsResponse_httpStatus :: Lens' DescribeDomainsResponse Int
- describeDomainsResponse_domainStatusList :: Lens' DescribeDomainsResponse [DomainStatus]
Creating a Request
data DescribeDomains Source #
Container for the parameters to the DescribeDomains operation. By
default shows the status of all domains. To restrict the response to
particular domains, specify the names of the domains you want to
describe.
See: newDescribeDomains smart constructor.
Constructors
| DescribeDomains' | |
Fields
| |
Instances
newDescribeDomains :: DescribeDomains Source #
Create a value of DescribeDomains 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:domainNames:DescribeDomains', describeDomains_domainNames - The names of the domains you want to include in the response.
Request Lenses
describeDomains_domainNames :: Lens' DescribeDomains (Maybe [Text]) Source #
The names of the domains you want to include in the response.
Destructuring the Response
data DescribeDomainsResponse Source #
The result of a DescribeDomains request. Contains the status of the
domains specified in the request or all domains owned by the account.
See: newDescribeDomainsResponse smart constructor.
Constructors
| DescribeDomainsResponse' | |
Fields
| |
Instances
newDescribeDomainsResponse Source #
Create a value of DescribeDomainsResponse 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:httpStatus:DescribeDomainsResponse', describeDomainsResponse_httpStatus - The response's http status code.
$sel:domainStatusList:DescribeDomainsResponse', describeDomainsResponse_domainStatusList - Undocumented member.
Response Lenses
describeDomainsResponse_httpStatus :: Lens' DescribeDomainsResponse Int Source #
The response's http status code.
describeDomainsResponse_domainStatusList :: Lens' DescribeDomainsResponse [DomainStatus] Source #
Undocumented member.