Class: Aws::TranscribeStreamingService::Types::MedicalScribeConfigurationEvent

Inherits:

Struct

• Object
• Struct
• Aws::TranscribeStreamingService::Types::MedicalScribeConfigurationEvent

Defined in:

gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/types.rb

Overview

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.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #channel_definitions ⇒ Array<Types::MedicalScribeChannelDefinition>

  Specify which speaker is on which audio channel.

• #encryption_settings ⇒ Types::MedicalScribeEncryptionSettings

  Specify the encryption settings for your streaming session.

• #event_type ⇒ Object

  Returns the value of attribute event_type.

• #medical_scribe_context ⇒ Types::MedicalScribeContext

  The MedicalScribeContext object that contains contextual information used to generate customized clinical notes.

• #post_stream_analytics_settings ⇒ Types::MedicalScribePostStreamAnalyticsSettings

  Specify settings for post-stream analytics.

• #resource_access_role_arn ⇒ String

  The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 output bucket you specified, and use your KMS key if supplied.

• #vocabulary_filter_method ⇒ String

  Specify how you want your custom vocabulary filter applied to the streaming session.

• #vocabulary_filter_name ⇒ String

  Specify the name of the custom vocabulary filter you want to include in your streaming session.

• #vocabulary_name ⇒ String

  Specify the name of the custom vocabulary you want to use for your streaming session.

Instance Attribute Details

#channel_definitions ⇒ Array<Types::MedicalScribeChannelDefinition>

Specify which speaker is on which audio channel.

Returns:

• (Array<Types::MedicalScribeChannelDefinition>)

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

class MedicalScribeConfigurationEvent < Struct.new(
  :vocabulary_name,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :resource_access_role_arn,
  :channel_definitions,
  :encryption_settings,
  :post_stream_analytics_settings,
  :medical_scribe_context,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_settings ⇒ Types::MedicalScribeEncryptionSettings

Specify the encryption settings for your streaming session.

Returns:

• (Types::MedicalScribeEncryptionSettings)

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

class MedicalScribeConfigurationEvent < Struct.new(
  :vocabulary_name,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :resource_access_role_arn,
  :channel_definitions,
  :encryption_settings,
  :post_stream_analytics_settings,
  :medical_scribe_context,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#event_type ⇒ Object

Returns the value of attribute event_type

Returns:

• (Object) —

  the current value of event_type

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

def event_type
  @event_type
end

#medical_scribe_context ⇒ Types::MedicalScribeContext

The MedicalScribeContext object that contains contextual information used to generate customized clinical notes.

Returns:

• (Types::MedicalScribeContext)

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

class MedicalScribeConfigurationEvent < Struct.new(
  :vocabulary_name,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :resource_access_role_arn,
  :channel_definitions,
  :encryption_settings,
  :post_stream_analytics_settings,
  :medical_scribe_context,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#post_stream_analytics_settings ⇒ Types::MedicalScribePostStreamAnalyticsSettings

Specify settings for post-stream analytics.

Returns:

• (Types::MedicalScribePostStreamAnalyticsSettings)

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

class MedicalScribeConfigurationEvent < Struct.new(
  :vocabulary_name,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :resource_access_role_arn,
  :channel_definitions,
  :encryption_settings,
  :post_stream_analytics_settings,
  :medical_scribe_context,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#resource_access_role_arn ⇒ String

The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 output bucket you specified, and use your KMS key if supplied. If the role that you specify doesn’t have the appropriate permissions, your request fails.

IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path. For example: arn:aws:iam::111122223333:role/Admin.

For more information, see Amazon Web Services HealthScribe.

Returns:

• (String)

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

class MedicalScribeConfigurationEvent < Struct.new(
  :vocabulary_name,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :resource_access_role_arn,
  :channel_definitions,
  :encryption_settings,
  :post_stream_analytics_settings,
  :medical_scribe_context,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#vocabulary_filter_method ⇒ String

Specify how you want your custom vocabulary filter applied to the streaming session.

To replace words with ***, specify mask.

To delete words, specify remove.

To flag words without changing them, specify tag.

Returns:

• (String)

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

class MedicalScribeConfigurationEvent < Struct.new(
  :vocabulary_name,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :resource_access_role_arn,
  :channel_definitions,
  :encryption_settings,
  :post_stream_analytics_settings,
  :medical_scribe_context,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#vocabulary_filter_name ⇒ String

Specify the name of the custom vocabulary filter you want to include in your streaming session. Custom vocabulary filter names are case-sensitive.

If you include VocabularyFilterName in the MedicalScribeConfigurationEvent, you must also include VocabularyFilterMethod.

Returns:

• (String)

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

class MedicalScribeConfigurationEvent < Struct.new(
  :vocabulary_name,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :resource_access_role_arn,
  :channel_definitions,
  :encryption_settings,
  :post_stream_analytics_settings,
  :medical_scribe_context,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#vocabulary_name ⇒ String

Specify the name of the custom vocabulary you want to use for your streaming session. Custom vocabulary names are case-sensitive.

Returns:

• (String)

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

class MedicalScribeConfigurationEvent < Struct.new(
  :vocabulary_name,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :resource_access_role_arn,
  :channel_definitions,
  :encryption_settings,
  :post_stream_analytics_settings,
  :medical_scribe_context,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end