AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Rekognition DetectModerationLabels API operation.

Syntax

Find-REKModerationLabel
-S3Object_Bucket <String>
-Image_Byte <Byte[]>
-DataAttributes_ContentClassifier <String[]>
-HumanLoopConfig_FlowDefinitionArn <String>
-HumanLoopConfig_HumanLoopName <String>
-MinConfidence <Single>
-S3Object_Name <String>
-ProjectVersion <String>
-S3Object_Version <String>
-Select <String>
-ClientConfig <AmazonRekognitionConfig>

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. You can specify an adapter to use when retrieving label predictions by providing a ProjectVersionArn to the ProjectVersion argument.

Parameters

-ClientConfig <AmazonRekognitionConfig>
Amazon.PowerShell.Cmdlets.REK.AmazonRekognitionClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DataAttributes_ContentClassifier <String[]>
Sets whether the input image is free of personally identifiable information.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesHumanLoopConfig_DataAttributes_ContentClassifiers
-HumanLoopConfig_FlowDefinitionArn <String>
The Amazon Resource Name (ARN) of the flow definition. You can create a flow definition by using the Amazon Sagemaker CreateFlowDefinition Operation.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-HumanLoopConfig_HumanLoopName <String>
The name of the human review used for this image. This should be kept unique within a region.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Image_Byte <Byte[]>
Blob of image bytes up to 5 MBs. Note that the maximum image size you can pass to DetectCustomLabels is 4MB. The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesImage_Bytes
-MinConfidence <Single>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ProjectVersion <String>
Identifier for the custom adapter. Expects the ProjectVersionArn as a value. Use the CreateProject or CreateProjectVersion APIs to create a custom adapter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-S3Object_Bucket <String>
Name of the S3 bucket.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesImage_S3Object_Bucket
-S3Object_Name <String>
S3 object key name.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesImage_S3Object_Name
-S3Object_Version <String>
If the bucket is versioning enabled, you can specify the object version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesImage_S3Object_Version
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.DetectModerationLabelsResponse). Specifying the name of a property of type Amazon.Rekognition.Model.DetectModerationLabelsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.Rekognition.Model.DetectModerationLabelsResponse
This cmdlet returns an Amazon.Rekognition.Model.DetectModerationLabelsResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z