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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Cancels a scheduled service software update for an Amazon OpenSearch Service domain. You can only perform this operation before the AutomatedUpdateDate and when the domain's UpdateStatus is PENDING_UPDATE. For more information, see Service software updates in Amazon OpenSearch Service.

Creating a Request

data CancelServiceSoftwareUpdate Source #

Container for the request parameters to cancel a service software update.

See: newCancelServiceSoftwareUpdate smart constructor.

Constructors

CancelServiceSoftwareUpdate'
Fields domainName :: Text Name of the OpenSearch Service domain that you want to cancel the service software update on.

Instances

Instances details

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

newCancelServiceSoftwareUpdate Source #

Arguments

:: Text	`CancelServiceSoftwareUpdate`
-> CancelServiceSoftwareUpdate

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

CancelServiceSoftwareUpdate, cancelServiceSoftwareUpdate_domainName - Name of the OpenSearch Service domain that you want to cancel the service software update on.

Request Lenses

cancelServiceSoftwareUpdate_domainName :: Lens' CancelServiceSoftwareUpdate Text Source #

Name of the OpenSearch Service domain that you want to cancel the service software update on.

Destructuring the Response

data CancelServiceSoftwareUpdateResponse Source #

Container for the response to a CancelServiceSoftwareUpdate operation. Contains the status of the update.

See: newCancelServiceSoftwareUpdateResponse smart constructor.

Constructors

CancelServiceSoftwareUpdateResponse'
Fields serviceSoftwareOptions :: Maybe ServiceSoftwareOptions Container for the state of your domain relative to the latest service software. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newCancelServiceSoftwareUpdateResponse Source #

Arguments

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

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

CancelServiceSoftwareUpdateResponse, cancelServiceSoftwareUpdateResponse_serviceSoftwareOptions - Container for the state of your domain relative to the latest service software.

$sel:httpStatus:CancelServiceSoftwareUpdateResponse', cancelServiceSoftwareUpdateResponse_httpStatus - The response's http status code.

Response Lenses

cancelServiceSoftwareUpdateResponse_serviceSoftwareOptions :: Lens' CancelServiceSoftwareUpdateResponse (Maybe ServiceSoftwareOptions) Source #

Container for the state of your domain relative to the latest service software.

cancelServiceSoftwareUpdateResponse_httpStatus :: Lens' CancelServiceSoftwareUpdateResponse Int Source #

The response's http status code.