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

#include <DescribeClassificationJobResult.h>

Public Member Functions

 DescribeClassificationJobResult ()
 
 DescribeClassificationJobResult (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
DescribeClassificationJobResultoperator= (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
const Aws::StringGetClientToken () const
 
void SetClientToken (const Aws::String &value)
 
void SetClientToken (Aws::String &&value)
 
void SetClientToken (const char *value)
 
DescribeClassificationJobResultWithClientToken (const Aws::String &value)
 
DescribeClassificationJobResultWithClientToken (Aws::String &&value)
 
DescribeClassificationJobResultWithClientToken (const char *value)
 
const Aws::Utils::DateTimeGetCreatedAt () const
 
void SetCreatedAt (const Aws::Utils::DateTime &value)
 
void SetCreatedAt (Aws::Utils::DateTime &&value)
 
DescribeClassificationJobResultWithCreatedAt (const Aws::Utils::DateTime &value)
 
DescribeClassificationJobResultWithCreatedAt (Aws::Utils::DateTime &&value)
 
const Aws::Vector< Aws::String > & GetCustomDataIdentifierIds () const
 
void SetCustomDataIdentifierIds (const Aws::Vector< Aws::String > &value)
 
void SetCustomDataIdentifierIds (Aws::Vector< Aws::String > &&value)
 
DescribeClassificationJobResultWithCustomDataIdentifierIds (const Aws::Vector< Aws::String > &value)
 
DescribeClassificationJobResultWithCustomDataIdentifierIds (Aws::Vector< Aws::String > &&value)
 
DescribeClassificationJobResultAddCustomDataIdentifierIds (const Aws::String &value)
 
DescribeClassificationJobResultAddCustomDataIdentifierIds (Aws::String &&value)
 
DescribeClassificationJobResultAddCustomDataIdentifierIds (const char *value)
 
const Aws::StringGetDescription () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
DescribeClassificationJobResultWithDescription (const Aws::String &value)
 
DescribeClassificationJobResultWithDescription (Aws::String &&value)
 
DescribeClassificationJobResultWithDescription (const char *value)
 
bool GetInitialRun () const
 
void SetInitialRun (bool value)
 
DescribeClassificationJobResultWithInitialRun (bool value)
 
const Aws::StringGetJobArn () const
 
void SetJobArn (const Aws::String &value)
 
void SetJobArn (Aws::String &&value)
 
void SetJobArn (const char *value)
 
DescribeClassificationJobResultWithJobArn (const Aws::String &value)
 
DescribeClassificationJobResultWithJobArn (Aws::String &&value)
 
DescribeClassificationJobResultWithJobArn (const char *value)
 
const Aws::StringGetJobId () const
 
void SetJobId (const Aws::String &value)
 
void SetJobId (Aws::String &&value)
 
void SetJobId (const char *value)
 
DescribeClassificationJobResultWithJobId (const Aws::String &value)
 
DescribeClassificationJobResultWithJobId (Aws::String &&value)
 
DescribeClassificationJobResultWithJobId (const char *value)
 
const JobStatusGetJobStatus () const
 
void SetJobStatus (const JobStatus &value)
 
void SetJobStatus (JobStatus &&value)
 
DescribeClassificationJobResultWithJobStatus (const JobStatus &value)
 
DescribeClassificationJobResultWithJobStatus (JobStatus &&value)
 
const JobTypeGetJobType () const
 
void SetJobType (const JobType &value)
 
void SetJobType (JobType &&value)
 
DescribeClassificationJobResultWithJobType (const JobType &value)
 
DescribeClassificationJobResultWithJobType (JobType &&value)
 
const LastRunErrorStatusGetLastRunErrorStatus () const
 
void SetLastRunErrorStatus (const LastRunErrorStatus &value)
 
void SetLastRunErrorStatus (LastRunErrorStatus &&value)
 
DescribeClassificationJobResultWithLastRunErrorStatus (const LastRunErrorStatus &value)
 
DescribeClassificationJobResultWithLastRunErrorStatus (LastRunErrorStatus &&value)
 
const Aws::Utils::DateTimeGetLastRunTime () const
 
void SetLastRunTime (const Aws::Utils::DateTime &value)
 
void SetLastRunTime (Aws::Utils::DateTime &&value)
 
DescribeClassificationJobResultWithLastRunTime (const Aws::Utils::DateTime &value)
 
DescribeClassificationJobResultWithLastRunTime (Aws::Utils::DateTime &&value)
 
const Aws::StringGetName () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
DescribeClassificationJobResultWithName (const Aws::String &value)
 
DescribeClassificationJobResultWithName (Aws::String &&value)
 
DescribeClassificationJobResultWithName (const char *value)
 
const S3JobDefinitionGetS3JobDefinition () const
 
void SetS3JobDefinition (const S3JobDefinition &value)
 
void SetS3JobDefinition (S3JobDefinition &&value)
 
DescribeClassificationJobResultWithS3JobDefinition (const S3JobDefinition &value)
 
DescribeClassificationJobResultWithS3JobDefinition (S3JobDefinition &&value)
 
int GetSamplingPercentage () const
 
void SetSamplingPercentage (int value)
 
DescribeClassificationJobResultWithSamplingPercentage (int value)
 
const JobScheduleFrequencyGetScheduleFrequency () const
 
void SetScheduleFrequency (const JobScheduleFrequency &value)
 
void SetScheduleFrequency (JobScheduleFrequency &&value)
 
DescribeClassificationJobResultWithScheduleFrequency (const JobScheduleFrequency &value)
 
DescribeClassificationJobResultWithScheduleFrequency (JobScheduleFrequency &&value)
 
const StatisticsGetStatistics () const
 
void SetStatistics (const Statistics &value)
 
void SetStatistics (Statistics &&value)
 
DescribeClassificationJobResultWithStatistics (const Statistics &value)
 
DescribeClassificationJobResultWithStatistics (Statistics &&value)
 
const Aws::Map< Aws::String, Aws::String > & GetTags () const
 
void SetTags (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetTags (Aws::Map< Aws::String, Aws::String > &&value)
 
DescribeClassificationJobResultWithTags (const Aws::Map< Aws::String, Aws::String > &value)
 
DescribeClassificationJobResultWithTags (Aws::Map< Aws::String, Aws::String > &&value)
 
DescribeClassificationJobResultAddTags (const Aws::String &key, const Aws::String &value)
 
DescribeClassificationJobResultAddTags (Aws::String &&key, const Aws::String &value)
 
DescribeClassificationJobResultAddTags (const Aws::String &key, Aws::String &&value)
 
DescribeClassificationJobResultAddTags (Aws::String &&key, Aws::String &&value)
 
DescribeClassificationJobResultAddTags (const char *key, Aws::String &&value)
 
DescribeClassificationJobResultAddTags (Aws::String &&key, const char *value)
 
DescribeClassificationJobResultAddTags (const char *key, const char *value)
 
const UserPausedDetailsGetUserPausedDetails () const
 
void SetUserPausedDetails (const UserPausedDetails &value)
 
void SetUserPausedDetails (UserPausedDetails &&value)
 
DescribeClassificationJobResultWithUserPausedDetails (const UserPausedDetails &value)
 
DescribeClassificationJobResultWithUserPausedDetails (UserPausedDetails &&value)
 

Detailed Description

Definition at line 38 of file DescribeClassificationJobResult.h.

Constructor & Destructor Documentation

◆ DescribeClassificationJobResult() [1/2]

Aws::Macie2::Model::DescribeClassificationJobResult::DescribeClassificationJobResult ( )

◆ DescribeClassificationJobResult() [2/2]

Aws::Macie2::Model::DescribeClassificationJobResult::DescribeClassificationJobResult ( const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &  result)

Member Function Documentation

◆ AddCustomDataIdentifierIds() [1/3]

DescribeClassificationJobResult& Aws::Macie2::Model::DescribeClassificationJobResult::AddCustomDataIdentifierIds ( Aws::String &&  value)
inline

The custom data identifiers that the job uses to analyze data.

Definition at line 153 of file DescribeClassificationJobResult.h.

◆ AddCustomDataIdentifierIds() [2/3]

DescribeClassificationJobResult& Aws::Macie2::Model::DescribeClassificationJobResult::AddCustomDataIdentifierIds ( const Aws::String value)
inline

The custom data identifiers that the job uses to analyze data.

Definition at line 148 of file DescribeClassificationJobResult.h.

◆ AddCustomDataIdentifierIds() [3/3]

DescribeClassificationJobResult& Aws::Macie2::Model::DescribeClassificationJobResult::AddCustomDataIdentifierIds ( const char *  value)
inline

The custom data identifiers that the job uses to analyze data.

Definition at line 158 of file DescribeClassificationJobResult.h.

◆ AddTags() [1/7]

DescribeClassificationJobResult& Aws::Macie2::Model::DescribeClassificationJobResult::AddTags ( Aws::String &&  key,
Aws::String &&  value 
)
inline

A map of key-value pairs that specifies which tags (keys and values) are associated with the classification job.

Definition at line 702 of file DescribeClassificationJobResult.h.

◆ AddTags() [2/7]

DescribeClassificationJobResult& Aws::Macie2::Model::DescribeClassificationJobResult::AddTags ( Aws::String &&  key,
const Aws::String value 
)
inline

A map of key-value pairs that specifies which tags (keys and values) are associated with the classification job.

Definition at line 690 of file DescribeClassificationJobResult.h.

◆ AddTags() [3/7]

DescribeClassificationJobResult& Aws::Macie2::Model::DescribeClassificationJobResult::AddTags ( Aws::String &&  key,
const char *  value 
)
inline

A map of key-value pairs that specifies which tags (keys and values) are associated with the classification job.

Definition at line 714 of file DescribeClassificationJobResult.h.

◆ AddTags() [4/7]

DescribeClassificationJobResult& Aws::Macie2::Model::DescribeClassificationJobResult::AddTags ( const Aws::String key,
Aws::String &&  value 
)
inline

A map of key-value pairs that specifies which tags (keys and values) are associated with the classification job.

Definition at line 696 of file DescribeClassificationJobResult.h.

◆ AddTags() [5/7]

DescribeClassificationJobResult& Aws::Macie2::Model::DescribeClassificationJobResult::AddTags ( const Aws::String key,
const Aws::String value 
)
inline

A map of key-value pairs that specifies which tags (keys and values) are associated with the classification job.

Definition at line 684 of file DescribeClassificationJobResult.h.

◆ AddTags() [6/7]

DescribeClassificationJobResult& Aws::Macie2::Model::DescribeClassificationJobResult::AddTags ( const char *  key,
Aws::String &&  value 
)
inline

A map of key-value pairs that specifies which tags (keys and values) are associated with the classification job.

Definition at line 708 of file DescribeClassificationJobResult.h.

◆ AddTags() [7/7]

DescribeClassificationJobResult& Aws::Macie2::Model::DescribeClassificationJobResult::AddTags ( const char *  key,
const char *  value 
)
inline

A map of key-value pairs that specifies which tags (keys and values) are associated with the classification job.

Definition at line 720 of file DescribeClassificationJobResult.h.

◆ GetClientToken()

const Aws::String& Aws::Macie2::Model::DescribeClassificationJobResult::GetClientToken ( ) const
inline

The token that was provided to ensure the idempotency of the request to create the job.

Definition at line 50 of file DescribeClassificationJobResult.h.

◆ GetCreatedAt()

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

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

Definition at line 93 of file DescribeClassificationJobResult.h.

◆ GetCustomDataIdentifierIds()

const Aws::Vector<Aws::String>& Aws::Macie2::Model::DescribeClassificationJobResult::GetCustomDataIdentifierIds ( ) const
inline

The custom data identifiers that the job uses to analyze data.

Definition at line 123 of file DescribeClassificationJobResult.h.

◆ GetDescription()

const Aws::String& Aws::Macie2::Model::DescribeClassificationJobResult::GetDescription ( ) const
inline

The custom description of the job.

Definition at line 164 of file DescribeClassificationJobResult.h.

◆ GetInitialRun()

bool Aws::Macie2::Model::DescribeClassificationJobResult::GetInitialRun ( ) const
inline

Specifies whether the job is configured to analyze all existing, eligible objects immediately after it's created.

Definition at line 201 of file DescribeClassificationJobResult.h.

◆ GetJobArn()

const Aws::String& Aws::Macie2::Model::DescribeClassificationJobResult::GetJobArn ( ) const
inline

The Amazon Resource Name (ARN) of the job.

Definition at line 219 of file DescribeClassificationJobResult.h.

◆ GetJobId()

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

The unique identifier for the job.

Definition at line 255 of file DescribeClassificationJobResult.h.

◆ GetJobStatus()

const JobStatus& Aws::Macie2::Model::DescribeClassificationJobResult::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 306 of file DescribeClassificationJobResult.h.

◆ GetJobType()

const JobType& Aws::Macie2::Model::DescribeClassificationJobResult::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. The scheduleFrequency property indicates the recurrence pattern for the job.

Definition at line 395 of file DescribeClassificationJobResult.h.

◆ GetLastRunErrorStatus()

const LastRunErrorStatus& Aws::Macie2::Model::DescribeClassificationJobResult::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 435 of file DescribeClassificationJobResult.h.

◆ GetLastRunTime()

const Aws::Utils::DateTime& Aws::Macie2::Model::DescribeClassificationJobResult::GetLastRunTime ( ) const
inline

The date and time, in UTC and extended ISO 8601 format, when the job started. If the job is a recurring job, this value indicates when the most recent run started.

Definition at line 471 of file DescribeClassificationJobResult.h.

◆ GetName()

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

The custom name of the job.

Definition at line 505 of file DescribeClassificationJobResult.h.

◆ GetS3JobDefinition()

const S3JobDefinition& Aws::Macie2::Model::DescribeClassificationJobResult::GetS3JobDefinition ( ) const
inline

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

Definition at line 542 of file DescribeClassificationJobResult.h.

◆ GetSamplingPercentage()

int Aws::Macie2::Model::DescribeClassificationJobResult::GetSamplingPercentage ( ) const
inline

The sampling depth, as a percentage, that determines the percentage of eligible objects that the job analyzes.

Definition at line 573 of file DescribeClassificationJobResult.h.

◆ GetScheduleFrequency()

const JobScheduleFrequency& Aws::Macie2::Model::DescribeClassificationJobResult::GetScheduleFrequency ( ) const
inline

The recurrence pattern for running the job. If the job is configured to run only once, this value is null.

Definition at line 592 of file DescribeClassificationJobResult.h.

◆ GetStatistics()

const Statistics& Aws::Macie2::Model::DescribeClassificationJobResult::GetStatistics ( ) const
inline

The number of times that the job has run and processing statistics for the job's current run.

Definition at line 623 of file DescribeClassificationJobResult.h.

◆ GetTags()

const Aws::Map<Aws::String, Aws::String>& Aws::Macie2::Model::DescribeClassificationJobResult::GetTags ( ) const
inline

A map of key-value pairs that specifies which tags (keys and values) are associated with the classification job.

Definition at line 654 of file DescribeClassificationJobResult.h.

◆ GetUserPausedDetails()

const UserPausedDetails& Aws::Macie2::Model::DescribeClassificationJobResult::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 729 of file DescribeClassificationJobResult.h.

◆ operator=()

DescribeClassificationJobResult& Aws::Macie2::Model::DescribeClassificationJobResult::operator= ( const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &  result)

◆ SetClientToken() [1/3]

void Aws::Macie2::Model::DescribeClassificationJobResult::SetClientToken ( Aws::String &&  value)
inline

The token that was provided to ensure the idempotency of the request to create the job.

Definition at line 62 of file DescribeClassificationJobResult.h.

◆ SetClientToken() [2/3]

void Aws::Macie2::Model::DescribeClassificationJobResult::SetClientToken ( const Aws::String value)
inline

The token that was provided to ensure the idempotency of the request to create the job.

Definition at line 56 of file DescribeClassificationJobResult.h.

◆ SetClientToken() [3/3]

void Aws::Macie2::Model::DescribeClassificationJobResult::SetClientToken ( const char *  value)
inline

The token that was provided to ensure the idempotency of the request to create the job.

Definition at line 68 of file DescribeClassificationJobResult.h.

◆ SetCreatedAt() [1/2]

void Aws::Macie2::Model::DescribeClassificationJobResult::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 105 of file DescribeClassificationJobResult.h.

◆ SetCreatedAt() [2/2]

void Aws::Macie2::Model::DescribeClassificationJobResult::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 99 of file DescribeClassificationJobResult.h.

◆ SetCustomDataIdentifierIds() [1/2]

void Aws::Macie2::Model::DescribeClassificationJobResult::SetCustomDataIdentifierIds ( Aws::Vector< Aws::String > &&  value)
inline

The custom data identifiers that the job uses to analyze data.

Definition at line 133 of file DescribeClassificationJobResult.h.

◆ SetCustomDataIdentifierIds() [2/2]

void Aws::Macie2::Model::DescribeClassificationJobResult::SetCustomDataIdentifierIds ( const Aws::Vector< Aws::String > &  value)
inline

The custom data identifiers that the job uses to analyze data.

Definition at line 128 of file DescribeClassificationJobResult.h.

◆ SetDescription() [1/3]

void Aws::Macie2::Model::DescribeClassificationJobResult::SetDescription ( Aws::String &&  value)
inline

The custom description of the job.

Definition at line 174 of file DescribeClassificationJobResult.h.

◆ SetDescription() [2/3]

void Aws::Macie2::Model::DescribeClassificationJobResult::SetDescription ( const Aws::String value)
inline

The custom description of the job.

Definition at line 169 of file DescribeClassificationJobResult.h.

◆ SetDescription() [3/3]

void Aws::Macie2::Model::DescribeClassificationJobResult::SetDescription ( const char *  value)
inline

The custom description of the job.

Definition at line 179 of file DescribeClassificationJobResult.h.

◆ SetInitialRun()

void Aws::Macie2::Model::DescribeClassificationJobResult::SetInitialRun ( bool  value)
inline

Specifies whether the job is configured to analyze all existing, eligible objects immediately after it's created.

Definition at line 207 of file DescribeClassificationJobResult.h.

◆ SetJobArn() [1/3]

void Aws::Macie2::Model::DescribeClassificationJobResult::SetJobArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the job.

Definition at line 229 of file DescribeClassificationJobResult.h.

◆ SetJobArn() [2/3]

void Aws::Macie2::Model::DescribeClassificationJobResult::SetJobArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the job.

Definition at line 224 of file DescribeClassificationJobResult.h.

◆ SetJobArn() [3/3]

void Aws::Macie2::Model::DescribeClassificationJobResult::SetJobArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the job.

Definition at line 234 of file DescribeClassificationJobResult.h.

◆ SetJobId() [1/3]

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

The unique identifier for the job.

Definition at line 265 of file DescribeClassificationJobResult.h.

◆ SetJobId() [2/3]

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

The unique identifier for the job.

Definition at line 260 of file DescribeClassificationJobResult.h.

◆ SetJobId() [3/3]

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

The unique identifier for the job.

Definition at line 270 of file DescribeClassificationJobResult.h.

◆ SetJobStatus() [1/2]

void Aws::Macie2::Model::DescribeClassificationJobResult::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 326 of file DescribeClassificationJobResult.h.

◆ SetJobStatus() [2/2]

void Aws::Macie2::Model::DescribeClassificationJobResult::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 346 of file DescribeClassificationJobResult.h.

◆ SetJobType() [1/2]

void Aws::Macie2::Model::DescribeClassificationJobResult::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. The scheduleFrequency property indicates the recurrence pattern for the job.

Definition at line 403 of file DescribeClassificationJobResult.h.

◆ SetJobType() [2/2]

void Aws::Macie2::Model::DescribeClassificationJobResult::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. The scheduleFrequency property indicates the recurrence pattern for the job.

Definition at line 411 of file DescribeClassificationJobResult.h.

◆ SetLastRunErrorStatus() [1/2]

void Aws::Macie2::Model::DescribeClassificationJobResult::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 442 of file DescribeClassificationJobResult.h.

◆ SetLastRunErrorStatus() [2/2]

void Aws::Macie2::Model::DescribeClassificationJobResult::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 449 of file DescribeClassificationJobResult.h.

◆ SetLastRunTime() [1/2]

void Aws::Macie2::Model::DescribeClassificationJobResult::SetLastRunTime ( Aws::Utils::DateTime &&  value)
inline

The date and time, in UTC and extended ISO 8601 format, when the job started. If the job is a recurring job, this value indicates when the most recent run started.

Definition at line 485 of file DescribeClassificationJobResult.h.

◆ SetLastRunTime() [2/2]

void Aws::Macie2::Model::DescribeClassificationJobResult::SetLastRunTime ( const Aws::Utils::DateTime value)
inline

The date and time, in UTC and extended ISO 8601 format, when the job started. If the job is a recurring job, this value indicates when the most recent run started.

Definition at line 478 of file DescribeClassificationJobResult.h.

◆ SetName() [1/3]

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

The custom name of the job.

Definition at line 515 of file DescribeClassificationJobResult.h.

◆ SetName() [2/3]

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

The custom name of the job.

Definition at line 510 of file DescribeClassificationJobResult.h.

◆ SetName() [3/3]

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

The custom name of the job.

Definition at line 520 of file DescribeClassificationJobResult.h.

◆ SetS3JobDefinition() [1/2]

void Aws::Macie2::Model::DescribeClassificationJobResult::SetS3JobDefinition ( const S3JobDefinition value)
inline

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

Definition at line 548 of file DescribeClassificationJobResult.h.

◆ SetS3JobDefinition() [2/2]

void Aws::Macie2::Model::DescribeClassificationJobResult::SetS3JobDefinition ( S3JobDefinition &&  value)
inline

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

Definition at line 554 of file DescribeClassificationJobResult.h.

◆ SetSamplingPercentage()

void Aws::Macie2::Model::DescribeClassificationJobResult::SetSamplingPercentage ( int  value)
inline

The sampling depth, as a percentage, that determines the percentage of eligible objects that the job analyzes.

Definition at line 579 of file DescribeClassificationJobResult.h.

◆ SetScheduleFrequency() [1/2]

void Aws::Macie2::Model::DescribeClassificationJobResult::SetScheduleFrequency ( const JobScheduleFrequency value)
inline

The recurrence pattern for running the job. If the job is configured to run only once, this value is null.

Definition at line 598 of file DescribeClassificationJobResult.h.

◆ SetScheduleFrequency() [2/2]

void Aws::Macie2::Model::DescribeClassificationJobResult::SetScheduleFrequency ( JobScheduleFrequency &&  value)
inline

The recurrence pattern for running the job. If the job is configured to run only once, this value is null.

Definition at line 604 of file DescribeClassificationJobResult.h.

◆ SetStatistics() [1/2]

void Aws::Macie2::Model::DescribeClassificationJobResult::SetStatistics ( const Statistics value)
inline

The number of times that the job has run and processing statistics for the job's current run.

Definition at line 629 of file DescribeClassificationJobResult.h.

◆ SetStatistics() [2/2]

void Aws::Macie2::Model::DescribeClassificationJobResult::SetStatistics ( Statistics &&  value)
inline

The number of times that the job has run and processing statistics for the job's current run.

Definition at line 635 of file DescribeClassificationJobResult.h.

◆ SetTags() [1/2]

void Aws::Macie2::Model::DescribeClassificationJobResult::SetTags ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

A map of key-value pairs that specifies which tags (keys and values) are associated with the classification job.

Definition at line 666 of file DescribeClassificationJobResult.h.

◆ SetTags() [2/2]

void Aws::Macie2::Model::DescribeClassificationJobResult::SetTags ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

A map of key-value pairs that specifies which tags (keys and values) are associated with the classification job.

Definition at line 660 of file DescribeClassificationJobResult.h.

◆ SetUserPausedDetails() [1/2]

void Aws::Macie2::Model::DescribeClassificationJobResult::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 737 of file DescribeClassificationJobResult.h.

◆ SetUserPausedDetails() [2/2]

void Aws::Macie2::Model::DescribeClassificationJobResult::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 745 of file DescribeClassificationJobResult.h.

◆ WithClientToken() [1/3]

DescribeClassificationJobResult& Aws::Macie2::Model::DescribeClassificationJobResult::WithClientToken ( Aws::String &&  value)
inline

The token that was provided to ensure the idempotency of the request to create the job.

Definition at line 80 of file DescribeClassificationJobResult.h.

◆ WithClientToken() [2/3]

DescribeClassificationJobResult& Aws::Macie2::Model::DescribeClassificationJobResult::WithClientToken ( const Aws::String value)
inline

The token that was provided to ensure the idempotency of the request to create the job.

Definition at line 74 of file DescribeClassificationJobResult.h.

◆ WithClientToken() [3/3]

DescribeClassificationJobResult& Aws::Macie2::Model::DescribeClassificationJobResult::WithClientToken ( const char *  value)
inline

The token that was provided to ensure the idempotency of the request to create the job.

Definition at line 86 of file DescribeClassificationJobResult.h.

◆ WithCreatedAt() [1/2]

DescribeClassificationJobResult& Aws::Macie2::Model::DescribeClassificationJobResult::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 117 of file DescribeClassificationJobResult.h.

◆ WithCreatedAt() [2/2]

DescribeClassificationJobResult& Aws::Macie2::Model::DescribeClassificationJobResult::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 111 of file DescribeClassificationJobResult.h.

◆ WithCustomDataIdentifierIds() [1/2]

DescribeClassificationJobResult& Aws::Macie2::Model::DescribeClassificationJobResult::WithCustomDataIdentifierIds ( Aws::Vector< Aws::String > &&  value)
inline

The custom data identifiers that the job uses to analyze data.

Definition at line 143 of file DescribeClassificationJobResult.h.

◆ WithCustomDataIdentifierIds() [2/2]

DescribeClassificationJobResult& Aws::Macie2::Model::DescribeClassificationJobResult::WithCustomDataIdentifierIds ( const Aws::Vector< Aws::String > &  value)
inline

The custom data identifiers that the job uses to analyze data.

Definition at line 138 of file DescribeClassificationJobResult.h.

◆ WithDescription() [1/3]

DescribeClassificationJobResult& Aws::Macie2::Model::DescribeClassificationJobResult::WithDescription ( Aws::String &&  value)
inline

The custom description of the job.

Definition at line 189 of file DescribeClassificationJobResult.h.

◆ WithDescription() [2/3]

DescribeClassificationJobResult& Aws::Macie2::Model::DescribeClassificationJobResult::WithDescription ( const Aws::String value)
inline

The custom description of the job.

Definition at line 184 of file DescribeClassificationJobResult.h.

◆ WithDescription() [3/3]

DescribeClassificationJobResult& Aws::Macie2::Model::DescribeClassificationJobResult::WithDescription ( const char *  value)
inline

The custom description of the job.

Definition at line 194 of file DescribeClassificationJobResult.h.

◆ WithInitialRun()

DescribeClassificationJobResult& Aws::Macie2::Model::DescribeClassificationJobResult::WithInitialRun ( bool  value)
inline

Specifies whether the job is configured to analyze all existing, eligible objects immediately after it's created.

Definition at line 213 of file DescribeClassificationJobResult.h.

◆ WithJobArn() [1/3]

DescribeClassificationJobResult& Aws::Macie2::Model::DescribeClassificationJobResult::WithJobArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the job.

Definition at line 244 of file DescribeClassificationJobResult.h.

◆ WithJobArn() [2/3]

DescribeClassificationJobResult& Aws::Macie2::Model::DescribeClassificationJobResult::WithJobArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the job.

Definition at line 239 of file DescribeClassificationJobResult.h.

◆ WithJobArn() [3/3]

DescribeClassificationJobResult& Aws::Macie2::Model::DescribeClassificationJobResult::WithJobArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the job.

Definition at line 249 of file DescribeClassificationJobResult.h.

◆ WithJobId() [1/3]

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

The unique identifier for the job.

Definition at line 280 of file DescribeClassificationJobResult.h.

◆ WithJobId() [2/3]

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

The unique identifier for the job.

Definition at line 275 of file DescribeClassificationJobResult.h.

◆ WithJobId() [3/3]

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

The unique identifier for the job.

Definition at line 285 of file DescribeClassificationJobResult.h.

◆ WithJobStatus() [1/2]

DescribeClassificationJobResult& Aws::Macie2::Model::DescribeClassificationJobResult::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 366 of file DescribeClassificationJobResult.h.

◆ WithJobStatus() [2/2]

DescribeClassificationJobResult& Aws::Macie2::Model::DescribeClassificationJobResult::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 386 of file DescribeClassificationJobResult.h.

◆ WithJobType() [1/2]

DescribeClassificationJobResult& Aws::Macie2::Model::DescribeClassificationJobResult::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. The scheduleFrequency property indicates the recurrence pattern for the job.

Definition at line 419 of file DescribeClassificationJobResult.h.

◆ WithJobType() [2/2]

DescribeClassificationJobResult& Aws::Macie2::Model::DescribeClassificationJobResult::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. The scheduleFrequency property indicates the recurrence pattern for the job.

Definition at line 427 of file DescribeClassificationJobResult.h.

◆ WithLastRunErrorStatus() [1/2]

DescribeClassificationJobResult& Aws::Macie2::Model::DescribeClassificationJobResult::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 456 of file DescribeClassificationJobResult.h.

◆ WithLastRunErrorStatus() [2/2]

DescribeClassificationJobResult& Aws::Macie2::Model::DescribeClassificationJobResult::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 463 of file DescribeClassificationJobResult.h.

◆ WithLastRunTime() [1/2]

DescribeClassificationJobResult& Aws::Macie2::Model::DescribeClassificationJobResult::WithLastRunTime ( Aws::Utils::DateTime &&  value)
inline

The date and time, in UTC and extended ISO 8601 format, when the job started. If the job is a recurring job, this value indicates when the most recent run started.

Definition at line 499 of file DescribeClassificationJobResult.h.

◆ WithLastRunTime() [2/2]

DescribeClassificationJobResult& Aws::Macie2::Model::DescribeClassificationJobResult::WithLastRunTime ( const Aws::Utils::DateTime value)
inline

The date and time, in UTC and extended ISO 8601 format, when the job started. If the job is a recurring job, this value indicates when the most recent run started.

Definition at line 492 of file DescribeClassificationJobResult.h.

◆ WithName() [1/3]

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

The custom name of the job.

Definition at line 530 of file DescribeClassificationJobResult.h.

◆ WithName() [2/3]

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

The custom name of the job.

Definition at line 525 of file DescribeClassificationJobResult.h.

◆ WithName() [3/3]

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

The custom name of the job.

Definition at line 535 of file DescribeClassificationJobResult.h.

◆ WithS3JobDefinition() [1/2]

DescribeClassificationJobResult& Aws::Macie2::Model::DescribeClassificationJobResult::WithS3JobDefinition ( const S3JobDefinition value)
inline

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

Definition at line 560 of file DescribeClassificationJobResult.h.

◆ WithS3JobDefinition() [2/2]

DescribeClassificationJobResult& Aws::Macie2::Model::DescribeClassificationJobResult::WithS3JobDefinition ( S3JobDefinition &&  value)
inline

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

Definition at line 566 of file DescribeClassificationJobResult.h.

◆ WithSamplingPercentage()

DescribeClassificationJobResult& Aws::Macie2::Model::DescribeClassificationJobResult::WithSamplingPercentage ( int  value)
inline

The sampling depth, as a percentage, that determines the percentage of eligible objects that the job analyzes.

Definition at line 585 of file DescribeClassificationJobResult.h.

◆ WithScheduleFrequency() [1/2]

DescribeClassificationJobResult& Aws::Macie2::Model::DescribeClassificationJobResult::WithScheduleFrequency ( const JobScheduleFrequency value)
inline

The recurrence pattern for running the job. If the job is configured to run only once, this value is null.

Definition at line 610 of file DescribeClassificationJobResult.h.

◆ WithScheduleFrequency() [2/2]

DescribeClassificationJobResult& Aws::Macie2::Model::DescribeClassificationJobResult::WithScheduleFrequency ( JobScheduleFrequency &&  value)
inline

The recurrence pattern for running the job. If the job is configured to run only once, this value is null.

Definition at line 616 of file DescribeClassificationJobResult.h.

◆ WithStatistics() [1/2]

DescribeClassificationJobResult& Aws::Macie2::Model::DescribeClassificationJobResult::WithStatistics ( const Statistics value)
inline

The number of times that the job has run and processing statistics for the job's current run.

Definition at line 641 of file DescribeClassificationJobResult.h.

◆ WithStatistics() [2/2]

DescribeClassificationJobResult& Aws::Macie2::Model::DescribeClassificationJobResult::WithStatistics ( Statistics &&  value)
inline

The number of times that the job has run and processing statistics for the job's current run.

Definition at line 647 of file DescribeClassificationJobResult.h.

◆ WithTags() [1/2]

DescribeClassificationJobResult& Aws::Macie2::Model::DescribeClassificationJobResult::WithTags ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

A map of key-value pairs that specifies which tags (keys and values) are associated with the classification job.

Definition at line 678 of file DescribeClassificationJobResult.h.

◆ WithTags() [2/2]

DescribeClassificationJobResult& Aws::Macie2::Model::DescribeClassificationJobResult::WithTags ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

A map of key-value pairs that specifies which tags (keys and values) are associated with the classification job.

Definition at line 672 of file DescribeClassificationJobResult.h.

◆ WithUserPausedDetails() [1/2]

DescribeClassificationJobResult& Aws::Macie2::Model::DescribeClassificationJobResult::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 753 of file DescribeClassificationJobResult.h.

◆ WithUserPausedDetails() [2/2]

DescribeClassificationJobResult& Aws::Macie2::Model::DescribeClassificationJobResult::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 761 of file DescribeClassificationJobResult.h.


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