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

#include <CreateClassificationJobRequest.h>

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

Public Member Functions

 CreateClassificationJobRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetClientToken () const
 
bool ClientTokenHasBeenSet () const
 
void SetClientToken (const Aws::String &value)
 
void SetClientToken (Aws::String &&value)
 
void SetClientToken (const char *value)
 
CreateClassificationJobRequestWithClientToken (const Aws::String &value)
 
CreateClassificationJobRequestWithClientToken (Aws::String &&value)
 
CreateClassificationJobRequestWithClientToken (const char *value)
 
const Aws::Vector< Aws::String > & GetCustomDataIdentifierIds () const
 
bool CustomDataIdentifierIdsHasBeenSet () const
 
void SetCustomDataIdentifierIds (const Aws::Vector< Aws::String > &value)
 
void SetCustomDataIdentifierIds (Aws::Vector< Aws::String > &&value)
 
CreateClassificationJobRequestWithCustomDataIdentifierIds (const Aws::Vector< Aws::String > &value)
 
CreateClassificationJobRequestWithCustomDataIdentifierIds (Aws::Vector< Aws::String > &&value)
 
CreateClassificationJobRequestAddCustomDataIdentifierIds (const Aws::String &value)
 
CreateClassificationJobRequestAddCustomDataIdentifierIds (Aws::String &&value)
 
CreateClassificationJobRequestAddCustomDataIdentifierIds (const char *value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
CreateClassificationJobRequestWithDescription (const Aws::String &value)
 
CreateClassificationJobRequestWithDescription (Aws::String &&value)
 
CreateClassificationJobRequestWithDescription (const char *value)
 
bool GetInitialRun () const
 
bool InitialRunHasBeenSet () const
 
void SetInitialRun (bool value)
 
CreateClassificationJobRequestWithInitialRun (bool value)
 
const JobTypeGetJobType () const
 
bool JobTypeHasBeenSet () const
 
void SetJobType (const JobType &value)
 
void SetJobType (JobType &&value)
 
CreateClassificationJobRequestWithJobType (const JobType &value)
 
CreateClassificationJobRequestWithJobType (JobType &&value)
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
CreateClassificationJobRequestWithName (const Aws::String &value)
 
CreateClassificationJobRequestWithName (Aws::String &&value)
 
CreateClassificationJobRequestWithName (const char *value)
 
const S3JobDefinitionGetS3JobDefinition () const
 
bool S3JobDefinitionHasBeenSet () const
 
void SetS3JobDefinition (const S3JobDefinition &value)
 
void SetS3JobDefinition (S3JobDefinition &&value)
 
CreateClassificationJobRequestWithS3JobDefinition (const S3JobDefinition &value)
 
CreateClassificationJobRequestWithS3JobDefinition (S3JobDefinition &&value)
 
int GetSamplingPercentage () const
 
bool SamplingPercentageHasBeenSet () const
 
void SetSamplingPercentage (int value)
 
CreateClassificationJobRequestWithSamplingPercentage (int value)
 
const JobScheduleFrequencyGetScheduleFrequency () const
 
bool ScheduleFrequencyHasBeenSet () const
 
void SetScheduleFrequency (const JobScheduleFrequency &value)
 
void SetScheduleFrequency (JobScheduleFrequency &&value)
 
CreateClassificationJobRequestWithScheduleFrequency (const JobScheduleFrequency &value)
 
CreateClassificationJobRequestWithScheduleFrequency (JobScheduleFrequency &&value)
 
const Aws::Map< Aws::String, Aws::String > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetTags (Aws::Map< Aws::String, Aws::String > &&value)
 
CreateClassificationJobRequestWithTags (const Aws::Map< Aws::String, Aws::String > &value)
 
CreateClassificationJobRequestWithTags (Aws::Map< Aws::String, Aws::String > &&value)
 
CreateClassificationJobRequestAddTags (const Aws::String &key, const Aws::String &value)
 
CreateClassificationJobRequestAddTags (Aws::String &&key, const Aws::String &value)
 
CreateClassificationJobRequestAddTags (const Aws::String &key, Aws::String &&value)
 
CreateClassificationJobRequestAddTags (Aws::String &&key, Aws::String &&value)
 
CreateClassificationJobRequestAddTags (const char *key, Aws::String &&value)
 
CreateClassificationJobRequestAddTags (Aws::String &&key, const char *value)
 
CreateClassificationJobRequestAddTags (const char *key, const char *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 27 of file CreateClassificationJobRequest.h.

Constructor & Destructor Documentation

◆ CreateClassificationJobRequest()

Aws::Macie2::Model::CreateClassificationJobRequest::CreateClassificationJobRequest ( )

Member Function Documentation

◆ AddCustomDataIdentifierIds() [1/3]

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

The custom data identifiers to use for data analysis and classification.

Definition at line 123 of file CreateClassificationJobRequest.h.

◆ AddCustomDataIdentifierIds() [2/3]

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

The custom data identifiers to use for data analysis and classification.

Definition at line 128 of file CreateClassificationJobRequest.h.

◆ AddCustomDataIdentifierIds() [3/3]

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

The custom data identifiers to use for data analysis and classification.

Definition at line 133 of file CreateClassificationJobRequest.h.

◆ AddTags() [1/7]

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

A map of key-value pairs that specifies the tags to associate with the job.

A job can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

Definition at line 485 of file CreateClassificationJobRequest.h.

◆ AddTags() [2/7]

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

A map of key-value pairs that specifies the tags to associate with the job.

A job can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

Definition at line 493 of file CreateClassificationJobRequest.h.

◆ AddTags() [3/7]

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

A map of key-value pairs that specifies the tags to associate with the job.

A job can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

Definition at line 501 of file CreateClassificationJobRequest.h.

◆ AddTags() [4/7]

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

A map of key-value pairs that specifies the tags to associate with the job.

A job can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

Definition at line 509 of file CreateClassificationJobRequest.h.

◆ AddTags() [5/7]

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

A map of key-value pairs that specifies the tags to associate with the job.

A job can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

Definition at line 517 of file CreateClassificationJobRequest.h.

◆ AddTags() [6/7]

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

A map of key-value pairs that specifies the tags to associate with the job.

A job can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

Definition at line 525 of file CreateClassificationJobRequest.h.

◆ AddTags() [7/7]

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

A map of key-value pairs that specifies the tags to associate with the job.

A job can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

Definition at line 533 of file CreateClassificationJobRequest.h.

◆ ClientTokenHasBeenSet()

bool Aws::Macie2::Model::CreateClassificationJobRequest::ClientTokenHasBeenSet ( ) const
inline

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

Definition at line 51 of file CreateClassificationJobRequest.h.

◆ CustomDataIdentifierIdsHasBeenSet()

bool Aws::Macie2::Model::CreateClassificationJobRequest::CustomDataIdentifierIdsHasBeenSet ( ) const
inline

The custom data identifiers to use for data analysis and classification.

Definition at line 98 of file CreateClassificationJobRequest.h.

◆ DescriptionHasBeenSet()

bool Aws::Macie2::Model::CreateClassificationJobRequest::DescriptionHasBeenSet ( ) const
inline

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

Definition at line 146 of file CreateClassificationJobRequest.h.

◆ GetClientToken()

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

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

Definition at line 45 of file CreateClassificationJobRequest.h.

◆ GetCustomDataIdentifierIds()

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

The custom data identifiers to use for data analysis and classification.

Definition at line 93 of file CreateClassificationJobRequest.h.

◆ GetDescription()

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

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

Definition at line 140 of file CreateClassificationJobRequest.h.

◆ GetInitialRun()

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

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

Definition at line 189 of file CreateClassificationJobRequest.h.

◆ GetJobType()

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

The schedule for running the job. Valid values are:

  • ONE_TIME - Run the job only once. If you specify this value, don't specify a value for the scheduleFrequency property.

  • SCHEDULED - Run the job on a daily, weekly, or monthly basis. If you specify this value, use the scheduleFrequency property to define the recurrence pattern for the job.

Definition at line 217 of file CreateClassificationJobRequest.h.

◆ GetName()

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

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

Definition at line 269 of file CreateClassificationJobRequest.h.

◆ GetS3JobDefinition()

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

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

Definition at line 318 of file CreateClassificationJobRequest.h.

◆ GetSamplingPercentage()

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

The sampling depth, as a percentage, to apply when processing objects. This value determines the percentage of eligible objects that the job analyzes. If this value is less than 100, Amazon Macie selects the objects to analyze at random, up to the specified percentage, and analyzes all the data in those objects.

Definition at line 358 of file CreateClassificationJobRequest.h.

◆ GetScheduleFrequency()

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

The recurrence pattern for running the job. To run the job only once, don't specify a value for this property and set the value of the jobType property to ONE_TIME.

Definition at line 393 of file CreateClassificationJobRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 36 of file CreateClassificationJobRequest.h.

◆ GetTags()

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

A map of key-value pairs that specifies the tags to associate with the job.

A job can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

Definition at line 437 of file CreateClassificationJobRequest.h.

◆ InitialRunHasBeenSet()

bool Aws::Macie2::Model::CreateClassificationJobRequest::InitialRunHasBeenSet ( ) const
inline

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

Definition at line 195 of file CreateClassificationJobRequest.h.

◆ JobTypeHasBeenSet()

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

The schedule for running the job. Valid values are:

  • ONE_TIME - Run the job only once. If you specify this value, don't specify a value for the scheduleFrequency property.

  • SCHEDULED - Run the job on a daily, weekly, or monthly basis. If you specify this value, use the scheduleFrequency property to define the recurrence pattern for the job.

Definition at line 226 of file CreateClassificationJobRequest.h.

◆ NameHasBeenSet()

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

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

Definition at line 275 of file CreateClassificationJobRequest.h.

◆ S3JobDefinitionHasBeenSet()

bool Aws::Macie2::Model::CreateClassificationJobRequest::S3JobDefinitionHasBeenSet ( ) const
inline

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

Definition at line 324 of file CreateClassificationJobRequest.h.

◆ SamplingPercentageHasBeenSet()

bool Aws::Macie2::Model::CreateClassificationJobRequest::SamplingPercentageHasBeenSet ( ) const
inline

The sampling depth, as a percentage, to apply when processing objects. This value determines the percentage of eligible objects that the job analyzes. If this value is less than 100, Amazon Macie selects the objects to analyze at random, up to the specified percentage, and analyzes all the data in those objects.

Definition at line 367 of file CreateClassificationJobRequest.h.

◆ ScheduleFrequencyHasBeenSet()

bool Aws::Macie2::Model::CreateClassificationJobRequest::ScheduleFrequencyHasBeenSet ( ) const
inline

The recurrence pattern for running the job. To run the job only once, don't specify a value for this property and set the value of the jobType property to ONE_TIME.

Definition at line 400 of file CreateClassificationJobRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetClientToken() [1/3]

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

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

Definition at line 57 of file CreateClassificationJobRequest.h.

◆ SetClientToken() [2/3]

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

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

Definition at line 63 of file CreateClassificationJobRequest.h.

◆ SetClientToken() [3/3]

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

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

Definition at line 69 of file CreateClassificationJobRequest.h.

◆ SetCustomDataIdentifierIds() [1/2]

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

The custom data identifiers to use for data analysis and classification.

Definition at line 103 of file CreateClassificationJobRequest.h.

◆ SetCustomDataIdentifierIds() [2/2]

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

The custom data identifiers to use for data analysis and classification.

Definition at line 108 of file CreateClassificationJobRequest.h.

◆ SetDescription() [1/3]

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

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

Definition at line 152 of file CreateClassificationJobRequest.h.

◆ SetDescription() [2/3]

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

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

Definition at line 158 of file CreateClassificationJobRequest.h.

◆ SetDescription() [3/3]

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

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

Definition at line 164 of file CreateClassificationJobRequest.h.

◆ SetInitialRun()

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

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

Definition at line 201 of file CreateClassificationJobRequest.h.

◆ SetJobType() [1/2]

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

The schedule for running the job. Valid values are:

  • ONE_TIME - Run the job only once. If you specify this value, don't specify a value for the scheduleFrequency property.

  • SCHEDULED - Run the job on a daily, weekly, or monthly basis. If you specify this value, use the scheduleFrequency property to define the recurrence pattern for the job.

Definition at line 235 of file CreateClassificationJobRequest.h.

◆ SetJobType() [2/2]

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

The schedule for running the job. Valid values are:

  • ONE_TIME - Run the job only once. If you specify this value, don't specify a value for the scheduleFrequency property.

  • SCHEDULED - Run the job on a daily, weekly, or monthly basis. If you specify this value, use the scheduleFrequency property to define the recurrence pattern for the job.

Definition at line 244 of file CreateClassificationJobRequest.h.

◆ SetName() [1/3]

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

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

Definition at line 281 of file CreateClassificationJobRequest.h.

◆ SetName() [2/3]

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

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

Definition at line 287 of file CreateClassificationJobRequest.h.

◆ SetName() [3/3]

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

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

Definition at line 293 of file CreateClassificationJobRequest.h.

◆ SetS3JobDefinition() [1/2]

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

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

Definition at line 330 of file CreateClassificationJobRequest.h.

◆ SetS3JobDefinition() [2/2]

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

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

Definition at line 336 of file CreateClassificationJobRequest.h.

◆ SetSamplingPercentage()

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

The sampling depth, as a percentage, to apply when processing objects. This value determines the percentage of eligible objects that the job analyzes. If this value is less than 100, Amazon Macie selects the objects to analyze at random, up to the specified percentage, and analyzes all the data in those objects.

Definition at line 376 of file CreateClassificationJobRequest.h.

◆ SetScheduleFrequency() [1/2]

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

The recurrence pattern for running the job. To run the job only once, don't specify a value for this property and set the value of the jobType property to ONE_TIME.

Definition at line 407 of file CreateClassificationJobRequest.h.

◆ SetScheduleFrequency() [2/2]

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

The recurrence pattern for running the job. To run the job only once, don't specify a value for this property and set the value of the jobType property to ONE_TIME.

Definition at line 414 of file CreateClassificationJobRequest.h.

◆ SetTags() [1/2]

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

A map of key-value pairs that specifies the tags to associate with the job.

A job can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

Definition at line 453 of file CreateClassificationJobRequest.h.

◆ SetTags() [2/2]

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

A map of key-value pairs that specifies the tags to associate with the job.

A job can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

Definition at line 461 of file CreateClassificationJobRequest.h.

◆ TagsHasBeenSet()

bool Aws::Macie2::Model::CreateClassificationJobRequest::TagsHasBeenSet ( ) const
inline

A map of key-value pairs that specifies the tags to associate with the job.

A job can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

Definition at line 445 of file CreateClassificationJobRequest.h.

◆ WithClientToken() [1/3]

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

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

Definition at line 75 of file CreateClassificationJobRequest.h.

◆ WithClientToken() [2/3]

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

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

Definition at line 81 of file CreateClassificationJobRequest.h.

◆ WithClientToken() [3/3]

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

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

Definition at line 87 of file CreateClassificationJobRequest.h.

◆ WithCustomDataIdentifierIds() [1/2]

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

The custom data identifiers to use for data analysis and classification.

Definition at line 113 of file CreateClassificationJobRequest.h.

◆ WithCustomDataIdentifierIds() [2/2]

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

The custom data identifiers to use for data analysis and classification.

Definition at line 118 of file CreateClassificationJobRequest.h.

◆ WithDescription() [1/3]

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

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

Definition at line 170 of file CreateClassificationJobRequest.h.

◆ WithDescription() [2/3]

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

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

Definition at line 176 of file CreateClassificationJobRequest.h.

◆ WithDescription() [3/3]

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

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

Definition at line 182 of file CreateClassificationJobRequest.h.

◆ WithInitialRun()

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

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

Definition at line 207 of file CreateClassificationJobRequest.h.

◆ WithJobType() [1/2]

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

The schedule for running the job. Valid values are:

  • ONE_TIME - Run the job only once. If you specify this value, don't specify a value for the scheduleFrequency property.

  • SCHEDULED - Run the job on a daily, weekly, or monthly basis. If you specify this value, use the scheduleFrequency property to define the recurrence pattern for the job.

Definition at line 253 of file CreateClassificationJobRequest.h.

◆ WithJobType() [2/2]

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

The schedule for running the job. Valid values are:

  • ONE_TIME - Run the job only once. If you specify this value, don't specify a value for the scheduleFrequency property.

  • SCHEDULED - Run the job on a daily, weekly, or monthly basis. If you specify this value, use the scheduleFrequency property to define the recurrence pattern for the job.

Definition at line 262 of file CreateClassificationJobRequest.h.

◆ WithName() [1/3]

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

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

Definition at line 299 of file CreateClassificationJobRequest.h.

◆ WithName() [2/3]

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

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

Definition at line 305 of file CreateClassificationJobRequest.h.

◆ WithName() [3/3]

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

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

Definition at line 311 of file CreateClassificationJobRequest.h.

◆ WithS3JobDefinition() [1/2]

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

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

Definition at line 342 of file CreateClassificationJobRequest.h.

◆ WithS3JobDefinition() [2/2]

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

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

Definition at line 348 of file CreateClassificationJobRequest.h.

◆ WithSamplingPercentage()

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

The sampling depth, as a percentage, to apply when processing objects. This value determines the percentage of eligible objects that the job analyzes. If this value is less than 100, Amazon Macie selects the objects to analyze at random, up to the specified percentage, and analyzes all the data in those objects.

Definition at line 385 of file CreateClassificationJobRequest.h.

◆ WithScheduleFrequency() [1/2]

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

The recurrence pattern for running the job. To run the job only once, don't specify a value for this property and set the value of the jobType property to ONE_TIME.

Definition at line 421 of file CreateClassificationJobRequest.h.

◆ WithScheduleFrequency() [2/2]

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

The recurrence pattern for running the job. To run the job only once, don't specify a value for this property and set the value of the jobType property to ONE_TIME.

Definition at line 428 of file CreateClassificationJobRequest.h.

◆ WithTags() [1/2]

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

A map of key-value pairs that specifies the tags to associate with the job.

A job can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

Definition at line 469 of file CreateClassificationJobRequest.h.

◆ WithTags() [2/2]

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

A map of key-value pairs that specifies the tags to associate with the job.

A job can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

Definition at line 477 of file CreateClassificationJobRequest.h.


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