Class StartMedicalScribeJobRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<StartMedicalScribeJobRequest.Builder,
StartMedicalScribeJobRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Makes it possible to specify which speaker is on which channel.final 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.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the ChannelDefinitions property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the KMSEncryptionContext property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.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.final Media
media()
Returns the value of the Media property for this object.final String
A unique name, chosen by you, for your Medical Scribe job.final String
The name of the Amazon S3 bucket where you want your Medical Scribe output stored.final String
The KMS key you want to use to encrypt your Medical Scribe output.static Class
<? extends StartMedicalScribeJobRequest.Builder> final MedicalScribeSettings
settings()
Makes it possible to control how your Medical Scribe job is processed using aMedicalScribeSettings
object.tags()
Adds one or more custom tags, each in the form of a key:value pair, to the Medica Scribe job.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
medicalScribeJobName
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.- Returns:
- 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.
-
media
Returns the value of the Media property for this object.- Returns:
- The value of the Media property for this object.
-
outputBucketName
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.- Returns:
- 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.
-
outputEncryptionKMSKeyId
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.- Returns:
- 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. -
-
-
hasKmsEncryptionContext
public final boolean hasKmsEncryptionContext()For responses, this returns true if the service returned a value for the KMSEncryptionContext property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
kmsEncryptionContext
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasKmsEncryptionContext()
method.- Returns:
- 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.
-
dataAccessRoleArn
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.
- Returns:
- 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.
-
settings
Makes it possible to control how your Medical Scribe job is processed using a
MedicalScribeSettings
object. SpecifyChannelIdentification
ifChannelDefinitions
are set. EnabledShowSpeakerLabels
ifChannelIdentification
andChannelDefinitions
are not set. One and only one ofChannelIdentification
andShowSpeakerLabels
must be set. IfShowSpeakerLabels
is set,MaxSpeakerLabels
must also be set. UseSettings
to specify a vocabulary or vocabulary filter or both usingVocabularyName
,VocabularyFilterName
.VocabularyFilterMethod
must be specified ifVocabularyFilterName
is set.- Returns:
- Makes it possible to control how your Medical Scribe job is processed using a
MedicalScribeSettings
object. SpecifyChannelIdentification
ifChannelDefinitions
are set. EnabledShowSpeakerLabels
ifChannelIdentification
andChannelDefinitions
are not set. One and only one ofChannelIdentification
andShowSpeakerLabels
must be set. IfShowSpeakerLabels
is set,MaxSpeakerLabels
must also be set. UseSettings
to specify a vocabulary or vocabulary filter or both usingVocabularyName
,VocabularyFilterName
.VocabularyFilterMethod
must be specified ifVocabularyFilterName
is set.
-
hasChannelDefinitions
public final boolean hasChannelDefinitions()For responses, this returns true if the service returned a value for the ChannelDefinitions property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
channelDefinitions
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 firstChannelDefinition
in the list to0
(to indicate the first channel) andParticipantRole
toCLINICIAN
(to indicate that it's the clinician speaking). Then you would set theChannelId
of the secondChannelDefinition
in the list to1
(to indicate the second channel) andParticipantRole
toPATIENT
(to indicate that it's the patient speaking).Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasChannelDefinitions()
method.- Returns:
- 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 firstChannelDefinition
in the list to0
(to indicate the first channel) andParticipantRole
toCLINICIAN
(to indicate that it's the clinician speaking). Then you would set theChannelId
of the secondChannelDefinition
in the list to1
(to indicate the second channel) andParticipantRole
toPATIENT
(to indicate that it's the patient speaking).
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()
method.- Returns:
- 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.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<StartMedicalScribeJobRequest.Builder,
StartMedicalScribeJobRequest> - Specified by:
toBuilder
in classTranscribeRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-