AWSTranscribeStartTranscriptionJobRequest

Objective-C

@interface AWSTranscribeStartTranscriptionJobRequest

Swift

class AWSTranscribeStartTranscriptionJobRequest
  • An object that contains the request parameters for content redaction.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSTranscribeContentRedaction *_Nullable contentRedaction;

    Swift

    var contentRedaction: AWSTranscribeContentRedaction? { get set }
  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable identifyLanguage;

    Swift

    var identifyLanguage: NSNumber? { get set }
  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSTranscribeJobExecutionSettings *_Nullable jobExecutionSettings;

    Swift

    var jobExecutionSettings: AWSTranscribeJobExecutionSettings? { get set }
  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDictionary<NSString *, NSString *> *_Nullable KMSEncryptionContext;

    Swift

    var kmsEncryptionContext: [String : String]? { get set }
  • 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.

    Declaration

    Objective-C

    @property (nonatomic) AWSTranscribeLanguageCode languageCode;

    Swift

    var languageCode: AWSTranscribeLanguageCode { get set }
  • The language identification settings associated with your transcription job. These settings include VocabularyName, VocabularyFilterName, and LanguageModelName.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDictionary<NSString *, AWSTranscribeLanguageIdSettings *> *_Nullable languageIdSettings;

    Swift

    var languageIdSettings: [String : AWSTranscribeLanguageIdSettings]? { get set }
  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<NSString *> *_Nullable languageOptions;

    Swift

    var languageOptions: [String]? { get set }
  • An object that describes the input media for a transcription job.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSTranscribeMedia *_Nullable media;

    Swift

    var media: AWSTranscribeMedia? { get set }
  • The format of the input media file.

    Declaration

    Objective-C

    @property (nonatomic) AWSTranscribeMediaFormat mediaFormat;

    Swift

    var mediaFormat: AWSTranscribeMediaFormat { get set }
  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable mediaSampleRateHertz;

    Swift

    var mediaSampleRateHertz: NSNumber? { get set }
  • Choose the custom language model you use for your transcription job in this parameter.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSTranscribeModelSettings *_Nullable modelSettings;

    Swift

    var modelSettings: AWSTranscribeModelSettings? { get set }
  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable outputBucketName;

    Swift

    var outputBucketName: String? { get set }
  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable outputEncryptionKMSKeyId;

    Swift

    var outputEncryptionKMSKeyId: String? { get set }
  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable outputKey;

    Swift

    var outputKey: String? { get set }
  • A Settings object that provides optional settings for a transcription job.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSTranscribeSettings *_Nullable settings;

    Swift

    var settings: AWSTranscribeSettings? { get set }
  • Add subtitles to your batch transcription job.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSTranscribeSubtitles *_Nullable subtitles;

    Swift

    var subtitles: AWSTranscribeSubtitles? { get set }
  • Add tags to an Amazon Transcribe transcription job.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<AWSTranscribeTag *> *_Nullable tags;

    Swift

    var tags: [AWSTranscribeTag]? { get set }
  • The name of the job. You can’t use the strings “.” or “..” 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable transcriptionJobName;

    Swift

    var transcriptionJobName: String? { get set }