Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . rekognition ]

get-content-moderation

Description

Gets the content moderation analysis results for a Rekognition Video analysis started by .

Content moderation analysis of a video is an asynchronous operation. You start analysis by calling . which returns a job identifier (job-id ). When analysis finishes, Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to start-content-moderation . To get the results of the content moderation analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED . If so, call GetCelebrityDetection and pass the job identifier (job-id ) from the initial call to StartCelebrityDetection . For more information, see video .

get-content-moderation returns detected content moderation labels, and the time they are detected, in an array, ModerationLabels , of objects.

By default, the moderated labels are returned sorted by time, in milliseconds from the start of the video. You can also sort them by moderated label by specifying NAME for the SortBy input parameter.

Since video analysis can return a large number of results, use the max-results parameter to limit the number of labels returned in a single call to get-content-moderation . If there are more results than specified in max-results , the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call get-content-moderation and populate the NextToken request parameter with the value of NextToken returned from the previous call to get-content-moderation .

For more information, see moderation .

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  get-content-moderation
--job-id <value>
[--max-results <value>]
[--next-token <value>]
[--sort-by <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--job-id (string)

The identifier for the content moderation job. Use job-id to identify the job in a subsequent call to get-content-moderation .

--max-results (integer)

Maximum number of content moderation labels to return. The default is 1000.

--next-token (string)

If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of content moderation labels.

--sort-by (string)

Sort to use for elements in the ModerationLabelDetections array. Use TIMESTAMP to sort array elements by the time labels are detected. Use NAME to alphabetically group elements for a label together. Within each label group, the array element are sorted by detection confidence. The default sort is by TIMESTAMP .

Possible values:

  • NAME
  • TIMESTAMP

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

JobStatus -> (string)

The current status of the content moderation job.

StatusMessage -> (string)

If the job fails, StatusMessage provides a descriptive error message.

VideoMetadata -> (structure)

Information about a video that Amazon Rekognition analyzed. Videometadata is returned in every page of paginated responses from get-content-moderation .

Codec -> (string)

Type of compression used in the analyzed video.

DurationMillis -> (long)

Length of the video in milliseconds.

Format -> (string)

Format of the analyzed video. Possible values are MP4, MOV and AVI.

FrameRate -> (float)

Number of frames per second in the video.

FrameHeight -> (long)

Vertical pixel dimension of the video.

FrameWidth -> (long)

Horizontal pixel dimension of the video.

ModerationLabels -> (list)

The detected moderation labels and the time(s) they were detected.

(structure)

Information about a moderation label detection in a stored video.

Timestamp -> (long)

Time, in milliseconds from the beginning of the video, that the moderation label was detected.

ModerationLabel -> (structure)

The moderation label detected by in the stored video.

Confidence -> (float)

Specifies the confidence that Amazon Rekognition has that the label has been correctly identified.

If you don't specify the MinConfidence parameter in the call to detect-moderation-labels , the operation returns labels with a confidence value greater than or equal to 50 percent.

Name -> (string)

The label name for the type of content detected in the image.

ParentName -> (string)

The name for the parent label. Labels at the top-level of the hierarchy have the parent label "" .

NextToken -> (string)

If the response is truncated, Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of moderation labels.