Struct aws_sdk_macie2::operation::create_classification_job::CreateClassificationJobInput

#[non_exhaustive]
pub struct CreateClassificationJobInput {

    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)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional 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 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 (default) - 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 custom data identifier for the job (customDataIdentifierIds) and don't specify any values for the managedDataIdentifierIds property.

• RECOMMENDED - Use only the set of managed data identifiers that Amazon Web Services recommends for jobs. 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 all managed data identifiers.

If the job is a recurring job and you don't specify a value for this property or you specify ALL or EXCLUDE, each job run automatically uses new managed data identifiers that are released. If 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 job starts to run.

For information about individual managed data identifiers or to determine which ones are in the recommended set, see Using managed data identifiers and 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.

tags: Option<HashMap<String, String>>

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

impl CreateClassificationJobInput

pub fn allow_list_ids(&self) -> Option<&[String]>

An array of unique identifiers, one for each allow list for the job to use when it analyzes data.

pub fn client_token(&self) -> Option<&str>

A unique, case-sensitive token that you provide to ensure the idempotency of the request.

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.

pub fn description(&self) -> Option<&str>

A custom description of the job. The description can contain as many as 200 characters.

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.

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.

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.

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 (default) - 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 custom data identifier for the job (customDataIdentifierIds) and don't specify any values for the managedDataIdentifierIds property.

• RECOMMENDED - Use only the set of managed data identifiers that Amazon Web Services recommends for jobs. 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 all managed data identifiers.

If the job is a recurring job and you don't specify a value for this property or you specify ALL or EXCLUDE, each job run automatically uses new managed data identifiers that are released. If 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 job starts to run.

For information about individual managed data identifiers or to determine which ones are in the recommended set, see Using managed data identifiers and Recommended managed data identifiers in the Amazon Macie User Guide.

pub fn name(&self) -> Option<&str>

A custom name for the job. The name can contain as many as 500 characters.

pub fn s3_job_definition(&self) -> Option<&S3JobDefinition>

The S3 buckets that contain the objects to analyze, and the scope of that analysis.

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.

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.

pub fn tags(&self) -> Option<&HashMap<String, String>>

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.

impl CreateClassificationJobInput

pub fn builder() -> CreateClassificationJobInputBuilder

Creates a new builder-style object to manufacture CreateClassificationJobInput.

Trait Implementations

impl Clone for CreateClassificationJobInput

fn clone(&self) -> CreateClassificationJobInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateClassificationJobInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<CreateClassificationJobInput> for CreateClassificationJobInput

fn eq(&self, other: &CreateClassificationJobInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateClassificationJobInput