/** * 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 StartSegmentDetectionRequest : public RekognitionRequest { public: AWS_REKOGNITION_API StartSegmentDetectionRequest(); // 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 "StartSegmentDetection"; } AWS_REKOGNITION_API Aws::String SerializePayload() const override; AWS_REKOGNITION_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; inline const Video& GetVideo() const{ return m_video; } inline bool VideoHasBeenSet() const { return m_videoHasBeenSet; } inline void SetVideo(const Video& value) { m_videoHasBeenSet = true; m_video = value; } inline void SetVideo(Video&& value) { m_videoHasBeenSet = true; m_video = std::move(value); } inline StartSegmentDetectionRequest& WithVideo(const Video& value) { SetVideo(value); return *this;} inline StartSegmentDetectionRequest& 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 StartSegmentDetection 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 StartSegmentDetection 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 StartSegmentDetection 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 StartSegmentDetection 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 StartSegmentDetection 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 StartSegmentDetection requests, the same * JobId is returned. Use ClientRequestToken to prevent * the same job from being accidently started more than once.

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

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

*/ inline StartSegmentDetectionRequest& 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 segment detection operation. Note that the * Amazon SNS topic must have a topic name that begins with * AmazonRekognition if you are using the AmazonRekognitionServiceRole * permissions policy to access the topic.

*/ 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 segment detection operation. Note that the * Amazon SNS topic must have a topic name that begins with * AmazonRekognition if you are using the AmazonRekognitionServiceRole * permissions policy to access the topic.

*/ 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 segment detection operation. Note that the * Amazon SNS topic must have a topic name that begins with * AmazonRekognition if you are using the AmazonRekognitionServiceRole * permissions policy to access the topic.

*/ 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 segment detection operation. Note that the * Amazon SNS topic must have a topic name that begins with * AmazonRekognition if you are using the AmazonRekognitionServiceRole * permissions policy to access the topic.

*/ 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 segment detection operation. Note that the * Amazon SNS topic must have a topic name that begins with * AmazonRekognition if you are using the AmazonRekognitionServiceRole * permissions policy to access the topic.

*/ inline StartSegmentDetectionRequest& 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 segment detection operation. Note that the * Amazon SNS topic must have a topic name that begins with * AmazonRekognition if you are using the AmazonRekognitionServiceRole * permissions policy to access the topic.

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

Filters for technical cue or shot detection.

*/ inline const StartSegmentDetectionFilters& GetFilters() const{ return m_filters; } /** *

Filters for technical cue or shot detection.

*/ inline bool FiltersHasBeenSet() const { return m_filtersHasBeenSet; } /** *

Filters for technical cue or shot detection.

*/ inline void SetFilters(const StartSegmentDetectionFilters& value) { m_filtersHasBeenSet = true; m_filters = value; } /** *

Filters for technical cue or shot detection.

*/ inline void SetFilters(StartSegmentDetectionFilters&& value) { m_filtersHasBeenSet = true; m_filters = std::move(value); } /** *

Filters for technical cue or shot detection.

*/ inline StartSegmentDetectionRequest& WithFilters(const StartSegmentDetectionFilters& value) { SetFilters(value); return *this;} /** *

Filters for technical cue or shot detection.

*/ inline StartSegmentDetectionRequest& WithFilters(StartSegmentDetectionFilters&& value) { SetFilters(std::move(value)); return *this;} /** *

An array of segment types to detect in the video. Valid values are * TECHNICAL_CUE and SHOT.

*/ inline const Aws::Vector& GetSegmentTypes() const{ return m_segmentTypes; } /** *

An array of segment types to detect in the video. Valid values are * TECHNICAL_CUE and SHOT.

*/ inline bool SegmentTypesHasBeenSet() const { return m_segmentTypesHasBeenSet; } /** *

An array of segment types to detect in the video. Valid values are * TECHNICAL_CUE and SHOT.

*/ inline void SetSegmentTypes(const Aws::Vector& value) { m_segmentTypesHasBeenSet = true; m_segmentTypes = value; } /** *

An array of segment types to detect in the video. Valid values are * TECHNICAL_CUE and SHOT.

*/ inline void SetSegmentTypes(Aws::Vector&& value) { m_segmentTypesHasBeenSet = true; m_segmentTypes = std::move(value); } /** *

An array of segment types to detect in the video. Valid values are * TECHNICAL_CUE and SHOT.

*/ inline StartSegmentDetectionRequest& WithSegmentTypes(const Aws::Vector& value) { SetSegmentTypes(value); return *this;} /** *

An array of segment types to detect in the video. Valid values are * TECHNICAL_CUE and SHOT.

*/ inline StartSegmentDetectionRequest& WithSegmentTypes(Aws::Vector&& value) { SetSegmentTypes(std::move(value)); return *this;} /** *

An array of segment types to detect in the video. Valid values are * TECHNICAL_CUE and SHOT.

*/ inline StartSegmentDetectionRequest& AddSegmentTypes(const SegmentType& value) { m_segmentTypesHasBeenSet = true; m_segmentTypes.push_back(value); return *this; } /** *

An array of segment types to detect in the video. Valid values are * TECHNICAL_CUE and SHOT.

*/ inline StartSegmentDetectionRequest& AddSegmentTypes(SegmentType&& value) { m_segmentTypesHasBeenSet = true; m_segmentTypes.push_back(std::move(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; Aws::String m_jobTag; bool m_jobTagHasBeenSet = false; StartSegmentDetectionFilters m_filters; bool m_filtersHasBeenSet = false; Aws::Vector m_segmentTypes; bool m_segmentTypesHasBeenSet = false; }; } // namespace Model } // namespace Rekognition } // namespace Aws