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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Schedules a service software update for an Amazon OpenSearch Service domain. For more information, see Service software updates in Amazon OpenSearch Service.

Creating a Request

data StartServiceSoftwareUpdate Source #

Container for the request parameters to the StartServiceSoftwareUpdate operation.

See: newStartServiceSoftwareUpdate smart constructor.

Constructors

StartServiceSoftwareUpdate'
Fields domainName :: Text The name of the domain that you want to update to the latest service software.

Instances

Instances details

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

newStartServiceSoftwareUpdate Source #

Arguments

:: Text	`StartServiceSoftwareUpdate`
-> StartServiceSoftwareUpdate

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

StartServiceSoftwareUpdate, startServiceSoftwareUpdate_domainName - The name of the domain that you want to update to the latest service software.

Request Lenses

startServiceSoftwareUpdate_domainName :: Lens' StartServiceSoftwareUpdate Text Source #

The name of the domain that you want to update to the latest service software.

Destructuring the Response

data StartServiceSoftwareUpdateResponse Source #

Represents the output of a StartServiceSoftwareUpdate operation. Contains the status of the update.

See: newStartServiceSoftwareUpdateResponse smart constructor.

Constructors

StartServiceSoftwareUpdateResponse'
Fields serviceSoftwareOptions :: Maybe ServiceSoftwareOptions The current status of the OpenSearch Service software update. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newStartServiceSoftwareUpdateResponse Source #

Arguments

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

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

StartServiceSoftwareUpdateResponse, startServiceSoftwareUpdateResponse_serviceSoftwareOptions - The current status of the OpenSearch Service software update.

$sel:httpStatus:StartServiceSoftwareUpdateResponse', startServiceSoftwareUpdateResponse_httpStatus - The response's http status code.

Response Lenses

startServiceSoftwareUpdateResponse_serviceSoftwareOptions :: Lens' StartServiceSoftwareUpdateResponse (Maybe ServiceSoftwareOptions) Source #

The current status of the OpenSearch Service software update.

startServiceSoftwareUpdateResponse_httpStatus :: Lens' StartServiceSoftwareUpdateResponse Int Source #

The response's http status code.