#[non_exhaustive]pub struct TranscriptionJobSummary {Show 15 fields
pub transcription_job_name: Option<String>,
pub creation_time: Option<DateTime>,
pub start_time: Option<DateTime>,
pub completion_time: Option<DateTime>,
pub language_code: Option<LanguageCode>,
pub transcription_job_status: Option<TranscriptionJobStatus>,
pub failure_reason: Option<String>,
pub output_location_type: Option<OutputLocationType>,
pub content_redaction: Option<ContentRedaction>,
pub model_settings: Option<ModelSettings>,
pub identify_language: Option<bool>,
pub identify_multiple_languages: Option<bool>,
pub identified_language_score: Option<f32>,
pub language_codes: Option<Vec<LanguageCodeItem>>,
pub toxicity_detection: Option<Vec<ToxicityDetectionSettings>>,
}
Expand description
Provides detailed information about a specific transcription job.
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.transcription_job_name: Option<String>
The name of the transcription job. Job names are case sensitive and must be unique within an Amazon Web Services account.
creation_time: Option<DateTime>
The date and time the specified transcription 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.
start_time: Option<DateTime>
The date and time your transcription 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.
completion_time: Option<DateTime>
The date and time the specified transcription 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.
language_code: Option<LanguageCode>
The language code used to create your transcription.
transcription_job_status: Option<TranscriptionJobStatus>
Provides the status of your transcription 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.
failure_reason: Option<String>
If TranscriptionJobStatus
is FAILED
, FailureReason
contains information about why the transcription job failed. See also: Common Errors.
output_location_type: Option<OutputLocationType>
Indicates where the specified transcription output is stored.
If the value is CUSTOMER_BUCKET
, the location is the Amazon S3 bucket you specified using the OutputBucketName
parameter in your request. If you also included OutputKey
in your request, your output is located in the path you specified in your request.
If the value is SERVICE_BUCKET
, the location is a service-managed Amazon S3 bucket. To access a transcript stored in a service-managed bucket, use the URI shown in the TranscriptFileUri
or RedactedTranscriptFileUri
field.
content_redaction: Option<ContentRedaction>
The content redaction settings of the transcription job.
model_settings: Option<ModelSettings>
Provides the name of the custom language model that was included in the specified transcription job.
Only use ModelSettings
with the LanguageModelName
sub-parameter if you're not using automatic language identification (). If using
LanguageIdSettings
in your request, this parameter contains a LanguageModelName
sub-parameter.
identify_language: Option<bool>
Indicates whether automatic language identification was enabled (TRUE
) for the specified transcription job.
identify_multiple_languages: Option<bool>
Indicates whether automatic multi-language identification was enabled (TRUE
) for the specified transcription job.
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.
language_codes: Option<Vec<LanguageCodeItem>>
The language codes used to create your transcription job. This parameter is used with multi-language identification. For single-language identification, the singular version of this parameter, LanguageCode
, is present.
toxicity_detection: Option<Vec<ToxicityDetectionSettings>>
Indicates whether toxicity detection was enabled for the specified transcription job.
Implementations§
Source§impl TranscriptionJobSummary
impl TranscriptionJobSummary
Sourcepub fn transcription_job_name(&self) -> Option<&str>
pub fn transcription_job_name(&self) -> Option<&str>
The name of the transcription job. Job names are case sensitive and must be unique within an Amazon Web Services account.
Sourcepub fn creation_time(&self) -> Option<&DateTime>
pub fn creation_time(&self) -> Option<&DateTime>
The date and time the specified transcription 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 start_time(&self) -> Option<&DateTime>
pub fn start_time(&self) -> Option<&DateTime>
The date and time your transcription 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 completion_time(&self) -> Option<&DateTime>
pub fn completion_time(&self) -> Option<&DateTime>
The date and time the specified transcription 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 language_code(&self) -> Option<&LanguageCode>
pub fn language_code(&self) -> Option<&LanguageCode>
The language code used to create your transcription.
Sourcepub fn transcription_job_status(&self) -> Option<&TranscriptionJobStatus>
pub fn transcription_job_status(&self) -> Option<&TranscriptionJobStatus>
Provides the status of your transcription 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 failure_reason(&self) -> Option<&str>
pub fn failure_reason(&self) -> Option<&str>
If TranscriptionJobStatus
is FAILED
, FailureReason
contains information about why the transcription job failed. See also: Common Errors.
Sourcepub fn output_location_type(&self) -> Option<&OutputLocationType>
pub fn output_location_type(&self) -> Option<&OutputLocationType>
Indicates where the specified transcription output is stored.
If the value is CUSTOMER_BUCKET
, the location is the Amazon S3 bucket you specified using the OutputBucketName
parameter in your request. If you also included OutputKey
in your request, your output is located in the path you specified in your request.
If the value is SERVICE_BUCKET
, the location is a service-managed Amazon S3 bucket. To access a transcript stored in a service-managed bucket, use the URI shown in the TranscriptFileUri
or RedactedTranscriptFileUri
field.
Sourcepub fn content_redaction(&self) -> Option<&ContentRedaction>
pub fn content_redaction(&self) -> Option<&ContentRedaction>
The content redaction settings of the transcription job.
Sourcepub fn model_settings(&self) -> Option<&ModelSettings>
pub fn model_settings(&self) -> Option<&ModelSettings>
Provides the name of the custom language model that was included in the specified transcription job.
Only use ModelSettings
with the LanguageModelName
sub-parameter if you're not using automatic language identification (). If using
LanguageIdSettings
in your request, this parameter contains a LanguageModelName
sub-parameter.
Sourcepub fn identify_language(&self) -> Option<bool>
pub fn identify_language(&self) -> Option<bool>
Indicates whether automatic language identification was enabled (TRUE
) for the specified transcription job.
Sourcepub fn identify_multiple_languages(&self) -> Option<bool>
pub fn identify_multiple_languages(&self) -> Option<bool>
Indicates whether automatic multi-language identification was enabled (TRUE
) for the specified transcription job.
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 language_codes(&self) -> &[LanguageCodeItem]
pub fn language_codes(&self) -> &[LanguageCodeItem]
The language codes used to create your transcription job. This parameter is used with multi-language identification. For single-language identification, the singular version of this parameter, LanguageCode
, is present.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .language_codes.is_none()
.
Sourcepub fn toxicity_detection(&self) -> &[ToxicityDetectionSettings]
pub fn toxicity_detection(&self) -> &[ToxicityDetectionSettings]
Indicates whether toxicity detection was enabled for the specified transcription 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 .toxicity_detection.is_none()
.
Source§impl TranscriptionJobSummary
impl TranscriptionJobSummary
Sourcepub fn builder() -> TranscriptionJobSummaryBuilder
pub fn builder() -> TranscriptionJobSummaryBuilder
Creates a new builder-style object to manufacture TranscriptionJobSummary
.
Trait Implementations§
Source§impl Clone for TranscriptionJobSummary
impl Clone for TranscriptionJobSummary
Source§fn clone(&self) -> TranscriptionJobSummary
fn clone(&self) -> TranscriptionJobSummary
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for TranscriptionJobSummary
impl Debug for TranscriptionJobSummary
Source§impl PartialEq for TranscriptionJobSummary
impl PartialEq for TranscriptionJobSummary
impl StructuralPartialEq for TranscriptionJobSummary
Auto Trait Implementations§
impl Freeze for TranscriptionJobSummary
impl RefUnwindSafe for TranscriptionJobSummary
impl Send for TranscriptionJobSummary
impl Sync for TranscriptionJobSummary
impl Unpin for TranscriptionJobSummary
impl UnwindSafe for TranscriptionJobSummary
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);