Struct aws_sdk_transcribe::operation::start_medical_scribe_job::builders::StartMedicalScribeJobInputBuilder
source · #[non_exhaustive]pub struct StartMedicalScribeJobInputBuilder { /* private fields */ }
Expand description
A builder for StartMedicalScribeJobInput
.
Implementations§
source§impl StartMedicalScribeJobInputBuilder
impl StartMedicalScribeJobInputBuilder
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 kms_encryption_context
.
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.
This field is required.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 channel_definitions
.
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.
sourcepub fn build(self) -> Result<StartMedicalScribeJobInput, BuildError>
pub fn build(self) -> Result<StartMedicalScribeJobInput, BuildError>
Consumes the builder and constructs a StartMedicalScribeJobInput
.
source§impl StartMedicalScribeJobInputBuilder
impl StartMedicalScribeJobInputBuilder
sourcepub async fn send_with(
self,
client: &Client
) -> Result<StartMedicalScribeJobOutput, SdkError<StartMedicalScribeJobError, HttpResponse>>
pub async fn send_with( self, client: &Client ) -> Result<StartMedicalScribeJobOutput, SdkError<StartMedicalScribeJobError, HttpResponse>>
Sends a request with this input using the given client.
Trait Implementations§
source§impl Clone for StartMedicalScribeJobInputBuilder
impl Clone for StartMedicalScribeJobInputBuilder
source§fn clone(&self) -> StartMedicalScribeJobInputBuilder
fn clone(&self) -> StartMedicalScribeJobInputBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Default for StartMedicalScribeJobInputBuilder
impl Default for StartMedicalScribeJobInputBuilder
source§fn default() -> StartMedicalScribeJobInputBuilder
fn default() -> StartMedicalScribeJobInputBuilder
source§impl PartialEq for StartMedicalScribeJobInputBuilder
impl PartialEq for StartMedicalScribeJobInputBuilder
source§fn eq(&self, other: &StartMedicalScribeJobInputBuilder) -> bool
fn eq(&self, other: &StartMedicalScribeJobInputBuilder) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for StartMedicalScribeJobInputBuilder
Auto Trait Implementations§
impl Freeze for StartMedicalScribeJobInputBuilder
impl RefUnwindSafe for StartMedicalScribeJobInputBuilder
impl Send for StartMedicalScribeJobInputBuilder
impl Sync for StartMedicalScribeJobInputBuilder
impl Unpin for StartMedicalScribeJobInputBuilder
impl UnwindSafe for StartMedicalScribeJobInputBuilder
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