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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Deletes an OpenSearch Serverless collection. For more information, see Creating and managing Amazon OpenSearch Serverless collections.

Creating a Request

data DeleteCollection Source #

See: newDeleteCollection smart constructor.

Constructors

DeleteCollection'
Fields clientToken :: Maybe Text A unique, case-sensitive identifier to ensure idempotency of the request. id :: Text The unique identifier of the collection. For example, `1iu5usc406kd`. The ID is part of the collection endpoint. You can also retrieve it using the ListCollections API.

Instances

Instances details

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

newDeleteCollection Source #

Arguments

:: Text	`DeleteCollection`
-> DeleteCollection

Create a value of DeleteCollection 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:DeleteCollection', deleteCollection_clientToken - A unique, case-sensitive identifier to ensure idempotency of the request.

DeleteCollection, deleteCollection_id - The unique identifier of the collection. For example, 1iu5usc406kd. The ID is part of the collection endpoint. You can also retrieve it using the ListCollections API.

Request Lenses

deleteCollection_clientToken :: Lens' DeleteCollection (Maybe Text) Source #

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

deleteCollection_id :: Lens' DeleteCollection Text Source #

The unique identifier of the collection. For example, 1iu5usc406kd. The ID is part of the collection endpoint. You can also retrieve it using the ListCollections API.

Destructuring the Response

data DeleteCollectionResponse Source #

See: newDeleteCollectionResponse smart constructor.

Constructors

DeleteCollectionResponse'
Fields deleteCollectionDetail :: Maybe DeleteCollectionDetail Details of the deleted collection. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDeleteCollectionResponse Source #

Arguments

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

Create a value of DeleteCollectionResponse 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:deleteCollectionDetail:DeleteCollectionResponse', deleteCollectionResponse_deleteCollectionDetail - Details of the deleted collection.

$sel:httpStatus:DeleteCollectionResponse', deleteCollectionResponse_httpStatus - The response's http status code.

Response Lenses

deleteCollectionResponse_deleteCollectionDetail :: Lens' DeleteCollectionResponse (Maybe DeleteCollectionDetail) Source #

Details of the deleted collection.

deleteCollectionResponse_httpStatus :: Lens' DeleteCollectionResponse Int Source #

The response's http status code.