Package software.amazon.awssdk.services.transcribe.model

Class TranscriptionJob

java.lang.Object
software.amazon.awssdk.services.transcribe.model.TranscriptionJob
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<TranscriptionJob.Builder,TranscriptionJob>
@Generated("software.amazon.awssdk:codegen") public final class TranscriptionJob extends Object implements SdkPojo, Serializable, ToCopyableBuilder<TranscriptionJob.Builder,TranscriptionJob>

Provides detailed information about a transcription job.

To view the status of the specified transcription job, check the TranscriptionJobStatus field. If the status is COMPLETED, the job is finished and you can find the results at the location specified in TranscriptFileUri. If the status is FAILED, FailureReason provides details on why your transcription job failed.

If you enabled content redaction, the redacted transcript can be found at the location specified in RedactedTranscriptFileUri.

See Also:

  • Method Details

    • transcriptionJobName

      public final String transcriptionJobName()

      The name of the transcription job. Job names are case sensitive and must be unique within an Amazon Web Services account.

      Returns:
      The name of the transcription job. Job names are case sensitive and must be unique within an Amazon Web Services account.

    • transcriptionJobStatus

      public final TranscriptionJobStatus transcriptionJobStatus()

      Provides the status of the specified transcription job.

      If the status is COMPLETED, the job is finished and you can find the results at the location specified in TranscriptFileUri (or RedactedTranscriptFileUri, if you requested transcript redaction). If the status is FAILED, FailureReason provides details on why your transcription job failed.

      If the service returns an enum value that is not available in the current SDK version, transcriptionJobStatus will return TranscriptionJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from transcriptionJobStatusAsString().

      Returns:
      Provides the status of the specified transcription job.

      If the status is COMPLETED, the job is finished and you can find the results at the location specified in TranscriptFileUri (or RedactedTranscriptFileUri, if you requested transcript redaction). If the status is FAILED, FailureReason provides details on why your transcription job failed.

      See Also:

    • transcriptionJobStatusAsString

      public final String transcriptionJobStatusAsString()

      Provides the status of the specified transcription job.

      If the status is COMPLETED, the job is finished and you can find the results at the location specified in TranscriptFileUri (or RedactedTranscriptFileUri, if you requested transcript redaction). If the status is FAILED, FailureReason provides details on why your transcription job failed.

      If the service returns an enum value that is not available in the current SDK version, transcriptionJobStatus will return TranscriptionJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from transcriptionJobStatusAsString().

      Returns:
      Provides the status of the specified transcription job.

      If the status is COMPLETED, the job is finished and you can find the results at the location specified in TranscriptFileUri (or RedactedTranscriptFileUri, if you requested transcript redaction). If the status is FAILED, FailureReason provides details on why your transcription job failed.

      See Also:

    • languageCode

      public final LanguageCode languageCode()

      The language code used to create your transcription job. This parameter is used with single-language identification. For multi-language identification requests, refer to the plural version of this parameter, LanguageCodes.

      If the service returns an enum value that is not available in the current SDK version, languageCode will return LanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageCodeAsString().

      Returns:
      The language code used to create your transcription job. This parameter is used with single-language identification. For multi-language identification requests, refer to the plural version of this parameter, LanguageCodes.
      See Also:

    • languageCodeAsString

      public final String languageCodeAsString()

      The language code used to create your transcription job. This parameter is used with single-language identification. For multi-language identification requests, refer to the plural version of this parameter, LanguageCodes.

      If the service returns an enum value that is not available in the current SDK version, languageCode will return LanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageCodeAsString().

      Returns:
      The language code used to create your transcription job. This parameter is used with single-language identification. For multi-language identification requests, refer to the plural version of this parameter, LanguageCodes.
      See Also:

    • mediaSampleRateHertz

      public final Integer mediaSampleRateHertz()

      The sample rate, in hertz, of the audio track in your input media file.

      Returns:
      The sample rate, in hertz, of the audio track in your input media file.

    • mediaFormat

      public final MediaFormat mediaFormat()

      The format of the input media file.

      If the service returns an enum value that is not available in the current SDK version, mediaFormat will return MediaFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from mediaFormatAsString().

      Returns:
      The format of the input media file.
      See Also:

    • mediaFormatAsString

      public final String mediaFormatAsString()

      The format of the input media file.

      If the service returns an enum value that is not available in the current SDK version, mediaFormat will return MediaFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from mediaFormatAsString().

      Returns:
      The format of the input media file.
      See Also:

    • media

      public final Media media()

      Provides the Amazon S3 location of the media file you used in your request.

      Returns:
      Provides the Amazon S3 location of the media file you used in your request.

    • transcript

      public final Transcript transcript()

      Provides you with the Amazon S3 URI you can use to access your transcript.

      Returns:
      Provides you with the Amazon S3 URI you can use to access your transcript.

    • startTime

      public final Instant startTime()

      The date and time the specified transcription 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 transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.

      Returns:
      The date and time the specified transcription 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 transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.

    • creationTime

      public final Instant creationTime()

      The date and time the specified transcription 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 transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.

      Returns:
      The date and time the specified transcription 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 transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.

    • completionTime

      public final Instant completionTime()

      The date and time the specified transcription job finished processing.

      Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started processing at 12:33 PM UTC-7 on May 4, 2022.

      Returns:
      The date and time the specified transcription job finished processing.

      Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started processing at 12:33 PM UTC-7 on May 4, 2022.

    • failureReason

      public final String failureReason()

      If TranscriptionJobStatus is FAILED, FailureReason contains information about why the transcription job request failed.

      The FailureReason field contains one of the following values:

      • Unsupported media format.

        The media format specified in MediaFormat isn't valid. Refer to refer to the MediaFormat parameter for a list of supported formats.

      • The media format provided does not match the detected media format.

        The media format specified in MediaFormat doesn't match the format of the input file. Check the media format of your media file and correct the specified value.

      • Invalid sample rate for audio file.

        The sample rate specified in MediaSampleRateHertz isn't valid. The sample rate must be between 8,000 and 48,000 hertz.

      • The sample rate provided does not match the detected sample rate.

        The sample rate specified in MediaSampleRateHertz doesn't match the sample rate detected in your input media file. Check the sample rate of your media file and correct the specified value.

      • Invalid file size: file size too large.

        The size of your media file is larger than what Amazon Transcribe can process. For more information, refer to Service quotas.

      • Invalid number of channels: number of channels too large.

        Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer to Service quotas.

      Returns:
      If TranscriptionJobStatus is FAILED, FailureReason contains information about why the transcription job request failed.

      The FailureReason field contains one of the following values:

      • Unsupported media format.

        The media format specified in MediaFormat isn't valid. Refer to refer to the MediaFormat parameter for a list of supported formats.

      • The media format provided does not match the detected media format.

        The media format specified in MediaFormat doesn't match the format of the input file. Check the media format of your media file and correct the specified value.

      • Invalid sample rate for audio file.

        The sample rate specified in MediaSampleRateHertz isn't valid. The sample rate must be between 8,000 and 48,000 hertz.

      • The sample rate provided does not match the detected sample rate.

        The sample rate specified in MediaSampleRateHertz doesn't match the sample rate detected in your input media file. Check the sample rate of your media file and correct the specified value.

      • Invalid file size: file size too large.

        The size of your media file is larger than what Amazon Transcribe can process. For more information, refer to Service quotas.

      • Invalid number of channels: number of channels too large.

        Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer to Service quotas.

    • settings

      public final Settings settings()

      Provides information on any additional settings that were included in your request. Additional settings include channel identification, alternative transcriptions, speaker partitioning, custom vocabularies, and custom vocabulary filters.

      Returns:
      Provides information on any additional settings that were included in your request. Additional settings include channel identification, alternative transcriptions, speaker partitioning, custom vocabularies, and custom vocabulary filters.

    • modelSettings

      public final ModelSettings modelSettings()

      Provides information on the custom language model you included in your request.

      Returns:
      Provides information on the custom language model you included in your request.

    • jobExecutionSettings

      public final JobExecutionSettings jobExecutionSettings()

      Provides information about how your transcription job was processed. This parameter shows if your request was queued and what data access role was used.

      Returns:
      Provides information about how your transcription job was processed. This parameter shows if your request was queued and what data access role was used.

    • contentRedaction

      public final ContentRedaction contentRedaction()

      Indicates whether redaction was enabled in your transcript.

      Returns:
      Indicates whether redaction was enabled in your transcript.

    • identifyLanguage

      public final Boolean identifyLanguage()

      Indicates whether automatic language identification was enabled (TRUE) for the specified transcription job.

      Returns:
      Indicates whether automatic language identification was enabled (TRUE) for the specified transcription job.

    • identifyMultipleLanguages

      public final Boolean identifyMultipleLanguages()

      Indicates whether automatic multi-language identification was enabled (TRUE) for the specified transcription job.

      Returns:
      Indicates whether automatic multi-language identification was enabled (TRUE) for the specified transcription job.

    • languageOptions

      public final List<LanguageCode> languageOptions()

      Provides the language codes you specified in your request.

      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 hasLanguageOptions() method.

      Returns:
      Provides the language codes you specified in your request.

    • hasLanguageOptions

      public final boolean hasLanguageOptions()
      For responses, this returns true if the service returned a value for the LanguageOptions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

    • languageOptionsAsStrings

      public final List<String> languageOptionsAsStrings()

      Provides the language codes you specified in your request.

      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 hasLanguageOptions() method.

      Returns:
      Provides the language codes you specified in your request.

    • identifiedLanguageScore

      public final Float identifiedLanguageScore()

      The confidence score associated with the language identified in your media file.

      Confidence scores are values between 0 and 1; a larger value indicates a higher probability that the identified language correctly matches the language spoken in your media.

      Returns:
      The confidence score associated with the language identified in your media file.

      Confidence scores are values between 0 and 1; a larger value indicates a higher probability that the identified language correctly matches the language spoken in your media.

    • hasLanguageCodes

      public final boolean hasLanguageCodes()
      For responses, this returns true if the service returned a value for the LanguageCodes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

    • languageCodes

      public final List<LanguageCodeItem> languageCodes()

      The language codes used to create your transcription job. This parameter is used with multi-language identification. For single-language identification requests, refer to the singular version of this parameter, LanguageCode.

      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 hasLanguageCodes() method.

      Returns:
      The language codes used to create your transcription job. This parameter is used with multi-language identification. For single-language identification requests, refer to the singular version of this parameter, LanguageCode.

    • 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 the isEmpty() 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

      public final List<Tag> tags()

      The tags, each in the form of a key:value pair, assigned to the specified transcription job.

      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:
      The tags, each in the form of a key:value pair, assigned to the specified transcription job.

    • subtitles

      public final SubtitlesOutput subtitles()

      Indicates whether subtitles were generated with your transcription.

      Returns:
      Indicates whether subtitles were generated with your transcription.

    • languageIdSettings

      public final Map<LanguageCode,LanguageIdSettings> languageIdSettings()

      Provides the name and language of all custom language models, custom vocabularies, and custom vocabulary filters that you included in your request.

      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 hasLanguageIdSettings() method.

      Returns:
      Provides the name and language of all custom language models, custom vocabularies, and custom vocabulary filters that you included in your request.

    • hasLanguageIdSettings

      public final boolean hasLanguageIdSettings()
      For responses, this returns true if the service returned a value for the LanguageIdSettings property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

    • languageIdSettingsAsStrings

      public final Map<String,LanguageIdSettings> languageIdSettingsAsStrings()

      Provides the name and language of all custom language models, custom vocabularies, and custom vocabulary filters that you included in your request.

      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 hasLanguageIdSettings() method.

      Returns:
      Provides the name and language of all custom language models, custom vocabularies, and custom vocabulary filters that you included in your request.

    • hasToxicityDetection

      public final boolean hasToxicityDetection()
      For responses, this returns true if the service returned a value for the ToxicityDetection property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

    • toxicityDetection

      public final List<ToxicityDetectionSettings> toxicityDetection()

      Provides information about the toxicity detection settings applied to your transcription.

      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 hasToxicityDetection() method.

      Returns:
      Provides information about the toxicity detection settings applied to your transcription.

    • toBuilder

      public TranscriptionJob.Builder 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 interface ToCopyableBuilder<TranscriptionJob.Builder,TranscriptionJob>
      Returns:
      a builder for type T

    • builder

      public static TranscriptionJob.Builder builder()

    • serializableBuilderClass

      public static Class<? extends TranscriptionJob.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String 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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.