#[non_exhaustive]pub struct MedicalScribeConfigurationEvent {
pub vocabulary_name: Option<String>,
pub vocabulary_filter_name: Option<String>,
pub vocabulary_filter_method: Option<MedicalScribeVocabularyFilterMethod>,
pub resource_access_role_arn: String,
pub channel_definitions: Option<Vec<MedicalScribeChannelDefinition>>,
pub encryption_settings: Option<MedicalScribeEncryptionSettings>,
pub post_stream_analytics_settings: Option<MedicalScribePostStreamAnalyticsSettings>,
pub medical_scribe_context: Option<MedicalScribeContext>,
}Expand description
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.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.vocabulary_name: Option<String>Specify the name of the custom vocabulary you want to use for your streaming session. Custom vocabulary names are case-sensitive.
vocabulary_filter_name: Option<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.
vocabulary_filter_method: Option<MedicalScribeVocabularyFilterMethod>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.
resource_access_role_arn: StringThe 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.
channel_definitions: Option<Vec<MedicalScribeChannelDefinition>>Specify which speaker is on which audio channel.
encryption_settings: Option<MedicalScribeEncryptionSettings>Specify the encryption settings for your streaming session.
post_stream_analytics_settings: Option<MedicalScribePostStreamAnalyticsSettings>Specify settings for post-stream analytics.
medical_scribe_context: Option<MedicalScribeContext>The MedicalScribeContext object that contains contextual information used to generate customized clinical notes.
Implementations§
Source§impl MedicalScribeConfigurationEvent
impl MedicalScribeConfigurationEvent
Sourcepub fn vocabulary_name(&self) -> Option<&str>
pub fn vocabulary_name(&self) -> Option<&str>
Specify the name of the custom vocabulary you want to use for your streaming session. Custom vocabulary names are case-sensitive.
Sourcepub fn vocabulary_filter_name(&self) -> Option<&str>
pub fn vocabulary_filter_name(&self) -> Option<&str>
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.
Sourcepub fn vocabulary_filter_method(
&self,
) -> Option<&MedicalScribeVocabularyFilterMethod>
pub fn vocabulary_filter_method( &self, ) -> Option<&MedicalScribeVocabularyFilterMethod>
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.
Sourcepub fn resource_access_role_arn(&self) -> &str
pub fn resource_access_role_arn(&self) -> &str
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.
Sourcepub fn channel_definitions(&self) -> &[MedicalScribeChannelDefinition]
pub fn channel_definitions(&self) -> &[MedicalScribeChannelDefinition]
Specify which speaker is on which audio channel.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .channel_definitions.is_none().
Sourcepub fn encryption_settings(&self) -> Option<&MedicalScribeEncryptionSettings>
pub fn encryption_settings(&self) -> Option<&MedicalScribeEncryptionSettings>
Specify the encryption settings for your streaming session.
Sourcepub fn post_stream_analytics_settings(
&self,
) -> Option<&MedicalScribePostStreamAnalyticsSettings>
pub fn post_stream_analytics_settings( &self, ) -> Option<&MedicalScribePostStreamAnalyticsSettings>
Specify settings for post-stream analytics.
Sourcepub fn medical_scribe_context(&self) -> Option<&MedicalScribeContext>
pub fn medical_scribe_context(&self) -> Option<&MedicalScribeContext>
The MedicalScribeContext object that contains contextual information used to generate customized clinical notes.
Source§impl MedicalScribeConfigurationEvent
impl MedicalScribeConfigurationEvent
Sourcepub fn builder() -> MedicalScribeConfigurationEventBuilder
pub fn builder() -> MedicalScribeConfigurationEventBuilder
Creates a new builder-style object to manufacture MedicalScribeConfigurationEvent.
Trait Implementations§
Source§impl Clone for MedicalScribeConfigurationEvent
impl Clone for MedicalScribeConfigurationEvent
Source§fn clone(&self) -> MedicalScribeConfigurationEvent
fn clone(&self) -> MedicalScribeConfigurationEvent
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl PartialEq for MedicalScribeConfigurationEvent
impl PartialEq for MedicalScribeConfigurationEvent
Source§fn eq(&self, other: &MedicalScribeConfigurationEvent) -> bool
fn eq(&self, other: &MedicalScribeConfigurationEvent) -> bool
self and other values to be equal, and is used by ==.impl StructuralPartialEq for MedicalScribeConfigurationEvent
Auto Trait Implementations§
impl Freeze for MedicalScribeConfigurationEvent
impl RefUnwindSafe for MedicalScribeConfigurationEvent
impl Send for MedicalScribeConfigurationEvent
impl Sync for MedicalScribeConfigurationEvent
impl Unpin for MedicalScribeConfigurationEvent
impl UnwindSafe for MedicalScribeConfigurationEvent
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling [Attribute] value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi [Quirk] value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the [Condition] value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);