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.
Contents
- PostStreamAnalyticsSettings
-
Specify settings for post-stream analytics.
Type: MedicalScribePostStreamAnalyticsSettings object
Required: Yes
- ResourceAccessRoleArn
-
The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 output bucket you specified, and use your AWS 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 AWS HealthScribe.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
^arn:(aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):iam::[0-9]{0,63}:role/[A-Za-z0-9:_/+=,@.-]{0,1024}$Required: Yes
- ChannelDefinitions
-
Specify which speaker is on which audio channel.
Type: Array of MedicalScribeChannelDefinition objects
Array Members: Fixed number of 2 items.
Required: No
- EncryptionSettings
-
Specify the encryption settings for your streaming session.
Type: MedicalScribeEncryptionSettings object
Required: No
- VocabularyFilterMethod
-
Specify how you want your custom vocabulary filter applied to the streaming session.
To replace words with
***, specifymask.To delete words, specify
remove.To flag words without changing them, specify
tag.Type: String
Valid Values:
remove | mask | tagRequired: No
- VocabularyFilterName
-
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
VocabularyFilterNamein theMedicalScribeConfigurationEvent, you must also includeVocabularyFilterMethod.Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern:
^[0-9a-zA-Z._-]+Required: No
- VocabularyName
-
Specify the name of the custom vocabulary you want to use for your streaming session. Custom vocabulary names are case-sensitive.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern:
^[0-9a-zA-Z._-]+Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
