Struct aws_sdk_macie2::input::CreateClassificationJobInput
source · [−]#[non_exhaustive]pub struct CreateClassificationJobInput {
pub client_token: Option<String>,
pub custom_data_identifier_ids: Option<Vec<String>>,
pub description: Option<String>,
pub initial_run: 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: 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.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: 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 define 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 the managed data identifiers that Amazon Macie provides. If you specify this value, don't specify any values for the managedDataIdentifierIds property.
EXCLUDE - Use all the managed data identifiers that Macie provides except the managed data identifiers 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 custom data identifier for the job (customDataIdentifierIds) and don't specify any values for the managedDataIdentifierIds property.
If you don't specify a value for this property, the job uses all managed data identifiers. If you don't specify a value for this property or you specify ALL or EXCLUDE for a recurring job, the job also uses new managed data identifiers as they are released.
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: 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
sourceimpl CreateClassificationJobInput
impl CreateClassificationJobInput
sourcepub async fn make_operation(
self,
_config: &Config
) -> Result<Operation<CreateClassificationJob, AwsErrorRetryPolicy>, BuildError>
pub async fn make_operation(
self,
_config: &Config
) -> Result<Operation<CreateClassificationJob, AwsErrorRetryPolicy>, BuildError>
Consumes the builder and constructs an Operation<CreateClassificationJob
>
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture CreateClassificationJobInput
sourceimpl CreateClassificationJobInput
impl CreateClassificationJobInput
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) -> Option<&[String]>
pub fn custom_data_identifier_ids(&self) -> Option<&[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.
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) -> bool
pub fn initial_run(&self) -> 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 define the recurrence pattern for the job.
sourcepub fn managed_data_identifier_ids(&self) -> Option<&[String]>
pub fn managed_data_identifier_ids(&self) -> Option<&[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.
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 the managed data identifiers that Amazon Macie provides. If you specify this value, don't specify any values for the managedDataIdentifierIds property.
EXCLUDE - Use all the managed data identifiers that Macie provides except the managed data identifiers 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 custom data identifier for the job (customDataIdentifierIds) and don't specify any values for the managedDataIdentifierIds property.
If you don't specify a value for this property, the job uses all managed data identifiers. If you don't specify a value for this property or you specify ALL or EXCLUDE for a recurring job, the job also uses new managed data identifiers as they are released.
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) -> i32
pub fn sampling_percentage(&self) -> 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.
Trait Implementations
sourceimpl Clone for CreateClassificationJobInput
impl Clone for CreateClassificationJobInput
sourcefn clone(&self) -> CreateClassificationJobInput
fn clone(&self) -> CreateClassificationJobInput
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for CreateClassificationJobInput
impl Debug for CreateClassificationJobInput
sourceimpl PartialEq<CreateClassificationJobInput> for CreateClassificationJobInput
impl PartialEq<CreateClassificationJobInput> for CreateClassificationJobInput
sourcefn eq(&self, other: &CreateClassificationJobInput) -> bool
fn eq(&self, other: &CreateClassificationJobInput) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &CreateClassificationJobInput) -> bool
fn ne(&self, other: &CreateClassificationJobInput) -> bool
This method tests for !=
.
impl StructuralPartialEq for CreateClassificationJobInput
Auto Trait Implementations
impl RefUnwindSafe for CreateClassificationJobInput
impl Send for CreateClassificationJobInput
impl Sync for CreateClassificationJobInput
impl Unpin for CreateClassificationJobInput
impl UnwindSafe for CreateClassificationJobInput
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more