AWS SDK for C++  1.9.44
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 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)
 
- 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 29 of file StartTranscriptionJobRequest.h.

Constructor & Destructor Documentation

◆ StartTranscriptionJobRequest()

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

Member Function Documentation

◆ 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.

Definition at line 981 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.

Definition at line 988 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 878 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 873 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 907 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 827 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 16000 Hz or higher.

Definition at line 123 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.

Definition at line 939 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 236 of file StartTranscriptionJobRequest.h.

◆ GetMediaFormat()

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

The format of the input media file.

Definition at line 205 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 169 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 788 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 AWS 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 286 of file StartTranscriptionJobRequest.h.

◆ GetOutputEncryptionKMSKeyId()

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

The Amazon Resource Name (ARN) of the AWS 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 611 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 472 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 38 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 751 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 AWS 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 52 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 915 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 835 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 16000 Hz or higher.

Definition at line 130 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.

Definition at line 946 of file StartTranscriptionJobRequest.h.

◆ MediaFormatHasBeenSet()

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

The format of the input media file.

Definition at line 210 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 241 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 179 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 794 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 AWS 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 310 of file StartTranscriptionJobRequest.h.

◆ OutputEncryptionKMSKeyIdHasBeenSet()

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

The Amazon Resource Name (ARN) of the AWS 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 630 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 489 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 883 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 888 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 923 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 843 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 851 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 16000 Hz or higher.

Definition at line 137 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 16000 Hz or higher.

Definition at line 144 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.

Definition at line 960 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.

Definition at line 953 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 246 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 251 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 215 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 220 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 189 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 800 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 806 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 AWS 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 358 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 AWS 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 334 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 AWS 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 382 of file StartTranscriptionJobRequest.h.

◆ SetOutputEncryptionKMSKeyId() [1/3]

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

The Amazon Resource Name (ARN) of the AWS 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 668 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 AWS 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 649 of file StartTranscriptionJobRequest.h.

◆ SetOutputEncryptionKMSKeyId() [3/3]

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

The Amazon Resource Name (ARN) of the AWS 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 687 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 523 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 506 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 540 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 763 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 769 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 757 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 AWS 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 79 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 AWS 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 70 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 AWS 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 88 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 AWS 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 61 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 893 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 898 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 931 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 859 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 867 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 16000 Hz or higher.

Definition at line 151 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 16000 Hz or higher.

Definition at line 158 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.

Definition at line 974 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.

Definition at line 967 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 256 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 261 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 225 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 230 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 199 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 812 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 818 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 AWS 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 430 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 AWS 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 406 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 AWS 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 454 of file StartTranscriptionJobRequest.h.

◆ WithOutputEncryptionKMSKeyId() [1/3]

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

The Amazon Resource Name (ARN) of the AWS 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 725 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 AWS 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 706 of file StartTranscriptionJobRequest.h.

◆ WithOutputEncryptionKMSKeyId() [3/3]

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

The Amazon Resource Name (ARN) of the AWS 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 744 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 574 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 557 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 591 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 775 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 781 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 AWS 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 106 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 AWS 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 97 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 AWS 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 115 of file StartTranscriptionJobRequest.h.


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