/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include #include #include #include namespace Aws { namespace Macie2 { namespace Model { /** */ class AWS_MACIE2_API CreateClassificationJobRequest : public Macie2Request { public: CreateClassificationJobRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "CreateClassificationJob"; } Aws::String SerializePayload() const override; /** *

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

*/ inline const Aws::String& GetClientToken() const{ return m_clientToken; } /** *

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

*/ inline bool ClientTokenHasBeenSet() const { return m_clientTokenHasBeenSet; } /** *

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

*/ inline void SetClientToken(const Aws::String& value) { m_clientTokenHasBeenSet = true; m_clientToken = value; } /** *

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

*/ inline void SetClientToken(Aws::String&& value) { m_clientTokenHasBeenSet = true; m_clientToken = std::move(value); } /** *

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

*/ inline void SetClientToken(const char* value) { m_clientTokenHasBeenSet = true; m_clientToken.assign(value); } /** *

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

*/ inline CreateClassificationJobRequest& WithClientToken(const Aws::String& value) { SetClientToken(value); return *this;} /** *

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

*/ inline CreateClassificationJobRequest& WithClientToken(Aws::String&& value) { SetClientToken(std::move(value)); return *this;} /** *

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

*/ inline CreateClassificationJobRequest& WithClientToken(const char* value) { SetClientToken(value); return *this;} /** *

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

*/ inline const Aws::Vector& GetCustomDataIdentifierIds() const{ return m_customDataIdentifierIds; } /** *

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

*/ inline bool CustomDataIdentifierIdsHasBeenSet() const { return m_customDataIdentifierIdsHasBeenSet; } /** *

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

*/ inline void SetCustomDataIdentifierIds(const Aws::Vector& value) { m_customDataIdentifierIdsHasBeenSet = true; m_customDataIdentifierIds = value; } /** *

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

*/ inline void SetCustomDataIdentifierIds(Aws::Vector&& value) { m_customDataIdentifierIdsHasBeenSet = true; m_customDataIdentifierIds = std::move(value); } /** *

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

*/ inline CreateClassificationJobRequest& WithCustomDataIdentifierIds(const Aws::Vector& value) { SetCustomDataIdentifierIds(value); return *this;} /** *

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

*/ inline CreateClassificationJobRequest& WithCustomDataIdentifierIds(Aws::Vector&& value) { SetCustomDataIdentifierIds(std::move(value)); return *this;} /** *

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

*/ inline CreateClassificationJobRequest& AddCustomDataIdentifierIds(const Aws::String& value) { m_customDataIdentifierIdsHasBeenSet = true; m_customDataIdentifierIds.push_back(value); return *this; } /** *

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

*/ inline CreateClassificationJobRequest& AddCustomDataIdentifierIds(Aws::String&& value) { m_customDataIdentifierIdsHasBeenSet = true; m_customDataIdentifierIds.push_back(std::move(value)); return *this; } /** *

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

*/ inline CreateClassificationJobRequest& AddCustomDataIdentifierIds(const char* value) { m_customDataIdentifierIdsHasBeenSet = true; m_customDataIdentifierIds.push_back(value); return *this; } /** *

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

*/ inline const Aws::String& GetDescription() const{ return m_description; } /** *

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

*/ inline bool DescriptionHasBeenSet() const { return m_descriptionHasBeenSet; } /** *

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

*/ inline void SetDescription(const Aws::String& value) { m_descriptionHasBeenSet = true; m_description = value; } /** *

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

*/ inline void SetDescription(Aws::String&& value) { m_descriptionHasBeenSet = true; m_description = std::move(value); } /** *

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

*/ inline void SetDescription(const char* value) { m_descriptionHasBeenSet = true; m_description.assign(value); } /** *

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

*/ inline CreateClassificationJobRequest& WithDescription(const Aws::String& value) { SetDescription(value); return *this;} /** *

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

*/ inline CreateClassificationJobRequest& WithDescription(Aws::String&& value) { SetDescription(std::move(value)); return *this;} /** *

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

*/ inline CreateClassificationJobRequest& WithDescription(const char* value) { SetDescription(value); return *this;} /** *

Specifies whether to run the job immediately, after it's created.

*/ inline bool GetInitialRun() const{ return m_initialRun; } /** *

Specifies whether to run the job immediately, after it's created.

*/ inline bool InitialRunHasBeenSet() const { return m_initialRunHasBeenSet; } /** *

Specifies whether to run the job immediately, after it's created.

*/ inline void SetInitialRun(bool value) { m_initialRunHasBeenSet = true; m_initialRun = value; } /** *

Specifies whether to run the job immediately, after it's created.

*/ inline CreateClassificationJobRequest& WithInitialRun(bool value) { SetInitialRun(value); return *this;} /** *

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.

*/ inline const JobType& GetJobType() const{ return m_jobType; } /** *

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.

*/ inline bool JobTypeHasBeenSet() const { return m_jobTypeHasBeenSet; } /** *

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.

*/ inline void SetJobType(const JobType& value) { m_jobTypeHasBeenSet = true; m_jobType = value; } /** *

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.

*/ inline void SetJobType(JobType&& value) { m_jobTypeHasBeenSet = true; m_jobType = std::move(value); } /** *

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.

*/ inline CreateClassificationJobRequest& WithJobType(const JobType& value) { SetJobType(value); return *this;} /** *

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.

*/ inline CreateClassificationJobRequest& WithJobType(JobType&& value) { SetJobType(std::move(value)); return *this;} /** *

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

*/ inline const Aws::String& GetName() const{ return m_name; } /** *

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

*/ inline bool NameHasBeenSet() const { return m_nameHasBeenSet; } /** *

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

*/ inline void SetName(const Aws::String& value) { m_nameHasBeenSet = true; m_name = value; } /** *

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

*/ inline void SetName(Aws::String&& value) { m_nameHasBeenSet = true; m_name = std::move(value); } /** *

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

*/ inline void SetName(const char* value) { m_nameHasBeenSet = true; m_name.assign(value); } /** *

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

*/ inline CreateClassificationJobRequest& WithName(const Aws::String& value) { SetName(value); return *this;} /** *

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

*/ inline CreateClassificationJobRequest& WithName(Aws::String&& value) { SetName(std::move(value)); return *this;} /** *

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

*/ inline CreateClassificationJobRequest& WithName(const char* value) { SetName(value); return *this;} /** *

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

*/ inline const S3JobDefinition& GetS3JobDefinition() const{ return m_s3JobDefinition; } /** *

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

*/ inline bool S3JobDefinitionHasBeenSet() const { return m_s3JobDefinitionHasBeenSet; } /** *

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

*/ inline void SetS3JobDefinition(const S3JobDefinition& value) { m_s3JobDefinitionHasBeenSet = true; m_s3JobDefinition = value; } /** *

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

*/ inline void SetS3JobDefinition(S3JobDefinition&& value) { m_s3JobDefinitionHasBeenSet = true; m_s3JobDefinition = std::move(value); } /** *

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

*/ inline CreateClassificationJobRequest& WithS3JobDefinition(const S3JobDefinition& value) { SetS3JobDefinition(value); return *this;} /** *

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

*/ inline CreateClassificationJobRequest& WithS3JobDefinition(S3JobDefinition&& value) { SetS3JobDefinition(std::move(value)); return *this;} /** *

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.

*/ inline int GetSamplingPercentage() const{ return m_samplingPercentage; } /** *

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.

*/ inline bool SamplingPercentageHasBeenSet() const { return m_samplingPercentageHasBeenSet; } /** *

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.

*/ inline void SetSamplingPercentage(int value) { m_samplingPercentageHasBeenSet = true; m_samplingPercentage = value; } /** *

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.

*/ inline CreateClassificationJobRequest& WithSamplingPercentage(int value) { SetSamplingPercentage(value); return *this;} /** *

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.

*/ inline const JobScheduleFrequency& GetScheduleFrequency() const{ return m_scheduleFrequency; } /** *

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.

*/ inline bool ScheduleFrequencyHasBeenSet() const { return m_scheduleFrequencyHasBeenSet; } /** *

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.

*/ inline void SetScheduleFrequency(const JobScheduleFrequency& value) { m_scheduleFrequencyHasBeenSet = true; m_scheduleFrequency = value; } /** *

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.

*/ inline void SetScheduleFrequency(JobScheduleFrequency&& value) { m_scheduleFrequencyHasBeenSet = true; m_scheduleFrequency = std::move(value); } /** *

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.

*/ inline CreateClassificationJobRequest& WithScheduleFrequency(const JobScheduleFrequency& value) { SetScheduleFrequency(value); return *this;} /** *

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.

*/ inline CreateClassificationJobRequest& WithScheduleFrequency(JobScheduleFrequency&& value) { SetScheduleFrequency(std::move(value)); return *this;} /** *

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.

*/ inline const Aws::Map& GetTags() const{ return m_tags; } /** *

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.

*/ inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; } /** *

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.

*/ inline void SetTags(const Aws::Map& value) { m_tagsHasBeenSet = true; m_tags = value; } /** *

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.

*/ inline void SetTags(Aws::Map&& value) { m_tagsHasBeenSet = true; m_tags = std::move(value); } /** *

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.

*/ inline CreateClassificationJobRequest& WithTags(const Aws::Map& value) { SetTags(value); return *this;} /** *

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.

*/ inline CreateClassificationJobRequest& WithTags(Aws::Map&& value) { SetTags(std::move(value)); return *this;} /** *

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.

*/ inline CreateClassificationJobRequest& AddTags(const Aws::String& key, const Aws::String& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, value); return *this; } /** *

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.

*/ inline CreateClassificationJobRequest& AddTags(Aws::String&& key, const Aws::String& value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), value); return *this; } /** *

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.

*/ inline CreateClassificationJobRequest& AddTags(const Aws::String& key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, std::move(value)); return *this; } /** *

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.

*/ inline CreateClassificationJobRequest& AddTags(Aws::String&& key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), std::move(value)); return *this; } /** *

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.

*/ inline CreateClassificationJobRequest& AddTags(const char* key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, std::move(value)); return *this; } /** *

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.

*/ inline CreateClassificationJobRequest& AddTags(Aws::String&& key, const char* value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), value); return *this; } /** *

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.

*/ inline CreateClassificationJobRequest& AddTags(const char* key, const char* value) { m_tagsHasBeenSet = true; m_tags.emplace(key, value); return *this; } private: Aws::String m_clientToken; bool m_clientTokenHasBeenSet; Aws::Vector m_customDataIdentifierIds; bool m_customDataIdentifierIdsHasBeenSet; Aws::String m_description; bool m_descriptionHasBeenSet; bool m_initialRun; bool m_initialRunHasBeenSet; JobType m_jobType; bool m_jobTypeHasBeenSet; Aws::String m_name; bool m_nameHasBeenSet; S3JobDefinition m_s3JobDefinition; bool m_s3JobDefinitionHasBeenSet; int m_samplingPercentage; bool m_samplingPercentageHasBeenSet; JobScheduleFrequency m_scheduleFrequency; bool m_scheduleFrequencyHasBeenSet; Aws::Map m_tags; bool m_tagsHasBeenSet; }; } // namespace Model } // namespace Macie2 } // namespace Aws