software.amazon.awssdk.services.transcribe.model

Interface CallAnalyticsJob.Builder

All Superinterfaces:

Buildable, CopyableBuilder<CallAnalyticsJob.Builder,CallAnalyticsJob>, SdkBuilder<CallAnalyticsJob.Builder,CallAnalyticsJob>, SdkPojo

Enclosing class:

CallAnalyticsJob

public static interface CallAnalyticsJob.Builder
extends SdkPojo, CopyableBuilder<CallAnalyticsJob.Builder,CallAnalyticsJob>

Method Summary

Modifier and Type	Method and Description
CallAnalyticsJob.Builder	callAnalyticsJobName(String callAnalyticsJobName) The name of the Call Analytics job.
CallAnalyticsJob.Builder	callAnalyticsJobStatus(CallAnalyticsJobStatus callAnalyticsJobStatus) Provides the status of the specified Call Analytics job.
CallAnalyticsJob.Builder	callAnalyticsJobStatus(String callAnalyticsJobStatus) Provides the status of the specified Call Analytics job.
CallAnalyticsJob.Builder	channelDefinitions(ChannelDefinition... channelDefinitions) Allows you to specify which speaker is on which channel in your Call Analytics job request.
CallAnalyticsJob.Builder	channelDefinitions(Collection<ChannelDefinition> channelDefinitions) Allows you to specify which speaker is on which channel in your Call Analytics job request.
CallAnalyticsJob.Builder	channelDefinitions(Consumer<ChannelDefinition.Builder>... channelDefinitions) Allows you to specify which speaker is on which channel in your Call Analytics job request.
CallAnalyticsJob.Builder	completionTime(Instant completionTime) The date and time the specified Call Analytics job finished processing.
CallAnalyticsJob.Builder	creationTime(Instant creationTime) The date and time the specified Call Analytics job request was made.
CallAnalyticsJob.Builder	dataAccessRoleArn(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.
CallAnalyticsJob.Builder	failureReason(String failureReason) If CallAnalyticsJobStatus is FAILED, FailureReason contains information about why the Call Analytics job request failed.
CallAnalyticsJob.Builder	identifiedLanguageScore(Float identifiedLanguageScore) The confidence score associated with the language identified in your media file.
CallAnalyticsJob.Builder	languageCode(LanguageCode languageCode) The language code used to create your Call Analytics job.
CallAnalyticsJob.Builder	languageCode(String languageCode) The language code used to create your Call Analytics job.
default CallAnalyticsJob.Builder	media(Consumer<Media.Builder> media) Sets the value of the Media property for this object.
CallAnalyticsJob.Builder	media(Media media) Sets the value of the Media property for this object.
CallAnalyticsJob.Builder	mediaFormat(MediaFormat mediaFormat) The format of the input media file.
CallAnalyticsJob.Builder	mediaFormat(String mediaFormat) The format of the input media file.
CallAnalyticsJob.Builder	mediaSampleRateHertz(Integer mediaSampleRateHertz) The sample rate, in Hertz, of the audio track in your input media file.
CallAnalyticsJob.Builder	settings(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.
default CallAnalyticsJob.Builder	settings(Consumer<CallAnalyticsJobSettings.Builder> 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.
CallAnalyticsJob.Builder	startTime(Instant startTime) The date and time the specified Call Analytics job began processing.
default CallAnalyticsJob.Builder	transcript(Consumer<Transcript.Builder> transcript) Sets the value of the Transcript property for this object.
CallAnalyticsJob.Builder	transcript(Transcript transcript) Sets the value of the Transcript property for this object.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

callAnalyticsJobName

CallAnalyticsJob.Builder callAnalyticsJobName(String callAnalyticsJobName)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

callAnalyticsJobStatus

CallAnalyticsJob.Builder callAnalyticsJobStatus(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

CallAnalyticsJobStatus, CallAnalyticsJobStatus

callAnalyticsJobStatus

CallAnalyticsJob.Builder callAnalyticsJobStatus(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

CallAnalyticsJobStatus, CallAnalyticsJobStatus

languageCode

CallAnalyticsJob.Builder languageCode(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

LanguageCode, LanguageCode

languageCode

CallAnalyticsJob.Builder languageCode(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

LanguageCode, LanguageCode

mediaSampleRateHertz

CallAnalyticsJob.Builder mediaSampleRateHertz(Integer mediaSampleRateHertz)

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

Parameters:

mediaSampleRateHertz - The sample rate, in Hertz, of the audio track in your input media file.

Returns:

Returns a reference to this object so that method calls can be chained together.

mediaFormat

CallAnalyticsJob.Builder mediaFormat(String mediaFormat)

The format of the input media file.

Parameters:

mediaFormat - The format of the input media file.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MediaFormat, MediaFormat

mediaFormat

CallAnalyticsJob.Builder mediaFormat(MediaFormat mediaFormat)

The format of the input media file.

Parameters:

mediaFormat - The format of the input media file.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MediaFormat, MediaFormat

media

CallAnalyticsJob.Builder media(Media media)

Sets the value of the Media property for this object.

Parameters:

media - The new value for the Media property for this object.

Returns:

Returns a reference to this object so that method calls can be chained together.

media

default CallAnalyticsJob.Builder media(Consumer<Media.Builder> media)

Sets the value of the Media property for this object. This is a convenience method that creates an instance of the Media.Builder avoiding the need to create one manually via Media.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to media(Media).

Parameters:

media - a consumer that will call methods on Media.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

media(Media)

transcript

CallAnalyticsJob.Builder transcript(Transcript transcript)

Sets the value of the Transcript property for this object.

Parameters:

transcript - The new value for the Transcript property for this object.

Returns:

Returns a reference to this object so that method calls can be chained together.

transcript

default CallAnalyticsJob.Builder transcript(Consumer<Transcript.Builder> transcript)

Sets the value of the Transcript property for this object. This is a convenience method that creates an instance of the Transcript.Builder avoiding the need to create one manually via Transcript.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to transcript(Transcript).

Parameters:

transcript - a consumer that will call methods on Transcript.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

transcript(Transcript)

startTime

CallAnalyticsJob.Builder startTime(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

creationTime

CallAnalyticsJob.Builder creationTime(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

completionTime

CallAnalyticsJob.Builder completionTime(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

failureReason

CallAnalyticsJob.Builder failureReason(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

dataAccessRoleArn

CallAnalyticsJob.Builder dataAccessRoleArn(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

identifiedLanguageScore

CallAnalyticsJob.Builder identifiedLanguageScore(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

settings

CallAnalyticsJob.Builder settings(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

settings

default CallAnalyticsJob.Builder settings(Consumer<CallAnalyticsJobSettings.Builder> 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.

This is a convenience method that creates an instance of the CallAnalyticsJobSettings.Builder avoiding the need to create one manually via CallAnalyticsJobSettings.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to settings(CallAnalyticsJobSettings).

Parameters:

settings - a consumer that will call methods on CallAnalyticsJobSettings.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

settings(CallAnalyticsJobSettings)

channelDefinitions

CallAnalyticsJob.Builder channelDefinitions(Collection<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).

Parameters:

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).

Returns:

Returns a reference to this object so that method calls can be chained together.

channelDefinitions

CallAnalyticsJob.Builder channelDefinitions(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).

Parameters:

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).

Returns:

Returns a reference to this object so that method calls can be chained together.

channelDefinitions

CallAnalyticsJob.Builder channelDefinitions(Consumer<ChannelDefinition.Builder>... 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).

This is a convenience method that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #channelDefinitions(List).

Parameters:

channelDefinitions - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#channelDefinitions(List)