Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.SageMaker.Types.UiConfig

Description

Synopsis

data UiConfig = UiConfig' {
- humanTaskUiArn :: Maybe Text
- uiTemplateS3Uri :: Maybe Text
}
newUiConfig :: UiConfig
uiConfig_humanTaskUiArn :: Lens' UiConfig (Maybe Text)
uiConfig_uiTemplateS3Uri :: Lens' UiConfig (Maybe Text)

Documentation

data UiConfig Source #

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: newUiConfig smart constructor.

Constructors

UiConfig'

Fields

humanTaskUiArn :: Maybe Text
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
```
uiTemplateS3Uri :: Maybe Text
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.

Instances

Instances details

FromJSON UiConfig Source #
Instance details Defined in Amazonka.SageMaker.Types.UiConfig Methods parseJSON :: Value -> Parser UiConfig # parseJSONList :: Value -> Parser [UiConfig] #
ToJSON UiConfig Source #
Instance details Defined in Amazonka.SageMaker.Types.UiConfig Methods toJSON :: UiConfig -> Value # toEncoding :: UiConfig -> Encoding # toJSONList :: [UiConfig] -> Value # toEncodingList :: [UiConfig] -> Encoding #
Generic UiConfig Source #
Instance details Defined in Amazonka.SageMaker.Types.UiConfig Associated Types type Rep UiConfig :: Type -> Type # Methods from :: UiConfig -> Rep UiConfig x # to :: Rep UiConfig x -> UiConfig #
Read UiConfig Source #
Instance details Defined in Amazonka.SageMaker.Types.UiConfig Methods readsPrec :: Int -> ReadS UiConfig # readList :: ReadS [UiConfig] # readPrec :: ReadPrec UiConfig # readListPrec :: ReadPrec [UiConfig] #
Show UiConfig Source #
Instance details Defined in Amazonka.SageMaker.Types.UiConfig Methods showsPrec :: Int -> UiConfig -> ShowS # show :: UiConfig -> String # showList :: [UiConfig] -> ShowS #
NFData UiConfig Source #
Instance details Defined in Amazonka.SageMaker.Types.UiConfig Methods rnf :: UiConfig -> () #
Eq UiConfig Source #
Instance details Defined in Amazonka.SageMaker.Types.UiConfig Methods (==) :: UiConfig -> UiConfig -> Bool # (/=) :: UiConfig -> UiConfig -> Bool #
Hashable UiConfig Source #
Instance details Defined in Amazonka.SageMaker.Types.UiConfig Methods hashWithSalt :: Int -> UiConfig -> Int # hash :: UiConfig -> Int #
type Rep UiConfig Source #
Instance details Defined in Amazonka.SageMaker.Types.UiConfig type Rep UiConfig = D1 ('MetaData "UiConfig" "Amazonka.SageMaker.Types.UiConfig" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "UiConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "humanTaskUiArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "uiTemplateS3Uri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newUiConfig :: UiConfig Source #

Create a value of UiConfig with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:humanTaskUiArn:UiConfig', uiConfig_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

$sel:uiTemplateS3Uri:UiConfig', uiConfig_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.

uiConfig_humanTaskUiArn :: Lens' UiConfig (Maybe Text) Source #

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