Class: Aws::SageMaker::Types::CreateLabelingJobRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::SageMaker::Types::CreateLabelingJobRequest
- Includes:
- Aws::Structure
- Defined in:
- lib/aws-sdk-sagemaker/types.rb
Overview
When making an API call, you may pass CreateLabelingJobRequest data as a hash:
{
labeling_job_name: "LabelingJobName", # required
label_attribute_name: "LabelAttributeName", # required
input_config: { # required
data_source: { # required
s3_data_source: { # required
manifest_s3_uri: "S3Uri", # required
},
},
data_attributes: {
content_classifiers: ["FreeOfPersonallyIdentifiableInformation"], # accepts FreeOfPersonallyIdentifiableInformation, FreeOfAdultContent
},
},
output_config: { # required
s3_output_path: "S3Uri", # required
kms_key_id: "KmsKeyId",
},
role_arn: "RoleArn", # required
label_category_config_s3_uri: "S3Uri",
stopping_conditions: {
max_human_labeled_object_count: 1,
max_percentage_of_input_dataset_labeled: 1,
},
labeling_job_algorithms_config: {
labeling_job_algorithm_specification_arn: "LabelingJobAlgorithmSpecificationArn", # required
initial_active_learning_model_arn: "ModelArn",
labeling_job_resource_config: {
volume_kms_key_id: "KmsKeyId",
},
},
human_task_config: { # required
workteam_arn: "WorkteamArn", # required
ui_config: { # required
ui_template_s3_uri: "S3Uri", # required
},
pre_human_task_lambda_arn: "LambdaFunctionArn", # required
task_keywords: ["TaskKeyword"],
task_title: "TaskTitle", # required
task_description: "TaskDescription", # required
number_of_human_workers_per_data_object: 1, # required
task_time_limit_in_seconds: 1, # required
task_availability_lifetime_in_seconds: 1,
max_concurrent_task_count: 1,
annotation_consolidation_config: { # required
annotation_consolidation_lambda_arn: "LambdaFunctionArn", # required
},
public_workforce_task_price: {
amount_in_usd: {
dollars: 1,
cents: 1,
tenth_fractions_of_a_cent: 1,
},
},
},
tags: [
{
key: "TagKey", # required
value: "TagValue", # required
},
],
}
Instance Attribute Summary collapse
-
#human_task_config ⇒ Types::HumanTaskConfig
Configures the information required for human workers to complete a labeling task.
-
#input_config ⇒ Types::LabelingJobInputConfig
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.
-
#label_attribute_name ⇒ String
The attribute name to use for the label in the output manifest file.
-
#label_category_config_s3_uri ⇒ String
The S3 URL of the file that defines the categories used to label the data objects.
-
#labeling_job_algorithms_config ⇒ Types::LabelingJobAlgorithmsConfig
Configures the information required to perform automated data labeling.
-
#labeling_job_name ⇒ String
The name of the labeling job.
-
#output_config ⇒ Types::LabelingJobOutputConfig
The location of the output data and the AWS Key Management Service key ID for the key used to encrypt the output data, if any.
-
#role_arn ⇒ String
The Amazon Resource Number (ARN) that Amazon SageMaker assumes to perform tasks on your behalf during data labeling.
-
#stopping_conditions ⇒ Types::LabelingJobStoppingConditions
A set of conditions for stopping the labeling job.
-
#tags ⇒ Array<Types::Tag>
An array of key/value pairs.
Instance Attribute Details
#human_task_config ⇒ Types::HumanTaskConfig
Configures the information required for human workers to complete a labeling task.
1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 |
# File 'lib/aws-sdk-sagemaker/types.rb', line 1834 class CreateLabelingJobRequest < Struct.new( :labeling_job_name, :label_attribute_name, :input_config, :output_config, :role_arn, :label_category_config_s3_uri, :stopping_conditions, :labeling_job_algorithms_config, :human_task_config, :tags) include Aws::Structure end |
#input_config ⇒ Types::LabelingJobInputConfig
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.
1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 |
# File 'lib/aws-sdk-sagemaker/types.rb', line 1834 class CreateLabelingJobRequest < Struct.new( :labeling_job_name, :label_attribute_name, :input_config, :output_config, :role_arn, :label_category_config_s3_uri, :stopping_conditions, :labeling_job_algorithms_config, :human_task_config, :tags) include Aws::Structure end |
#label_attribute_name ⇒ String
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 name can’t end with “-metadata”. If you are running a semantic segmentation labeling job, the attribute name must end with “-ref”. If you are running any other kind of labeling job, the attribute name must not end with “-ref”.
1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 |
# File 'lib/aws-sdk-sagemaker/types.rb', line 1834 class CreateLabelingJobRequest < Struct.new( :labeling_job_name, :label_attribute_name, :input_config, :output_config, :role_arn, :label_category_config_s3_uri, :stopping_conditions, :labeling_job_algorithms_config, :human_task_config, :tags) include Aws::Structure end |
#label_category_config_s3_uri ⇒ String
The S3 URL of the file that defines the categories used to label the data objects.
The file is a JSON structure in the following format:
‘{`
‘ “document-version”: “2018-11-28”`
‘ “labels”: [`
‘ {`
‘ “label”: “label 1”`
‘ },`
‘ {`
‘ “label”: “label 2”`
‘ },`
‘ …`
‘ {`
‘ “label”: “label n”`
‘ }`
‘ ]`
‘}`
1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 |
# File 'lib/aws-sdk-sagemaker/types.rb', line 1834 class CreateLabelingJobRequest < Struct.new( :labeling_job_name, :label_attribute_name, :input_config, :output_config, :role_arn, :label_category_config_s3_uri, :stopping_conditions, :labeling_job_algorithms_config, :human_task_config, :tags) include Aws::Structure end |
#labeling_job_algorithms_config ⇒ Types::LabelingJobAlgorithmsConfig
Configures the information required to perform automated data labeling.
1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 |
# File 'lib/aws-sdk-sagemaker/types.rb', line 1834 class CreateLabelingJobRequest < Struct.new( :labeling_job_name, :label_attribute_name, :input_config, :output_config, :role_arn, :label_category_config_s3_uri, :stopping_conditions, :labeling_job_algorithms_config, :human_task_config, :tags) include Aws::Structure end |
#labeling_job_name ⇒ String
The name of the labeling job. This name is used to identify the job in a list of labeling jobs.
1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 |
# File 'lib/aws-sdk-sagemaker/types.rb', line 1834 class CreateLabelingJobRequest < Struct.new( :labeling_job_name, :label_attribute_name, :input_config, :output_config, :role_arn, :label_category_config_s3_uri, :stopping_conditions, :labeling_job_algorithms_config, :human_task_config, :tags) include Aws::Structure end |
#output_config ⇒ Types::LabelingJobOutputConfig
The location of the output data and the AWS Key Management Service key ID for the key used to encrypt the output data, if any.
1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 |
# File 'lib/aws-sdk-sagemaker/types.rb', line 1834 class CreateLabelingJobRequest < Struct.new( :labeling_job_name, :label_attribute_name, :input_config, :output_config, :role_arn, :label_category_config_s3_uri, :stopping_conditions, :labeling_job_algorithms_config, :human_task_config, :tags) include Aws::Structure end |
#role_arn ⇒ String
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.
1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 |
# File 'lib/aws-sdk-sagemaker/types.rb', line 1834 class CreateLabelingJobRequest < Struct.new( :labeling_job_name, :label_attribute_name, :input_config, :output_config, :role_arn, :label_category_config_s3_uri, :stopping_conditions, :labeling_job_algorithms_config, :human_task_config, :tags) include Aws::Structure end |
#stopping_conditions ⇒ Types::LabelingJobStoppingConditions
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.
1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 |
# File 'lib/aws-sdk-sagemaker/types.rb', line 1834 class CreateLabelingJobRequest < Struct.new( :labeling_job_name, :label_attribute_name, :input_config, :output_config, :role_arn, :label_category_config_s3_uri, :stopping_conditions, :labeling_job_algorithms_config, :human_task_config, :tags) include Aws::Structure end |
#tags ⇒ Array<Types::Tag>
An array of key/value pairs. For more information, see [Using Cost Allocation Tags] in the *AWS Billing and Cost Management User Guide*.
[1]: docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what
1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 |
# File 'lib/aws-sdk-sagemaker/types.rb', line 1834 class CreateLabelingJobRequest < Struct.new( :labeling_job_name, :label_attribute_name, :input_config, :output_config, :role_arn, :label_category_config_s3_uri, :stopping_conditions, :labeling_job_algorithms_config, :human_task_config, :tags) include Aws::Structure end |