#[non_exhaustive]pub struct CallAnalyticsJob {Show 17 fields
pub call_analytics_job_name: Option<String>,
pub call_analytics_job_status: Option<CallAnalyticsJobStatus>,
pub call_analytics_job_details: Option<CallAnalyticsJobDetails>,
pub language_code: Option<LanguageCode>,
pub media_sample_rate_hertz: Option<i32>,
pub media_format: Option<MediaFormat>,
pub media: Option<Media>,
pub transcript: Option<Transcript>,
pub start_time: Option<DateTime>,
pub creation_time: Option<DateTime>,
pub completion_time: Option<DateTime>,
pub failure_reason: Option<String>,
pub data_access_role_arn: Option<String>,
pub identified_language_score: Option<f32>,
pub settings: Option<CallAnalyticsJobSettings>,
pub channel_definitions: Option<Vec<ChannelDefinition>>,
pub tags: Option<Vec<Tag>>,
}
Expand description
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.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.call_analytics_job_name: Option<String>
The name of the Call Analytics job. Job names are case sensitive and must be unique within an Amazon Web Services account.
call_analytics_job_status: 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.
call_analytics_job_details: Option<CallAnalyticsJobDetails>
Provides detailed information about a call analytics job, including information about skipped analytics features.
language_code: 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 do not 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.
media_sample_rate_hertz: Option<i32>
The sample rate, in hertz, of the audio track in your input media file.
media_format: Option<MediaFormat>
The format of the input media file.
media: Option<Media>
Provides the Amazon S3 location of the media file you used in your Call Analytics request.
transcript: Option<Transcript>
Provides you with the Amazon S3 URI you can use to access your transcript.
start_time: 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.
creation_time: 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.
completion_time: 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.
failure_reason: Option<String>
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 refer to theMediaFormat
parameter 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 Service 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 Service quotas.
data_access_role_arn: Option<String>
The Amazon Resource Name (ARN) you included in your request.
identified_language_score: 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.
settings: Option<CallAnalyticsJobSettings>
Provides information on any additional settings that were included in your request. Additional settings include content redaction and language identification settings.
channel_definitions: Option<Vec<ChannelDefinition>>
Indicates which speaker is on which channel.
The tags, each in the form of a key:value pair, assigned to the specified call analytics job.
Implementations§
Source§impl CallAnalyticsJob
impl CallAnalyticsJob
Sourcepub fn call_analytics_job_name(&self) -> Option<&str>
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.
Sourcepub fn call_analytics_job_status(&self) -> Option<&CallAnalyticsJobStatus>
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.
Sourcepub fn call_analytics_job_details(&self) -> Option<&CallAnalyticsJobDetails>
pub fn call_analytics_job_details(&self) -> Option<&CallAnalyticsJobDetails>
Provides detailed information about a call analytics job, including information about skipped analytics features.
Sourcepub fn language_code(&self) -> Option<&LanguageCode>
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 do not 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.
Sourcepub fn media_sample_rate_hertz(&self) -> Option<i32>
pub fn media_sample_rate_hertz(&self) -> Option<i32>
The sample rate, in hertz, of the audio track in your input media file.
Sourcepub fn media_format(&self) -> Option<&MediaFormat>
pub fn media_format(&self) -> Option<&MediaFormat>
The format of the input media file.
Sourcepub fn media(&self) -> Option<&Media>
pub fn media(&self) -> Option<&Media>
Provides the Amazon S3 location of the media file you used in your Call Analytics request.
Sourcepub fn transcript(&self) -> Option<&Transcript>
pub fn transcript(&self) -> Option<&Transcript>
Provides you with the Amazon S3 URI you can use to access your transcript.
Sourcepub fn start_time(&self) -> Option<&DateTime>
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.
Sourcepub fn creation_time(&self) -> Option<&DateTime>
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.
Sourcepub fn completion_time(&self) -> Option<&DateTime>
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.
Sourcepub fn failure_reason(&self) -> Option<&str>
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 refer to theMediaFormat
parameter 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 Service 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 Service quotas.
Sourcepub fn data_access_role_arn(&self) -> Option<&str>
pub fn data_access_role_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) you included in your request.
Sourcepub fn identified_language_score(&self) -> Option<f32>
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.
Sourcepub fn settings(&self) -> Option<&CallAnalyticsJobSettings>
pub fn settings(&self) -> Option<&CallAnalyticsJobSettings>
Provides information on any additional settings that were included in your request. Additional settings include content redaction and language identification settings.
Sourcepub fn channel_definitions(&self) -> &[ChannelDefinition]
pub fn channel_definitions(&self) -> &[ChannelDefinition]
Indicates which speaker is on which channel.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .channel_definitions.is_none()
.
The tags, each in the form of a key:value pair, assigned to the specified call analytics job.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none()
.
Source§impl CallAnalyticsJob
impl CallAnalyticsJob
Sourcepub fn builder() -> CallAnalyticsJobBuilder
pub fn builder() -> CallAnalyticsJobBuilder
Creates a new builder-style object to manufacture CallAnalyticsJob
.
Trait Implementations§
Source§impl Clone for CallAnalyticsJob
impl Clone for CallAnalyticsJob
Source§fn clone(&self) -> CallAnalyticsJob
fn clone(&self) -> CallAnalyticsJob
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for CallAnalyticsJob
impl Debug for CallAnalyticsJob
Source§impl PartialEq for CallAnalyticsJob
impl PartialEq for CallAnalyticsJob
impl StructuralPartialEq for CallAnalyticsJob
Auto Trait Implementations§
impl Freeze for CallAnalyticsJob
impl RefUnwindSafe for CallAnalyticsJob
impl Send for CallAnalyticsJob
impl Sync for CallAnalyticsJob
impl Unpin for CallAnalyticsJob
impl UnwindSafe for CallAnalyticsJob
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> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
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 moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);