Struct JobSummary

#[non_exhaustive]
pub struct JobSummary {
    pub bucket_criteria: Option<S3BucketCriteriaForJob>,
    pub bucket_definitions: Option<Vec<S3BucketDefinitionForJob>>,
    pub created_at: Option<DateTime>,
    pub job_id: Option<String>,
    pub job_status: Option<JobStatus>,
    pub job_type: Option<JobType>,
    pub last_run_error_status: Option<LastRunErrorStatus>,
    pub name: Option<String>,
    pub user_paused_details: Option<UserPausedDetails>,
}

Provides information about a classification job, including the current status of the job.

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.

bucket_criteria: Option<S3BucketCriteriaForJob>

The property- and tag-based conditions that determine which S3 buckets are included or excluded from the job's analysis. Each time the job runs, the job uses these criteria to determine which buckets to analyze. A job's definition can contain a bucketCriteria object or a bucketDefinitions array, not both.

bucket_definitions: Option<Vec<S3BucketDefinitionForJob>>

An array of objects, one for each Amazon Web Services account that owns specific S3 buckets for the job to analyze. Each object specifies the account ID for an account and one or more buckets to analyze for that account. A job's definition can contain a bucketDefinitions array or a bucketCriteria object, not both.

created_at: Option<DateTime>

The date and time, in UTC and extended ISO 8601 format, when the job was created.

job_id: Option<String>

The unique identifier for the job.

job_status: Option<JobStatus>

The current status of the job. Possible values are:

• CANCELLED - You cancelled the job or, if it's a one-time job, you paused the job and didn't resume it within 30 days.

• COMPLETE - For a one-time job, Amazon Macie finished processing the data specified for the job. This value doesn't apply to recurring jobs.

• IDLE - For a recurring job, the previous scheduled run is complete and the next scheduled run is pending. This value doesn't apply to one-time jobs.

• PAUSED - Macie started running the job but additional processing would exceed the monthly sensitive data discovery quota for your account or one or more member accounts that the job analyzes data for.

• RUNNING - For a one-time job, the job is in progress. For a recurring job, a scheduled run is in progress.

• USER_PAUSED - You paused the job. If you paused the job while it had a status of RUNNING and you don't resume it within 30 days of pausing it, the job or job run will expire and be cancelled, depending on the job's type. To check the expiration date, refer to the UserPausedDetails.jobExpiresAt property.

job_type: Option<JobType>

The schedule for running the job. Possible values are:

• ONE_TIME - The job runs only once.

• SCHEDULED - The job runs on a daily, weekly, or monthly basis.

last_run_error_status: Option<LastRunErrorStatus>

Specifies whether any account- or bucket-level access errors occurred when the job ran. For a recurring job, this value indicates the error status of the job's most recent run.

name: Option<String>

The custom name of the job.

user_paused_details: Option<UserPausedDetails>

If the current status of the job is USER_PAUSED, specifies when the job was paused and when the job or job run will expire and be cancelled if it isn't resumed. This value is present only if the value for jobStatus is USER_PAUSED.

Implementations

impl JobSummary

pub fn bucket_criteria(&self) -> Option<&S3BucketCriteriaForJob>

The property- and tag-based conditions that determine which S3 buckets are included or excluded from the job's analysis. Each time the job runs, the job uses these criteria to determine which buckets to analyze. A job's definition can contain a bucketCriteria object or a bucketDefinitions array, not both.

pub fn bucket_definitions(&self) -> &[S3BucketDefinitionForJob]

An array of objects, one for each Amazon Web Services account that owns specific S3 buckets for the job to analyze. Each object specifies the account ID for an account and one or more buckets to analyze for that account. A job's definition can contain a bucketDefinitions array or a bucketCriteria object, not both.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .bucket_definitions.is_none().

pub fn created_at(&self) -> Option<&DateTime>

The date and time, in UTC and extended ISO 8601 format, when the job was created.

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

The unique identifier for the job.

pub fn job_status(&self) -> Option<&JobStatus>

The current status of the job. Possible values are:

• CANCELLED - You cancelled the job or, if it's a one-time job, you paused the job and didn't resume it within 30 days.

• COMPLETE - For a one-time job, Amazon Macie finished processing the data specified for the job. This value doesn't apply to recurring jobs.

• IDLE - For a recurring job, the previous scheduled run is complete and the next scheduled run is pending. This value doesn't apply to one-time jobs.

• PAUSED - Macie started running the job but additional processing would exceed the monthly sensitive data discovery quota for your account or one or more member accounts that the job analyzes data for.

• RUNNING - For a one-time job, the job is in progress. For a recurring job, a scheduled run is in progress.

• USER_PAUSED - You paused the job. If you paused the job while it had a status of RUNNING and you don't resume it within 30 days of pausing it, the job or job run will expire and be cancelled, depending on the job's type. To check the expiration date, refer to the UserPausedDetails.jobExpiresAt property.

pub fn job_type(&self) -> Option<&JobType>

The schedule for running the job. Possible values are:

• ONE_TIME - The job runs only once.

• SCHEDULED - The job runs on a daily, weekly, or monthly basis.

pub fn last_run_error_status(&self) -> Option<&LastRunErrorStatus>

Specifies whether any account- or bucket-level access errors occurred when the job ran. For a recurring job, this value indicates the error status of the job's most recent run.

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

The custom name of the job.

pub fn user_paused_details(&self) -> Option<&UserPausedDetails>

If the current status of the job is USER_PAUSED, specifies when the job was paused and when the job or job run will expire and be cancelled if it isn't resumed. This value is present only if the value for jobStatus is USER_PAUSED.

impl JobSummary

pub fn builder() -> JobSummaryBuilder

Creates a new builder-style object to manufacture JobSummary.

Trait Implementations

impl Clone for JobSummary

fn clone(&self) -> JobSummary

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for JobSummary

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

Formats the value using the given formatter.

impl PartialEq for JobSummary

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for JobSummary