com.amazonaws.services.rekognition.model

Class StartFaceDetectionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.rekognition.model.StartFaceDetectionRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class StartFaceDetectionRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Starts asynchronous detection of faces in a stored video.

Amazon Rekognition Video can detect faces in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartFaceDetection returns a job identifier ( JobId) that you use to get the results of the operation. When face detection 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 face detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetFaceDetection and pass the job identifier (JobId) from the initial call to StartFaceDetection.

For more information, see Detecting Faces in a Stored Video in the Amazon Rekognition Developer Guide.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
StartFaceDetectionRequest()

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	getFaceAttributes() The face attributes you want returned.
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 ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the face detection operation.
Video	getVideo() The video in which you want to detect faces.
int	hashCode()
void	setClientRequestToken(java.lang.String clientRequestToken) Idempotent token used to identify the start request.
void	setFaceAttributes(FaceAttributes faceAttributes) The face attributes you want returned.
void	setFaceAttributes(java.lang.String faceAttributes) The face attributes you want returned.
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 ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the face detection operation.
void	setVideo(Video video) The video in which you want to detect faces.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
StartFaceDetectionRequest	withClientRequestToken(java.lang.String clientRequestToken) Idempotent token used to identify the start request.
StartFaceDetectionRequest	withFaceAttributes(FaceAttributes faceAttributes) The face attributes you want returned.
StartFaceDetectionRequest	withFaceAttributes(java.lang.String faceAttributes) The face attributes you want returned.
StartFaceDetectionRequest	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.
StartFaceDetectionRequest	withNotificationChannel(NotificationChannel notificationChannel) The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the face detection operation.
StartFaceDetectionRequest	withVideo(Video video) The video in which you want to detect faces.

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

StartFaceDetectionRequest

public StartFaceDetectionRequest()

Method Detail

getVideo

public Video getVideo()

The video in which you want to detect faces. The video must be stored in an Amazon S3 bucket.

Returns:

The video in which you want to detect faces. The video must be stored in an Amazon S3 bucket.

setVideo

public void setVideo(Video video)

The video in which you want to detect faces. The video must be stored in an Amazon S3 bucket.

Parameters:

video -

The video in which you want to detect faces. The video must be stored in an Amazon S3 bucket.

withVideo

public StartFaceDetectionRequest withVideo(Video video)

The video in which you want to detect faces. 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 detect faces. 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 StartFaceDetection 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 StartFaceDetection 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 StartFaceDetection 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 StartFaceDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.

withClientRequestToken

public StartFaceDetectionRequest withClientRequestToken(java.lang.String clientRequestToken)

Idempotent token used to identify the start request. If you use the same token with multiple StartFaceDetection 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 StartFaceDetection 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 ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the face detection operation.

Returns:

The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the face detection operation.

setNotificationChannel

public void setNotificationChannel(NotificationChannel notificationChannel)

The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the face detection operation.

Parameters:

notificationChannel -

The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the face detection operation.

withNotificationChannel

public StartFaceDetectionRequest withNotificationChannel(NotificationChannel notificationChannel)

The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the face detection operation.

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

Parameters:

notificationChannel -

The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the face detection operation.

Returns:

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

getFaceAttributes

public java.lang.String getFaceAttributes()

The face attributes you want returned.

DEFAULT - The following subset of facial attributes are returned: BoundingBox, Confidence, Pose, Quality and Landmarks.

ALL - All facial attributes are returned.

Constraints:
Allowed Values: DEFAULT, ALL

Returns:

The face attributes you want returned.

DEFAULT - The following subset of facial attributes are returned: BoundingBox, Confidence, Pose, Quality and Landmarks.

ALL - All facial attributes are returned.

See Also:

FaceAttributes

setFaceAttributes

public void setFaceAttributes(java.lang.String faceAttributes)

The face attributes you want returned.

DEFAULT - The following subset of facial attributes are returned: BoundingBox, Confidence, Pose, Quality and Landmarks.

ALL - All facial attributes are returned.

Constraints:
Allowed Values: DEFAULT, ALL

Parameters:

faceAttributes -

The face attributes you want returned.

DEFAULT - The following subset of facial attributes are returned: BoundingBox, Confidence, Pose, Quality and Landmarks.

ALL - All facial attributes are returned.

See Also:

FaceAttributes

withFaceAttributes

public StartFaceDetectionRequest withFaceAttributes(java.lang.String faceAttributes)

The face attributes you want returned.

DEFAULT - The following subset of facial attributes are returned: BoundingBox, Confidence, Pose, Quality and Landmarks.

ALL - All facial attributes are returned.

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

Constraints:
Allowed Values: DEFAULT, ALL

Parameters:

faceAttributes -

The face attributes you want returned.

DEFAULT - The following subset of facial attributes are returned: BoundingBox, Confidence, Pose, Quality and Landmarks.

ALL - All facial attributes are returned.

Returns:

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

See Also:

FaceAttributes

setFaceAttributes

public void setFaceAttributes(FaceAttributes faceAttributes)

The face attributes you want returned.

DEFAULT - The following subset of facial attributes are returned: BoundingBox, Confidence, Pose, Quality and Landmarks.

ALL - All facial attributes are returned.

Constraints:
Allowed Values: DEFAULT, ALL

Parameters:

faceAttributes -

The face attributes you want returned.

DEFAULT - The following subset of facial attributes are returned: BoundingBox, Confidence, Pose, Quality and Landmarks.

ALL - All facial attributes are returned.

See Also:

FaceAttributes

withFaceAttributes

public StartFaceDetectionRequest withFaceAttributes(FaceAttributes faceAttributes)

The face attributes you want returned.

DEFAULT - The following subset of facial attributes are returned: BoundingBox, Confidence, Pose, Quality and Landmarks.

ALL - All facial attributes are returned.

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

Constraints:
Allowed Values: DEFAULT, ALL

Parameters:

faceAttributes -

The face attributes you want returned.

DEFAULT - The following subset of facial attributes are returned: BoundingBox, Confidence, Pose, Quality and Landmarks.

ALL - All facial attributes are returned.

Returns:

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

See Also:

FaceAttributes

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 StartFaceDetectionRequest 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