Module aws_sdk_transcribe::model

Data structures used by operation inputs/outputs. Documentation on these types is copied from the model.

Modules

absolute_time_range

See AbsoluteTimeRange.

call_analytics_job

See CallAnalyticsJob.

call_analytics_job_settings

See CallAnalyticsJobSettings.

call_analytics_job_summary

See CallAnalyticsJobSummary.

category_properties

See CategoryProperties.

channel_definition

See ChannelDefinition.

content_redaction

See ContentRedaction.

input_data_config

See InputDataConfig.

interruption_filter

See InterruptionFilter.

job_execution_settings

See JobExecutionSettings.

language_code_item

See LanguageCodeItem.

language_id_settings

See LanguageIdSettings.

language_model

See LanguageModel.

media

See Media.

medical_transcript

See MedicalTranscript.

medical_transcription_job

See MedicalTranscriptionJob.

medical_transcription_job_summary

See MedicalTranscriptionJobSummary.

medical_transcription_setting

See MedicalTranscriptionSetting.

model_settings

See ModelSettings.

non_talk_time_filter

See NonTalkTimeFilter.

relative_time_range

See RelativeTimeRange.

sentiment_filter

See SentimentFilter.

settings

See Settings.

subtitles

See Subtitles.

subtitles_output

See SubtitlesOutput.

tag

See Tag.

transcript

See Transcript.

transcript_filter

See TranscriptFilter.

transcription_job

See TranscriptionJob.

transcription_job_summary

See TranscriptionJobSummary.

vocabulary_filter_info

See VocabularyFilterInfo.

vocabulary_info

See VocabularyInfo.

Structs

AbsoluteTimeRange

A time range, in milliseconds, between two points in your media file.

CallAnalyticsJob

Provides detailed information about a Call Analytics job.

CallAnalyticsJobSettings

Provides additional optional settings for your request, including content redaction, automatic language identification; allows you to apply custom language models, vocabulary filters, and custom vocabularies.

CallAnalyticsJobSummary

Provides detailed information about a specific Call Analytics job.

CategoryProperties

Provides you with the properties of the Call Analytics category you specified in your request. This includes the list of rules that define the specified category.

ChannelDefinition

Allows you to specify which speaker is on which channel. For example, if your agent is the first participant to speak, you would set ChannelId to 0 (to indicate the first channel) and ParticipantRole to AGENT (to indicate that it's the agent speaking).

ContentRedaction

Allows you to redact or flag specified personally identifiable information (PII) in your transcript. If you use ContentRedaction, you must also include the sub-parameters: PiiEntityTypes, RedactionOutput, and RedactionType.

InputDataConfig

Contains the Amazon S3 location of the training data you want to use to create a new custom language model, and permissions to access this location.

InterruptionFilter

Flag the presence or absence of interruptions in your Call Analytics transcription output.

JobExecutionSettings

Allows you to control how your transcription job is processed. Currently, the only JobExecutionSettings modification you can choose is enabling job queueing using the AllowDeferredExecution sub-parameter.

LanguageCodeItem

Provides information on the speech contained in a discreet utterance when multi-language identification is enabled in your request. This utterance represents a block of speech consisting of one language, preceded or followed by a block of speech in a different language.

LanguageIdSettings

If using automatic language identification (IdentifyLanguage) in your request and you want to apply a custom language model, a custom vocabulary, or a custom vocabulary filter, include LanguageIdSettings with the relevant sub-parameters (VocabularyName, LanguageModelName, and VocabularyFilterName).

LanguageModel

Provides information about a custom language model, including the base model name, when the model was created, the location of the files used to train the model, when the model was last modified, the name you chose for the model, its language, its processing state, and if there is an upgrade available for the base model.

Media

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

MedicalTranscript

Provides you with the Amazon S3 URI you can use to access your transcript.

MedicalTranscriptionJob

Provides detailed information about a medical transcription job.

MedicalTranscriptionJobSummary

Provides detailed information about a specific medical transcription job.

MedicalTranscriptionSetting

Allows additional optional settings in your request, including channel identification, alternative transcriptions, and speaker labeling; allows you to apply custom vocabularies to your medical transcription job.

ModelSettings

Provides the name of the custom language model that was included in the specified transcription job.

NonTalkTimeFilter

Flag the presence or absence of periods of silence in your Call Analytics transcription output.

RelativeTimeRange

A time range, in percentage, between two points in your media file.

SentimentFilter

Flag the presence or absence of specific sentiments detected in your Call Analytics transcription output.

Settings

Allows additional optional settings in your request, including channel identification, alternative transcriptions, and speaker labeling; allows you to apply custom vocabularies to your transcription job.

Subtitles

Generate subtitles for your media file with your transcription request.

SubtitlesOutput

Provides information about your subtitle file, including format, start index, and Amazon S3 location.

Tag

Adds metadata, in the form of a key:value pair, to the specified resource.

Transcript

Provides you with the Amazon S3 URI you can use to access your transcript.

TranscriptFilter

Flag the presence or absence of specific words or phrases detected in your Call Analytics transcription output.

TranscriptionJob

Provides detailed information about a transcription job.

TranscriptionJobSummary

Provides detailed information about a specific transcription job.

VocabularyFilterInfo

Provides information about a vocabulary filter, including the language of the filter, when it was last modified, and its name.

VocabularyInfo

Provides information about a custom vocabulary, including the language of the vocabulary, when it was last modified, its name, and the processing state.

Enums

BaseModelName

When writing a match expression against BaseModelName, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

CallAnalyticsJobStatus

When writing a match expression against CallAnalyticsJobStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ClmLanguageCode

When writing a match expression against ClmLanguageCode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

LanguageCode

When writing a match expression against LanguageCode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

MediaFormat

When writing a match expression against MediaFormat, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

MedicalContentIdentificationType

When writing a match expression against MedicalContentIdentificationType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ModelStatus

When writing a match expression against ModelStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

OutputLocationType

When writing a match expression against OutputLocationType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ParticipantRole

When writing a match expression against ParticipantRole, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

PiiEntityType

When writing a match expression against PiiEntityType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

RedactionOutput

When writing a match expression against RedactionOutput, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

RedactionType

When writing a match expression against RedactionType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

Rule

A rule is a set of criteria you can specify to flag an attribute in your Call Analytics output. Rules define a Call Analytics category.

SentimentValue

When writing a match expression against SentimentValue, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

Specialty

When writing a match expression against Specialty, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

SubtitleFormat

When writing a match expression against SubtitleFormat, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

TranscriptFilterType

When writing a match expression against TranscriptFilterType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

TranscriptionJobStatus

When writing a match expression against TranscriptionJobStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

Type

When writing a match expression against Type, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

VocabularyFilterMethod

When writing a match expression against VocabularyFilterMethod, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

VocabularyState

When writing a match expression against VocabularyState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.