Module types

Data structures used by operation inputs/outputs.

Modules

builders

Builders

error

Error types that Amazon Transcribe Streaming Service can respond with.

Structs

Alternative

A list of possible alternative transcriptions for the input audio. Each alternative may contain one or more of Items, Entities, or Transcript.

AudioEvent

A wrapper for your audio chunks. Your audio stream consists of one or more audio events, which consist of one or more audio chunks.

For more information, see Event stream encoding.

CallAnalyticsEntity

Contains entities identified as personally identifiable information (PII) in your transcription output, along with various associated attributes. Examples include category, confidence score, content, type, and start and end times.

CallAnalyticsItem

A word, phrase, or punctuation mark in your Call Analytics transcription output, along with various associated attributes, such as confidence score, type, and start and end times.

CallAnalyticsLanguageWithScore

The language code that represents the language identified in your audio, including the associated confidence score.

CategoryEvent

Provides information on any TranscriptFilterType categories that matched your transcription output. Matches are identified for each segment upon completion of that segment.

ChannelDefinition

Makes it possible to specify which speaker is on which audio 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).

CharacterOffsets

Provides the location, using character count, in your transcript where a match is identified. For example, the location of an issue or a category match within a segment.

ClinicalNoteGenerationResult

The details for clinical note generation, including status, and output locations for clinical note and aggregated transcript if the analytics completed, or failure reason if the analytics failed.

ClinicalNoteGenerationSettings

The output configuration for aggregated transcript and clinical note generation.

ConfigurationEvent

Allows you to set audio channel definitions and post-call analytics settings.

Entity

Contains entities identified as personally identifiable information (PII) in your transcription output, along with various associated attributes. Examples include category, confidence score, type, stability score, and start and end times.

IssueDetected

Lists the issues that were identified in your audio segment.

Item

A word, phrase, or punctuation mark in your transcription output, along with various associated attributes, such as confidence score, type, and start and end times.

LanguageWithScore

The language code that represents the language identified in your audio, including the associated confidence score. If you enabled channel identification in your request and each channel contained a different language, you will have more than one LanguageWithScore result.

MedicalAlternative

A list of possible alternative transcriptions for the input audio. Each alternative may contain one or more of Items, Entities, or Transcript.

MedicalEntity

Contains entities identified as personal health information (PHI) in your transcription output, along with various associated attributes. Examples include category, confidence score, type, stability score, and start and end times.

MedicalItem

A word, phrase, or punctuation mark in your transcription output, along with various associated attributes, such as confidence score, type, and start and end times.

MedicalResult

The Result associated with a .

Contains a set of transcription results from one or more audio segments, along with additional information per your request parameters. This can include information relating to alternative transcriptions, channel identification, partial result stabilization, language identification, and other transcription-related data.

MedicalScribeAudioEvent

A wrapper for your audio chunks

For more information, see Event stream encoding.

MedicalScribeChannelDefinition

Makes it possible to specify which speaker is on which channel. For example, if the clinician is the first participant to speak, you would set the ChannelId of the first ChannelDefinition in the list to 0 (to indicate the first channel) and ParticipantRole to CLINICIAN (to indicate that it's the clinician speaking). Then you would set the ChannelId of the second ChannelDefinition in the list to 1 (to indicate the second channel) and ParticipantRole to PATIENT (to indicate that it's the patient speaking).

If you don't specify a channel definition, HealthScribe will diarize the transcription and identify speaker roles for each speaker.

MedicalScribeConfigurationEvent

Specify details to configure the streaming session, including channel definitions, encryption settings, post-stream analytics settings, resource access role ARN and vocabulary settings.

Whether you are starting a new session or resuming an existing session, your first event must be a MedicalScribeConfigurationEvent. If you are resuming a session, then this event must have the same configurations that you provided to start the session.

MedicalScribeContext

The MedicalScribeContext object that contains contextual information which is used during clinical note generation to add relevant context to the note.

MedicalScribeEncryptionSettings

Contains encryption related settings to be used for data encryption with Key Management Service, including KmsEncryptionContext and KmsKeyId. The KmsKeyId is required, while KmsEncryptionContext is optional for additional layer of security.

By default, Amazon Web Services HealthScribe provides encryption at rest to protect sensitive customer data using Amazon S3-managed keys. HealthScribe uses the KMS key you specify as a second layer of encryption.

Your ResourceAccessRoleArn must permission to use your KMS key. For more information, see Data Encryption at rest for Amazon Web Services HealthScribe.

MedicalScribePatientContext

Contains patient-specific information.

MedicalScribePostStreamAnalyticsResult

Contains details for the result of post-stream analytics.

MedicalScribePostStreamAnalyticsSettings

The settings for post-stream analytics.

MedicalScribeSessionControlEvent

Specify the lifecycle of your streaming session.

MedicalScribeStreamDetails

Contains details about a Amazon Web Services HealthScribe streaming session.

MedicalScribeTranscriptEvent

The event associated with MedicalScribeResultStream.

Contains MedicalScribeTranscriptSegment, which contains segment related information.

MedicalScribeTranscriptItem

A word, phrase, or punctuation mark in your transcription output, along with various associated attributes, such as confidence score, type, and start and end times.

MedicalScribeTranscriptSegment

Contains a set of transcription results, along with additional information of the segment.

MedicalTranscript

The MedicalTranscript associated with a .

MedicalTranscript contains Results, which contains a set of transcription results from one or more audio segments, along with additional information per your request parameters.

MedicalTranscriptEvent

The MedicalTranscriptEvent associated with a MedicalTranscriptResultStream.

Contains a set of transcription results from one or more audio segments, along with additional information per your request parameters.

PointsOfInterest

Contains the timestamps of matched categories.

PostCallAnalyticsSettings

Allows you to specify additional settings for your Call Analytics post-call request, including output locations for your redacted transcript, which IAM role to use, and which encryption key to use.

DataAccessRoleArn and OutputLocation are required fields.

PostCallAnalyticsSettings provides you with the same insights as a Call Analytics post-call transcription. Refer to Post-call analytics for more information on this feature.

Result

The Result associated with a .

Contains a set of transcription results from one or more audio segments, along with additional information per your request parameters. This can include information relating to alternative transcriptions, channel identification, partial result stabilization, language identification, and other transcription-related data.

TimestampRange

Contains the timestamp range (start time through end time) of a matched category.

Transcript

The Transcript associated with a .

Transcript contains Results, which contains a set of transcription results from one or more audio segments, along with additional information per your request parameters.

TranscriptEvent

The TranscriptEvent associated with a TranscriptResultStream.

Contains a set of transcription results from one or more audio segments, along with additional information per your request parameters.

UtteranceEvent

Contains set of transcription results from one or more audio segments, along with additional information about the parameters included in your request. For example, channel definitions, partial result stabilization, sentiment, and issue detection.

Enums

AudioStream

An encoded stream of audio blobs. Audio streams are encoded as either HTTP/2 or WebSocket data frames.

For more information, see Transcribing streaming audio.

CallAnalyticsLanguageCode

When writing a match expression against CallAnalyticsLanguageCode, 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.

CallAnalyticsTranscriptResultStream

Contains detailed information about your real-time Call Analytics session. These details are provided in the UtteranceEvent and CategoryEvent objects.

ClinicalNoteGenerationStatus

When writing a match expression against ClinicalNoteGenerationStatus, 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.

ContentIdentificationType

When writing a match expression against ContentIdentificationType, 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.

ContentRedactionOutput

When writing a match expression against ContentRedactionOutput, 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.

ContentRedactionType

When writing a match expression against ContentRedactionType, 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.

ItemType

When writing a match expression against ItemType, 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.

MediaEncoding

When writing a match expression against MediaEncoding, 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.

MedicalScribeInputStream

An encoded stream of events. The stream is encoded as HTTP/2 data frames.

An input stream consists of the following types of events. The first element of the input stream must be the MedicalScribeConfigurationEvent event type.

• MedicalScribeConfigurationEvent

• MedicalScribeAudioEvent

• MedicalScribeSessionControlEvent

MedicalScribeLanguageCode

When writing a match expression against MedicalScribeLanguageCode, 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.

MedicalScribeMediaEncoding

When writing a match expression against MedicalScribeMediaEncoding, 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.

MedicalScribeNoteTemplate

When writing a match expression against MedicalScribeNoteTemplate, 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.

MedicalScribeParticipantRole

When writing a match expression against MedicalScribeParticipantRole, 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.

MedicalScribeResultStream

Result stream where you will receive the output events. The details are provided in the MedicalScribeTranscriptEvent object.

MedicalScribeSessionControlEventType

When writing a match expression against MedicalScribeSessionControlEventType, 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.

MedicalScribeStreamStatus

When writing a match expression against MedicalScribeStreamStatus, 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.

MedicalScribeTranscriptItemType

When writing a match expression against MedicalScribeTranscriptItemType, 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.

MedicalScribeVocabularyFilterMethod

When writing a match expression against MedicalScribeVocabularyFilterMethod, 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.

MedicalTranscriptResultStream

Contains detailed information about your streaming session.

PartialResultsStability

When writing a match expression against PartialResultsStability, 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.

Pronouns

When writing a match expression against Pronouns, 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.

Sentiment

When writing a match expression against Sentiment, 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.

TranscriptResultStream

Contains detailed information about your streaming session.

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.