NAME
Paws::Transcribe::StartTranscriptionJob - Arguments for method StartTranscriptionJob on Paws::Transcribe
DESCRIPTION
This class represents the parameters used for calling the method StartTranscriptionJob on the Amazon Transcribe Service service. Use the attributes of this class as arguments to method StartTranscriptionJob.
You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartTranscriptionJob.
SYNOPSIS
my $transcribe = Paws->service('Transcribe');
my $StartTranscriptionJobResponse = $transcribe->StartTranscriptionJob(
LanguageCode => 'en-US',
Media => {
MediaFileUri => 'MyUri', # min: 1, max: 2000; OPTIONAL
},
TranscriptionJobName => 'MyTranscriptionJobName',
JobExecutionSettings => {
AllowDeferredExecution => 1, # OPTIONAL
DataAccessRoleArn => 'MyDataAccessRoleArn', # OPTIONAL
}, # OPTIONAL
MediaFormat => 'mp3', # OPTIONAL
MediaSampleRateHertz => 1, # OPTIONAL
OutputBucketName => 'MyOutputBucketName', # OPTIONAL
OutputEncryptionKMSKeyId => 'MyKMSKeyId', # OPTIONAL
Settings => {
ChannelIdentification => 1, # OPTIONAL
MaxAlternatives => 1, # min: 2, max: 10; OPTIONAL
MaxSpeakerLabels => 1, # min: 2, max: 10; OPTIONAL
ShowAlternatives => 1, # OPTIONAL
ShowSpeakerLabels => 1, # OPTIONAL
VocabularyFilterMethod => 'remove', # values: remove, mask; OPTIONAL
VocabularyFilterName =>
'MyVocabularyFilterName', # min: 1, max: 200; OPTIONAL
VocabularyName => 'MyVocabularyName', # min: 1, max: 200; OPTIONAL
}, # OPTIONAL
);
# Results:
my $TranscriptionJob = $StartTranscriptionJobResponse->TranscriptionJob;
# Returns a L<Paws::Transcribe::StartTranscriptionJobResponse> object.Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/transcribe/StartTranscriptionJob
ATTRIBUTES
JobExecutionSettings => Paws::Transcribe::JobExecutionSettings
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.
REQUIRED LanguageCode => Str
The language code for the language used in the input media file.
Valid values are: "en-US", "es-US", "en-AU", "fr-CA", "en-GB", "de-DE", "pt-BR", "fr-FR", "it-IT", "ko-KR", "es-ES", "en-IN", "hi-IN", "ar-SA", "ru-RU", "zh-CN", "nl-NL", "id-ID", "ta-IN", "fa-IR", "en-IE", "en-AB", "en-WL", "pt-PT", "te-IN", "tr-TR", "de-CH", "he-IL", "ms-MY", "ja-JP", "ar-AE"
REQUIRED Media => Paws::Transcribe::Media
An object that describes the input media for a transcription job.
MediaFormat => Str
The format of the input media file.
Valid values are: "mp3", "mp4", "wav", "flac"
MediaSampleRateHertz => Int
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.
OutputBucketName => Str
The location where the transcription is stored.
If you set the OutputBucketName, Amazon Transcribe puts the transcription in the specified S3 bucket. When you call the GetTranscriptionJob operation, the operation returns this location in the TranscriptFileUri field. 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 (https://docs.aws.amazon.com/transcribe/latest/dg/security_iam_id-based-policy-examples.html#auth-role-iam-user).
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.
OutputEncryptionKMSKeyId => Str
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.
Settings => Paws::Transcribe::Settings
A Settings object that provides optional settings for a transcription job.
REQUIRED TranscriptionJobName => Str
The name of the job. Note that you can't use the strings "." or ".." by themselves as the job name. The name must also be unique within an AWS account.
SEE ALSO
This class forms part of Paws, documenting arguments for method StartTranscriptionJob in Paws::Transcribe
BUGS and CONTRIBUTIONS
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues