Struct aws_sdk_transcribe::operation::start_medical_scribe_job::builders::StartMedicalScribeJobFluentBuilder
source · pub struct StartMedicalScribeJobFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to StartMedicalScribeJob
.
Transcribes patient-clinician conversations and generates clinical notes.
Amazon Web Services HealthScribe automatically provides rich conversation transcripts, identifies speaker roles, classifies dialogues, extracts medical terms, and generates preliminary clinical notes. To learn more about these features, refer to Amazon Web Services HealthScribe.
To make a StartMedicalScribeJob
request, you must first upload your media file into an Amazon S3 bucket; you can then specify the Amazon S3 location of the file using the Media
parameter.
You must include the following parameters in your StartMedicalTranscriptionJob
request:
-
DataAccessRoleArn
: The ARN of an IAM role with the these minimum permissions: read permission on input file Amazon S3 bucket specified inMedia
, write permission on the Amazon S3 bucket specified inOutputBucketName
, and full permissions on the KMS key specified inOutputEncryptionKMSKeyId
(if set). The role should also allowtranscribe.amazonaws.com
to assume it. -
Media
(MediaFileUri
): The Amazon S3 location of your media file. -
MedicalScribeJobName
: A custom name you create for your MedicalScribe job that is unique within your Amazon Web Services account. -
OutputBucketName
: The Amazon S3 bucket where you want your output files stored. -
Settings
: AMedicalScribeSettings
obect that must set exactly one ofShowSpeakerLabels
orChannelIdentification
to true. IfShowSpeakerLabels
is true,MaxSpeakerLabels
must also be set. -
ChannelDefinitions
: AMedicalScribeChannelDefinitions
array should be set if and only if theChannelIdentification
value ofSettings
is set to true.
Implementations§
source§impl StartMedicalScribeJobFluentBuilder
impl StartMedicalScribeJobFluentBuilder
sourcepub fn as_input(&self) -> &StartMedicalScribeJobInputBuilder
pub fn as_input(&self) -> &StartMedicalScribeJobInputBuilder
Access the StartMedicalScribeJob as a reference.
sourcepub async fn send(
self
) -> Result<StartMedicalScribeJobOutput, SdkError<StartMedicalScribeJobError, HttpResponse>>
pub async fn send( self ) -> Result<StartMedicalScribeJobOutput, SdkError<StartMedicalScribeJobError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
sourcepub fn customize(
self
) -> CustomizableOperation<StartMedicalScribeJobOutput, StartMedicalScribeJobError, Self>
pub fn customize( self ) -> CustomizableOperation<StartMedicalScribeJobOutput, StartMedicalScribeJobError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn medical_scribe_job_name(self, input: impl Into<String>) -> Self
pub fn medical_scribe_job_name(self, input: impl Into<String>) -> Self
A unique name, chosen by you, for your Medical Scribe job.
This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a new job with the same name as an existing job, you get a ConflictException
error.
sourcepub fn set_medical_scribe_job_name(self, input: Option<String>) -> Self
pub fn set_medical_scribe_job_name(self, input: Option<String>) -> Self
A unique name, chosen by you, for your Medical Scribe job.
This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a new job with the same name as an existing job, you get a ConflictException
error.
sourcepub fn get_medical_scribe_job_name(&self) -> &Option<String>
pub fn get_medical_scribe_job_name(&self) -> &Option<String>
A unique name, chosen by you, for your Medical Scribe job.
This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a new job with the same name as an existing job, you get a ConflictException
error.
sourcepub fn media(self, input: Media) -> Self
pub fn media(self, input: Media) -> Self
Describes the Amazon S3 location of the media file you want to use in your request.
For information on supported media formats, refer to the MediaFormat
parameter or the Media formats section in the Amazon S3 Developer Guide.
sourcepub fn set_media(self, input: Option<Media>) -> Self
pub fn set_media(self, input: Option<Media>) -> Self
Describes the Amazon S3 location of the media file you want to use in your request.
For information on supported media formats, refer to the MediaFormat
parameter or the Media formats section in the Amazon S3 Developer Guide.
sourcepub fn get_media(&self) -> &Option<Media>
pub fn get_media(&self) -> &Option<Media>
Describes the Amazon S3 location of the media file you want to use in your request.
For information on supported media formats, refer to the MediaFormat
parameter or the Media formats section in the Amazon S3 Developer Guide.
sourcepub fn output_bucket_name(self, input: impl Into<String>) -> Self
pub fn output_bucket_name(self, input: impl Into<String>) -> Self
The name of the Amazon S3 bucket where you want your Medical Scribe output stored. Do not include the S3://
prefix of the specified bucket.
Note that the role specified in the DataAccessRoleArn
request parameter must have permission to use the specified location. You can change Amazon S3 permissions using the Amazon Web Services Management Console. See also Permissions Required for IAM User Roles.
sourcepub fn set_output_bucket_name(self, input: Option<String>) -> Self
pub fn set_output_bucket_name(self, input: Option<String>) -> Self
The name of the Amazon S3 bucket where you want your Medical Scribe output stored. Do not include the S3://
prefix of the specified bucket.
Note that the role specified in the DataAccessRoleArn
request parameter must have permission to use the specified location. You can change Amazon S3 permissions using the Amazon Web Services Management Console. See also Permissions Required for IAM User Roles.
sourcepub fn get_output_bucket_name(&self) -> &Option<String>
pub fn get_output_bucket_name(&self) -> &Option<String>
The name of the Amazon S3 bucket where you want your Medical Scribe output stored. Do not include the S3://
prefix of the specified bucket.
Note that the role specified in the DataAccessRoleArn
request parameter must have permission to use the specified location. You can change Amazon S3 permissions using the Amazon Web Services Management Console. See also Permissions Required for IAM User Roles.
sourcepub fn output_encryption_kms_key_id(self, input: impl Into<String>) -> Self
pub fn output_encryption_kms_key_id(self, input: impl Into<String>) -> Self
The KMS key you want to use to encrypt your Medical Scribe output.
If using a key located in the current Amazon Web Services account, you can specify your KMS key in one of four ways:
-
Use the KMS key ID itself. For example,
1234abcd-12ab-34cd-56ef-1234567890ab
. -
Use an alias for the KMS key ID. For example,
alias/ExampleAlias
. -
Use the Amazon Resource Name (ARN) for the KMS key ID. For example,
arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab
. -
Use the ARN for the KMS key alias. For example,
arn:aws:kms:region:account-ID:alias/ExampleAlias
.
If using a key located in a different Amazon Web Services account than the current Amazon Web Services account, you can specify your KMS key in one of two ways:
-
Use the ARN for the KMS key ID. For example,
arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab
. -
Use the ARN for the KMS key alias. For example,
arn:aws:kms:region:account-ID:alias/ExampleAlias
.
If you do not specify an encryption key, your output is encrypted with the default Amazon S3 key (SSE-S3).
Note that the role specified in the DataAccessRoleArn
request parameter must have permission to use the specified KMS key.
sourcepub fn set_output_encryption_kms_key_id(self, input: Option<String>) -> Self
pub fn set_output_encryption_kms_key_id(self, input: Option<String>) -> Self
The KMS key you want to use to encrypt your Medical Scribe output.
If using a key located in the current Amazon Web Services account, you can specify your KMS key in one of four ways:
-
Use the KMS key ID itself. For example,
1234abcd-12ab-34cd-56ef-1234567890ab
. -
Use an alias for the KMS key ID. For example,
alias/ExampleAlias
. -
Use the Amazon Resource Name (ARN) for the KMS key ID. For example,
arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab
. -
Use the ARN for the KMS key alias. For example,
arn:aws:kms:region:account-ID:alias/ExampleAlias
.
If using a key located in a different Amazon Web Services account than the current Amazon Web Services account, you can specify your KMS key in one of two ways:
-
Use the ARN for the KMS key ID. For example,
arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab
. -
Use the ARN for the KMS key alias. For example,
arn:aws:kms:region:account-ID:alias/ExampleAlias
.
If you do not specify an encryption key, your output is encrypted with the default Amazon S3 key (SSE-S3).
Note that the role specified in the DataAccessRoleArn
request parameter must have permission to use the specified KMS key.
sourcepub fn get_output_encryption_kms_key_id(&self) -> &Option<String>
pub fn get_output_encryption_kms_key_id(&self) -> &Option<String>
The KMS key you want to use to encrypt your Medical Scribe output.
If using a key located in the current Amazon Web Services account, you can specify your KMS key in one of four ways:
-
Use the KMS key ID itself. For example,
1234abcd-12ab-34cd-56ef-1234567890ab
. -
Use an alias for the KMS key ID. For example,
alias/ExampleAlias
. -
Use the Amazon Resource Name (ARN) for the KMS key ID. For example,
arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab
. -
Use the ARN for the KMS key alias. For example,
arn:aws:kms:region:account-ID:alias/ExampleAlias
.
If using a key located in a different Amazon Web Services account than the current Amazon Web Services account, you can specify your KMS key in one of two ways:
-
Use the ARN for the KMS key ID. For example,
arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab
. -
Use the ARN for the KMS key alias. For example,
arn:aws:kms:region:account-ID:alias/ExampleAlias
.
If you do not specify an encryption key, your output is encrypted with the default Amazon S3 key (SSE-S3).
Note that the role specified in the DataAccessRoleArn
request parameter must have permission to use the specified KMS key.
sourcepub fn kms_encryption_context(
self,
k: impl Into<String>,
v: impl Into<String>
) -> Self
pub fn kms_encryption_context( self, k: impl Into<String>, v: impl Into<String> ) -> Self
Adds a key-value pair to KMSEncryptionContext
.
To override the contents of this collection use set_kms_encryption_context
.
A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data. For more information, see KMS encryption context and Asymmetric keys in KMS.
sourcepub fn set_kms_encryption_context(
self,
input: Option<HashMap<String, String>>
) -> Self
pub fn set_kms_encryption_context( self, input: Option<HashMap<String, String>> ) -> Self
A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data. For more information, see KMS encryption context and Asymmetric keys in KMS.
sourcepub fn get_kms_encryption_context(&self) -> &Option<HashMap<String, String>>
pub fn get_kms_encryption_context(&self) -> &Option<HashMap<String, String>>
A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data. For more information, see KMS encryption context and Asymmetric keys in KMS.
sourcepub fn data_access_role_arn(self, input: impl Into<String>) -> Self
pub fn data_access_role_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files, write to the output bucket, 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 IAM ARNs.
sourcepub fn set_data_access_role_arn(self, input: Option<String>) -> Self
pub fn set_data_access_role_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files, write to the output bucket, 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 IAM ARNs.
sourcepub fn get_data_access_role_arn(&self) -> &Option<String>
pub fn get_data_access_role_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files, write to the output bucket, 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 IAM ARNs.
sourcepub fn settings(self, input: MedicalScribeSettings) -> Self
pub fn settings(self, input: MedicalScribeSettings) -> Self
Makes it possible to control how your Medical Scribe job is processed using a MedicalScribeSettings
object. Specify ChannelIdentification
if ChannelDefinitions
are set. Enabled ShowSpeakerLabels
if ChannelIdentification
and ChannelDefinitions
are not set. One and only one of ChannelIdentification
and ShowSpeakerLabels
must be set. If ShowSpeakerLabels
is set, MaxSpeakerLabels
must also be set. Use Settings
to specify a vocabulary or vocabulary filter or both using VocabularyName
, VocabularyFilterName
. VocabularyFilterMethod
must be specified if VocabularyFilterName
is set.
sourcepub fn set_settings(self, input: Option<MedicalScribeSettings>) -> Self
pub fn set_settings(self, input: Option<MedicalScribeSettings>) -> Self
Makes it possible to control how your Medical Scribe job is processed using a MedicalScribeSettings
object. Specify ChannelIdentification
if ChannelDefinitions
are set. Enabled ShowSpeakerLabels
if ChannelIdentification
and ChannelDefinitions
are not set. One and only one of ChannelIdentification
and ShowSpeakerLabels
must be set. If ShowSpeakerLabels
is set, MaxSpeakerLabels
must also be set. Use Settings
to specify a vocabulary or vocabulary filter or both using VocabularyName
, VocabularyFilterName
. VocabularyFilterMethod
must be specified if VocabularyFilterName
is set.
sourcepub fn get_settings(&self) -> &Option<MedicalScribeSettings>
pub fn get_settings(&self) -> &Option<MedicalScribeSettings>
Makes it possible to control how your Medical Scribe job is processed using a MedicalScribeSettings
object. Specify ChannelIdentification
if ChannelDefinitions
are set. Enabled ShowSpeakerLabels
if ChannelIdentification
and ChannelDefinitions
are not set. One and only one of ChannelIdentification
and ShowSpeakerLabels
must be set. If ShowSpeakerLabels
is set, MaxSpeakerLabels
must also be set. Use Settings
to specify a vocabulary or vocabulary filter or both using VocabularyName
, VocabularyFilterName
. VocabularyFilterMethod
must be specified if VocabularyFilterName
is set.
sourcepub fn channel_definitions(self, input: MedicalScribeChannelDefinition) -> Self
pub fn channel_definitions(self, input: MedicalScribeChannelDefinition) -> Self
Appends an item to ChannelDefinitions
.
To override the contents of this collection use set_channel_definitions
.
Makes it possible to specify which speaker is on which channel. For example, if the clinician is the first participant to speak, you would set ChannelId
of the first ChannelDefinition
in the list to 0
(to indicate the first channel) and ParticipantRole
to CLINICIAN
(to indicate that it's the clinician speaking). Then you would set the ChannelId
of the second ChannelDefinition
in the list to 1
(to indicate the second channel) and ParticipantRole
to PATIENT
(to indicate that it's the patient speaking).
sourcepub fn set_channel_definitions(
self,
input: Option<Vec<MedicalScribeChannelDefinition>>
) -> Self
pub fn set_channel_definitions( self, input: Option<Vec<MedicalScribeChannelDefinition>> ) -> Self
Makes it possible to specify which speaker is on which channel. For example, if the clinician is the first participant to speak, you would set ChannelId
of the first ChannelDefinition
in the list to 0
(to indicate the first channel) and ParticipantRole
to CLINICIAN
(to indicate that it's the clinician speaking). Then you would set the ChannelId
of the second ChannelDefinition
in the list to 1
(to indicate the second channel) and ParticipantRole
to PATIENT
(to indicate that it's the patient speaking).
sourcepub fn get_channel_definitions(
&self
) -> &Option<Vec<MedicalScribeChannelDefinition>>
pub fn get_channel_definitions( &self ) -> &Option<Vec<MedicalScribeChannelDefinition>>
Makes it possible to specify which speaker is on which channel. For example, if the clinician is the first participant to speak, you would set ChannelId
of the first ChannelDefinition
in the list to 0
(to indicate the first channel) and ParticipantRole
to CLINICIAN
(to indicate that it's the clinician speaking). Then you would set the ChannelId
of the second ChannelDefinition
in the list to 1
(to indicate the second channel) and ParticipantRole
to PATIENT
(to indicate that it's the patient speaking).
Appends an item to Tags
.
To override the contents of this collection use set_tags
.
Adds one or more custom tags, each in the form of a key:value pair, to the Medica Scribe job.
To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
Adds one or more custom tags, each in the form of a key:value pair, to the Medica Scribe job.
To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
Adds one or more custom tags, each in the form of a key:value pair, to the Medica Scribe job.
To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
Trait Implementations§
source§impl Clone for StartMedicalScribeJobFluentBuilder
impl Clone for StartMedicalScribeJobFluentBuilder
source§fn clone(&self) -> StartMedicalScribeJobFluentBuilder
fn clone(&self) -> StartMedicalScribeJobFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for StartMedicalScribeJobFluentBuilder
impl !RefUnwindSafe for StartMedicalScribeJobFluentBuilder
impl Send for StartMedicalScribeJobFluentBuilder
impl Sync for StartMedicalScribeJobFluentBuilder
impl Unpin for StartMedicalScribeJobFluentBuilder
impl !UnwindSafe for StartMedicalScribeJobFluentBuilder
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> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§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