libZSservicesZSamazonka-rekognitionZSamazonka-rekognition
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Rekognition.DetectModerationLabels

Description

Detects unsafe content in a specified JPEG or PNG format image. Use DetectModerationLabels to moderate images depending on your requirements. For example, you might want to filter images that contain nudity, but not images containing suggestive content.

To filter images, use the labels returned by DetectModerationLabels to determine which types of content are appropriate.

For information about moderation labels, see Detecting Unsafe Content in the Amazon Rekognition Developer Guide.

You pass the input image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file.

Synopsis

Creating a Request

data DetectModerationLabels Source #

See: newDetectModerationLabels smart constructor.

Constructors

DetectModerationLabels' 

Fields

  • humanLoopConfig :: Maybe HumanLoopConfig

    Sets up the configuration for human evaluation, including the FlowDefinition the image will be sent to.

  • minConfidence :: Maybe Double

    Specifies the minimum confidence level for the labels to return. Amazon Rekognition doesn't return any labels with a confidence level lower than this specified value.

    If you don't specify MinConfidence, the operation returns labels with confidence values greater than or equal to 50 percent.

  • image :: Image

    The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.

    If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

Instances

Instances details
Eq DetectModerationLabels Source # 
Instance details

Defined in Amazonka.Rekognition.DetectModerationLabels

Read DetectModerationLabels Source # 
Instance details

Defined in Amazonka.Rekognition.DetectModerationLabels

Show DetectModerationLabels Source # 
Instance details

Defined in Amazonka.Rekognition.DetectModerationLabels

Generic DetectModerationLabels Source # 
Instance details

Defined in Amazonka.Rekognition.DetectModerationLabels

Associated Types

type Rep DetectModerationLabels :: Type -> Type #

NFData DetectModerationLabels Source # 
Instance details

Defined in Amazonka.Rekognition.DetectModerationLabels

Methods

rnf :: DetectModerationLabels -> () #

Hashable DetectModerationLabels Source # 
Instance details

Defined in Amazonka.Rekognition.DetectModerationLabels

ToJSON DetectModerationLabels Source # 
Instance details

Defined in Amazonka.Rekognition.DetectModerationLabels

AWSRequest DetectModerationLabels Source # 
Instance details

Defined in Amazonka.Rekognition.DetectModerationLabels

Associated Types

type AWSResponse DetectModerationLabels #

ToHeaders DetectModerationLabels Source # 
Instance details

Defined in Amazonka.Rekognition.DetectModerationLabels

ToPath DetectModerationLabels Source # 
Instance details

Defined in Amazonka.Rekognition.DetectModerationLabels

ToQuery DetectModerationLabels Source # 
Instance details

Defined in Amazonka.Rekognition.DetectModerationLabels

type Rep DetectModerationLabels Source # 
Instance details

Defined in Amazonka.Rekognition.DetectModerationLabels

type Rep DetectModerationLabels = D1 ('MetaData "DetectModerationLabels" "Amazonka.Rekognition.DetectModerationLabels" "libZSservicesZSamazonka-rekognitionZSamazonka-rekognition" 'False) (C1 ('MetaCons "DetectModerationLabels'" 'PrefixI 'True) (S1 ('MetaSel ('Just "humanLoopConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HumanLoopConfig)) :*: (S1 ('MetaSel ('Just "minConfidence") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "image") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Image))))
type AWSResponse DetectModerationLabels Source # 
Instance details

Defined in Amazonka.Rekognition.DetectModerationLabels

newDetectModerationLabels Source #

Create a value of DetectModerationLabels 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:humanLoopConfig:DetectModerationLabels', detectModerationLabels_humanLoopConfig - Sets up the configuration for human evaluation, including the FlowDefinition the image will be sent to.

$sel:minConfidence:DetectModerationLabels', detectModerationLabels_minConfidence - Specifies the minimum confidence level for the labels to return. Amazon Rekognition doesn't return any labels with a confidence level lower than this specified value.

If you don't specify MinConfidence, the operation returns labels with confidence values greater than or equal to 50 percent.

$sel:image:DetectModerationLabels', detectModerationLabels_image - The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.

If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

Request Lenses

detectModerationLabels_humanLoopConfig :: Lens' DetectModerationLabels (Maybe HumanLoopConfig) Source #

Sets up the configuration for human evaluation, including the FlowDefinition the image will be sent to.

detectModerationLabels_minConfidence :: Lens' DetectModerationLabels (Maybe Double) Source #

Specifies the minimum confidence level for the labels to return. Amazon Rekognition doesn't return any labels with a confidence level lower than this specified value.

If you don't specify MinConfidence, the operation returns labels with confidence values greater than or equal to 50 percent.

detectModerationLabels_image :: Lens' DetectModerationLabels Image Source #

The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.

If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

Destructuring the Response

data DetectModerationLabelsResponse Source #

See: newDetectModerationLabelsResponse smart constructor.

Constructors

DetectModerationLabelsResponse' 

Fields

Instances

Instances details
Eq DetectModerationLabelsResponse Source # 
Instance details

Defined in Amazonka.Rekognition.DetectModerationLabels

Read DetectModerationLabelsResponse Source # 
Instance details

Defined in Amazonka.Rekognition.DetectModerationLabels

Show DetectModerationLabelsResponse Source # 
Instance details

Defined in Amazonka.Rekognition.DetectModerationLabels

Generic DetectModerationLabelsResponse Source # 
Instance details

Defined in Amazonka.Rekognition.DetectModerationLabels

Associated Types

type Rep DetectModerationLabelsResponse :: Type -> Type #

NFData DetectModerationLabelsResponse Source # 
Instance details

Defined in Amazonka.Rekognition.DetectModerationLabels

type Rep DetectModerationLabelsResponse Source # 
Instance details

Defined in Amazonka.Rekognition.DetectModerationLabels

type Rep DetectModerationLabelsResponse = D1 ('MetaData "DetectModerationLabelsResponse" "Amazonka.Rekognition.DetectModerationLabels" "libZSservicesZSamazonka-rekognitionZSamazonka-rekognition" 'False) (C1 ('MetaCons "DetectModerationLabelsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "humanLoopActivationOutput") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HumanLoopActivationOutput)) :*: S1 ('MetaSel ('Just "moderationModelVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "moderationLabels") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ModerationLabel])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDetectModerationLabelsResponse Source #

Create a value of DetectModerationLabelsResponse 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:humanLoopActivationOutput:DetectModerationLabelsResponse', detectModerationLabelsResponse_humanLoopActivationOutput - Shows the results of the human in the loop evaluation.

$sel:moderationModelVersion:DetectModerationLabelsResponse', detectModerationLabelsResponse_moderationModelVersion - Version number of the moderation detection model that was used to detect unsafe content.

$sel:moderationLabels:DetectModerationLabelsResponse', detectModerationLabelsResponse_moderationLabels - Array of detected Moderation labels and the time, in milliseconds from the start of the video, they were detected.

$sel:httpStatus:DetectModerationLabelsResponse', detectModerationLabelsResponse_httpStatus - The response's http status code.

Response Lenses

detectModerationLabelsResponse_moderationModelVersion :: Lens' DetectModerationLabelsResponse (Maybe Text) Source #

Version number of the moderation detection model that was used to detect unsafe content.

detectModerationLabelsResponse_moderationLabels :: Lens' DetectModerationLabelsResponse (Maybe [ModerationLabel]) Source #

Array of detected Moderation labels and the time, in milliseconds from the start of the video, they were detected.