Class UiConfig

java.lang.Object
software.amazon.awssdk.services.sagemaker.model.UiConfig
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<UiConfig.Builder,UiConfig>
@Generated("software.amazon.awssdk:codegen") public final class UiConfig extends Object implements SdkPojo, Serializable, ToCopyableBuilder<UiConfig.Builder,UiConfig>

Provided configuration information for the worker UI for a labeling job. Provide either HumanTaskUiArn or UiTemplateS3Uri.

For named entity recognition, 3D point cloud and video frame labeling jobs, use HumanTaskUiArn.

For all other Ground Truth built-in task types and custom task types, use UiTemplateS3Uri to specify the location of a worker task template in Amazon S3.

See Also:

  • Method Details

    • uiTemplateS3Uri

      public final String uiTemplateS3Uri()

      The Amazon S3 bucket location of the UI template, or worker task template. This is the template used to render the worker UI and tools for labeling job tasks. For more information about the contents of a UI template, see Creating Your Custom Labeling Task Template.

      Returns:
      The Amazon S3 bucket location of the UI template, or worker task template. This is the template used to render the worker UI and tools for labeling job tasks. For more information about the contents of a UI template, see Creating Your Custom Labeling Task Template.

    • humanTaskUiArn

      public final String humanTaskUiArn()

      The ARN of the worker task template used to render the worker UI and tools for labeling job tasks.

      Use this parameter when you are creating a labeling job for named entity recognition, 3D point cloud and video frame labeling jobs. Use your labeling job task type to select one of the following ARNs and use it with this parameter when you create a labeling job. Replace aws-region with the Amazon Web Services Region you are creating your labeling job in. For example, replace aws-region with us-west-1 if you create a labeling job in US West (N. California).

      Named Entity Recognition

      Use the following HumanTaskUiArn for named entity recognition labeling jobs:

      arn:aws:sagemaker:aws-region:394669845002:human-task-ui/NamedEntityRecognition

      3D Point Cloud HumanTaskUiArns

      Use this HumanTaskUiArn for 3D point cloud object detection and 3D point cloud object detection adjustment labeling jobs.

      • arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudObjectDetection

      Use this HumanTaskUiArn for 3D point cloud object tracking and 3D point cloud object tracking adjustment labeling jobs.

      • arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudObjectTracking

      Use this HumanTaskUiArn for 3D point cloud semantic segmentation and 3D point cloud semantic segmentation adjustment labeling jobs.

      • arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudSemanticSegmentation

      Video Frame HumanTaskUiArns

      Use this HumanTaskUiArn for video frame object detection and video frame object detection adjustment labeling jobs.

      • arn:aws:sagemaker:region:394669845002:human-task-ui/VideoObjectDetection

      Use this HumanTaskUiArn for video frame object tracking and video frame object tracking adjustment labeling jobs.

      • arn:aws:sagemaker:aws-region:394669845002:human-task-ui/VideoObjectTracking

      Returns:
      The ARN of the worker task template used to render the worker UI and tools for labeling job tasks.

      Use this parameter when you are creating a labeling job for named entity recognition, 3D point cloud and video frame labeling jobs. Use your labeling job task type to select one of the following ARNs and use it with this parameter when you create a labeling job. Replace aws-region with the Amazon Web Services Region you are creating your labeling job in. For example, replace aws-region with us-west-1 if you create a labeling job in US West (N. California).

      Named Entity Recognition

      Use the following HumanTaskUiArn for named entity recognition labeling jobs:

      arn:aws:sagemaker:aws-region:394669845002:human-task-ui/NamedEntityRecognition

      3D Point Cloud HumanTaskUiArns

      Use this HumanTaskUiArn for 3D point cloud object detection and 3D point cloud object detection adjustment labeling jobs.

      • arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudObjectDetection

      Use this HumanTaskUiArn for 3D point cloud object tracking and 3D point cloud object tracking adjustment labeling jobs.

      • arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudObjectTracking

      Use this HumanTaskUiArn for 3D point cloud semantic segmentation and 3D point cloud semantic segmentation adjustment labeling jobs.

      • arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudSemanticSegmentation

      Video Frame HumanTaskUiArns

      Use this HumanTaskUiArn for video frame object detection and video frame object detection adjustment labeling jobs.

      • arn:aws:sagemaker:region:394669845002:human-task-ui/VideoObjectDetection

      Use this HumanTaskUiArn for video frame object tracking and video frame object tracking adjustment labeling jobs.

      • arn:aws:sagemaker:aws-region:394669845002:human-task-ui/VideoObjectTracking

    • toBuilder

      public UiConfig.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<UiConfig.Builder,UiConfig>
      Returns:
      a builder for type T

    • builder

      public static UiConfig.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final 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 final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.