#[non_exhaustive]pub struct EntityRecognizerProperties {Show 18 fields
pub entity_recognizer_arn: Option<String>,
pub language_code: Option<LanguageCode>,
pub status: Option<ModelStatus>,
pub message: Option<String>,
pub submit_time: Option<DateTime>,
pub end_time: Option<DateTime>,
pub training_start_time: Option<DateTime>,
pub training_end_time: Option<DateTime>,
pub input_data_config: Option<EntityRecognizerInputDataConfig>,
pub recognizer_metadata: Option<EntityRecognizerMetadata>,
pub data_access_role_arn: Option<String>,
pub volume_kms_key_id: Option<String>,
pub vpc_config: Option<VpcConfig>,
pub model_kms_key_id: Option<String>,
pub version_name: Option<String>,
pub source_model_arn: Option<String>,
pub flywheel_arn: Option<String>,
pub output_data_config: Option<EntityRecognizerOutputDataConfig>,
}Expand description
Describes information about an entity recognizer.
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.entity_recognizer_arn: Option<String>The Amazon Resource Name (ARN) that identifies the entity recognizer.
language_code: Option<LanguageCode>The language of the input documents. All documents must be in the same language. Only English ("en") is currently supported.
status: Option<ModelStatus>Provides the status of the entity recognizer.
message: Option<String>A description of the status of the recognizer.
submit_time: Option<DateTime>The time that the recognizer was submitted for processing.
end_time: Option<DateTime>The time that the recognizer creation completed.
training_start_time: Option<DateTime>The time that training of the entity recognizer started.
training_end_time: Option<DateTime>The time that training of the entity recognizer was completed.
input_data_config: Option<EntityRecognizerInputDataConfig>The input data properties of an entity recognizer.
recognizer_metadata: Option<EntityRecognizerMetadata>Provides information about an entity recognizer.
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 custom entity recognizer. For more information, see Amazon VPC.
model_kms_key_id: Option<String>ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId 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"
version_name: Option<String>The version name you assigned to the entity recognizer.
source_model_arn: Option<String>The Amazon Resource Name (ARN) of the source model. This model was imported from a different Amazon Web Services account to create the entity recognizer model in your Amazon Web Services account.
flywheel_arn: Option<String>The Amazon Resource Number (ARN) of the flywheel
output_data_config: Option<EntityRecognizerOutputDataConfig>Output data configuration.
Implementations§
Source§impl EntityRecognizerProperties
impl EntityRecognizerProperties
Sourcepub fn entity_recognizer_arn(&self) -> Option<&str>
pub fn entity_recognizer_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) that identifies the entity recognizer.
Sourcepub fn language_code(&self) -> Option<&LanguageCode>
pub fn language_code(&self) -> Option<&LanguageCode>
The language of the input documents. All documents must be in the same language. Only English ("en") is currently supported.
Sourcepub fn status(&self) -> Option<&ModelStatus>
pub fn status(&self) -> Option<&ModelStatus>
Provides the status of the entity recognizer.
Sourcepub fn submit_time(&self) -> Option<&DateTime>
pub fn submit_time(&self) -> Option<&DateTime>
The time that the recognizer was submitted for processing.
Sourcepub fn training_start_time(&self) -> Option<&DateTime>
pub fn training_start_time(&self) -> Option<&DateTime>
The time that training of the entity recognizer started.
Sourcepub fn training_end_time(&self) -> Option<&DateTime>
pub fn training_end_time(&self) -> Option<&DateTime>
The time that training of the entity recognizer was completed.
Sourcepub fn input_data_config(&self) -> Option<&EntityRecognizerInputDataConfig>
pub fn input_data_config(&self) -> Option<&EntityRecognizerInputDataConfig>
The input data properties of an entity recognizer.
Sourcepub fn recognizer_metadata(&self) -> Option<&EntityRecognizerMetadata>
pub fn recognizer_metadata(&self) -> Option<&EntityRecognizerMetadata>
Provides information about an entity recognizer.
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 custom entity recognizer. For more information, see Amazon VPC.
Sourcepub fn model_kms_key_id(&self) -> Option<&str>
pub fn model_kms_key_id(&self) -> Option<&str>
ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId 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 version_name(&self) -> Option<&str>
pub fn version_name(&self) -> Option<&str>
The version name you assigned to the entity recognizer.
Sourcepub fn source_model_arn(&self) -> Option<&str>
pub fn source_model_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the source model. This model was imported from a different Amazon Web Services account to create the entity recognizer model in your Amazon Web Services account.
Sourcepub fn flywheel_arn(&self) -> Option<&str>
pub fn flywheel_arn(&self) -> Option<&str>
The Amazon Resource Number (ARN) of the flywheel
Sourcepub fn output_data_config(&self) -> Option<&EntityRecognizerOutputDataConfig>
pub fn output_data_config(&self) -> Option<&EntityRecognizerOutputDataConfig>
Output data configuration.
Source§impl EntityRecognizerProperties
impl EntityRecognizerProperties
Sourcepub fn builder() -> EntityRecognizerPropertiesBuilder
pub fn builder() -> EntityRecognizerPropertiesBuilder
Creates a new builder-style object to manufacture EntityRecognizerProperties.
Trait Implementations§
Source§impl Clone for EntityRecognizerProperties
impl Clone for EntityRecognizerProperties
Source§fn clone(&self) -> EntityRecognizerProperties
fn clone(&self) -> EntityRecognizerProperties
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 EntityRecognizerProperties
impl Debug for EntityRecognizerProperties
Source§impl PartialEq for EntityRecognizerProperties
impl PartialEq for EntityRecognizerProperties
Source§fn eq(&self, other: &EntityRecognizerProperties) -> bool
fn eq(&self, other: &EntityRecognizerProperties) -> bool
self and other values to be equal, and is used by ==.impl StructuralPartialEq for EntityRecognizerProperties
Auto Trait Implementations§
impl Freeze for EntityRecognizerProperties
impl RefUnwindSafe for EntityRecognizerProperties
impl Send for EntityRecognizerProperties
impl Sync for EntityRecognizerProperties
impl Unpin for EntityRecognizerProperties
impl UnwindSafe for EntityRecognizerProperties
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);