| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.Rekognition.DeleteFaces
Description
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.
Synopsis
- data DeleteFaces = DeleteFaces' {
- collectionId :: Text
- faceIds :: NonEmpty Text
- newDeleteFaces :: Text -> NonEmpty Text -> DeleteFaces
- deleteFaces_collectionId :: Lens' DeleteFaces Text
- deleteFaces_faceIds :: Lens' DeleteFaces (NonEmpty Text)
- data DeleteFacesResponse = DeleteFacesResponse' {
- deletedFaces :: Maybe (NonEmpty Text)
- httpStatus :: Int
- newDeleteFacesResponse :: Int -> DeleteFacesResponse
- deleteFacesResponse_deletedFaces :: Lens' DeleteFacesResponse (Maybe (NonEmpty Text))
- deleteFacesResponse_httpStatus :: Lens' DeleteFacesResponse Int
Creating a Request
data DeleteFaces Source #
See: newDeleteFaces smart constructor.
Constructors
| DeleteFaces' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> NonEmpty Text | |
| -> DeleteFaces |
Create a value of DeleteFaces 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:collectionId:DeleteFaces', deleteFaces_collectionId - Collection from which to remove the specific faces.
$sel:faceIds:DeleteFaces', deleteFaces_faceIds - An array of face IDs to delete.
Request Lenses
deleteFaces_collectionId :: Lens' DeleteFaces Text Source #
Collection from which to remove the specific faces.
deleteFaces_faceIds :: Lens' DeleteFaces (NonEmpty Text) Source #
An array of face IDs to delete.
Destructuring the Response
data DeleteFacesResponse Source #
See: newDeleteFacesResponse smart constructor.
Constructors
| DeleteFacesResponse' | |
Fields
| |
Instances
newDeleteFacesResponse Source #
Arguments
| :: Int | |
| -> DeleteFacesResponse |
Create a value of DeleteFacesResponse 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:deletedFaces:DeleteFacesResponse', deleteFacesResponse_deletedFaces - An array of strings (face IDs) of the faces that were deleted.
$sel:httpStatus:DeleteFacesResponse', deleteFacesResponse_httpStatus - The response's http status code.
Response Lenses
deleteFacesResponse_deletedFaces :: Lens' DeleteFacesResponse (Maybe (NonEmpty Text)) Source #
An array of strings (face IDs) of the faces that were deleted.
deleteFacesResponse_httpStatus :: Lens' DeleteFacesResponse Int Source #
The response's http status code.