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.OpenSearch.DescribeDomains

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns domain configuration information about the specified Amazon OpenSearch Service domains.

Creating a Request

data DescribeDomains Source #

Container for the parameters to the DescribeDomains operation.

See: newDescribeDomains smart constructor.

Constructors

DescribeDomains'
Fields domainNames :: [Text] Array of OpenSearch Service domain names that you want information about. If you don't specify any domains, OpenSearch Service returns information about all domains owned by the account.

Instances

Instances details

ToJSON DescribeDomains Source #
Instance details Defined in Amazonka.OpenSearch.DescribeDomains Methods toJSON :: DescribeDomains -> Value # toEncoding :: DescribeDomains -> Encoding # toJSONList :: [DescribeDomains] -> Value # toEncodingList :: [DescribeDomains] -> Encoding #
ToHeaders DescribeDomains Source #
Instance details Defined in Amazonka.OpenSearch.DescribeDomains Methods toHeaders :: DescribeDomains -> [Header] #
ToPath DescribeDomains Source #
Instance details Defined in Amazonka.OpenSearch.DescribeDomains Methods toPath :: DescribeDomains -> ByteString #
ToQuery DescribeDomains Source #
Instance details Defined in Amazonka.OpenSearch.DescribeDomains Methods toQuery :: DescribeDomains -> QueryString #
AWSRequest DescribeDomains Source #
Instance details Defined in Amazonka.OpenSearch.DescribeDomains Associated Types type AWSResponse DescribeDomains # Methods request :: (Service -> Service) -> DescribeDomains -> Request DescribeDomains # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeDomains -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeDomains))) #
Generic DescribeDomains Source #
Instance details Defined in Amazonka.OpenSearch.DescribeDomains Associated Types type Rep DescribeDomains :: Type -> Type # Methods from :: DescribeDomains -> Rep DescribeDomains x # to :: Rep DescribeDomains x -> DescribeDomains #
Read DescribeDomains Source #
Instance details Defined in Amazonka.OpenSearch.DescribeDomains Methods readsPrec :: Int -> ReadS DescribeDomains # readList :: ReadS [DescribeDomains] # readPrec :: ReadPrec DescribeDomains # readListPrec :: ReadPrec [DescribeDomains] #
Show DescribeDomains Source #
Instance details Defined in Amazonka.OpenSearch.DescribeDomains Methods showsPrec :: Int -> DescribeDomains -> ShowS # show :: DescribeDomains -> String # showList :: [DescribeDomains] -> ShowS #
NFData DescribeDomains Source #
Instance details Defined in Amazonka.OpenSearch.DescribeDomains Methods rnf :: DescribeDomains -> () #
Eq DescribeDomains Source #
Instance details Defined in Amazonka.OpenSearch.DescribeDomains Methods (==) :: DescribeDomains -> DescribeDomains -> Bool # (/=) :: DescribeDomains -> DescribeDomains -> Bool #
Hashable DescribeDomains Source #
Instance details Defined in Amazonka.OpenSearch.DescribeDomains Methods hashWithSalt :: Int -> DescribeDomains -> Int # hash :: DescribeDomains -> Int #
type AWSResponse DescribeDomains Source #
Instance details Defined in Amazonka.OpenSearch.DescribeDomains type AWSResponse DescribeDomains = DescribeDomainsResponse
type Rep DescribeDomains Source #
Instance details Defined in Amazonka.OpenSearch.DescribeDomains type Rep DescribeDomains = D1 ('MetaData "DescribeDomains" "Amazonka.OpenSearch.DescribeDomains" "amazonka-opensearch-2.0-GNoaWlqGXH04P8GBIHM78L" 'False) (C1 ('MetaCons "DescribeDomains'" 'PrefixI 'True) (S1 ('MetaSel ('Just "domainNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text])))

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 - Array of OpenSearch Service domain names that you want information about. If you don't specify any domains, OpenSearch Service returns information about all domains owned by the account.

Request Lenses

describeDomains_domainNames :: Lens' DescribeDomains [Text] Source #

Array of OpenSearch Service domain names that you want information about. If you don't specify any domains, OpenSearch Service returns information about all domains owned by the account.

Destructuring the Response

data DescribeDomainsResponse Source #

Contains the status of the specified domains or all domains owned by the account.

See: newDescribeDomainsResponse smart constructor.

Constructors

DescribeDomainsResponse'
Fields httpStatus :: Int The response's http status code. domainStatusList :: [DomainStatus] The status of the requested domains.

Instances

Instances details

Generic DescribeDomainsResponse Source #
Instance details Defined in Amazonka.OpenSearch.DescribeDomains Associated Types type Rep DescribeDomainsResponse :: Type -> Type # Methods from :: DescribeDomainsResponse -> Rep DescribeDomainsResponse x # to :: Rep DescribeDomainsResponse x -> DescribeDomainsResponse #
Read DescribeDomainsResponse Source #
Instance details Defined in Amazonka.OpenSearch.DescribeDomains Methods readsPrec :: Int -> ReadS DescribeDomainsResponse # readList :: ReadS [DescribeDomainsResponse] # readPrec :: ReadPrec DescribeDomainsResponse # readListPrec :: ReadPrec [DescribeDomainsResponse] #
Show DescribeDomainsResponse Source #
Instance details Defined in Amazonka.OpenSearch.DescribeDomains Methods showsPrec :: Int -> DescribeDomainsResponse -> ShowS # show :: DescribeDomainsResponse -> String # showList :: [DescribeDomainsResponse] -> ShowS #
NFData DescribeDomainsResponse Source #
Instance details Defined in Amazonka.OpenSearch.DescribeDomains Methods rnf :: DescribeDomainsResponse -> () #
Eq DescribeDomainsResponse Source #
Instance details Defined in Amazonka.OpenSearch.DescribeDomains Methods (==) :: DescribeDomainsResponse -> DescribeDomainsResponse -> Bool # (/=) :: DescribeDomainsResponse -> DescribeDomainsResponse -> Bool #
type Rep DescribeDomainsResponse Source #
Instance details Defined in Amazonka.OpenSearch.DescribeDomains type Rep DescribeDomainsResponse = D1 ('MetaData "DescribeDomainsResponse" "Amazonka.OpenSearch.DescribeDomains" "amazonka-opensearch-2.0-GNoaWlqGXH04P8GBIHM78L" 'False) (C1 ('MetaCons "DescribeDomainsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "domainStatusList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [DomainStatus])))

newDescribeDomainsResponse Source #

Arguments

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

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 - The status of the requested domains.

Response Lenses

describeDomainsResponse_httpStatus :: Lens' DescribeDomainsResponse Int Source #

The response's http status code.

describeDomainsResponse_domainStatusList :: Lens' DescribeDomainsResponse [DomainStatus] Source #

The status of the requested domains.