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

#include <StartFaceSearchRequest.h>

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

Public Member Functions

 StartFaceSearchRequest ()
 
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)
 
StartFaceSearchRequestWithVideo (const Video &value)
 
StartFaceSearchRequestWithVideo (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)
 
StartFaceSearchRequestWithClientRequestToken (const Aws::String &value)
 
StartFaceSearchRequestWithClientRequestToken (Aws::String &&value)
 
StartFaceSearchRequestWithClientRequestToken (const char *value)
 
double GetFaceMatchThreshold () const
 
bool FaceMatchThresholdHasBeenSet () const
 
void SetFaceMatchThreshold (double value)
 
StartFaceSearchRequestWithFaceMatchThreshold (double value)
 
const Aws::StringGetCollectionId () const
 
bool CollectionIdHasBeenSet () const
 
void SetCollectionId (const Aws::String &value)
 
void SetCollectionId (Aws::String &&value)
 
void SetCollectionId (const char *value)
 
StartFaceSearchRequestWithCollectionId (const Aws::String &value)
 
StartFaceSearchRequestWithCollectionId (Aws::String &&value)
 
StartFaceSearchRequestWithCollectionId (const char *value)
 
const NotificationChannelGetNotificationChannel () const
 
bool NotificationChannelHasBeenSet () const
 
void SetNotificationChannel (const NotificationChannel &value)
 
void SetNotificationChannel (NotificationChannel &&value)
 
StartFaceSearchRequestWithNotificationChannel (const NotificationChannel &value)
 
StartFaceSearchRequestWithNotificationChannel (NotificationChannel &&value)
 
const Aws::StringGetJobTag () const
 
bool JobTagHasBeenSet () const
 
void SetJobTag (const Aws::String &value)
 
void SetJobTag (Aws::String &&value)
 
void SetJobTag (const char *value)
 
StartFaceSearchRequestWithJobTag (const Aws::String &value)
 
StartFaceSearchRequestWithJobTag (Aws::String &&value)
 
StartFaceSearchRequestWithJobTag (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 23 of file StartFaceSearchRequest.h.

Constructor & Destructor Documentation

◆ StartFaceSearchRequest()

Aws::Rekognition::Model::StartFaceSearchRequest::StartFaceSearchRequest ( )

Member Function Documentation

◆ ClientRequestTokenHasBeenSet()

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

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

Definition at line 90 of file StartFaceSearchRequest.h.

◆ CollectionIdHasBeenSet()

bool Aws::Rekognition::Model::StartFaceSearchRequest::CollectionIdHasBeenSet ( ) const
inline

ID of the collection that contains the faces you want to search for.

Definition at line 178 of file StartFaceSearchRequest.h.

◆ FaceMatchThresholdHasBeenSet()

bool Aws::Rekognition::Model::StartFaceSearchRequest::FaceMatchThresholdHasBeenSet ( ) const
inline

The minimum confidence in the person match to return. For example, don't return any matches where confidence in matches is less than 70%. The default value is 80%.

Definition at line 153 of file StartFaceSearchRequest.h.

◆ GetClientRequestToken()

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

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

Definition at line 82 of file StartFaceSearchRequest.h.

◆ GetCollectionId()

const Aws::String& Aws::Rekognition::Model::StartFaceSearchRequest::GetCollectionId ( ) const
inline

ID of the collection that contains the faces you want to search for.

Definition at line 173 of file StartFaceSearchRequest.h.

◆ GetFaceMatchThreshold()

double Aws::Rekognition::Model::StartFaceSearchRequest::GetFaceMatchThreshold ( ) const
inline

The minimum confidence in the person match to return. For example, don't return any matches where confidence in matches is less than 70%. The default value is 80%.

Definition at line 146 of file StartFaceSearchRequest.h.

◆ GetJobTag()

const Aws::String& Aws::Rekognition::Model::StartFaceSearchRequest::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 266 of file StartFaceSearchRequest.h.

◆ GetNotificationChannel()

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

The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the search. The Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy to access the topic.

Definition at line 217 of file StartFaceSearchRequest.h.

◆ GetRequestSpecificHeaders()

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

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file StartFaceSearchRequest.h.

◆ GetVideo()

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

The video you want to search. The video must be stored in an Amazon S3 bucket.

Definition at line 43 of file StartFaceSearchRequest.h.

◆ JobTagHasBeenSet()

bool Aws::Rekognition::Model::StartFaceSearchRequest::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 274 of file StartFaceSearchRequest.h.

◆ NotificationChannelHasBeenSet()

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

The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the search. The Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy to access the topic.

Definition at line 225 of file StartFaceSearchRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetClientRequestToken() [1/3]

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

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

Definition at line 106 of file StartFaceSearchRequest.h.

◆ SetClientRequestToken() [2/3]

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

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

Definition at line 98 of file StartFaceSearchRequest.h.

◆ SetClientRequestToken() [3/3]

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

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

Definition at line 114 of file StartFaceSearchRequest.h.

◆ SetCollectionId() [1/3]

void Aws::Rekognition::Model::StartFaceSearchRequest::SetCollectionId ( Aws::String &&  value)
inline

ID of the collection that contains the faces you want to search for.

Definition at line 188 of file StartFaceSearchRequest.h.

◆ SetCollectionId() [2/3]

void Aws::Rekognition::Model::StartFaceSearchRequest::SetCollectionId ( const Aws::String value)
inline

ID of the collection that contains the faces you want to search for.

Definition at line 183 of file StartFaceSearchRequest.h.

◆ SetCollectionId() [3/3]

void Aws::Rekognition::Model::StartFaceSearchRequest::SetCollectionId ( const char *  value)
inline

ID of the collection that contains the faces you want to search for.

Definition at line 193 of file StartFaceSearchRequest.h.

◆ SetFaceMatchThreshold()

void Aws::Rekognition::Model::StartFaceSearchRequest::SetFaceMatchThreshold ( double  value)
inline

The minimum confidence in the person match to return. For example, don't return any matches where confidence in matches is less than 70%. The default value is 80%.

Definition at line 160 of file StartFaceSearchRequest.h.

◆ SetJobTag() [1/3]

void Aws::Rekognition::Model::StartFaceSearchRequest::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 290 of file StartFaceSearchRequest.h.

◆ SetJobTag() [2/3]

void Aws::Rekognition::Model::StartFaceSearchRequest::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 282 of file StartFaceSearchRequest.h.

◆ SetJobTag() [3/3]

void Aws::Rekognition::Model::StartFaceSearchRequest::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 298 of file StartFaceSearchRequest.h.

◆ SetNotificationChannel() [1/2]

void Aws::Rekognition::Model::StartFaceSearchRequest::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 search. The Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy to access the topic.

Definition at line 233 of file StartFaceSearchRequest.h.

◆ SetNotificationChannel() [2/2]

void Aws::Rekognition::Model::StartFaceSearchRequest::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 search. The Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy to access the topic.

Definition at line 241 of file StartFaceSearchRequest.h.

◆ SetVideo() [1/2]

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

The video you want to search. The video must be stored in an Amazon S3 bucket.

Definition at line 55 of file StartFaceSearchRequest.h.

◆ SetVideo() [2/2]

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

The video you want to search. The video must be stored in an Amazon S3 bucket.

Definition at line 61 of file StartFaceSearchRequest.h.

◆ VideoHasBeenSet()

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

The video you want to search. The video must be stored in an Amazon S3 bucket.

Definition at line 49 of file StartFaceSearchRequest.h.

◆ WithClientRequestToken() [1/3]

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

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

Definition at line 130 of file StartFaceSearchRequest.h.

◆ WithClientRequestToken() [2/3]

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

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

Definition at line 122 of file StartFaceSearchRequest.h.

◆ WithClientRequestToken() [3/3]

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

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

Definition at line 138 of file StartFaceSearchRequest.h.

◆ WithCollectionId() [1/3]

StartFaceSearchRequest& Aws::Rekognition::Model::StartFaceSearchRequest::WithCollectionId ( Aws::String &&  value)
inline

ID of the collection that contains the faces you want to search for.

Definition at line 203 of file StartFaceSearchRequest.h.

◆ WithCollectionId() [2/3]

StartFaceSearchRequest& Aws::Rekognition::Model::StartFaceSearchRequest::WithCollectionId ( const Aws::String value)
inline

ID of the collection that contains the faces you want to search for.

Definition at line 198 of file StartFaceSearchRequest.h.

◆ WithCollectionId() [3/3]

StartFaceSearchRequest& Aws::Rekognition::Model::StartFaceSearchRequest::WithCollectionId ( const char *  value)
inline

ID of the collection that contains the faces you want to search for.

Definition at line 208 of file StartFaceSearchRequest.h.

◆ WithFaceMatchThreshold()

StartFaceSearchRequest& Aws::Rekognition::Model::StartFaceSearchRequest::WithFaceMatchThreshold ( double  value)
inline

The minimum confidence in the person match to return. For example, don't return any matches where confidence in matches is less than 70%. The default value is 80%.

Definition at line 167 of file StartFaceSearchRequest.h.

◆ WithJobTag() [1/3]

StartFaceSearchRequest& Aws::Rekognition::Model::StartFaceSearchRequest::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 314 of file StartFaceSearchRequest.h.

◆ WithJobTag() [2/3]

StartFaceSearchRequest& Aws::Rekognition::Model::StartFaceSearchRequest::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 306 of file StartFaceSearchRequest.h.

◆ WithJobTag() [3/3]

StartFaceSearchRequest& Aws::Rekognition::Model::StartFaceSearchRequest::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 322 of file StartFaceSearchRequest.h.

◆ WithNotificationChannel() [1/2]

StartFaceSearchRequest& Aws::Rekognition::Model::StartFaceSearchRequest::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 search. The Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy to access the topic.

Definition at line 249 of file StartFaceSearchRequest.h.

◆ WithNotificationChannel() [2/2]

StartFaceSearchRequest& Aws::Rekognition::Model::StartFaceSearchRequest::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 search. The Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy to access the topic.

Definition at line 257 of file StartFaceSearchRequest.h.

◆ WithVideo() [1/2]

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

The video you want to search. The video must be stored in an Amazon S3 bucket.

Definition at line 67 of file StartFaceSearchRequest.h.

◆ WithVideo() [2/2]

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

The video you want to search. The video must be stored in an Amazon S3 bucket.

Definition at line 73 of file StartFaceSearchRequest.h.


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