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

#include <DetectFacesRequest.h>

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

Public Member Functions

 DetectFacesRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const ImageGetImage () const
 
bool ImageHasBeenSet () const
 
void SetImage (const Image &value)
 
void SetImage (Image &&value)
 
DetectFacesRequestWithImage (const Image &value)
 
DetectFacesRequestWithImage (Image &&value)
 
const Aws::Vector< Attribute > & GetAttributes () const
 
bool AttributesHasBeenSet () const
 
void SetAttributes (const Aws::Vector< Attribute > &value)
 
void SetAttributes (Aws::Vector< Attribute > &&value)
 
DetectFacesRequestWithAttributes (const Aws::Vector< Attribute > &value)
 
DetectFacesRequestWithAttributes (Aws::Vector< Attribute > &&value)
 
DetectFacesRequestAddAttributes (const Attribute &value)
 
DetectFacesRequestAddAttributes (Attribute &&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 DetectFacesRequest.h.

Constructor & Destructor Documentation

◆ DetectFacesRequest()

Aws::Rekognition::Model::DetectFacesRequest::DetectFacesRequest ( )

Member Function Documentation

◆ AddAttributes() [1/2]

DetectFacesRequest& Aws::Rekognition::Model::DetectFacesRequest::AddAttributes ( Attribute &&  value)
inline

An array of facial attributes 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 210 of file DetectFacesRequest.h.

◆ AddAttributes() [2/2]

DetectFacesRequest& Aws::Rekognition::Model::DetectFacesRequest::AddAttributes ( const Attribute value)
inline

An array of facial attributes 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 196 of file DetectFacesRequest.h.

◆ AttributesHasBeenSet()

bool Aws::Rekognition::Model::DetectFacesRequest::AttributesHasBeenSet ( ) const
inline

An array of facial attributes 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 126 of file DetectFacesRequest.h.

◆ GetAttributes()

const Aws::Vector<Attribute>& Aws::Rekognition::Model::DetectFacesRequest::GetAttributes ( ) const
inline

An array of facial attributes 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 112 of file DetectFacesRequest.h.

◆ GetImage()

const Image& Aws::Rekognition::Model::DetectFacesRequest::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 47 of file DetectFacesRequest.h.

◆ GetRequestSpecificHeaders()

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

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file DetectFacesRequest.h.

◆ ImageHasBeenSet()

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

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAttributes() [1/2]

void Aws::Rekognition::Model::DetectFacesRequest::SetAttributes ( Aws::Vector< Attribute > &&  value)
inline

An array of facial attributes 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 154 of file DetectFacesRequest.h.

◆ SetAttributes() [2/2]

void Aws::Rekognition::Model::DetectFacesRequest::SetAttributes ( const Aws::Vector< Attribute > &  value)
inline

An array of facial attributes 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 140 of file DetectFacesRequest.h.

◆ SetImage() [1/2]

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

◆ SetImage() [2/2]

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

◆ WithAttributes() [1/2]

DetectFacesRequest& Aws::Rekognition::Model::DetectFacesRequest::WithAttributes ( Aws::Vector< Attribute > &&  value)
inline

An array of facial attributes 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 182 of file DetectFacesRequest.h.

◆ WithAttributes() [2/2]

DetectFacesRequest& Aws::Rekognition::Model::DetectFacesRequest::WithAttributes ( const Aws::Vector< Attribute > &  value)
inline

An array of facial attributes 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 168 of file DetectFacesRequest.h.

◆ WithImage() [1/2]

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

◆ WithImage() [2/2]

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


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