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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Deletes the specified collection. Note that this operation removes all faces in the collection. For an example, see Deleting a collection.

This operation requires permissions to perform the rekognition:DeleteCollection action.

Creating a Request

data DeleteCollection Source #

See: newDeleteCollection smart constructor.

Constructors

DeleteCollection'
Fields collectionId :: Text ID of the collection to delete.

Instances

Instances details

ToJSON DeleteCollection Source #
Instance details Defined in Amazonka.Rekognition.DeleteCollection Methods toJSON :: DeleteCollection -> Value # toEncoding :: DeleteCollection -> Encoding # toJSONList :: [DeleteCollection] -> Value # toEncodingList :: [DeleteCollection] -> Encoding #
ToHeaders DeleteCollection Source #
Instance details Defined in Amazonka.Rekognition.DeleteCollection Methods toHeaders :: DeleteCollection -> [Header] #
ToPath DeleteCollection Source #
Instance details Defined in Amazonka.Rekognition.DeleteCollection Methods toPath :: DeleteCollection -> ByteString #
ToQuery DeleteCollection Source #
Instance details Defined in Amazonka.Rekognition.DeleteCollection Methods toQuery :: DeleteCollection -> QueryString #
AWSRequest DeleteCollection Source #
Instance details Defined in Amazonka.Rekognition.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.Rekognition.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.Rekognition.DeleteCollection Methods readsPrec :: Int -> ReadS DeleteCollection # readList :: ReadS [DeleteCollection] # readPrec :: ReadPrec DeleteCollection # readListPrec :: ReadPrec [DeleteCollection] #
Show DeleteCollection Source #
Instance details Defined in Amazonka.Rekognition.DeleteCollection Methods showsPrec :: Int -> DeleteCollection -> ShowS # show :: DeleteCollection -> String # showList :: [DeleteCollection] -> ShowS #
NFData DeleteCollection Source #
Instance details Defined in Amazonka.Rekognition.DeleteCollection Methods rnf :: DeleteCollection -> () #
Eq DeleteCollection Source #
Instance details Defined in Amazonka.Rekognition.DeleteCollection Methods (==) :: DeleteCollection -> DeleteCollection -> Bool # (/=) :: DeleteCollection -> DeleteCollection -> Bool #
Hashable DeleteCollection Source #
Instance details Defined in Amazonka.Rekognition.DeleteCollection Methods hashWithSalt :: Int -> DeleteCollection -> Int # hash :: DeleteCollection -> Int #
type AWSResponse DeleteCollection Source #
Instance details Defined in Amazonka.Rekognition.DeleteCollection type AWSResponse DeleteCollection = DeleteCollectionResponse
type Rep DeleteCollection Source #
Instance details Defined in Amazonka.Rekognition.DeleteCollection type Rep DeleteCollection = D1 ('MetaData "DeleteCollection" "Amazonka.Rekognition.DeleteCollection" "amazonka-rekognition-2.0-EaCrS9R3rWADqefEZvOx5B" 'False) (C1 ('MetaCons "DeleteCollection'" 'PrefixI 'True) (S1 ('MetaSel ('Just "collectionId") '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:

DeleteCollection, deleteCollection_collectionId - ID of the collection to delete.

Request Lenses

deleteCollection_collectionId :: Lens' DeleteCollection Text Source #

ID of the collection to delete.

Destructuring the Response

data DeleteCollectionResponse Source #

See: newDeleteCollectionResponse smart constructor.

Constructors

DeleteCollectionResponse'
Fields statusCode :: Maybe Natural HTTP status code that indicates the result of the operation. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DeleteCollectionResponse Source #
Instance details Defined in Amazonka.Rekognition.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.Rekognition.DeleteCollection Methods readsPrec :: Int -> ReadS DeleteCollectionResponse # readList :: ReadS [DeleteCollectionResponse] # readPrec :: ReadPrec DeleteCollectionResponse # readListPrec :: ReadPrec [DeleteCollectionResponse] #
Show DeleteCollectionResponse Source #
Instance details Defined in Amazonka.Rekognition.DeleteCollection Methods showsPrec :: Int -> DeleteCollectionResponse -> ShowS # show :: DeleteCollectionResponse -> String # showList :: [DeleteCollectionResponse] -> ShowS #
NFData DeleteCollectionResponse Source #
Instance details Defined in Amazonka.Rekognition.DeleteCollection Methods rnf :: DeleteCollectionResponse -> () #
Eq DeleteCollectionResponse Source #
Instance details Defined in Amazonka.Rekognition.DeleteCollection Methods (==) :: DeleteCollectionResponse -> DeleteCollectionResponse -> Bool # (/=) :: DeleteCollectionResponse -> DeleteCollectionResponse -> Bool #
type Rep DeleteCollectionResponse Source #
Instance details Defined in Amazonka.Rekognition.DeleteCollection type Rep DeleteCollectionResponse = D1 ('MetaData "DeleteCollectionResponse" "Amazonka.Rekognition.DeleteCollection" "amazonka-rekognition-2.0-EaCrS9R3rWADqefEZvOx5B" 'False) (C1 ('MetaCons "DeleteCollectionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "statusCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: 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:statusCode:DeleteCollectionResponse', deleteCollectionResponse_statusCode - HTTP status code that indicates the result of the operation.

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

Response Lenses

deleteCollectionResponse_statusCode :: Lens' DeleteCollectionResponse (Maybe Natural) Source #

HTTP status code that indicates the result of the operation.

deleteCollectionResponse_httpStatus :: Lens' DeleteCollectionResponse Int Source #

The response's http status code.