Amazonka.OpenSearchServerless.UpdateCollection

Updates an OpenSearch Serverless collection.

Creating a Request

data UpdateCollection

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

ToJSON UpdateCollection

Defined in Amazonka.OpenSearchServerless.UpdateCollection

Methods

toJSON :: UpdateCollection -> Value

toEncoding :: UpdateCollection -> Encoding

toJSONList :: [UpdateCollection] -> Value

toEncodingList :: [UpdateCollection] -> Encoding

ToHeaders UpdateCollection

Defined in Amazonka.OpenSearchServerless.UpdateCollection

Methods

toHeaders :: UpdateCollection -> [Header]

ToPath UpdateCollection

Defined in Amazonka.OpenSearchServerless.UpdateCollection

Methods

toPath :: UpdateCollection -> ByteString

ToQuery UpdateCollection

Defined in Amazonka.OpenSearchServerless.UpdateCollection

Methods

toQuery :: UpdateCollection -> QueryString

AWSRequest UpdateCollection

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

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

Defined in Amazonka.OpenSearchServerless.UpdateCollection

Methods

readsPrec :: Int -> ReadS UpdateCollection

readList :: ReadS [UpdateCollection]

readPrec :: ReadPrec UpdateCollection

readListPrec :: ReadPrec [UpdateCollection]

Show UpdateCollection

Defined in Amazonka.OpenSearchServerless.UpdateCollection

Methods

showsPrec :: Int -> UpdateCollection -> ShowS

show :: UpdateCollection -> String

showList :: [UpdateCollection] -> ShowS

NFData UpdateCollection

Defined in Amazonka.OpenSearchServerless.UpdateCollection

Methods

rnf :: UpdateCollection -> ()

Eq UpdateCollection

Defined in Amazonka.OpenSearchServerless.UpdateCollection

Methods

(==) :: UpdateCollection -> UpdateCollection -> Bool

(/=) :: UpdateCollection -> UpdateCollection -> Bool

Hashable UpdateCollection

Defined in Amazonka.OpenSearchServerless.UpdateCollection

Methods

hashWithSalt :: Int -> UpdateCollection -> Int

hash :: UpdateCollection -> Int

type AWSResponse UpdateCollection

Defined in Amazonka.OpenSearchServerless.UpdateCollection

type AWSResponse UpdateCollection = UpdateCollectionResponse

type Rep UpdateCollection

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

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)

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

updateCollection_description :: Lens' UpdateCollection (Maybe Text)

A description of the collection.

updateCollection_id :: Lens' UpdateCollection Text

The unique identifier of the collection.

Destructuring the Response

data UpdateCollectionResponse

See: newUpdateCollectionResponse smart constructor.

Constructors

UpdateCollectionResponse'

Fields

• updateCollectionDetail :: Maybe UpdateCollectionDetail

  Details about the updated collection.

• httpStatus :: Int

  The response's http status code.

Instances

Generic UpdateCollectionResponse

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

Defined in Amazonka.OpenSearchServerless.UpdateCollection

Methods

readsPrec :: Int -> ReadS UpdateCollectionResponse

readList :: ReadS [UpdateCollectionResponse]

readPrec :: ReadPrec UpdateCollectionResponse

readListPrec :: ReadPrec [UpdateCollectionResponse]

Show UpdateCollectionResponse

Defined in Amazonka.OpenSearchServerless.UpdateCollection

Methods

showsPrec :: Int -> UpdateCollectionResponse -> ShowS

show :: UpdateCollectionResponse -> String

showList :: [UpdateCollectionResponse] -> ShowS

NFData UpdateCollectionResponse

Defined in Amazonka.OpenSearchServerless.UpdateCollection

Methods

rnf :: UpdateCollectionResponse -> ()

Eq UpdateCollectionResponse

Defined in Amazonka.OpenSearchServerless.UpdateCollection

Methods

(==) :: UpdateCollectionResponse -> UpdateCollectionResponse -> Bool

(/=) :: UpdateCollectionResponse -> UpdateCollectionResponse -> Bool

type Rep UpdateCollectionResponse

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

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)

Details about the updated collection.

updateCollectionResponse_httpStatus :: Lens' UpdateCollectionResponse Int

The response's http status code.