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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service.

Creating a Request

data UpdatePackage Source #

Container for request parameters to the UpdatePackage operation.

See: newUpdatePackage smart constructor.

Constructors

UpdatePackage'
Fields commitMessage :: Maybe Text Commit message for the updated file, which is shown as part of `GetPackageVersionHistoryResponse`. packageDescription :: Maybe Text A new description of the package. packageID :: Text The unique identifier for the package. packageSource :: PackageSource Amazon S3 bucket and key for the package.

Instances

Instances details

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

newUpdatePackage Source #

Arguments

:: Text	`UpdatePackage`
-> PackageSource	`$sel:packageSource:UpdatePackage'`
-> UpdatePackage

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

UpdatePackage, updatePackage_commitMessage - Commit message for the updated file, which is shown as part of GetPackageVersionHistoryResponse.

UpdatePackage, updatePackage_packageDescription - A new description of the package.

UpdatePackage, updatePackage_packageID - The unique identifier for the package.

$sel:packageSource:UpdatePackage', updatePackage_packageSource - Amazon S3 bucket and key for the package.

Request Lenses

updatePackage_commitMessage :: Lens' UpdatePackage (Maybe Text) Source #

Commit message for the updated file, which is shown as part of GetPackageVersionHistoryResponse.

updatePackage_packageDescription :: Lens' UpdatePackage (Maybe Text) Source #

A new description of the package.

updatePackage_packageID :: Lens' UpdatePackage Text Source #

The unique identifier for the package.

updatePackage_packageSource :: Lens' UpdatePackage PackageSource Source #

Amazon S3 bucket and key for the package.

Destructuring the Response

data UpdatePackageResponse Source #

Container for the response returned by the UpdatePackage operation.

See: newUpdatePackageResponse smart constructor.

Constructors

UpdatePackageResponse'
Fields packageDetails :: Maybe PackageDetails Information about a package. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newUpdatePackageResponse Source #

Arguments

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

Create a value of UpdatePackageResponse 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:packageDetails:UpdatePackageResponse', updatePackageResponse_packageDetails - Information about a package.

$sel:httpStatus:UpdatePackageResponse', updatePackageResponse_httpStatus - The response's http status code.

Response Lenses

updatePackageResponse_packageDetails :: Lens' UpdatePackageResponse (Maybe PackageDetails) Source #

Information about a package.

updatePackageResponse_httpStatus :: Lens' UpdatePackageResponse Int Source #

The response's http status code.