/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include namespace Aws { namespace Rekognition { namespace Model { /** */ class DetectFacesRequest : public RekognitionRequest { public: AWS_REKOGNITION_API DetectFacesRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "DetectFaces"; } AWS_REKOGNITION_API Aws::String SerializePayload() const override; AWS_REKOGNITION_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

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.

*/ inline const Image& GetImage() const{ return m_image; } /** *

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.

*/ inline bool ImageHasBeenSet() const { return m_imageHasBeenSet; } /** *

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.

*/ inline void SetImage(const Image& value) { m_imageHasBeenSet = true; m_image = value; } /** *

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.

*/ inline void SetImage(Image&& value) { m_imageHasBeenSet = true; m_image = std::move(value); } /** *

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.

*/ inline DetectFacesRequest& WithImage(const Image& value) { SetImage(value); return *this;} /** *

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.

*/ inline DetectFacesRequest& WithImage(Image&& value) { SetImage(std::move(value)); return *this;} /** *

An array of facial attributes you want to be returned. A DEFAULT * subset of facial attributes - BoundingBox, Confidence, * Pose, Quality, and Landmarks - will * always be returned. You can request for specific facial attributes (in addition * to the default list) - by using ["DEFAULT", "FACE_OCCLUDED"] or * just ["FACE_OCCLUDED"]. You can request for all facial attributes * by using ["ALL"]. Requesting more attributes may increase response * time.

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

*/ inline const Aws::Vector& GetAttributes() const{ return m_attributes; } /** *

An array of facial attributes you want to be returned. A DEFAULT * subset of facial attributes - BoundingBox, Confidence, * Pose, Quality, and Landmarks - will * always be returned. You can request for specific facial attributes (in addition * to the default list) - by using ["DEFAULT", "FACE_OCCLUDED"] or * just ["FACE_OCCLUDED"]. You can request for all facial attributes * by using ["ALL"]. Requesting more attributes may increase response * time.

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

*/ inline bool AttributesHasBeenSet() const { return m_attributesHasBeenSet; } /** *

An array of facial attributes you want to be returned. A DEFAULT * subset of facial attributes - BoundingBox, Confidence, * Pose, Quality, and Landmarks - will * always be returned. You can request for specific facial attributes (in addition * to the default list) - by using ["DEFAULT", "FACE_OCCLUDED"] or * just ["FACE_OCCLUDED"]. You can request for all facial attributes * by using ["ALL"]. Requesting more attributes may increase response * time.

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

*/ inline void SetAttributes(const Aws::Vector& value) { m_attributesHasBeenSet = true; m_attributes = value; } /** *

An array of facial attributes you want to be returned. A DEFAULT * subset of facial attributes - BoundingBox, Confidence, * Pose, Quality, and Landmarks - will * always be returned. You can request for specific facial attributes (in addition * to the default list) - by using ["DEFAULT", "FACE_OCCLUDED"] or * just ["FACE_OCCLUDED"]. You can request for all facial attributes * by using ["ALL"]. Requesting more attributes may increase response * time.

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

*/ inline void SetAttributes(Aws::Vector&& value) { m_attributesHasBeenSet = true; m_attributes = std::move(value); } /** *

An array of facial attributes you want to be returned. A DEFAULT * subset of facial attributes - BoundingBox, Confidence, * Pose, Quality, and Landmarks - will * always be returned. You can request for specific facial attributes (in addition * to the default list) - by using ["DEFAULT", "FACE_OCCLUDED"] or * just ["FACE_OCCLUDED"]. You can request for all facial attributes * by using ["ALL"]. Requesting more attributes may increase response * time.

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

*/ inline DetectFacesRequest& WithAttributes(const Aws::Vector& value) { SetAttributes(value); return *this;} /** *

An array of facial attributes you want to be returned. A DEFAULT * subset of facial attributes - BoundingBox, Confidence, * Pose, Quality, and Landmarks - will * always be returned. You can request for specific facial attributes (in addition * to the default list) - by using ["DEFAULT", "FACE_OCCLUDED"] or * just ["FACE_OCCLUDED"]. You can request for all facial attributes * by using ["ALL"]. Requesting more attributes may increase response * time.

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

*/ inline DetectFacesRequest& WithAttributes(Aws::Vector&& value) { SetAttributes(std::move(value)); return *this;} /** *

An array of facial attributes you want to be returned. A DEFAULT * subset of facial attributes - BoundingBox, Confidence, * Pose, Quality, and Landmarks - will * always be returned. You can request for specific facial attributes (in addition * to the default list) - by using ["DEFAULT", "FACE_OCCLUDED"] or * just ["FACE_OCCLUDED"]. You can request for all facial attributes * by using ["ALL"]. Requesting more attributes may increase response * time.

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

*/ inline DetectFacesRequest& AddAttributes(const Attribute& value) { m_attributesHasBeenSet = true; m_attributes.push_back(value); return *this; } /** *

An array of facial attributes you want to be returned. A DEFAULT * subset of facial attributes - BoundingBox, Confidence, * Pose, Quality, and Landmarks - will * always be returned. You can request for specific facial attributes (in addition * to the default list) - by using ["DEFAULT", "FACE_OCCLUDED"] or * just ["FACE_OCCLUDED"]. You can request for all facial attributes * by using ["ALL"]. Requesting more attributes may increase response * time.

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

*/ inline DetectFacesRequest& AddAttributes(Attribute&& value) { m_attributesHasBeenSet = true; m_attributes.push_back(std::move(value)); return *this; } private: Image m_image; bool m_imageHasBeenSet = false; Aws::Vector m_attributes; bool m_attributesHasBeenSet = false; }; } // namespace Model } // namespace Rekognition } // namespace Aws