GetContentModeration (smaws-clients.Smaws_Client_Rekognition.GetContentModeration)

Module Smaws_Client_Rekognition.GetContentModeration

Gets the inappropriate, unwanted, or offensive content analysis results for a Amazon Rekognition Video analysis started by StartContentModeration. For a list of moderation labels in Amazon Rekognition, see Using the image and video moderation APIs.

Amazon Rekognition Video inappropriate or offensive content detection in a stored video is an asynchronous operation. You start analysis by calling StartContentModeration which returns a job identifier (JobId). When analysis finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartContentModeration. To get the results of the content analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetContentModeration and pass the job identifier (JobId) from the initial call to StartContentModeration.

For more information, see Working with Stored Videos in the Amazon Rekognition Devlopers Guide.

GetContentModeration returns detected inappropriate, unwanted, or offensive content moderation labels, and the time they are detected, in an array, ModerationLabels, of ContentModerationDetection 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 MaxResults parameter to limit the number of labels returned in a single call to GetContentModeration. If there are more results than specified in MaxResults, 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 GetContentModeration and populate the NextToken request parameter with the value of NextToken returned from the previous call to GetContentModeration.

For more information, see moderating content in the Amazon Rekognition Developer Guide.

val error_to_string : 
  [ Smaws_Lib.Protocols.AwsJson.error
  | `AccessDeniedException of Types.access_denied_exception
  | `InternalServerError of Types.internal_server_error
  | `InvalidPaginationTokenException of
    Types.invalid_pagination_token_exception
  | `InvalidParameterException of Types.invalid_parameter_exception
  | `ProvisionedThroughputExceededException of
    Types.provisioned_throughput_exceeded_exception
  | `ResourceNotFoundException of Types.resource_not_found_exception
  | `ThrottlingException of Types.throttling_exception ] ->
  string

val request : 
  'http_type Smaws_Lib.Context.t ->
  Types.get_content_moderation_request ->
  (Types.get_content_moderation_response,
    [> Smaws_Lib.Protocols.AwsJson.error
    | `AccessDeniedException of Types.access_denied_exception
    | `InternalServerError of Types.internal_server_error
    | `InvalidPaginationTokenException of
      Types.invalid_pagination_token_exception
    | `InvalidParameterException of Types.invalid_parameter_exception
    | `ProvisionedThroughputExceededException of
      Types.provisioned_throughput_exceeded_exception
    | `ResourceNotFoundException of Types.resource_not_found_exception
    | `ThrottlingException of Types.throttling_exception ])
    Stdlib.result

val request_with_metadata : 
  'http_type Smaws_Lib.Context.t ->
  Types.get_content_moderation_request ->
  (Types.get_content_moderation_response Smaws_Lib.Response.t,
    [> Smaws_Lib.Protocols.AwsJson.error
    | `AccessDeniedException of Types.access_denied_exception
    | `InternalServerError of Types.internal_server_error
    | `InvalidPaginationTokenException of
      Types.invalid_pagination_token_exception
    | `InvalidParameterException of Types.invalid_parameter_exception
    | `ProvisionedThroughputExceededException of
      Types.provisioned_throughput_exceeded_exception
    | `ResourceNotFoundException of Types.resource_not_found_exception
    | `ThrottlingException of Types.throttling_exception ]
    * Smaws_Lib.Response.metadata)
    Stdlib.result