StartTranscriptionJobRequest

public struct StartTranscriptionJobRequest : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

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

    Declaration

    Swift

    public let contentRedaction: ContentRedaction?

  • 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

    Swift

    public let jobExecutionSettings: JobExecutionSettings?

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

    Declaration

    Swift

    public let languageCode: LanguageCode

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

    Declaration

    Swift

    public let media: Media

  • The format of the input media file.

    Declaration

    Swift

    public let mediaFormat: MediaFormat?

  • 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

    Swift

    public let mediaSampleRateHertz: Int?

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

    Declaration

    Swift

    public let modelSettings: ModelSettings?

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

    Declaration

    Swift

    public let outputBucketName: String?

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

    Declaration

    Swift

    public let outputEncryptionKMSKeyId: String?

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

    Declaration

    Swift

    public let settings: Settings?

  • 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 AWS account. If you try to create a transcription job with the same name as a previous transcription job, you get a ConflictException error.

    Declaration

    Swift

    public let transcriptionJobName: String

  • Undocumented

    Declaration

    Swift

    public init(contentRedaction: ContentRedaction? = nil, jobExecutionSettings: JobExecutionSettings? = nil, languageCode: LanguageCode, media: Media, mediaFormat: MediaFormat? = nil, mediaSampleRateHertz: Int? = nil, modelSettings: ModelSettings? = nil, outputBucketName: String? = nil, outputEncryptionKMSKeyId: String? = nil, settings: Settings? = nil, transcriptionJobName: String)

  • Declaration

    Swift

    public func validate(name: String) throws