@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class StartCallAnalyticsJobRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
StartCallAnalyticsJobRequest() |
Modifier and Type | Method and Description |
---|---|
StartCallAnalyticsJobRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
String |
getCallAnalyticsJobName()
The name of the call analytics job.
|
List<ChannelDefinition> |
getChannelDefinitions()
When you start a call analytics job, you must pass an array that maps the agent and the customer to specific
audio channels.
|
String |
getDataAccessRoleArn()
The Amazon Resource Name (ARN) of a role that has access to the S3 bucket that contains your input files.
|
Media |
getMedia() |
String |
getOutputEncryptionKMSKeyId()
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 |
getOutputLocation()
The Amazon S3 location where the output of the call analytics job is stored.
|
CallAnalyticsJobSettings |
getSettings()
A
Settings object that provides optional settings for a call analytics job. |
int |
hashCode() |
void |
setCallAnalyticsJobName(String callAnalyticsJobName)
The name of the call analytics job.
|
void |
setChannelDefinitions(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.
|
void |
setDataAccessRoleArn(String dataAccessRoleArn)
The Amazon Resource Name (ARN) of a role that has access to the S3 bucket that contains your input files.
|
void |
setMedia(Media media) |
void |
setOutputEncryptionKMSKeyId(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.
|
void |
setOutputLocation(String outputLocation)
The Amazon S3 location where the output of the call analytics job is stored.
|
void |
setSettings(CallAnalyticsJobSettings settings)
A
Settings object that provides optional settings for a call analytics job. |
String |
toString()
Returns a string representation of this object.
|
StartCallAnalyticsJobRequest |
withCallAnalyticsJobName(String callAnalyticsJobName)
The name of the call analytics job.
|
StartCallAnalyticsJobRequest |
withChannelDefinitions(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 |
withChannelDefinitions(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 |
withDataAccessRoleArn(String dataAccessRoleArn)
The Amazon Resource Name (ARN) of a role that has access to the S3 bucket that contains your input files.
|
StartCallAnalyticsJobRequest |
withMedia(Media media) |
StartCallAnalyticsJobRequest |
withOutputEncryptionKMSKeyId(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 |
withOutputLocation(String outputLocation)
The Amazon S3 location where the output of the call analytics job is stored.
|
StartCallAnalyticsJobRequest |
withSettings(CallAnalyticsJobSettings settings)
A
Settings object that provides optional settings for a call analytics job. |
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setCallAnalyticsJobName(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.
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.public String getCallAnalyticsJobName()
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.
ConflictException
error.public StartCallAnalyticsJobRequest withCallAnalyticsJobName(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.
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.public void setMedia(Media media)
media
- public Media getMedia()
public StartCallAnalyticsJobRequest withMedia(Media media)
media
- public void setOutputLocation(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.
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.
public String getOutputLocation()
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.
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.
public StartCallAnalyticsJobRequest withOutputLocation(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.
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.
public void setOutputEncryptionKMSKeyId(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.
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.
public String getOutputEncryptionKMSKeyId()
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.
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.
public StartCallAnalyticsJobRequest withOutputEncryptionKMSKeyId(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.
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.
public void setDataAccessRoleArn(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.
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.public String getDataAccessRoleArn()
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.
public StartCallAnalyticsJobRequest withDataAccessRoleArn(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.
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.public void setSettings(CallAnalyticsJobSettings settings)
A Settings
object that provides optional settings for a call analytics job.
settings
- A Settings
object that provides optional settings for a call analytics job.public CallAnalyticsJobSettings getSettings()
A Settings
object that provides optional settings for a call analytics job.
Settings
object that provides optional settings for a call analytics job.public StartCallAnalyticsJobRequest withSettings(CallAnalyticsJobSettings settings)
A Settings
object that provides optional settings for a call analytics job.
settings
- A Settings
object that provides optional settings for a call analytics job.public List<ChannelDefinition> getChannelDefinitions()
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.
public void setChannelDefinitions(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.
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.public StartCallAnalyticsJobRequest withChannelDefinitions(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.
NOTE: This method appends the values to the existing list (if any). Use
setChannelDefinitions(java.util.Collection)
or withChannelDefinitions(java.util.Collection)
if
you want to override the existing values.
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.public StartCallAnalyticsJobRequest withChannelDefinitions(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.
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.public String toString()
toString
in class Object
Object.toString()
public StartCallAnalyticsJobRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()