Class: Aws::TranscribeService::Types::StartMedicalTranscriptionJobRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-transcribeservice/types.rb

Overview

Note:

When making an API call, you may pass StartMedicalTranscriptionJobRequest data as a hash:

{
  medical_transcription_job_name: "TranscriptionJobName", # required
  language_code: "af-ZA", # required, accepts af-ZA, ar-AE, ar-SA, cy-GB, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, ga-IE, gd-GB, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN
  media_sample_rate_hertz: 1,
  media_format: "mp3", # accepts mp3, mp4, wav, flac, ogg, amr, webm
  media: { # required
    media_file_uri: "Uri",
  },
  output_bucket_name: "OutputBucketName", # required
  output_key: "OutputKey",
  output_encryption_kms_key_id: "KMSKeyId",
  settings: {
    show_speaker_labels: false,
    max_speaker_labels: 1,
    channel_identification: false,
    show_alternatives: false,
    max_alternatives: 1,
    vocabulary_name: "VocabularyName",
  },
  content_identification_type: "PHI", # accepts PHI
  specialty: "PRIMARYCARE", # required, accepts PRIMARYCARE
  type: "CONVERSATION", # required, accepts CONVERSATION, DICTATION
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#content_identification_typeString

You can configure Amazon Transcribe Medical to label content in the transcription output. If you specify `PHI`, Amazon Transcribe Medical labels the personal health information (PHI) that it identifies in the transcription output.

Returns:

  • (String)

2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
# File 'lib/aws-sdk-transcribeservice/types.rb', line 2056

class StartMedicalTranscriptionJobRequest < Struct.new(
  :medical_transcription_job_name,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :output_bucket_name,
  :output_key,
  :output_encryption_kms_key_id,
  :settings,
  :content_identification_type,
  :specialty,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#language_codeString

The language code for the language spoken in the input media file. US English (en-US) is the valid value for medical transcription jobs. Any other value you enter for language code results in a `BadRequestException` error.

Returns:

  • (String)

2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
# File 'lib/aws-sdk-transcribeservice/types.rb', line 2056

class StartMedicalTranscriptionJobRequest < Struct.new(
  :medical_transcription_job_name,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :output_bucket_name,
  :output_key,
  :output_encryption_kms_key_id,
  :settings,
  :content_identification_type,
  :specialty,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#mediaTypes::Media

Describes the input media file in a transcription request.

Returns:


2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
# File 'lib/aws-sdk-transcribeservice/types.rb', line 2056

class StartMedicalTranscriptionJobRequest < Struct.new(
  :medical_transcription_job_name,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :output_bucket_name,
  :output_key,
  :output_encryption_kms_key_id,
  :settings,
  :content_identification_type,
  :specialty,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#media_formatString

The audio format of the input media file.

Returns:

  • (String)

2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
# File 'lib/aws-sdk-transcribeservice/types.rb', line 2056

class StartMedicalTranscriptionJobRequest < Struct.new(
  :medical_transcription_job_name,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :output_bucket_name,
  :output_key,
  :output_encryption_kms_key_id,
  :settings,
  :content_identification_type,
  :specialty,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#media_sample_rate_hertzInteger

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 Medical determines the sample rate. If you specify the sample rate, it must match the rate detected by Amazon Transcribe Medical. In most cases, you should leave the `MediaSampleRateHertz` field blank and let Amazon Transcribe Medical determine the sample rate.

Returns:

  • (Integer)

2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
# File 'lib/aws-sdk-transcribeservice/types.rb', line 2056

class StartMedicalTranscriptionJobRequest < Struct.new(
  :medical_transcription_job_name,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :output_bucket_name,
  :output_key,
  :output_encryption_kms_key_id,
  :settings,
  :content_identification_type,
  :specialty,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#medical_transcription_job_nameString

The name of the medical transcription 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 medical transcription job with the same name as a previous medical transcription job, you get a `ConflictException` error.

Returns:

  • (String)

2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
# File 'lib/aws-sdk-transcribeservice/types.rb', line 2056

class StartMedicalTranscriptionJobRequest < Struct.new(
  :medical_transcription_job_name,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :output_bucket_name,
  :output_key,
  :output_encryption_kms_key_id,
  :settings,
  :content_identification_type,
  :specialty,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#output_bucket_nameString

The Amazon S3 location where the transcription is stored.

You must set `OutputBucketName` for Amazon Transcribe Medical to store the transcription results. Your transcript appears in the S3 location you specify. When you call the GetMedicalTranscriptionJob, the operation returns this location in the `TranscriptFileUri` field. The S3 bucket must have permissions that allow Amazon Transcribe Medical 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 Medical uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.

[1]: docs.aws.amazon.com/transcribe/latest/dg/security_iam_id-based-policy-examples.html#auth-role-iam-user

Returns:

  • (String)

2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
# File 'lib/aws-sdk-transcribeservice/types.rb', line 2056

class StartMedicalTranscriptionJobRequest < Struct.new(
  :medical_transcription_job_name,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :output_bucket_name,
  :output_key,
  :output_encryption_kms_key_id,
  :settings,
  :content_identification_type,
  :specialty,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#output_encryption_kms_key_idString

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 StartMedicalTranscriptionJob operation must have permission to use the specified KMS key.

You 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 in the current account or another account: “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 medical 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.

Returns:

  • (String)

2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
# File 'lib/aws-sdk-transcribeservice/types.rb', line 2056

class StartMedicalTranscriptionJobRequest < Struct.new(
  :medical_transcription_job_name,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :output_bucket_name,
  :output_key,
  :output_encryption_kms_key_id,
  :settings,
  :content_identification_type,
  :specialty,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#output_keyString

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

If you don't specify an output key, Amazon Transcribe Medical 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.

Returns:

  • (String)

2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
# File 'lib/aws-sdk-transcribeservice/types.rb', line 2056

class StartMedicalTranscriptionJobRequest < Struct.new(
  :medical_transcription_job_name,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :output_bucket_name,
  :output_key,
  :output_encryption_kms_key_id,
  :settings,
  :content_identification_type,
  :specialty,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#settingsTypes::MedicalTranscriptionSetting

Optional settings for the medical transcription job.


2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
# File 'lib/aws-sdk-transcribeservice/types.rb', line 2056

class StartMedicalTranscriptionJobRequest < Struct.new(
  :medical_transcription_job_name,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :output_bucket_name,
  :output_key,
  :output_encryption_kms_key_id,
  :settings,
  :content_identification_type,
  :specialty,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#specialtyString

The medical specialty of any clinician speaking in the input media.

Returns:

  • (String)

2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
# File 'lib/aws-sdk-transcribeservice/types.rb', line 2056

class StartMedicalTranscriptionJobRequest < Struct.new(
  :medical_transcription_job_name,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :output_bucket_name,
  :output_key,
  :output_encryption_kms_key_id,
  :settings,
  :content_identification_type,
  :specialty,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#typeString

The type of speech in the input audio. `CONVERSATION` refers to conversations between two or more speakers, e.g., a conversations between doctors and patients. `DICTATION` refers to single-speaker dictated speech, e.g., for clinical notes.

Returns:

  • (String)

2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
# File 'lib/aws-sdk-transcribeservice/types.rb', line 2056

class StartMedicalTranscriptionJobRequest < Struct.new(
  :medical_transcription_job_name,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :output_bucket_name,
  :output_key,
  :output_encryption_kms_key_id,
  :settings,
  :content_identification_type,
  :specialty,
  :type)
  SENSITIVE = []
  include Aws::Structure
end