CallAnalyticsJob (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.transcribe.model.CallAnalyticsJob

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CallAnalyticsJob.Builder,CallAnalyticsJob>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class CallAnalyticsJob
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CallAnalyticsJob.Builder,CallAnalyticsJob>
```
Provides detailed information about a Call Analytics job.

To view the job's status, refer to CallAnalyticsJobStatus. If the status is COMPLETED, the job is finished. You can find your completed transcript at the URI specified in TranscriptFileUri. If the status is FAILED, FailureReason provides details on why your transcription job failed.

If you enabled personally identifiable information (PII) redaction, the redacted transcript appears at the location specified in RedactedTranscriptFileUri.

If you chose to redact the audio in your media file, you can find your redacted media file at the location specified in the RedactedMediaFileUri field of your response.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CallAnalyticsJob.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CallAnalyticsJob.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CallAnalyticsJob.Builder`	`builder()`
`String`	`callAnalyticsJobName()` The name of the Call Analytics job.
`CallAnalyticsJobStatus`	`callAnalyticsJobStatus()` Provides the status of the specified Call Analytics job.
`String`	`callAnalyticsJobStatusAsString()` Provides the status of the specified Call Analytics job.
`List<ChannelDefinition>`	`channelDefinitions()` Allows you to specify which speaker is on which channel in your Call Analytics job request.
`Instant`	`completionTime()` The date and time the specified Call Analytics job finished processing.
`Instant`	`creationTime()` The date and time the specified Call Analytics job request was made.
`String`	`dataAccessRoleArn()` The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`failureReason()` If `CallAnalyticsJobStatus` is `FAILED`, `FailureReason` contains information about why the Call Analytics job request failed.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasChannelDefinitions()` For responses, this returns true if the service returned a value for the ChannelDefinitions property.
`int`	`hashCode()`
`Float`	`identifiedLanguageScore()` The confidence score associated with the language identified in your media file.
`LanguageCode`	`languageCode()` The language code used to create your Call Analytics job.
`String`	`languageCodeAsString()` The language code used to create your Call Analytics job.
`Media`	`media()` Returns the value of the Media property for this object.
`MediaFormat`	`mediaFormat()` The format of the input media file.
`String`	`mediaFormatAsString()` The format of the input media file.
`Integer`	`mediaSampleRateHertz()` The sample rate, in Hertz, of the audio track in your input media file.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CallAnalyticsJob.Builder>`	`serializableBuilderClass()`
`CallAnalyticsJobSettings`	`settings()` Allows additional optional settings in your request, including content redaction; allows you to apply custom language models, vocabulary filters, and custom vocabularies to your Call Analytics job.
`Instant`	`startTime()` The date and time the specified Call Analytics job began processing.
`CallAnalyticsJob.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`Transcript`	`transcript()` Returns the value of the Transcript property for this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - callAnalyticsJobName
```
public final String callAnalyticsJobName()
```
    The name of the Call Analytics job. Job names are case sensitive and must be unique within an Amazon Web Services account.
    
    Returns:
    
    The name of the Call Analytics job. Job names are case sensitive and must be unique within an Amazon Web Services account.
  - callAnalyticsJobStatus
```
public final CallAnalyticsJobStatus callAnalyticsJobStatus()
```
    Provides the status of the specified Call Analytics 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, callAnalyticsJobStatus will return CallAnalyticsJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from callAnalyticsJobStatusAsString().
    
    Returns:
    
    Provides the status of the specified Call Analytics 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:
    
    CallAnalyticsJobStatus
  - callAnalyticsJobStatusAsString
```
public final String callAnalyticsJobStatusAsString()
```
    Provides the status of the specified Call Analytics 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, callAnalyticsJobStatus will return CallAnalyticsJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from callAnalyticsJobStatusAsString().
    
    Returns:
    
    Provides the status of the specified Call Analytics 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:
    
    CallAnalyticsJobStatus
  - languageCode
```
public final LanguageCode languageCode()
```
    The language code used to create your Call Analytics job. For a list of supported languages and their associated language codes, refer to the Supported languages table.
    
    If you don't know the language spoken in your media file, you can omit this field and let Amazon Transcribe automatically identify the language of your media. To improve the accuracy of language identification, you can include several language codes and Amazon Transcribe chooses the closest match for your transcription.
    
    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 Call Analytics job. For a list of supported languages and their associated language codes, refer to the Supported languages table.
    
    If you don't know the language spoken in your media file, you can omit this field and let Amazon Transcribe automatically identify the language of your media. To improve the accuracy of language identification, you can include several language codes and Amazon Transcribe chooses the closest match for your transcription.
    
    See Also:
    
    LanguageCode
  - languageCodeAsString
```
public final String languageCodeAsString()
```
    The language code used to create your Call Analytics job. For a list of supported languages and their associated language codes, refer to the Supported languages table.
    
    If you don't know the language spoken in your media file, you can omit this field and let Amazon Transcribe automatically identify the language of your media. To improve the accuracy of language identification, you can include several language codes and Amazon Transcribe chooses the closest match for your transcription.
    
    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 Call Analytics job. For a list of supported languages and their associated language codes, refer to the Supported languages table.
    
    If you don't know the language spoken in your media file, you can omit this field and let Amazon Transcribe automatically identify the language of your media. To improve the accuracy of language identification, you can include several language codes and Amazon Transcribe chooses the closest match for your transcription.
    
    See Also:
    
    LanguageCode
  - 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:
    
    MediaFormat
  - 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:
    
    MediaFormat
  - media
```
public final Media media()
```
    Returns the value of the Media property for this object.
    
    Returns:
    
    The value of the Media property for this object.
  - transcript
```
public final Transcript transcript()
```
    Returns the value of the Transcript property for this object.
    
    Returns:
    
    The value of the Transcript property for this object.
  - startTime
```
public final Instant startTime()
```
    The date and time the specified Call Analytics 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 Call Analytics 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 Call Analytics 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 Call Analytics 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 Call Analytics 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 Call Analytics 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 CallAnalyticsJobStatus is FAILED, FailureReason contains information about why the Call Analytics 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 MediaFormat 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 Guidelines and 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 Guidelines and quotas.
    Returns:
    If CallAnalyticsJobStatus is FAILED, FailureReason contains information about why the Call Analytics 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 MediaFormat 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 Guidelines and 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 Guidelines and quotas.
  - dataAccessRoleArn
```
public final String dataAccessRoleArn()
```
    The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files. If the role you specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, 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. If the role you specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, 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.
  - 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.
  - settings
```
public final CallAnalyticsJobSettings settings()
```
    Allows additional optional settings in your request, including content redaction; allows you to apply custom language models, vocabulary filters, and custom vocabularies to your Call Analytics job.
    
    Returns:
    
    Allows additional optional settings in your request, including content redaction; allows you to apply custom language models, vocabulary filters, and custom vocabularies to your Call Analytics job.
  - 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 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.
  - channelDefinitions
```
public final List<ChannelDefinition> channelDefinitions()
```
    Allows you to specify which speaker is on which channel in your Call Analytics job request. For example, if your agent is the first participant to speak, you would set ChannelId to 0 (to indicate the first channel) and ParticipantRole to AGENT (to indicate that it's the agent 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:
    
    Allows you to specify which speaker is on which channel in your Call Analytics job request. For example, if your agent is the first participant to speak, you would set ChannelId to 0 (to indicate the first channel) and ParticipantRole to AGENT (to indicate that it's the agent speaking).
  - toBuilder
```
public CallAnalyticsJob.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CallAnalyticsJob.Builder,CallAnalyticsJob>
  - builder
```
public static CallAnalyticsJob.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CallAnalyticsJob.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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class CallAnalyticsJob

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

callAnalyticsJobName

callAnalyticsJobStatus

callAnalyticsJobStatusAsString

languageCode

languageCodeAsString

mediaSampleRateHertz

mediaFormat

mediaFormatAsString

media

transcript

startTime

creationTime

completionTime

failureReason

dataAccessRoleArn

identifiedLanguageScore

settings

hasChannelDefinitions

channelDefinitions

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields