AWS SDK for C++  1.9.67
AWS SDK for C++
Public Member Functions | List of all members
Aws::Macie2::Model::JobSummary Class Reference

#include <JobSummary.h>

Public Member Functions

 JobSummary ()
 
 JobSummary (Aws::Utils::Json::JsonView jsonValue)
 
JobSummaryoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::Vector< S3BucketDefinitionForJob > & GetBucketDefinitions () const
 
bool BucketDefinitionsHasBeenSet () const
 
void SetBucketDefinitions (const Aws::Vector< S3BucketDefinitionForJob > &value)
 
void SetBucketDefinitions (Aws::Vector< S3BucketDefinitionForJob > &&value)
 
JobSummaryWithBucketDefinitions (const Aws::Vector< S3BucketDefinitionForJob > &value)
 
JobSummaryWithBucketDefinitions (Aws::Vector< S3BucketDefinitionForJob > &&value)
 
JobSummaryAddBucketDefinitions (const S3BucketDefinitionForJob &value)
 
JobSummaryAddBucketDefinitions (S3BucketDefinitionForJob &&value)
 
const Aws::Utils::DateTimeGetCreatedAt () const
 
bool CreatedAtHasBeenSet () const
 
void SetCreatedAt (const Aws::Utils::DateTime &value)
 
void SetCreatedAt (Aws::Utils::DateTime &&value)
 
JobSummaryWithCreatedAt (const Aws::Utils::DateTime &value)
 
JobSummaryWithCreatedAt (Aws::Utils::DateTime &&value)
 
const Aws::StringGetJobId () const
 
bool JobIdHasBeenSet () const
 
void SetJobId (const Aws::String &value)
 
void SetJobId (Aws::String &&value)
 
void SetJobId (const char *value)
 
JobSummaryWithJobId (const Aws::String &value)
 
JobSummaryWithJobId (Aws::String &&value)
 
JobSummaryWithJobId (const char *value)
 
const JobStatusGetJobStatus () const
 
bool JobStatusHasBeenSet () const
 
void SetJobStatus (const JobStatus &value)
 
void SetJobStatus (JobStatus &&value)
 
JobSummaryWithJobStatus (const JobStatus &value)
 
JobSummaryWithJobStatus (JobStatus &&value)
 
const JobTypeGetJobType () const
 
bool JobTypeHasBeenSet () const
 
void SetJobType (const JobType &value)
 
void SetJobType (JobType &&value)
 
JobSummaryWithJobType (const JobType &value)
 
JobSummaryWithJobType (JobType &&value)
 
const LastRunErrorStatusGetLastRunErrorStatus () const
 
bool LastRunErrorStatusHasBeenSet () const
 
void SetLastRunErrorStatus (const LastRunErrorStatus &value)
 
void SetLastRunErrorStatus (LastRunErrorStatus &&value)
 
JobSummaryWithLastRunErrorStatus (const LastRunErrorStatus &value)
 
JobSummaryWithLastRunErrorStatus (LastRunErrorStatus &&value)
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
JobSummaryWithName (const Aws::String &value)
 
JobSummaryWithName (Aws::String &&value)
 
JobSummaryWithName (const char *value)
 
const UserPausedDetailsGetUserPausedDetails () const
 
bool UserPausedDetailsHasBeenSet () const
 
void SetUserPausedDetails (const UserPausedDetails &value)
 
void SetUserPausedDetails (UserPausedDetails &&value)
 
JobSummaryWithUserPausedDetails (const UserPausedDetails &value)
 
JobSummaryWithUserPausedDetails (UserPausedDetails &&value)
 
const S3BucketCriteriaForJobGetBucketCriteria () const
 
bool BucketCriteriaHasBeenSet () const
 
void SetBucketCriteria (const S3BucketCriteriaForJob &value)
 
void SetBucketCriteria (S3BucketCriteriaForJob &&value)
 
JobSummaryWithBucketCriteria (const S3BucketCriteriaForJob &value)
 
JobSummaryWithBucketCriteria (S3BucketCriteriaForJob &&value)
 

Detailed Description

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

See Also:

AWS API Reference

Definition at line 40 of file JobSummary.h.

Constructor & Destructor Documentation

◆ JobSummary() [1/2]

Aws::Macie2::Model::JobSummary::JobSummary ( )

◆ JobSummary() [2/2]

Aws::Macie2::Model::JobSummary::JobSummary ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddBucketDefinitions() [1/2]

JobSummary& Aws::Macie2::Model::JobSummary::AddBucketDefinitions ( const S3BucketDefinitionForJob value)
inline

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.

Definition at line 110 of file JobSummary.h.

◆ AddBucketDefinitions() [2/2]

JobSummary& Aws::Macie2::Model::JobSummary::AddBucketDefinitions ( S3BucketDefinitionForJob &&  value)
inline

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.

Definition at line 119 of file JobSummary.h.

◆ BucketCriteriaHasBeenSet()

bool Aws::Macie2::Model::JobSummary::BucketCriteriaHasBeenSet ( ) const
inline

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.

Definition at line 511 of file JobSummary.h.

◆ BucketDefinitionsHasBeenSet()

bool Aws::Macie2::Model::JobSummary::BucketDefinitionsHasBeenSet ( ) const
inline

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.

Definition at line 65 of file JobSummary.h.

◆ CreatedAtHasBeenSet()

bool Aws::Macie2::Model::JobSummary::CreatedAtHasBeenSet ( ) const
inline

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

Definition at line 132 of file JobSummary.h.

◆ GetBucketCriteria()

const S3BucketCriteriaForJob& Aws::Macie2::Model::JobSummary::GetBucketCriteria ( ) const
inline

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.

Definition at line 503 of file JobSummary.h.

◆ GetBucketDefinitions()

const Aws::Vector<S3BucketDefinitionForJob>& Aws::Macie2::Model::JobSummary::GetBucketDefinitions ( ) const
inline

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.

Definition at line 56 of file JobSummary.h.

◆ GetCreatedAt()

const Aws::Utils::DateTime& Aws::Macie2::Model::JobSummary::GetCreatedAt ( ) const
inline

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

Definition at line 126 of file JobSummary.h.

◆ GetJobId()

const Aws::String& Aws::Macie2::Model::JobSummary::GetJobId ( ) const
inline

The unique identifier for the job.

Definition at line 162 of file JobSummary.h.

◆ GetJobStatus()

const JobStatus& Aws::Macie2::Model::JobSummary::GetJobStatus ( ) const
inline

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 - Amazon 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.

Definition at line 218 of file JobSummary.h.

◆ GetJobType()

const JobType& Aws::Macie2::Model::JobSummary::GetJobType ( ) const
inline

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.

Definition at line 326 of file JobSummary.h.

◆ GetLastRunErrorStatus()

const LastRunErrorStatus& Aws::Macie2::Model::JobSummary::GetLastRunErrorStatus ( ) const
inline

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.

Definition at line 369 of file JobSummary.h.

◆ GetName()

const Aws::String& Aws::Macie2::Model::JobSummary::GetName ( ) const
inline

The custom name of the job.

Definition at line 410 of file JobSummary.h.

◆ GetUserPausedDetails()

const UserPausedDetails& Aws::Macie2::Model::JobSummary::GetUserPausedDetails ( ) const
inline

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.

Definition at line 454 of file JobSummary.h.

◆ JobIdHasBeenSet()

bool Aws::Macie2::Model::JobSummary::JobIdHasBeenSet ( ) const
inline

The unique identifier for the job.

Definition at line 167 of file JobSummary.h.

◆ JobStatusHasBeenSet()

bool Aws::Macie2::Model::JobSummary::JobStatusHasBeenSet ( ) const
inline

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 - Amazon 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.

Definition at line 238 of file JobSummary.h.

◆ JobTypeHasBeenSet()

bool Aws::Macie2::Model::JobSummary::JobTypeHasBeenSet ( ) const
inline

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.

Definition at line 333 of file JobSummary.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::Macie2::Model::JobSummary::Jsonize ( ) const

◆ LastRunErrorStatusHasBeenSet()

bool Aws::Macie2::Model::JobSummary::LastRunErrorStatusHasBeenSet ( ) const
inline

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.

Definition at line 376 of file JobSummary.h.

◆ NameHasBeenSet()

bool Aws::Macie2::Model::JobSummary::NameHasBeenSet ( ) const
inline

The custom name of the job.

Definition at line 415 of file JobSummary.h.

◆ operator=()

JobSummary& Aws::Macie2::Model::JobSummary::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetBucketCriteria() [1/2]

void Aws::Macie2::Model::JobSummary::SetBucketCriteria ( const S3BucketCriteriaForJob value)
inline

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.

Definition at line 519 of file JobSummary.h.

◆ SetBucketCriteria() [2/2]

void Aws::Macie2::Model::JobSummary::SetBucketCriteria ( S3BucketCriteriaForJob &&  value)
inline

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.

Definition at line 527 of file JobSummary.h.

◆ SetBucketDefinitions() [1/2]

void Aws::Macie2::Model::JobSummary::SetBucketDefinitions ( Aws::Vector< S3BucketDefinitionForJob > &&  value)
inline

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.

Definition at line 83 of file JobSummary.h.

◆ SetBucketDefinitions() [2/2]

void Aws::Macie2::Model::JobSummary::SetBucketDefinitions ( const Aws::Vector< S3BucketDefinitionForJob > &  value)
inline

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.

Definition at line 74 of file JobSummary.h.

◆ SetCreatedAt() [1/2]

void Aws::Macie2::Model::JobSummary::SetCreatedAt ( Aws::Utils::DateTime &&  value)
inline

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

Definition at line 144 of file JobSummary.h.

◆ SetCreatedAt() [2/2]

void Aws::Macie2::Model::JobSummary::SetCreatedAt ( const Aws::Utils::DateTime value)
inline

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

Definition at line 138 of file JobSummary.h.

◆ SetJobId() [1/3]

void Aws::Macie2::Model::JobSummary::SetJobId ( Aws::String &&  value)
inline

The unique identifier for the job.

Definition at line 177 of file JobSummary.h.

◆ SetJobId() [2/3]

void Aws::Macie2::Model::JobSummary::SetJobId ( const Aws::String value)
inline

The unique identifier for the job.

Definition at line 172 of file JobSummary.h.

◆ SetJobId() [3/3]

void Aws::Macie2::Model::JobSummary::SetJobId ( const char *  value)
inline

The unique identifier for the job.

Definition at line 182 of file JobSummary.h.

◆ SetJobStatus() [1/2]

void Aws::Macie2::Model::JobSummary::SetJobStatus ( const JobStatus value)
inline

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 - Amazon 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.

Definition at line 258 of file JobSummary.h.

◆ SetJobStatus() [2/2]

void Aws::Macie2::Model::JobSummary::SetJobStatus ( JobStatus &&  value)
inline

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 - Amazon 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.

Definition at line 278 of file JobSummary.h.

◆ SetJobType() [1/2]

void Aws::Macie2::Model::JobSummary::SetJobType ( const JobType value)
inline

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.

Definition at line 340 of file JobSummary.h.

◆ SetJobType() [2/2]

void Aws::Macie2::Model::JobSummary::SetJobType ( JobType &&  value)
inline

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.

Definition at line 347 of file JobSummary.h.

◆ SetLastRunErrorStatus() [1/2]

void Aws::Macie2::Model::JobSummary::SetLastRunErrorStatus ( const LastRunErrorStatus value)
inline

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.

Definition at line 383 of file JobSummary.h.

◆ SetLastRunErrorStatus() [2/2]

void Aws::Macie2::Model::JobSummary::SetLastRunErrorStatus ( LastRunErrorStatus &&  value)
inline

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.

Definition at line 390 of file JobSummary.h.

◆ SetName() [1/3]

void Aws::Macie2::Model::JobSummary::SetName ( Aws::String &&  value)
inline

The custom name of the job.

Definition at line 425 of file JobSummary.h.

◆ SetName() [2/3]

void Aws::Macie2::Model::JobSummary::SetName ( const Aws::String value)
inline

The custom name of the job.

Definition at line 420 of file JobSummary.h.

◆ SetName() [3/3]

void Aws::Macie2::Model::JobSummary::SetName ( const char *  value)
inline

The custom name of the job.

Definition at line 430 of file JobSummary.h.

◆ SetUserPausedDetails() [1/2]

void Aws::Macie2::Model::JobSummary::SetUserPausedDetails ( const UserPausedDetails value)
inline

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.

Definition at line 470 of file JobSummary.h.

◆ SetUserPausedDetails() [2/2]

void Aws::Macie2::Model::JobSummary::SetUserPausedDetails ( UserPausedDetails &&  value)
inline

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.

Definition at line 478 of file JobSummary.h.

◆ UserPausedDetailsHasBeenSet()

bool Aws::Macie2::Model::JobSummary::UserPausedDetailsHasBeenSet ( ) const
inline

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.

Definition at line 462 of file JobSummary.h.

◆ WithBucketCriteria() [1/2]

JobSummary& Aws::Macie2::Model::JobSummary::WithBucketCriteria ( const S3BucketCriteriaForJob value)
inline

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.

Definition at line 535 of file JobSummary.h.

◆ WithBucketCriteria() [2/2]

JobSummary& Aws::Macie2::Model::JobSummary::WithBucketCriteria ( S3BucketCriteriaForJob &&  value)
inline

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.

Definition at line 543 of file JobSummary.h.

◆ WithBucketDefinitions() [1/2]

JobSummary& Aws::Macie2::Model::JobSummary::WithBucketDefinitions ( Aws::Vector< S3BucketDefinitionForJob > &&  value)
inline

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.

Definition at line 101 of file JobSummary.h.

◆ WithBucketDefinitions() [2/2]

JobSummary& Aws::Macie2::Model::JobSummary::WithBucketDefinitions ( const Aws::Vector< S3BucketDefinitionForJob > &  value)
inline

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.

Definition at line 92 of file JobSummary.h.

◆ WithCreatedAt() [1/2]

JobSummary& Aws::Macie2::Model::JobSummary::WithCreatedAt ( Aws::Utils::DateTime &&  value)
inline

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

Definition at line 156 of file JobSummary.h.

◆ WithCreatedAt() [2/2]

JobSummary& Aws::Macie2::Model::JobSummary::WithCreatedAt ( const Aws::Utils::DateTime value)
inline

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

Definition at line 150 of file JobSummary.h.

◆ WithJobId() [1/3]

JobSummary& Aws::Macie2::Model::JobSummary::WithJobId ( Aws::String &&  value)
inline

The unique identifier for the job.

Definition at line 192 of file JobSummary.h.

◆ WithJobId() [2/3]

JobSummary& Aws::Macie2::Model::JobSummary::WithJobId ( const Aws::String value)
inline

The unique identifier for the job.

Definition at line 187 of file JobSummary.h.

◆ WithJobId() [3/3]

JobSummary& Aws::Macie2::Model::JobSummary::WithJobId ( const char *  value)
inline

The unique identifier for the job.

Definition at line 197 of file JobSummary.h.

◆ WithJobStatus() [1/2]

JobSummary& Aws::Macie2::Model::JobSummary::WithJobStatus ( const JobStatus value)
inline

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 - Amazon 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.

Definition at line 298 of file JobSummary.h.

◆ WithJobStatus() [2/2]

JobSummary& Aws::Macie2::Model::JobSummary::WithJobStatus ( JobStatus &&  value)
inline

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 - Amazon 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.

Definition at line 318 of file JobSummary.h.

◆ WithJobType() [1/2]

JobSummary& Aws::Macie2::Model::JobSummary::WithJobType ( const JobType value)
inline

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.

Definition at line 354 of file JobSummary.h.

◆ WithJobType() [2/2]

JobSummary& Aws::Macie2::Model::JobSummary::WithJobType ( JobType &&  value)
inline

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.

Definition at line 361 of file JobSummary.h.

◆ WithLastRunErrorStatus() [1/2]

JobSummary& Aws::Macie2::Model::JobSummary::WithLastRunErrorStatus ( const LastRunErrorStatus value)
inline

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.

Definition at line 397 of file JobSummary.h.

◆ WithLastRunErrorStatus() [2/2]

JobSummary& Aws::Macie2::Model::JobSummary::WithLastRunErrorStatus ( LastRunErrorStatus &&  value)
inline

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.

Definition at line 404 of file JobSummary.h.

◆ WithName() [1/3]

JobSummary& Aws::Macie2::Model::JobSummary::WithName ( Aws::String &&  value)
inline

The custom name of the job.

Definition at line 440 of file JobSummary.h.

◆ WithName() [2/3]

JobSummary& Aws::Macie2::Model::JobSummary::WithName ( const Aws::String value)
inline

The custom name of the job.

Definition at line 435 of file JobSummary.h.

◆ WithName() [3/3]

JobSummary& Aws::Macie2::Model::JobSummary::WithName ( const char *  value)
inline

The custom name of the job.

Definition at line 445 of file JobSummary.h.

◆ WithUserPausedDetails() [1/2]

JobSummary& Aws::Macie2::Model::JobSummary::WithUserPausedDetails ( const UserPausedDetails value)
inline

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.

Definition at line 486 of file JobSummary.h.

◆ WithUserPausedDetails() [2/2]

JobSummary& Aws::Macie2::Model::JobSummary::WithUserPausedDetails ( UserPausedDetails &&  value)
inline

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.

Definition at line 494 of file JobSummary.h.


The documentation for this class was generated from the following file: