software.amazon.awssdk.services.transcribe.model

Interface StartCallAnalyticsJobRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<StartCallAnalyticsJobRequest.Builder,StartCallAnalyticsJobRequest>, SdkBuilder<StartCallAnalyticsJobRequest.Builder,StartCallAnalyticsJobRequest>, SdkPojo, SdkRequest.Builder, TranscribeRequest.Builder

Enclosing class:

StartCallAnalyticsJobRequest

public static interface StartCallAnalyticsJobRequest.Builder
extends TranscribeRequest.Builder, SdkPojo, CopyableBuilder<StartCallAnalyticsJobRequest.Builder,StartCallAnalyticsJobRequest>

Method Summary

Modifier and Type	Method and Description
StartCallAnalyticsJobRequest.Builder	callAnalyticsJobName(String callAnalyticsJobName) The name of the call analytics job.
StartCallAnalyticsJobRequest.Builder	channelDefinitions(ChannelDefinition... channelDefinitions) When you start a call analytics job, you must pass an array that maps the agent and the customer to specific audio channels.
StartCallAnalyticsJobRequest.Builder	channelDefinitions(Collection<ChannelDefinition> channelDefinitions) When you start a call analytics job, you must pass an array that maps the agent and the customer to specific audio channels.
StartCallAnalyticsJobRequest.Builder	channelDefinitions(Consumer<ChannelDefinition.Builder>... channelDefinitions) When you start a call analytics job, you must pass an array that maps the agent and the customer to specific audio channels.
StartCallAnalyticsJobRequest.Builder	dataAccessRoleArn(String dataAccessRoleArn) The Amazon Resource Name (ARN) of a role that has access to the S3 bucket that contains your input files.
default StartCallAnalyticsJobRequest.Builder	media(Consumer<Media.Builder> media) Sets the value of the Media property for this object.
StartCallAnalyticsJobRequest.Builder	media(Media media) Sets the value of the Media property for this object.
StartCallAnalyticsJobRequest.Builder	outputEncryptionKMSKeyId(String outputEncryptionKMSKeyId) The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service key used to encrypt the output of the call analytics job.
StartCallAnalyticsJobRequest.Builder	outputLocation(String outputLocation) The Amazon S3 location where the output of the call analytics job is stored.
StartCallAnalyticsJobRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
StartCallAnalyticsJobRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
StartCallAnalyticsJobRequest.Builder	settings(CallAnalyticsJobSettings settings) A Settings object that provides optional settings for a call analytics job.
default StartCallAnalyticsJobRequest.Builder	settings(Consumer<CallAnalyticsJobSettings.Builder> settings) A Settings object that provides optional settings for a call analytics job.

Methods inherited from interface software.amazon.awssdk.services.transcribe.model.TranscribeRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

StartCallAnalyticsJobRequest.Builder callAnalyticsJobName(String callAnalyticsJobName)

The name of the call analytics job. You can't use the string "." or ".." by themselves as the job name. The name must also be unique within an Amazon Web Services account. If you try to create a call analytics job with the same name as a previous call analytics job, you get a ConflictException error.

Parameters:

callAnalyticsJobName - The name of the call analytics job. You can't use the string "." or ".." by themselves as the job name. The name must also be unique within an Amazon Web Services account. If you try to create a call analytics job with the same name as a previous call analytics job, you get a ConflictException error.

Returns:

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

media

StartCallAnalyticsJobRequest.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 StartCallAnalyticsJobRequest.Builder media(Consumer<Media.Builder> media)

Sets the value of the Media property for this object. This is a convenience 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)

outputLocation

StartCallAnalyticsJobRequest.Builder outputLocation(String outputLocation)

The Amazon S3 location where the output of the call analytics job is stored. You can provide the following location types to store the output of call analytics job:

• s3://DOC-EXAMPLE-BUCKET1

  If you specify a bucket, Amazon Transcribe saves the output of the analytics job as a JSON file at the root level of the bucket.

• s3://DOC-EXAMPLE-BUCKET1/folder/

  f you specify a path, Amazon Transcribe saves the output of the analytics job as s3://DOC-EXAMPLE-BUCKET1/folder/your-transcription-job-name.json

  If you specify a folder, you must provide a trailing slash.

• s3://DOC-EXAMPLE-BUCKET1/folder/filename.json

  If you provide a path that has the filename specified, Amazon Transcribe saves the output of the analytics job as s3://DOC-EXAMPLEBUCKET1/folder/filename.json

You can specify an Amazon Web Services Key Management Service (KMS) key to encrypt the output of our analytics job using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption of the analytics job output that is placed in your S3 bucket.

Parameters:

outputLocation - The Amazon S3 location where the output of the call analytics job is stored. You can provide the following location types to store the output of call analytics job:

• s3://DOC-EXAMPLE-BUCKET1

  If you specify a bucket, Amazon Transcribe saves the output of the analytics job as a JSON file at the root level of the bucket.

• s3://DOC-EXAMPLE-BUCKET1/folder/

  f you specify a path, Amazon Transcribe saves the output of the analytics job as s3://DOC-EXAMPLE-BUCKET1/folder/your-transcription-job-name.json

  If you specify a folder, you must provide a trailing slash.

• s3://DOC-EXAMPLE-BUCKET1/folder/filename.json

  If you provide a path that has the filename specified, Amazon Transcribe saves the output of the analytics job as s3://DOC-EXAMPLEBUCKET1/folder/filename.json

You can specify an Amazon Web Services Key Management Service (KMS) key to encrypt the output of our analytics job using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption of the analytics job output that is placed in your S3 bucket.

Returns:

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

outputEncryptionKMSKeyId

StartCallAnalyticsJobRequest.Builder outputEncryptionKMSKeyId(String outputEncryptionKMSKeyId)

The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service key used to encrypt the output of the call analytics job. The user calling the operation must have permission to use the specified KMS key.

You use either of the following to identify an Amazon Web Services KMS key in the current account:

• KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

• KMS Key Alias: "alias/ExampleAlias"

You can use either of the following to identify a KMS key in the current account or another account:

• Amazon Resource Name (ARN) of a KMS key in the current account or another account: "arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef1234567890ab"

• ARN of a KMS Key Alias: "arn:aws:kms:region:account ID:alias/ExampleAlias"

If you don't specify an encryption key, the output of the call analytics job is encrypted with the default Amazon S3 key (SSE-S3).

If you specify a KMS key to encrypt your output, you must also specify an output location in the OutputLocation parameter.

Parameters:

outputEncryptionKMSKeyId - The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service key used to encrypt the output of the call analytics job. The user calling the operation must have permission to use the specified KMS key.

You use either of the following to identify an Amazon Web Services KMS key in the current account:

• KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

• KMS Key Alias: "alias/ExampleAlias"

You can use either of the following to identify a KMS key in the current account or another account:

• Amazon Resource Name (ARN) of a KMS key in the current account or another account: "arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef1234567890ab"

• ARN of a KMS Key Alias: "arn:aws:kms:region:account ID:alias/ExampleAlias"

If you don't specify an encryption key, the output of the call analytics job is encrypted with the default Amazon S3 key (SSE-S3).

If you specify a KMS key to encrypt your output, you must also specify an output location in the OutputLocation parameter.

Returns:

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

dataAccessRoleArn

StartCallAnalyticsJobRequest.Builder dataAccessRoleArn(String dataAccessRoleArn)

The Amazon Resource Name (ARN) of a role that has access to the S3 bucket that contains your input files. Amazon Transcribe assumes this role to read queued audio files. If you have specified an output S3 bucket for your transcription results, this role should have access to the output bucket as well.

Parameters:

dataAccessRoleArn - The Amazon Resource Name (ARN) of a role that has access to the S3 bucket that contains your input files. Amazon Transcribe assumes this role to read queued audio files. If you have specified an output S3 bucket for your transcription results, this role should have access to the output bucket as well.

Returns:

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

settings

StartCallAnalyticsJobRequest.Builder settings(CallAnalyticsJobSettings settings)

A Settings object that provides optional settings for a call analytics job.

Parameters:

settings - A Settings object that provides optional settings for a call analytics job.

Returns:

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

settings

default StartCallAnalyticsJobRequest.Builder settings(Consumer<CallAnalyticsJobSettings.Builder> settings)

A Settings object that provides optional settings for a call analytics job.

This is a convenience 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

StartCallAnalyticsJobRequest.Builder channelDefinitions(Collection<ChannelDefinition> channelDefinitions)

When you start a call analytics job, you must pass an array that maps the agent and the customer to specific audio channels. The values you can assign to a channel are 0 and 1. The agent and the customer must each have their own channel. You can't assign more than one channel to an agent or customer.

Parameters:

channelDefinitions - When you start a call analytics job, you must pass an array that maps the agent and the customer to specific audio channels. The values you can assign to a channel are 0 and 1. The agent and the customer must each have their own channel. You can't assign more than one channel to an agent or customer.

Returns:

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

channelDefinitions

StartCallAnalyticsJobRequest.Builder channelDefinitions(ChannelDefinition... channelDefinitions)

When you start a call analytics job, you must pass an array that maps the agent and the customer to specific audio channels. The values you can assign to a channel are 0 and 1. The agent and the customer must each have their own channel. You can't assign more than one channel to an agent or customer.

Parameters:

channelDefinitions - When you start a call analytics job, you must pass an array that maps the agent and the customer to specific audio channels. The values you can assign to a channel are 0 and 1. The agent and the customer must each have their own channel. You can't assign more than one channel to an agent or customer.

Returns:

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

channelDefinitions

StartCallAnalyticsJobRequest.Builder channelDefinitions(Consumer<ChannelDefinition.Builder>... channelDefinitions)

When you start a call analytics job, you must pass an array that maps the agent and the customer to specific audio channels. The values you can assign to a channel are 0 and 1. The agent and the customer must each have their own channel. You can't assign more than one channel to an agent or customer.

This is a convenience 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)

overrideConfiguration

StartCallAnalyticsJobRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

StartCallAnalyticsJobRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder