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.OpenSearchServerless.UpdateCollection

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates an OpenSearch Serverless collection.

Creating a Request

data UpdateCollection Source #

See: newUpdateCollection smart constructor.

Constructors

UpdateCollection'
Fields clientToken :: Maybe Text Unique, case-sensitive identifier to ensure idempotency of the request. description :: Maybe Text A description of the collection. id :: Text The unique identifier of the collection.

Instances

Instances details

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

newUpdateCollection Source #

Arguments

:: Text	`UpdateCollection`
-> UpdateCollection

Create a value of UpdateCollection 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:clientToken:UpdateCollection', updateCollection_clientToken - Unique, case-sensitive identifier to ensure idempotency of the request.

UpdateCollection, updateCollection_description - A description of the collection.

UpdateCollection, updateCollection_id - The unique identifier of the collection.

Request Lenses

updateCollection_clientToken :: Lens' UpdateCollection (Maybe Text) Source #

Unique, case-sensitive identifier to ensure idempotency of the request.

updateCollection_description :: Lens' UpdateCollection (Maybe Text) Source #

A description of the collection.

updateCollection_id :: Lens' UpdateCollection Text Source #

The unique identifier of the collection.

Destructuring the Response

data UpdateCollectionResponse Source #

See: newUpdateCollectionResponse smart constructor.

Constructors

UpdateCollectionResponse'
Fields updateCollectionDetail :: Maybe UpdateCollectionDetail Details about the updated collection. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newUpdateCollectionResponse Source #

Arguments

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

Create a value of UpdateCollectionResponse 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:updateCollectionDetail:UpdateCollectionResponse', updateCollectionResponse_updateCollectionDetail - Details about the updated collection.

$sel:httpStatus:UpdateCollectionResponse', updateCollectionResponse_httpStatus - The response's http status code.

Response Lenses

updateCollectionResponse_updateCollectionDetail :: Lens' UpdateCollectionResponse (Maybe UpdateCollectionDetail) Source #

Details about the updated collection.

updateCollectionResponse_httpStatus :: Lens' UpdateCollectionResponse Int Source #

The response's http status code.