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.DescribeElasticsearchDomain

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Creating a Request

data DescribeElasticsearchDomain Source #

Container for the parameters to the DescribeElasticsearchDomain operation.

See: newDescribeElasticsearchDomain smart constructor.

Constructors

DescribeElasticsearchDomain'
Fields domainName :: Text The name of the Elasticsearch domain for which you want information.

Instances

Instances details

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

newDescribeElasticsearchDomain Source #

Arguments

:: Text	`DescribeElasticsearchDomain`
-> DescribeElasticsearchDomain

Create a value of DescribeElasticsearchDomain 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:

DescribeElasticsearchDomain, describeElasticsearchDomain_domainName - The name of the Elasticsearch domain for which you want information.

Request Lenses

describeElasticsearchDomain_domainName :: Lens' DescribeElasticsearchDomain Text Source #

The name of the Elasticsearch domain for which you want information.

Destructuring the Response

data DescribeElasticsearchDomainResponse Source #

The result of a DescribeElasticsearchDomain request. Contains the status of the domain specified in the request.

See: newDescribeElasticsearchDomainResponse smart constructor.

Constructors

DescribeElasticsearchDomainResponse'
Fields httpStatus :: Int The response's http status code. domainStatus :: ElasticsearchDomainStatus The current status of the Elasticsearch domain.

Instances

Instances details

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

newDescribeElasticsearchDomainResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeElasticsearchDomainResponse'`
-> ElasticsearchDomainStatus	`$sel:domainStatus:DescribeElasticsearchDomainResponse'`
-> DescribeElasticsearchDomainResponse

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

$sel:domainStatus:DescribeElasticsearchDomainResponse', describeElasticsearchDomainResponse_domainStatus - The current status of the Elasticsearch domain.

Response Lenses

describeElasticsearchDomainResponse_httpStatus :: Lens' DescribeElasticsearchDomainResponse Int Source #

The response's http status code.

describeElasticsearchDomainResponse_domainStatus :: Lens' DescribeElasticsearchDomainResponse ElasticsearchDomainStatus Source #

The current status of the Elasticsearch domain.