Struct aws_sdk_transcribe::operation::start_call_analytics_job::builders::StartCallAnalyticsJobFluentBuilder
source · pub struct StartCallAnalyticsJobFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to StartCallAnalyticsJob
.
Transcribes the audio from a customer service call and applies any additional Request Parameters you choose to include in your request.
In addition to many standard transcription features, Call Analytics provides you with call characteristics, call summarization, speaker sentiment, and optional redaction of your text transcript and your audio file. You can also apply custom categories to flag specified conditions. To learn more about these features and insights, refer to Analyzing call center audio with Call Analytics.
If you want to apply categories to your Call Analytics job, you must create them before submitting your job request. Categories cannot be retroactively applied to a job. To create a new category, use the operation. To learn more about Call Analytics categories, see Creating categories for post-call transcriptions and Creating categories for real-time transcriptions.
To make a StartCallAnalyticsJob
request, you must first upload your media file into an Amazon S3 bucket; you can then specify the Amazon S3 location of the file using the Media
parameter.
Note that job queuing is enabled by default for Call Analytics jobs.
You must include the following parameters in your StartCallAnalyticsJob
request:
-
region
: The Amazon Web Services Region where you are making your request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to Amazon Transcribe endpoints and quotas. -
CallAnalyticsJobName
: A custom name that you create for your transcription job that's unique within your Amazon Web Services account. -
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
(MediaFileUri
orRedactedMediaFileUri
): The Amazon S3 location of your media file.
With Call Analytics, you can redact the audio contained in your media file by including RedactedMediaFileUri
, instead of MediaFileUri
, to specify the location of your input audio. If you choose to redact your audio, you can find your redacted media at the location specified in the RedactedMediaFileUri
field of your response.
Implementations§
source§impl StartCallAnalyticsJobFluentBuilder
impl StartCallAnalyticsJobFluentBuilder
sourcepub fn as_input(&self) -> &StartCallAnalyticsJobInputBuilder
pub fn as_input(&self) -> &StartCallAnalyticsJobInputBuilder
Access the StartCallAnalyticsJob as a reference.
sourcepub async fn send(
self
) -> Result<StartCallAnalyticsJobOutput, SdkError<StartCallAnalyticsJobError, HttpResponse>>
pub async fn send( self ) -> Result<StartCallAnalyticsJobOutput, SdkError<StartCallAnalyticsJobError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
sourcepub fn customize(
self
) -> CustomizableOperation<StartCallAnalyticsJobOutput, StartCallAnalyticsJobError, Self>
pub fn customize( self ) -> CustomizableOperation<StartCallAnalyticsJobOutput, StartCallAnalyticsJobError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn call_analytics_job_name(self, input: impl Into<String>) -> Self
pub fn call_analytics_job_name(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_call_analytics_job_name(self, input: Option<String>) -> Self
pub fn set_call_analytics_job_name(self, input: Option<String>) -> Self
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.
sourcepub fn get_call_analytics_job_name(&self) -> &Option<String>
pub fn get_call_analytics_job_name(&self) -> &Option<String>
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.
sourcepub fn media(self, input: Media) -> Self
pub fn media(self, input: Media) -> Self
Describes the Amazon S3 location of the media file you want to use in your Call Analytics request.
sourcepub fn set_media(self, input: Option<Media>) -> Self
pub fn set_media(self, input: Option<Media>) -> Self
Describes the Amazon S3 location of the media file you want to use in your Call Analytics request.
sourcepub fn get_media(&self) -> &Option<Media>
pub fn get_media(&self) -> &Option<Media>
Describes the Amazon S3 location of the media file you want to use in your Call Analytics request.
sourcepub fn output_location(self, input: impl Into<String>) -> Self
pub fn output_location(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_output_location(self, input: Option<String>) -> Self
pub fn set_output_location(self, input: Option<String>) -> Self
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.
sourcepub fn get_output_location(&self) -> &Option<String>
pub fn get_output_location(&self) -> &Option<String>
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.
sourcepub fn output_encryption_kms_key_id(self, input: impl Into<String>) -> Self
pub fn output_encryption_kms_key_id(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_output_encryption_kms_key_id(self, input: Option<String>) -> Self
pub fn set_output_encryption_kms_key_id(self, input: Option<String>) -> Self
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.
sourcepub fn get_output_encryption_kms_key_id(&self) -> &Option<String>
pub fn get_output_encryption_kms_key_id(&self) -> &Option<String>
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.
sourcepub fn data_access_role_arn(self, input: impl Into<String>) -> Self
pub fn data_access_role_arn(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_data_access_role_arn(self, input: Option<String>) -> Self
pub fn set_data_access_role_arn(self, input: Option<String>) -> Self
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.
sourcepub fn get_data_access_role_arn(&self) -> &Option<String>
pub fn get_data_access_role_arn(&self) -> &Option<String>
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.
sourcepub fn settings(self, input: CallAnalyticsJobSettings) -> Self
pub fn settings(self, input: CallAnalyticsJobSettings) -> Self
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.
sourcepub fn set_settings(self, input: Option<CallAnalyticsJobSettings>) -> Self
pub fn set_settings(self, input: Option<CallAnalyticsJobSettings>) -> Self
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.
sourcepub fn get_settings(&self) -> &Option<CallAnalyticsJobSettings>
pub fn get_settings(&self) -> &Option<CallAnalyticsJobSettings>
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.
sourcepub fn channel_definitions(self, input: ChannelDefinition) -> Self
pub fn channel_definitions(self, input: ChannelDefinition) -> Self
Appends an item to ChannelDefinitions
.
To override the contents of this collection use set_channel_definitions
.
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
to 0
(to indicate the first channel) and ParticipantRole
to AGENT
(to indicate that it's the agent speaking).
sourcepub fn set_channel_definitions(
self,
input: Option<Vec<ChannelDefinition>>
) -> Self
pub fn set_channel_definitions( self, input: Option<Vec<ChannelDefinition>> ) -> Self
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
to 0
(to indicate the first channel) and ParticipantRole
to AGENT
(to indicate that it's the agent speaking).
sourcepub fn get_channel_definitions(&self) -> &Option<Vec<ChannelDefinition>>
pub fn get_channel_definitions(&self) -> &Option<Vec<ChannelDefinition>>
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
to 0
(to indicate the first channel) and ParticipantRole
to AGENT
(to indicate that it's the agent speaking).
Trait Implementations§
source§impl Clone for StartCallAnalyticsJobFluentBuilder
impl Clone for StartCallAnalyticsJobFluentBuilder
source§fn clone(&self) -> StartCallAnalyticsJobFluentBuilder
fn clone(&self) -> StartCallAnalyticsJobFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for StartCallAnalyticsJobFluentBuilder
impl !RefUnwindSafe for StartCallAnalyticsJobFluentBuilder
impl Send for StartCallAnalyticsJobFluentBuilder
impl Sync for StartCallAnalyticsJobFluentBuilder
impl Unpin for StartCallAnalyticsJobFluentBuilder
impl !UnwindSafe for StartCallAnalyticsJobFluentBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more