AWS SDK for C++  1.9.131
AWS SDK for C++
Public Member Functions | List of all members
Aws::TranscribeService::Model::JobExecutionSettings Class Reference

#include <JobExecutionSettings.h>

Public Member Functions

 JobExecutionSettings ()
 
 JobExecutionSettings (Aws::Utils::Json::JsonView jsonValue)
 
JobExecutionSettingsoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
bool GetAllowDeferredExecution () const
 
bool AllowDeferredExecutionHasBeenSet () const
 
void SetAllowDeferredExecution (bool value)
 
JobExecutionSettingsWithAllowDeferredExecution (bool value)
 
const Aws::StringGetDataAccessRoleArn () const
 
bool DataAccessRoleArnHasBeenSet () const
 
void SetDataAccessRoleArn (const Aws::String &value)
 
void SetDataAccessRoleArn (Aws::String &&value)
 
void SetDataAccessRoleArn (const char *value)
 
JobExecutionSettingsWithDataAccessRoleArn (const Aws::String &value)
 
JobExecutionSettingsWithDataAccessRoleArn (Aws::String &&value)
 
JobExecutionSettingsWithDataAccessRoleArn (const char *value)
 

Detailed Description

Provides information about when a transcription job should be executed.

See Also:

AWS API Reference

Definition at line 32 of file JobExecutionSettings.h.

Constructor & Destructor Documentation

◆ JobExecutionSettings() [1/2]

Aws::TranscribeService::Model::JobExecutionSettings::JobExecutionSettings ( )

◆ JobExecutionSettings() [2/2]

Aws::TranscribeService::Model::JobExecutionSettings::JobExecutionSettings ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AllowDeferredExecutionHasBeenSet()

bool Aws::TranscribeService::Model::JobExecutionSettings::AllowDeferredExecutionHasBeenSet ( ) const
inline

Indicates whether a job should be queued by Amazon Transcribe when the concurrent execution limit is exceeded. When the AllowDeferredExecution field is true, jobs are queued and executed when the number of executing jobs falls below the concurrent execution limit. If the field is false, Amazon Transcribe returns a LimitExceededException exception.

Note that job queuing is enabled by default for call analytics jobs.

If you specify the AllowDeferredExecution field, you must specify the DataAccessRoleArn field.

Definition at line 65 of file JobExecutionSettings.h.

◆ DataAccessRoleArnHasBeenSet()

bool Aws::TranscribeService::Model::JobExecutionSettings::DataAccessRoleArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of a role that has access to the S3 bucket that contains the input files. Amazon Transcribe assumes this role to read queued media files. If you have specified an output S3 bucket for the transcription results, this role should have access to the output bucket as well.

If you specify the AllowDeferredExecution field, you must specify the DataAccessRoleArn field.

Definition at line 112 of file JobExecutionSettings.h.

◆ GetAllowDeferredExecution()

bool Aws::TranscribeService::Model::JobExecutionSettings::GetAllowDeferredExecution ( ) const
inline

Indicates whether a job should be queued by Amazon Transcribe when the concurrent execution limit is exceeded. When the AllowDeferredExecution field is true, jobs are queued and executed when the number of executing jobs falls below the concurrent execution limit. If the field is false, Amazon Transcribe returns a LimitExceededException exception.

Note that job queuing is enabled by default for call analytics jobs.

If you specify the AllowDeferredExecution field, you must specify the DataAccessRoleArn field.

Definition at line 52 of file JobExecutionSettings.h.

◆ GetDataAccessRoleArn()

const Aws::String& Aws::TranscribeService::Model::JobExecutionSettings::GetDataAccessRoleArn ( ) const
inline

The Amazon Resource Name (ARN) of a role that has access to the S3 bucket that contains the input files. Amazon Transcribe assumes this role to read queued media files. If you have specified an output S3 bucket for the transcription results, this role should have access to the output bucket as well.

If you specify the AllowDeferredExecution field, you must specify the DataAccessRoleArn field.

Definition at line 102 of file JobExecutionSettings.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::TranscribeService::Model::JobExecutionSettings::Jsonize ( ) const

◆ operator=()

JobExecutionSettings& Aws::TranscribeService::Model::JobExecutionSettings::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetAllowDeferredExecution()

void Aws::TranscribeService::Model::JobExecutionSettings::SetAllowDeferredExecution ( bool  value)
inline

Indicates whether a job should be queued by Amazon Transcribe when the concurrent execution limit is exceeded. When the AllowDeferredExecution field is true, jobs are queued and executed when the number of executing jobs falls below the concurrent execution limit. If the field is false, Amazon Transcribe returns a LimitExceededException exception.

Note that job queuing is enabled by default for call analytics jobs.

If you specify the AllowDeferredExecution field, you must specify the DataAccessRoleArn field.

Definition at line 78 of file JobExecutionSettings.h.

◆ SetDataAccessRoleArn() [1/3]

void Aws::TranscribeService::Model::JobExecutionSettings::SetDataAccessRoleArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of a role that has access to the S3 bucket that contains the input files. Amazon Transcribe assumes this role to read queued media files. If you have specified an output S3 bucket for the transcription results, this role should have access to the output bucket as well.

If you specify the AllowDeferredExecution field, you must specify the DataAccessRoleArn field.

Definition at line 132 of file JobExecutionSettings.h.

◆ SetDataAccessRoleArn() [2/3]

void Aws::TranscribeService::Model::JobExecutionSettings::SetDataAccessRoleArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of a role that has access to the S3 bucket that contains the input files. Amazon Transcribe assumes this role to read queued media files. If you have specified an output S3 bucket for the transcription results, this role should have access to the output bucket as well.

If you specify the AllowDeferredExecution field, you must specify the DataAccessRoleArn field.

Definition at line 122 of file JobExecutionSettings.h.

◆ SetDataAccessRoleArn() [3/3]

void Aws::TranscribeService::Model::JobExecutionSettings::SetDataAccessRoleArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of a role that has access to the S3 bucket that contains the input files. Amazon Transcribe assumes this role to read queued media files. If you have specified an output S3 bucket for the transcription results, this role should have access to the output bucket as well.

If you specify the AllowDeferredExecution field, you must specify the DataAccessRoleArn field.

Definition at line 142 of file JobExecutionSettings.h.

◆ WithAllowDeferredExecution()

JobExecutionSettings& Aws::TranscribeService::Model::JobExecutionSettings::WithAllowDeferredExecution ( bool  value)
inline

Indicates whether a job should be queued by Amazon Transcribe when the concurrent execution limit is exceeded. When the AllowDeferredExecution field is true, jobs are queued and executed when the number of executing jobs falls below the concurrent execution limit. If the field is false, Amazon Transcribe returns a LimitExceededException exception.

Note that job queuing is enabled by default for call analytics jobs.

If you specify the AllowDeferredExecution field, you must specify the DataAccessRoleArn field.

Definition at line 91 of file JobExecutionSettings.h.

◆ WithDataAccessRoleArn() [1/3]

JobExecutionSettings& Aws::TranscribeService::Model::JobExecutionSettings::WithDataAccessRoleArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of a role that has access to the S3 bucket that contains the input files. Amazon Transcribe assumes this role to read queued media files. If you have specified an output S3 bucket for the transcription results, this role should have access to the output bucket as well.

If you specify the AllowDeferredExecution field, you must specify the DataAccessRoleArn field.

Definition at line 162 of file JobExecutionSettings.h.

◆ WithDataAccessRoleArn() [2/3]

JobExecutionSettings& Aws::TranscribeService::Model::JobExecutionSettings::WithDataAccessRoleArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of a role that has access to the S3 bucket that contains the input files. Amazon Transcribe assumes this role to read queued media files. If you have specified an output S3 bucket for the transcription results, this role should have access to the output bucket as well.

If you specify the AllowDeferredExecution field, you must specify the DataAccessRoleArn field.

Definition at line 152 of file JobExecutionSettings.h.

◆ WithDataAccessRoleArn() [3/3]

JobExecutionSettings& Aws::TranscribeService::Model::JobExecutionSettings::WithDataAccessRoleArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of a role that has access to the S3 bucket that contains the input files. Amazon Transcribe assumes this role to read queued media files. If you have specified an output S3 bucket for the transcription results, this role should have access to the output bucket as well.

If you specify the AllowDeferredExecution field, you must specify the DataAccessRoleArn field.

Definition at line 172 of file JobExecutionSettings.h.


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