com.amazonaws.services.rekognition.model

Class StartCelebrityRecognitionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.rekognition.model.StartCelebrityRecognitionRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class StartCelebrityRecognitionRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Starts asynchronous recognition of celebrities in a stored video.

Amazon Rekognition Video can detect celebrities in a video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartCelebrityRecognition returns a job identifier (JobId) which you use to get the results of the analysis. When celebrity recognition analysis is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel. To get the results of the celebrity recognition analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetCelebrityRecognition and pass the job identifier ( JobId) from the initial call to StartCelebrityRecognition.

For more information, see Recognizing Celebrities in the Amazon Rekognition Developer Guide.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
StartCelebrityRecognitionRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getClientRequestToken() Idempotent token used to identify the start request.
java.lang.String	getJobTag() An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic.
NotificationChannel	getNotificationChannel() The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish the completion status of the celebrity recognition analysis to.
Video	getVideo() The video in which you want to recognize celebrities.
int	hashCode()
void	setClientRequestToken(java.lang.String clientRequestToken) Idempotent token used to identify the start request.
void	setJobTag(java.lang.String jobTag) An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic.
void	setNotificationChannel(NotificationChannel notificationChannel) The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish the completion status of the celebrity recognition analysis to.
void	setVideo(Video video) The video in which you want to recognize celebrities.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
StartCelebrityRecognitionRequest	withClientRequestToken(java.lang.String clientRequestToken) Idempotent token used to identify the start request.
StartCelebrityRecognitionRequest	withJobTag(java.lang.String jobTag) An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic.
StartCelebrityRecognitionRequest	withNotificationChannel(NotificationChannel notificationChannel) The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish the completion status of the celebrity recognition analysis to.
StartCelebrityRecognitionRequest	withVideo(Video video) The video in which you want to recognize celebrities.

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

StartCelebrityRecognitionRequest

public StartCelebrityRecognitionRequest()

Method Detail

getVideo

public Video getVideo()

The video in which you want to recognize celebrities. The video must be stored in an Amazon S3 bucket.

Returns:

The video in which you want to recognize celebrities. The video must be stored in an Amazon S3 bucket.

setVideo

public void setVideo(Video video)

The video in which you want to recognize celebrities. The video must be stored in an Amazon S3 bucket.

Parameters:

video -

The video in which you want to recognize celebrities. The video must be stored in an Amazon S3 bucket.

withVideo

public StartCelebrityRecognitionRequest withVideo(Video video)

The video in which you want to recognize celebrities. The video must be stored in an Amazon S3 bucket.

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

Parameters:

video -

The video in which you want to recognize celebrities. The video must be stored in an Amazon S3 bucket.

Returns:

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

getClientRequestToken

public java.lang.String getClientRequestToken()

Idempotent token used to identify the start request. If you use the same token with multiple StartCelebrityRecognition requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.

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

Returns:

Idempotent token used to identify the start request. If you use the same token with multiple StartCelebrityRecognition requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.

setClientRequestToken

public void setClientRequestToken(java.lang.String clientRequestToken)

Idempotent token used to identify the start request. If you use the same token with multiple StartCelebrityRecognition requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.

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

Parameters:

clientRequestToken -

Idempotent token used to identify the start request. If you use the same token with multiple StartCelebrityRecognition requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.

withClientRequestToken

public StartCelebrityRecognitionRequest withClientRequestToken(java.lang.String clientRequestToken)

Idempotent token used to identify the start request. If you use the same token with multiple StartCelebrityRecognition requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.

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

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

Parameters:

clientRequestToken -

Idempotent token used to identify the start request. If you use the same token with multiple StartCelebrityRecognition requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.

Returns:

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

getNotificationChannel

public NotificationChannel getNotificationChannel()

The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish the completion status of the celebrity recognition analysis to.

Returns:

The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish the completion status of the celebrity recognition analysis to.

setNotificationChannel

public void setNotificationChannel(NotificationChannel notificationChannel)

The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish the completion status of the celebrity recognition analysis to.

Parameters:

notificationChannel -

The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish the completion status of the celebrity recognition analysis to.

withNotificationChannel

public StartCelebrityRecognitionRequest withNotificationChannel(NotificationChannel notificationChannel)

The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish the completion status of the celebrity recognition analysis to.

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

Parameters:

notificationChannel -

The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish the completion status of the celebrity recognition analysis to.

Returns:

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

getJobTag

public java.lang.String getJobTag()

An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.

Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.\-:]+

Returns:

An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.

setJobTag

public void setJobTag(java.lang.String jobTag)

An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.

Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.\-:]+

Parameters:

jobTag -

An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.

withJobTag

public StartCelebrityRecognitionRequest withJobTag(java.lang.String jobTag)

An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.

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

Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.\-:]+

Parameters:

jobTag -

An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.

Returns:

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

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