Struct aws_sdk_transcribe::model::CallAnalyticsJob

#[non_exhaustive]
pub struct CallAnalyticsJob { /* private fields */ }

Provides detailed information about a Call Analytics job.

To view the job's status, refer to CallAnalyticsJobStatus. If the status is COMPLETED, the job is finished. You can find your completed transcript at the URI specified in TranscriptFileUri. If the status is FAILED, FailureReason provides details on why your transcription job failed.

If you enabled personally identifiable information (PII) redaction, the redacted transcript appears at the location specified in RedactedTranscriptFileUri.

If you chose to redact the audio in your media file, you can find your redacted media file at the location specified in the RedactedMediaFileUri field of your response.

Implementations

impl CallAnalyticsJob

pub fn call_analytics_job_name(&self) -> Option<&str>

The name of the Call Analytics job. Job names are case sensitive and must be unique within an Amazon Web Services account.

pub fn call_analytics_job_status(&self) -> Option<&CallAnalyticsJobStatus>

Provides the status of the specified Call Analytics job.

If the status is COMPLETED, the job is finished and you can find the results at the location specified in TranscriptFileUri (or RedactedTranscriptFileUri, if you requested transcript redaction). If the status is FAILED, FailureReason provides details on why your transcription job failed.

pub fn language_code(&self) -> Option<&LanguageCode>

The language code used to create your Call Analytics job. For a list of supported languages and their associated language codes, refer to the Supported languages table.

If you don't know the language spoken in your media file, you can omit this field and let Amazon Transcribe automatically identify the language of your media. To improve the accuracy of language identification, you can include several language codes and Amazon Transcribe chooses the closest match for your transcription.

pub fn media_sample_rate_hertz(&self) -> Option<i32>

The sample rate, in Hertz, of the audio track in your input media file.

pub fn media_format(&self) -> Option<&MediaFormat>

The format of the input media file.

pub fn media(&self) -> Option<&Media>

Describes the Amazon S3 location of the media file you want to use in your request.

pub fn transcript(&self) -> Option<&Transcript>

Provides you with the Amazon S3 URI you can use to access your transcript.

pub fn start_time(&self) -> Option<&DateTime>

The date and time the specified Call Analytics job began processing.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.

pub fn creation_time(&self) -> Option<&DateTime>

The date and time the specified Call Analytics job request was made.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.

pub fn completion_time(&self) -> Option<&DateTime>

The date and time the specified Call Analytics job finished processing.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started processing at 12:33 PM UTC-7 on May 4, 2022.

pub fn failure_reason(&self) -> Option<&str>

If CallAnalyticsJobStatus is FAILED, FailureReason contains information about why the Call Analytics job request failed.

The FailureReason field contains one of the following values:

• Unsupported media format.

  The media format specified in MediaFormat isn't valid. Refer to MediaFormat for a list of supported formats.

• The media format provided does not match the detected media format.

  The media format specified in MediaFormat doesn't match the format of the input file. Check the media format of your media file and correct the specified value.

• Invalid sample rate for audio file.

  The sample rate specified in MediaSampleRateHertz isn't valid. The sample rate must be between 8,000 and 48,000 Hertz.

• The sample rate provided does not match the detected sample rate.

  The sample rate specified in MediaSampleRateHertz doesn't match the sample rate detected in your input media file. Check the sample rate of your media file and correct the specified value.

• Invalid file size: file size too large.

  The size of your media file is larger than what Amazon Transcribe can process. For more information, refer to Guidelines and quotas.

• Invalid number of channels: number of channels too large.

  Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer to Guidelines and quotas.

pub fn data_access_role_arn(&self) -> Option<&str>

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.

pub fn identified_language_score(&self) -> Option<f32>

The confidence score associated with the language identified in your media file.

Confidence scores are values between 0 and 1; a larger value indicates a higher probability that the identified language correctly matches the language spoken in your media.

pub fn settings(&self) -> Option<&CallAnalyticsJobSettings>

Allows 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.

pub fn channel_definitions(&self) -> Option<&[ChannelDefinition]>

Allows you to specify which speaker is on which channel in your Call Analytics job request. 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).

impl CallAnalyticsJob

pub fn builder() -> Builder

Creates a new builder-style object to manufacture CallAnalyticsJob.

Trait Implementations

impl Clone for CallAnalyticsJob

fn clone(&self) -> CallAnalyticsJob

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CallAnalyticsJob

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

Formats the value using the given formatter.

impl PartialEq<CallAnalyticsJob> for CallAnalyticsJob

fn eq(&self, other: &CallAnalyticsJob) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CallAnalyticsJob