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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-transcribestreamingservice/types.rb

Overview

Contains details about a Amazon Web Services HealthScribe streaming session.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#channel_definitions ⇒ Array<Types::MedicalScribeChannelDefinition>

The Channel Definitions of the HealthScribe streaming session.

Returns:



1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 1251

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,
  :medical_scribe_context_provided)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_settings ⇒ Types::MedicalScribeEncryptionSettings

The Encryption Settings of the HealthScribe streaming session.

Returns:



1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 1251

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,
  :medical_scribe_context_provided)
  SENSITIVE = []
  include Aws::Structure
end

#language_code ⇒ String

The Language Code of the HealthScribe streaming session.

Returns:

  • (String) 


1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 1251

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,
  :medical_scribe_context_provided)
  SENSITIVE = []
  include Aws::Structure
end

#media_encoding ⇒ String

The Media Encoding of the HealthScribe streaming session.

Returns:

  • (String) 


1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 1251

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,
  :medical_scribe_context_provided)
  SENSITIVE = []
  include Aws::Structure
end

#media_sample_rate_hertz ⇒ Integer

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

Returns:

  • (Integer) 


1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 1251

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,
  :medical_scribe_context_provided)
  SENSITIVE = []
  include Aws::Structure
end

#medical_scribe_context_provided ⇒ Boolean

Indicates whether the ‘MedicalScribeContext` object was provided when the stream was started.

Returns:

  • (Boolean) 


1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 1251

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,
  :medical_scribe_context_provided)
  SENSITIVE = []
  include Aws::Structure
end

#post_stream_analytics_result ⇒ Types::MedicalScribePostStreamAnalyticsResult

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

Returns:



1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 1251

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,
  :medical_scribe_context_provided)
  SENSITIVE = []
  include Aws::Structure
end

#post_stream_analytics_settings ⇒ Types::MedicalScribePostStreamAnalyticsSettings

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

Returns:



1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 1251

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,
  :medical_scribe_context_provided)
  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) 


1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 1251

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,
  :medical_scribe_context_provided)
  SENSITIVE = []
  include Aws::Structure
end

#session_id ⇒ String

The identifier of the HealthScribe streaming session.

Returns:

  • (String) 


1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 1251

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,
  :medical_scribe_context_provided)
  SENSITIVE = []
  include Aws::Structure
end

#stream_created_at ⇒ Time

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

Returns:

  • (Time) 


1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 1251

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,
  :medical_scribe_context_provided)
  SENSITIVE = []
  include Aws::Structure
end

#stream_ended_at ⇒ Time

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

Returns:

  • (Time) 


1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 1251

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,
  :medical_scribe_context_provided)
  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) 


1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 1251

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,
  :medical_scribe_context_provided)
  SENSITIVE = []
  include Aws::Structure
end

#vocabulary_filter_method ⇒ String

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

Returns:

  • (String) 


1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 1251

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,
  :medical_scribe_context_provided)
  SENSITIVE = []
  include Aws::Structure
end

#vocabulary_filter_name ⇒ String

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

Returns:

  • (String) 


1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 1251

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,
  :medical_scribe_context_provided)
  SENSITIVE = []
  include Aws::Structure
end

#vocabulary_name ⇒ String

The vocabulary name of the HealthScribe streaming session.

Returns:

  • (String) 


1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 1251

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,
  :medical_scribe_context_provided)
  SENSITIVE = []
  include Aws::Structure
end