software.amazon.awssdk.services.transcribe.model

Class StartCallAnalyticsJobRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.transcribe.model.TranscribeRequest

software.amazon.awssdk.services.transcribe.model.StartCallAnalyticsJobRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartCallAnalyticsJobRequest.Builder,StartCallAnalyticsJobRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class StartCallAnalyticsJobRequest
extends TranscribeRequest
implements ToCopyableBuilder<StartCallAnalyticsJobRequest.Builder,StartCallAnalyticsJobRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StartCallAnalyticsJobRequest.Builder

Method Summary

Modifier and Type	Method and Description
static StartCallAnalyticsJobRequest.Builder	builder()
String	callAnalyticsJobName() The name of the call analytics job.
List<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.
String	dataAccessRoleArn() The Amazon Resource Name (ARN) of a role that has access to the S3 bucket that contains your input files.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<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()
Media	media() Returns the value of the Media property for this object.
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.
String	outputLocation() The Amazon S3 location where the output of the call analytics job is stored.
List<SdkField<?>>	sdkFields()
static Class<? extends StartCallAnalyticsJobRequest.Builder>	serializableBuilderClass()
CallAnalyticsJobSettings	settings() A Settings object that provides optional settings for a call analytics job.
StartCallAnalyticsJobRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

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.

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.

outputLocation

public final 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.

Returns:

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.

outputEncryptionKMSKeyId

public final 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.

Returns:

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.

dataAccessRoleArn

public final 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.

Returns:

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.

settings

public final CallAnalyticsJobSettings settings()

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

Returns:

A Settings object that provides optional settings for a 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()

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.

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:

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.

toBuilder

public StartCallAnalyticsJobRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartCallAnalyticsJobRequest.Builder,StartCallAnalyticsJobRequest>

Specified by:

toBuilder in class TranscribeRequest

builder

public static StartCallAnalyticsJobRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo