1. Packages
  2. AWS Classic
  3. API Docs
  4. sagemaker
  5. HumanTaskUI

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.44.0 published on Monday, Jul 8, 2024 by Pulumi

aws.sagemaker.HumanTaskUI

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.44.0 published on Monday, Jul 8, 2024 by Pulumi

    Provides a SageMaker Human Task UI resource.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    import * as std from "@pulumi/std";
    
    const example = new aws.sagemaker.HumanTaskUI("example", {
        humanTaskUiName: "example",
        uiTemplate: {
            content: std.file({
                input: "sagemaker-human-task-ui-template.html",
            }).then(invoke => invoke.result),
        },
    });
    
    import pulumi
    import pulumi_aws as aws
    import pulumi_std as std
    
    example = aws.sagemaker.HumanTaskUI("example",
        human_task_ui_name="example",
        ui_template={
            "content": std.file(input="sagemaker-human-task-ui-template.html").result,
        })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/sagemaker"
    	"github.com/pulumi/pulumi-std/sdk/go/std"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		invokeFile, err := std.File(ctx, &std.FileArgs{
    			Input: "sagemaker-human-task-ui-template.html",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = sagemaker.NewHumanTaskUI(ctx, "example", &sagemaker.HumanTaskUIArgs{
    			HumanTaskUiName: pulumi.String("example"),
    			UiTemplate: &sagemaker.HumanTaskUIUiTemplateArgs{
    				Content: invokeFile.Result,
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    using Std = Pulumi.Std;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Aws.Sagemaker.HumanTaskUI("example", new()
        {
            HumanTaskUiName = "example",
            UiTemplate = new Aws.Sagemaker.Inputs.HumanTaskUIUiTemplateArgs
            {
                Content = Std.File.Invoke(new()
                {
                    Input = "sagemaker-human-task-ui-template.html",
                }).Apply(invoke => invoke.Result),
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.sagemaker.HumanTaskUI;
    import com.pulumi.aws.sagemaker.HumanTaskUIArgs;
    import com.pulumi.aws.sagemaker.inputs.HumanTaskUIUiTemplateArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var example = new HumanTaskUI("example", HumanTaskUIArgs.builder()
                .humanTaskUiName("example")
                .uiTemplate(HumanTaskUIUiTemplateArgs.builder()
                    .content(StdFunctions.file(FileArgs.builder()
                        .input("sagemaker-human-task-ui-template.html")
                        .build()).result())
                    .build())
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:sagemaker:HumanTaskUI
        properties:
          humanTaskUiName: example
          uiTemplate:
            content:
              fn::invoke:
                Function: std:file
                Arguments:
                  input: sagemaker-human-task-ui-template.html
                Return: result
    

    Create HumanTaskUI Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new HumanTaskUI(name: string, args: HumanTaskUIArgs, opts?: CustomResourceOptions);
    @overload
    def HumanTaskUI(resource_name: str,
                    args: HumanTaskUIArgs,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def HumanTaskUI(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    human_task_ui_name: Optional[str] = None,
                    ui_template: Optional[HumanTaskUIUiTemplateArgs] = None,
                    tags: Optional[Mapping[str, str]] = None)
    func NewHumanTaskUI(ctx *Context, name string, args HumanTaskUIArgs, opts ...ResourceOption) (*HumanTaskUI, error)
    public HumanTaskUI(string name, HumanTaskUIArgs args, CustomResourceOptions? opts = null)
    public HumanTaskUI(String name, HumanTaskUIArgs args)
    public HumanTaskUI(String name, HumanTaskUIArgs args, CustomResourceOptions options)
    
    type: aws:sagemaker:HumanTaskUI
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args HumanTaskUIArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args HumanTaskUIArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args HumanTaskUIArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args HumanTaskUIArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args HumanTaskUIArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var humanTaskUIResource = new Aws.Sagemaker.HumanTaskUI("humanTaskUIResource", new()
    {
        HumanTaskUiName = "string",
        UiTemplate = new Aws.Sagemaker.Inputs.HumanTaskUIUiTemplateArgs
        {
            Content = "string",
            ContentSha256 = "string",
            Url = "string",
        },
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := sagemaker.NewHumanTaskUI(ctx, "humanTaskUIResource", &sagemaker.HumanTaskUIArgs{
    	HumanTaskUiName: pulumi.String("string"),
    	UiTemplate: &sagemaker.HumanTaskUIUiTemplateArgs{
    		Content:       pulumi.String("string"),
    		ContentSha256: pulumi.String("string"),
    		Url:           pulumi.String("string"),
    	},
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var humanTaskUIResource = new HumanTaskUI("humanTaskUIResource", HumanTaskUIArgs.builder()
        .humanTaskUiName("string")
        .uiTemplate(HumanTaskUIUiTemplateArgs.builder()
            .content("string")
            .contentSha256("string")
            .url("string")
            .build())
        .tags(Map.of("string", "string"))
        .build());
    
    human_task_ui_resource = aws.sagemaker.HumanTaskUI("humanTaskUIResource",
        human_task_ui_name="string",
        ui_template={
            "content": "string",
            "contentSha256": "string",
            "url": "string",
        },
        tags={
            "string": "string",
        })
    
    const humanTaskUIResource = new aws.sagemaker.HumanTaskUI("humanTaskUIResource", {
        humanTaskUiName: "string",
        uiTemplate: {
            content: "string",
            contentSha256: "string",
            url: "string",
        },
        tags: {
            string: "string",
        },
    });
    
    type: aws:sagemaker:HumanTaskUI
    properties:
        humanTaskUiName: string
        tags:
            string: string
        uiTemplate:
            content: string
            contentSha256: string
            url: string
    

    HumanTaskUI Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The HumanTaskUI resource accepts the following input properties:

    HumanTaskUiName string
    The name of the Human Task UI.
    UiTemplate Pulumi.Aws.Sagemaker.Inputs.HumanTaskUIUiTemplate
    The Liquid template for the worker user interface. See UI Template below.
    Tags Dictionary<string, string>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    HumanTaskUiName string
    The name of the Human Task UI.
    UiTemplate HumanTaskUIUiTemplateArgs
    The Liquid template for the worker user interface. See UI Template below.
    Tags map[string]string
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    humanTaskUiName String
    The name of the Human Task UI.
    uiTemplate HumanTaskUIUiTemplate
    The Liquid template for the worker user interface. See UI Template below.
    tags Map<String,String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    humanTaskUiName string
    The name of the Human Task UI.
    uiTemplate HumanTaskUIUiTemplate
    The Liquid template for the worker user interface. See UI Template below.
    tags {[key: string]: string}
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    human_task_ui_name str
    The name of the Human Task UI.
    ui_template HumanTaskUIUiTemplateArgs
    The Liquid template for the worker user interface. See UI Template below.
    tags Mapping[str, str]
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    humanTaskUiName String
    The name of the Human Task UI.
    uiTemplate Property Map
    The Liquid template for the worker user interface. See UI Template below.
    tags Map<String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the HumanTaskUI resource produces the following output properties:

    Arn string
    The Amazon Resource Name (ARN) assigned by AWS to this Human Task UI.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    The Amazon Resource Name (ARN) assigned by AWS to this Human Task UI.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The Amazon Resource Name (ARN) assigned by AWS to this Human Task UI.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    The Amazon Resource Name (ARN) assigned by AWS to this Human Task UI.
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    The Amazon Resource Name (ARN) assigned by AWS to this Human Task UI.
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The Amazon Resource Name (ARN) assigned by AWS to this Human Task UI.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing HumanTaskUI Resource

    Get an existing HumanTaskUI resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: HumanTaskUIState, opts?: CustomResourceOptions): HumanTaskUI
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            arn: Optional[str] = None,
            human_task_ui_name: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None,
            ui_template: Optional[HumanTaskUIUiTemplateArgs] = None) -> HumanTaskUI
    func GetHumanTaskUI(ctx *Context, name string, id IDInput, state *HumanTaskUIState, opts ...ResourceOption) (*HumanTaskUI, error)
    public static HumanTaskUI Get(string name, Input<string> id, HumanTaskUIState? state, CustomResourceOptions? opts = null)
    public static HumanTaskUI get(String name, Output<String> id, HumanTaskUIState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    The Amazon Resource Name (ARN) assigned by AWS to this Human Task UI.
    HumanTaskUiName string
    The name of the Human Task UI.
    Tags Dictionary<string, string>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    UiTemplate Pulumi.Aws.Sagemaker.Inputs.HumanTaskUIUiTemplate
    The Liquid template for the worker user interface. See UI Template below.
    Arn string
    The Amazon Resource Name (ARN) assigned by AWS to this Human Task UI.
    HumanTaskUiName string
    The name of the Human Task UI.
    Tags map[string]string
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    UiTemplate HumanTaskUIUiTemplateArgs
    The Liquid template for the worker user interface. See UI Template below.
    arn String
    The Amazon Resource Name (ARN) assigned by AWS to this Human Task UI.
    humanTaskUiName String
    The name of the Human Task UI.
    tags Map<String,String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    uiTemplate HumanTaskUIUiTemplate
    The Liquid template for the worker user interface. See UI Template below.
    arn string
    The Amazon Resource Name (ARN) assigned by AWS to this Human Task UI.
    humanTaskUiName string
    The name of the Human Task UI.
    tags {[key: string]: string}
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    uiTemplate HumanTaskUIUiTemplate
    The Liquid template for the worker user interface. See UI Template below.
    arn str
    The Amazon Resource Name (ARN) assigned by AWS to this Human Task UI.
    human_task_ui_name str
    The name of the Human Task UI.
    tags Mapping[str, str]
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    ui_template HumanTaskUIUiTemplateArgs
    The Liquid template for the worker user interface. See UI Template below.
    arn String
    The Amazon Resource Name (ARN) assigned by AWS to this Human Task UI.
    humanTaskUiName String
    The name of the Human Task UI.
    tags Map<String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    uiTemplate Property Map
    The Liquid template for the worker user interface. See UI Template below.

    Supporting Types

    HumanTaskUIUiTemplate, HumanTaskUIUiTemplateArgs

    Content string
    The content of the Liquid template for the worker user interface.
    ContentSha256 string
    The SHA-256 digest of the contents of the template.
    Url string
    The URL for the user interface template.
    Content string
    The content of the Liquid template for the worker user interface.
    ContentSha256 string
    The SHA-256 digest of the contents of the template.
    Url string
    The URL for the user interface template.
    content String
    The content of the Liquid template for the worker user interface.
    contentSha256 String
    The SHA-256 digest of the contents of the template.
    url String
    The URL for the user interface template.
    content string
    The content of the Liquid template for the worker user interface.
    contentSha256 string
    The SHA-256 digest of the contents of the template.
    url string
    The URL for the user interface template.
    content str
    The content of the Liquid template for the worker user interface.
    content_sha256 str
    The SHA-256 digest of the contents of the template.
    url str
    The URL for the user interface template.
    content String
    The content of the Liquid template for the worker user interface.
    contentSha256 String
    The SHA-256 digest of the contents of the template.
    url String
    The URL for the user interface template.

    Import

    Using pulumi import, import SageMaker Human Task UIs using the human_task_ui_name. For example:

    $ pulumi import aws:sagemaker/humanTaskUI:HumanTaskUI example example
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.44.0 published on Monday, Jul 8, 2024 by Pulumi