AWS SDK Version 4 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Contains details about a Amazon Web Services HealthScribe streaming session.

Inheritance Hierarchy

System.Object
  Amazon.TranscribeStreaming.Model.MedicalScribeStreamDetails

Namespace: Amazon.TranscribeStreaming.Model
Assembly: AWSSDK.TranscribeStreaming.dll
Version: 3.x.y.z

Syntax

C#
public class MedicalScribeStreamDetails

The MedicalScribeStreamDetails type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property ChannelDefinitions System.Collections.Generic.List<Amazon.TranscribeStreaming.Model.MedicalScribeChannelDefinition>

Gets and sets the property ChannelDefinitions.

The Channel Definitions of the HealthScribe streaming session.

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Public Property EncryptionSettings Amazon.TranscribeStreaming.Model.MedicalScribeEncryptionSettings

Gets and sets the property EncryptionSettings.

The Encryption Settings of the HealthScribe streaming session.

Public Property LanguageCode Amazon.TranscribeStreaming.MedicalScribeLanguageCode

Gets and sets the property LanguageCode.

The Language Code of the HealthScribe streaming session.

Public Property MediaEncoding Amazon.TranscribeStreaming.MedicalScribeMediaEncoding

Gets and sets the property MediaEncoding.

The Media Encoding of the HealthScribe streaming session.

Public Property MediaSampleRateHertz System.Nullable<System.Int32>

Gets and sets the property MediaSampleRateHertz.

The sample rate (in hertz) of the HealthScribe streaming session.

Public Property PostStreamAnalyticsResult Amazon.TranscribeStreaming.Model.MedicalScribePostStreamAnalyticsResult

Gets and sets the property PostStreamAnalyticsResult.

The result of post-stream analytics for the HealthScribe streaming session.

Public Property PostStreamAnalyticsSettings Amazon.TranscribeStreaming.Model.MedicalScribePostStreamAnalyticsSettings

Gets and sets the property PostStreamAnalyticsSettings.

The post-stream analytics settings of the HealthScribe streaming session.

Public Property ResourceAccessRoleArn System.String

Gets and sets the property ResourceAccessRoleArn.

The Amazon Resource Name (ARN) of the role used in the HealthScribe streaming session.

Public Property SessionId System.String

Gets and sets the property SessionId.

The identifier of the HealthScribe streaming session.

Public Property StreamCreatedAt System.Nullable<System.DateTime>

Gets and sets the property StreamCreatedAt.

The date and time when the HealthScribe streaming session was created.

Public Property StreamEndedAt System.Nullable<System.DateTime>

Gets and sets the property StreamEndedAt.

The date and time when the HealthScribe streaming session was ended.

Public Property StreamStatus Amazon.TranscribeStreaming.MedicalScribeStreamStatus

Gets and sets the property StreamStatus.

The streaming status of the HealthScribe streaming session.

Possible Values:

  • IN_PROGRESS

  • PAUSED

  • FAILED

  • COMPLETED

This status is specific to real-time streaming. A COMPLETED status doesn't mean that the post-stream analytics is complete. To get status of an analytics result, check the Status field for the analytics result within the MedicalScribePostStreamAnalyticsResult. For example, you can view the status of the ClinicalNoteGenerationResult.

Public Property VocabularyFilterMethod Amazon.TranscribeStreaming.MedicalScribeVocabularyFilterMethod

Gets and sets the property VocabularyFilterMethod.

The method of the vocabulary filter for the HealthScribe streaming session.

Public Property VocabularyFilterName System.String

Gets and sets the property VocabularyFilterName.

The name of the vocabulary filter used for the HealthScribe streaming session .

Public Property VocabularyName System.String

Gets and sets the property VocabularyName.

The vocabulary name of the HealthScribe streaming session.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer