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.ElasticSearch.DescribeElasticsearchDomains

Contents

Description

Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.

Creating a Request

data DescribeElasticsearchDomains Source #

Container for the parameters to the DescribeElasticsearchDomains operation. By default, the API returns the status of all Elasticsearch domains.

See: newDescribeElasticsearchDomains smart constructor.

Constructors

DescribeElasticsearchDomains'
Fields domainNames :: [Text] The Elasticsearch domains for which you want information.

Instances

Instances details

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

newDescribeElasticsearchDomains :: DescribeElasticsearchDomains Source #

Create a value of DescribeElasticsearchDomains 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:DescribeElasticsearchDomains', describeElasticsearchDomains_domainNames - The Elasticsearch domains for which you want information.

Request Lenses

describeElasticsearchDomains_domainNames :: Lens' DescribeElasticsearchDomains [Text] Source #

The Elasticsearch domains for which you want information.

Destructuring the Response

data DescribeElasticsearchDomainsResponse Source #

The result of a DescribeElasticsearchDomains request. Contains the status of the specified domains or all domains owned by the account.

See: newDescribeElasticsearchDomainsResponse smart constructor.

Constructors

DescribeElasticsearchDomainsResponse'
Fields httpStatus :: Int The response's http status code. domainStatusList :: [ElasticsearchDomainStatus] The status of the domains requested in the `DescribeElasticsearchDomains` request.

Instances

Instances details

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

newDescribeElasticsearchDomainsResponse Source #

Arguments

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

Create a value of DescribeElasticsearchDomainsResponse 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:DescribeElasticsearchDomainsResponse', describeElasticsearchDomainsResponse_httpStatus - The response's http status code.

$sel:domainStatusList:DescribeElasticsearchDomainsResponse', describeElasticsearchDomainsResponse_domainStatusList - The status of the domains requested in the DescribeElasticsearchDomains request.

Response Lenses

describeElasticsearchDomainsResponse_httpStatus :: Lens' DescribeElasticsearchDomainsResponse Int Source #

The response's http status code.

describeElasticsearchDomainsResponse_domainStatusList :: Lens' DescribeElasticsearchDomainsResponse [ElasticsearchDomainStatus] Source #

The status of the domains requested in the DescribeElasticsearchDomains request.