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

#include <IndexFacesRequest.h>

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

Public Member Functions

 IndexFacesRequest ()
 
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)
 
IndexFacesRequestWithCollectionId (const Aws::String &value)
 
IndexFacesRequestWithCollectionId (Aws::String &&value)
 
IndexFacesRequestWithCollectionId (const char *value)
 
const ImageGetImage () const
 
bool ImageHasBeenSet () const
 
void SetImage (const Image &value)
 
void SetImage (Image &&value)
 
IndexFacesRequestWithImage (const Image &value)
 
IndexFacesRequestWithImage (Image &&value)
 
const Aws::StringGetExternalImageId () const
 
bool ExternalImageIdHasBeenSet () const
 
void SetExternalImageId (const Aws::String &value)
 
void SetExternalImageId (Aws::String &&value)
 
void SetExternalImageId (const char *value)
 
IndexFacesRequestWithExternalImageId (const Aws::String &value)
 
IndexFacesRequestWithExternalImageId (Aws::String &&value)
 
IndexFacesRequestWithExternalImageId (const char *value)
 
const Aws::Vector< Attribute > & GetDetectionAttributes () const
 
bool DetectionAttributesHasBeenSet () const
 
void SetDetectionAttributes (const Aws::Vector< Attribute > &value)
 
void SetDetectionAttributes (Aws::Vector< Attribute > &&value)
 
IndexFacesRequestWithDetectionAttributes (const Aws::Vector< Attribute > &value)
 
IndexFacesRequestWithDetectionAttributes (Aws::Vector< Attribute > &&value)
 
IndexFacesRequestAddDetectionAttributes (const Attribute &value)
 
IndexFacesRequestAddDetectionAttributes (Attribute &&value)
 
int GetMaxFaces () const
 
bool MaxFacesHasBeenSet () const
 
void SetMaxFaces (int value)
 
IndexFacesRequestWithMaxFaces (int value)
 
const QualityFilterGetQualityFilter () const
 
bool QualityFilterHasBeenSet () const
 
void SetQualityFilter (const QualityFilter &value)
 
void SetQualityFilter (QualityFilter &&value)
 
IndexFacesRequestWithQualityFilter (const QualityFilter &value)
 
IndexFacesRequestWithQualityFilter (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 25 of file IndexFacesRequest.h.

Constructor & Destructor Documentation

◆ IndexFacesRequest()

Aws::Rekognition::Model::IndexFacesRequest::IndexFacesRequest ( )

Member Function Documentation

◆ AddDetectionAttributes() [1/2]

IndexFacesRequest& Aws::Rekognition::Model::IndexFacesRequest::AddDetectionAttributes ( Attribute &&  value)
inline

An array of facial attributes that you want to be returned. This can be the default list of attributes or all attributes. If you don't specify a value for Attributes or if you specify ["DEFAULT"], the API returns the following subset of facial attributes: BoundingBox, Confidence, Pose, Quality, and Landmarks. If you provide ["ALL"], all facial attributes are returned, but the operation takes longer to complete.

If you provide both, ["ALL", "DEFAULT"], the service uses a logical AND operator to determine which attributes to return (in this case, all attributes).

Definition at line 302 of file IndexFacesRequest.h.

◆ AddDetectionAttributes() [2/2]

IndexFacesRequest& Aws::Rekognition::Model::IndexFacesRequest::AddDetectionAttributes ( const Attribute value)
inline

An array of facial attributes that you want to be returned. This can be the default list of attributes or all attributes. If you don't specify a value for Attributes or if you specify ["DEFAULT"], the API returns the following subset of facial attributes: BoundingBox, Confidence, Pose, Quality, and Landmarks. If you provide ["ALL"], all facial attributes are returned, but the operation takes longer to complete.

If you provide both, ["ALL", "DEFAULT"], the service uses a logical AND operator to determine which attributes to return (in this case, all attributes).

Definition at line 288 of file IndexFacesRequest.h.

◆ CollectionIdHasBeenSet()

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

The ID of an existing collection to which you want to add the faces that are detected in the input images.

Definition at line 51 of file IndexFacesRequest.h.

◆ DetectionAttributesHasBeenSet()

bool Aws::Rekognition::Model::IndexFacesRequest::DetectionAttributesHasBeenSet ( ) const
inline

An array of facial attributes that you want to be returned. This can be the default list of attributes or all attributes. If you don't specify a value for Attributes or if you specify ["DEFAULT"], the API returns the following subset of facial attributes: BoundingBox, Confidence, Pose, Quality, and Landmarks. If you provide ["ALL"], all facial attributes are returned, but the operation takes longer to complete.

If you provide both, ["ALL", "DEFAULT"], the service uses a logical AND operator to determine which attributes to return (in this case, all attributes).

Definition at line 218 of file IndexFacesRequest.h.

◆ ExternalImageIdHasBeenSet()

bool Aws::Rekognition::Model::IndexFacesRequest::ExternalImageIdHasBeenSet ( ) const
inline

The ID you want to assign to all the faces detected in the image.

Definition at line 159 of file IndexFacesRequest.h.

◆ GetCollectionId()

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

The ID of an existing collection to which you want to add the faces that are detected in the input images.

Definition at line 45 of file IndexFacesRequest.h.

◆ GetDetectionAttributes()

const Aws::Vector<Attribute>& Aws::Rekognition::Model::IndexFacesRequest::GetDetectionAttributes ( ) const
inline

An array of facial attributes that you want to be returned. This can be the default list of attributes or all attributes. If you don't specify a value for Attributes or if you specify ["DEFAULT"], the API returns the following subset of facial attributes: BoundingBox, Confidence, Pose, Quality, and Landmarks. If you provide ["ALL"], all facial attributes are returned, but the operation takes longer to complete.

If you provide both, ["ALL", "DEFAULT"], the service uses a logical AND operator to determine which attributes to return (in this case, all attributes).

Definition at line 204 of file IndexFacesRequest.h.

◆ GetExternalImageId()

const Aws::String& Aws::Rekognition::Model::IndexFacesRequest::GetExternalImageId ( ) const
inline

The ID you want to assign to all the faces detected in the image.

Definition at line 154 of file IndexFacesRequest.h.

◆ GetImage()

const Image& Aws::Rekognition::Model::IndexFacesRequest::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 isn't 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 IndexFacesRequest.h.

◆ GetMaxFaces()

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

The maximum number of faces to index. The value of MaxFaces must be greater than or equal to 1. IndexFaces returns no more than 100 detected faces in an image, even if you specify a larger value for MaxFaces.

If IndexFaces detects more faces than the value of MaxFaces, the faces with the lowest quality are filtered out first. If there are still more faces than the value of MaxFaces, the faces with the smallest bounding boxes are filtered out (up to the number that's needed to satisfy the value of MaxFaces). Information about the unindexed faces is available in the UnindexedFaces array.

The faces that are returned by IndexFaces are sorted by the largest face bounding box size to the smallest size, in descending order.

MaxFaces can be used with a collection associated with any version of the face model.

Definition at line 320 of file IndexFacesRequest.h.

◆ GetQualityFilter()

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

A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't indexed. 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 default value is AUTO. 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.

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

Definition at line 387 of file IndexFacesRequest.h.

◆ GetRequestSpecificHeaders()

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

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file IndexFacesRequest.h.

◆ ImageHasBeenSet()

bool Aws::Rekognition::Model::IndexFacesRequest::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 isn't 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 IndexFacesRequest.h.

◆ MaxFacesHasBeenSet()

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

The maximum number of faces to index. The value of MaxFaces must be greater than or equal to 1. IndexFaces returns no more than 100 detected faces in an image, even if you specify a larger value for MaxFaces.

If IndexFaces detects more faces than the value of MaxFaces, the faces with the lowest quality are filtered out first. If there are still more faces than the value of MaxFaces, the faces with the smallest bounding boxes are filtered out (up to the number that's needed to satisfy the value of MaxFaces). Information about the unindexed faces is available in the UnindexedFaces array.

The faces that are returned by IndexFaces are sorted by the largest face bounding box size to the smallest size, in descending order.

MaxFaces can be used with a collection associated with any version of the face model.

Definition at line 337 of file IndexFacesRequest.h.

◆ QualityFilterHasBeenSet()

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

A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't indexed. 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 default value is AUTO. 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.

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

Definition at line 402 of file IndexFacesRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetCollectionId() [1/3]

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

The ID of an existing collection to which you want to add the faces that are detected in the input images.

Definition at line 63 of file IndexFacesRequest.h.

◆ SetCollectionId() [2/3]

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

The ID of an existing collection to which you want to add the faces that are detected in the input images.

Definition at line 57 of file IndexFacesRequest.h.

◆ SetCollectionId() [3/3]

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

The ID of an existing collection to which you want to add the faces that are detected in the input images.

Definition at line 69 of file IndexFacesRequest.h.

◆ SetDetectionAttributes() [1/2]

void Aws::Rekognition::Model::IndexFacesRequest::SetDetectionAttributes ( Aws::Vector< Attribute > &&  value)
inline

An array of facial attributes that you want to be returned. This can be the default list of attributes or all attributes. If you don't specify a value for Attributes or if you specify ["DEFAULT"], the API returns the following subset of facial attributes: BoundingBox, Confidence, Pose, Quality, and Landmarks. If you provide ["ALL"], all facial attributes are returned, but the operation takes longer to complete.

If you provide both, ["ALL", "DEFAULT"], the service uses a logical AND operator to determine which attributes to return (in this case, all attributes).

Definition at line 246 of file IndexFacesRequest.h.

◆ SetDetectionAttributes() [2/2]

void Aws::Rekognition::Model::IndexFacesRequest::SetDetectionAttributes ( const Aws::Vector< Attribute > &  value)
inline

An array of facial attributes that you want to be returned. This can be the default list of attributes or all attributes. If you don't specify a value for Attributes or if you specify ["DEFAULT"], the API returns the following subset of facial attributes: BoundingBox, Confidence, Pose, Quality, and Landmarks. If you provide ["ALL"], all facial attributes are returned, but the operation takes longer to complete.

If you provide both, ["ALL", "DEFAULT"], the service uses a logical AND operator to determine which attributes to return (in this case, all attributes).

Definition at line 232 of file IndexFacesRequest.h.

◆ SetExternalImageId() [1/3]

void Aws::Rekognition::Model::IndexFacesRequest::SetExternalImageId ( Aws::String &&  value)
inline

The ID you want to assign to all the faces detected in the image.

Definition at line 169 of file IndexFacesRequest.h.

◆ SetExternalImageId() [2/3]

void Aws::Rekognition::Model::IndexFacesRequest::SetExternalImageId ( const Aws::String value)
inline

The ID you want to assign to all the faces detected in the image.

Definition at line 164 of file IndexFacesRequest.h.

◆ SetExternalImageId() [3/3]

void Aws::Rekognition::Model::IndexFacesRequest::SetExternalImageId ( const char *  value)
inline

The ID you want to assign to all the faces detected in the image.

Definition at line 174 of file IndexFacesRequest.h.

◆ SetImage() [1/2]

void Aws::Rekognition::Model::IndexFacesRequest::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 isn't 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 IndexFacesRequest.h.

◆ SetImage() [2/2]

void Aws::Rekognition::Model::IndexFacesRequest::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 isn't 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 IndexFacesRequest.h.

◆ SetMaxFaces()

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

The maximum number of faces to index. The value of MaxFaces must be greater than or equal to 1. IndexFaces returns no more than 100 detected faces in an image, even if you specify a larger value for MaxFaces.

If IndexFaces detects more faces than the value of MaxFaces, the faces with the lowest quality are filtered out first. If there are still more faces than the value of MaxFaces, the faces with the smallest bounding boxes are filtered out (up to the number that's needed to satisfy the value of MaxFaces). Information about the unindexed faces is available in the UnindexedFaces array.

The faces that are returned by IndexFaces are sorted by the largest face bounding box size to the smallest size, in descending order.

MaxFaces can be used with a collection associated with any version of the face model.

Definition at line 354 of file IndexFacesRequest.h.

◆ SetQualityFilter() [1/2]

void Aws::Rekognition::Model::IndexFacesRequest::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 indexed. 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 default value is AUTO. 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.

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

Definition at line 417 of file IndexFacesRequest.h.

◆ SetQualityFilter() [2/2]

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

A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't indexed. 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 default value is AUTO. 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.

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

Definition at line 432 of file IndexFacesRequest.h.

◆ WithCollectionId() [1/3]

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

The ID of an existing collection to which you want to add the faces that are detected in the input images.

Definition at line 81 of file IndexFacesRequest.h.

◆ WithCollectionId() [2/3]

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

The ID of an existing collection to which you want to add the faces that are detected in the input images.

Definition at line 75 of file IndexFacesRequest.h.

◆ WithCollectionId() [3/3]

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

The ID of an existing collection to which you want to add the faces that are detected in the input images.

Definition at line 87 of file IndexFacesRequest.h.

◆ WithDetectionAttributes() [1/2]

IndexFacesRequest& Aws::Rekognition::Model::IndexFacesRequest::WithDetectionAttributes ( Aws::Vector< Attribute > &&  value)
inline

An array of facial attributes that you want to be returned. This can be the default list of attributes or all attributes. If you don't specify a value for Attributes or if you specify ["DEFAULT"], the API returns the following subset of facial attributes: BoundingBox, Confidence, Pose, Quality, and Landmarks. If you provide ["ALL"], all facial attributes are returned, but the operation takes longer to complete.

If you provide both, ["ALL", "DEFAULT"], the service uses a logical AND operator to determine which attributes to return (in this case, all attributes).

Definition at line 274 of file IndexFacesRequest.h.

◆ WithDetectionAttributes() [2/2]

IndexFacesRequest& Aws::Rekognition::Model::IndexFacesRequest::WithDetectionAttributes ( const Aws::Vector< Attribute > &  value)
inline

An array of facial attributes that you want to be returned. This can be the default list of attributes or all attributes. If you don't specify a value for Attributes or if you specify ["DEFAULT"], the API returns the following subset of facial attributes: BoundingBox, Confidence, Pose, Quality, and Landmarks. If you provide ["ALL"], all facial attributes are returned, but the operation takes longer to complete.

If you provide both, ["ALL", "DEFAULT"], the service uses a logical AND operator to determine which attributes to return (in this case, all attributes).

Definition at line 260 of file IndexFacesRequest.h.

◆ WithExternalImageId() [1/3]

IndexFacesRequest& Aws::Rekognition::Model::IndexFacesRequest::WithExternalImageId ( Aws::String &&  value)
inline

The ID you want to assign to all the faces detected in the image.

Definition at line 184 of file IndexFacesRequest.h.

◆ WithExternalImageId() [2/3]

IndexFacesRequest& Aws::Rekognition::Model::IndexFacesRequest::WithExternalImageId ( const Aws::String value)
inline

The ID you want to assign to all the faces detected in the image.

Definition at line 179 of file IndexFacesRequest.h.

◆ WithExternalImageId() [3/3]

IndexFacesRequest& Aws::Rekognition::Model::IndexFacesRequest::WithExternalImageId ( const char *  value)
inline

The ID you want to assign to all the faces detected in the image.

Definition at line 189 of file IndexFacesRequest.h.

◆ WithImage() [1/2]

IndexFacesRequest& Aws::Rekognition::Model::IndexFacesRequest::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 isn't 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 IndexFacesRequest.h.

◆ WithImage() [2/2]

IndexFacesRequest& Aws::Rekognition::Model::IndexFacesRequest::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 isn't 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 148 of file IndexFacesRequest.h.

◆ WithMaxFaces()

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

The maximum number of faces to index. The value of MaxFaces must be greater than or equal to 1. IndexFaces returns no more than 100 detected faces in an image, even if you specify a larger value for MaxFaces.

If IndexFaces detects more faces than the value of MaxFaces, the faces with the lowest quality are filtered out first. If there are still more faces than the value of MaxFaces, the faces with the smallest bounding boxes are filtered out (up to the number that's needed to satisfy the value of MaxFaces). Information about the unindexed faces is available in the UnindexedFaces array.

The faces that are returned by IndexFaces are sorted by the largest face bounding box size to the smallest size, in descending order.

MaxFaces can be used with a collection associated with any version of the face model.

Definition at line 371 of file IndexFacesRequest.h.

◆ WithQualityFilter() [1/2]

IndexFacesRequest& Aws::Rekognition::Model::IndexFacesRequest::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 indexed. 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 default value is AUTO. 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.

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

Definition at line 447 of file IndexFacesRequest.h.

◆ WithQualityFilter() [2/2]

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

A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't indexed. 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 default value is AUTO. 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.

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

Definition at line 462 of file IndexFacesRequest.h.


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