/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include namespace Aws { namespace Rekognition { namespace Model { /** */ class StartFaceDetectionRequest : public RekognitionRequest { public: AWS_REKOGNITION_API StartFaceDetectionRequest(); // 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 "StartFaceDetection"; } AWS_REKOGNITION_API Aws::String SerializePayload() const override; AWS_REKOGNITION_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

The video in which you want to detect faces. The video must be stored in an * Amazon S3 bucket.

*/ inline const Video& GetVideo() const{ return m_video; } /** *

The video in which you want to detect faces. The video must be stored in an * Amazon S3 bucket.

*/ inline bool VideoHasBeenSet() const { return m_videoHasBeenSet; } /** *

The video in which you want to detect faces. The video must be stored in an * Amazon S3 bucket.

*/ inline void SetVideo(const Video& value) { m_videoHasBeenSet = true; m_video = value; } /** *

The video in which you want to detect faces. The video must be stored in an * Amazon S3 bucket.

*/ inline void SetVideo(Video&& value) { m_videoHasBeenSet = true; m_video = std::move(value); } /** *

The video in which you want to detect faces. The video must be stored in an * Amazon S3 bucket.

*/ inline StartFaceDetectionRequest& WithVideo(const Video& value) { SetVideo(value); return *this;} /** *

The video in which you want to detect faces. The video must be stored in an * Amazon S3 bucket.

*/ inline StartFaceDetectionRequest& WithVideo(Video&& value) { SetVideo(std::move(value)); return *this;} /** *

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

*/ inline const Aws::String& GetClientRequestToken() const{ return m_clientRequestToken; } /** *

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

*/ inline bool ClientRequestTokenHasBeenSet() const { return m_clientRequestTokenHasBeenSet; } /** *

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

*/ inline void SetClientRequestToken(const Aws::String& value) { m_clientRequestTokenHasBeenSet = true; m_clientRequestToken = value; } /** *

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

*/ inline void SetClientRequestToken(Aws::String&& value) { m_clientRequestTokenHasBeenSet = true; m_clientRequestToken = std::move(value); } /** *

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

*/ inline void SetClientRequestToken(const char* value) { m_clientRequestTokenHasBeenSet = true; m_clientRequestToken.assign(value); } /** *

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

*/ inline StartFaceDetectionRequest& WithClientRequestToken(const Aws::String& value) { SetClientRequestToken(value); return *this;} /** *

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

*/ inline StartFaceDetectionRequest& WithClientRequestToken(Aws::String&& value) { SetClientRequestToken(std::move(value)); return *this;} /** *

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

*/ inline StartFaceDetectionRequest& WithClientRequestToken(const char* value) { SetClientRequestToken(value); return *this;} /** *

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

*/ inline const NotificationChannel& GetNotificationChannel() const{ return m_notificationChannel; } /** *

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

*/ inline bool NotificationChannelHasBeenSet() const { return m_notificationChannelHasBeenSet; } /** *

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

*/ inline void SetNotificationChannel(const NotificationChannel& value) { m_notificationChannelHasBeenSet = true; m_notificationChannel = value; } /** *

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

*/ inline void SetNotificationChannel(NotificationChannel&& value) { m_notificationChannelHasBeenSet = true; m_notificationChannel = std::move(value); } /** *

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

*/ inline StartFaceDetectionRequest& WithNotificationChannel(const NotificationChannel& value) { SetNotificationChannel(value); return *this;} /** *

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

*/ inline StartFaceDetectionRequest& WithNotificationChannel(NotificationChannel&& value) { SetNotificationChannel(std::move(value)); return *this;} /** *

The face attributes you want returned.

DEFAULT - The * following subset of facial attributes are returned: BoundingBox, Confidence, * Pose, Quality and Landmarks.

ALL - All facial attributes * are returned.

*/ inline const FaceAttributes& GetFaceAttributes() const{ return m_faceAttributes; } /** *

The face attributes you want returned.

DEFAULT - The * following subset of facial attributes are returned: BoundingBox, Confidence, * Pose, Quality and Landmarks.

ALL - All facial attributes * are returned.

*/ inline bool FaceAttributesHasBeenSet() const { return m_faceAttributesHasBeenSet; } /** *

The face attributes you want returned.

DEFAULT - The * following subset of facial attributes are returned: BoundingBox, Confidence, * Pose, Quality and Landmarks.

ALL - All facial attributes * are returned.

*/ inline void SetFaceAttributes(const FaceAttributes& value) { m_faceAttributesHasBeenSet = true; m_faceAttributes = value; } /** *

The face attributes you want returned.

DEFAULT - The * following subset of facial attributes are returned: BoundingBox, Confidence, * Pose, Quality and Landmarks.

ALL - All facial attributes * are returned.

*/ inline void SetFaceAttributes(FaceAttributes&& value) { m_faceAttributesHasBeenSet = true; m_faceAttributes = std::move(value); } /** *

The face attributes you want returned.

DEFAULT - The * following subset of facial attributes are returned: BoundingBox, Confidence, * Pose, Quality and Landmarks.

ALL - All facial attributes * are returned.

*/ inline StartFaceDetectionRequest& WithFaceAttributes(const FaceAttributes& value) { SetFaceAttributes(value); return *this;} /** *

The face attributes you want returned.

DEFAULT - The * following subset of facial attributes are returned: BoundingBox, Confidence, * Pose, Quality and Landmarks.

ALL - All facial attributes * are returned.

*/ inline StartFaceDetectionRequest& WithFaceAttributes(FaceAttributes&& value) { SetFaceAttributes(std::move(value)); return *this;} /** *

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.

*/ inline const Aws::String& GetJobTag() const{ return m_jobTag; } /** *

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.

*/ inline bool JobTagHasBeenSet() const { return m_jobTagHasBeenSet; } /** *

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.

*/ inline void SetJobTag(const Aws::String& value) { m_jobTagHasBeenSet = true; m_jobTag = value; } /** *

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.

*/ inline void SetJobTag(Aws::String&& value) { m_jobTagHasBeenSet = true; m_jobTag = std::move(value); } /** *

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.

*/ inline void SetJobTag(const char* value) { m_jobTagHasBeenSet = true; m_jobTag.assign(value); } /** *

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.

*/ inline StartFaceDetectionRequest& WithJobTag(const Aws::String& value) { SetJobTag(value); return *this;} /** *

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.

*/ inline StartFaceDetectionRequest& WithJobTag(Aws::String&& value) { SetJobTag(std::move(value)); return *this;} /** *

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.

*/ inline StartFaceDetectionRequest& WithJobTag(const char* value) { SetJobTag(value); return *this;} private: Video m_video; bool m_videoHasBeenSet = false; Aws::String m_clientRequestToken; bool m_clientRequestTokenHasBeenSet = false; NotificationChannel m_notificationChannel; bool m_notificationChannelHasBeenSet = false; FaceAttributes m_faceAttributes; bool m_faceAttributesHasBeenSet = false; Aws::String m_jobTag; bool m_jobTagHasBeenSet = false; }; } // namespace Model } // namespace Rekognition } // namespace Aws