/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.sagemaker.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *

* 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 AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class UiConfig implements Serializable, Cloneable, StructuredPojo { /** *

* 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. *

*/ private String uiTemplateS3Uri; /** *

* 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. *

* *

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

* *

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

* *

* Video Frame HumanTaskUiArns *

*

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

* *

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

* */ private String humanTaskUiArn; /** *

* 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. *

* * @param 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. */ public void setUiTemplateS3Uri(String uiTemplateS3Uri) { this.uiTemplateS3Uri = 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. *

* * @return 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. */ public String getUiTemplateS3Uri() { return this.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. *

* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public UiConfig withUiTemplateS3Uri(String uiTemplateS3Uri) { setUiTemplateS3Uri(uiTemplateS3Uri); return this; } /** *

* 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. *

* *

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

* *

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

* *

* Video Frame HumanTaskUiArns *

*

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

* *

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

* * * @param 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. *

* *

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

* *

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

* *

* Video Frame HumanTaskUiArns *

*

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

* *

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

*