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

#include <StartTranscriptionJobRequest.h>

+ Inheritance diagram for Aws::TranscribeService::Model::StartTranscriptionJobRequest:

Public Member Functions

 StartTranscriptionJobRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetTranscriptionJobName () const
 
bool TranscriptionJobNameHasBeenSet () const
 
void SetTranscriptionJobName (const Aws::String &value)
 
void SetTranscriptionJobName (Aws::String &&value)
 
void SetTranscriptionJobName (const char *value)
 
StartTranscriptionJobRequestWithTranscriptionJobName (const Aws::String &value)
 
StartTranscriptionJobRequestWithTranscriptionJobName (Aws::String &&value)
 
StartTranscriptionJobRequestWithTranscriptionJobName (const char *value)
 
const LanguageCodeGetLanguageCode () const
 
bool LanguageCodeHasBeenSet () const
 
void SetLanguageCode (const LanguageCode &value)
 
void SetLanguageCode (LanguageCode &&value)
 
StartTranscriptionJobRequestWithLanguageCode (const LanguageCode &value)
 
StartTranscriptionJobRequestWithLanguageCode (LanguageCode &&value)
 
int GetMediaSampleRateHertz () const
 
bool MediaSampleRateHertzHasBeenSet () const
 
void SetMediaSampleRateHertz (int value)
 
StartTranscriptionJobRequestWithMediaSampleRateHertz (int value)
 
const MediaFormatGetMediaFormat () const
 
bool MediaFormatHasBeenSet () const
 
void SetMediaFormat (const MediaFormat &value)
 
void SetMediaFormat (MediaFormat &&value)
 
StartTranscriptionJobRequestWithMediaFormat (const MediaFormat &value)
 
StartTranscriptionJobRequestWithMediaFormat (MediaFormat &&value)
 
const MediaGetMedia () const
 
bool MediaHasBeenSet () const
 
void SetMedia (const Media &value)
 
void SetMedia (Media &&value)
 
StartTranscriptionJobRequestWithMedia (const Media &value)
 
StartTranscriptionJobRequestWithMedia (Media &&value)
 
const Aws::StringGetOutputBucketName () const
 
bool OutputBucketNameHasBeenSet () const
 
void SetOutputBucketName (const Aws::String &value)
 
void SetOutputBucketName (Aws::String &&value)
 
void SetOutputBucketName (const char *value)
 
StartTranscriptionJobRequestWithOutputBucketName (const Aws::String &value)
 
StartTranscriptionJobRequestWithOutputBucketName (Aws::String &&value)
 
StartTranscriptionJobRequestWithOutputBucketName (const char *value)
 
const Aws::StringGetOutputKey () const
 
bool OutputKeyHasBeenSet () const
 
void SetOutputKey (const Aws::String &value)
 
void SetOutputKey (Aws::String &&value)
 
void SetOutputKey (const char *value)
 
StartTranscriptionJobRequestWithOutputKey (const Aws::String &value)
 
StartTranscriptionJobRequestWithOutputKey (Aws::String &&value)
 
StartTranscriptionJobRequestWithOutputKey (const char *value)
 
const Aws::StringGetOutputEncryptionKMSKeyId () const
 
bool OutputEncryptionKMSKeyIdHasBeenSet () const
 
void SetOutputEncryptionKMSKeyId (const Aws::String &value)
 
void SetOutputEncryptionKMSKeyId (Aws::String &&value)
 
void SetOutputEncryptionKMSKeyId (const char *value)
 
StartTranscriptionJobRequestWithOutputEncryptionKMSKeyId (const Aws::String &value)
 
StartTranscriptionJobRequestWithOutputEncryptionKMSKeyId (Aws::String &&value)
 
StartTranscriptionJobRequestWithOutputEncryptionKMSKeyId (const char *value)
 
const Aws::Map< Aws::String, Aws::String > & GetKMSEncryptionContext () const
 
bool KMSEncryptionContextHasBeenSet () const
 
void SetKMSEncryptionContext (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetKMSEncryptionContext (Aws::Map< Aws::String, Aws::String > &&value)
 
StartTranscriptionJobRequestWithKMSEncryptionContext (const Aws::Map< Aws::String, Aws::String > &value)
 
StartTranscriptionJobRequestWithKMSEncryptionContext (Aws::Map< Aws::String, Aws::String > &&value)
 
StartTranscriptionJobRequestAddKMSEncryptionContext (const Aws::String &key, const Aws::String &value)
 
StartTranscriptionJobRequestAddKMSEncryptionContext (Aws::String &&key, const Aws::String &value)
 
StartTranscriptionJobRequestAddKMSEncryptionContext (const Aws::String &key, Aws::String &&value)
 
StartTranscriptionJobRequestAddKMSEncryptionContext (Aws::String &&key, Aws::String &&value)
 
StartTranscriptionJobRequestAddKMSEncryptionContext (const char *key, Aws::String &&value)
 
StartTranscriptionJobRequestAddKMSEncryptionContext (Aws::String &&key, const char *value)
 
StartTranscriptionJobRequestAddKMSEncryptionContext (const char *key, const char *value)
 
const SettingsGetSettings () const
 
bool SettingsHasBeenSet () const
 
void SetSettings (const Settings &value)
 
void SetSettings (Settings &&value)
 
StartTranscriptionJobRequestWithSettings (const Settings &value)
 
StartTranscriptionJobRequestWithSettings (Settings &&value)
 
const ModelSettingsGetModelSettings () const
 
bool ModelSettingsHasBeenSet () const
 
void SetModelSettings (const ModelSettings &value)
 
void SetModelSettings (ModelSettings &&value)
 
StartTranscriptionJobRequestWithModelSettings (const ModelSettings &value)
 
StartTranscriptionJobRequestWithModelSettings (ModelSettings &&value)
 
const JobExecutionSettingsGetJobExecutionSettings () const
 
bool JobExecutionSettingsHasBeenSet () const
 
void SetJobExecutionSettings (const JobExecutionSettings &value)
 
void SetJobExecutionSettings (JobExecutionSettings &&value)
 
StartTranscriptionJobRequestWithJobExecutionSettings (const JobExecutionSettings &value)
 
StartTranscriptionJobRequestWithJobExecutionSettings (JobExecutionSettings &&value)
 
const ContentRedactionGetContentRedaction () const
 
bool ContentRedactionHasBeenSet () const
 
void SetContentRedaction (const ContentRedaction &value)
 
void SetContentRedaction (ContentRedaction &&value)
 
StartTranscriptionJobRequestWithContentRedaction (const ContentRedaction &value)
 
StartTranscriptionJobRequestWithContentRedaction (ContentRedaction &&value)
 
bool GetIdentifyLanguage () const
 
bool IdentifyLanguageHasBeenSet () const
 
void SetIdentifyLanguage (bool value)
 
StartTranscriptionJobRequestWithIdentifyLanguage (bool value)
 
const Aws::Vector< LanguageCode > & GetLanguageOptions () const
 
bool LanguageOptionsHasBeenSet () const
 
void SetLanguageOptions (const Aws::Vector< LanguageCode > &value)
 
void SetLanguageOptions (Aws::Vector< LanguageCode > &&value)
 
StartTranscriptionJobRequestWithLanguageOptions (const Aws::Vector< LanguageCode > &value)
 
StartTranscriptionJobRequestWithLanguageOptions (Aws::Vector< LanguageCode > &&value)
 
StartTranscriptionJobRequestAddLanguageOptions (const LanguageCode &value)
 
StartTranscriptionJobRequestAddLanguageOptions (LanguageCode &&value)
 
const SubtitlesGetSubtitles () const
 
bool SubtitlesHasBeenSet () const
 
void SetSubtitles (const Subtitles &value)
 
void SetSubtitles (Subtitles &&value)
 
StartTranscriptionJobRequestWithSubtitles (const Subtitles &value)
 
StartTranscriptionJobRequestWithSubtitles (Subtitles &&value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
StartTranscriptionJobRequestWithTags (const Aws::Vector< Tag > &value)
 
StartTranscriptionJobRequestWithTags (Aws::Vector< Tag > &&value)
 
StartTranscriptionJobRequestAddTags (const Tag &value)
 
StartTranscriptionJobRequestAddTags (Tag &&value)
 
const Aws::Map< LanguageCode, LanguageIdSettings > & GetLanguageIdSettings () const
 
bool LanguageIdSettingsHasBeenSet () const
 
void SetLanguageIdSettings (const Aws::Map< LanguageCode, LanguageIdSettings > &value)
 
void SetLanguageIdSettings (Aws::Map< LanguageCode, LanguageIdSettings > &&value)
 
StartTranscriptionJobRequestWithLanguageIdSettings (const Aws::Map< LanguageCode, LanguageIdSettings > &value)
 
StartTranscriptionJobRequestWithLanguageIdSettings (Aws::Map< LanguageCode, LanguageIdSettings > &&value)
 
StartTranscriptionJobRequestAddLanguageIdSettings (const LanguageCode &key, const LanguageIdSettings &value)
 
StartTranscriptionJobRequestAddLanguageIdSettings (LanguageCode &&key, const LanguageIdSettings &value)
 
StartTranscriptionJobRequestAddLanguageIdSettings (const LanguageCode &key, LanguageIdSettings &&value)
 
StartTranscriptionJobRequestAddLanguageIdSettings (LanguageCode &&key, LanguageIdSettings &&value)
 
- Public Member Functions inherited from Aws::TranscribeService::TranscribeServiceRequest
virtual ~TranscribeServiceRequest ()
 
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 33 of file StartTranscriptionJobRequest.h.

Constructor & Destructor Documentation

◆ StartTranscriptionJobRequest()

Aws::TranscribeService::Model::StartTranscriptionJobRequest::StartTranscriptionJobRequest ( )

Member Function Documentation

◆ AddKMSEncryptionContext() [1/7]

StartTranscriptionJobRequest& Aws::TranscribeService::Model::StartTranscriptionJobRequest::AddKMSEncryptionContext ( Aws::String &&  key,
Aws::String &&  value 
)
inline

A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data.

Definition at line 809 of file StartTranscriptionJobRequest.h.

◆ AddKMSEncryptionContext() [2/7]

StartTranscriptionJobRequest& Aws::TranscribeService::Model::StartTranscriptionJobRequest::AddKMSEncryptionContext ( Aws::String &&  key,
const Aws::String value 
)
inline

A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data.

Definition at line 797 of file StartTranscriptionJobRequest.h.

◆ AddKMSEncryptionContext() [3/7]

StartTranscriptionJobRequest& Aws::TranscribeService::Model::StartTranscriptionJobRequest::AddKMSEncryptionContext ( Aws::String &&  key,
const char *  value 
)
inline

A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data.

Definition at line 821 of file StartTranscriptionJobRequest.h.

◆ AddKMSEncryptionContext() [4/7]

StartTranscriptionJobRequest& Aws::TranscribeService::Model::StartTranscriptionJobRequest::AddKMSEncryptionContext ( const Aws::String key,
Aws::String &&  value 
)
inline

A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data.

Definition at line 803 of file StartTranscriptionJobRequest.h.

◆ AddKMSEncryptionContext() [5/7]

StartTranscriptionJobRequest& Aws::TranscribeService::Model::StartTranscriptionJobRequest::AddKMSEncryptionContext ( const Aws::String key,
const Aws::String value 
)
inline

A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data.

Definition at line 791 of file StartTranscriptionJobRequest.h.

◆ AddKMSEncryptionContext() [6/7]

StartTranscriptionJobRequest& Aws::TranscribeService::Model::StartTranscriptionJobRequest::AddKMSEncryptionContext ( const char *  key,
Aws::String &&  value 
)
inline

A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data.

Definition at line 815 of file StartTranscriptionJobRequest.h.

◆ AddKMSEncryptionContext() [7/7]

StartTranscriptionJobRequest& Aws::TranscribeService::Model::StartTranscriptionJobRequest::AddKMSEncryptionContext ( const char *  key,
const char *  value 
)
inline

A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data.

Definition at line 827 of file StartTranscriptionJobRequest.h.

◆ AddLanguageIdSettings() [1/4]

StartTranscriptionJobRequest& Aws::TranscribeService::Model::StartTranscriptionJobRequest::AddLanguageIdSettings ( const LanguageCode key,
const LanguageIdSettings value 
)
inline

The language identification settings associated with your transcription job. These settings include VocabularyName, VocabularyFilterName, and LanguageModelName.

Definition at line 1209 of file StartTranscriptionJobRequest.h.

◆ AddLanguageIdSettings() [2/4]

StartTranscriptionJobRequest& Aws::TranscribeService::Model::StartTranscriptionJobRequest::AddLanguageIdSettings ( const LanguageCode key,
LanguageIdSettings &&  value 
)
inline

The language identification settings associated with your transcription job. These settings include VocabularyName, VocabularyFilterName, and LanguageModelName.

Definition at line 1223 of file StartTranscriptionJobRequest.h.

◆ AddLanguageIdSettings() [3/4]

StartTranscriptionJobRequest& Aws::TranscribeService::Model::StartTranscriptionJobRequest::AddLanguageIdSettings ( LanguageCode &&  key,
const LanguageIdSettings value 
)
inline

The language identification settings associated with your transcription job. These settings include VocabularyName, VocabularyFilterName, and LanguageModelName.

Definition at line 1216 of file StartTranscriptionJobRequest.h.

◆ AddLanguageIdSettings() [4/4]

StartTranscriptionJobRequest& Aws::TranscribeService::Model::StartTranscriptionJobRequest::AddLanguageIdSettings ( LanguageCode &&  key,
LanguageIdSettings &&  value 
)
inline

The language identification settings associated with your transcription job. These settings include VocabularyName, VocabularyFilterName, and LanguageModelName.

Definition at line 1230 of file StartTranscriptionJobRequest.h.

◆ AddLanguageOptions() [1/2]

StartTranscriptionJobRequest& Aws::TranscribeService::Model::StartTranscriptionJobRequest::AddLanguageOptions ( const LanguageCode value)
inline

An object containing a list of languages that might be present in your collection of audio files. Automatic language identification chooses a language that best matches the source audio from that list.

To transcribe speech in Modern Standard Arabic (ar-SA), your audio or video file must be encoded at a sample rate of 16,000 Hz or higher.

Definition at line 1078 of file StartTranscriptionJobRequest.h.

◆ AddLanguageOptions() [2/2]

StartTranscriptionJobRequest& Aws::TranscribeService::Model::StartTranscriptionJobRequest::AddLanguageOptions ( LanguageCode &&  value)
inline

An object containing a list of languages that might be present in your collection of audio files. Automatic language identification chooses a language that best matches the source audio from that list.

To transcribe speech in Modern Standard Arabic (ar-SA), your audio or video file must be encoded at a sample rate of 16,000 Hz or higher.

Definition at line 1087 of file StartTranscriptionJobRequest.h.

◆ AddTags() [1/2]

StartTranscriptionJobRequest& Aws::TranscribeService::Model::StartTranscriptionJobRequest::AddTags ( const Tag value)
inline

Add tags to an Amazon Transcribe transcription job.

Definition at line 1154 of file StartTranscriptionJobRequest.h.

◆ AddTags() [2/2]

StartTranscriptionJobRequest& Aws::TranscribeService::Model::StartTranscriptionJobRequest::AddTags ( Tag &&  value)
inline

Add tags to an Amazon Transcribe transcription job.

Definition at line 1159 of file StartTranscriptionJobRequest.h.

◆ ContentRedactionHasBeenSet()

bool Aws::TranscribeService::Model::StartTranscriptionJobRequest::ContentRedactionHasBeenSet ( ) const
inline

An object that contains the request parameters for content redaction.

Definition at line 961 of file StartTranscriptionJobRequest.h.

◆ GetContentRedaction()

const ContentRedaction& Aws::TranscribeService::Model::StartTranscriptionJobRequest::GetContentRedaction ( ) const
inline

An object that contains the request parameters for content redaction.

Definition at line 956 of file StartTranscriptionJobRequest.h.

◆ GetIdentifyLanguage()

bool Aws::TranscribeService::Model::StartTranscriptionJobRequest::GetIdentifyLanguage ( ) const
inline

Set this field to true to enable automatic language identification. Automatic language identification is disabled by default. You receive a BadRequestException error if you enter a value for a LanguageCode.

Definition at line 990 of file StartTranscriptionJobRequest.h.

◆ GetJobExecutionSettings()

const JobExecutionSettings& Aws::TranscribeService::Model::StartTranscriptionJobRequest::GetJobExecutionSettings ( ) const
inline

Provides information about how a transcription job is executed. Use this field to indicate that the job can be queued for deferred execution if the concurrency limit is reached and there are no slots available to immediately run the job.

Definition at line 910 of file StartTranscriptionJobRequest.h.

◆ GetKMSEncryptionContext()

const Aws::Map<Aws::String, Aws::String>& Aws::TranscribeService::Model::StartTranscriptionJobRequest::GetKMSEncryptionContext ( ) const
inline

A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data.

Definition at line 755 of file StartTranscriptionJobRequest.h.

◆ GetLanguageCode()

const LanguageCode& Aws::TranscribeService::Model::StartTranscriptionJobRequest::GetLanguageCode ( ) const
inline

The language code for the language used in the input media file.

To transcribe speech in Modern Standard Arabic (ar-SA), your audio or video file must be encoded at a sample rate of 16,000 Hz or higher.

Definition at line 127 of file StartTranscriptionJobRequest.h.

◆ GetLanguageIdSettings()

const Aws::Map<LanguageCode, LanguageIdSettings>& Aws::TranscribeService::Model::StartTranscriptionJobRequest::GetLanguageIdSettings ( ) const
inline

The language identification settings associated with your transcription job. These settings include VocabularyName, VocabularyFilterName, and LanguageModelName.

Definition at line 1167 of file StartTranscriptionJobRequest.h.

◆ GetLanguageOptions()

const Aws::Vector<LanguageCode>& Aws::TranscribeService::Model::StartTranscriptionJobRequest::GetLanguageOptions ( ) const
inline

An object containing a list of languages that might be present in your collection of audio files. Automatic language identification chooses a language that best matches the source audio from that list.

To transcribe speech in Modern Standard Arabic (ar-SA), your audio or video file must be encoded at a sample rate of 16,000 Hz or higher.

Definition at line 1024 of file StartTranscriptionJobRequest.h.

◆ GetMedia()

const Media& Aws::TranscribeService::Model::StartTranscriptionJobRequest::GetMedia ( ) const
inline

An object that describes the input media for a transcription job.

Definition at line 240 of file StartTranscriptionJobRequest.h.

◆ GetMediaFormat()

const MediaFormat& Aws::TranscribeService::Model::StartTranscriptionJobRequest::GetMediaFormat ( ) const
inline

The format of the input media file.

Definition at line 209 of file StartTranscriptionJobRequest.h.

◆ GetMediaSampleRateHertz()

int Aws::TranscribeService::Model::StartTranscriptionJobRequest::GetMediaSampleRateHertz ( ) const
inline

The sample rate, in Hertz, of the audio track in the input media file.

If you do not specify the media sample rate, Amazon Transcribe determines the sample rate. If you specify the sample rate, it must match the sample rate detected by Amazon Transcribe. In most cases, you should leave the MediaSampleRateHertz field blank and let Amazon Transcribe determine the sample rate.

Definition at line 173 of file StartTranscriptionJobRequest.h.

◆ GetModelSettings()

const ModelSettings& Aws::TranscribeService::Model::StartTranscriptionJobRequest::GetModelSettings ( ) const
inline

Choose the custom language model you use for your transcription job in this parameter.

Definition at line 871 of file StartTranscriptionJobRequest.h.

◆ GetOutputBucketName()

const Aws::String& Aws::TranscribeService::Model::StartTranscriptionJobRequest::GetOutputBucketName ( ) const
inline

The location where the transcription is stored.

If you set the OutputBucketName, Amazon Transcribe puts the transcript in the specified S3 bucket. When you call the GetTranscriptionJob operation, the operation returns this location in the TranscriptFileUri field. If you enable content redaction, the redacted transcript appears in RedactedTranscriptFileUri. If you enable content redaction and choose to output an unredacted transcript, that transcript's location still appears in the TranscriptFileUri. The S3 bucket must have permissions that allow Amazon Transcribe to put files in the bucket. For more information, see Permissions Required for IAM User Roles.

You can specify an Amazon Web Services Key Management Service (KMS) key to encrypt the output of your transcription using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.

If you don't set the OutputBucketName, Amazon Transcribe generates a pre-signed URL, a shareable URL that provides secure access to your transcription, and returns it in the TranscriptFileUri field. Use this URL to download the transcription.

Definition at line 290 of file StartTranscriptionJobRequest.h.

◆ GetOutputEncryptionKMSKeyId()

const Aws::String& Aws::TranscribeService::Model::StartTranscriptionJobRequest::GetOutputEncryptionKMSKeyId ( ) const
inline

The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service (KMS) key used to encrypt the output of the transcription job. The user calling the StartTranscriptionJob operation must have permission to use the specified KMS key.

You can use either of the following to identify a KMS key in the current account:

  • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

  • KMS Key Alias: "alias/ExampleAlias"

You can use either of the following to identify a KMS key in the current account or another account:

  • Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef-1234567890ab"

  • ARN of a KMS Key Alias: "arn:aws:kms:region:account-ID:alias/ExampleAlias"

If you don't specify an encryption key, the output of the transcription job is encrypted with the default Amazon S3 key (SSE-S3).

If you specify a KMS key to encrypt your output, you must also specify an output location in the OutputBucketName parameter.

Definition at line 615 of file StartTranscriptionJobRequest.h.

◆ GetOutputKey()

const Aws::String& Aws::TranscribeService::Model::StartTranscriptionJobRequest::GetOutputKey ( ) const
inline

You can specify a location in an Amazon S3 bucket to store the output of your transcription job.

If you don't specify an output key, Amazon Transcribe stores the output of your transcription job in the Amazon S3 bucket you specified. By default, the object key is "your-transcription-job-name.json".

You can use output keys to specify the Amazon S3 prefix and file name of the transcription output. For example, specifying the Amazon S3 prefix, "folder1/folder2/", as an output key would lead to the output being stored as "folder1/folder2/your-transcription-job-name.json". If you specify "my-other-job-name.json" as the output key, the object key is changed to "my-other-job-name.json". You can use an output key to change both the prefix and the file name, for example "folder/my-other-job-name.json".

If you specify an output key, you must also specify an S3 bucket in the OutputBucketName parameter.

Definition at line 476 of file StartTranscriptionJobRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::TranscribeService::Model::StartTranscriptionJobRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetServiceRequestName()

virtual const char* Aws::TranscribeService::Model::StartTranscriptionJobRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 42 of file StartTranscriptionJobRequest.h.

◆ GetSettings()

const Settings& Aws::TranscribeService::Model::StartTranscriptionJobRequest::GetSettings ( ) const
inline

A Settings object that provides optional settings for a transcription job.

Definition at line 834 of file StartTranscriptionJobRequest.h.

◆ GetSubtitles()

const Subtitles& Aws::TranscribeService::Model::StartTranscriptionJobRequest::GetSubtitles ( ) const
inline

Add subtitles to your batch transcription job.

Definition at line 1093 of file StartTranscriptionJobRequest.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::TranscribeService::Model::StartTranscriptionJobRequest::GetTags ( ) const
inline

Add tags to an Amazon Transcribe transcription job.

Definition at line 1124 of file StartTranscriptionJobRequest.h.

◆ GetTranscriptionJobName()

const Aws::String& Aws::TranscribeService::Model::StartTranscriptionJobRequest::GetTranscriptionJobName ( ) const
inline

The name of the job. You can't use the strings "<code>.</code>" or "<code>..</code>" by themselves as the job name. The name must also be unique within an Amazon Web Services account. If you try to create a transcription job with the same name as a previous transcription job, you get a ConflictException error.

Definition at line 56 of file StartTranscriptionJobRequest.h.

◆ IdentifyLanguageHasBeenSet()

bool Aws::TranscribeService::Model::StartTranscriptionJobRequest::IdentifyLanguageHasBeenSet ( ) const
inline

Set this field to true to enable automatic language identification. Automatic language identification is disabled by default. You receive a BadRequestException error if you enter a value for a LanguageCode.

Definition at line 998 of file StartTranscriptionJobRequest.h.

◆ JobExecutionSettingsHasBeenSet()

bool Aws::TranscribeService::Model::StartTranscriptionJobRequest::JobExecutionSettingsHasBeenSet ( ) const
inline

Provides information about how a transcription job is executed. Use this field to indicate that the job can be queued for deferred execution if the concurrency limit is reached and there are no slots available to immediately run the job.

Definition at line 918 of file StartTranscriptionJobRequest.h.

◆ KMSEncryptionContextHasBeenSet()

bool Aws::TranscribeService::Model::StartTranscriptionJobRequest::KMSEncryptionContextHasBeenSet ( ) const
inline

A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data.

Definition at line 761 of file StartTranscriptionJobRequest.h.

◆ LanguageCodeHasBeenSet()

bool Aws::TranscribeService::Model::StartTranscriptionJobRequest::LanguageCodeHasBeenSet ( ) const
inline

The language code for the language used in the input media file.

To transcribe speech in Modern Standard Arabic (ar-SA), your audio or video file must be encoded at a sample rate of 16,000 Hz or higher.

Definition at line 134 of file StartTranscriptionJobRequest.h.

◆ LanguageIdSettingsHasBeenSet()

bool Aws::TranscribeService::Model::StartTranscriptionJobRequest::LanguageIdSettingsHasBeenSet ( ) const
inline

The language identification settings associated with your transcription job. These settings include VocabularyName, VocabularyFilterName, and LanguageModelName.

Definition at line 1174 of file StartTranscriptionJobRequest.h.

◆ LanguageOptionsHasBeenSet()

bool Aws::TranscribeService::Model::StartTranscriptionJobRequest::LanguageOptionsHasBeenSet ( ) const
inline

An object containing a list of languages that might be present in your collection of audio files. Automatic language identification chooses a language that best matches the source audio from that list.

To transcribe speech in Modern Standard Arabic (ar-SA), your audio or video file must be encoded at a sample rate of 16,000 Hz or higher.

Definition at line 1033 of file StartTranscriptionJobRequest.h.

◆ MediaFormatHasBeenSet()

bool Aws::TranscribeService::Model::StartTranscriptionJobRequest::MediaFormatHasBeenSet ( ) const
inline

The format of the input media file.

Definition at line 214 of file StartTranscriptionJobRequest.h.

◆ MediaHasBeenSet()

bool Aws::TranscribeService::Model::StartTranscriptionJobRequest::MediaHasBeenSet ( ) const
inline

An object that describes the input media for a transcription job.

Definition at line 245 of file StartTranscriptionJobRequest.h.

◆ MediaSampleRateHertzHasBeenSet()

bool Aws::TranscribeService::Model::StartTranscriptionJobRequest::MediaSampleRateHertzHasBeenSet ( ) const
inline

The sample rate, in Hertz, of the audio track in the input media file.

If you do not specify the media sample rate, Amazon Transcribe determines the sample rate. If you specify the sample rate, it must match the sample rate detected by Amazon Transcribe. In most cases, you should leave the MediaSampleRateHertz field blank and let Amazon Transcribe determine the sample rate.

Definition at line 183 of file StartTranscriptionJobRequest.h.

◆ ModelSettingsHasBeenSet()

bool Aws::TranscribeService::Model::StartTranscriptionJobRequest::ModelSettingsHasBeenSet ( ) const
inline

Choose the custom language model you use for your transcription job in this parameter.

Definition at line 877 of file StartTranscriptionJobRequest.h.

◆ OutputBucketNameHasBeenSet()

bool Aws::TranscribeService::Model::StartTranscriptionJobRequest::OutputBucketNameHasBeenSet ( ) const
inline

The location where the transcription is stored.

If you set the OutputBucketName, Amazon Transcribe puts the transcript in the specified S3 bucket. When you call the GetTranscriptionJob operation, the operation returns this location in the TranscriptFileUri field. If you enable content redaction, the redacted transcript appears in RedactedTranscriptFileUri. If you enable content redaction and choose to output an unredacted transcript, that transcript's location still appears in the TranscriptFileUri. The S3 bucket must have permissions that allow Amazon Transcribe to put files in the bucket. For more information, see Permissions Required for IAM User Roles.

You can specify an Amazon Web Services Key Management Service (KMS) key to encrypt the output of your transcription using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.

If you don't set the OutputBucketName, Amazon Transcribe generates a pre-signed URL, a shareable URL that provides secure access to your transcription, and returns it in the TranscriptFileUri field. Use this URL to download the transcription.

Definition at line 314 of file StartTranscriptionJobRequest.h.

◆ OutputEncryptionKMSKeyIdHasBeenSet()

bool Aws::TranscribeService::Model::StartTranscriptionJobRequest::OutputEncryptionKMSKeyIdHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service (KMS) key used to encrypt the output of the transcription job. The user calling the StartTranscriptionJob operation must have permission to use the specified KMS key.

You can use either of the following to identify a KMS key in the current account:

  • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

  • KMS Key Alias: "alias/ExampleAlias"

You can use either of the following to identify a KMS key in the current account or another account:

  • Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef-1234567890ab"

  • ARN of a KMS Key Alias: "arn:aws:kms:region:account-ID:alias/ExampleAlias"

If you don't specify an encryption key, the output of the transcription job is encrypted with the default Amazon S3 key (SSE-S3).

If you specify a KMS key to encrypt your output, you must also specify an output location in the OutputBucketName parameter.

Definition at line 634 of file StartTranscriptionJobRequest.h.

◆ OutputKeyHasBeenSet()

bool Aws::TranscribeService::Model::StartTranscriptionJobRequest::OutputKeyHasBeenSet ( ) const
inline

You can specify a location in an Amazon S3 bucket to store the output of your transcription job.

If you don't specify an output key, Amazon Transcribe stores the output of your transcription job in the Amazon S3 bucket you specified. By default, the object key is "your-transcription-job-name.json".

You can use output keys to specify the Amazon S3 prefix and file name of the transcription output. For example, specifying the Amazon S3 prefix, "folder1/folder2/", as an output key would lead to the output being stored as "folder1/folder2/your-transcription-job-name.json". If you specify "my-other-job-name.json" as the output key, the object key is changed to "my-other-job-name.json". You can use an output key to change both the prefix and the file name, for example "folder/my-other-job-name.json".

If you specify an output key, you must also specify an S3 bucket in the OutputBucketName parameter.

Definition at line 493 of file StartTranscriptionJobRequest.h.

◆ SerializePayload()

Aws::String Aws::TranscribeService::Model::StartTranscriptionJobRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetContentRedaction() [1/2]

void Aws::TranscribeService::Model::StartTranscriptionJobRequest::SetContentRedaction ( const ContentRedaction value)
inline

An object that contains the request parameters for content redaction.

Definition at line 966 of file StartTranscriptionJobRequest.h.

◆ SetContentRedaction() [2/2]

void Aws::TranscribeService::Model::StartTranscriptionJobRequest::SetContentRedaction ( ContentRedaction &&  value)
inline

An object that contains the request parameters for content redaction.

Definition at line 971 of file StartTranscriptionJobRequest.h.

◆ SetIdentifyLanguage()

void Aws::TranscribeService::Model::StartTranscriptionJobRequest::SetIdentifyLanguage ( bool  value)
inline

Set this field to true to enable automatic language identification. Automatic language identification is disabled by default. You receive a BadRequestException error if you enter a value for a LanguageCode.

Definition at line 1006 of file StartTranscriptionJobRequest.h.

◆ SetJobExecutionSettings() [1/2]

void Aws::TranscribeService::Model::StartTranscriptionJobRequest::SetJobExecutionSettings ( const JobExecutionSettings value)
inline

Provides information about how a transcription job is executed. Use this field to indicate that the job can be queued for deferred execution if the concurrency limit is reached and there are no slots available to immediately run the job.

Definition at line 926 of file StartTranscriptionJobRequest.h.

◆ SetJobExecutionSettings() [2/2]

void Aws::TranscribeService::Model::StartTranscriptionJobRequest::SetJobExecutionSettings ( JobExecutionSettings &&  value)
inline

Provides information about how a transcription job is executed. Use this field to indicate that the job can be queued for deferred execution if the concurrency limit is reached and there are no slots available to immediately run the job.

Definition at line 934 of file StartTranscriptionJobRequest.h.

◆ SetKMSEncryptionContext() [1/2]

void Aws::TranscribeService::Model::StartTranscriptionJobRequest::SetKMSEncryptionContext ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data.

Definition at line 773 of file StartTranscriptionJobRequest.h.

◆ SetKMSEncryptionContext() [2/2]

void Aws::TranscribeService::Model::StartTranscriptionJobRequest::SetKMSEncryptionContext ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data.

Definition at line 767 of file StartTranscriptionJobRequest.h.

◆ SetLanguageCode() [1/2]

void Aws::TranscribeService::Model::StartTranscriptionJobRequest::SetLanguageCode ( const LanguageCode value)
inline

The language code for the language used in the input media file.

To transcribe speech in Modern Standard Arabic (ar-SA), your audio or video file must be encoded at a sample rate of 16,000 Hz or higher.

Definition at line 141 of file StartTranscriptionJobRequest.h.

◆ SetLanguageCode() [2/2]

void Aws::TranscribeService::Model::StartTranscriptionJobRequest::SetLanguageCode ( LanguageCode &&  value)
inline

The language code for the language used in the input media file.

To transcribe speech in Modern Standard Arabic (ar-SA), your audio or video file must be encoded at a sample rate of 16,000 Hz or higher.

Definition at line 148 of file StartTranscriptionJobRequest.h.

◆ SetLanguageIdSettings() [1/2]

void Aws::TranscribeService::Model::StartTranscriptionJobRequest::SetLanguageIdSettings ( Aws::Map< LanguageCode, LanguageIdSettings > &&  value)
inline

The language identification settings associated with your transcription job. These settings include VocabularyName, VocabularyFilterName, and LanguageModelName.

Definition at line 1188 of file StartTranscriptionJobRequest.h.

◆ SetLanguageIdSettings() [2/2]

void Aws::TranscribeService::Model::StartTranscriptionJobRequest::SetLanguageIdSettings ( const Aws::Map< LanguageCode, LanguageIdSettings > &  value)
inline

The language identification settings associated with your transcription job. These settings include VocabularyName, VocabularyFilterName, and LanguageModelName.

Definition at line 1181 of file StartTranscriptionJobRequest.h.

◆ SetLanguageOptions() [1/2]

void Aws::TranscribeService::Model::StartTranscriptionJobRequest::SetLanguageOptions ( Aws::Vector< LanguageCode > &&  value)
inline

An object containing a list of languages that might be present in your collection of audio files. Automatic language identification chooses a language that best matches the source audio from that list.

To transcribe speech in Modern Standard Arabic (ar-SA), your audio or video file must be encoded at a sample rate of 16,000 Hz or higher.

Definition at line 1051 of file StartTranscriptionJobRequest.h.

◆ SetLanguageOptions() [2/2]

void Aws::TranscribeService::Model::StartTranscriptionJobRequest::SetLanguageOptions ( const Aws::Vector< LanguageCode > &  value)
inline

An object containing a list of languages that might be present in your collection of audio files. Automatic language identification chooses a language that best matches the source audio from that list.

To transcribe speech in Modern Standard Arabic (ar-SA), your audio or video file must be encoded at a sample rate of 16,000 Hz or higher.

Definition at line 1042 of file StartTranscriptionJobRequest.h.

◆ SetMedia() [1/2]

void Aws::TranscribeService::Model::StartTranscriptionJobRequest::SetMedia ( const Media value)
inline

An object that describes the input media for a transcription job.

Definition at line 250 of file StartTranscriptionJobRequest.h.

◆ SetMedia() [2/2]

void Aws::TranscribeService::Model::StartTranscriptionJobRequest::SetMedia ( Media &&  value)
inline

An object that describes the input media for a transcription job.

Definition at line 255 of file StartTranscriptionJobRequest.h.

◆ SetMediaFormat() [1/2]

void Aws::TranscribeService::Model::StartTranscriptionJobRequest::SetMediaFormat ( const MediaFormat value)
inline

The format of the input media file.

Definition at line 219 of file StartTranscriptionJobRequest.h.

◆ SetMediaFormat() [2/2]

void Aws::TranscribeService::Model::StartTranscriptionJobRequest::SetMediaFormat ( MediaFormat &&  value)
inline

The format of the input media file.

Definition at line 224 of file StartTranscriptionJobRequest.h.

◆ SetMediaSampleRateHertz()

void Aws::TranscribeService::Model::StartTranscriptionJobRequest::SetMediaSampleRateHertz ( int  value)
inline

The sample rate, in Hertz, of the audio track in the input media file.

If you do not specify the media sample rate, Amazon Transcribe determines the sample rate. If you specify the sample rate, it must match the sample rate detected by Amazon Transcribe. In most cases, you should leave the MediaSampleRateHertz field blank and let Amazon Transcribe determine the sample rate.

Definition at line 193 of file StartTranscriptionJobRequest.h.

◆ SetModelSettings() [1/2]

void Aws::TranscribeService::Model::StartTranscriptionJobRequest::SetModelSettings ( const ModelSettings value)
inline

Choose the custom language model you use for your transcription job in this parameter.

Definition at line 883 of file StartTranscriptionJobRequest.h.

◆ SetModelSettings() [2/2]

void Aws::TranscribeService::Model::StartTranscriptionJobRequest::SetModelSettings ( ModelSettings &&  value)
inline

Choose the custom language model you use for your transcription job in this parameter.

Definition at line 889 of file StartTranscriptionJobRequest.h.

◆ SetOutputBucketName() [1/3]

void Aws::TranscribeService::Model::StartTranscriptionJobRequest::SetOutputBucketName ( Aws::String &&  value)
inline

The location where the transcription is stored.

If you set the OutputBucketName, Amazon Transcribe puts the transcript in the specified S3 bucket. When you call the GetTranscriptionJob operation, the operation returns this location in the TranscriptFileUri field. If you enable content redaction, the redacted transcript appears in RedactedTranscriptFileUri. If you enable content redaction and choose to output an unredacted transcript, that transcript's location still appears in the TranscriptFileUri. The S3 bucket must have permissions that allow Amazon Transcribe to put files in the bucket. For more information, see Permissions Required for IAM User Roles.

You can specify an Amazon Web Services Key Management Service (KMS) key to encrypt the output of your transcription using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.

If you don't set the OutputBucketName, Amazon Transcribe generates a pre-signed URL, a shareable URL that provides secure access to your transcription, and returns it in the TranscriptFileUri field. Use this URL to download the transcription.

Definition at line 362 of file StartTranscriptionJobRequest.h.

◆ SetOutputBucketName() [2/3]

void Aws::TranscribeService::Model::StartTranscriptionJobRequest::SetOutputBucketName ( const Aws::String value)
inline

The location where the transcription is stored.

If you set the OutputBucketName, Amazon Transcribe puts the transcript in the specified S3 bucket. When you call the GetTranscriptionJob operation, the operation returns this location in the TranscriptFileUri field. If you enable content redaction, the redacted transcript appears in RedactedTranscriptFileUri. If you enable content redaction and choose to output an unredacted transcript, that transcript's location still appears in the TranscriptFileUri. The S3 bucket must have permissions that allow Amazon Transcribe to put files in the bucket. For more information, see Permissions Required for IAM User Roles.

You can specify an Amazon Web Services Key Management Service (KMS) key to encrypt the output of your transcription using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.

If you don't set the OutputBucketName, Amazon Transcribe generates a pre-signed URL, a shareable URL that provides secure access to your transcription, and returns it in the TranscriptFileUri field. Use this URL to download the transcription.

Definition at line 338 of file StartTranscriptionJobRequest.h.

◆ SetOutputBucketName() [3/3]

void Aws::TranscribeService::Model::StartTranscriptionJobRequest::SetOutputBucketName ( const char *  value)
inline

The location where the transcription is stored.

If you set the OutputBucketName, Amazon Transcribe puts the transcript in the specified S3 bucket. When you call the GetTranscriptionJob operation, the operation returns this location in the TranscriptFileUri field. If you enable content redaction, the redacted transcript appears in RedactedTranscriptFileUri. If you enable content redaction and choose to output an unredacted transcript, that transcript's location still appears in the TranscriptFileUri. The S3 bucket must have permissions that allow Amazon Transcribe to put files in the bucket. For more information, see Permissions Required for IAM User Roles.

You can specify an Amazon Web Services Key Management Service (KMS) key to encrypt the output of your transcription using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.

If you don't set the OutputBucketName, Amazon Transcribe generates a pre-signed URL, a shareable URL that provides secure access to your transcription, and returns it in the TranscriptFileUri field. Use this URL to download the transcription.

Definition at line 386 of file StartTranscriptionJobRequest.h.

◆ SetOutputEncryptionKMSKeyId() [1/3]

void Aws::TranscribeService::Model::StartTranscriptionJobRequest::SetOutputEncryptionKMSKeyId ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service (KMS) key used to encrypt the output of the transcription job. The user calling the StartTranscriptionJob operation must have permission to use the specified KMS key.

You can use either of the following to identify a KMS key in the current account:

  • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

  • KMS Key Alias: "alias/ExampleAlias"

You can use either of the following to identify a KMS key in the current account or another account:

  • Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef-1234567890ab"

  • ARN of a KMS Key Alias: "arn:aws:kms:region:account-ID:alias/ExampleAlias"

If you don't specify an encryption key, the output of the transcription job is encrypted with the default Amazon S3 key (SSE-S3).

If you specify a KMS key to encrypt your output, you must also specify an output location in the OutputBucketName parameter.

Definition at line 672 of file StartTranscriptionJobRequest.h.

◆ SetOutputEncryptionKMSKeyId() [2/3]

void Aws::TranscribeService::Model::StartTranscriptionJobRequest::SetOutputEncryptionKMSKeyId ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service (KMS) key used to encrypt the output of the transcription job. The user calling the StartTranscriptionJob operation must have permission to use the specified KMS key.

You can use either of the following to identify a KMS key in the current account:

  • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

  • KMS Key Alias: "alias/ExampleAlias"

You can use either of the following to identify a KMS key in the current account or another account:

  • Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef-1234567890ab"

  • ARN of a KMS Key Alias: "arn:aws:kms:region:account-ID:alias/ExampleAlias"

If you don't specify an encryption key, the output of the transcription job is encrypted with the default Amazon S3 key (SSE-S3).

If you specify a KMS key to encrypt your output, you must also specify an output location in the OutputBucketName parameter.

Definition at line 653 of file StartTranscriptionJobRequest.h.

◆ SetOutputEncryptionKMSKeyId() [3/3]

void Aws::TranscribeService::Model::StartTranscriptionJobRequest::SetOutputEncryptionKMSKeyId ( const char *  value)
inline

The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service (KMS) key used to encrypt the output of the transcription job. The user calling the StartTranscriptionJob operation must have permission to use the specified KMS key.

You can use either of the following to identify a KMS key in the current account:

  • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

  • KMS Key Alias: "alias/ExampleAlias"

You can use either of the following to identify a KMS key in the current account or another account:

  • Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef-1234567890ab"

  • ARN of a KMS Key Alias: "arn:aws:kms:region:account-ID:alias/ExampleAlias"

If you don't specify an encryption key, the output of the transcription job is encrypted with the default Amazon S3 key (SSE-S3).

If you specify a KMS key to encrypt your output, you must also specify an output location in the OutputBucketName parameter.

Definition at line 691 of file StartTranscriptionJobRequest.h.

◆ SetOutputKey() [1/3]

void Aws::TranscribeService::Model::StartTranscriptionJobRequest::SetOutputKey ( Aws::String &&  value)
inline

You can specify a location in an Amazon S3 bucket to store the output of your transcription job.

If you don't specify an output key, Amazon Transcribe stores the output of your transcription job in the Amazon S3 bucket you specified. By default, the object key is "your-transcription-job-name.json".

You can use output keys to specify the Amazon S3 prefix and file name of the transcription output. For example, specifying the Amazon S3 prefix, "folder1/folder2/", as an output key would lead to the output being stored as "folder1/folder2/your-transcription-job-name.json". If you specify "my-other-job-name.json" as the output key, the object key is changed to "my-other-job-name.json". You can use an output key to change both the prefix and the file name, for example "folder/my-other-job-name.json".

If you specify an output key, you must also specify an S3 bucket in the OutputBucketName parameter.

Definition at line 527 of file StartTranscriptionJobRequest.h.

◆ SetOutputKey() [2/3]

void Aws::TranscribeService::Model::StartTranscriptionJobRequest::SetOutputKey ( const Aws::String value)
inline

You can specify a location in an Amazon S3 bucket to store the output of your transcription job.

If you don't specify an output key, Amazon Transcribe stores the output of your transcription job in the Amazon S3 bucket you specified. By default, the object key is "your-transcription-job-name.json".

You can use output keys to specify the Amazon S3 prefix and file name of the transcription output. For example, specifying the Amazon S3 prefix, "folder1/folder2/", as an output key would lead to the output being stored as "folder1/folder2/your-transcription-job-name.json". If you specify "my-other-job-name.json" as the output key, the object key is changed to "my-other-job-name.json". You can use an output key to change both the prefix and the file name, for example "folder/my-other-job-name.json".

If you specify an output key, you must also specify an S3 bucket in the OutputBucketName parameter.

Definition at line 510 of file StartTranscriptionJobRequest.h.

◆ SetOutputKey() [3/3]

void Aws::TranscribeService::Model::StartTranscriptionJobRequest::SetOutputKey ( const char *  value)
inline

You can specify a location in an Amazon S3 bucket to store the output of your transcription job.

If you don't specify an output key, Amazon Transcribe stores the output of your transcription job in the Amazon S3 bucket you specified. By default, the object key is "your-transcription-job-name.json".

You can use output keys to specify the Amazon S3 prefix and file name of the transcription output. For example, specifying the Amazon S3 prefix, "folder1/folder2/", as an output key would lead to the output being stored as "folder1/folder2/your-transcription-job-name.json". If you specify "my-other-job-name.json" as the output key, the object key is changed to "my-other-job-name.json". You can use an output key to change both the prefix and the file name, for example "folder/my-other-job-name.json".

If you specify an output key, you must also specify an S3 bucket in the OutputBucketName parameter.

Definition at line 544 of file StartTranscriptionJobRequest.h.

◆ SetSettings() [1/2]

void Aws::TranscribeService::Model::StartTranscriptionJobRequest::SetSettings ( const Settings value)
inline

A Settings object that provides optional settings for a transcription job.

Definition at line 846 of file StartTranscriptionJobRequest.h.

◆ SetSettings() [2/2]

void Aws::TranscribeService::Model::StartTranscriptionJobRequest::SetSettings ( Settings &&  value)
inline

A Settings object that provides optional settings for a transcription job.

Definition at line 852 of file StartTranscriptionJobRequest.h.

◆ SetSubtitles() [1/2]

void Aws::TranscribeService::Model::StartTranscriptionJobRequest::SetSubtitles ( const Subtitles value)
inline

Add subtitles to your batch transcription job.

Definition at line 1103 of file StartTranscriptionJobRequest.h.

◆ SetSubtitles() [2/2]

void Aws::TranscribeService::Model::StartTranscriptionJobRequest::SetSubtitles ( Subtitles &&  value)
inline

Add subtitles to your batch transcription job.

Definition at line 1108 of file StartTranscriptionJobRequest.h.

◆ SetTags() [1/2]

void Aws::TranscribeService::Model::StartTranscriptionJobRequest::SetTags ( Aws::Vector< Tag > &&  value)
inline

Add tags to an Amazon Transcribe transcription job.

Definition at line 1139 of file StartTranscriptionJobRequest.h.

◆ SetTags() [2/2]

void Aws::TranscribeService::Model::StartTranscriptionJobRequest::SetTags ( const Aws::Vector< Tag > &  value)
inline

Add tags to an Amazon Transcribe transcription job.

Definition at line 1134 of file StartTranscriptionJobRequest.h.

◆ SettingsHasBeenSet()

bool Aws::TranscribeService::Model::StartTranscriptionJobRequest::SettingsHasBeenSet ( ) const
inline

A Settings object that provides optional settings for a transcription job.

Definition at line 840 of file StartTranscriptionJobRequest.h.

◆ SetTranscriptionJobName() [1/3]

void Aws::TranscribeService::Model::StartTranscriptionJobRequest::SetTranscriptionJobName ( Aws::String &&  value)
inline

The name of the job. You can't use the strings "<code>.</code>" or "<code>..</code>" by themselves as the job name. The name must also be unique within an Amazon Web Services account. If you try to create a transcription job with the same name as a previous transcription job, you get a ConflictException error.

Definition at line 83 of file StartTranscriptionJobRequest.h.

◆ SetTranscriptionJobName() [2/3]

void Aws::TranscribeService::Model::StartTranscriptionJobRequest::SetTranscriptionJobName ( const Aws::String value)
inline

The name of the job. You can't use the strings "<code>.</code>" or "<code>..</code>" by themselves as the job name. The name must also be unique within an Amazon Web Services account. If you try to create a transcription job with the same name as a previous transcription job, you get a ConflictException error.

Definition at line 74 of file StartTranscriptionJobRequest.h.

◆ SetTranscriptionJobName() [3/3]

void Aws::TranscribeService::Model::StartTranscriptionJobRequest::SetTranscriptionJobName ( const char *  value)
inline

The name of the job. You can't use the strings "<code>.</code>" or "<code>..</code>" by themselves as the job name. The name must also be unique within an Amazon Web Services account. If you try to create a transcription job with the same name as a previous transcription job, you get a ConflictException error.

Definition at line 92 of file StartTranscriptionJobRequest.h.

◆ SubtitlesHasBeenSet()

bool Aws::TranscribeService::Model::StartTranscriptionJobRequest::SubtitlesHasBeenSet ( ) const
inline

Add subtitles to your batch transcription job.

Definition at line 1098 of file StartTranscriptionJobRequest.h.

◆ TagsHasBeenSet()

bool Aws::TranscribeService::Model::StartTranscriptionJobRequest::TagsHasBeenSet ( ) const
inline

Add tags to an Amazon Transcribe transcription job.

Definition at line 1129 of file StartTranscriptionJobRequest.h.

◆ TranscriptionJobNameHasBeenSet()

bool Aws::TranscribeService::Model::StartTranscriptionJobRequest::TranscriptionJobNameHasBeenSet ( ) const
inline

The name of the job. You can't use the strings "<code>.</code>" or "<code>..</code>" by themselves as the job name. The name must also be unique within an Amazon Web Services account. If you try to create a transcription job with the same name as a previous transcription job, you get a ConflictException error.

Definition at line 65 of file StartTranscriptionJobRequest.h.

◆ WithContentRedaction() [1/2]

StartTranscriptionJobRequest& Aws::TranscribeService::Model::StartTranscriptionJobRequest::WithContentRedaction ( const ContentRedaction value)
inline

An object that contains the request parameters for content redaction.

Definition at line 976 of file StartTranscriptionJobRequest.h.

◆ WithContentRedaction() [2/2]

StartTranscriptionJobRequest& Aws::TranscribeService::Model::StartTranscriptionJobRequest::WithContentRedaction ( ContentRedaction &&  value)
inline

An object that contains the request parameters for content redaction.

Definition at line 981 of file StartTranscriptionJobRequest.h.

◆ WithIdentifyLanguage()

StartTranscriptionJobRequest& Aws::TranscribeService::Model::StartTranscriptionJobRequest::WithIdentifyLanguage ( bool  value)
inline

Set this field to true to enable automatic language identification. Automatic language identification is disabled by default. You receive a BadRequestException error if you enter a value for a LanguageCode.

Definition at line 1014 of file StartTranscriptionJobRequest.h.

◆ WithJobExecutionSettings() [1/2]

StartTranscriptionJobRequest& Aws::TranscribeService::Model::StartTranscriptionJobRequest::WithJobExecutionSettings ( const JobExecutionSettings value)
inline

Provides information about how a transcription job is executed. Use this field to indicate that the job can be queued for deferred execution if the concurrency limit is reached and there are no slots available to immediately run the job.

Definition at line 942 of file StartTranscriptionJobRequest.h.

◆ WithJobExecutionSettings() [2/2]

StartTranscriptionJobRequest& Aws::TranscribeService::Model::StartTranscriptionJobRequest::WithJobExecutionSettings ( JobExecutionSettings &&  value)
inline

Provides information about how a transcription job is executed. Use this field to indicate that the job can be queued for deferred execution if the concurrency limit is reached and there are no slots available to immediately run the job.

Definition at line 950 of file StartTranscriptionJobRequest.h.

◆ WithKMSEncryptionContext() [1/2]

StartTranscriptionJobRequest& Aws::TranscribeService::Model::StartTranscriptionJobRequest::WithKMSEncryptionContext ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data.

Definition at line 785 of file StartTranscriptionJobRequest.h.

◆ WithKMSEncryptionContext() [2/2]

StartTranscriptionJobRequest& Aws::TranscribeService::Model::StartTranscriptionJobRequest::WithKMSEncryptionContext ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data.

Definition at line 779 of file StartTranscriptionJobRequest.h.

◆ WithLanguageCode() [1/2]

StartTranscriptionJobRequest& Aws::TranscribeService::Model::StartTranscriptionJobRequest::WithLanguageCode ( const LanguageCode value)
inline

The language code for the language used in the input media file.

To transcribe speech in Modern Standard Arabic (ar-SA), your audio or video file must be encoded at a sample rate of 16,000 Hz or higher.

Definition at line 155 of file StartTranscriptionJobRequest.h.

◆ WithLanguageCode() [2/2]

StartTranscriptionJobRequest& Aws::TranscribeService::Model::StartTranscriptionJobRequest::WithLanguageCode ( LanguageCode &&  value)
inline

The language code for the language used in the input media file.

To transcribe speech in Modern Standard Arabic (ar-SA), your audio or video file must be encoded at a sample rate of 16,000 Hz or higher.

Definition at line 162 of file StartTranscriptionJobRequest.h.

◆ WithLanguageIdSettings() [1/2]

StartTranscriptionJobRequest& Aws::TranscribeService::Model::StartTranscriptionJobRequest::WithLanguageIdSettings ( Aws::Map< LanguageCode, LanguageIdSettings > &&  value)
inline

The language identification settings associated with your transcription job. These settings include VocabularyName, VocabularyFilterName, and LanguageModelName.

Definition at line 1202 of file StartTranscriptionJobRequest.h.

◆ WithLanguageIdSettings() [2/2]

StartTranscriptionJobRequest& Aws::TranscribeService::Model::StartTranscriptionJobRequest::WithLanguageIdSettings ( const Aws::Map< LanguageCode, LanguageIdSettings > &  value)
inline

The language identification settings associated with your transcription job. These settings include VocabularyName, VocabularyFilterName, and LanguageModelName.

Definition at line 1195 of file StartTranscriptionJobRequest.h.

◆ WithLanguageOptions() [1/2]

StartTranscriptionJobRequest& Aws::TranscribeService::Model::StartTranscriptionJobRequest::WithLanguageOptions ( Aws::Vector< LanguageCode > &&  value)
inline

An object containing a list of languages that might be present in your collection of audio files. Automatic language identification chooses a language that best matches the source audio from that list.

To transcribe speech in Modern Standard Arabic (ar-SA), your audio or video file must be encoded at a sample rate of 16,000 Hz or higher.

Definition at line 1069 of file StartTranscriptionJobRequest.h.

◆ WithLanguageOptions() [2/2]

StartTranscriptionJobRequest& Aws::TranscribeService::Model::StartTranscriptionJobRequest::WithLanguageOptions ( const Aws::Vector< LanguageCode > &  value)
inline

An object containing a list of languages that might be present in your collection of audio files. Automatic language identification chooses a language that best matches the source audio from that list.

To transcribe speech in Modern Standard Arabic (ar-SA), your audio or video file must be encoded at a sample rate of 16,000 Hz or higher.

Definition at line 1060 of file StartTranscriptionJobRequest.h.

◆ WithMedia() [1/2]

StartTranscriptionJobRequest& Aws::TranscribeService::Model::StartTranscriptionJobRequest::WithMedia ( const Media value)
inline

An object that describes the input media for a transcription job.

Definition at line 260 of file StartTranscriptionJobRequest.h.

◆ WithMedia() [2/2]

StartTranscriptionJobRequest& Aws::TranscribeService::Model::StartTranscriptionJobRequest::WithMedia ( Media &&  value)
inline

An object that describes the input media for a transcription job.

Definition at line 265 of file StartTranscriptionJobRequest.h.

◆ WithMediaFormat() [1/2]

StartTranscriptionJobRequest& Aws::TranscribeService::Model::StartTranscriptionJobRequest::WithMediaFormat ( const MediaFormat value)
inline

The format of the input media file.

Definition at line 229 of file StartTranscriptionJobRequest.h.

◆ WithMediaFormat() [2/2]

StartTranscriptionJobRequest& Aws::TranscribeService::Model::StartTranscriptionJobRequest::WithMediaFormat ( MediaFormat &&  value)
inline

The format of the input media file.

Definition at line 234 of file StartTranscriptionJobRequest.h.

◆ WithMediaSampleRateHertz()

StartTranscriptionJobRequest& Aws::TranscribeService::Model::StartTranscriptionJobRequest::WithMediaSampleRateHertz ( int  value)
inline

The sample rate, in Hertz, of the audio track in the input media file.

If you do not specify the media sample rate, Amazon Transcribe determines the sample rate. If you specify the sample rate, it must match the sample rate detected by Amazon Transcribe. In most cases, you should leave the MediaSampleRateHertz field blank and let Amazon Transcribe determine the sample rate.

Definition at line 203 of file StartTranscriptionJobRequest.h.

◆ WithModelSettings() [1/2]

StartTranscriptionJobRequest& Aws::TranscribeService::Model::StartTranscriptionJobRequest::WithModelSettings ( const ModelSettings value)
inline

Choose the custom language model you use for your transcription job in this parameter.

Definition at line 895 of file StartTranscriptionJobRequest.h.

◆ WithModelSettings() [2/2]

StartTranscriptionJobRequest& Aws::TranscribeService::Model::StartTranscriptionJobRequest::WithModelSettings ( ModelSettings &&  value)
inline

Choose the custom language model you use for your transcription job in this parameter.

Definition at line 901 of file StartTranscriptionJobRequest.h.

◆ WithOutputBucketName() [1/3]

StartTranscriptionJobRequest& Aws::TranscribeService::Model::StartTranscriptionJobRequest::WithOutputBucketName ( Aws::String &&  value)
inline

The location where the transcription is stored.

If you set the OutputBucketName, Amazon Transcribe puts the transcript in the specified S3 bucket. When you call the GetTranscriptionJob operation, the operation returns this location in the TranscriptFileUri field. If you enable content redaction, the redacted transcript appears in RedactedTranscriptFileUri. If you enable content redaction and choose to output an unredacted transcript, that transcript's location still appears in the TranscriptFileUri. The S3 bucket must have permissions that allow Amazon Transcribe to put files in the bucket. For more information, see Permissions Required for IAM User Roles.

You can specify an Amazon Web Services Key Management Service (KMS) key to encrypt the output of your transcription using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.

If you don't set the OutputBucketName, Amazon Transcribe generates a pre-signed URL, a shareable URL that provides secure access to your transcription, and returns it in the TranscriptFileUri field. Use this URL to download the transcription.

Definition at line 434 of file StartTranscriptionJobRequest.h.

◆ WithOutputBucketName() [2/3]

StartTranscriptionJobRequest& Aws::TranscribeService::Model::StartTranscriptionJobRequest::WithOutputBucketName ( const Aws::String value)
inline

The location where the transcription is stored.

If you set the OutputBucketName, Amazon Transcribe puts the transcript in the specified S3 bucket. When you call the GetTranscriptionJob operation, the operation returns this location in the TranscriptFileUri field. If you enable content redaction, the redacted transcript appears in RedactedTranscriptFileUri. If you enable content redaction and choose to output an unredacted transcript, that transcript's location still appears in the TranscriptFileUri. The S3 bucket must have permissions that allow Amazon Transcribe to put files in the bucket. For more information, see Permissions Required for IAM User Roles.

You can specify an Amazon Web Services Key Management Service (KMS) key to encrypt the output of your transcription using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.

If you don't set the OutputBucketName, Amazon Transcribe generates a pre-signed URL, a shareable URL that provides secure access to your transcription, and returns it in the TranscriptFileUri field. Use this URL to download the transcription.

Definition at line 410 of file StartTranscriptionJobRequest.h.

◆ WithOutputBucketName() [3/3]

StartTranscriptionJobRequest& Aws::TranscribeService::Model::StartTranscriptionJobRequest::WithOutputBucketName ( const char *  value)
inline

The location where the transcription is stored.

If you set the OutputBucketName, Amazon Transcribe puts the transcript in the specified S3 bucket. When you call the GetTranscriptionJob operation, the operation returns this location in the TranscriptFileUri field. If you enable content redaction, the redacted transcript appears in RedactedTranscriptFileUri. If you enable content redaction and choose to output an unredacted transcript, that transcript's location still appears in the TranscriptFileUri. The S3 bucket must have permissions that allow Amazon Transcribe to put files in the bucket. For more information, see Permissions Required for IAM User Roles.

You can specify an Amazon Web Services Key Management Service (KMS) key to encrypt the output of your transcription using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.

If you don't set the OutputBucketName, Amazon Transcribe generates a pre-signed URL, a shareable URL that provides secure access to your transcription, and returns it in the TranscriptFileUri field. Use this URL to download the transcription.

Definition at line 458 of file StartTranscriptionJobRequest.h.

◆ WithOutputEncryptionKMSKeyId() [1/3]

StartTranscriptionJobRequest& Aws::TranscribeService::Model::StartTranscriptionJobRequest::WithOutputEncryptionKMSKeyId ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service (KMS) key used to encrypt the output of the transcription job. The user calling the StartTranscriptionJob operation must have permission to use the specified KMS key.

You can use either of the following to identify a KMS key in the current account:

  • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

  • KMS Key Alias: "alias/ExampleAlias"

You can use either of the following to identify a KMS key in the current account or another account:

  • Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef-1234567890ab"

  • ARN of a KMS Key Alias: "arn:aws:kms:region:account-ID:alias/ExampleAlias"

If you don't specify an encryption key, the output of the transcription job is encrypted with the default Amazon S3 key (SSE-S3).

If you specify a KMS key to encrypt your output, you must also specify an output location in the OutputBucketName parameter.

Definition at line 729 of file StartTranscriptionJobRequest.h.

◆ WithOutputEncryptionKMSKeyId() [2/3]

StartTranscriptionJobRequest& Aws::TranscribeService::Model::StartTranscriptionJobRequest::WithOutputEncryptionKMSKeyId ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service (KMS) key used to encrypt the output of the transcription job. The user calling the StartTranscriptionJob operation must have permission to use the specified KMS key.

You can use either of the following to identify a KMS key in the current account:

  • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

  • KMS Key Alias: "alias/ExampleAlias"

You can use either of the following to identify a KMS key in the current account or another account:

  • Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef-1234567890ab"

  • ARN of a KMS Key Alias: "arn:aws:kms:region:account-ID:alias/ExampleAlias"

If you don't specify an encryption key, the output of the transcription job is encrypted with the default Amazon S3 key (SSE-S3).

If you specify a KMS key to encrypt your output, you must also specify an output location in the OutputBucketName parameter.

Definition at line 710 of file StartTranscriptionJobRequest.h.

◆ WithOutputEncryptionKMSKeyId() [3/3]

StartTranscriptionJobRequest& Aws::TranscribeService::Model::StartTranscriptionJobRequest::WithOutputEncryptionKMSKeyId ( const char *  value)
inline

The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service (KMS) key used to encrypt the output of the transcription job. The user calling the StartTranscriptionJob operation must have permission to use the specified KMS key.

You can use either of the following to identify a KMS key in the current account:

  • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

  • KMS Key Alias: "alias/ExampleAlias"

You can use either of the following to identify a KMS key in the current account or another account:

  • Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef-1234567890ab"

  • ARN of a KMS Key Alias: "arn:aws:kms:region:account-ID:alias/ExampleAlias"

If you don't specify an encryption key, the output of the transcription job is encrypted with the default Amazon S3 key (SSE-S3).

If you specify a KMS key to encrypt your output, you must also specify an output location in the OutputBucketName parameter.

Definition at line 748 of file StartTranscriptionJobRequest.h.

◆ WithOutputKey() [1/3]

StartTranscriptionJobRequest& Aws::TranscribeService::Model::StartTranscriptionJobRequest::WithOutputKey ( Aws::String &&  value)
inline

You can specify a location in an Amazon S3 bucket to store the output of your transcription job.

If you don't specify an output key, Amazon Transcribe stores the output of your transcription job in the Amazon S3 bucket you specified. By default, the object key is "your-transcription-job-name.json".

You can use output keys to specify the Amazon S3 prefix and file name of the transcription output. For example, specifying the Amazon S3 prefix, "folder1/folder2/", as an output key would lead to the output being stored as "folder1/folder2/your-transcription-job-name.json". If you specify "my-other-job-name.json" as the output key, the object key is changed to "my-other-job-name.json". You can use an output key to change both the prefix and the file name, for example "folder/my-other-job-name.json".

If you specify an output key, you must also specify an S3 bucket in the OutputBucketName parameter.

Definition at line 578 of file StartTranscriptionJobRequest.h.

◆ WithOutputKey() [2/3]

StartTranscriptionJobRequest& Aws::TranscribeService::Model::StartTranscriptionJobRequest::WithOutputKey ( const Aws::String value)
inline

You can specify a location in an Amazon S3 bucket to store the output of your transcription job.

If you don't specify an output key, Amazon Transcribe stores the output of your transcription job in the Amazon S3 bucket you specified. By default, the object key is "your-transcription-job-name.json".

You can use output keys to specify the Amazon S3 prefix and file name of the transcription output. For example, specifying the Amazon S3 prefix, "folder1/folder2/", as an output key would lead to the output being stored as "folder1/folder2/your-transcription-job-name.json". If you specify "my-other-job-name.json" as the output key, the object key is changed to "my-other-job-name.json". You can use an output key to change both the prefix and the file name, for example "folder/my-other-job-name.json".

If you specify an output key, you must also specify an S3 bucket in the OutputBucketName parameter.

Definition at line 561 of file StartTranscriptionJobRequest.h.

◆ WithOutputKey() [3/3]

StartTranscriptionJobRequest& Aws::TranscribeService::Model::StartTranscriptionJobRequest::WithOutputKey ( const char *  value)
inline

You can specify a location in an Amazon S3 bucket to store the output of your transcription job.

If you don't specify an output key, Amazon Transcribe stores the output of your transcription job in the Amazon S3 bucket you specified. By default, the object key is "your-transcription-job-name.json".

You can use output keys to specify the Amazon S3 prefix and file name of the transcription output. For example, specifying the Amazon S3 prefix, "folder1/folder2/", as an output key would lead to the output being stored as "folder1/folder2/your-transcription-job-name.json". If you specify "my-other-job-name.json" as the output key, the object key is changed to "my-other-job-name.json". You can use an output key to change both the prefix and the file name, for example "folder/my-other-job-name.json".

If you specify an output key, you must also specify an S3 bucket in the OutputBucketName parameter.

Definition at line 595 of file StartTranscriptionJobRequest.h.

◆ WithSettings() [1/2]

StartTranscriptionJobRequest& Aws::TranscribeService::Model::StartTranscriptionJobRequest::WithSettings ( const Settings value)
inline

A Settings object that provides optional settings for a transcription job.

Definition at line 858 of file StartTranscriptionJobRequest.h.

◆ WithSettings() [2/2]

StartTranscriptionJobRequest& Aws::TranscribeService::Model::StartTranscriptionJobRequest::WithSettings ( Settings &&  value)
inline

A Settings object that provides optional settings for a transcription job.

Definition at line 864 of file StartTranscriptionJobRequest.h.

◆ WithSubtitles() [1/2]

StartTranscriptionJobRequest& Aws::TranscribeService::Model::StartTranscriptionJobRequest::WithSubtitles ( const Subtitles value)
inline

Add subtitles to your batch transcription job.

Definition at line 1113 of file StartTranscriptionJobRequest.h.

◆ WithSubtitles() [2/2]

StartTranscriptionJobRequest& Aws::TranscribeService::Model::StartTranscriptionJobRequest::WithSubtitles ( Subtitles &&  value)
inline

Add subtitles to your batch transcription job.

Definition at line 1118 of file StartTranscriptionJobRequest.h.

◆ WithTags() [1/2]

StartTranscriptionJobRequest& Aws::TranscribeService::Model::StartTranscriptionJobRequest::WithTags ( Aws::Vector< Tag > &&  value)
inline

Add tags to an Amazon Transcribe transcription job.

Definition at line 1149 of file StartTranscriptionJobRequest.h.

◆ WithTags() [2/2]

StartTranscriptionJobRequest& Aws::TranscribeService::Model::StartTranscriptionJobRequest::WithTags ( const Aws::Vector< Tag > &  value)
inline

Add tags to an Amazon Transcribe transcription job.

Definition at line 1144 of file StartTranscriptionJobRequest.h.

◆ WithTranscriptionJobName() [1/3]

StartTranscriptionJobRequest& Aws::TranscribeService::Model::StartTranscriptionJobRequest::WithTranscriptionJobName ( Aws::String &&  value)
inline

The name of the job. You can't use the strings "<code>.</code>" or "<code>..</code>" by themselves as the job name. The name must also be unique within an Amazon Web Services account. If you try to create a transcription job with the same name as a previous transcription job, you get a ConflictException error.

Definition at line 110 of file StartTranscriptionJobRequest.h.

◆ WithTranscriptionJobName() [2/3]

StartTranscriptionJobRequest& Aws::TranscribeService::Model::StartTranscriptionJobRequest::WithTranscriptionJobName ( const Aws::String value)
inline

The name of the job. You can't use the strings "<code>.</code>" or "<code>..</code>" by themselves as the job name. The name must also be unique within an Amazon Web Services account. If you try to create a transcription job with the same name as a previous transcription job, you get a ConflictException error.

Definition at line 101 of file StartTranscriptionJobRequest.h.

◆ WithTranscriptionJobName() [3/3]

StartTranscriptionJobRequest& Aws::TranscribeService::Model::StartTranscriptionJobRequest::WithTranscriptionJobName ( const char *  value)
inline

The name of the job. You can't use the strings "<code>.</code>" or "<code>..</code>" by themselves as the job name. The name must also be unique within an Amazon Web Services account. If you try to create a transcription job with the same name as a previous transcription job, you get a ConflictException error.

Definition at line 119 of file StartTranscriptionJobRequest.h.


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