#[non_exhaustive]pub struct CreateClassificationJobInput {Show 13 fields
pub allow_list_ids: Option<Vec<String>>,
pub client_token: Option<String>,
pub custom_data_identifier_ids: Option<Vec<String>>,
pub description: Option<String>,
pub initial_run: Option<bool>,
pub job_type: Option<JobType>,
pub managed_data_identifier_ids: Option<Vec<String>>,
pub managed_data_identifier_selector: Option<ManagedDataIdentifierSelector>,
pub name: Option<String>,
pub s3_job_definition: Option<S3JobDefinition>,
pub sampling_percentage: Option<i32>,
pub schedule_frequency: Option<JobScheduleFrequency>,
pub tags: Option<HashMap<String, String>>,
}
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.allow_list_ids: Option<Vec<String>>
An array of unique identifiers, one for each allow list for the job to use when it analyzes data.
client_token: Option<String>
A unique, case-sensitive token that you provide to ensure the idempotency of the request.
custom_data_identifier_ids: Option<Vec<String>>
An array of unique identifiers, one for each custom data identifier for the job to use when it analyzes data. To use only managed data identifiers, don't specify a value for this property and specify a value other than NONE for the managedDataIdentifierSelector property.
description: Option<String>
A custom description of the job. The description can contain as many as 200 characters.
initial_run: Option<bool>
For a recurring job, specifies whether to analyze all existing, eligible objects immediately after the job is created (true). To analyze only those objects that are created or changed after you create the job and before the job's first scheduled run, set this value to false.
If you configure the job to run only once, don't specify a value for this property.
job_type: Option<JobType>
The schedule for running the job. Valid values are:
-
ONE_TIME - Run the job only once. If you specify this value, don't specify a value for the scheduleFrequency property.
-
SCHEDULED - Run the job on a daily, weekly, or monthly basis. If you specify this value, use the scheduleFrequency property to specify the recurrence pattern for the job.
managed_data_identifier_ids: Option<Vec<String>>
An array of unique identifiers, one for each managed data identifier for the job to include (use) or exclude (not use) when it analyzes data. Inclusion or exclusion depends on the managed data identifier selection type that you specify for the job (managedDataIdentifierSelector).
To retrieve a list of valid values for this property, use the ListManagedDataIdentifiers operation.
managed_data_identifier_selector: Option<ManagedDataIdentifierSelector>
The selection type to apply when determining which managed data identifiers the job uses to analyze data. Valid values are:
-
ALL - Use all managed data identifiers. If you specify this value, don't specify any values for the managedDataIdentifierIds property.
-
EXCLUDE - Use all managed data identifiers except the ones specified by the managedDataIdentifierIds property.
-
INCLUDE - Use only the managed data identifiers specified by the managedDataIdentifierIds property.
-
NONE - Don't use any managed data identifiers. If you specify this value, specify at least one value for the customDataIdentifierIds property and don't specify any values for the managedDataIdentifierIds property.
-
RECOMMENDED (default) - Use the recommended set of managed data identifiers. If you specify this value, don't specify any values for the managedDataIdentifierIds property.
If you don't specify a value for this property, the job uses the recommended set of managed data identifiers.
If the job is a recurring job and you specify ALL or EXCLUDE, each job run automatically uses new managed data identifiers that are released. If you don't specify a value for this property or you specify RECOMMENDED for a recurring job, each job run automatically uses all the managed data identifiers that are in the recommended set when the run starts.
To learn about individual managed data identifiers or determine which ones are in the recommended set, see Using managed data identifiers or Recommended managed data identifiers in the Amazon Macie User Guide.
name: Option<String>
A custom name for the job. The name can contain as many as 500 characters.
s3_job_definition: Option<S3JobDefinition>
The S3 buckets that contain the objects to analyze, and the scope of that analysis.
sampling_percentage: Option<i32>
The sampling depth, as a percentage, for the job to apply when processing objects. This value determines the percentage of eligible objects that the job analyzes. If this value is less than 100, Amazon Macie selects the objects to analyze at random, up to the specified percentage, and analyzes all the data in those objects.
schedule_frequency: Option<JobScheduleFrequency>
The recurrence pattern for running the job. To run the job only once, don't specify a value for this property and set the value for the jobType property to ONE_TIME.
A map of key-value pairs that specifies the tags to associate with the job.
A job can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.
Implementations§
Source§impl CreateClassificationJobInput
impl CreateClassificationJobInput
Sourcepub fn allow_list_ids(&self) -> &[String]
pub fn allow_list_ids(&self) -> &[String]
An array of unique identifiers, one for each allow list for the job to use when it analyzes data.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .allow_list_ids.is_none()
.
Sourcepub fn client_token(&self) -> Option<&str>
pub fn client_token(&self) -> Option<&str>
A unique, case-sensitive token that you provide to ensure the idempotency of the request.
Sourcepub fn custom_data_identifier_ids(&self) -> &[String]
pub fn custom_data_identifier_ids(&self) -> &[String]
An array of unique identifiers, one for each custom data identifier for the job to use when it analyzes data. To use only managed data identifiers, don't specify a value for this property and specify a value other than NONE for the managedDataIdentifierSelector property.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .custom_data_identifier_ids.is_none()
.
Sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
A custom description of the job. The description can contain as many as 200 characters.
Sourcepub fn initial_run(&self) -> Option<bool>
pub fn initial_run(&self) -> Option<bool>
For a recurring job, specifies whether to analyze all existing, eligible objects immediately after the job is created (true). To analyze only those objects that are created or changed after you create the job and before the job's first scheduled run, set this value to false.
If you configure the job to run only once, don't specify a value for this property.
Sourcepub fn job_type(&self) -> Option<&JobType>
pub fn job_type(&self) -> Option<&JobType>
The schedule for running the job. Valid values are:
-
ONE_TIME - Run the job only once. If you specify this value, don't specify a value for the scheduleFrequency property.
-
SCHEDULED - Run the job on a daily, weekly, or monthly basis. If you specify this value, use the scheduleFrequency property to specify the recurrence pattern for the job.
Sourcepub fn managed_data_identifier_ids(&self) -> &[String]
pub fn managed_data_identifier_ids(&self) -> &[String]
An array of unique identifiers, one for each managed data identifier for the job to include (use) or exclude (not use) when it analyzes data. Inclusion or exclusion depends on the managed data identifier selection type that you specify for the job (managedDataIdentifierSelector).
To retrieve a list of valid values for this property, use the ListManagedDataIdentifiers operation.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .managed_data_identifier_ids.is_none()
.
Sourcepub fn managed_data_identifier_selector(
&self,
) -> Option<&ManagedDataIdentifierSelector>
pub fn managed_data_identifier_selector( &self, ) -> Option<&ManagedDataIdentifierSelector>
The selection type to apply when determining which managed data identifiers the job uses to analyze data. Valid values are:
-
ALL - Use all managed data identifiers. If you specify this value, don't specify any values for the managedDataIdentifierIds property.
-
EXCLUDE - Use all managed data identifiers except the ones specified by the managedDataIdentifierIds property.
-
INCLUDE - Use only the managed data identifiers specified by the managedDataIdentifierIds property.
-
NONE - Don't use any managed data identifiers. If you specify this value, specify at least one value for the customDataIdentifierIds property and don't specify any values for the managedDataIdentifierIds property.
-
RECOMMENDED (default) - Use the recommended set of managed data identifiers. If you specify this value, don't specify any values for the managedDataIdentifierIds property.
If you don't specify a value for this property, the job uses the recommended set of managed data identifiers.
If the job is a recurring job and you specify ALL or EXCLUDE, each job run automatically uses new managed data identifiers that are released. If you don't specify a value for this property or you specify RECOMMENDED for a recurring job, each job run automatically uses all the managed data identifiers that are in the recommended set when the run starts.
To learn about individual managed data identifiers or determine which ones are in the recommended set, see Using managed data identifiers or Recommended managed data identifiers in the Amazon Macie User Guide.
Sourcepub fn name(&self) -> Option<&str>
pub fn name(&self) -> Option<&str>
A custom name for the job. The name can contain as many as 500 characters.
Sourcepub fn s3_job_definition(&self) -> Option<&S3JobDefinition>
pub fn s3_job_definition(&self) -> Option<&S3JobDefinition>
The S3 buckets that contain the objects to analyze, and the scope of that analysis.
Sourcepub fn sampling_percentage(&self) -> Option<i32>
pub fn sampling_percentage(&self) -> Option<i32>
The sampling depth, as a percentage, for the job to apply when processing objects. This value determines the percentage of eligible objects that the job analyzes. If this value is less than 100, Amazon Macie selects the objects to analyze at random, up to the specified percentage, and analyzes all the data in those objects.
Sourcepub fn schedule_frequency(&self) -> Option<&JobScheduleFrequency>
pub fn schedule_frequency(&self) -> Option<&JobScheduleFrequency>
The recurrence pattern for running the job. To run the job only once, don't specify a value for this property and set the value for the jobType property to ONE_TIME.
A map of key-value pairs that specifies the tags to associate with the job.
A job can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.
Source§impl CreateClassificationJobInput
impl CreateClassificationJobInput
Sourcepub fn builder() -> CreateClassificationJobInputBuilder
pub fn builder() -> CreateClassificationJobInputBuilder
Creates a new builder-style object to manufacture CreateClassificationJobInput
.
Trait Implementations§
Source§impl Clone for CreateClassificationJobInput
impl Clone for CreateClassificationJobInput
Source§fn clone(&self) -> CreateClassificationJobInput
fn clone(&self) -> CreateClassificationJobInput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for CreateClassificationJobInput
impl Debug for CreateClassificationJobInput
Source§impl PartialEq for CreateClassificationJobInput
impl PartialEq for CreateClassificationJobInput
Source§fn eq(&self, other: &CreateClassificationJobInput) -> bool
fn eq(&self, other: &CreateClassificationJobInput) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for CreateClassificationJobInput
Auto Trait Implementations§
impl Freeze for CreateClassificationJobInput
impl RefUnwindSafe for CreateClassificationJobInput
impl Send for CreateClassificationJobInput
impl Sync for CreateClassificationJobInput
impl Unpin for CreateClassificationJobInput
impl UnwindSafe for CreateClassificationJobInput
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);