Amazonka.Rekognition.DeleteCollection

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

See: newDeleteCollection smart constructor.

Constructors

DeleteCollection'

Fields

• collectionId :: Text

  ID of the collection to delete.

Instances

ToJSON DeleteCollection

Defined in Amazonka.Rekognition.DeleteCollection

Methods

toJSON :: DeleteCollection -> Value

toEncoding :: DeleteCollection -> Encoding

toJSONList :: [DeleteCollection] -> Value

toEncodingList :: [DeleteCollection] -> Encoding

ToHeaders DeleteCollection

Defined in Amazonka.Rekognition.DeleteCollection

Methods

toHeaders :: DeleteCollection -> [Header]

ToPath DeleteCollection

Defined in Amazonka.Rekognition.DeleteCollection

Methods

toPath :: DeleteCollection -> ByteString

ToQuery DeleteCollection

Defined in Amazonka.Rekognition.DeleteCollection

Methods

toQuery :: DeleteCollection -> QueryString

AWSRequest DeleteCollection

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

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

Defined in Amazonka.Rekognition.DeleteCollection

Methods

readsPrec :: Int -> ReadS DeleteCollection

readList :: ReadS [DeleteCollection]

readPrec :: ReadPrec DeleteCollection

readListPrec :: ReadPrec [DeleteCollection]

Show DeleteCollection

Defined in Amazonka.Rekognition.DeleteCollection

Methods

showsPrec :: Int -> DeleteCollection -> ShowS

show :: DeleteCollection -> String

showList :: [DeleteCollection] -> ShowS

NFData DeleteCollection

Defined in Amazonka.Rekognition.DeleteCollection

Methods

rnf :: DeleteCollection -> ()

Eq DeleteCollection

Defined in Amazonka.Rekognition.DeleteCollection

Methods

(==) :: DeleteCollection -> DeleteCollection -> Bool

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

Hashable DeleteCollection

Defined in Amazonka.Rekognition.DeleteCollection

Methods

hashWithSalt :: Int -> DeleteCollection -> Int

hash :: DeleteCollection -> Int

type AWSResponse DeleteCollection

Defined in Amazonka.Rekognition.DeleteCollection

type AWSResponse DeleteCollection = DeleteCollectionResponse

type Rep DeleteCollection

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

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

ID of the collection to delete.

Destructuring the Response

data DeleteCollectionResponse

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

Generic DeleteCollectionResponse

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

Defined in Amazonka.Rekognition.DeleteCollection

Methods

readsPrec :: Int -> ReadS DeleteCollectionResponse

readList :: ReadS [DeleteCollectionResponse]

readPrec :: ReadPrec DeleteCollectionResponse

readListPrec :: ReadPrec [DeleteCollectionResponse]

Show DeleteCollectionResponse

Defined in Amazonka.Rekognition.DeleteCollection

Methods

showsPrec :: Int -> DeleteCollectionResponse -> ShowS

show :: DeleteCollectionResponse -> String

showList :: [DeleteCollectionResponse] -> ShowS

NFData DeleteCollectionResponse

Defined in Amazonka.Rekognition.DeleteCollection

Methods

rnf :: DeleteCollectionResponse -> ()

Eq DeleteCollectionResponse

Defined in Amazonka.Rekognition.DeleteCollection

Methods

(==) :: DeleteCollectionResponse -> DeleteCollectionResponse -> Bool

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

type Rep DeleteCollectionResponse

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

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)

HTTP status code that indicates the result of the operation.

deleteCollectionResponse_httpStatus :: Lens' DeleteCollectionResponse Int

The response's http status code.