/** * 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 #include namespace Aws { namespace SageMaker { namespace Model { /** */ class CreateLabelingJobRequest : public SageMakerRequest { public: AWS_SAGEMAKER_API CreateLabelingJobRequest(); // 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 "CreateLabelingJob"; } AWS_SAGEMAKER_API Aws::String SerializePayload() const override; AWS_SAGEMAKER_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

The name of the labeling job. This name is used to identify the job in a list * of labeling jobs. Labeling job names must be unique within an Amazon Web * Services account and region. LabelingJobName is not case sensitive. * For example, Example-job and example-job are considered the same labeling job * name by Ground Truth.

*/ inline const Aws::String& GetLabelingJobName() const{ return m_labelingJobName; } /** *

The name of the labeling job. This name is used to identify the job in a list * of labeling jobs. Labeling job names must be unique within an Amazon Web * Services account and region. LabelingJobName is not case sensitive. * For example, Example-job and example-job are considered the same labeling job * name by Ground Truth.

*/ inline bool LabelingJobNameHasBeenSet() const { return m_labelingJobNameHasBeenSet; } /** *

The name of the labeling job. This name is used to identify the job in a list * of labeling jobs. Labeling job names must be unique within an Amazon Web * Services account and region. LabelingJobName is not case sensitive. * For example, Example-job and example-job are considered the same labeling job * name by Ground Truth.

*/ inline void SetLabelingJobName(const Aws::String& value) { m_labelingJobNameHasBeenSet = true; m_labelingJobName = value; } /** *

The name of the labeling job. This name is used to identify the job in a list * of labeling jobs. Labeling job names must be unique within an Amazon Web * Services account and region. LabelingJobName is not case sensitive. * For example, Example-job and example-job are considered the same labeling job * name by Ground Truth.

*/ inline void SetLabelingJobName(Aws::String&& value) { m_labelingJobNameHasBeenSet = true; m_labelingJobName = std::move(value); } /** *

The name of the labeling job. This name is used to identify the job in a list * of labeling jobs. Labeling job names must be unique within an Amazon Web * Services account and region. LabelingJobName is not case sensitive. * For example, Example-job and example-job are considered the same labeling job * name by Ground Truth.

*/ inline void SetLabelingJobName(const char* value) { m_labelingJobNameHasBeenSet = true; m_labelingJobName.assign(value); } /** *

The name of the labeling job. This name is used to identify the job in a list * of labeling jobs. Labeling job names must be unique within an Amazon Web * Services account and region. LabelingJobName is not case sensitive. * For example, Example-job and example-job are considered the same labeling job * name by Ground Truth.

*/ inline CreateLabelingJobRequest& WithLabelingJobName(const Aws::String& value) { SetLabelingJobName(value); return *this;} /** *

The name of the labeling job. This name is used to identify the job in a list * of labeling jobs. Labeling job names must be unique within an Amazon Web * Services account and region. LabelingJobName is not case sensitive. * For example, Example-job and example-job are considered the same labeling job * name by Ground Truth.

*/ inline CreateLabelingJobRequest& WithLabelingJobName(Aws::String&& value) { SetLabelingJobName(std::move(value)); return *this;} /** *

The name of the labeling job. This name is used to identify the job in a list * of labeling jobs. Labeling job names must be unique within an Amazon Web * Services account and region. LabelingJobName is not case sensitive. * For example, Example-job and example-job are considered the same labeling job * name by Ground Truth.

*/ inline CreateLabelingJobRequest& WithLabelingJobName(const char* value) { SetLabelingJobName(value); return *this;} /** *

The attribute name to use for the label in the output manifest file. This is * the key for the key/value pair formed with the label that a worker assigns to * the object. The LabelAttributeName must meet the following * requirements.

  • The name can't end with "-metadata".

  • *
  • If you are using one of the following built-in * task types, the attribute name must end with "-ref". If the task type * you are using is not listed below, the attribute name must not end with * "-ref".

    • Image semantic segmentation * (SemanticSegmentation), and adjustment * (AdjustmentSemanticSegmentation) and verification * (VerificationSemanticSegmentation) labeling jobs for this task * type.

    • Video frame object detection * (VideoObjectDetection), and adjustment and verification * (AdjustmentVideoObjectDetection) labeling jobs for this task * type.

    • Video frame object tracking * (VideoObjectTracking), and adjustment and verification * (AdjustmentVideoObjectTracking) labeling jobs for this task * type.

    • 3D point cloud semantic segmentation * (3DPointCloudSemanticSegmentation), and adjustment and verification * (Adjustment3DPointCloudSemanticSegmentation) labeling jobs for this * task type.

    • 3D point cloud object tracking * (3DPointCloudObjectTracking), and adjustment and verification * (Adjustment3DPointCloudObjectTracking) labeling jobs for this task * type.

If you are creating an * adjustment or verification labeling job, you must use a different * LabelAttributeName than the one used in the original labeling job. * The original labeling job is the Ground Truth labeling job that produced the * labels that you want verified or adjusted. To learn more about adjustment and * verification labeling jobs, see Verify * and Adjust Labels.

*/ inline const Aws::String& GetLabelAttributeName() const{ return m_labelAttributeName; } /** *

The attribute name to use for the label in the output manifest file. This is * the key for the key/value pair formed with the label that a worker assigns to * the object. The LabelAttributeName must meet the following * requirements.

  • The name can't end with "-metadata".

  • *
  • If you are using one of the following built-in * task types, the attribute name must end with "-ref". If the task type * you are using is not listed below, the attribute name must not end with * "-ref".

    • Image semantic segmentation * (SemanticSegmentation), and adjustment * (AdjustmentSemanticSegmentation) and verification * (VerificationSemanticSegmentation) labeling jobs for this task * type.

    • Video frame object detection * (VideoObjectDetection), and adjustment and verification * (AdjustmentVideoObjectDetection) labeling jobs for this task * type.

    • Video frame object tracking * (VideoObjectTracking), and adjustment and verification * (AdjustmentVideoObjectTracking) labeling jobs for this task * type.

    • 3D point cloud semantic segmentation * (3DPointCloudSemanticSegmentation), and adjustment and verification * (Adjustment3DPointCloudSemanticSegmentation) labeling jobs for this * task type.

    • 3D point cloud object tracking * (3DPointCloudObjectTracking), and adjustment and verification * (Adjustment3DPointCloudObjectTracking) labeling jobs for this task * type.

If you are creating an * adjustment or verification labeling job, you must use a different * LabelAttributeName than the one used in the original labeling job. * The original labeling job is the Ground Truth labeling job that produced the * labels that you want verified or adjusted. To learn more about adjustment and * verification labeling jobs, see Verify * and Adjust Labels.

*/ inline bool LabelAttributeNameHasBeenSet() const { return m_labelAttributeNameHasBeenSet; } /** *

The attribute name to use for the label in the output manifest file. This is * the key for the key/value pair formed with the label that a worker assigns to * the object. The LabelAttributeName must meet the following * requirements.

  • The name can't end with "-metadata".

  • *
  • If you are using one of the following built-in * task types, the attribute name must end with "-ref". If the task type * you are using is not listed below, the attribute name must not end with * "-ref".

    • Image semantic segmentation * (SemanticSegmentation), and adjustment * (AdjustmentSemanticSegmentation) and verification * (VerificationSemanticSegmentation) labeling jobs for this task * type.

    • Video frame object detection * (VideoObjectDetection), and adjustment and verification * (AdjustmentVideoObjectDetection) labeling jobs for this task * type.

    • Video frame object tracking * (VideoObjectTracking), and adjustment and verification * (AdjustmentVideoObjectTracking) labeling jobs for this task * type.

    • 3D point cloud semantic segmentation * (3DPointCloudSemanticSegmentation), and adjustment and verification * (Adjustment3DPointCloudSemanticSegmentation) labeling jobs for this * task type.

    • 3D point cloud object tracking * (3DPointCloudObjectTracking), and adjustment and verification * (Adjustment3DPointCloudObjectTracking) labeling jobs for this task * type.

If you are creating an * adjustment or verification labeling job, you must use a different * LabelAttributeName than the one used in the original labeling job. * The original labeling job is the Ground Truth labeling job that produced the * labels that you want verified or adjusted. To learn more about adjustment and * verification labeling jobs, see Verify * and Adjust Labels.

*/ inline void SetLabelAttributeName(const Aws::String& value) { m_labelAttributeNameHasBeenSet = true; m_labelAttributeName = value; } /** *

The attribute name to use for the label in the output manifest file. This is * the key for the key/value pair formed with the label that a worker assigns to * the object. The LabelAttributeName must meet the following * requirements.

  • The name can't end with "-metadata".

  • *
  • If you are using one of the following built-in * task types, the attribute name must end with "-ref". If the task type * you are using is not listed below, the attribute name must not end with * "-ref".

    • Image semantic segmentation * (SemanticSegmentation), and adjustment * (AdjustmentSemanticSegmentation) and verification * (VerificationSemanticSegmentation) labeling jobs for this task * type.

    • Video frame object detection * (VideoObjectDetection), and adjustment and verification * (AdjustmentVideoObjectDetection) labeling jobs for this task * type.

    • Video frame object tracking * (VideoObjectTracking), and adjustment and verification * (AdjustmentVideoObjectTracking) labeling jobs for this task * type.

    • 3D point cloud semantic segmentation * (3DPointCloudSemanticSegmentation), and adjustment and verification * (Adjustment3DPointCloudSemanticSegmentation) labeling jobs for this * task type.

    • 3D point cloud object tracking * (3DPointCloudObjectTracking), and adjustment and verification * (Adjustment3DPointCloudObjectTracking) labeling jobs for this task * type.

If you are creating an * adjustment or verification labeling job, you must use a different * LabelAttributeName than the one used in the original labeling job. * The original labeling job is the Ground Truth labeling job that produced the * labels that you want verified or adjusted. To learn more about adjustment and * verification labeling jobs, see Verify * and Adjust Labels.

*/ inline void SetLabelAttributeName(Aws::String&& value) { m_labelAttributeNameHasBeenSet = true; m_labelAttributeName = std::move(value); } /** *

The attribute name to use for the label in the output manifest file. This is * the key for the key/value pair formed with the label that a worker assigns to * the object. The LabelAttributeName must meet the following * requirements.

  • The name can't end with "-metadata".

  • *
  • If you are using one of the following built-in * task types, the attribute name must end with "-ref". If the task type * you are using is not listed below, the attribute name must not end with * "-ref".

    • Image semantic segmentation * (SemanticSegmentation), and adjustment * (AdjustmentSemanticSegmentation) and verification * (VerificationSemanticSegmentation) labeling jobs for this task * type.

    • Video frame object detection * (VideoObjectDetection), and adjustment and verification * (AdjustmentVideoObjectDetection) labeling jobs for this task * type.

    • Video frame object tracking * (VideoObjectTracking), and adjustment and verification * (AdjustmentVideoObjectTracking) labeling jobs for this task * type.

    • 3D point cloud semantic segmentation * (3DPointCloudSemanticSegmentation), and adjustment and verification * (Adjustment3DPointCloudSemanticSegmentation) labeling jobs for this * task type.

    • 3D point cloud object tracking * (3DPointCloudObjectTracking), and adjustment and verification * (Adjustment3DPointCloudObjectTracking) labeling jobs for this task * type.

If you are creating an * adjustment or verification labeling job, you must use a different * LabelAttributeName than the one used in the original labeling job. * The original labeling job is the Ground Truth labeling job that produced the * labels that you want verified or adjusted. To learn more about adjustment and * verification labeling jobs, see Verify * and Adjust Labels.

*/ inline void SetLabelAttributeName(const char* value) { m_labelAttributeNameHasBeenSet = true; m_labelAttributeName.assign(value); } /** *

The attribute name to use for the label in the output manifest file. This is * the key for the key/value pair formed with the label that a worker assigns to * the object. The LabelAttributeName must meet the following * requirements.

  • The name can't end with "-metadata".

  • *
  • If you are using one of the following built-in * task types, the attribute name must end with "-ref". If the task type * you are using is not listed below, the attribute name must not end with * "-ref".

    • Image semantic segmentation * (SemanticSegmentation), and adjustment * (AdjustmentSemanticSegmentation) and verification * (VerificationSemanticSegmentation) labeling jobs for this task * type.

    • Video frame object detection * (VideoObjectDetection), and adjustment and verification * (AdjustmentVideoObjectDetection) labeling jobs for this task * type.

    • Video frame object tracking * (VideoObjectTracking), and adjustment and verification * (AdjustmentVideoObjectTracking) labeling jobs for this task * type.

    • 3D point cloud semantic segmentation * (3DPointCloudSemanticSegmentation), and adjustment and verification * (Adjustment3DPointCloudSemanticSegmentation) labeling jobs for this * task type.

    • 3D point cloud object tracking * (3DPointCloudObjectTracking), and adjustment and verification * (Adjustment3DPointCloudObjectTracking) labeling jobs for this task * type.

If you are creating an * adjustment or verification labeling job, you must use a different * LabelAttributeName than the one used in the original labeling job. * The original labeling job is the Ground Truth labeling job that produced the * labels that you want verified or adjusted. To learn more about adjustment and * verification labeling jobs, see Verify * and Adjust Labels.

*/ inline CreateLabelingJobRequest& WithLabelAttributeName(const Aws::String& value) { SetLabelAttributeName(value); return *this;} /** *

The attribute name to use for the label in the output manifest file. This is * the key for the key/value pair formed with the label that a worker assigns to * the object. The LabelAttributeName must meet the following * requirements.

  • The name can't end with "-metadata".

  • *
  • If you are using one of the following built-in * task types, the attribute name must end with "-ref". If the task type * you are using is not listed below, the attribute name must not end with * "-ref".

    • Image semantic segmentation * (SemanticSegmentation), and adjustment * (AdjustmentSemanticSegmentation) and verification * (VerificationSemanticSegmentation) labeling jobs for this task * type.

    • Video frame object detection * (VideoObjectDetection), and adjustment and verification * (AdjustmentVideoObjectDetection) labeling jobs for this task * type.

    • Video frame object tracking * (VideoObjectTracking), and adjustment and verification * (AdjustmentVideoObjectTracking) labeling jobs for this task * type.

    • 3D point cloud semantic segmentation * (3DPointCloudSemanticSegmentation), and adjustment and verification * (Adjustment3DPointCloudSemanticSegmentation) labeling jobs for this * task type.

    • 3D point cloud object tracking * (3DPointCloudObjectTracking), and adjustment and verification * (Adjustment3DPointCloudObjectTracking) labeling jobs for this task * type.

If you are creating an * adjustment or verification labeling job, you must use a different * LabelAttributeName than the one used in the original labeling job. * The original labeling job is the Ground Truth labeling job that produced the * labels that you want verified or adjusted. To learn more about adjustment and * verification labeling jobs, see Verify * and Adjust Labels.

*/ inline CreateLabelingJobRequest& WithLabelAttributeName(Aws::String&& value) { SetLabelAttributeName(std::move(value)); return *this;} /** *

The attribute name to use for the label in the output manifest file. This is * the key for the key/value pair formed with the label that a worker assigns to * the object. The LabelAttributeName must meet the following * requirements.

  • The name can't end with "-metadata".

  • *
  • If you are using one of the following built-in * task types, the attribute name must end with "-ref". If the task type * you are using is not listed below, the attribute name must not end with * "-ref".

    • Image semantic segmentation * (SemanticSegmentation), and adjustment * (AdjustmentSemanticSegmentation) and verification * (VerificationSemanticSegmentation) labeling jobs for this task * type.

    • Video frame object detection * (VideoObjectDetection), and adjustment and verification * (AdjustmentVideoObjectDetection) labeling jobs for this task * type.

    • Video frame object tracking * (VideoObjectTracking), and adjustment and verification * (AdjustmentVideoObjectTracking) labeling jobs for this task * type.

    • 3D point cloud semantic segmentation * (3DPointCloudSemanticSegmentation), and adjustment and verification * (Adjustment3DPointCloudSemanticSegmentation) labeling jobs for this * task type.

    • 3D point cloud object tracking * (3DPointCloudObjectTracking), and adjustment and verification * (Adjustment3DPointCloudObjectTracking) labeling jobs for this task * type.

If you are creating an * adjustment or verification labeling job, you must use a different * LabelAttributeName than the one used in the original labeling job. * The original labeling job is the Ground Truth labeling job that produced the * labels that you want verified or adjusted. To learn more about adjustment and * verification labeling jobs, see Verify * and Adjust Labels.

*/ inline CreateLabelingJobRequest& WithLabelAttributeName(const char* value) { SetLabelAttributeName(value); return *this;} /** *

Input data for the labeling job, such as the Amazon S3 location of the data * objects and the location of the manifest file that describes the data * objects.

You must specify at least one of the following: * S3DataSource or SnsDataSource.

  • Use * SnsDataSource to specify an SNS input topic for a streaming * labeling job. If you do not specify and SNS input topic ARN, Ground Truth will * create a one-time labeling job that stops after all data objects in the input * manifest file have been labeled.

  • Use S3DataSource * to specify an input manifest file for both streaming and one-time labeling jobs. * Adding an S3DataSource is optional if you use * SnsDataSource to create a streaming labeling job.

*

If you use the Amazon Mechanical Turk workforce, your input data should not * include confidential information, personal information or protected health * information. Use ContentClassifiers to specify that your data is * free of personally identifiable information and adult content.

*/ inline const LabelingJobInputConfig& GetInputConfig() const{ return m_inputConfig; } /** *

Input data for the labeling job, such as the Amazon S3 location of the data * objects and the location of the manifest file that describes the data * objects.

You must specify at least one of the following: * S3DataSource or SnsDataSource.

  • Use * SnsDataSource to specify an SNS input topic for a streaming * labeling job. If you do not specify and SNS input topic ARN, Ground Truth will * create a one-time labeling job that stops after all data objects in the input * manifest file have been labeled.

  • Use S3DataSource * to specify an input manifest file for both streaming and one-time labeling jobs. * Adding an S3DataSource is optional if you use * SnsDataSource to create a streaming labeling job.

*

If you use the Amazon Mechanical Turk workforce, your input data should not * include confidential information, personal information or protected health * information. Use ContentClassifiers to specify that your data is * free of personally identifiable information and adult content.

*/ inline bool InputConfigHasBeenSet() const { return m_inputConfigHasBeenSet; } /** *

Input data for the labeling job, such as the Amazon S3 location of the data * objects and the location of the manifest file that describes the data * objects.

You must specify at least one of the following: * S3DataSource or SnsDataSource.

  • Use * SnsDataSource to specify an SNS input topic for a streaming * labeling job. If you do not specify and SNS input topic ARN, Ground Truth will * create a one-time labeling job that stops after all data objects in the input * manifest file have been labeled.

  • Use S3DataSource * to specify an input manifest file for both streaming and one-time labeling jobs. * Adding an S3DataSource is optional if you use * SnsDataSource to create a streaming labeling job.

*

If you use the Amazon Mechanical Turk workforce, your input data should not * include confidential information, personal information or protected health * information. Use ContentClassifiers to specify that your data is * free of personally identifiable information and adult content.

*/ inline void SetInputConfig(const LabelingJobInputConfig& value) { m_inputConfigHasBeenSet = true; m_inputConfig = value; } /** *

Input data for the labeling job, such as the Amazon S3 location of the data * objects and the location of the manifest file that describes the data * objects.

You must specify at least one of the following: * S3DataSource or SnsDataSource.

  • Use * SnsDataSource to specify an SNS input topic for a streaming * labeling job. If you do not specify and SNS input topic ARN, Ground Truth will * create a one-time labeling job that stops after all data objects in the input * manifest file have been labeled.

  • Use S3DataSource * to specify an input manifest file for both streaming and one-time labeling jobs. * Adding an S3DataSource is optional if you use * SnsDataSource to create a streaming labeling job.

*

If you use the Amazon Mechanical Turk workforce, your input data should not * include confidential information, personal information or protected health * information. Use ContentClassifiers to specify that your data is * free of personally identifiable information and adult content.

*/ inline void SetInputConfig(LabelingJobInputConfig&& value) { m_inputConfigHasBeenSet = true; m_inputConfig = std::move(value); } /** *

Input data for the labeling job, such as the Amazon S3 location of the data * objects and the location of the manifest file that describes the data * objects.

You must specify at least one of the following: * S3DataSource or SnsDataSource.

  • Use * SnsDataSource to specify an SNS input topic for a streaming * labeling job. If you do not specify and SNS input topic ARN, Ground Truth will * create a one-time labeling job that stops after all data objects in the input * manifest file have been labeled.

  • Use S3DataSource * to specify an input manifest file for both streaming and one-time labeling jobs. * Adding an S3DataSource is optional if you use * SnsDataSource to create a streaming labeling job.

*

If you use the Amazon Mechanical Turk workforce, your input data should not * include confidential information, personal information or protected health * information. Use ContentClassifiers to specify that your data is * free of personally identifiable information and adult content.

*/ inline CreateLabelingJobRequest& WithInputConfig(const LabelingJobInputConfig& value) { SetInputConfig(value); return *this;} /** *

Input data for the labeling job, such as the Amazon S3 location of the data * objects and the location of the manifest file that describes the data * objects.

You must specify at least one of the following: * S3DataSource or SnsDataSource.

  • Use * SnsDataSource to specify an SNS input topic for a streaming * labeling job. If you do not specify and SNS input topic ARN, Ground Truth will * create a one-time labeling job that stops after all data objects in the input * manifest file have been labeled.

  • Use S3DataSource * to specify an input manifest file for both streaming and one-time labeling jobs. * Adding an S3DataSource is optional if you use * SnsDataSource to create a streaming labeling job.

*

If you use the Amazon Mechanical Turk workforce, your input data should not * include confidential information, personal information or protected health * information. Use ContentClassifiers to specify that your data is * free of personally identifiable information and adult content.

*/ inline CreateLabelingJobRequest& WithInputConfig(LabelingJobInputConfig&& value) { SetInputConfig(std::move(value)); return *this;} /** *

The location of the output data and the Amazon Web Services Key Management * Service key ID for the key used to encrypt the output data, if any.

*/ inline const LabelingJobOutputConfig& GetOutputConfig() const{ return m_outputConfig; } /** *

The location of the output data and the Amazon Web Services Key Management * Service key ID for the key used to encrypt the output data, if any.

*/ inline bool OutputConfigHasBeenSet() const { return m_outputConfigHasBeenSet; } /** *

The location of the output data and the Amazon Web Services Key Management * Service key ID for the key used to encrypt the output data, if any.

*/ inline void SetOutputConfig(const LabelingJobOutputConfig& value) { m_outputConfigHasBeenSet = true; m_outputConfig = value; } /** *

The location of the output data and the Amazon Web Services Key Management * Service key ID for the key used to encrypt the output data, if any.

*/ inline void SetOutputConfig(LabelingJobOutputConfig&& value) { m_outputConfigHasBeenSet = true; m_outputConfig = std::move(value); } /** *

The location of the output data and the Amazon Web Services Key Management * Service key ID for the key used to encrypt the output data, if any.

*/ inline CreateLabelingJobRequest& WithOutputConfig(const LabelingJobOutputConfig& value) { SetOutputConfig(value); return *this;} /** *

The location of the output data and the Amazon Web Services Key Management * Service key ID for the key used to encrypt the output data, if any.

*/ inline CreateLabelingJobRequest& WithOutputConfig(LabelingJobOutputConfig&& value) { SetOutputConfig(std::move(value)); return *this;} /** *

The Amazon Resource Number (ARN) that Amazon SageMaker assumes to perform * tasks on your behalf during data labeling. You must grant this role the * necessary permissions so that Amazon SageMaker can successfully complete data * labeling.

*/ inline const Aws::String& GetRoleArn() const{ return m_roleArn; } /** *

The Amazon Resource Number (ARN) that Amazon SageMaker assumes to perform * tasks on your behalf during data labeling. You must grant this role the * necessary permissions so that Amazon SageMaker can successfully complete data * labeling.

*/ inline bool RoleArnHasBeenSet() const { return m_roleArnHasBeenSet; } /** *

The Amazon Resource Number (ARN) that Amazon SageMaker assumes to perform * tasks on your behalf during data labeling. You must grant this role the * necessary permissions so that Amazon SageMaker can successfully complete data * labeling.

*/ inline void SetRoleArn(const Aws::String& value) { m_roleArnHasBeenSet = true; m_roleArn = value; } /** *

The Amazon Resource Number (ARN) that Amazon SageMaker assumes to perform * tasks on your behalf during data labeling. You must grant this role the * necessary permissions so that Amazon SageMaker can successfully complete data * labeling.

*/ inline void SetRoleArn(Aws::String&& value) { m_roleArnHasBeenSet = true; m_roleArn = std::move(value); } /** *

The Amazon Resource Number (ARN) that Amazon SageMaker assumes to perform * tasks on your behalf during data labeling. You must grant this role the * necessary permissions so that Amazon SageMaker can successfully complete data * labeling.

*/ inline void SetRoleArn(const char* value) { m_roleArnHasBeenSet = true; m_roleArn.assign(value); } /** *

The Amazon Resource Number (ARN) that Amazon SageMaker assumes to perform * tasks on your behalf during data labeling. You must grant this role the * necessary permissions so that Amazon SageMaker can successfully complete data * labeling.

*/ inline CreateLabelingJobRequest& WithRoleArn(const Aws::String& value) { SetRoleArn(value); return *this;} /** *

The Amazon Resource Number (ARN) that Amazon SageMaker assumes to perform * tasks on your behalf during data labeling. You must grant this role the * necessary permissions so that Amazon SageMaker can successfully complete data * labeling.

*/ inline CreateLabelingJobRequest& WithRoleArn(Aws::String&& value) { SetRoleArn(std::move(value)); return *this;} /** *

The Amazon Resource Number (ARN) that Amazon SageMaker assumes to perform * tasks on your behalf during data labeling. You must grant this role the * necessary permissions so that Amazon SageMaker can successfully complete data * labeling.

*/ inline CreateLabelingJobRequest& WithRoleArn(const char* value) { SetRoleArn(value); return *this;} /** *

The S3 URI of the file, referred to as a label category configuration * file, that defines the categories used to label the data objects.

For * 3D point cloud and video frame task types, you can add label category attributes * and frame attributes to your label category configuration file. To learn how, * see Create * a Labeling Category Configuration File for 3D Point Cloud Labeling Jobs. *

For named entity recognition jobs, in addition to "labels", * you must provide worker instructions in the label category configuration file * using the "instructions" parameter: "instructions": * {"shortInstruction":"<h1>Add header</h1><p>Add * Instructions</p>", "fullInstruction":"<p>Add additional * instructions.</p>"}. For details and an example, see Create * a Named Entity Recognition Labeling Job (API) .

For all other built-in * task types and custom * tasks, your label category configuration file must be a JSON file in the * following format. Identify the labels you want to use by replacing * label_1, label_2,...,label_n * with your label categories.

{

* "document-version": "2018-11-28",

"labels": * [{"label": "label_1"},{"label": "label_2"},...{"label": "label_n"}]

*

}

Note the following about the label category * configuration file:

  • For image classification and text * classification (single and multi-label) you must specify at least two label * categories. For all other task types, the minimum number of label categories * required is one.

  • Each label category must be unique, you * cannot specify duplicate label categories.

  • If you create a 3D * point cloud or video frame adjustment or verification labeling job, you must * include auditLabelAttributeName in the label category * configuration. Use this parameter to enter the * LabelAttributeName of the labeling job you want to adjust or * verify annotations of.

*/ inline const Aws::String& GetLabelCategoryConfigS3Uri() const{ return m_labelCategoryConfigS3Uri; } /** *

The S3 URI of the file, referred to as a label category configuration * file, that defines the categories used to label the data objects.

For * 3D point cloud and video frame task types, you can add label category attributes * and frame attributes to your label category configuration file. To learn how, * see Create * a Labeling Category Configuration File for 3D Point Cloud Labeling Jobs. *

For named entity recognition jobs, in addition to "labels", * you must provide worker instructions in the label category configuration file * using the "instructions" parameter: "instructions": * {"shortInstruction":"<h1>Add header</h1><p>Add * Instructions</p>", "fullInstruction":"<p>Add additional * instructions.</p>"}. For details and an example, see Create * a Named Entity Recognition Labeling Job (API) .

For all other built-in * task types and custom * tasks, your label category configuration file must be a JSON file in the * following format. Identify the labels you want to use by replacing * label_1, label_2,...,label_n * with your label categories.

{

* "document-version": "2018-11-28",

"labels": * [{"label": "label_1"},{"label": "label_2"},...{"label": "label_n"}]

*

}

Note the following about the label category * configuration file:

  • For image classification and text * classification (single and multi-label) you must specify at least two label * categories. For all other task types, the minimum number of label categories * required is one.

  • Each label category must be unique, you * cannot specify duplicate label categories.

  • If you create a 3D * point cloud or video frame adjustment or verification labeling job, you must * include auditLabelAttributeName in the label category * configuration. Use this parameter to enter the * LabelAttributeName of the labeling job you want to adjust or * verify annotations of.

*/ inline bool LabelCategoryConfigS3UriHasBeenSet() const { return m_labelCategoryConfigS3UriHasBeenSet; } /** *

The S3 URI of the file, referred to as a label category configuration * file, that defines the categories used to label the data objects.

For * 3D point cloud and video frame task types, you can add label category attributes * and frame attributes to your label category configuration file. To learn how, * see Create * a Labeling Category Configuration File for 3D Point Cloud Labeling Jobs. *

For named entity recognition jobs, in addition to "labels", * you must provide worker instructions in the label category configuration file * using the "instructions" parameter: "instructions": * {"shortInstruction":"<h1>Add header</h1><p>Add * Instructions</p>", "fullInstruction":"<p>Add additional * instructions.</p>"}. For details and an example, see Create * a Named Entity Recognition Labeling Job (API) .

For all other built-in * task types and custom * tasks, your label category configuration file must be a JSON file in the * following format. Identify the labels you want to use by replacing * label_1, label_2,...,label_n * with your label categories.

{

* "document-version": "2018-11-28",

"labels": * [{"label": "label_1"},{"label": "label_2"},...{"label": "label_n"}]

*

}

Note the following about the label category * configuration file:

  • For image classification and text * classification (single and multi-label) you must specify at least two label * categories. For all other task types, the minimum number of label categories * required is one.

  • Each label category must be unique, you * cannot specify duplicate label categories.

  • If you create a 3D * point cloud or video frame adjustment or verification labeling job, you must * include auditLabelAttributeName in the label category * configuration. Use this parameter to enter the * LabelAttributeName of the labeling job you want to adjust or * verify annotations of.

*/ inline void SetLabelCategoryConfigS3Uri(const Aws::String& value) { m_labelCategoryConfigS3UriHasBeenSet = true; m_labelCategoryConfigS3Uri = value; } /** *

The S3 URI of the file, referred to as a label category configuration * file, that defines the categories used to label the data objects.

For * 3D point cloud and video frame task types, you can add label category attributes * and frame attributes to your label category configuration file. To learn how, * see Create * a Labeling Category Configuration File for 3D Point Cloud Labeling Jobs. *

For named entity recognition jobs, in addition to "labels", * you must provide worker instructions in the label category configuration file * using the "instructions" parameter: "instructions": * {"shortInstruction":"<h1>Add header</h1><p>Add * Instructions</p>", "fullInstruction":"<p>Add additional * instructions.</p>"}. For details and an example, see Create * a Named Entity Recognition Labeling Job (API) .

For all other built-in * task types and custom * tasks, your label category configuration file must be a JSON file in the * following format. Identify the labels you want to use by replacing * label_1, label_2,...,label_n * with your label categories.

{

* "document-version": "2018-11-28",

"labels": * [{"label": "label_1"},{"label": "label_2"},...{"label": "label_n"}]

*

}

Note the following about the label category * configuration file:

  • For image classification and text * classification (single and multi-label) you must specify at least two label * categories. For all other task types, the minimum number of label categories * required is one.

  • Each label category must be unique, you * cannot specify duplicate label categories.

  • If you create a 3D * point cloud or video frame adjustment or verification labeling job, you must * include auditLabelAttributeName in the label category * configuration. Use this parameter to enter the * LabelAttributeName of the labeling job you want to adjust or * verify annotations of.

*/ inline void SetLabelCategoryConfigS3Uri(Aws::String&& value) { m_labelCategoryConfigS3UriHasBeenSet = true; m_labelCategoryConfigS3Uri = std::move(value); } /** *

The S3 URI of the file, referred to as a label category configuration * file, that defines the categories used to label the data objects.

For * 3D point cloud and video frame task types, you can add label category attributes * and frame attributes to your label category configuration file. To learn how, * see Create * a Labeling Category Configuration File for 3D Point Cloud Labeling Jobs. *

For named entity recognition jobs, in addition to "labels", * you must provide worker instructions in the label category configuration file * using the "instructions" parameter: "instructions": * {"shortInstruction":"<h1>Add header</h1><p>Add * Instructions</p>", "fullInstruction":"<p>Add additional * instructions.</p>"}. For details and an example, see Create * a Named Entity Recognition Labeling Job (API) .

For all other built-in * task types and custom * tasks, your label category configuration file must be a JSON file in the * following format. Identify the labels you want to use by replacing * label_1, label_2,...,label_n * with your label categories.

{

* "document-version": "2018-11-28",

"labels": * [{"label": "label_1"},{"label": "label_2"},...{"label": "label_n"}]

*

}

Note the following about the label category * configuration file:

  • For image classification and text * classification (single and multi-label) you must specify at least two label * categories. For all other task types, the minimum number of label categories * required is one.

  • Each label category must be unique, you * cannot specify duplicate label categories.

  • If you create a 3D * point cloud or video frame adjustment or verification labeling job, you must * include auditLabelAttributeName in the label category * configuration. Use this parameter to enter the * LabelAttributeName of the labeling job you want to adjust or * verify annotations of.

*/ inline void SetLabelCategoryConfigS3Uri(const char* value) { m_labelCategoryConfigS3UriHasBeenSet = true; m_labelCategoryConfigS3Uri.assign(value); } /** *

The S3 URI of the file, referred to as a label category configuration * file, that defines the categories used to label the data objects.

For * 3D point cloud and video frame task types, you can add label category attributes * and frame attributes to your label category configuration file. To learn how, * see Create * a Labeling Category Configuration File for 3D Point Cloud Labeling Jobs. *

For named entity recognition jobs, in addition to "labels", * you must provide worker instructions in the label category configuration file * using the "instructions" parameter: "instructions": * {"shortInstruction":"<h1>Add header</h1><p>Add * Instructions</p>", "fullInstruction":"<p>Add additional * instructions.</p>"}. For details and an example, see Create * a Named Entity Recognition Labeling Job (API) .

For all other built-in * task types and custom * tasks, your label category configuration file must be a JSON file in the * following format. Identify the labels you want to use by replacing * label_1, label_2,...,label_n * with your label categories.

{

* "document-version": "2018-11-28",

"labels": * [{"label": "label_1"},{"label": "label_2"},...{"label": "label_n"}]

*

}

Note the following about the label category * configuration file:

  • For image classification and text * classification (single and multi-label) you must specify at least two label * categories. For all other task types, the minimum number of label categories * required is one.

  • Each label category must be unique, you * cannot specify duplicate label categories.

  • If you create a 3D * point cloud or video frame adjustment or verification labeling job, you must * include auditLabelAttributeName in the label category * configuration. Use this parameter to enter the * LabelAttributeName of the labeling job you want to adjust or * verify annotations of.

*/ inline CreateLabelingJobRequest& WithLabelCategoryConfigS3Uri(const Aws::String& value) { SetLabelCategoryConfigS3Uri(value); return *this;} /** *

The S3 URI of the file, referred to as a label category configuration * file, that defines the categories used to label the data objects.

For * 3D point cloud and video frame task types, you can add label category attributes * and frame attributes to your label category configuration file. To learn how, * see Create * a Labeling Category Configuration File for 3D Point Cloud Labeling Jobs. *

For named entity recognition jobs, in addition to "labels", * you must provide worker instructions in the label category configuration file * using the "instructions" parameter: "instructions": * {"shortInstruction":"<h1>Add header</h1><p>Add * Instructions</p>", "fullInstruction":"<p>Add additional * instructions.</p>"}. For details and an example, see Create * a Named Entity Recognition Labeling Job (API) .

For all other built-in * task types and custom * tasks, your label category configuration file must be a JSON file in the * following format. Identify the labels you want to use by replacing * label_1, label_2,...,label_n * with your label categories.

{

* "document-version": "2018-11-28",

"labels": * [{"label": "label_1"},{"label": "label_2"},...{"label": "label_n"}]

*

}

Note the following about the label category * configuration file:

  • For image classification and text * classification (single and multi-label) you must specify at least two label * categories. For all other task types, the minimum number of label categories * required is one.

  • Each label category must be unique, you * cannot specify duplicate label categories.

  • If you create a 3D * point cloud or video frame adjustment or verification labeling job, you must * include auditLabelAttributeName in the label category * configuration. Use this parameter to enter the * LabelAttributeName of the labeling job you want to adjust or * verify annotations of.

*/ inline CreateLabelingJobRequest& WithLabelCategoryConfigS3Uri(Aws::String&& value) { SetLabelCategoryConfigS3Uri(std::move(value)); return *this;} /** *

The S3 URI of the file, referred to as a label category configuration * file, that defines the categories used to label the data objects.

For * 3D point cloud and video frame task types, you can add label category attributes * and frame attributes to your label category configuration file. To learn how, * see Create * a Labeling Category Configuration File for 3D Point Cloud Labeling Jobs. *

For named entity recognition jobs, in addition to "labels", * you must provide worker instructions in the label category configuration file * using the "instructions" parameter: "instructions": * {"shortInstruction":"<h1>Add header</h1><p>Add * Instructions</p>", "fullInstruction":"<p>Add additional * instructions.</p>"}. For details and an example, see Create * a Named Entity Recognition Labeling Job (API) .

For all other built-in * task types and custom * tasks, your label category configuration file must be a JSON file in the * following format. Identify the labels you want to use by replacing * label_1, label_2,...,label_n * with your label categories.

{

* "document-version": "2018-11-28",

"labels": * [{"label": "label_1"},{"label": "label_2"},...{"label": "label_n"}]

*

}

Note the following about the label category * configuration file:

  • For image classification and text * classification (single and multi-label) you must specify at least two label * categories. For all other task types, the minimum number of label categories * required is one.

  • Each label category must be unique, you * cannot specify duplicate label categories.

  • If you create a 3D * point cloud or video frame adjustment or verification labeling job, you must * include auditLabelAttributeName in the label category * configuration. Use this parameter to enter the * LabelAttributeName of the labeling job you want to adjust or * verify annotations of.

*/ inline CreateLabelingJobRequest& WithLabelCategoryConfigS3Uri(const char* value) { SetLabelCategoryConfigS3Uri(value); return *this;} /** *

A set of conditions for stopping the labeling job. If any of the conditions * are met, the job is automatically stopped. You can use these conditions to * control the cost of data labeling.

*/ inline const LabelingJobStoppingConditions& GetStoppingConditions() const{ return m_stoppingConditions; } /** *

A set of conditions for stopping the labeling job. If any of the conditions * are met, the job is automatically stopped. You can use these conditions to * control the cost of data labeling.

*/ inline bool StoppingConditionsHasBeenSet() const { return m_stoppingConditionsHasBeenSet; } /** *

A set of conditions for stopping the labeling job. If any of the conditions * are met, the job is automatically stopped. You can use these conditions to * control the cost of data labeling.

*/ inline void SetStoppingConditions(const LabelingJobStoppingConditions& value) { m_stoppingConditionsHasBeenSet = true; m_stoppingConditions = value; } /** *

A set of conditions for stopping the labeling job. If any of the conditions * are met, the job is automatically stopped. You can use these conditions to * control the cost of data labeling.

*/ inline void SetStoppingConditions(LabelingJobStoppingConditions&& value) { m_stoppingConditionsHasBeenSet = true; m_stoppingConditions = std::move(value); } /** *

A set of conditions for stopping the labeling job. If any of the conditions * are met, the job is automatically stopped. You can use these conditions to * control the cost of data labeling.

*/ inline CreateLabelingJobRequest& WithStoppingConditions(const LabelingJobStoppingConditions& value) { SetStoppingConditions(value); return *this;} /** *

A set of conditions for stopping the labeling job. If any of the conditions * are met, the job is automatically stopped. You can use these conditions to * control the cost of data labeling.

*/ inline CreateLabelingJobRequest& WithStoppingConditions(LabelingJobStoppingConditions&& value) { SetStoppingConditions(std::move(value)); return *this;} /** *

Configures the information required to perform automated data labeling.

*/ inline const LabelingJobAlgorithmsConfig& GetLabelingJobAlgorithmsConfig() const{ return m_labelingJobAlgorithmsConfig; } /** *

Configures the information required to perform automated data labeling.

*/ inline bool LabelingJobAlgorithmsConfigHasBeenSet() const { return m_labelingJobAlgorithmsConfigHasBeenSet; } /** *

Configures the information required to perform automated data labeling.

*/ inline void SetLabelingJobAlgorithmsConfig(const LabelingJobAlgorithmsConfig& value) { m_labelingJobAlgorithmsConfigHasBeenSet = true; m_labelingJobAlgorithmsConfig = value; } /** *

Configures the information required to perform automated data labeling.

*/ inline void SetLabelingJobAlgorithmsConfig(LabelingJobAlgorithmsConfig&& value) { m_labelingJobAlgorithmsConfigHasBeenSet = true; m_labelingJobAlgorithmsConfig = std::move(value); } /** *

Configures the information required to perform automated data labeling.

*/ inline CreateLabelingJobRequest& WithLabelingJobAlgorithmsConfig(const LabelingJobAlgorithmsConfig& value) { SetLabelingJobAlgorithmsConfig(value); return *this;} /** *

Configures the information required to perform automated data labeling.

*/ inline CreateLabelingJobRequest& WithLabelingJobAlgorithmsConfig(LabelingJobAlgorithmsConfig&& value) { SetLabelingJobAlgorithmsConfig(std::move(value)); return *this;} /** *

Configures the labeling task and how it is presented to workers; including, * but not limited to price, keywords, and batch size (task count).

*/ inline const HumanTaskConfig& GetHumanTaskConfig() const{ return m_humanTaskConfig; } /** *

Configures the labeling task and how it is presented to workers; including, * but not limited to price, keywords, and batch size (task count).

*/ inline bool HumanTaskConfigHasBeenSet() const { return m_humanTaskConfigHasBeenSet; } /** *

Configures the labeling task and how it is presented to workers; including, * but not limited to price, keywords, and batch size (task count).

*/ inline void SetHumanTaskConfig(const HumanTaskConfig& value) { m_humanTaskConfigHasBeenSet = true; m_humanTaskConfig = value; } /** *

Configures the labeling task and how it is presented to workers; including, * but not limited to price, keywords, and batch size (task count).

*/ inline void SetHumanTaskConfig(HumanTaskConfig&& value) { m_humanTaskConfigHasBeenSet = true; m_humanTaskConfig = std::move(value); } /** *

Configures the labeling task and how it is presented to workers; including, * but not limited to price, keywords, and batch size (task count).

*/ inline CreateLabelingJobRequest& WithHumanTaskConfig(const HumanTaskConfig& value) { SetHumanTaskConfig(value); return *this;} /** *

Configures the labeling task and how it is presented to workers; including, * but not limited to price, keywords, and batch size (task count).

*/ inline CreateLabelingJobRequest& WithHumanTaskConfig(HumanTaskConfig&& value) { SetHumanTaskConfig(std::move(value)); return *this;} /** *

An array of key/value pairs. For more information, see Using * Cost Allocation Tags in the Amazon Web Services Billing and Cost * Management User Guide.

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

An array of key/value pairs. For more information, see Using * Cost Allocation Tags in the Amazon Web Services Billing and Cost * Management User Guide.

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

An array of key/value pairs. For more information, see Using * Cost Allocation Tags in the Amazon Web Services Billing and Cost * Management User Guide.

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

An array of key/value pairs. For more information, see Using * Cost Allocation Tags in the Amazon Web Services Billing and Cost * Management User Guide.

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

An array of key/value pairs. For more information, see Using * Cost Allocation Tags in the Amazon Web Services Billing and Cost * Management User Guide.

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

An array of key/value pairs. For more information, see Using * Cost Allocation Tags in the Amazon Web Services Billing and Cost * Management User Guide.

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

An array of key/value pairs. For more information, see Using * Cost Allocation Tags in the Amazon Web Services Billing and Cost * Management User Guide.

*/ inline CreateLabelingJobRequest& AddTags(const Tag& value) { m_tagsHasBeenSet = true; m_tags.push_back(value); return *this; } /** *

An array of key/value pairs. For more information, see Using * Cost Allocation Tags in the Amazon Web Services Billing and Cost * Management User Guide.

*/ inline CreateLabelingJobRequest& AddTags(Tag&& value) { m_tagsHasBeenSet = true; m_tags.push_back(std::move(value)); return *this; } private: Aws::String m_labelingJobName; bool m_labelingJobNameHasBeenSet = false; Aws::String m_labelAttributeName; bool m_labelAttributeNameHasBeenSet = false; LabelingJobInputConfig m_inputConfig; bool m_inputConfigHasBeenSet = false; LabelingJobOutputConfig m_outputConfig; bool m_outputConfigHasBeenSet = false; Aws::String m_roleArn; bool m_roleArnHasBeenSet = false; Aws::String m_labelCategoryConfigS3Uri; bool m_labelCategoryConfigS3UriHasBeenSet = false; LabelingJobStoppingConditions m_stoppingConditions; bool m_stoppingConditionsHasBeenSet = false; LabelingJobAlgorithmsConfig m_labelingJobAlgorithmsConfig; bool m_labelingJobAlgorithmsConfigHasBeenSet = false; HumanTaskConfig m_humanTaskConfig; bool m_humanTaskConfigHasBeenSet = false; Aws::Vector m_tags; bool m_tagsHasBeenSet = false; }; } // namespace Model } // namespace SageMaker } // namespace Aws