Struct aws_sdk_transcribe::client::fluent_builders::StartCallAnalyticsJob

pub struct StartCallAnalyticsJob<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to StartCallAnalyticsJob.

Starts an asynchronous analytics job that not only transcribes the audio recording of a caller and agent, but also returns additional insights. These insights include how quickly or loudly the caller or agent was speaking. To retrieve additional insights with your analytics jobs, create categories. A category is a way to classify analytics jobs based on attributes, such as a customer's sentiment or a particular phrase being used during the call. For more information, see the operation.

Implementations

impl<C, M, R> StartCallAnalyticsJob<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<StartCallAnalyticsJobOutput, SdkError<StartCallAnalyticsJobError>> where
    R::Policy: SmithyRetryPolicy<StartCallAnalyticsJobInputOperationOutputAlias, StartCallAnalyticsJobOutput, StartCallAnalyticsJobError, StartCallAnalyticsJobInputOperationRetryAlias>, 

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.

pub fn call_analytics_job_name(self, inp: impl Into<String>) -> Self

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.

pub fn set_call_analytics_job_name(self, input: Option<String>) -> Self

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.

pub fn media(self, inp: Media) -> Self

Describes the input media file in a transcription request.

pub fn set_media(self, input: Option<Media>) -> Self

Describes the input media file in a transcription request.

pub fn output_location(self, inp: impl Into<String>) -> Self

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.

pub fn set_output_location(self, input: Option<String>) -> Self

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.

pub fn output_encryption_kms_key_id(self, inp: impl Into<String>) -> Self

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.

pub fn set_output_encryption_kms_key_id(self, input: Option<String>) -> Self

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.

pub fn data_access_role_arn(self, inp: impl Into<String>) -> Self

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.

pub fn set_data_access_role_arn(self, input: Option<String>) -> Self

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.

pub fn settings(self, inp: CallAnalyticsJobSettings) -> Self

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

pub fn set_settings(self, input: Option<CallAnalyticsJobSettings>) -> Self

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

pub fn channel_definitions(self, inp: impl Into<ChannelDefinition>) -> Self

Appends an item to ChannelDefinitions.

To override the contents of this collection use set_channel_definitions.

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.

pub fn set_channel_definitions(
    self,
    input: Option<Vec<ChannelDefinition>>
) -> Self

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.

Trait Implementations

impl<C: Debug, M: Debug, R: Debug> Debug for StartCallAnalyticsJob<C, M, R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.