Network.AWS.Rekognition.DeleteFaces

Deletes faces from a collection. You specify a collection ID and an array of face IDs to remove from the collection.

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

Creating a Request

deleteFaces

Arguments

:: Text

dfCollectionId

-> NonEmpty Text

dfFaceIds

-> DeleteFaces

Creates a value of DeleteFaces with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dfCollectionId - Collection from which to remove the specific faces.
• dfFaceIds - An array of face IDs to delete.

data DeleteFaces

See: deleteFaces smart constructor.

Instances

Eq DeleteFaces

Methods

(==) :: DeleteFaces -> DeleteFaces -> Bool

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

Data DeleteFaces

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DeleteFaces -> c DeleteFaces

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DeleteFaces

toConstr :: DeleteFaces -> Constr

dataTypeOf :: DeleteFaces -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DeleteFaces)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DeleteFaces)

gmapT :: (forall b. Data b => b -> b) -> DeleteFaces -> DeleteFaces

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DeleteFaces -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DeleteFaces -> r

gmapQ :: (forall d. Data d => d -> u) -> DeleteFaces -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DeleteFaces -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DeleteFaces -> m DeleteFaces

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteFaces -> m DeleteFaces

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteFaces -> m DeleteFaces

Read DeleteFaces

Methods

readsPrec :: Int -> ReadS DeleteFaces

readList :: ReadS [DeleteFaces]

readPrec :: ReadPrec DeleteFaces

readListPrec :: ReadPrec [DeleteFaces]

Show DeleteFaces

Methods

showsPrec :: Int -> DeleteFaces -> ShowS

show :: DeleteFaces -> String

showList :: [DeleteFaces] -> ShowS

Generic DeleteFaces

Associated Types

type Rep DeleteFaces :: * -> *

Methods

from :: DeleteFaces -> Rep DeleteFaces x

to :: Rep DeleteFaces x -> DeleteFaces

Hashable DeleteFaces

Methods

hashWithSalt :: Int -> DeleteFaces -> Int

hash :: DeleteFaces -> Int

ToJSON DeleteFaces

Methods

toJSON :: DeleteFaces -> Value

toEncoding :: DeleteFaces -> Encoding

toJSONList :: [DeleteFaces] -> Value

toEncodingList :: [DeleteFaces] -> Encoding

NFData DeleteFaces

Methods

rnf :: DeleteFaces -> ()

AWSRequest DeleteFaces

Associated Types

type Rs DeleteFaces :: *

Methods

request :: DeleteFaces -> Request DeleteFaces

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * DeleteFaces -> ClientResponse -> m (Response DeleteFaces)

ToHeaders DeleteFaces

Methods

toHeaders :: DeleteFaces -> [Header]

ToPath DeleteFaces

Methods

toPath :: DeleteFaces -> ByteString

ToQuery DeleteFaces

Methods

toQuery :: DeleteFaces -> QueryString

type Rep DeleteFaces

type Rep DeleteFaces = D1 * (MetaData "DeleteFaces" "Network.AWS.Rekognition.DeleteFaces" "amazonka-rekognition-1.6.0-3jgXZy5HWud2mYhTRx5OTT" False) (C1 * (MetaCons "DeleteFaces'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_dfCollectionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_dfFaceIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (List1 Text)))))

type Rs DeleteFaces

type Rs DeleteFaces = DeleteFacesResponse

Request Lenses

dfCollectionId :: Lens' DeleteFaces Text

Collection from which to remove the specific faces.

dfFaceIds :: Lens' DeleteFaces (NonEmpty Text)

An array of face IDs to delete.

Destructuring the Response

deleteFacesResponse

Arguments

:: Int

dfsrsResponseStatus

-> DeleteFacesResponse

Creates a value of DeleteFacesResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dfsrsDeletedFaces - An array of strings (face IDs) of the faces that were deleted.
• dfsrsResponseStatus - -- | The response status code.

data DeleteFacesResponse

See: deleteFacesResponse smart constructor.

Instances

Eq DeleteFacesResponse

Methods

(==) :: DeleteFacesResponse -> DeleteFacesResponse -> Bool

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

Data DeleteFacesResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DeleteFacesResponse -> c DeleteFacesResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DeleteFacesResponse

toConstr :: DeleteFacesResponse -> Constr

dataTypeOf :: DeleteFacesResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DeleteFacesResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DeleteFacesResponse)

gmapT :: (forall b. Data b => b -> b) -> DeleteFacesResponse -> DeleteFacesResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DeleteFacesResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DeleteFacesResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> DeleteFacesResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DeleteFacesResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DeleteFacesResponse -> m DeleteFacesResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteFacesResponse -> m DeleteFacesResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteFacesResponse -> m DeleteFacesResponse

Read DeleteFacesResponse

Methods

readsPrec :: Int -> ReadS DeleteFacesResponse

readList :: ReadS [DeleteFacesResponse]

readPrec :: ReadPrec DeleteFacesResponse

readListPrec :: ReadPrec [DeleteFacesResponse]

Show DeleteFacesResponse

Methods

showsPrec :: Int -> DeleteFacesResponse -> ShowS

show :: DeleteFacesResponse -> String

showList :: [DeleteFacesResponse] -> ShowS

Generic DeleteFacesResponse

Associated Types

type Rep DeleteFacesResponse :: * -> *

Methods

from :: DeleteFacesResponse -> Rep DeleteFacesResponse x

to :: Rep DeleteFacesResponse x -> DeleteFacesResponse

NFData DeleteFacesResponse

Methods

rnf :: DeleteFacesResponse -> ()

type Rep DeleteFacesResponse

type Rep DeleteFacesResponse = D1 * (MetaData "DeleteFacesResponse" "Network.AWS.Rekognition.DeleteFaces" "amazonka-rekognition-1.6.0-3jgXZy5HWud2mYhTRx5OTT" False) (C1 * (MetaCons "DeleteFacesResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_dfsrsDeletedFaces") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (List1 Text)))) (S1 * (MetaSel (Just Symbol "_dfsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

dfsrsDeletedFaces :: Lens' DeleteFacesResponse (Maybe (NonEmpty Text))

An array of strings (face IDs) of the faces that were deleted.

dfsrsResponseStatus :: Lens' DeleteFacesResponse Int

• - | The response status code.