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

#include <StartLabelDetectionRequest.h>

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

Public Member Functions

 StartLabelDetectionRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const VideoGetVideo () const
 
bool VideoHasBeenSet () const
 
void SetVideo (const Video &value)
 
void SetVideo (Video &&value)
 
StartLabelDetectionRequestWithVideo (const Video &value)
 
StartLabelDetectionRequestWithVideo (Video &&value)
 
const Aws::StringGetClientRequestToken () const
 
bool ClientRequestTokenHasBeenSet () const
 
void SetClientRequestToken (const Aws::String &value)
 
void SetClientRequestToken (Aws::String &&value)
 
void SetClientRequestToken (const char *value)
 
StartLabelDetectionRequestWithClientRequestToken (const Aws::String &value)
 
StartLabelDetectionRequestWithClientRequestToken (Aws::String &&value)
 
StartLabelDetectionRequestWithClientRequestToken (const char *value)
 
double GetMinConfidence () const
 
bool MinConfidenceHasBeenSet () const
 
void SetMinConfidence (double value)
 
StartLabelDetectionRequestWithMinConfidence (double value)
 
const NotificationChannelGetNotificationChannel () const
 
bool NotificationChannelHasBeenSet () const
 
void SetNotificationChannel (const NotificationChannel &value)
 
void SetNotificationChannel (NotificationChannel &&value)
 
StartLabelDetectionRequestWithNotificationChannel (const NotificationChannel &value)
 
StartLabelDetectionRequestWithNotificationChannel (NotificationChannel &&value)
 
const Aws::StringGetJobTag () const
 
bool JobTagHasBeenSet () const
 
void SetJobTag (const Aws::String &value)
 
void SetJobTag (Aws::String &&value)
 
void SetJobTag (const char *value)
 
StartLabelDetectionRequestWithJobTag (const Aws::String &value)
 
StartLabelDetectionRequestWithJobTag (Aws::String &&value)
 
StartLabelDetectionRequestWithJobTag (const char *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 StartLabelDetectionRequest.h.

Constructor & Destructor Documentation

◆ StartLabelDetectionRequest()

Aws::Rekognition::Model::StartLabelDetectionRequest::StartLabelDetectionRequest ( )

Member Function Documentation

◆ ClientRequestTokenHasBeenSet()

bool Aws::Rekognition::Model::StartLabelDetectionRequest::ClientRequestTokenHasBeenSet ( ) const
inline

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.

Definition at line 90 of file StartLabelDetectionRequest.h.

◆ GetClientRequestToken()

const Aws::String& Aws::Rekognition::Model::StartLabelDetectionRequest::GetClientRequestToken ( ) const
inline

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.

Definition at line 82 of file StartLabelDetectionRequest.h.

◆ GetJobTag()

const Aws::String& Aws::Rekognition::Model::StartLabelDetectionRequest::GetJobTag ( ) const
inline

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.

Definition at line 241 of file StartLabelDetectionRequest.h.

◆ GetMinConfidence()

double Aws::Rekognition::Model::StartLabelDetectionRequest::GetMinConfidence ( ) const
inline

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 with confidence values greater than or equal to 50 percent.

Definition at line 150 of file StartLabelDetectionRequest.h.

◆ GetNotificationChannel()

const NotificationChannel& Aws::Rekognition::Model::StartLabelDetectionRequest::GetNotificationChannel ( ) const
inline

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.

Definition at line 192 of file StartLabelDetectionRequest.h.

◆ GetRequestSpecificHeaders()

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

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file StartLabelDetectionRequest.h.

◆ GetVideo()

const Video& Aws::Rekognition::Model::StartLabelDetectionRequest::GetVideo ( ) const
inline

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

Definition at line 43 of file StartLabelDetectionRequest.h.

◆ JobTagHasBeenSet()

bool Aws::Rekognition::Model::StartLabelDetectionRequest::JobTagHasBeenSet ( ) const
inline

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.

Definition at line 249 of file StartLabelDetectionRequest.h.

◆ MinConfidenceHasBeenSet()

bool Aws::Rekognition::Model::StartLabelDetectionRequest::MinConfidenceHasBeenSet ( ) const
inline

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 with confidence values greater than or equal to 50 percent.

Definition at line 161 of file StartLabelDetectionRequest.h.

◆ NotificationChannelHasBeenSet()

bool Aws::Rekognition::Model::StartLabelDetectionRequest::NotificationChannelHasBeenSet ( ) const
inline

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.

Definition at line 200 of file StartLabelDetectionRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetClientRequestToken() [1/3]

void Aws::Rekognition::Model::StartLabelDetectionRequest::SetClientRequestToken ( Aws::String &&  value)
inline

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.

Definition at line 106 of file StartLabelDetectionRequest.h.

◆ SetClientRequestToken() [2/3]

void Aws::Rekognition::Model::StartLabelDetectionRequest::SetClientRequestToken ( const Aws::String value)
inline

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.

Definition at line 98 of file StartLabelDetectionRequest.h.

◆ SetClientRequestToken() [3/3]

void Aws::Rekognition::Model::StartLabelDetectionRequest::SetClientRequestToken ( const char *  value)
inline

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.

Definition at line 114 of file StartLabelDetectionRequest.h.

◆ SetJobTag() [1/3]

void Aws::Rekognition::Model::StartLabelDetectionRequest::SetJobTag ( Aws::String &&  value)
inline

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.

Definition at line 265 of file StartLabelDetectionRequest.h.

◆ SetJobTag() [2/3]

void Aws::Rekognition::Model::StartLabelDetectionRequest::SetJobTag ( const Aws::String value)
inline

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.

Definition at line 257 of file StartLabelDetectionRequest.h.

◆ SetJobTag() [3/3]

void Aws::Rekognition::Model::StartLabelDetectionRequest::SetJobTag ( const char *  value)
inline

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.

Definition at line 273 of file StartLabelDetectionRequest.h.

◆ SetMinConfidence()

void Aws::Rekognition::Model::StartLabelDetectionRequest::SetMinConfidence ( double  value)
inline

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 with confidence values greater than or equal to 50 percent.

Definition at line 172 of file StartLabelDetectionRequest.h.

◆ SetNotificationChannel() [1/2]

void Aws::Rekognition::Model::StartLabelDetectionRequest::SetNotificationChannel ( const NotificationChannel value)
inline

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.

Definition at line 208 of file StartLabelDetectionRequest.h.

◆ SetNotificationChannel() [2/2]

void Aws::Rekognition::Model::StartLabelDetectionRequest::SetNotificationChannel ( NotificationChannel &&  value)
inline

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.

Definition at line 216 of file StartLabelDetectionRequest.h.

◆ SetVideo() [1/2]

void Aws::Rekognition::Model::StartLabelDetectionRequest::SetVideo ( const Video value)
inline

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

Definition at line 55 of file StartLabelDetectionRequest.h.

◆ SetVideo() [2/2]

void Aws::Rekognition::Model::StartLabelDetectionRequest::SetVideo ( Video &&  value)
inline

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

Definition at line 61 of file StartLabelDetectionRequest.h.

◆ VideoHasBeenSet()

bool Aws::Rekognition::Model::StartLabelDetectionRequest::VideoHasBeenSet ( ) const
inline

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

Definition at line 49 of file StartLabelDetectionRequest.h.

◆ WithClientRequestToken() [1/3]

StartLabelDetectionRequest& Aws::Rekognition::Model::StartLabelDetectionRequest::WithClientRequestToken ( Aws::String &&  value)
inline

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.

Definition at line 130 of file StartLabelDetectionRequest.h.

◆ WithClientRequestToken() [2/3]

StartLabelDetectionRequest& Aws::Rekognition::Model::StartLabelDetectionRequest::WithClientRequestToken ( const Aws::String value)
inline

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.

Definition at line 122 of file StartLabelDetectionRequest.h.

◆ WithClientRequestToken() [3/3]

StartLabelDetectionRequest& Aws::Rekognition::Model::StartLabelDetectionRequest::WithClientRequestToken ( const char *  value)
inline

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.

Definition at line 138 of file StartLabelDetectionRequest.h.

◆ WithJobTag() [1/3]

StartLabelDetectionRequest& Aws::Rekognition::Model::StartLabelDetectionRequest::WithJobTag ( Aws::String &&  value)
inline

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.

Definition at line 289 of file StartLabelDetectionRequest.h.

◆ WithJobTag() [2/3]

StartLabelDetectionRequest& Aws::Rekognition::Model::StartLabelDetectionRequest::WithJobTag ( const Aws::String value)
inline

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.

Definition at line 281 of file StartLabelDetectionRequest.h.

◆ WithJobTag() [3/3]

StartLabelDetectionRequest& Aws::Rekognition::Model::StartLabelDetectionRequest::WithJobTag ( const char *  value)
inline

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.

Definition at line 297 of file StartLabelDetectionRequest.h.

◆ WithMinConfidence()

StartLabelDetectionRequest& Aws::Rekognition::Model::StartLabelDetectionRequest::WithMinConfidence ( double  value)
inline

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 with confidence values greater than or equal to 50 percent.

Definition at line 183 of file StartLabelDetectionRequest.h.

◆ WithNotificationChannel() [1/2]

StartLabelDetectionRequest& Aws::Rekognition::Model::StartLabelDetectionRequest::WithNotificationChannel ( const NotificationChannel value)
inline

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.

Definition at line 224 of file StartLabelDetectionRequest.h.

◆ WithNotificationChannel() [2/2]

StartLabelDetectionRequest& Aws::Rekognition::Model::StartLabelDetectionRequest::WithNotificationChannel ( NotificationChannel &&  value)
inline

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.

Definition at line 232 of file StartLabelDetectionRequest.h.

◆ WithVideo() [1/2]

StartLabelDetectionRequest& Aws::Rekognition::Model::StartLabelDetectionRequest::WithVideo ( const Video value)
inline

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

Definition at line 67 of file StartLabelDetectionRequest.h.

◆ WithVideo() [2/2]

StartLabelDetectionRequest& Aws::Rekognition::Model::StartLabelDetectionRequest::WithVideo ( Video &&  value)
inline

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

Definition at line 73 of file StartLabelDetectionRequest.h.


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