Class: Aws::TranscribeStreamingService::Types::MedicalScribeStreamDetails

Inherits:

Struct

• Object
• Struct
• Aws::TranscribeStreamingService::Types::MedicalScribeStreamDetails

Includes:

Structure

Defined in:

lib/aws-sdk-transcribestreamingservice/types.rb

Overview

Contains details about a Amazon Web Services HealthScribe streaming session.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #channel_definitions ⇒ Array<Types::MedicalScribeChannelDefinition>

  The Channel Definitions of the HealthScribe streaming session.

• #encryption_settings ⇒ Types::MedicalScribeEncryptionSettings

  The Encryption Settings of the HealthScribe streaming session.

• #language_code ⇒ String

  The Language Code of the HealthScribe streaming session.

• #media_encoding ⇒ String

  The Media Encoding of the HealthScribe streaming session.

• #media_sample_rate_hertz ⇒ Integer

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

• #post_stream_analytics_result ⇒ Types::MedicalScribePostStreamAnalyticsResult

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

• #post_stream_analytics_settings ⇒ Types::MedicalScribePostStreamAnalyticsSettings

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

• #resource_access_role_arn ⇒ String

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

• #session_id ⇒ String

  The identifier of the HealthScribe streaming session.

• #stream_created_at ⇒ Time

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

• #stream_ended_at ⇒ Time

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

• #stream_status ⇒ String

  The streaming status of the HealthScribe streaming session.

• #vocabulary_filter_method ⇒ String

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

• #vocabulary_filter_name ⇒ String

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

• #vocabulary_name ⇒ String

  The vocabulary name of the HealthScribe streaming session.

Instance Attribute Details

#channel_definitions ⇒ Array<Types::MedicalScribeChannelDefinition>

The Channel Definitions of the HealthScribe streaming session.

Returns:

• (Array<Types::MedicalScribeChannelDefinition>)

# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 1166

class MedicalScribeStreamDetails < Struct.new(
  :session_id,
  :stream_created_at,
  :stream_ended_at,
  :language_code,
  :media_sample_rate_hertz,
  :media_encoding,
  :vocabulary_name,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :resource_access_role_arn,
  :channel_definitions,
  :encryption_settings,
  :stream_status,
  :post_stream_analytics_settings,
  :post_stream_analytics_result)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_settings ⇒ Types::MedicalScribeEncryptionSettings

The Encryption Settings of the HealthScribe streaming session.

Returns:

• (Types::MedicalScribeEncryptionSettings)

# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 1166

class MedicalScribeStreamDetails < Struct.new(
  :session_id,
  :stream_created_at,
  :stream_ended_at,
  :language_code,
  :media_sample_rate_hertz,
  :media_encoding,
  :vocabulary_name,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :resource_access_role_arn,
  :channel_definitions,
  :encryption_settings,
  :stream_status,
  :post_stream_analytics_settings,
  :post_stream_analytics_result)
  SENSITIVE = []
  include Aws::Structure
end

#language_code ⇒ String

The Language Code of the HealthScribe streaming session.

Returns:

• (String)

# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 1166

class MedicalScribeStreamDetails < Struct.new(
  :session_id,
  :stream_created_at,
  :stream_ended_at,
  :language_code,
  :media_sample_rate_hertz,
  :media_encoding,
  :vocabulary_name,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :resource_access_role_arn,
  :channel_definitions,
  :encryption_settings,
  :stream_status,
  :post_stream_analytics_settings,
  :post_stream_analytics_result)
  SENSITIVE = []
  include Aws::Structure
end

#media_encoding ⇒ String

The Media Encoding of the HealthScribe streaming session.

Returns:

• (String)

# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 1166

class MedicalScribeStreamDetails < Struct.new(
  :session_id,
  :stream_created_at,
  :stream_ended_at,
  :language_code,
  :media_sample_rate_hertz,
  :media_encoding,
  :vocabulary_name,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :resource_access_role_arn,
  :channel_definitions,
  :encryption_settings,
  :stream_status,
  :post_stream_analytics_settings,
  :post_stream_analytics_result)
  SENSITIVE = []
  include Aws::Structure
end

#media_sample_rate_hertz ⇒ Integer

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

Returns:

• (Integer)

# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 1166

class MedicalScribeStreamDetails < Struct.new(
  :session_id,
  :stream_created_at,
  :stream_ended_at,
  :language_code,
  :media_sample_rate_hertz,
  :media_encoding,
  :vocabulary_name,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :resource_access_role_arn,
  :channel_definitions,
  :encryption_settings,
  :stream_status,
  :post_stream_analytics_settings,
  :post_stream_analytics_result)
  SENSITIVE = []
  include Aws::Structure
end

#post_stream_analytics_result ⇒ Types::MedicalScribePostStreamAnalyticsResult

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

Returns:

• (Types::MedicalScribePostStreamAnalyticsResult)

# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 1166

class MedicalScribeStreamDetails < Struct.new(
  :session_id,
  :stream_created_at,
  :stream_ended_at,
  :language_code,
  :media_sample_rate_hertz,
  :media_encoding,
  :vocabulary_name,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :resource_access_role_arn,
  :channel_definitions,
  :encryption_settings,
  :stream_status,
  :post_stream_analytics_settings,
  :post_stream_analytics_result)
  SENSITIVE = []
  include Aws::Structure
end

#post_stream_analytics_settings ⇒ Types::MedicalScribePostStreamAnalyticsSettings

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

Returns:

• (Types::MedicalScribePostStreamAnalyticsSettings)

# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 1166

class MedicalScribeStreamDetails < Struct.new(
  :session_id,
  :stream_created_at,
  :stream_ended_at,
  :language_code,
  :media_sample_rate_hertz,
  :media_encoding,
  :vocabulary_name,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :resource_access_role_arn,
  :channel_definitions,
  :encryption_settings,
  :stream_status,
  :post_stream_analytics_settings,
  :post_stream_analytics_result)
  SENSITIVE = []
  include Aws::Structure
end

#resource_access_role_arn ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 1166

class MedicalScribeStreamDetails < Struct.new(
  :session_id,
  :stream_created_at,
  :stream_ended_at,
  :language_code,
  :media_sample_rate_hertz,
  :media_encoding,
  :vocabulary_name,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :resource_access_role_arn,
  :channel_definitions,
  :encryption_settings,
  :stream_status,
  :post_stream_analytics_settings,
  :post_stream_analytics_result)
  SENSITIVE = []
  include Aws::Structure
end

#session_id ⇒ String

The identifier of the HealthScribe streaming session.

Returns:

• (String)

# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 1166

class MedicalScribeStreamDetails < Struct.new(
  :session_id,
  :stream_created_at,
  :stream_ended_at,
  :language_code,
  :media_sample_rate_hertz,
  :media_encoding,
  :vocabulary_name,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :resource_access_role_arn,
  :channel_definitions,
  :encryption_settings,
  :stream_status,
  :post_stream_analytics_settings,
  :post_stream_analytics_result)
  SENSITIVE = []
  include Aws::Structure
end

#stream_created_at ⇒ Time

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

Returns:

• (Time)

# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 1166

class MedicalScribeStreamDetails < Struct.new(
  :session_id,
  :stream_created_at,
  :stream_ended_at,
  :language_code,
  :media_sample_rate_hertz,
  :media_encoding,
  :vocabulary_name,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :resource_access_role_arn,
  :channel_definitions,
  :encryption_settings,
  :stream_status,
  :post_stream_analytics_settings,
  :post_stream_analytics_result)
  SENSITIVE = []
  include Aws::Structure
end

#stream_ended_at ⇒ Time

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

Returns:

• (Time)

# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 1166

class MedicalScribeStreamDetails < Struct.new(
  :session_id,
  :stream_created_at,
  :stream_ended_at,
  :language_code,
  :media_sample_rate_hertz,
  :media_encoding,
  :vocabulary_name,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :resource_access_role_arn,
  :channel_definitions,
  :encryption_settings,
  :stream_status,
  :post_stream_analytics_settings,
  :post_stream_analytics_result)
  SENSITIVE = []
  include Aws::Structure
end

#stream_status ⇒ String

The streaming status of the HealthScribe streaming session.

Possible Values:

• ‘IN_PROGRESS`

• ‘PAUSED`

• ‘FAILED`

• ‘COMPLETED`

<note markdown=“1”> 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`.

</note>

Returns:

• (String)

# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 1166

class MedicalScribeStreamDetails < Struct.new(
  :session_id,
  :stream_created_at,
  :stream_ended_at,
  :language_code,
  :media_sample_rate_hertz,
  :media_encoding,
  :vocabulary_name,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :resource_access_role_arn,
  :channel_definitions,
  :encryption_settings,
  :stream_status,
  :post_stream_analytics_settings,
  :post_stream_analytics_result)
  SENSITIVE = []
  include Aws::Structure
end

#vocabulary_filter_method ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 1166

class MedicalScribeStreamDetails < Struct.new(
  :session_id,
  :stream_created_at,
  :stream_ended_at,
  :language_code,
  :media_sample_rate_hertz,
  :media_encoding,
  :vocabulary_name,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :resource_access_role_arn,
  :channel_definitions,
  :encryption_settings,
  :stream_status,
  :post_stream_analytics_settings,
  :post_stream_analytics_result)
  SENSITIVE = []
  include Aws::Structure
end

#vocabulary_filter_name ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 1166

class MedicalScribeStreamDetails < Struct.new(
  :session_id,
  :stream_created_at,
  :stream_ended_at,
  :language_code,
  :media_sample_rate_hertz,
  :media_encoding,
  :vocabulary_name,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :resource_access_role_arn,
  :channel_definitions,
  :encryption_settings,
  :stream_status,
  :post_stream_analytics_settings,
  :post_stream_analytics_result)
  SENSITIVE = []
  include Aws::Structure
end

#vocabulary_name ⇒ String

The vocabulary name of the HealthScribe streaming session.

Returns:

• (String)

# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 1166

class MedicalScribeStreamDetails < Struct.new(
  :session_id,
  :stream_created_at,
  :stream_ended_at,
  :language_code,
  :media_sample_rate_hertz,
  :media_encoding,
  :vocabulary_name,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :resource_access_role_arn,
  :channel_definitions,
  :encryption_settings,
  :stream_status,
  :post_stream_analytics_settings,
  :post_stream_analytics_result)
  SENSITIVE = []
  include Aws::Structure
end