Class MedicalScribeJob
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<MedicalScribeJob.Builder,
MedicalScribeJob>
Provides detailed information about a Medical Scribe job.
To view the status of the specified Medical Scribe job, check the MedicalScribeJobStatus
field. If the
status is COMPLETED
, the job is finished and you can find the results at the locations specified in
MedicalScribeOutput
. If the status is FAILED
, FailureReason
provides details
on why your Medical Scribe job failed.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic MedicalScribeJob.Builder
builder()
Makes it possible to specify which speaker is on which channel.final Instant
The date and time the specified Medical Scribe job finished processing.final Instant
The date and time the specified Medical Scribe job request was made.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 String
IfMedicalScribeJobStatus
isFAILED
,FailureReason
contains information about why the transcription job failed.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the ChannelDefinitions property.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.The language code used to create your Medical Scribe job.final String
The language code used to create your Medical Scribe job.final Media
media()
Returns the value of the Media property for this object.final String
The name of the Medical Scribe job.final MedicalScribeJobStatus
Provides the status of the specified Medical Scribe job.final String
Provides the status of the specified Medical Scribe job.final MedicalScribeOutput
The location of the output of your Medical Scribe job.static Class
<? extends MedicalScribeJob.Builder> final MedicalScribeSettings
settings()
Makes it possible to control how your Medical Scribe job is processed using aMedicalScribeSettings
object.final Instant
The date and time your Medical Scribe job began processing.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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
medicalScribeJobName
The name of the Medical Scribe job. Job names are case sensitive and must be unique within an Amazon Web Services account.
- Returns:
- The name of the Medical Scribe job. Job names are case sensitive and must be unique within an Amazon Web Services account.
-
medicalScribeJobStatus
Provides the status of the specified Medical Scribe job.
If the status is
COMPLETED
, the job is finished and you can find the results at the location specified inMedicalScribeOutput
If the status isFAILED
,FailureReason
provides details on why your Medical Scribe job failed.If the service returns an enum value that is not available in the current SDK version,
medicalScribeJobStatus
will returnMedicalScribeJobStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommedicalScribeJobStatusAsString()
.- Returns:
- Provides the status of the specified Medical Scribe job.
If the status is
COMPLETED
, the job is finished and you can find the results at the location specified inMedicalScribeOutput
If the status isFAILED
,FailureReason
provides details on why your Medical Scribe job failed. - See Also:
-
medicalScribeJobStatusAsString
Provides the status of the specified Medical Scribe job.
If the status is
COMPLETED
, the job is finished and you can find the results at the location specified inMedicalScribeOutput
If the status isFAILED
,FailureReason
provides details on why your Medical Scribe job failed.If the service returns an enum value that is not available in the current SDK version,
medicalScribeJobStatus
will returnMedicalScribeJobStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommedicalScribeJobStatusAsString()
.- Returns:
- Provides the status of the specified Medical Scribe job.
If the status is
COMPLETED
, the job is finished and you can find the results at the location specified inMedicalScribeOutput
If the status isFAILED
,FailureReason
provides details on why your Medical Scribe job failed. - See Also:
-
languageCode
The language code used to create your Medical Scribe job. US English (
en-US
) is the only supported language for Medical Scribe jobs.If the service returns an enum value that is not available in the current SDK version,
languageCode
will returnMedicalScribeLanguageCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlanguageCodeAsString()
.- Returns:
- The language code used to create your Medical Scribe job. US English (
en-US
) is the only supported language for Medical Scribe jobs. - See Also:
-
languageCodeAsString
The language code used to create your Medical Scribe job. US English (
en-US
) is the only supported language for Medical Scribe jobs.If the service returns an enum value that is not available in the current SDK version,
languageCode
will returnMedicalScribeLanguageCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlanguageCodeAsString()
.- Returns:
- The language code used to create your Medical Scribe job. US English (
en-US
) is the only supported language for Medical Scribe jobs. - See Also:
-
media
Returns the value of the Media property for this object.- Returns:
- The value of the Media property for this object.
-
medicalScribeOutput
The location of the output of your Medical Scribe job.
ClinicalDocumentUri
holds the Amazon S3 URI for the Clinical Document andTranscriptFileUri
holds the Amazon S3 URI for the Transcript.- Returns:
- The location of the output of your Medical Scribe job.
ClinicalDocumentUri
holds the Amazon S3 URI for the Clinical Document andTranscriptFileUri
holds the Amazon S3 URI for the Transcript.
-
startTime
The date and time your Medical Scribe job began processing.
Timestamps are in the format
YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC
. For example,2022-05-04T12:32:58.789000-07:00
represents a Medical Scribe job that started processing at 12:32 PM UTC-7 on May 4, 2022.- Returns:
- The date and time your Medical Scribe job began processing.
Timestamps are in the format
YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC
. For example,2022-05-04T12:32:58.789000-07:00
represents a Medical Scribe job that started processing at 12:32 PM UTC-7 on May 4, 2022.
-
creationTime
The date and time the specified Medical Scribe job request was made.
Timestamps are in the format
YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC
. For example,2022-05-04T12:32:58.761000-07:00
represents a Medical Scribe job that started processing at 12:32 PM UTC-7 on May 4, 2022.- Returns:
- The date and time the specified Medical Scribe job request was made.
Timestamps are in the format
YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC
. For example,2022-05-04T12:32:58.761000-07:00
represents a Medical Scribe job that started processing at 12:32 PM UTC-7 on May 4, 2022.
-
completionTime
The date and time the specified Medical Scribe job finished processing.
Timestamps are in the format
YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC
. For example,2022-05-04T12:32:58.761000-07:00
represents a Medical Scribe job that finished processing at 12:32 PM UTC-7 on May 4, 2022.- Returns:
- The date and time the specified Medical Scribe job finished processing.
Timestamps are in the format
YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC
. For example,2022-05-04T12:32:58.761000-07:00
represents a Medical Scribe job that finished processing at 12:32 PM UTC-7 on May 4, 2022.
-
failureReason
If
MedicalScribeJobStatus
isFAILED
,FailureReason
contains information about why the transcription job failed. See also: Common Errors.- Returns:
- If
MedicalScribeJobStatus
isFAILED
,FailureReason
contains information about why the transcription job failed. See also: Common Errors.
-
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.
-
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.
-
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<MedicalScribeJob.Builder,
MedicalScribeJob> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
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
-
sdkFields
-