#[non_exhaustive]pub struct DocumentClassificationJobProperties {Show 14 fields
pub job_id: Option<String>,
pub job_arn: Option<String>,
pub job_name: Option<String>,
pub job_status: Option<JobStatus>,
pub message: Option<String>,
pub submit_time: Option<DateTime>,
pub end_time: Option<DateTime>,
pub document_classifier_arn: Option<String>,
pub input_data_config: Option<InputDataConfig>,
pub output_data_config: Option<OutputDataConfig>,
pub data_access_role_arn: Option<String>,
pub volume_kms_key_id: Option<String>,
pub vpc_config: Option<VpcConfig>,
pub flywheel_arn: Option<String>,
}Expand description
Provides information about a document classification 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.job_id: Option<String>The identifier assigned to the document classification job.
job_arn: Option<String>The Amazon Resource Name (ARN) of the document classification job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:
arn:
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab
job_name: Option<String>The name that you assigned to the document classification job.
job_status: Option<JobStatus>The current status of the document classification job. If the status is FAILED, the Message field shows the reason for the failure.
message: Option<String>A description of the status of the job.
submit_time: Option<DateTime>The time that the document classification job was submitted for processing.
end_time: Option<DateTime>The time that the document classification job completed.
document_classifier_arn: Option<String>The Amazon Resource Name (ARN) that identifies the document classifier.
input_data_config: Option<InputDataConfig>The input data configuration that you supplied when you created the document classification job.
output_data_config: Option<OutputDataConfig>The output data configuration that you supplied when you created the document classification job.
data_access_role_arn: Option<String>The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
volume_kms_key_id: Option<String>ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
-
KMS Key ID:
"1234abcd-12ab-34cd-56ef-1234567890ab" -
Amazon Resource Name (ARN) of a KMS Key:
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
vpc_config: Option<VpcConfig>Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your document classification job. For more information, see Amazon VPC.
flywheel_arn: Option<String>The Amazon Resource Number (ARN) of the flywheel
Implementations§
Source§impl DocumentClassificationJobProperties
impl DocumentClassificationJobProperties
Sourcepub fn job_id(&self) -> Option<&str>
pub fn job_id(&self) -> Option<&str>
The identifier assigned to the document classification job.
Sourcepub fn job_arn(&self) -> Option<&str>
pub fn job_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the document classification job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:
arn:
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab
Sourcepub fn job_name(&self) -> Option<&str>
pub fn job_name(&self) -> Option<&str>
The name that you assigned to the document classification job.
Sourcepub fn job_status(&self) -> Option<&JobStatus>
pub fn job_status(&self) -> Option<&JobStatus>
The current status of the document classification job. If the status is FAILED, the Message field shows the reason for the failure.
Sourcepub fn submit_time(&self) -> Option<&DateTime>
pub fn submit_time(&self) -> Option<&DateTime>
The time that the document classification job was submitted for processing.
Sourcepub fn end_time(&self) -> Option<&DateTime>
pub fn end_time(&self) -> Option<&DateTime>
The time that the document classification job completed.
Sourcepub fn document_classifier_arn(&self) -> Option<&str>
pub fn document_classifier_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) that identifies the document classifier.
Sourcepub fn input_data_config(&self) -> Option<&InputDataConfig>
pub fn input_data_config(&self) -> Option<&InputDataConfig>
The input data configuration that you supplied when you created the document classification job.
Sourcepub fn output_data_config(&self) -> Option<&OutputDataConfig>
pub fn output_data_config(&self) -> Option<&OutputDataConfig>
The output data configuration that you supplied when you created the document classification job.
Sourcepub fn data_access_role_arn(&self) -> Option<&str>
pub fn data_access_role_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
Sourcepub fn volume_kms_key_id(&self) -> Option<&str>
pub fn volume_kms_key_id(&self) -> Option<&str>
ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
-
KMS Key ID:
"1234abcd-12ab-34cd-56ef-1234567890ab" -
Amazon Resource Name (ARN) of a KMS Key:
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
Sourcepub fn vpc_config(&self) -> Option<&VpcConfig>
pub fn vpc_config(&self) -> Option<&VpcConfig>
Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your document classification job. For more information, see Amazon VPC.
Sourcepub fn flywheel_arn(&self) -> Option<&str>
pub fn flywheel_arn(&self) -> Option<&str>
The Amazon Resource Number (ARN) of the flywheel
Source§impl DocumentClassificationJobProperties
impl DocumentClassificationJobProperties
Sourcepub fn builder() -> DocumentClassificationJobPropertiesBuilder
pub fn builder() -> DocumentClassificationJobPropertiesBuilder
Creates a new builder-style object to manufacture DocumentClassificationJobProperties.
Trait Implementations§
Source§impl Clone for DocumentClassificationJobProperties
impl Clone for DocumentClassificationJobProperties
Source§fn clone(&self) -> DocumentClassificationJobProperties
fn clone(&self) -> DocumentClassificationJobProperties
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl PartialEq for DocumentClassificationJobProperties
impl PartialEq for DocumentClassificationJobProperties
Source§fn eq(&self, other: &DocumentClassificationJobProperties) -> bool
fn eq(&self, other: &DocumentClassificationJobProperties) -> bool
self and other values to be equal, and is used by ==.impl StructuralPartialEq for DocumentClassificationJobProperties
Auto Trait Implementations§
impl Freeze for DocumentClassificationJobProperties
impl RefUnwindSafe for DocumentClassificationJobProperties
impl Send for DocumentClassificationJobProperties
impl Sync for DocumentClassificationJobProperties
impl Unpin for DocumentClassificationJobProperties
impl UnwindSafe for DocumentClassificationJobProperties
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);