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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Creating a Request

data DescribeDomain Source #

Container for the parameters to the DescribeDomain operation.

See: newDescribeDomain smart constructor.

Constructors

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

Instances

Instances details

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

newDescribeDomain Source #

Arguments

:: Text	`$sel:domainName:DescribeDomain'`
-> DescribeDomain

Create a value of DescribeDomain 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:domainName:DescribeDomain', describeDomain_domainName - The name of the domain for which you want information.

Request Lenses

describeDomain_domainName :: Lens' DescribeDomain Text Source #

The name of the domain for which you want information.

Destructuring the Response

data DescribeDomainResponse Source #

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

See: newDescribeDomainResponse smart constructor.

Constructors

DescribeDomainResponse'
Fields httpStatus :: Int The response's http status code. domainStatus :: DomainStatus The current status of the domain.

Instances

Instances details

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

newDescribeDomainResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeDomainResponse'`
-> DomainStatus	`$sel:domainStatus:DescribeDomainResponse'`
-> DescribeDomainResponse

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

$sel:domainStatus:DescribeDomainResponse', describeDomainResponse_domainStatus - The current status of the domain.

Response Lenses

describeDomainResponse_httpStatus :: Lens' DescribeDomainResponse Int Source #

The response's http status code.

describeDomainResponse_domainStatus :: Lens' DescribeDomainResponse DomainStatus Source #

The current status of the domain.