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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns information about the current blue/green deployment happening on an Amazon OpenSearch Service domain. For more information, see Making configuration changes in Amazon OpenSearch Service.

Creating a Request

data DescribeDomainChangeProgress Source #

Container for the parameters to the DescribeDomainChangeProgress operation.

See: newDescribeDomainChangeProgress smart constructor.

Constructors

DescribeDomainChangeProgress'
Fields changeId :: Maybe Text The specific change ID for which you want to get progress information. If omitted, the request returns information about the most recent configuration change. domainName :: Text The name of the domain to get progress information for.

Instances

Instances details

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

newDescribeDomainChangeProgress Source #

Arguments

:: Text	`DescribeDomainChangeProgress`
-> DescribeDomainChangeProgress

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

DescribeDomainChangeProgress, describeDomainChangeProgress_changeId - The specific change ID for which you want to get progress information. If omitted, the request returns information about the most recent configuration change.

DescribeDomainChangeProgress, describeDomainChangeProgress_domainName - The name of the domain to get progress information for.

Request Lenses

describeDomainChangeProgress_changeId :: Lens' DescribeDomainChangeProgress (Maybe Text) Source #

The specific change ID for which you want to get progress information. If omitted, the request returns information about the most recent configuration change.

describeDomainChangeProgress_domainName :: Lens' DescribeDomainChangeProgress Text Source #

The name of the domain to get progress information for.

Destructuring the Response

data DescribeDomainChangeProgressResponse Source #

The result of a DescribeDomainChangeProgress request. Contains progress information for the requested domain change.

See: newDescribeDomainChangeProgressResponse smart constructor.

Constructors

DescribeDomainChangeProgressResponse'
Fields changeProgressStatus :: Maybe ChangeProgressStatusDetails Container for information about the stages of a configuration change happening on a domain. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDescribeDomainChangeProgressResponse Source #

Arguments

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

Create a value of DescribeDomainChangeProgressResponse 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:changeProgressStatus:DescribeDomainChangeProgressResponse', describeDomainChangeProgressResponse_changeProgressStatus - Container for information about the stages of a configuration change happening on a domain.

$sel:httpStatus:DescribeDomainChangeProgressResponse', describeDomainChangeProgressResponse_httpStatus - The response's http status code.

Response Lenses

describeDomainChangeProgressResponse_changeProgressStatus :: Lens' DescribeDomainChangeProgressResponse (Maybe ChangeProgressStatusDetails) Source #

Container for information about the stages of a configuration change happening on a domain.

describeDomainChangeProgressResponse_httpStatus :: Lens' DescribeDomainChangeProgressResponse Int Source #

The response's http status code.