public static interface StartCallAnalyticsJobRequest.Builder extends TranscribeRequest.Builder, SdkPojo, CopyableBuilder<StartCallAnalyticsJobRequest.Builder,StartCallAnalyticsJobRequest>
| Modifier and Type | Method and Description |
|---|---|
StartCallAnalyticsJobRequest.Builder |
callAnalyticsJobName(String callAnalyticsJobName)
A unique name, chosen by you, for your Call Analytics job.
|
StartCallAnalyticsJobRequest.Builder |
channelDefinitions(ChannelDefinition... channelDefinitions)
Allows you to specify which speaker is on which channel.
|
StartCallAnalyticsJobRequest.Builder |
channelDefinitions(Collection<ChannelDefinition> channelDefinitions)
Allows you to specify which speaker is on which channel.
|
StartCallAnalyticsJobRequest.Builder |
channelDefinitions(Consumer<ChannelDefinition.Builder>... channelDefinitions)
Allows you to specify which speaker is on which channel.
|
StartCallAnalyticsJobRequest.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.
|
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 KMS key you want to use to encrypt your Call Analytics output.
|
StartCallAnalyticsJobRequest.Builder |
outputLocation(String outputLocation)
The Amazon S3 location where you want your Call Analytics transcription output stored.
|
StartCallAnalyticsJobRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
StartCallAnalyticsJobRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
StartCallAnalyticsJobRequest.Builder |
settings(CallAnalyticsJobSettings settings)
Specify 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 StartCallAnalyticsJobRequest.Builder |
settings(Consumer<CallAnalyticsJobSettings.Builder> settings)
Specify 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.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildStartCallAnalyticsJobRequest.Builder callAnalyticsJobName(String callAnalyticsJobName)
A unique name, chosen by you, for your Call Analytics job.
This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.
If you try to create a new job with the same name as an existing job, you get a
ConflictException error.
callAnalyticsJobName - A unique name, chosen by you, for your Call Analytics job.
This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services
account. If you try to create a new job with the same name as an existing job, you get a
ConflictException error.
StartCallAnalyticsJobRequest.Builder media(Media media)
media - The new value for the Media property for this object.default StartCallAnalyticsJobRequest.Builder media(Consumer<Media.Builder> media)
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).media - a consumer that will call methods on Media.Buildermedia(Media)StartCallAnalyticsJobRequest.Builder outputLocation(String outputLocation)
The Amazon S3 location where you want your Call Analytics transcription output stored. You can use any of the following formats to specify the output location:
s3://DOC-EXAMPLE-BUCKET
s3://DOC-EXAMPLE-BUCKET/my-output-folder/
s3://DOC-EXAMPLE-BUCKET/my-output-folder/my-call-analytics-job.json
Unless you specify a file name (option 3), the name of your output file has a default value that matches the
name you specified for your transcription job using the CallAnalyticsJobName parameter.
You can specify a KMS key to encrypt your output using the OutputEncryptionKMSKeyId parameter.
If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption.
If you don't specify OutputLocation, your transcript is placed in a service-managed Amazon S3
bucket and you are provided with a URI to access your transcript.
outputLocation - The Amazon S3 location where you want your Call Analytics transcription output stored. You can use any
of the following formats to specify the output location:
s3://DOC-EXAMPLE-BUCKET
s3://DOC-EXAMPLE-BUCKET/my-output-folder/
s3://DOC-EXAMPLE-BUCKET/my-output-folder/my-call-analytics-job.json
Unless you specify a file name (option 3), the name of your output file has a default value that
matches the name you specified for your transcription job using the CallAnalyticsJobName
parameter.
You can specify a KMS key to encrypt your output using the OutputEncryptionKMSKeyId
parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for
server-side encryption.
If you don't specify OutputLocation, your transcript is placed in a service-managed
Amazon S3 bucket and you are provided with a URI to access your transcript.
StartCallAnalyticsJobRequest.Builder outputEncryptionKMSKeyId(String outputEncryptionKMSKeyId)
The KMS key you want to use to encrypt your Call Analytics output.
If using a key located in the current Amazon Web Services account, you can specify your KMS key in one of four ways:
Use the KMS key ID itself. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
Use an alias for the KMS key ID. For example, alias/ExampleAlias.
Use the Amazon Resource Name (ARN) for the KMS key ID. For example,
arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias
.
If using a key located in a different Amazon Web Services account than the current Amazon Web Services account, you can specify your KMS key in one of two ways:
Use the ARN for the KMS key ID. For example,
arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias
.
If you don't specify an encryption key, your output 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 using the
OutputLocation parameter.
Note that the user making the request must have permission to use the specified KMS key.
outputEncryptionKMSKeyId - The KMS key you want to use to encrypt your Call Analytics output.
If using a key located in the current Amazon Web Services account, you can specify your KMS key in one of four ways:
Use the KMS key ID itself. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
Use an alias for the KMS key ID. For example, alias/ExampleAlias.
Use the Amazon Resource Name (ARN) for the KMS key ID. For example,
arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Use the ARN for the KMS key alias. For example,
arn:aws:kms:region:account-ID:alias/ExampleAlias.
If using a key located in a different Amazon Web Services account than the current Amazon Web Services account, you can specify your KMS key in one of two ways:
Use the ARN for the KMS key ID. For example,
arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Use the ARN for the KMS key alias. For example,
arn:aws:kms:region:account-ID:alias/ExampleAlias.
If you don't specify an encryption key, your output 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 using the
OutputLocation parameter.
Note that the user making the request must have permission to use the specified KMS key.
StartCallAnalyticsJobRequest.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.
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.
StartCallAnalyticsJobRequest.Builder settings(CallAnalyticsJobSettings settings)
Specify 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.
settings - Specify 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 StartCallAnalyticsJobRequest.Builder settings(Consumer<CallAnalyticsJobSettings.Builder> settings)
Specify 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 theCallAnalyticsJobSettings.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).settings - a consumer that will call methods on CallAnalyticsJobSettings.Buildersettings(CallAnalyticsJobSettings)StartCallAnalyticsJobRequest.Builder channelDefinitions(Collection<ChannelDefinition> channelDefinitions)
Allows you to specify which speaker is on which channel. 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).
channelDefinitions - Allows you to specify which speaker is on which channel. 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).StartCallAnalyticsJobRequest.Builder channelDefinitions(ChannelDefinition... channelDefinitions)
Allows you to specify which speaker is on which channel. 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).
channelDefinitions - Allows you to specify which speaker is on which channel. 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).StartCallAnalyticsJobRequest.Builder channelDefinitions(Consumer<ChannelDefinition.Builder>... channelDefinitions)
Allows you to specify which speaker is on which channel. 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).
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) .channelDefinitions - a consumer that will call methods on List.Builder #channelDefinitions(List) StartCallAnalyticsJobRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderStartCallAnalyticsJobRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2022. All rights reserved.