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

#include <UpdateClassificationJobRequest.h>

+ Inheritance diagram for Aws::Macie2::Model::UpdateClassificationJobRequest:

Public Member Functions

 UpdateClassificationJobRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetJobId () const
 
bool JobIdHasBeenSet () const
 
void SetJobId (const Aws::String &value)
 
void SetJobId (Aws::String &&value)
 
void SetJobId (const char *value)
 
UpdateClassificationJobRequestWithJobId (const Aws::String &value)
 
UpdateClassificationJobRequestWithJobId (Aws::String &&value)
 
UpdateClassificationJobRequestWithJobId (const char *value)
 
const JobStatusGetJobStatus () const
 
bool JobStatusHasBeenSet () const
 
void SetJobStatus (const JobStatus &value)
 
void SetJobStatus (JobStatus &&value)
 
UpdateClassificationJobRequestWithJobStatus (const JobStatus &value)
 
UpdateClassificationJobRequestWithJobStatus (JobStatus &&value)
 
- Public Member Functions inherited from Aws::Macie2::Macie2Request
virtual ~Macie2Request ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::Macie2::Macie2Request
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 
- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 22 of file UpdateClassificationJobRequest.h.

Constructor & Destructor Documentation

◆ UpdateClassificationJobRequest()

Aws::Macie2::Model::UpdateClassificationJobRequest::UpdateClassificationJobRequest ( )

Member Function Documentation

◆ GetJobId()

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

The unique identifier for the classification job.

Definition at line 39 of file UpdateClassificationJobRequest.h.

◆ GetJobStatus()

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

The new status for the job. Valid values are:

  • CANCELLED - Stops the job permanently and cancels it. This value is valid only if the job's current status is IDLE, PAUSED, RUNNING, or USER_PAUSED.

    If you specify this value and the job's current status is RUNNING, Amazon Macie immediately begins to stop all processing tasks for the job. You can't resume or restart a job after you cancel it.

  • RUNNING - Resumes the job. This value is valid only if the job's current status is USER_PAUSED.

    If you paused the job while it was actively running and you specify this value less than 30 days after you paused the job, Macie immediately resumes processing from the point where you paused the job. Otherwise, Macie resumes the job according to the schedule and other settings for the job.

  • USER_PAUSED - Pauses the job temporarily. This value is valid only if the job's current status is IDLE, PAUSED, or RUNNING. If you specify this value and the job's current status is RUNNING, Macie immediately begins to pause all processing tasks for the job.

    If you pause a one-time job and you don't resume it within 30 days, the job expires and Macie cancels the job. If you pause a recurring job when its status is RUNNING and you don't resume it within 30 days, the job run expires and Macie cancels the run. To check the expiration date, refer to the UserPausedDetails.jobExpiresAt property.

Definition at line 98 of file UpdateClassificationJobRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::Macie2::Model::UpdateClassificationJobRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 31 of file UpdateClassificationJobRequest.h.

◆ JobIdHasBeenSet()

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

The unique identifier for the classification job.

Definition at line 44 of file UpdateClassificationJobRequest.h.

◆ JobStatusHasBeenSet()

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

The new status for the job. Valid values are:

  • CANCELLED - Stops the job permanently and cancels it. This value is valid only if the job's current status is IDLE, PAUSED, RUNNING, or USER_PAUSED.

    If you specify this value and the job's current status is RUNNING, Amazon Macie immediately begins to stop all processing tasks for the job. You can't resume or restart a job after you cancel it.

  • RUNNING - Resumes the job. This value is valid only if the job's current status is USER_PAUSED.

    If you paused the job while it was actively running and you specify this value less than 30 days after you paused the job, Macie immediately resumes processing from the point where you paused the job. Otherwise, Macie resumes the job according to the schedule and other settings for the job.

  • USER_PAUSED - Pauses the job temporarily. This value is valid only if the job's current status is IDLE, PAUSED, or RUNNING. If you specify this value and the job's current status is RUNNING, Macie immediately begins to pause all processing tasks for the job.

    If you pause a one-time job and you don't resume it within 30 days, the job expires and Macie cancels the job. If you pause a recurring job when its status is RUNNING and you don't resume it within 30 days, the job run expires and Macie cancels the run. To check the expiration date, refer to the UserPausedDetails.jobExpiresAt property.

Definition at line 121 of file UpdateClassificationJobRequest.h.

◆ SerializePayload()

Aws::String Aws::Macie2::Model::UpdateClassificationJobRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetJobId() [1/3]

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

The unique identifier for the classification job.

Definition at line 54 of file UpdateClassificationJobRequest.h.

◆ SetJobId() [2/3]

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

The unique identifier for the classification job.

Definition at line 49 of file UpdateClassificationJobRequest.h.

◆ SetJobId() [3/3]

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

The unique identifier for the classification job.

Definition at line 59 of file UpdateClassificationJobRequest.h.

◆ SetJobStatus() [1/2]

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

The new status for the job. Valid values are:

  • CANCELLED - Stops the job permanently and cancels it. This value is valid only if the job's current status is IDLE, PAUSED, RUNNING, or USER_PAUSED.

    If you specify this value and the job's current status is RUNNING, Amazon Macie immediately begins to stop all processing tasks for the job. You can't resume or restart a job after you cancel it.

  • RUNNING - Resumes the job. This value is valid only if the job's current status is USER_PAUSED.

    If you paused the job while it was actively running and you specify this value less than 30 days after you paused the job, Macie immediately resumes processing from the point where you paused the job. Otherwise, Macie resumes the job according to the schedule and other settings for the job.

  • USER_PAUSED - Pauses the job temporarily. This value is valid only if the job's current status is IDLE, PAUSED, or RUNNING. If you specify this value and the job's current status is RUNNING, Macie immediately begins to pause all processing tasks for the job.

    If you pause a one-time job and you don't resume it within 30 days, the job expires and Macie cancels the job. If you pause a recurring job when its status is RUNNING and you don't resume it within 30 days, the job run expires and Macie cancels the run. To check the expiration date, refer to the UserPausedDetails.jobExpiresAt property.

Definition at line 144 of file UpdateClassificationJobRequest.h.

◆ SetJobStatus() [2/2]

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

The new status for the job. Valid values are:

  • CANCELLED - Stops the job permanently and cancels it. This value is valid only if the job's current status is IDLE, PAUSED, RUNNING, or USER_PAUSED.

    If you specify this value and the job's current status is RUNNING, Amazon Macie immediately begins to stop all processing tasks for the job. You can't resume or restart a job after you cancel it.

  • RUNNING - Resumes the job. This value is valid only if the job's current status is USER_PAUSED.

    If you paused the job while it was actively running and you specify this value less than 30 days after you paused the job, Macie immediately resumes processing from the point where you paused the job. Otherwise, Macie resumes the job according to the schedule and other settings for the job.

  • USER_PAUSED - Pauses the job temporarily. This value is valid only if the job's current status is IDLE, PAUSED, or RUNNING. If you specify this value and the job's current status is RUNNING, Macie immediately begins to pause all processing tasks for the job.

    If you pause a one-time job and you don't resume it within 30 days, the job expires and Macie cancels the job. If you pause a recurring job when its status is RUNNING and you don't resume it within 30 days, the job run expires and Macie cancels the run. To check the expiration date, refer to the UserPausedDetails.jobExpiresAt property.

Definition at line 167 of file UpdateClassificationJobRequest.h.

◆ WithJobId() [1/3]

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

The unique identifier for the classification job.

Definition at line 69 of file UpdateClassificationJobRequest.h.

◆ WithJobId() [2/3]

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

The unique identifier for the classification job.

Definition at line 64 of file UpdateClassificationJobRequest.h.

◆ WithJobId() [3/3]

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

The unique identifier for the classification job.

Definition at line 74 of file UpdateClassificationJobRequest.h.

◆ WithJobStatus() [1/2]

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

The new status for the job. Valid values are:

  • CANCELLED - Stops the job permanently and cancels it. This value is valid only if the job's current status is IDLE, PAUSED, RUNNING, or USER_PAUSED.

    If you specify this value and the job's current status is RUNNING, Amazon Macie immediately begins to stop all processing tasks for the job. You can't resume or restart a job after you cancel it.

  • RUNNING - Resumes the job. This value is valid only if the job's current status is USER_PAUSED.

    If you paused the job while it was actively running and you specify this value less than 30 days after you paused the job, Macie immediately resumes processing from the point where you paused the job. Otherwise, Macie resumes the job according to the schedule and other settings for the job.

  • USER_PAUSED - Pauses the job temporarily. This value is valid only if the job's current status is IDLE, PAUSED, or RUNNING. If you specify this value and the job's current status is RUNNING, Macie immediately begins to pause all processing tasks for the job.

    If you pause a one-time job and you don't resume it within 30 days, the job expires and Macie cancels the job. If you pause a recurring job when its status is RUNNING and you don't resume it within 30 days, the job run expires and Macie cancels the run. To check the expiration date, refer to the UserPausedDetails.jobExpiresAt property.

Definition at line 190 of file UpdateClassificationJobRequest.h.

◆ WithJobStatus() [2/2]

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

The new status for the job. Valid values are:

  • CANCELLED - Stops the job permanently and cancels it. This value is valid only if the job's current status is IDLE, PAUSED, RUNNING, or USER_PAUSED.

    If you specify this value and the job's current status is RUNNING, Amazon Macie immediately begins to stop all processing tasks for the job. You can't resume or restart a job after you cancel it.

  • RUNNING - Resumes the job. This value is valid only if the job's current status is USER_PAUSED.

    If you paused the job while it was actively running and you specify this value less than 30 days after you paused the job, Macie immediately resumes processing from the point where you paused the job. Otherwise, Macie resumes the job according to the schedule and other settings for the job.

  • USER_PAUSED - Pauses the job temporarily. This value is valid only if the job's current status is IDLE, PAUSED, or RUNNING. If you specify this value and the job's current status is RUNNING, Macie immediately begins to pause all processing tasks for the job.

    If you pause a one-time job and you don't resume it within 30 days, the job expires and Macie cancels the job. If you pause a recurring job when its status is RUNNING and you don't resume it within 30 days, the job run expires and Macie cancels the run. To check the expiration date, refer to the UserPausedDetails.jobExpiresAt property.

Definition at line 213 of file UpdateClassificationJobRequest.h.


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