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

#include <SearchFacesByImageRequest.h>

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

Public Member Functions

 SearchFacesByImageRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetCollectionId () const
 
bool CollectionIdHasBeenSet () const
 
void SetCollectionId (const Aws::String &value)
 
void SetCollectionId (Aws::String &&value)
 
void SetCollectionId (const char *value)
 
SearchFacesByImageRequestWithCollectionId (const Aws::String &value)
 
SearchFacesByImageRequestWithCollectionId (Aws::String &&value)
 
SearchFacesByImageRequestWithCollectionId (const char *value)
 
const ImageGetImage () const
 
bool ImageHasBeenSet () const
 
void SetImage (const Image &value)
 
void SetImage (Image &&value)
 
SearchFacesByImageRequestWithImage (const Image &value)
 
SearchFacesByImageRequestWithImage (Image &&value)
 
int GetMaxFaces () const
 
bool MaxFacesHasBeenSet () const
 
void SetMaxFaces (int value)
 
SearchFacesByImageRequestWithMaxFaces (int value)
 
double GetFaceMatchThreshold () const
 
bool FaceMatchThresholdHasBeenSet () const
 
void SetFaceMatchThreshold (double value)
 
SearchFacesByImageRequestWithFaceMatchThreshold (double value)
 
const QualityFilterGetQualityFilter () const
 
bool QualityFilterHasBeenSet () const
 
void SetQualityFilter (const QualityFilter &value)
 
void SetQualityFilter (QualityFilter &&value)
 
SearchFacesByImageRequestWithQualityFilter (const QualityFilter &value)
 
SearchFacesByImageRequestWithQualityFilter (QualityFilter &&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 SearchFacesByImageRequest.h.

Constructor & Destructor Documentation

◆ SearchFacesByImageRequest()

Aws::Rekognition::Model::SearchFacesByImageRequest::SearchFacesByImageRequest ( )

Member Function Documentation

◆ CollectionIdHasBeenSet()

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

ID of the collection to search.

Definition at line 47 of file SearchFacesByImageRequest.h.

◆ FaceMatchThresholdHasBeenSet()

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

(Optional) Specifies the minimum confidence in the face 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 178 of file SearchFacesByImageRequest.h.

◆ GetCollectionId()

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

ID of the collection to search.

Definition at line 42 of file SearchFacesByImageRequest.h.

◆ GetFaceMatchThreshold()

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

(Optional) Specifies the minimum confidence in the face 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 171 of file SearchFacesByImageRequest.h.

◆ GetImage()

const Image& Aws::Rekognition::Model::SearchFacesByImageRequest::GetImage ( ) const
inline

The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.

If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

Definition at line 88 of file SearchFacesByImageRequest.h.

◆ GetMaxFaces()

int Aws::Rekognition::Model::SearchFacesByImageRequest::GetMaxFaces ( ) const
inline

Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.

Definition at line 145 of file SearchFacesByImageRequest.h.

◆ GetQualityFilter()

const QualityFilter& Aws::Rekognition::Model::SearchFacesByImageRequest::GetQualityFilter ( ) const
inline

A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't searched for in the collection. If you specify AUTO, Amazon Rekognition chooses the quality bar. If you specify LOW, MEDIUM, or HIGH, filtering removes all faces that don’t meet the chosen quality bar. The quality bar is based on a variety of common use cases. Low-quality detections can occur for a number of reasons. Some examples are an object that's misidentified as a face, a face that's too blurry, or a face with a pose that's too extreme to use. If you specify NONE, no filtering is performed. The default value is NONE.

To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.

Definition at line 208 of file SearchFacesByImageRequest.h.

◆ GetRequestSpecificHeaders()

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

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file SearchFacesByImageRequest.h.

◆ ImageHasBeenSet()

bool Aws::Rekognition::Model::SearchFacesByImageRequest::ImageHasBeenSet ( ) const
inline

The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.

If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

Definition at line 98 of file SearchFacesByImageRequest.h.

◆ MaxFacesHasBeenSet()

bool Aws::Rekognition::Model::SearchFacesByImageRequest::MaxFacesHasBeenSet ( ) const
inline

Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.

Definition at line 151 of file SearchFacesByImageRequest.h.

◆ QualityFilterHasBeenSet()

bool Aws::Rekognition::Model::SearchFacesByImageRequest::QualityFilterHasBeenSet ( ) const
inline

A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't searched for in the collection. If you specify AUTO, Amazon Rekognition chooses the quality bar. If you specify LOW, MEDIUM, or HIGH, filtering removes all faces that don’t meet the chosen quality bar. The quality bar is based on a variety of common use cases. Low-quality detections can occur for a number of reasons. Some examples are an object that's misidentified as a face, a face that's too blurry, or a face with a pose that's too extreme to use. If you specify NONE, no filtering is performed. The default value is NONE.

To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.

Definition at line 223 of file SearchFacesByImageRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetCollectionId() [1/3]

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

ID of the collection to search.

Definition at line 57 of file SearchFacesByImageRequest.h.

◆ SetCollectionId() [2/3]

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

ID of the collection to search.

Definition at line 52 of file SearchFacesByImageRequest.h.

◆ SetCollectionId() [3/3]

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

ID of the collection to search.

Definition at line 62 of file SearchFacesByImageRequest.h.

◆ SetFaceMatchThreshold()

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

(Optional) Specifies the minimum confidence in the face 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 185 of file SearchFacesByImageRequest.h.

◆ SetImage() [1/2]

void Aws::Rekognition::Model::SearchFacesByImageRequest::SetImage ( const Image value)
inline

The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.

If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

Definition at line 108 of file SearchFacesByImageRequest.h.

◆ SetImage() [2/2]

void Aws::Rekognition::Model::SearchFacesByImageRequest::SetImage ( Image &&  value)
inline

The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.

If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

Definition at line 118 of file SearchFacesByImageRequest.h.

◆ SetMaxFaces()

void Aws::Rekognition::Model::SearchFacesByImageRequest::SetMaxFaces ( int  value)
inline

Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.

Definition at line 157 of file SearchFacesByImageRequest.h.

◆ SetQualityFilter() [1/2]

void Aws::Rekognition::Model::SearchFacesByImageRequest::SetQualityFilter ( const QualityFilter value)
inline

A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't searched for in the collection. If you specify AUTO, Amazon Rekognition chooses the quality bar. If you specify LOW, MEDIUM, or HIGH, filtering removes all faces that don’t meet the chosen quality bar. The quality bar is based on a variety of common use cases. Low-quality detections can occur for a number of reasons. Some examples are an object that's misidentified as a face, a face that's too blurry, or a face with a pose that's too extreme to use. If you specify NONE, no filtering is performed. The default value is NONE.

To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.

Definition at line 238 of file SearchFacesByImageRequest.h.

◆ SetQualityFilter() [2/2]

void Aws::Rekognition::Model::SearchFacesByImageRequest::SetQualityFilter ( QualityFilter &&  value)
inline

A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't searched for in the collection. If you specify AUTO, Amazon Rekognition chooses the quality bar. If you specify LOW, MEDIUM, or HIGH, filtering removes all faces that don’t meet the chosen quality bar. The quality bar is based on a variety of common use cases. Low-quality detections can occur for a number of reasons. Some examples are an object that's misidentified as a face, a face that's too blurry, or a face with a pose that's too extreme to use. If you specify NONE, no filtering is performed. The default value is NONE.

To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.

Definition at line 253 of file SearchFacesByImageRequest.h.

◆ WithCollectionId() [1/3]

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

ID of the collection to search.

Definition at line 72 of file SearchFacesByImageRequest.h.

◆ WithCollectionId() [2/3]

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

ID of the collection to search.

Definition at line 67 of file SearchFacesByImageRequest.h.

◆ WithCollectionId() [3/3]

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

ID of the collection to search.

Definition at line 77 of file SearchFacesByImageRequest.h.

◆ WithFaceMatchThreshold()

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

(Optional) Specifies the minimum confidence in the face 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 192 of file SearchFacesByImageRequest.h.

◆ WithImage() [1/2]

SearchFacesByImageRequest& Aws::Rekognition::Model::SearchFacesByImageRequest::WithImage ( const Image value)
inline

The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.

If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

Definition at line 128 of file SearchFacesByImageRequest.h.

◆ WithImage() [2/2]

SearchFacesByImageRequest& Aws::Rekognition::Model::SearchFacesByImageRequest::WithImage ( Image &&  value)
inline

The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.

If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

Definition at line 138 of file SearchFacesByImageRequest.h.

◆ WithMaxFaces()

SearchFacesByImageRequest& Aws::Rekognition::Model::SearchFacesByImageRequest::WithMaxFaces ( int  value)
inline

Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.

Definition at line 163 of file SearchFacesByImageRequest.h.

◆ WithQualityFilter() [1/2]

SearchFacesByImageRequest& Aws::Rekognition::Model::SearchFacesByImageRequest::WithQualityFilter ( const QualityFilter value)
inline

A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't searched for in the collection. If you specify AUTO, Amazon Rekognition chooses the quality bar. If you specify LOW, MEDIUM, or HIGH, filtering removes all faces that don’t meet the chosen quality bar. The quality bar is based on a variety of common use cases. Low-quality detections can occur for a number of reasons. Some examples are an object that's misidentified as a face, a face that's too blurry, or a face with a pose that's too extreme to use. If you specify NONE, no filtering is performed. The default value is NONE.

To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.

Definition at line 268 of file SearchFacesByImageRequest.h.

◆ WithQualityFilter() [2/2]

SearchFacesByImageRequest& Aws::Rekognition::Model::SearchFacesByImageRequest::WithQualityFilter ( QualityFilter &&  value)
inline

A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't searched for in the collection. If you specify AUTO, Amazon Rekognition chooses the quality bar. If you specify LOW, MEDIUM, or HIGH, filtering removes all faces that don’t meet the chosen quality bar. The quality bar is based on a variety of common use cases. Low-quality detections can occur for a number of reasons. Some examples are an object that's misidentified as a face, a face that's too blurry, or a face with a pose that's too extreme to use. If you specify NONE, no filtering is performed. The default value is NONE.

To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.

Definition at line 283 of file SearchFacesByImageRequest.h.


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