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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#channel_definitions ⇒ Array<Types::MedicalScribeChannelDefinition>

Specify which speaker is on which audio channel.

Returns:



932
933
934
935
936
937
938
939
940
941
942
943
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 932

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

#encryption_settings ⇒ Types::MedicalScribeEncryptionSettings

Specify the encryption settings for your streaming session.

Returns:



932
933
934
935
936
937
938
939
940
941
942
943
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 932

class MedicalScribeConfigurationEvent < Struct.new(
  :vocabulary_name,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :resource_access_role_arn,
  :channel_definitions,
  :encryption_settings,
  :post_stream_analytics_settings,
  :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



932
933
934
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 932

def event_type
  @event_type
end

#post_stream_analytics_settings ⇒ Types::MedicalScribePostStreamAnalyticsSettings

Specify settings for post-stream analytics.

Returns:



932
933
934
935
936
937
938
939
940
941
942
943
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 932

class MedicalScribeConfigurationEvent < Struct.new(
  :vocabulary_name,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :resource_access_role_arn,
  :channel_definitions,
  :encryption_settings,
  :post_stream_analytics_settings,
  :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].

[1]: docs.aws.amazon.com/transcribe/latest/dg/health-scribe-streaming.html

Returns:

  • (String) 


932
933
934
935
936
937
938
939
940
941
942
943
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 932

class MedicalScribeConfigurationEvent < Struct.new(
  :vocabulary_name,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :resource_access_role_arn,
  :channel_definitions,
  :encryption_settings,
  :post_stream_analytics_settings,
  :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) 


932
933
934
935
936
937
938
939
940
941
942
943
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 932

class MedicalScribeConfigurationEvent < Struct.new(
  :vocabulary_name,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :resource_access_role_arn,
  :channel_definitions,
  :encryption_settings,
  :post_stream_analytics_settings,
  :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) 


932
933
934
935
936
937
938
939
940
941
942
943
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 932

class MedicalScribeConfigurationEvent < Struct.new(
  :vocabulary_name,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :resource_access_role_arn,
  :channel_definitions,
  :encryption_settings,
  :post_stream_analytics_settings,
  :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) 


932
933
934
935
936
937
938
939
940
941
942
943
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 932

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