com.amazonaws.services.rekognition.model

Class GetContentModerationRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.rekognition.model.GetContentModerationRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class GetContentModerationRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Gets the unsafe content analysis results for a Amazon Rekognition Video analysis started by StartContentModeration.

Unsafe content analysis of a 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 unsafe 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 unsafe content 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 Detecting Unsafe Content in the Amazon Rekognition Developer Guide.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GetContentModerationRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getJobId() The identifier for the unsafe content job.
java.lang.Integer	getMaxResults() Maximum number of results to return per paginated call.
java.lang.String	getNextToken() If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition returns a pagination token in the response.
java.lang.String	getSortBy() Sort to use for elements in the ModerationLabelDetections array.
int	hashCode()
void	setJobId(java.lang.String jobId) The identifier for the unsafe content job.
void	setMaxResults(java.lang.Integer maxResults) Maximum number of results to return per paginated call.
void	setNextToken(java.lang.String nextToken) If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition returns a pagination token in the response.
void	setSortBy(ContentModerationSortBy sortBy) Sort to use for elements in the ModerationLabelDetections array.
void	setSortBy(java.lang.String sortBy) Sort to use for elements in the ModerationLabelDetections array.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
GetContentModerationRequest	withJobId(java.lang.String jobId) The identifier for the unsafe content job.
GetContentModerationRequest	withMaxResults(java.lang.Integer maxResults) Maximum number of results to return per paginated call.
GetContentModerationRequest	withNextToken(java.lang.String nextToken) If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition returns a pagination token in the response.
GetContentModerationRequest	withSortBy(ContentModerationSortBy sortBy) Sort to use for elements in the ModerationLabelDetections array.
GetContentModerationRequest	withSortBy(java.lang.String sortBy) Sort to use for elements in the ModerationLabelDetections array.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetContentModerationRequest

public GetContentModerationRequest()

Method Detail

getJobId

public java.lang.String getJobId()

The identifier for the unsafe content job. Use JobId to identify the job in a subsequent call to GetContentModeration.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-_]+$

Returns:

The identifier for the unsafe content job. Use JobId to identify the job in a subsequent call to GetContentModeration.

setJobId

public void setJobId(java.lang.String jobId)

The identifier for the unsafe content job. Use JobId to identify the job in a subsequent call to GetContentModeration.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-_]+$

Parameters:

jobId -

The identifier for the unsafe content job. Use JobId to identify the job in a subsequent call to GetContentModeration.

withJobId

public GetContentModerationRequest withJobId(java.lang.String jobId)

The identifier for the unsafe content job. Use JobId to identify the job in a subsequent call to GetContentModeration.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-_]+$

Parameters:

jobId -

The identifier for the unsafe content job. Use JobId to identify the job in a subsequent call to GetContentModeration.

Returns:

A reference to this updated object so that method calls can be chained together.

getMaxResults

public java.lang.Integer getMaxResults()

Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.

Constraints:
Range: 1 -

Returns:

Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.

setMaxResults

public void setMaxResults(java.lang.Integer maxResults)

Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.

Constraints:
Range: 1 -

Parameters:

maxResults -

Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.

withMaxResults

public GetContentModerationRequest withMaxResults(java.lang.Integer maxResults)

Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Range: 1 -

Parameters:

maxResults -

Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.

Returns:

A reference to this updated object so that method calls can be chained together.

getNextToken

public java.lang.String getNextToken()

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 unsafe content labels.

Constraints:
Length: - 255

Returns:

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 unsafe content labels.

setNextToken

public void setNextToken(java.lang.String nextToken)

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 unsafe content labels.

Constraints:
Length: - 255

Parameters:

nextToken -

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 unsafe content labels.

withNextToken

public GetContentModerationRequest withNextToken(java.lang.String nextToken)

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 unsafe content labels.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: - 255

Parameters:

nextToken -

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 unsafe content labels.

Returns:

A reference to this updated object so that method calls can be chained together.

getSortBy

public java.lang.String getSortBy()

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.

Constraints:
Allowed Values: NAME, TIMESTAMP

Returns:

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.

See Also:

ContentModerationSortBy

setSortBy

public void setSortBy(java.lang.String sortBy)

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.

Constraints:
Allowed Values: NAME, TIMESTAMP

Parameters:

sortBy -

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.

See Also:

ContentModerationSortBy

withSortBy

public GetContentModerationRequest withSortBy(java.lang.String sortBy)

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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: NAME, TIMESTAMP

Parameters:

sortBy -

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.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

ContentModerationSortBy

setSortBy

public void setSortBy(ContentModerationSortBy sortBy)

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.

Constraints:
Allowed Values: NAME, TIMESTAMP

Parameters:

sortBy -

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.

See Also:

ContentModerationSortBy

withSortBy

public GetContentModerationRequest withSortBy(ContentModerationSortBy sortBy)

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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: NAME, TIMESTAMP

Parameters:

sortBy -

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.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

ContentModerationSortBy

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object