/** * 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 #include #include namespace Aws { namespace Rekognition { namespace Model { /** */ class StartLabelDetectionRequest : public RekognitionRequest { public: AWS_REKOGNITION_API StartLabelDetectionRequest(); // 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 "StartLabelDetection"; } 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 labels. 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 labels. 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 labels. 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 labels. 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 labels. The video must be stored in an * Amazon S3 bucket.

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

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

*/ inline StartLabelDetectionRequest& 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 StartLabelDetection 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 StartLabelDetection 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 StartLabelDetection 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 StartLabelDetection 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 StartLabelDetection 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 StartLabelDetection requests, the same * JobId is returned. Use ClientRequestToken to prevent * the same job from being accidently started more than once.

*/ inline StartLabelDetectionRequest& 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 StartLabelDetection requests, the same * JobId is returned. Use ClientRequestToken to prevent * the same job from being accidently started more than once.

*/ inline StartLabelDetectionRequest& 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 StartLabelDetection requests, the same * JobId is returned. Use ClientRequestToken to prevent * the same job from being accidently started more than once.

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

Specifies the minimum confidence that Amazon Rekognition Video must have in * order to return a detected label. Confidence represents how certain Amazon * Rekognition is that a label is correctly identified.0 is the lowest confidence. * 100 is the highest confidence. Amazon Rekognition Video doesn't return any * labels with a confidence level lower than this specified value.

If you * don't specify MinConfidence, the operation returns labels and * bounding boxes (if detected) with confidence values greater than or equal to 50 * percent.

*/ inline double GetMinConfidence() const{ return m_minConfidence; } /** *

Specifies the minimum confidence that Amazon Rekognition Video must have in * order to return a detected label. Confidence represents how certain Amazon * Rekognition is that a label is correctly identified.0 is the lowest confidence. * 100 is the highest confidence. Amazon Rekognition Video doesn't return any * labels with a confidence level lower than this specified value.

If you * don't specify MinConfidence, the operation returns labels and * bounding boxes (if detected) with confidence values greater than or equal to 50 * percent.

*/ inline bool MinConfidenceHasBeenSet() const { return m_minConfidenceHasBeenSet; } /** *

Specifies the minimum confidence that Amazon Rekognition Video must have in * order to return a detected label. Confidence represents how certain Amazon * Rekognition is that a label is correctly identified.0 is the lowest confidence. * 100 is the highest confidence. Amazon Rekognition Video doesn't return any * labels with a confidence level lower than this specified value.

If you * don't specify MinConfidence, the operation returns labels and * bounding boxes (if detected) with confidence values greater than or equal to 50 * percent.

*/ inline void SetMinConfidence(double value) { m_minConfidenceHasBeenSet = true; m_minConfidence = value; } /** *

Specifies the minimum confidence that Amazon Rekognition Video must have in * order to return a detected label. Confidence represents how certain Amazon * Rekognition is that a label is correctly identified.0 is the lowest confidence. * 100 is the highest confidence. Amazon Rekognition Video doesn't return any * labels with a confidence level lower than this specified value.

If you * don't specify MinConfidence, the operation returns labels and * bounding boxes (if detected) with confidence values greater than or equal to 50 * percent.

*/ inline StartLabelDetectionRequest& WithMinConfidence(double value) { SetMinConfidence(value); return *this;} /** *

The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the * completion status of the label detection operation to. 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 Amazon SNS topic ARN you want Amazon Rekognition Video to publish the * completion status of the label detection operation to. 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 Amazon SNS topic ARN you want Amazon Rekognition Video to publish the * completion status of the label detection operation to. 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 Amazon SNS topic ARN you want Amazon Rekognition Video to publish the * completion status of the label detection operation to. 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 Amazon SNS topic ARN you want Amazon Rekognition Video to publish the * completion status of the label detection operation to. The Amazon SNS topic must * have a topic name that begins with AmazonRekognition if you are using the * AmazonRekognitionServiceRole permissions policy.

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

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

*/ inline StartLabelDetectionRequest& WithNotificationChannel(NotificationChannel&& value) { SetNotificationChannel(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 StartLabelDetectionRequest& 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 StartLabelDetectionRequest& 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 StartLabelDetectionRequest& WithJobTag(const char* value) { SetJobTag(value); return *this;} /** *

The features to return after video analysis. You can specify that * GENERAL_LABELS are returned.

*/ inline const Aws::Vector& GetFeatures() const{ return m_features; } /** *

The features to return after video analysis. You can specify that * GENERAL_LABELS are returned.

*/ inline bool FeaturesHasBeenSet() const { return m_featuresHasBeenSet; } /** *

The features to return after video analysis. You can specify that * GENERAL_LABELS are returned.

*/ inline void SetFeatures(const Aws::Vector& value) { m_featuresHasBeenSet = true; m_features = value; } /** *

The features to return after video analysis. You can specify that * GENERAL_LABELS are returned.

*/ inline void SetFeatures(Aws::Vector&& value) { m_featuresHasBeenSet = true; m_features = std::move(value); } /** *

The features to return after video analysis. You can specify that * GENERAL_LABELS are returned.

*/ inline StartLabelDetectionRequest& WithFeatures(const Aws::Vector& value) { SetFeatures(value); return *this;} /** *

The features to return after video analysis. You can specify that * GENERAL_LABELS are returned.

*/ inline StartLabelDetectionRequest& WithFeatures(Aws::Vector&& value) { SetFeatures(std::move(value)); return *this;} /** *

The features to return after video analysis. You can specify that * GENERAL_LABELS are returned.

*/ inline StartLabelDetectionRequest& AddFeatures(const LabelDetectionFeatureName& value) { m_featuresHasBeenSet = true; m_features.push_back(value); return *this; } /** *

The features to return after video analysis. You can specify that * GENERAL_LABELS are returned.

*/ inline StartLabelDetectionRequest& AddFeatures(LabelDetectionFeatureName&& value) { m_featuresHasBeenSet = true; m_features.push_back(std::move(value)); return *this; } /** *

The settings for a StartLabelDetection request.Contains the specified * parameters for the label detection request of an asynchronous label analysis * operation. Settings can include filters for GENERAL_LABELS.

*/ inline const LabelDetectionSettings& GetSettings() const{ return m_settings; } /** *

The settings for a StartLabelDetection request.Contains the specified * parameters for the label detection request of an asynchronous label analysis * operation. Settings can include filters for GENERAL_LABELS.

*/ inline bool SettingsHasBeenSet() const { return m_settingsHasBeenSet; } /** *

The settings for a StartLabelDetection request.Contains the specified * parameters for the label detection request of an asynchronous label analysis * operation. Settings can include filters for GENERAL_LABELS.

*/ inline void SetSettings(const LabelDetectionSettings& value) { m_settingsHasBeenSet = true; m_settings = value; } /** *

The settings for a StartLabelDetection request.Contains the specified * parameters for the label detection request of an asynchronous label analysis * operation. Settings can include filters for GENERAL_LABELS.

*/ inline void SetSettings(LabelDetectionSettings&& value) { m_settingsHasBeenSet = true; m_settings = std::move(value); } /** *

The settings for a StartLabelDetection request.Contains the specified * parameters for the label detection request of an asynchronous label analysis * operation. Settings can include filters for GENERAL_LABELS.

*/ inline StartLabelDetectionRequest& WithSettings(const LabelDetectionSettings& value) { SetSettings(value); return *this;} /** *

The settings for a StartLabelDetection request.Contains the specified * parameters for the label detection request of an asynchronous label analysis * operation. Settings can include filters for GENERAL_LABELS.

*/ inline StartLabelDetectionRequest& WithSettings(LabelDetectionSettings&& value) { SetSettings(std::move(value)); return *this;} private: Video m_video; bool m_videoHasBeenSet = false; Aws::String m_clientRequestToken; bool m_clientRequestTokenHasBeenSet = false; double m_minConfidence; bool m_minConfidenceHasBeenSet = false; NotificationChannel m_notificationChannel; bool m_notificationChannelHasBeenSet = false; Aws::String m_jobTag; bool m_jobTagHasBeenSet = false; Aws::Vector m_features; bool m_featuresHasBeenSet = false; LabelDetectionSettings m_settings; bool m_settingsHasBeenSet = false; }; } // namespace Model } // namespace Rekognition } // namespace Aws