Interface StartCallAnalyticsJobRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<StartCallAnalyticsJobRequest.Builder,
,StartCallAnalyticsJobRequest> SdkBuilder<StartCallAnalyticsJobRequest.Builder,
,StartCallAnalyticsJobRequest> SdkPojo
,SdkRequest.Builder
,TranscribeRequest.Builder
- Enclosing class:
StartCallAnalyticsJobRequest
-
Method Summary
Modifier and TypeMethodDescriptioncallAnalyticsJobName
(String callAnalyticsJobName) A unique name, chosen by you, for your Call Analytics job.channelDefinitions
(Collection<ChannelDefinition> channelDefinitions) Makes it possible to specify which speaker is on which channel.channelDefinitions
(Consumer<ChannelDefinition.Builder>... channelDefinitions) Makes it possible to specify which speaker is on which channel.channelDefinitions
(ChannelDefinition... channelDefinitions) Makes it possible to specify which speaker is on which channel.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.media
(Consumer<Media.Builder> media) Describes the Amazon S3 location of the media file you want to use in your Call Analytics request.Describes the Amazon S3 location of the media file you want to use in your Call Analytics request.outputEncryptionKMSKeyId
(String outputEncryptionKMSKeyId) The KMS key you want to use to encrypt your Call Analytics output.outputLocation
(String outputLocation) The Amazon S3 location where you want your Call Analytics transcription output stored.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.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.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.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
Methods inherited from interface software.amazon.awssdk.services.transcribe.model.TranscribeRequest.Builder
build
-
Method Details
-
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.- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
media
Describes the Amazon S3 location of the media file you want to use in your Call Analytics request.
- Parameters:
media
- Describes the Amazon S3 location of the media file you want to use in your Call Analytics request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
media
Describes the Amazon S3 location of the media file you want to use in your Call Analytics request.
This is a convenience method that creates an instance of theMedia.Builder
avoiding the need to create one manually viaMedia.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tomedia(Media)
.- Parameters:
media
- a consumer that will call methods onMedia.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 do not specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption.If you do not specify
OutputLocation
, your transcript is placed in a service-managed Amazon S3 bucket and you are provided with a URI to access your transcript.- Parameters:
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 do not specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption.If you do not specify
OutputLocation
, your transcript is placed in a service-managed Amazon S3 bucket and you are provided with a URI to access your transcript.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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 do not 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 role making the request must have permission to use the specified KMS key.
- Parameters:
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 do not 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 role making the request must have permission to use the specified KMS key.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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 that 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 that 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.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
settings
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 viaCallAnalyticsJobSettings.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosettings(CallAnalyticsJobSettings)
.- Parameters:
settings
- a consumer that will call methods onCallAnalyticsJobSettings.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
channelDefinitions
StartCallAnalyticsJobRequest.Builder channelDefinitions(Collection<ChannelDefinition> channelDefinitions) Makes it possible to specify which speaker is on which channel. For example, if your agent is the first participant to speak, you would set
ChannelId
to0
(to indicate the first channel) andParticipantRole
toAGENT
(to indicate that it's the agent speaking).- Parameters:
channelDefinitions
- Makes it possible to specify which speaker is on which channel. For example, if your agent is the first participant to speak, you would setChannelId
to0
(to indicate the first channel) andParticipantRole
toAGENT
(to indicate that it's the agent speaking).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
channelDefinitions
Makes it possible to specify which speaker is on which channel. For example, if your agent is the first participant to speak, you would set
ChannelId
to0
(to indicate the first channel) andParticipantRole
toAGENT
(to indicate that it's the agent speaking).- Parameters:
channelDefinitions
- Makes it possible to specify which speaker is on which channel. For example, if your agent is the first participant to speak, you would setChannelId
to0
(to indicate the first channel) andParticipantRole
toAGENT
(to indicate that it's the agent speaking).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
channelDefinitions
StartCallAnalyticsJobRequest.Builder channelDefinitions(Consumer<ChannelDefinition.Builder>... channelDefinitions) Makes it possible to specify which speaker is on which channel. For example, if your agent is the first participant to speak, you would set
This is a convenience method that creates an instance of theChannelId
to0
(to indicate the first channel) andParticipantRole
toAGENT
(to indicate that it's the agent speaking).ChannelDefinition.Builder
avoiding the need to create one manually viaChannelDefinition.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tochannelDefinitions(List<ChannelDefinition>)
.- Parameters:
channelDefinitions
- a consumer that will call methods onChannelDefinition.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
StartCallAnalyticsJobRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
StartCallAnalyticsJobRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-