software.amazon.awssdk.services.sagemaker.model

Class HumanTaskConfig

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.HumanTaskConfig

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<HumanTaskConfig.Builder,HumanTaskConfig>

@Generated(value="software.amazon.awssdk:codegen")
public final class HumanTaskConfig
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<HumanTaskConfig.Builder,HumanTaskConfig>

Information required for human workers to complete a labeling task.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	HumanTaskConfig.Builder

Method Summary

Modifier and Type	Method and Description
AnnotationConsolidationConfig	annotationConsolidationConfig() Configures how labels are consolidated across human workers.
static HumanTaskConfig.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxConcurrentTaskCount() Defines the maximum number of data objects that can be labeled by human workers at the same time.
Integer	numberOfHumanWorkersPerDataObject() The number of human workers that will label an object.
String	preHumanTaskLambdaArn() The Amazon Resource Name (ARN) of a Lambda function that is run before a data object is sent to a human worker.
PublicWorkforceTaskPrice	publicWorkforceTaskPrice() The price that you pay for each task performed by an Amazon Mechanical Turk worker.
List<SdkField<?>>	sdkFields()
static Class<? extends HumanTaskConfig.Builder>	serializableBuilderClass()
Integer	taskAvailabilityLifetimeInSeconds() The length of time that a task remains available for labeling by human workers.
String	taskDescription() A description of the task for your human workers.
List<String>	taskKeywords() Keywords used to describe the task so that workers on Amazon Mechanical Turk can discover the task.
Integer	taskTimeLimitInSeconds() The amount of time that a worker has to complete a task.
String	taskTitle() A title for the task for your human workers.
HumanTaskConfig.Builder	toBuilder()
String	toString() Returns a string representation of this object.
UiConfig	uiConfig() Information about the user interface that workers use to complete the labeling task.
String	workteamArn() The Amazon Resource Name (ARN) of the work team assigned to complete the tasks.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

workteamArn

public String workteamArn()

The Amazon Resource Name (ARN) of the work team assigned to complete the tasks.

Returns:

The Amazon Resource Name (ARN) of the work team assigned to complete the tasks.

uiConfig

public UiConfig uiConfig()

Information about the user interface that workers use to complete the labeling task.

Returns:

Information about the user interface that workers use to complete the labeling task.

preHumanTaskLambdaArn

public String preHumanTaskLambdaArn()

The Amazon Resource Name (ARN) of a Lambda function that is run before a data object is sent to a human worker. Use this function to provide input to a custom labeling job.

For the built-in bounding box, image classification, semantic segmentation, and text classification task types, Amazon SageMaker Ground Truth provides the following Lambda functions:

US East (Northern Virginia) (us-east-1):

• arn:aws:lambda:us-east-1:432418664414:function:PRE-BoundingBox

• arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClass

• arn:aws:lambda:us-east-1:432418664414:function:PRE-SemanticSegmentation

• arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClass

• arn:aws:lambda:us-east-1:432418664414:function:PRE-NamedEntityRecognition

US East (Ohio) (us-east-2):

• arn:aws:lambda:us-east-2:266458841044:function:PRE-BoundingBox

• arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClass

• arn:aws:lambda:us-east-2:266458841044:function:PRE-SemanticSegmentation

• arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClass

• arn:aws:lambda:us-east-2:266458841044:function:PRE-NamedEntityRecognition

US West (Oregon) (us-west-2):

• arn:aws:lambda:us-west-2:081040173940:function:PRE-BoundingBox

• arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClass

• arn:aws:lambda:us-west-2:081040173940:function:PRE-SemanticSegmentation

• arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClass

• arn:aws:lambda:us-west-2:081040173940:function:PRE-NamedEntityRecognition

Canada (Central) (ca-central-1):

• arn:awslambda:ca-central-1:918755190332:function:PRE-BoundingBox

• arn:awslambda:ca-central-1:918755190332:function:PRE-ImageMultiClass

• arn:awslambda:ca-central-1:918755190332:function:PRE-SemanticSegmentation

• arn:awslambda:ca-central-1:918755190332:function:PRE-TextMultiClass

• arn:awslambda:ca-central-1:918755190332:function:PRE-NamedEntityRecognition

EU (Ireland) (eu-west-1):

• arn:aws:lambda:eu-west-1:568282634449:function:PRE-BoundingBox

• arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClass

• arn:aws:lambda:eu-west-1:568282634449:function:PRE-SemanticSegmentation

• arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClass

• arn:aws:lambda:eu-west-1:568282634449:function:PRE-NamedEntityRecognition

EU (London) (eu-west-2):

• arn:awslambda:eu-west-2:487402164563:function:PRE-BoundingBox

• arn:awslambda:eu-west-2:487402164563:function:PRE-ImageMultiClass

• arn:awslambda:eu-west-2:487402164563:function:PRE-SemanticSegmentation

• arn:awslambda:eu-west-2:487402164563:function:PRE-TextMultiClass

• arn:awslambda:eu-west-2:487402164563:function:PRE-NamedEntityRecognition

EU Frankfurt (eu-central-1):

• arn:awslambda:eu-central-1:203001061592:function:PRE-BoundingBox

• arn:awslambda:eu-central-1:203001061592:function:PRE-ImageMultiClass

• arn:awslambda:eu-central-1:203001061592:function:PRE-SemanticSegmentation

• arn:awslambda:eu-central-1:203001061592:function:PRE-TextMultiClass

• arn:awslambda:eu-central-1:203001061592:function:PRE-NamedEntityRecognition

Asia Pacific (Tokyo) (ap-northeast-1):

• arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-BoundingBox

• arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClass

• arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-SemanticSegmentation

• arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClass

• arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-NamedEntityRecognition

Asia Pacific (Seoul) (ap-northeast-2):

• arn:awslambda:ap-northeast-2:845288260483:function:PRE-BoundingBox

• arn:awslambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClass

• arn:awslambda:ap-northeast-2:845288260483:function:PRE-SemanticSegmentation

• arn:awslambda:ap-northeast-2:845288260483:function:PRE-TextMultiClass

• arn:awslambda:ap-northeast-2:845288260483:function:PRE-NamedEntityRecognition

Asia Pacific (Mumbai) (ap-south-1):

• arn:awslambda:ap-south-1:565803892007:function:PRE-BoundingBox

• arn:awslambda:ap-south-1:565803892007:function:PRE-ImageMultiClass

• arn:awslambda:ap-south-1:565803892007:function:PRE-SemanticSegmentation

• arn:awslambda:ap-south-1:565803892007:function:PRE-TextMultiClass

• arn:awslambda:ap-south-1:565803892007:function:PRE-NamedEntityRecognition

Asia Pacific (Singapore) (ap-southeast-1):

• arn:awslambda:ap-southeast-1:377565633583:function:PRE-BoundingBox

• arn:awslambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClass

• arn:awslambda:ap-southeast-1:377565633583:function:PRE-SemanticSegmentation

• arn:awslambda:ap-southeast-1:377565633583:function:PRE-TextMultiClass

• arn:awslambda:ap-southeast-1:377565633583:function:PRE-NamedEntityRecognition

Asia Pacific (Sydney) (ap-southeast-2):

• arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-BoundingBox

• arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-ImageMultiClass

• arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-SemanticSegmentation

• arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClass

• arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-NamedEntityRecognition

Returns:

The Amazon Resource Name (ARN) of a Lambda function that is run before a data object is sent to a human worker. Use this function to provide input to a custom labeling job.

For the built-in bounding box, image classification, semantic segmentation, and text classification task types, Amazon SageMaker Ground Truth provides the following Lambda functions:

US East (Northern Virginia) (us-east-1):

• arn:aws:lambda:us-east-1:432418664414:function:PRE-BoundingBox

• arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClass

• arn:aws:lambda:us-east-1:432418664414:function:PRE-SemanticSegmentation

• arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClass

• arn:aws:lambda:us-east-1:432418664414:function:PRE-NamedEntityRecognition

US East (Ohio) (us-east-2):

• arn:aws:lambda:us-east-2:266458841044:function:PRE-BoundingBox

• arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClass

• arn:aws:lambda:us-east-2:266458841044:function:PRE-SemanticSegmentation

• arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClass

• arn:aws:lambda:us-east-2:266458841044:function:PRE-NamedEntityRecognition

US West (Oregon) (us-west-2):

• arn:aws:lambda:us-west-2:081040173940:function:PRE-BoundingBox

• arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClass

• arn:aws:lambda:us-west-2:081040173940:function:PRE-SemanticSegmentation

• arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClass

• arn:aws:lambda:us-west-2:081040173940:function:PRE-NamedEntityRecognition

Canada (Central) (ca-central-1):

• arn:awslambda:ca-central-1:918755190332:function:PRE-BoundingBox

• arn:awslambda:ca-central-1:918755190332:function:PRE-ImageMultiClass

• arn:awslambda:ca-central-1:918755190332:function:PRE-SemanticSegmentation

• arn:awslambda:ca-central-1:918755190332:function:PRE-TextMultiClass

• arn:awslambda:ca-central-1:918755190332:function:PRE-NamedEntityRecognition

EU (Ireland) (eu-west-1):

• arn:aws:lambda:eu-west-1:568282634449:function:PRE-BoundingBox

• arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClass

• arn:aws:lambda:eu-west-1:568282634449:function:PRE-SemanticSegmentation

• arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClass

• arn:aws:lambda:eu-west-1:568282634449:function:PRE-NamedEntityRecognition

EU (London) (eu-west-2):

• arn:awslambda:eu-west-2:487402164563:function:PRE-BoundingBox

• arn:awslambda:eu-west-2:487402164563:function:PRE-ImageMultiClass

• arn:awslambda:eu-west-2:487402164563:function:PRE-SemanticSegmentation

• arn:awslambda:eu-west-2:487402164563:function:PRE-TextMultiClass

• arn:awslambda:eu-west-2:487402164563:function:PRE-NamedEntityRecognition

EU Frankfurt (eu-central-1):

• arn:awslambda:eu-central-1:203001061592:function:PRE-BoundingBox

• arn:awslambda:eu-central-1:203001061592:function:PRE-ImageMultiClass

• arn:awslambda:eu-central-1:203001061592:function:PRE-SemanticSegmentation

• arn:awslambda:eu-central-1:203001061592:function:PRE-TextMultiClass

• arn:awslambda:eu-central-1:203001061592:function:PRE-NamedEntityRecognition

Asia Pacific (Tokyo) (ap-northeast-1):

• arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-BoundingBox

• arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClass

• arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-SemanticSegmentation

• arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClass

• arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-NamedEntityRecognition

Asia Pacific (Seoul) (ap-northeast-2):

• arn:awslambda:ap-northeast-2:845288260483:function:PRE-BoundingBox

• arn:awslambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClass

• arn:awslambda:ap-northeast-2:845288260483:function:PRE-SemanticSegmentation

• arn:awslambda:ap-northeast-2:845288260483:function:PRE-TextMultiClass

• arn:awslambda:ap-northeast-2:845288260483:function:PRE-NamedEntityRecognition

Asia Pacific (Mumbai) (ap-south-1):

• arn:awslambda:ap-south-1:565803892007:function:PRE-BoundingBox

• arn:awslambda:ap-south-1:565803892007:function:PRE-ImageMultiClass

• arn:awslambda:ap-south-1:565803892007:function:PRE-SemanticSegmentation

• arn:awslambda:ap-south-1:565803892007:function:PRE-TextMultiClass

• arn:awslambda:ap-south-1:565803892007:function:PRE-NamedEntityRecognition

Asia Pacific (Singapore) (ap-southeast-1):

• arn:awslambda:ap-southeast-1:377565633583:function:PRE-BoundingBox

• arn:awslambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClass

• arn:awslambda:ap-southeast-1:377565633583:function:PRE-SemanticSegmentation

• arn:awslambda:ap-southeast-1:377565633583:function:PRE-TextMultiClass

• arn:awslambda:ap-southeast-1:377565633583:function:PRE-NamedEntityRecognition

Asia Pacific (Sydney) (ap-southeast-2):

• arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-BoundingBox

• arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-ImageMultiClass

• arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-SemanticSegmentation

• arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClass

• arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-NamedEntityRecognition

taskKeywords

public List<String> taskKeywords()

Keywords used to describe the task so that workers on Amazon Mechanical Turk can discover the task.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

Keywords used to describe the task so that workers on Amazon Mechanical Turk can discover the task.

taskTitle

public String taskTitle()

A title for the task for your human workers.

Returns:

A title for the task for your human workers.

taskDescription

public String taskDescription()

A description of the task for your human workers.

Returns:

A description of the task for your human workers.

numberOfHumanWorkersPerDataObject

public Integer numberOfHumanWorkersPerDataObject()

The number of human workers that will label an object.

Returns:

The number of human workers that will label an object.

taskTimeLimitInSeconds

public Integer taskTimeLimitInSeconds()

The amount of time that a worker has to complete a task.

Returns:

The amount of time that a worker has to complete a task.

taskAvailabilityLifetimeInSeconds

public Integer taskAvailabilityLifetimeInSeconds()

The length of time that a task remains available for labeling by human workers. If you choose the Amazon Mechanical Turk workforce, the maximum is 12 hours (43200). For private and vendor workforces, the maximum is as listed.

Returns:

The length of time that a task remains available for labeling by human workers. If you choose the Amazon Mechanical Turk workforce, the maximum is 12 hours (43200). For private and vendor workforces, the maximum is as listed.

maxConcurrentTaskCount

public Integer maxConcurrentTaskCount()

Defines the maximum number of data objects that can be labeled by human workers at the same time. Each object may have more than one worker at one time.

Returns:

Defines the maximum number of data objects that can be labeled by human workers at the same time. Each object may have more than one worker at one time.

annotationConsolidationConfig

public AnnotationConsolidationConfig annotationConsolidationConfig()

Configures how labels are consolidated across human workers.

Returns:

Configures how labels are consolidated across human workers.

publicWorkforceTaskPrice

public PublicWorkforceTaskPrice publicWorkforceTaskPrice()

The price that you pay for each task performed by an Amazon Mechanical Turk worker.

Returns:

The price that you pay for each task performed by an Amazon Mechanical Turk worker.

toBuilder

public HumanTaskConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<HumanTaskConfig.Builder,HumanTaskConfig>

builder

public static HumanTaskConfig.Builder builder()

serializableBuilderClass

public static Class<? extends HumanTaskConfig.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo