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

Inherits:

Struct

Object
Struct
Aws::TranscribeService::Types::StartMedicalTranscriptionJobRequest

show all

Includes:: Structure

Defined in:: lib/aws-sdk-transcribeservice/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#content_identification_type ⇒ String

Labels all personal health information (PHI) identified in your transcript.
#kms_encryption_context ⇒ Hash<String,String>

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.
#language_code ⇒ String

The language code that represents the language spoken in the input media file.
#media ⇒ Types::Media

Describes the Amazon S3 location of the media file you want to use in your request.
#media_format ⇒ String

Specify the format of your input media file.
#media_sample_rate_hertz ⇒ Integer

The sample rate, in hertz, of the audio track in your input media file.
#medical_transcription_job_name ⇒ String

A unique name, chosen by you, for your medical transcription job.
#output_bucket_name ⇒ String

The name of the Amazon S3 bucket where you want your medical transcription output stored.
#output_encryption_kms_key_id ⇒ String

The KMS key you want to use to encrypt your medical transcription output.
#output_key ⇒ String

Use in combination with ‘OutputBucketName` to specify the output location of your transcript and, optionally, a unique name for your output file.
#settings ⇒ Types::MedicalTranscriptionSetting

Specify additional optional settings in your request, including channel identification, alternative transcriptions, and speaker partitioning.
#specialty ⇒ String

Specify the predominant medical specialty represented in your media.
#tags ⇒ Array<Types::Tag>

Adds one or more custom tags, each in the form of a key:value pair, to a new medical transcription job at the time you start this new job.
#type ⇒ String

Specify whether your input media contains only one person (‘DICTATION`) or contains a conversation between two people (`CONVERSATION`).

Instance Attribute Details

#content_identification_type ⇒ `String`

Labels all personal health information (PHI) identified in your transcript. For more information, see [Identifying personal health information (PHI) in a transcription].

[1]: docs.aws.amazon.com/transcribe/latest/dg/phi-id.html

Returns:

(String)

# File 'lib/aws-sdk-transcribeservice/types.rb', line 3731

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,
  :kms_encryption_context,
  :settings,
  :content_identification_type,
  :specialty,
  :type,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#kms_encryption_context ⇒ `Hash<String,String>`

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. For more information, see [KMS encryption context] and [Asymmetric keys in KMS].

[1]: docs.aws.amazon.com/transcribe/latest/dg/key-management.html#kms-context [2]: docs.aws.amazon.com/transcribe/latest/dg/symmetric-asymmetric.html

Returns:

(Hash<String,String>)

# File 'lib/aws-sdk-transcribeservice/types.rb', line 3731

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,
  :kms_encryption_context,
  :settings,
  :content_identification_type,
  :specialty,
  :type,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#language_code ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-transcribeservice/types.rb', line 3731

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,
  :kms_encryption_context,
  :settings,
  :content_identification_type,
  :specialty,
  :type,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#media ⇒ `Types::Media`

Describes the Amazon S3 location of the media file you want to use in your request.

For information on supported media formats, refer to the

MediaFormat][1: parameter or the [Media formats] section in the

Amazon S3 Developer Guide.

[1]: docs.aws.amazon.com/APIReference/API_StartTranscriptionJob.html#transcribe-StartTranscriptionJob-request-MediaFormat [2]: docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio

Returns:

(Types::Media)

# File 'lib/aws-sdk-transcribeservice/types.rb', line 3731

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,
  :kms_encryption_context,
  :settings,
  :content_identification_type,
  :specialty,
  :type,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#media_format ⇒ `String`

Specify the format of your input media file.

Returns:

(String)

# File 'lib/aws-sdk-transcribeservice/types.rb', line 3731

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,
  :kms_encryption_context,
  :settings,
  :content_identification_type,
  :specialty,
  :type,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#media_sample_rate_hertz ⇒ `Integer`

The sample rate, in hertz, of the audio track in your input media file.

If you don’t specify the media sample rate, Amazon Transcribe Medical determines it for you. If you specify the sample rate, it must match the rate detected by Amazon Transcribe Medical; if there’s a mismatch between the value that you specify and the value detected, your job fails. Therefore, in most cases, it’s advised to omit ‘MediaSampleRateHertz` and let Amazon Transcribe Medical determine the sample rate.

Returns:

(Integer)

# File 'lib/aws-sdk-transcribeservice/types.rb', line 3731

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,
  :kms_encryption_context,
  :settings,
  :content_identification_type,
  :specialty,
  :type,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#medical_transcription_job_name ⇒ `String`

A unique name, chosen by you, for your medical transcription job. The name that you specify is also used as the default name of your transcription output file. If you want to specify a different name for your transcription output, use the ‘OutputKey` parameter.

This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a new job with the same name as an existing job, you get a ‘ConflictException` error.

Returns:

(String)

# File 'lib/aws-sdk-transcribeservice/types.rb', line 3731

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,
  :kms_encryption_context,
  :settings,
  :content_identification_type,
  :specialty,
  :type,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#output_bucket_name ⇒ `String`

The name of the Amazon S3 bucket where you want your medical transcription output stored. Do not include the ‘S3://` prefix of the specified bucket.

If you want your output to go to a sub-folder of this bucket, specify it using the ‘OutputKey` parameter; `OutputBucketName` only accepts the name of a bucket.

For example, if you want your output stored in ‘S3://DOC-EXAMPLE-BUCKET`, set `OutputBucketName` to `DOC-EXAMPLE-BUCKET`. However, if you want your output stored in `S3://DOC-EXAMPLE-BUCKET/test-files/`, set `OutputBucketName` to `DOC-EXAMPLE-BUCKET` and `OutputKey` to `test-files/`.

Note that Amazon Transcribe must have permission to use the specified location. You can change Amazon S3 permissions using the [Amazon Web Services Management Console]. See also [Permissions Required for IAM User Roles].

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

Returns:

(String)

# File 'lib/aws-sdk-transcribeservice/types.rb', line 3731

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,
  :kms_encryption_context,
  :settings,
  :content_identification_type,
  :specialty,
  :type,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#output_encryption_kms_key_id ⇒ `String`

The KMS key you want to use to encrypt your medical transcription output.

If using a key located in the current Amazon Web Services account, you can specify your KMS key in one of four ways:

Use the KMS key ID itself. For example, ‘1234abcd-12ab-34cd-56ef-1234567890ab`.
Use an alias for the KMS key ID. For example, ‘alias/ExampleAlias`.
Use the Amazon Resource Name (ARN) for the KMS key ID. For example, ‘arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab`.
Use the ARN for the KMS key alias. For example, ‘arn:aws:kms:region:account-ID:alias/ExampleAlias`.

If using a key located in a different Amazon Web Services account than the current Amazon Web Services account, you can specify your KMS key in one of two ways:

Use the ARN for the KMS key ID. For example, ‘arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab`.
Use the ARN for the KMS key alias. For example, ‘arn:aws:kms:region:account-ID:alias/ExampleAlias`.

If you don’t specify an encryption key, your output 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 using the ‘OutputLocation` parameter.

Note that the role making the request must have permission to use the specified KMS key.

Returns:

(String)

# File 'lib/aws-sdk-transcribeservice/types.rb', line 3731

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,
  :kms_encryption_context,
  :settings,
  :content_identification_type,
  :specialty,
  :type,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#output_key ⇒ `String`

Use in combination with ‘OutputBucketName` to specify the output location of your transcript and, optionally, a unique name for your output file. The default name for your transcription output is the same as the name you specified for your medical transcription job (`MedicalTranscriptionJobName`).

Here are some examples of how you can use ‘OutputKey`:

If you specify ‘DOC-EXAMPLE-BUCKET’ as the ‘OutputBucketName` and ’my-transcript.json’ as the ‘OutputKey`, your transcription output path is `s3://DOC-EXAMPLE-BUCKET/my-transcript.json`.
If you specify ‘my-first-transcription’ as the ‘MedicalTranscriptionJobName`, ’DOC-EXAMPLE-BUCKET’ as the ‘OutputBucketName`, and ’my-transcript’ as the ‘OutputKey`, your transcription output path is `s3://DOC-EXAMPLE-BUCKET/my-transcript/my-first-transcription.json`.
If you specify ‘DOC-EXAMPLE-BUCKET’ as the ‘OutputBucketName` and ’test-files/my-transcript.json’ as the ‘OutputKey`, your transcription output path is `s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json`.
If you specify ‘my-first-transcription’ as the ‘MedicalTranscriptionJobName`, ’DOC-EXAMPLE-BUCKET’ as the ‘OutputBucketName`, and ’test-files/my-transcript’ as the ‘OutputKey`, your transcription output path is `s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript/my-first-transcription.json`.

If you specify the name of an Amazon S3 bucket sub-folder that doesn’t exist, one is created for you.

Returns:

(String)

# File 'lib/aws-sdk-transcribeservice/types.rb', line 3731

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,
  :kms_encryption_context,
  :settings,
  :content_identification_type,
  :specialty,
  :type,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#settings ⇒ `Types::MedicalTranscriptionSetting`

Specify additional optional settings in your request, including channel identification, alternative transcriptions, and speaker partitioning. You can use that to apply custom vocabularies to your transcription job.

Returns:

(Types::MedicalTranscriptionSetting)

# File 'lib/aws-sdk-transcribeservice/types.rb', line 3731

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,
  :kms_encryption_context,
  :settings,
  :content_identification_type,
  :specialty,
  :type,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#specialty ⇒ `String`

Specify the predominant medical specialty represented in your media. For batch transcriptions, ‘PRIMARYCARE` is the only valid value. If you require additional specialties, refer to .

Returns:

(String)

# File 'lib/aws-sdk-transcribeservice/types.rb', line 3731

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,
  :kms_encryption_context,
  :settings,
  :content_identification_type,
  :specialty,
  :type,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ `Array<Types::Tag>`

Adds one or more custom tags, each in the form of a key:value pair, to a new medical transcription job at the time you start this new job.

To learn more about using tags with Amazon Transcribe, refer to [Tagging resources].

[1]: docs.aws.amazon.com/transcribe/latest/dg/tagging.html

Returns:

(Array<Types::Tag>)

# File 'lib/aws-sdk-transcribeservice/types.rb', line 3731

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,
  :kms_encryption_context,
  :settings,
  :content_identification_type,
  :specialty,
  :type,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ `String`

Specify whether your input media contains only one person (‘DICTATION`) or contains a conversation between two people (`CONVERSATION`).

For example, ‘DICTATION` could be used for a medical professional wanting to transcribe voice memos; `CONVERSATION` could be used for transcribing the doctor-patient dialogue during the patient’s office visit.

Returns:

(String)

# File 'lib/aws-sdk-transcribeservice/types.rb', line 3731

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,
  :kms_encryption_context,
  :settings,
  :content_identification_type,
  :specialty,
  :type,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#content_identification_type ⇒ String

#kms_encryption_context ⇒ Hash<String,String>

#language_code ⇒ String

#media ⇒ Types::Media

#media_format ⇒ String

#media_sample_rate_hertz ⇒ Integer

#medical_transcription_job_name ⇒ String

#output_bucket_name ⇒ String

#output_encryption_kms_key_id ⇒ String

#output_key ⇒ String

#settings ⇒ Types::MedicalTranscriptionSetting

#specialty ⇒ String

#tags ⇒ Array<Types::Tag>

#type ⇒ String

#content_identification_type ⇒ `String`

#kms_encryption_context ⇒ `Hash<String,String>`

#language_code ⇒ `String`

#media ⇒ `Types::Media`

#media_format ⇒ `String`

#media_sample_rate_hertz ⇒ `Integer`

#medical_transcription_job_name ⇒ `String`

#output_bucket_name ⇒ `String`

#output_encryption_kms_key_id ⇒ `String`

#output_key ⇒ `String`

#settings ⇒ `Types::MedicalTranscriptionSetting`

#specialty ⇒ `String`

#tags ⇒ `Array<Types::Tag>`

#type ⇒ `String`