AWS SDK for C++  1.9.66
AWS SDK for C++
Public Member Functions | List of all members
Aws::Rekognition::Model::StartFaceDetectionRequest Class Reference

#include <StartFaceDetectionRequest.h>

+ Inheritance diagram for Aws::Rekognition::Model::StartFaceDetectionRequest:

Public Member Functions

 StartFaceDetectionRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const VideoGetVideo () const
 
bool VideoHasBeenSet () const
 
void SetVideo (const Video &value)
 
void SetVideo (Video &&value)
 
StartFaceDetectionRequestWithVideo (const Video &value)
 
StartFaceDetectionRequestWithVideo (Video &&value)
 
const Aws::StringGetClientRequestToken () const
 
bool ClientRequestTokenHasBeenSet () const
 
void SetClientRequestToken (const Aws::String &value)
 
void SetClientRequestToken (Aws::String &&value)
 
void SetClientRequestToken (const char *value)
 
StartFaceDetectionRequestWithClientRequestToken (const Aws::String &value)
 
StartFaceDetectionRequestWithClientRequestToken (Aws::String &&value)
 
StartFaceDetectionRequestWithClientRequestToken (const char *value)
 
const NotificationChannelGetNotificationChannel () const
 
bool NotificationChannelHasBeenSet () const
 
void SetNotificationChannel (const NotificationChannel &value)
 
void SetNotificationChannel (NotificationChannel &&value)
 
StartFaceDetectionRequestWithNotificationChannel (const NotificationChannel &value)
 
StartFaceDetectionRequestWithNotificationChannel (NotificationChannel &&value)
 
const FaceAttributesGetFaceAttributes () const
 
bool FaceAttributesHasBeenSet () const
 
void SetFaceAttributes (const FaceAttributes &value)
 
void SetFaceAttributes (FaceAttributes &&value)
 
StartFaceDetectionRequestWithFaceAttributes (const FaceAttributes &value)
 
StartFaceDetectionRequestWithFaceAttributes (FaceAttributes &&value)
 
const Aws::StringGetJobTag () const
 
bool JobTagHasBeenSet () const
 
void SetJobTag (const Aws::String &value)
 
void SetJobTag (Aws::String &&value)
 
void SetJobTag (const char *value)
 
StartFaceDetectionRequestWithJobTag (const Aws::String &value)
 
StartFaceDetectionRequestWithJobTag (Aws::String &&value)
 
StartFaceDetectionRequestWithJobTag (const char *value)
 
- Public Member Functions inherited from Aws::Rekognition::RekognitionRequest
virtual ~RekognitionRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 24 of file StartFaceDetectionRequest.h.

Constructor & Destructor Documentation

◆ StartFaceDetectionRequest()

Aws::Rekognition::Model::StartFaceDetectionRequest::StartFaceDetectionRequest ( )

Member Function Documentation

◆ ClientRequestTokenHasBeenSet()

bool Aws::Rekognition::Model::StartFaceDetectionRequest::ClientRequestTokenHasBeenSet ( ) const
inline

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.

Definition at line 91 of file StartFaceDetectionRequest.h.

◆ FaceAttributesHasBeenSet()

bool Aws::Rekognition::Model::StartFaceDetectionRequest::FaceAttributesHasBeenSet ( ) const
inline

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.

Definition at line 193 of file StartFaceDetectionRequest.h.

◆ GetClientRequestToken()

const Aws::String& Aws::Rekognition::Model::StartFaceDetectionRequest::GetClientRequestToken ( ) const
inline

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.

Definition at line 83 of file StartFaceDetectionRequest.h.

◆ GetFaceAttributes()

const FaceAttributes& Aws::Rekognition::Model::StartFaceDetectionRequest::GetFaceAttributes ( ) const
inline

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.

Definition at line 185 of file StartFaceDetectionRequest.h.

◆ GetJobTag()

const Aws::String& Aws::Rekognition::Model::StartFaceDetectionRequest::GetJobTag ( ) const
inline

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.

Definition at line 234 of file StartFaceDetectionRequest.h.

◆ GetNotificationChannel()

const NotificationChannel& Aws::Rekognition::Model::StartFaceDetectionRequest::GetNotificationChannel ( ) const
inline

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

Definition at line 146 of file StartFaceDetectionRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::Rekognition::Model::StartFaceDetectionRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetServiceRequestName()

virtual const char* Aws::Rekognition::Model::StartFaceDetectionRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file StartFaceDetectionRequest.h.

◆ GetVideo()

const Video& Aws::Rekognition::Model::StartFaceDetectionRequest::GetVideo ( ) const
inline

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

Definition at line 44 of file StartFaceDetectionRequest.h.

◆ JobTagHasBeenSet()

bool Aws::Rekognition::Model::StartFaceDetectionRequest::JobTagHasBeenSet ( ) const
inline

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.

Definition at line 242 of file StartFaceDetectionRequest.h.

◆ NotificationChannelHasBeenSet()

bool Aws::Rekognition::Model::StartFaceDetectionRequest::NotificationChannelHasBeenSet ( ) const
inline

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

Definition at line 152 of file StartFaceDetectionRequest.h.

◆ SerializePayload()

Aws::String Aws::Rekognition::Model::StartFaceDetectionRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetClientRequestToken() [1/3]

void Aws::Rekognition::Model::StartFaceDetectionRequest::SetClientRequestToken ( Aws::String &&  value)
inline

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.

Definition at line 107 of file StartFaceDetectionRequest.h.

◆ SetClientRequestToken() [2/3]

void Aws::Rekognition::Model::StartFaceDetectionRequest::SetClientRequestToken ( const Aws::String value)
inline

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.

Definition at line 99 of file StartFaceDetectionRequest.h.

◆ SetClientRequestToken() [3/3]

void Aws::Rekognition::Model::StartFaceDetectionRequest::SetClientRequestToken ( const char *  value)
inline

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.

Definition at line 115 of file StartFaceDetectionRequest.h.

◆ SetFaceAttributes() [1/2]

void Aws::Rekognition::Model::StartFaceDetectionRequest::SetFaceAttributes ( const FaceAttributes value)
inline

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.

Definition at line 201 of file StartFaceDetectionRequest.h.

◆ SetFaceAttributes() [2/2]

void Aws::Rekognition::Model::StartFaceDetectionRequest::SetFaceAttributes ( FaceAttributes &&  value)
inline

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.

Definition at line 209 of file StartFaceDetectionRequest.h.

◆ SetJobTag() [1/3]

void Aws::Rekognition::Model::StartFaceDetectionRequest::SetJobTag ( Aws::String &&  value)
inline

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.

Definition at line 258 of file StartFaceDetectionRequest.h.

◆ SetJobTag() [2/3]

void Aws::Rekognition::Model::StartFaceDetectionRequest::SetJobTag ( const Aws::String value)
inline

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.

Definition at line 250 of file StartFaceDetectionRequest.h.

◆ SetJobTag() [3/3]

void Aws::Rekognition::Model::StartFaceDetectionRequest::SetJobTag ( const char *  value)
inline

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.

Definition at line 266 of file StartFaceDetectionRequest.h.

◆ SetNotificationChannel() [1/2]

void Aws::Rekognition::Model::StartFaceDetectionRequest::SetNotificationChannel ( const NotificationChannel value)
inline

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

Definition at line 158 of file StartFaceDetectionRequest.h.

◆ SetNotificationChannel() [2/2]

void Aws::Rekognition::Model::StartFaceDetectionRequest::SetNotificationChannel ( NotificationChannel &&  value)
inline

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

Definition at line 164 of file StartFaceDetectionRequest.h.

◆ SetVideo() [1/2]

void Aws::Rekognition::Model::StartFaceDetectionRequest::SetVideo ( const Video value)
inline

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

Definition at line 56 of file StartFaceDetectionRequest.h.

◆ SetVideo() [2/2]

void Aws::Rekognition::Model::StartFaceDetectionRequest::SetVideo ( Video &&  value)
inline

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

Definition at line 62 of file StartFaceDetectionRequest.h.

◆ VideoHasBeenSet()

bool Aws::Rekognition::Model::StartFaceDetectionRequest::VideoHasBeenSet ( ) const
inline

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

Definition at line 50 of file StartFaceDetectionRequest.h.

◆ WithClientRequestToken() [1/3]

StartFaceDetectionRequest& Aws::Rekognition::Model::StartFaceDetectionRequest::WithClientRequestToken ( Aws::String &&  value)
inline

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.

Definition at line 131 of file StartFaceDetectionRequest.h.

◆ WithClientRequestToken() [2/3]

StartFaceDetectionRequest& Aws::Rekognition::Model::StartFaceDetectionRequest::WithClientRequestToken ( const Aws::String value)
inline

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.

Definition at line 123 of file StartFaceDetectionRequest.h.

◆ WithClientRequestToken() [3/3]

StartFaceDetectionRequest& Aws::Rekognition::Model::StartFaceDetectionRequest::WithClientRequestToken ( const char *  value)
inline

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.

Definition at line 139 of file StartFaceDetectionRequest.h.

◆ WithFaceAttributes() [1/2]

StartFaceDetectionRequest& Aws::Rekognition::Model::StartFaceDetectionRequest::WithFaceAttributes ( const FaceAttributes value)
inline

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.

Definition at line 217 of file StartFaceDetectionRequest.h.

◆ WithFaceAttributes() [2/2]

StartFaceDetectionRequest& Aws::Rekognition::Model::StartFaceDetectionRequest::WithFaceAttributes ( FaceAttributes &&  value)
inline

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.

Definition at line 225 of file StartFaceDetectionRequest.h.

◆ WithJobTag() [1/3]

StartFaceDetectionRequest& Aws::Rekognition::Model::StartFaceDetectionRequest::WithJobTag ( Aws::String &&  value)
inline

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.

Definition at line 282 of file StartFaceDetectionRequest.h.

◆ WithJobTag() [2/3]

StartFaceDetectionRequest& Aws::Rekognition::Model::StartFaceDetectionRequest::WithJobTag ( const Aws::String value)
inline

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.

Definition at line 274 of file StartFaceDetectionRequest.h.

◆ WithJobTag() [3/3]

StartFaceDetectionRequest& Aws::Rekognition::Model::StartFaceDetectionRequest::WithJobTag ( const char *  value)
inline

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.

Definition at line 290 of file StartFaceDetectionRequest.h.

◆ WithNotificationChannel() [1/2]

StartFaceDetectionRequest& Aws::Rekognition::Model::StartFaceDetectionRequest::WithNotificationChannel ( const NotificationChannel value)
inline

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

Definition at line 170 of file StartFaceDetectionRequest.h.

◆ WithNotificationChannel() [2/2]

StartFaceDetectionRequest& Aws::Rekognition::Model::StartFaceDetectionRequest::WithNotificationChannel ( NotificationChannel &&  value)
inline

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

Definition at line 176 of file StartFaceDetectionRequest.h.

◆ WithVideo() [1/2]

StartFaceDetectionRequest& Aws::Rekognition::Model::StartFaceDetectionRequest::WithVideo ( const Video value)
inline

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

Definition at line 68 of file StartFaceDetectionRequest.h.

◆ WithVideo() [2/2]

StartFaceDetectionRequest& Aws::Rekognition::Model::StartFaceDetectionRequest::WithVideo ( Video &&  value)
inline

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

Definition at line 74 of file StartFaceDetectionRequest.h.


The documentation for this class was generated from the following file: