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

data DeleteFaces

See: newDeleteFaces smart constructor.

Constructors

DeleteFaces'

Fields

• collectionId :: Text

  Collection from which to remove the specific faces.

• faceIds :: NonEmpty Text

  An array of face IDs to delete.

Instances

ToJSON DeleteFaces

Defined in Amazonka.Rekognition.DeleteFaces

Methods

toJSON :: DeleteFaces -> Value

toEncoding :: DeleteFaces -> Encoding

toJSONList :: [DeleteFaces] -> Value

toEncodingList :: [DeleteFaces] -> Encoding

ToHeaders DeleteFaces

Defined in Amazonka.Rekognition.DeleteFaces

Methods

toHeaders :: DeleteFaces -> [Header]

ToPath DeleteFaces

Defined in Amazonka.Rekognition.DeleteFaces

Methods

toPath :: DeleteFaces -> ByteString

ToQuery DeleteFaces

Defined in Amazonka.Rekognition.DeleteFaces

Methods

toQuery :: DeleteFaces -> QueryString

AWSRequest DeleteFaces

Defined in Amazonka.Rekognition.DeleteFaces

Associated Types

type AWSResponse DeleteFaces

Methods

request :: (Service -> Service) -> DeleteFaces -> Request DeleteFaces

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeleteFaces -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteFaces)))

Generic DeleteFaces

Defined in Amazonka.Rekognition.DeleteFaces

Associated Types

type Rep DeleteFaces :: Type -> Type

Methods

from :: DeleteFaces -> Rep DeleteFaces x

to :: Rep DeleteFaces x -> DeleteFaces

Read DeleteFaces

Defined in Amazonka.Rekognition.DeleteFaces

Methods

readsPrec :: Int -> ReadS DeleteFaces

readList :: ReadS [DeleteFaces]

readPrec :: ReadPrec DeleteFaces

readListPrec :: ReadPrec [DeleteFaces]

Show DeleteFaces

Defined in Amazonka.Rekognition.DeleteFaces

Methods

showsPrec :: Int -> DeleteFaces -> ShowS

show :: DeleteFaces -> String

showList :: [DeleteFaces] -> ShowS

NFData DeleteFaces

Defined in Amazonka.Rekognition.DeleteFaces

Methods

rnf :: DeleteFaces -> ()

Eq DeleteFaces

Defined in Amazonka.Rekognition.DeleteFaces

Methods

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

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

Hashable DeleteFaces

Defined in Amazonka.Rekognition.DeleteFaces

Methods

hashWithSalt :: Int -> DeleteFaces -> Int

hash :: DeleteFaces -> Int

type AWSResponse DeleteFaces

Defined in Amazonka.Rekognition.DeleteFaces

type AWSResponse DeleteFaces = DeleteFacesResponse

type Rep DeleteFaces

Defined in Amazonka.Rekognition.DeleteFaces

type Rep DeleteFaces = D1 ('MetaData "DeleteFaces" "Amazonka.Rekognition.DeleteFaces" "amazonka-rekognition-2.0-EaCrS9R3rWADqefEZvOx5B" 'False) (C1 ('MetaCons "DeleteFaces'" 'PrefixI 'True) (S1 ('MetaSel ('Just "collectionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "faceIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text))))

newDeleteFaces

Arguments

:: Text

DeleteFaces

-> NonEmpty Text

$sel:faceIds:DeleteFaces'

-> 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:

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

Collection from which to remove the specific faces.

deleteFaces_faceIds :: Lens' DeleteFaces (NonEmpty Text)

An array of face IDs to delete.

Destructuring the Response

data DeleteFacesResponse

See: newDeleteFacesResponse smart constructor.

Constructors

DeleteFacesResponse'

Fields

• deletedFaces :: Maybe (NonEmpty Text)

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

• httpStatus :: Int

  The response's http status code.

Instances

Generic DeleteFacesResponse

Defined in Amazonka.Rekognition.DeleteFaces

Associated Types

type Rep DeleteFacesResponse :: Type -> Type

Methods

from :: DeleteFacesResponse -> Rep DeleteFacesResponse x

to :: Rep DeleteFacesResponse x -> DeleteFacesResponse

Read DeleteFacesResponse

Defined in Amazonka.Rekognition.DeleteFaces

Methods

readsPrec :: Int -> ReadS DeleteFacesResponse

readList :: ReadS [DeleteFacesResponse]

readPrec :: ReadPrec DeleteFacesResponse

readListPrec :: ReadPrec [DeleteFacesResponse]

Show DeleteFacesResponse

Defined in Amazonka.Rekognition.DeleteFaces

Methods

showsPrec :: Int -> DeleteFacesResponse -> ShowS

show :: DeleteFacesResponse -> String

showList :: [DeleteFacesResponse] -> ShowS

NFData DeleteFacesResponse

Defined in Amazonka.Rekognition.DeleteFaces

Methods

rnf :: DeleteFacesResponse -> ()

Eq DeleteFacesResponse

Defined in Amazonka.Rekognition.DeleteFaces

Methods

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

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

type Rep DeleteFacesResponse

Defined in Amazonka.Rekognition.DeleteFaces

type Rep DeleteFacesResponse = D1 ('MetaData "DeleteFacesResponse" "Amazonka.Rekognition.DeleteFaces" "amazonka-rekognition-2.0-EaCrS9R3rWADqefEZvOx5B" 'False) (C1 ('MetaCons "DeleteFacesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "deletedFaces") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeleteFacesResponse

Arguments

:: Int

$sel:httpStatus:DeleteFacesResponse'

-> 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))

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

deleteFacesResponse_httpStatus :: Lens' DeleteFacesResponse Int

The response's http status code.