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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes the domain configuration for the specified Amazon OpenSearch Service domain, including the domain ID, domain service 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 that you want information about.

Instances

Instances details

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 #
AWSRequest DescribeDomain Source #
Instance details Defined in Amazonka.OpenSearch.DescribeDomain Associated Types type AWSResponse DescribeDomain # Methods request :: (Service -> Service) -> DescribeDomain -> Request DescribeDomain # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeDomain -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeDomain))) #
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 #
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 #
NFData DescribeDomain Source #
Instance details Defined in Amazonka.OpenSearch.DescribeDomain Methods rnf :: DescribeDomain -> () #
Eq DescribeDomain Source #
Instance details Defined in Amazonka.OpenSearch.DescribeDomain Methods (==) :: DescribeDomain -> DescribeDomain -> Bool # (/=) :: DescribeDomain -> DescribeDomain -> Bool #
Hashable DescribeDomain Source #
Instance details Defined in Amazonka.OpenSearch.DescribeDomain Methods hashWithSalt :: Int -> DescribeDomain -> Int # hash :: DescribeDomain -> Int #
type AWSResponse DescribeDomain Source #
Instance details Defined in Amazonka.OpenSearch.DescribeDomain type AWSResponse DescribeDomain = DescribeDomainResponse
type Rep DescribeDomain Source #
Instance details Defined in Amazonka.OpenSearch.DescribeDomain type Rep DescribeDomain = D1 ('MetaData "DescribeDomain" "Amazonka.OpenSearch.DescribeDomain" "amazonka-opensearch-2.0-GNoaWlqGXH04P8GBIHM78L" 'False) (C1 ('MetaCons "DescribeDomain'" 'PrefixI 'True) (S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeDomain Source #

Arguments

:: Text	`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:

DescribeDomain, describeDomain_domainName - The name of the domain that you want information about.

Request Lenses

describeDomain_domainName :: Lens' DescribeDomain Text Source #

The name of the domain that you want information about.

Destructuring the Response

data DescribeDomainResponse Source #

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 List that contains the status of each specified OpenSearch Service domain.

Instances

Instances details

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 #
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 #
NFData DescribeDomainResponse Source #
Instance details Defined in Amazonka.OpenSearch.DescribeDomain Methods rnf :: DescribeDomainResponse -> () #
Eq DescribeDomainResponse Source #
Instance details Defined in Amazonka.OpenSearch.DescribeDomain Methods (==) :: DescribeDomainResponse -> DescribeDomainResponse -> Bool # (/=) :: DescribeDomainResponse -> DescribeDomainResponse -> Bool #
type Rep DescribeDomainResponse Source #
Instance details Defined in Amazonka.OpenSearch.DescribeDomain type Rep DescribeDomainResponse = D1 ('MetaData "DescribeDomainResponse" "Amazonka.OpenSearch.DescribeDomain" "amazonka-opensearch-2.0-GNoaWlqGXH04P8GBIHM78L" '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 - List that contains the status of each specified OpenSearch Service domain.

Response Lenses

describeDomainResponse_httpStatus :: Lens' DescribeDomainResponse Int Source #

The response's http status code.

describeDomainResponse_domainStatus :: Lens' DescribeDomainResponse DomainStatus Source #

List that contains the status of each specified OpenSearch Service domain.