aws.sagemaker.FlowDefinition
Explore with Pulumi AI
Provides a SageMaker AI Flow Definition resource.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.sagemaker.FlowDefinition("example", {
flowDefinitionName: "example",
roleArn: exampleAwsIamRole.arn,
humanLoopConfig: {
humanTaskUiArn: exampleAwsSagemakerHumanTaskUi.arn,
taskAvailabilityLifetimeInSeconds: 1,
taskCount: 1,
taskDescription: "example",
taskTitle: "example",
workteamArn: exampleAwsSagemakerWorkteam.arn,
},
outputConfig: {
s3OutputPath: `s3://${exampleAwsS3Bucket.bucket}/`,
},
});
import pulumi
import pulumi_aws as aws
example = aws.sagemaker.FlowDefinition("example",
flow_definition_name="example",
role_arn=example_aws_iam_role["arn"],
human_loop_config={
"human_task_ui_arn": example_aws_sagemaker_human_task_ui["arn"],
"task_availability_lifetime_in_seconds": 1,
"task_count": 1,
"task_description": "example",
"task_title": "example",
"workteam_arn": example_aws_sagemaker_workteam["arn"],
},
output_config={
"s3_output_path": f"s3://{example_aws_s3_bucket['bucket']}/",
})
package main
import (
"fmt"
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/sagemaker"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := sagemaker.NewFlowDefinition(ctx, "example", &sagemaker.FlowDefinitionArgs{
FlowDefinitionName: pulumi.String("example"),
RoleArn: pulumi.Any(exampleAwsIamRole.Arn),
HumanLoopConfig: &sagemaker.FlowDefinitionHumanLoopConfigArgs{
HumanTaskUiArn: pulumi.Any(exampleAwsSagemakerHumanTaskUi.Arn),
TaskAvailabilityLifetimeInSeconds: pulumi.Int(1),
TaskCount: pulumi.Int(1),
TaskDescription: pulumi.String("example"),
TaskTitle: pulumi.String("example"),
WorkteamArn: pulumi.Any(exampleAwsSagemakerWorkteam.Arn),
},
OutputConfig: &sagemaker.FlowDefinitionOutputConfigArgs{
S3OutputPath: pulumi.Sprintf("s3://%v/", exampleAwsS3Bucket.Bucket),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Sagemaker.FlowDefinition("example", new()
{
FlowDefinitionName = "example",
RoleArn = exampleAwsIamRole.Arn,
HumanLoopConfig = new Aws.Sagemaker.Inputs.FlowDefinitionHumanLoopConfigArgs
{
HumanTaskUiArn = exampleAwsSagemakerHumanTaskUi.Arn,
TaskAvailabilityLifetimeInSeconds = 1,
TaskCount = 1,
TaskDescription = "example",
TaskTitle = "example",
WorkteamArn = exampleAwsSagemakerWorkteam.Arn,
},
OutputConfig = new Aws.Sagemaker.Inputs.FlowDefinitionOutputConfigArgs
{
S3OutputPath = $"s3://{exampleAwsS3Bucket.Bucket}/",
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.sagemaker.FlowDefinition;
import com.pulumi.aws.sagemaker.FlowDefinitionArgs;
import com.pulumi.aws.sagemaker.inputs.FlowDefinitionHumanLoopConfigArgs;
import com.pulumi.aws.sagemaker.inputs.FlowDefinitionOutputConfigArgs;
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 FlowDefinition("example", FlowDefinitionArgs.builder()
.flowDefinitionName("example")
.roleArn(exampleAwsIamRole.arn())
.humanLoopConfig(FlowDefinitionHumanLoopConfigArgs.builder()
.humanTaskUiArn(exampleAwsSagemakerHumanTaskUi.arn())
.taskAvailabilityLifetimeInSeconds(1)
.taskCount(1)
.taskDescription("example")
.taskTitle("example")
.workteamArn(exampleAwsSagemakerWorkteam.arn())
.build())
.outputConfig(FlowDefinitionOutputConfigArgs.builder()
.s3OutputPath(String.format("s3://%s/", exampleAwsS3Bucket.bucket()))
.build())
.build());
}
}
resources:
example:
type: aws:sagemaker:FlowDefinition
properties:
flowDefinitionName: example
roleArn: ${exampleAwsIamRole.arn}
humanLoopConfig:
humanTaskUiArn: ${exampleAwsSagemakerHumanTaskUi.arn}
taskAvailabilityLifetimeInSeconds: 1
taskCount: 1
taskDescription: example
taskTitle: example
workteamArn: ${exampleAwsSagemakerWorkteam.arn}
outputConfig:
s3OutputPath: s3://${exampleAwsS3Bucket.bucket}/
Public Workteam Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.sagemaker.FlowDefinition("example", {
flowDefinitionName: "example",
roleArn: exampleAwsIamRole.arn,
humanLoopConfig: {
humanTaskUiArn: exampleAwsSagemakerHumanTaskUi.arn,
taskAvailabilityLifetimeInSeconds: 1,
taskCount: 1,
taskDescription: "example",
taskTitle: "example",
workteamArn: `arn:aws:sagemaker:${current.name}:394669845002:workteam/public-crowd/default`,
publicWorkforceTaskPrice: {
amountInUsd: {
cents: 1,
tenthFractionsOfACent: 2,
},
},
},
outputConfig: {
s3OutputPath: `s3://${exampleAwsS3Bucket.bucket}/`,
},
});
import pulumi
import pulumi_aws as aws
example = aws.sagemaker.FlowDefinition("example",
flow_definition_name="example",
role_arn=example_aws_iam_role["arn"],
human_loop_config={
"human_task_ui_arn": example_aws_sagemaker_human_task_ui["arn"],
"task_availability_lifetime_in_seconds": 1,
"task_count": 1,
"task_description": "example",
"task_title": "example",
"workteam_arn": f"arn:aws:sagemaker:{current['name']}:394669845002:workteam/public-crowd/default",
"public_workforce_task_price": {
"amount_in_usd": {
"cents": 1,
"tenth_fractions_of_a_cent": 2,
},
},
},
output_config={
"s3_output_path": f"s3://{example_aws_s3_bucket['bucket']}/",
})
package main
import (
"fmt"
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/sagemaker"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := sagemaker.NewFlowDefinition(ctx, "example", &sagemaker.FlowDefinitionArgs{
FlowDefinitionName: pulumi.String("example"),
RoleArn: pulumi.Any(exampleAwsIamRole.Arn),
HumanLoopConfig: &sagemaker.FlowDefinitionHumanLoopConfigArgs{
HumanTaskUiArn: pulumi.Any(exampleAwsSagemakerHumanTaskUi.Arn),
TaskAvailabilityLifetimeInSeconds: pulumi.Int(1),
TaskCount: pulumi.Int(1),
TaskDescription: pulumi.String("example"),
TaskTitle: pulumi.String("example"),
WorkteamArn: pulumi.Sprintf("arn:aws:sagemaker:%v:394669845002:workteam/public-crowd/default", current.Name),
PublicWorkforceTaskPrice: &sagemaker.FlowDefinitionHumanLoopConfigPublicWorkforceTaskPriceArgs{
AmountInUsd: &sagemaker.FlowDefinitionHumanLoopConfigPublicWorkforceTaskPriceAmountInUsdArgs{
Cents: pulumi.Int(1),
TenthFractionsOfACent: pulumi.Int(2),
},
},
},
OutputConfig: &sagemaker.FlowDefinitionOutputConfigArgs{
S3OutputPath: pulumi.Sprintf("s3://%v/", exampleAwsS3Bucket.Bucket),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Sagemaker.FlowDefinition("example", new()
{
FlowDefinitionName = "example",
RoleArn = exampleAwsIamRole.Arn,
HumanLoopConfig = new Aws.Sagemaker.Inputs.FlowDefinitionHumanLoopConfigArgs
{
HumanTaskUiArn = exampleAwsSagemakerHumanTaskUi.Arn,
TaskAvailabilityLifetimeInSeconds = 1,
TaskCount = 1,
TaskDescription = "example",
TaskTitle = "example",
WorkteamArn = $"arn:aws:sagemaker:{current.Name}:394669845002:workteam/public-crowd/default",
PublicWorkforceTaskPrice = new Aws.Sagemaker.Inputs.FlowDefinitionHumanLoopConfigPublicWorkforceTaskPriceArgs
{
AmountInUsd = new Aws.Sagemaker.Inputs.FlowDefinitionHumanLoopConfigPublicWorkforceTaskPriceAmountInUsdArgs
{
Cents = 1,
TenthFractionsOfACent = 2,
},
},
},
OutputConfig = new Aws.Sagemaker.Inputs.FlowDefinitionOutputConfigArgs
{
S3OutputPath = $"s3://{exampleAwsS3Bucket.Bucket}/",
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.sagemaker.FlowDefinition;
import com.pulumi.aws.sagemaker.FlowDefinitionArgs;
import com.pulumi.aws.sagemaker.inputs.FlowDefinitionHumanLoopConfigArgs;
import com.pulumi.aws.sagemaker.inputs.FlowDefinitionHumanLoopConfigPublicWorkforceTaskPriceArgs;
import com.pulumi.aws.sagemaker.inputs.FlowDefinitionHumanLoopConfigPublicWorkforceTaskPriceAmountInUsdArgs;
import com.pulumi.aws.sagemaker.inputs.FlowDefinitionOutputConfigArgs;
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 FlowDefinition("example", FlowDefinitionArgs.builder()
.flowDefinitionName("example")
.roleArn(exampleAwsIamRole.arn())
.humanLoopConfig(FlowDefinitionHumanLoopConfigArgs.builder()
.humanTaskUiArn(exampleAwsSagemakerHumanTaskUi.arn())
.taskAvailabilityLifetimeInSeconds(1)
.taskCount(1)
.taskDescription("example")
.taskTitle("example")
.workteamArn(String.format("arn:aws:sagemaker:%s:394669845002:workteam/public-crowd/default", current.name()))
.publicWorkforceTaskPrice(FlowDefinitionHumanLoopConfigPublicWorkforceTaskPriceArgs.builder()
.amountInUsd(FlowDefinitionHumanLoopConfigPublicWorkforceTaskPriceAmountInUsdArgs.builder()
.cents(1)
.tenthFractionsOfACent(2)
.build())
.build())
.build())
.outputConfig(FlowDefinitionOutputConfigArgs.builder()
.s3OutputPath(String.format("s3://%s/", exampleAwsS3Bucket.bucket()))
.build())
.build());
}
}
resources:
example:
type: aws:sagemaker:FlowDefinition
properties:
flowDefinitionName: example
roleArn: ${exampleAwsIamRole.arn}
humanLoopConfig:
humanTaskUiArn: ${exampleAwsSagemakerHumanTaskUi.arn}
taskAvailabilityLifetimeInSeconds: 1
taskCount: 1
taskDescription: example
taskTitle: example
workteamArn: arn:aws:sagemaker:${current.name}:394669845002:workteam/public-crowd/default
publicWorkforceTaskPrice:
amountInUsd:
cents: 1
tenthFractionsOfACent: 2
outputConfig:
s3OutputPath: s3://${exampleAwsS3Bucket.bucket}/
Human Loop Activation Config Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.sagemaker.FlowDefinition("example", {
flowDefinitionName: "example",
roleArn: exampleAwsIamRole.arn,
humanLoopConfig: {
humanTaskUiArn: exampleAwsSagemakerHumanTaskUi.arn,
taskAvailabilityLifetimeInSeconds: 1,
taskCount: 1,
taskDescription: "example",
taskTitle: "example",
workteamArn: exampleAwsSagemakerWorkteam.arn,
},
humanLoopRequestSource: {
awsManagedHumanLoopRequestSource: "AWS/Textract/AnalyzeDocument/Forms/V1",
},
humanLoopActivationConfig: {
humanLoopActivationConditionsConfig: {
humanLoopActivationConditions: ` {
\x09\x09\x09"Conditions": [
\x09\x09\x09 {
\x09\x09\x09\x09"ConditionType": "Sampling",
\x09\x09\x09\x09"ConditionParameters": {
\x09\x09\x09\x09 "RandomSamplingPercentage": 5
\x09\x09\x09\x09}
\x09\x09\x09 }
\x09\x09\x09]
\x09\x09}
`,
},
},
outputConfig: {
s3OutputPath: `s3://${exampleAwsS3Bucket.bucket}/`,
},
});
import pulumi
import pulumi_aws as aws
example = aws.sagemaker.FlowDefinition("example",
flow_definition_name="example",
role_arn=example_aws_iam_role["arn"],
human_loop_config={
"human_task_ui_arn": example_aws_sagemaker_human_task_ui["arn"],
"task_availability_lifetime_in_seconds": 1,
"task_count": 1,
"task_description": "example",
"task_title": "example",
"workteam_arn": example_aws_sagemaker_workteam["arn"],
},
human_loop_request_source={
"aws_managed_human_loop_request_source": "AWS/Textract/AnalyzeDocument/Forms/V1",
},
human_loop_activation_config={
"human_loop_activation_conditions_config": {
"human_loop_activation_conditions": """ {
\x09\x09\x09"Conditions": [
\x09\x09\x09 {
\x09\x09\x09\x09"ConditionType": "Sampling",
\x09\x09\x09\x09"ConditionParameters": {
\x09\x09\x09\x09 "RandomSamplingPercentage": 5
\x09\x09\x09\x09}
\x09\x09\x09 }
\x09\x09\x09]
\x09\x09}
""",
},
},
output_config={
"s3_output_path": f"s3://{example_aws_s3_bucket['bucket']}/",
})
package main
import (
"fmt"
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/sagemaker"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := sagemaker.NewFlowDefinition(ctx, "example", &sagemaker.FlowDefinitionArgs{
FlowDefinitionName: pulumi.String("example"),
RoleArn: pulumi.Any(exampleAwsIamRole.Arn),
HumanLoopConfig: &sagemaker.FlowDefinitionHumanLoopConfigArgs{
HumanTaskUiArn: pulumi.Any(exampleAwsSagemakerHumanTaskUi.Arn),
TaskAvailabilityLifetimeInSeconds: pulumi.Int(1),
TaskCount: pulumi.Int(1),
TaskDescription: pulumi.String("example"),
TaskTitle: pulumi.String("example"),
WorkteamArn: pulumi.Any(exampleAwsSagemakerWorkteam.Arn),
},
HumanLoopRequestSource: &sagemaker.FlowDefinitionHumanLoopRequestSourceArgs{
AwsManagedHumanLoopRequestSource: pulumi.String("AWS/Textract/AnalyzeDocument/Forms/V1"),
},
HumanLoopActivationConfig: &sagemaker.FlowDefinitionHumanLoopActivationConfigArgs{
HumanLoopActivationConditionsConfig: &sagemaker.FlowDefinitionHumanLoopActivationConfigHumanLoopActivationConditionsConfigArgs{
HumanLoopActivationConditions: pulumi.String(` {
"Conditions": [
{
"ConditionType": "Sampling",
"ConditionParameters": {
"RandomSamplingPercentage": 5
}
}
]
}
`),
},
},
OutputConfig: &sagemaker.FlowDefinitionOutputConfigArgs{
S3OutputPath: pulumi.Sprintf("s3://%v/", exampleAwsS3Bucket.Bucket),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Sagemaker.FlowDefinition("example", new()
{
FlowDefinitionName = "example",
RoleArn = exampleAwsIamRole.Arn,
HumanLoopConfig = new Aws.Sagemaker.Inputs.FlowDefinitionHumanLoopConfigArgs
{
HumanTaskUiArn = exampleAwsSagemakerHumanTaskUi.Arn,
TaskAvailabilityLifetimeInSeconds = 1,
TaskCount = 1,
TaskDescription = "example",
TaskTitle = "example",
WorkteamArn = exampleAwsSagemakerWorkteam.Arn,
},
HumanLoopRequestSource = new Aws.Sagemaker.Inputs.FlowDefinitionHumanLoopRequestSourceArgs
{
AwsManagedHumanLoopRequestSource = "AWS/Textract/AnalyzeDocument/Forms/V1",
},
HumanLoopActivationConfig = new Aws.Sagemaker.Inputs.FlowDefinitionHumanLoopActivationConfigArgs
{
HumanLoopActivationConditionsConfig = new Aws.Sagemaker.Inputs.FlowDefinitionHumanLoopActivationConfigHumanLoopActivationConditionsConfigArgs
{
HumanLoopActivationConditions = @" {
""Conditions"": [
{
""ConditionType"": ""Sampling"",
""ConditionParameters"": {
""RandomSamplingPercentage"": 5
}
}
]
}
",
},
},
OutputConfig = new Aws.Sagemaker.Inputs.FlowDefinitionOutputConfigArgs
{
S3OutputPath = $"s3://{exampleAwsS3Bucket.Bucket}/",
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.sagemaker.FlowDefinition;
import com.pulumi.aws.sagemaker.FlowDefinitionArgs;
import com.pulumi.aws.sagemaker.inputs.FlowDefinitionHumanLoopConfigArgs;
import com.pulumi.aws.sagemaker.inputs.FlowDefinitionHumanLoopRequestSourceArgs;
import com.pulumi.aws.sagemaker.inputs.FlowDefinitionHumanLoopActivationConfigArgs;
import com.pulumi.aws.sagemaker.inputs.FlowDefinitionHumanLoopActivationConfigHumanLoopActivationConditionsConfigArgs;
import com.pulumi.aws.sagemaker.inputs.FlowDefinitionOutputConfigArgs;
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 FlowDefinition("example", FlowDefinitionArgs.builder()
.flowDefinitionName("example")
.roleArn(exampleAwsIamRole.arn())
.humanLoopConfig(FlowDefinitionHumanLoopConfigArgs.builder()
.humanTaskUiArn(exampleAwsSagemakerHumanTaskUi.arn())
.taskAvailabilityLifetimeInSeconds(1)
.taskCount(1)
.taskDescription("example")
.taskTitle("example")
.workteamArn(exampleAwsSagemakerWorkteam.arn())
.build())
.humanLoopRequestSource(FlowDefinitionHumanLoopRequestSourceArgs.builder()
.awsManagedHumanLoopRequestSource("AWS/Textract/AnalyzeDocument/Forms/V1")
.build())
.humanLoopActivationConfig(FlowDefinitionHumanLoopActivationConfigArgs.builder()
.humanLoopActivationConditionsConfig(FlowDefinitionHumanLoopActivationConfigHumanLoopActivationConditionsConfigArgs.builder()
.humanLoopActivationConditions("""
{
"Conditions": [
{
"ConditionType": "Sampling",
"ConditionParameters": {
"RandomSamplingPercentage": 5
}
}
]
}
""")
.build())
.build())
.outputConfig(FlowDefinitionOutputConfigArgs.builder()
.s3OutputPath(String.format("s3://%s/", exampleAwsS3Bucket.bucket()))
.build())
.build());
}
}
resources:
example:
type: aws:sagemaker:FlowDefinition
properties:
flowDefinitionName: example
roleArn: ${exampleAwsIamRole.arn}
humanLoopConfig:
humanTaskUiArn: ${exampleAwsSagemakerHumanTaskUi.arn}
taskAvailabilityLifetimeInSeconds: 1
taskCount: 1
taskDescription: example
taskTitle: example
workteamArn: ${exampleAwsSagemakerWorkteam.arn}
humanLoopRequestSource:
awsManagedHumanLoopRequestSource: AWS/Textract/AnalyzeDocument/Forms/V1
humanLoopActivationConfig:
humanLoopActivationConditionsConfig:
humanLoopActivationConditions: |2
{
"Conditions": [
{
"ConditionType": "Sampling",
"ConditionParameters": {
"RandomSamplingPercentage": 5
}
}
]
}
outputConfig:
s3OutputPath: s3://${exampleAwsS3Bucket.bucket}/
Create FlowDefinition Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new FlowDefinition(name: string, args: FlowDefinitionArgs, opts?: CustomResourceOptions);
@overload
def FlowDefinition(resource_name: str,
args: FlowDefinitionArgs,
opts: Optional[ResourceOptions] = None)
@overload
def FlowDefinition(resource_name: str,
opts: Optional[ResourceOptions] = None,
flow_definition_name: Optional[str] = None,
human_loop_config: Optional[FlowDefinitionHumanLoopConfigArgs] = None,
output_config: Optional[FlowDefinitionOutputConfigArgs] = None,
role_arn: Optional[str] = None,
human_loop_activation_config: Optional[FlowDefinitionHumanLoopActivationConfigArgs] = None,
human_loop_request_source: Optional[FlowDefinitionHumanLoopRequestSourceArgs] = None,
tags: Optional[Mapping[str, str]] = None)
func NewFlowDefinition(ctx *Context, name string, args FlowDefinitionArgs, opts ...ResourceOption) (*FlowDefinition, error)
public FlowDefinition(string name, FlowDefinitionArgs args, CustomResourceOptions? opts = null)
public FlowDefinition(String name, FlowDefinitionArgs args)
public FlowDefinition(String name, FlowDefinitionArgs args, CustomResourceOptions options)
type: aws:sagemaker:FlowDefinition
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name
This property is required. string - The unique name of the resource.
- args
This property is required. FlowDefinitionArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
This property is required. str - The unique name of the resource.
- args
This property is required. FlowDefinitionArgs - The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. FlowDefinitionArgs - The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. FlowDefinitionArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name
This property is required. String - The unique name of the resource.
- args
This property is required. FlowDefinitionArgs - 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 flowDefinitionResource = new Aws.Sagemaker.FlowDefinition("flowDefinitionResource", new()
{
FlowDefinitionName = "string",
HumanLoopConfig = new Aws.Sagemaker.Inputs.FlowDefinitionHumanLoopConfigArgs
{
HumanTaskUiArn = "string",
TaskCount = 0,
TaskDescription = "string",
TaskTitle = "string",
WorkteamArn = "string",
PublicWorkforceTaskPrice = new Aws.Sagemaker.Inputs.FlowDefinitionHumanLoopConfigPublicWorkforceTaskPriceArgs
{
AmountInUsd = new Aws.Sagemaker.Inputs.FlowDefinitionHumanLoopConfigPublicWorkforceTaskPriceAmountInUsdArgs
{
Cents = 0,
Dollars = 0,
TenthFractionsOfACent = 0,
},
},
TaskAvailabilityLifetimeInSeconds = 0,
TaskKeywords = new[]
{
"string",
},
TaskTimeLimitInSeconds = 0,
},
OutputConfig = new Aws.Sagemaker.Inputs.FlowDefinitionOutputConfigArgs
{
S3OutputPath = "string",
KmsKeyId = "string",
},
RoleArn = "string",
HumanLoopActivationConfig = new Aws.Sagemaker.Inputs.FlowDefinitionHumanLoopActivationConfigArgs
{
HumanLoopActivationConditionsConfig = new Aws.Sagemaker.Inputs.FlowDefinitionHumanLoopActivationConfigHumanLoopActivationConditionsConfigArgs
{
HumanLoopActivationConditions = "string",
},
},
HumanLoopRequestSource = new Aws.Sagemaker.Inputs.FlowDefinitionHumanLoopRequestSourceArgs
{
AwsManagedHumanLoopRequestSource = "string",
},
Tags =
{
{ "string", "string" },
},
});
example, err := sagemaker.NewFlowDefinition(ctx, "flowDefinitionResource", &sagemaker.FlowDefinitionArgs{
FlowDefinitionName: pulumi.String("string"),
HumanLoopConfig: &sagemaker.FlowDefinitionHumanLoopConfigArgs{
HumanTaskUiArn: pulumi.String("string"),
TaskCount: pulumi.Int(0),
TaskDescription: pulumi.String("string"),
TaskTitle: pulumi.String("string"),
WorkteamArn: pulumi.String("string"),
PublicWorkforceTaskPrice: &sagemaker.FlowDefinitionHumanLoopConfigPublicWorkforceTaskPriceArgs{
AmountInUsd: &sagemaker.FlowDefinitionHumanLoopConfigPublicWorkforceTaskPriceAmountInUsdArgs{
Cents: pulumi.Int(0),
Dollars: pulumi.Int(0),
TenthFractionsOfACent: pulumi.Int(0),
},
},
TaskAvailabilityLifetimeInSeconds: pulumi.Int(0),
TaskKeywords: pulumi.StringArray{
pulumi.String("string"),
},
TaskTimeLimitInSeconds: pulumi.Int(0),
},
OutputConfig: &sagemaker.FlowDefinitionOutputConfigArgs{
S3OutputPath: pulumi.String("string"),
KmsKeyId: pulumi.String("string"),
},
RoleArn: pulumi.String("string"),
HumanLoopActivationConfig: &sagemaker.FlowDefinitionHumanLoopActivationConfigArgs{
HumanLoopActivationConditionsConfig: &sagemaker.FlowDefinitionHumanLoopActivationConfigHumanLoopActivationConditionsConfigArgs{
HumanLoopActivationConditions: pulumi.String("string"),
},
},
HumanLoopRequestSource: &sagemaker.FlowDefinitionHumanLoopRequestSourceArgs{
AwsManagedHumanLoopRequestSource: pulumi.String("string"),
},
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var flowDefinitionResource = new FlowDefinition("flowDefinitionResource", FlowDefinitionArgs.builder()
.flowDefinitionName("string")
.humanLoopConfig(FlowDefinitionHumanLoopConfigArgs.builder()
.humanTaskUiArn("string")
.taskCount(0)
.taskDescription("string")
.taskTitle("string")
.workteamArn("string")
.publicWorkforceTaskPrice(FlowDefinitionHumanLoopConfigPublicWorkforceTaskPriceArgs.builder()
.amountInUsd(FlowDefinitionHumanLoopConfigPublicWorkforceTaskPriceAmountInUsdArgs.builder()
.cents(0)
.dollars(0)
.tenthFractionsOfACent(0)
.build())
.build())
.taskAvailabilityLifetimeInSeconds(0)
.taskKeywords("string")
.taskTimeLimitInSeconds(0)
.build())
.outputConfig(FlowDefinitionOutputConfigArgs.builder()
.s3OutputPath("string")
.kmsKeyId("string")
.build())
.roleArn("string")
.humanLoopActivationConfig(FlowDefinitionHumanLoopActivationConfigArgs.builder()
.humanLoopActivationConditionsConfig(FlowDefinitionHumanLoopActivationConfigHumanLoopActivationConditionsConfigArgs.builder()
.humanLoopActivationConditions("string")
.build())
.build())
.humanLoopRequestSource(FlowDefinitionHumanLoopRequestSourceArgs.builder()
.awsManagedHumanLoopRequestSource("string")
.build())
.tags(Map.of("string", "string"))
.build());
flow_definition_resource = aws.sagemaker.FlowDefinition("flowDefinitionResource",
flow_definition_name="string",
human_loop_config={
"human_task_ui_arn": "string",
"task_count": 0,
"task_description": "string",
"task_title": "string",
"workteam_arn": "string",
"public_workforce_task_price": {
"amount_in_usd": {
"cents": 0,
"dollars": 0,
"tenth_fractions_of_a_cent": 0,
},
},
"task_availability_lifetime_in_seconds": 0,
"task_keywords": ["string"],
"task_time_limit_in_seconds": 0,
},
output_config={
"s3_output_path": "string",
"kms_key_id": "string",
},
role_arn="string",
human_loop_activation_config={
"human_loop_activation_conditions_config": {
"human_loop_activation_conditions": "string",
},
},
human_loop_request_source={
"aws_managed_human_loop_request_source": "string",
},
tags={
"string": "string",
})
const flowDefinitionResource = new aws.sagemaker.FlowDefinition("flowDefinitionResource", {
flowDefinitionName: "string",
humanLoopConfig: {
humanTaskUiArn: "string",
taskCount: 0,
taskDescription: "string",
taskTitle: "string",
workteamArn: "string",
publicWorkforceTaskPrice: {
amountInUsd: {
cents: 0,
dollars: 0,
tenthFractionsOfACent: 0,
},
},
taskAvailabilityLifetimeInSeconds: 0,
taskKeywords: ["string"],
taskTimeLimitInSeconds: 0,
},
outputConfig: {
s3OutputPath: "string",
kmsKeyId: "string",
},
roleArn: "string",
humanLoopActivationConfig: {
humanLoopActivationConditionsConfig: {
humanLoopActivationConditions: "string",
},
},
humanLoopRequestSource: {
awsManagedHumanLoopRequestSource: "string",
},
tags: {
string: "string",
},
});
type: aws:sagemaker:FlowDefinition
properties:
flowDefinitionName: string
humanLoopActivationConfig:
humanLoopActivationConditionsConfig:
humanLoopActivationConditions: string
humanLoopConfig:
humanTaskUiArn: string
publicWorkforceTaskPrice:
amountInUsd:
cents: 0
dollars: 0
tenthFractionsOfACent: 0
taskAvailabilityLifetimeInSeconds: 0
taskCount: 0
taskDescription: string
taskKeywords:
- string
taskTimeLimitInSeconds: 0
taskTitle: string
workteamArn: string
humanLoopRequestSource:
awsManagedHumanLoopRequestSource: string
outputConfig:
kmsKeyId: string
s3OutputPath: string
roleArn: string
tags:
string: string
FlowDefinition Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The FlowDefinition resource accepts the following input properties:
- Flow
Definition Name This property is required. Changes to this property will trigger replacement.
- The name of your flow definition.
- Human
Loop Config This property is required. Changes to this property will trigger replacement.
Definition Human Loop Config - An object containing information about the tasks the human reviewers will perform. See Human Loop Config details below.
- Output
Config This property is required. Changes to this property will trigger replacement.
Definition Output Config - An object containing information about where the human review results will be uploaded. See Output Config details below.
- Role
Arn This property is required. Changes to this property will trigger replacement.
- The Amazon Resource Name (ARN) of the role needed to call other services on your behalf.
- Human
Loop Activation Config Changes to this property will trigger replacement.
Definition Human Loop Activation Config - An object containing information about the events that trigger a human workflow. See Human Loop Activation Config details below.
- Human
Loop Request Source Changes to this property will trigger replacement.
Definition Human Loop Request Source - Container for configuring the source of human task requests. Use to specify if Amazon Rekognition or Amazon Textract is used as an integration source. See Human Loop Request Source details below.
- 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.
- Flow
Definition Name This property is required. Changes to this property will trigger replacement.
- The name of your flow definition.
- Human
Loop Config This property is required. Changes to this property will trigger replacement.
Definition Human Loop Config Args - An object containing information about the tasks the human reviewers will perform. See Human Loop Config details below.
- Output
Config This property is required. Changes to this property will trigger replacement.
Definition Output Config Args - An object containing information about where the human review results will be uploaded. See Output Config details below.
- Role
Arn This property is required. Changes to this property will trigger replacement.
- The Amazon Resource Name (ARN) of the role needed to call other services on your behalf.
- Human
Loop Activation Config Changes to this property will trigger replacement.
Definition Human Loop Activation Config Args - An object containing information about the events that trigger a human workflow. See Human Loop Activation Config details below.
- Human
Loop Request Source Changes to this property will trigger replacement.
Definition Human Loop Request Source Args - Container for configuring the source of human task requests. Use to specify if Amazon Rekognition or Amazon Textract is used as an integration source. See Human Loop Request Source details below.
- 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.
- flow
Definition Name This property is required. Changes to this property will trigger replacement.
- The name of your flow definition.
- human
Loop Config This property is required. Changes to this property will trigger replacement.
Definition Human Loop Config - An object containing information about the tasks the human reviewers will perform. See Human Loop Config details below.
- output
Config This property is required. Changes to this property will trigger replacement.
Definition Output Config - An object containing information about where the human review results will be uploaded. See Output Config details below.
- role
Arn This property is required. Changes to this property will trigger replacement.
- The Amazon Resource Name (ARN) of the role needed to call other services on your behalf.
- human
Loop Activation Config Changes to this property will trigger replacement.
Definition Human Loop Activation Config - An object containing information about the events that trigger a human workflow. See Human Loop Activation Config details below.
- human
Loop Request Source Changes to this property will trigger replacement.
Definition Human Loop Request Source - Container for configuring the source of human task requests. Use to specify if Amazon Rekognition or Amazon Textract is used as an integration source. See Human Loop Request Source details below.
- 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.
- flow
Definition Name This property is required. Changes to this property will trigger replacement.
- The name of your flow definition.
- human
Loop Config This property is required. Changes to this property will trigger replacement.
Definition Human Loop Config - An object containing information about the tasks the human reviewers will perform. See Human Loop Config details below.
- output
Config This property is required. Changes to this property will trigger replacement.
Definition Output Config - An object containing information about where the human review results will be uploaded. See Output Config details below.
- role
Arn This property is required. Changes to this property will trigger replacement.
- The Amazon Resource Name (ARN) of the role needed to call other services on your behalf.
- human
Loop Activation Config Changes to this property will trigger replacement.
Definition Human Loop Activation Config - An object containing information about the events that trigger a human workflow. See Human Loop Activation Config details below.
- human
Loop Request Source Changes to this property will trigger replacement.
Definition Human Loop Request Source - Container for configuring the source of human task requests. Use to specify if Amazon Rekognition or Amazon Textract is used as an integration source. See Human Loop Request Source details below.
- {[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.
- flow_
definition_ name This property is required. Changes to this property will trigger replacement.
- The name of your flow definition.
- human_
loop_ config This property is required. Changes to this property will trigger replacement.
Definition Human Loop Config Args - An object containing information about the tasks the human reviewers will perform. See Human Loop Config details below.
- output_
config This property is required. Changes to this property will trigger replacement.
Definition Output Config Args - An object containing information about where the human review results will be uploaded. See Output Config details below.
- role_
arn This property is required. Changes to this property will trigger replacement.
- The Amazon Resource Name (ARN) of the role needed to call other services on your behalf.
- human_
loop_ activation_ config Changes to this property will trigger replacement.
Definition Human Loop Activation Config Args - An object containing information about the events that trigger a human workflow. See Human Loop Activation Config details below.
- human_
loop_ request_ source Changes to this property will trigger replacement.
Definition Human Loop Request Source Args - Container for configuring the source of human task requests. Use to specify if Amazon Rekognition or Amazon Textract is used as an integration source. See Human Loop Request Source details below.
- 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.
- flow
Definition Name This property is required. Changes to this property will trigger replacement.
- The name of your flow definition.
- human
Loop Config This property is required. Changes to this property will trigger replacement.
- An object containing information about the tasks the human reviewers will perform. See Human Loop Config details below.
- output
Config This property is required. Changes to this property will trigger replacement.
- An object containing information about where the human review results will be uploaded. See Output Config details below.
- role
Arn This property is required. Changes to this property will trigger replacement.
- The Amazon Resource Name (ARN) of the role needed to call other services on your behalf.
- human
Loop Activation Config Changes to this property will trigger replacement.
- An object containing information about the events that trigger a human workflow. See Human Loop Activation Config details below.
- human
Loop Request Source Changes to this property will trigger replacement.
- Container for configuring the source of human task requests. Use to specify if Amazon Rekognition or Amazon Textract is used as an integration source. See Human Loop Request Source details below.
- 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 FlowDefinition resource produces the following output properties:
Look up Existing FlowDefinition Resource
Get an existing FlowDefinition 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?: FlowDefinitionState, opts?: CustomResourceOptions): FlowDefinition
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
arn: Optional[str] = None,
flow_definition_name: Optional[str] = None,
human_loop_activation_config: Optional[FlowDefinitionHumanLoopActivationConfigArgs] = None,
human_loop_config: Optional[FlowDefinitionHumanLoopConfigArgs] = None,
human_loop_request_source: Optional[FlowDefinitionHumanLoopRequestSourceArgs] = None,
output_config: Optional[FlowDefinitionOutputConfigArgs] = None,
role_arn: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
tags_all: Optional[Mapping[str, str]] = None) -> FlowDefinition
func GetFlowDefinition(ctx *Context, name string, id IDInput, state *FlowDefinitionState, opts ...ResourceOption) (*FlowDefinition, error)
public static FlowDefinition Get(string name, Input<string> id, FlowDefinitionState? state, CustomResourceOptions? opts = null)
public static FlowDefinition get(String name, Output<String> id, FlowDefinitionState state, CustomResourceOptions options)
resources: _: type: aws:sagemaker:FlowDefinition get: id: ${id}
- name
This property is required. - The unique name of the resulting resource.
- id
This property is required. - 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
This property is required. - The unique name of the resulting resource.
- id
This property is required. - The unique provider ID of the resource to lookup.
- name
This property is required. - The unique name of the resulting resource.
- id
This property is required. - 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
This property is required. - The unique name of the resulting resource.
- id
This property is required. - 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
This property is required. - The unique name of the resulting resource.
- id
This property is required. - 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.
- Arn string
- The Amazon Resource Name (ARN) assigned by AWS to this Flow Definition.
- Flow
Definition Name Changes to this property will trigger replacement.
- The name of your flow definition.
- Human
Loop Activation Config Changes to this property will trigger replacement.
Definition Human Loop Activation Config - An object containing information about the events that trigger a human workflow. See Human Loop Activation Config details below.
- Human
Loop Config Changes to this property will trigger replacement.
Definition Human Loop Config - An object containing information about the tasks the human reviewers will perform. See Human Loop Config details below.
- Human
Loop Request Source Changes to this property will trigger replacement.
Definition Human Loop Request Source - Container for configuring the source of human task requests. Use to specify if Amazon Rekognition or Amazon Textract is used as an integration source. See Human Loop Request Source details below.
- Output
Config Changes to this property will trigger replacement.
Definition Output Config - An object containing information about where the human review results will be uploaded. See Output Config details below.
- Role
Arn Changes to this property will trigger replacement.
- The Amazon Resource Name (ARN) of the role needed to call other services on your behalf.
- 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. - Dictionary<string, string>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- Arn string
- The Amazon Resource Name (ARN) assigned by AWS to this Flow Definition.
- Flow
Definition Name Changes to this property will trigger replacement.
- The name of your flow definition.
- Human
Loop Activation Config Changes to this property will trigger replacement.
Definition Human Loop Activation Config Args - An object containing information about the events that trigger a human workflow. See Human Loop Activation Config details below.
- Human
Loop Config Changes to this property will trigger replacement.
Definition Human Loop Config Args - An object containing information about the tasks the human reviewers will perform. See Human Loop Config details below.
- Human
Loop Request Source Changes to this property will trigger replacement.
Definition Human Loop Request Source Args - Container for configuring the source of human task requests. Use to specify if Amazon Rekognition or Amazon Textract is used as an integration source. See Human Loop Request Source details below.
- Output
Config Changes to this property will trigger replacement.
Definition Output Config Args - An object containing information about where the human review results will be uploaded. See Output Config details below.
- Role
Arn Changes to this property will trigger replacement.
- The Amazon Resource Name (ARN) of the role needed to call other services on your behalf.
- 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. - map[string]string
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn String
- The Amazon Resource Name (ARN) assigned by AWS to this Flow Definition.
- flow
Definition Name Changes to this property will trigger replacement.
- The name of your flow definition.
- human
Loop Activation Config Changes to this property will trigger replacement.
Definition Human Loop Activation Config - An object containing information about the events that trigger a human workflow. See Human Loop Activation Config details below.
- human
Loop Config Changes to this property will trigger replacement.
Definition Human Loop Config - An object containing information about the tasks the human reviewers will perform. See Human Loop Config details below.
- human
Loop Request Source Changes to this property will trigger replacement.
Definition Human Loop Request Source - Container for configuring the source of human task requests. Use to specify if Amazon Rekognition or Amazon Textract is used as an integration source. See Human Loop Request Source details below.
- output
Config Changes to this property will trigger replacement.
Definition Output Config - An object containing information about where the human review results will be uploaded. See Output Config details below.
- role
Arn Changes to this property will trigger replacement.
- The Amazon Resource Name (ARN) of the role needed to call other services on your behalf.
- 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. - Map<String,String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn string
- The Amazon Resource Name (ARN) assigned by AWS to this Flow Definition.
- flow
Definition Name Changes to this property will trigger replacement.
- The name of your flow definition.
- human
Loop Activation Config Changes to this property will trigger replacement.
Definition Human Loop Activation Config - An object containing information about the events that trigger a human workflow. See Human Loop Activation Config details below.
- human
Loop Config Changes to this property will trigger replacement.
Definition Human Loop Config - An object containing information about the tasks the human reviewers will perform. See Human Loop Config details below.
- human
Loop Request Source Changes to this property will trigger replacement.
Definition Human Loop Request Source - Container for configuring the source of human task requests. Use to specify if Amazon Rekognition or Amazon Textract is used as an integration source. See Human Loop Request Source details below.
- output
Config Changes to this property will trigger replacement.
Definition Output Config - An object containing information about where the human review results will be uploaded. See Output Config details below.
- role
Arn Changes to this property will trigger replacement.
- The Amazon Resource Name (ARN) of the role needed to call other services on your behalf.
- {[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. - {[key: string]: string}
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn str
- The Amazon Resource Name (ARN) assigned by AWS to this Flow Definition.
- flow_
definition_ name Changes to this property will trigger replacement.
- The name of your flow definition.
- human_
loop_ activation_ config Changes to this property will trigger replacement.
Definition Human Loop Activation Config Args - An object containing information about the events that trigger a human workflow. See Human Loop Activation Config details below.
- human_
loop_ config Changes to this property will trigger replacement.
Definition Human Loop Config Args - An object containing information about the tasks the human reviewers will perform. See Human Loop Config details below.
- human_
loop_ request_ source Changes to this property will trigger replacement.
Definition Human Loop Request Source Args - Container for configuring the source of human task requests. Use to specify if Amazon Rekognition or Amazon Textract is used as an integration source. See Human Loop Request Source details below.
- output_
config Changes to this property will trigger replacement.
Definition Output Config Args - An object containing information about where the human review results will be uploaded. See Output Config details below.
- role_
arn Changes to this property will trigger replacement.
- The Amazon Resource Name (ARN) of the role needed to call other services on your behalf.
- 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. - Mapping[str, str]
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn String
- The Amazon Resource Name (ARN) assigned by AWS to this Flow Definition.
- flow
Definition Name Changes to this property will trigger replacement.
- The name of your flow definition.
- human
Loop Activation Config Changes to this property will trigger replacement.
- An object containing information about the events that trigger a human workflow. See Human Loop Activation Config details below.
- human
Loop Config Changes to this property will trigger replacement.
- An object containing information about the tasks the human reviewers will perform. See Human Loop Config details below.
- human
Loop Request Source Changes to this property will trigger replacement.
- Container for configuring the source of human task requests. Use to specify if Amazon Rekognition or Amazon Textract is used as an integration source. See Human Loop Request Source details below.
- output
Config Changes to this property will trigger replacement.
- An object containing information about where the human review results will be uploaded. See Output Config details below.
- role
Arn Changes to this property will trigger replacement.
- The Amazon Resource Name (ARN) of the role needed to call other services on your behalf.
- 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. - Map<String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
Supporting Types
FlowDefinitionHumanLoopActivationConfig, FlowDefinitionHumanLoopActivationConfigArgs
- Human
Loop Activation Conditions Config Changes to this property will trigger replacement.
Definition Human Loop Activation Config Human Loop Activation Conditions Config - defines under what conditions SageMaker AI creates a human loop. See Human Loop Activation Conditions Config details below.
- Human
Loop Activation Conditions Config Changes to this property will trigger replacement.
Definition Human Loop Activation Config Human Loop Activation Conditions Config - defines under what conditions SageMaker AI creates a human loop. See Human Loop Activation Conditions Config details below.
- human
Loop Activation Conditions Config Changes to this property will trigger replacement.
Definition Human Loop Activation Config Human Loop Activation Conditions Config - defines under what conditions SageMaker AI creates a human loop. See Human Loop Activation Conditions Config details below.
- human
Loop Activation Conditions Config Changes to this property will trigger replacement.
Definition Human Loop Activation Config Human Loop Activation Conditions Config - defines under what conditions SageMaker AI creates a human loop. See Human Loop Activation Conditions Config details below.
- human_
loop_ activation_ conditions_ config Changes to this property will trigger replacement.
Definition Human Loop Activation Config Human Loop Activation Conditions Config - defines under what conditions SageMaker AI creates a human loop. See Human Loop Activation Conditions Config details below.
- human
Loop Activation Conditions Config Changes to this property will trigger replacement.
- defines under what conditions SageMaker AI creates a human loop. See Human Loop Activation Conditions Config details below.
FlowDefinitionHumanLoopActivationConfigHumanLoopActivationConditionsConfig, FlowDefinitionHumanLoopActivationConfigHumanLoopActivationConditionsConfigArgs
- Human
Loop Activation Conditions This property is required. Changes to this property will trigger replacement.
- A JSON expressing use-case specific conditions declaratively. If any condition is matched, atomic tasks are created against the configured work team. For more information about how to structure the JSON, see JSON Schema for Human Loop Activation Conditions in Amazon Augmented AI.
- Human
Loop Activation Conditions This property is required. Changes to this property will trigger replacement.
- A JSON expressing use-case specific conditions declaratively. If any condition is matched, atomic tasks are created against the configured work team. For more information about how to structure the JSON, see JSON Schema for Human Loop Activation Conditions in Amazon Augmented AI.
- human
Loop Activation Conditions This property is required. Changes to this property will trigger replacement.
- A JSON expressing use-case specific conditions declaratively. If any condition is matched, atomic tasks are created against the configured work team. For more information about how to structure the JSON, see JSON Schema for Human Loop Activation Conditions in Amazon Augmented AI.
- human
Loop Activation Conditions This property is required. Changes to this property will trigger replacement.
- A JSON expressing use-case specific conditions declaratively. If any condition is matched, atomic tasks are created against the configured work team. For more information about how to structure the JSON, see JSON Schema for Human Loop Activation Conditions in Amazon Augmented AI.
- human_
loop_ activation_ conditions This property is required. Changes to this property will trigger replacement.
- A JSON expressing use-case specific conditions declaratively. If any condition is matched, atomic tasks are created against the configured work team. For more information about how to structure the JSON, see JSON Schema for Human Loop Activation Conditions in Amazon Augmented AI.
- human
Loop Activation Conditions This property is required. Changes to this property will trigger replacement.
- A JSON expressing use-case specific conditions declaratively. If any condition is matched, atomic tasks are created against the configured work team. For more information about how to structure the JSON, see JSON Schema for Human Loop Activation Conditions in Amazon Augmented AI.
FlowDefinitionHumanLoopConfig, FlowDefinitionHumanLoopConfigArgs
- Human
Task Ui Arn This property is required. Changes to this property will trigger replacement.
- The Amazon Resource Name (ARN) of the human task user interface.
- Task
Count This property is required. Changes to this property will trigger replacement.
- The number of distinct workers who will perform the same task on each object. Valid value range between
1
and3
. - Task
Description This property is required. Changes to this property will trigger replacement.
- A description for the human worker task.
- Task
Title This property is required. Changes to this property will trigger replacement.
- A title for the human worker task.
- Workteam
Arn This property is required. Changes to this property will trigger replacement.
- The Amazon Resource Name (ARN) of the human task user interface. Amazon Resource Name (ARN) of a team of workers. For Public workforces see AWS Docs.
- Public
Workforce Task Price Changes to this property will trigger replacement.
Definition Human Loop Config Public Workforce Task Price - Defines the amount of money paid to an Amazon Mechanical Turk worker for each task performed. See Public Workforce Task Price details below.
- Task
Availability Lifetime In Seconds Changes to this property will trigger replacement.
- The length of time that a task remains available for review by human workers. Valid value range between
1
and864000
. - Task
Keywords List<string> - An array of keywords used to describe the task so that workers can discover the task.
- Task
Time Limit In Seconds Changes to this property will trigger replacement.
- The amount of time that a worker has to complete a task. The default value is
3600
seconds.
- Human
Task Ui Arn This property is required. Changes to this property will trigger replacement.
- The Amazon Resource Name (ARN) of the human task user interface.
- Task
Count This property is required. Changes to this property will trigger replacement.
- The number of distinct workers who will perform the same task on each object. Valid value range between
1
and3
. - Task
Description This property is required. Changes to this property will trigger replacement.
- A description for the human worker task.
- Task
Title This property is required. Changes to this property will trigger replacement.
- A title for the human worker task.
- Workteam
Arn This property is required. Changes to this property will trigger replacement.
- The Amazon Resource Name (ARN) of the human task user interface. Amazon Resource Name (ARN) of a team of workers. For Public workforces see AWS Docs.
- Public
Workforce Task Price Changes to this property will trigger replacement.
Definition Human Loop Config Public Workforce Task Price - Defines the amount of money paid to an Amazon Mechanical Turk worker for each task performed. See Public Workforce Task Price details below.
- Task
Availability Lifetime In Seconds Changes to this property will trigger replacement.
- The length of time that a task remains available for review by human workers. Valid value range between
1
and864000
. - Task
Keywords []string - An array of keywords used to describe the task so that workers can discover the task.
- Task
Time Limit In Seconds Changes to this property will trigger replacement.
- The amount of time that a worker has to complete a task. The default value is
3600
seconds.
- human
Task Ui Arn This property is required. Changes to this property will trigger replacement.
- The Amazon Resource Name (ARN) of the human task user interface.
- task
Count This property is required. Changes to this property will trigger replacement.
- The number of distinct workers who will perform the same task on each object. Valid value range between
1
and3
. - task
Description This property is required. Changes to this property will trigger replacement.
- A description for the human worker task.
- task
Title This property is required. Changes to this property will trigger replacement.
- A title for the human worker task.
- workteam
Arn This property is required. Changes to this property will trigger replacement.
- The Amazon Resource Name (ARN) of the human task user interface. Amazon Resource Name (ARN) of a team of workers. For Public workforces see AWS Docs.
- public
Workforce Task Price Changes to this property will trigger replacement.
Definition Human Loop Config Public Workforce Task Price - Defines the amount of money paid to an Amazon Mechanical Turk worker for each task performed. See Public Workforce Task Price details below.
- task
Availability Lifetime In Seconds Changes to this property will trigger replacement.
- The length of time that a task remains available for review by human workers. Valid value range between
1
and864000
. - task
Keywords List<String> - An array of keywords used to describe the task so that workers can discover the task.
- task
Time Limit In Seconds Changes to this property will trigger replacement.
- The amount of time that a worker has to complete a task. The default value is
3600
seconds.
- human
Task Ui Arn This property is required. Changes to this property will trigger replacement.
- The Amazon Resource Name (ARN) of the human task user interface.
- task
Count This property is required. Changes to this property will trigger replacement.
- The number of distinct workers who will perform the same task on each object. Valid value range between
1
and3
. - task
Description This property is required. Changes to this property will trigger replacement.
- A description for the human worker task.
- task
Title This property is required. Changes to this property will trigger replacement.
- A title for the human worker task.
- workteam
Arn This property is required. Changes to this property will trigger replacement.
- The Amazon Resource Name (ARN) of the human task user interface. Amazon Resource Name (ARN) of a team of workers. For Public workforces see AWS Docs.
- public
Workforce Task Price Changes to this property will trigger replacement.
Definition Human Loop Config Public Workforce Task Price - Defines the amount of money paid to an Amazon Mechanical Turk worker for each task performed. See Public Workforce Task Price details below.
- task
Availability Lifetime In Seconds Changes to this property will trigger replacement.
- The length of time that a task remains available for review by human workers. Valid value range between
1
and864000
. - task
Keywords string[] - An array of keywords used to describe the task so that workers can discover the task.
- task
Time Limit In Seconds Changes to this property will trigger replacement.
- The amount of time that a worker has to complete a task. The default value is
3600
seconds.
- human_
task_ ui_ arn This property is required. Changes to this property will trigger replacement.
- The Amazon Resource Name (ARN) of the human task user interface.
- task_
count This property is required. Changes to this property will trigger replacement.
- The number of distinct workers who will perform the same task on each object. Valid value range between
1
and3
. - task_
description This property is required. Changes to this property will trigger replacement.
- A description for the human worker task.
- task_
title This property is required. Changes to this property will trigger replacement.
- A title for the human worker task.
- workteam_
arn This property is required. Changes to this property will trigger replacement.
- The Amazon Resource Name (ARN) of the human task user interface. Amazon Resource Name (ARN) of a team of workers. For Public workforces see AWS Docs.
- public_
workforce_ task_ price Changes to this property will trigger replacement.
Definition Human Loop Config Public Workforce Task Price - Defines the amount of money paid to an Amazon Mechanical Turk worker for each task performed. See Public Workforce Task Price details below.
- task_
availability_ lifetime_ in_ seconds Changes to this property will trigger replacement.
- The length of time that a task remains available for review by human workers. Valid value range between
1
and864000
. - task_
keywords Sequence[str] - An array of keywords used to describe the task so that workers can discover the task.
- task_
time_ limit_ in_ seconds Changes to this property will trigger replacement.
- The amount of time that a worker has to complete a task. The default value is
3600
seconds.
- human
Task Ui Arn This property is required. Changes to this property will trigger replacement.
- The Amazon Resource Name (ARN) of the human task user interface.
- task
Count This property is required. Changes to this property will trigger replacement.
- The number of distinct workers who will perform the same task on each object. Valid value range between
1
and3
. - task
Description This property is required. Changes to this property will trigger replacement.
- A description for the human worker task.
- task
Title This property is required. Changes to this property will trigger replacement.
- A title for the human worker task.
- workteam
Arn This property is required. Changes to this property will trigger replacement.
- The Amazon Resource Name (ARN) of the human task user interface. Amazon Resource Name (ARN) of a team of workers. For Public workforces see AWS Docs.
- public
Workforce Task Price Changes to this property will trigger replacement.
- Defines the amount of money paid to an Amazon Mechanical Turk worker for each task performed. See Public Workforce Task Price details below.
- task
Availability Lifetime In Seconds Changes to this property will trigger replacement.
- The length of time that a task remains available for review by human workers. Valid value range between
1
and864000
. - task
Keywords List<String> - An array of keywords used to describe the task so that workers can discover the task.
- task
Time Limit In Seconds Changes to this property will trigger replacement.
- The amount of time that a worker has to complete a task. The default value is
3600
seconds.
FlowDefinitionHumanLoopConfigPublicWorkforceTaskPrice, FlowDefinitionHumanLoopConfigPublicWorkforceTaskPriceArgs
- Amount
In Usd Changes to this property will trigger replacement.
Definition Human Loop Config Public Workforce Task Price Amount In Usd - Defines the amount of money paid to an Amazon Mechanical Turk worker in United States dollars. See Amount In Usd details below.
- Amount
In Usd Changes to this property will trigger replacement.
Definition Human Loop Config Public Workforce Task Price Amount In Usd - Defines the amount of money paid to an Amazon Mechanical Turk worker in United States dollars. See Amount In Usd details below.
- amount
In Usd Changes to this property will trigger replacement.
Definition Human Loop Config Public Workforce Task Price Amount In Usd - Defines the amount of money paid to an Amazon Mechanical Turk worker in United States dollars. See Amount In Usd details below.
- amount
In Usd Changes to this property will trigger replacement.
Definition Human Loop Config Public Workforce Task Price Amount In Usd - Defines the amount of money paid to an Amazon Mechanical Turk worker in United States dollars. See Amount In Usd details below.
- amount_
in_ usd Changes to this property will trigger replacement.
Definition Human Loop Config Public Workforce Task Price Amount In Usd - Defines the amount of money paid to an Amazon Mechanical Turk worker in United States dollars. See Amount In Usd details below.
- amount
In Usd Changes to this property will trigger replacement.
- Defines the amount of money paid to an Amazon Mechanical Turk worker in United States dollars. See Amount In Usd details below.
FlowDefinitionHumanLoopConfigPublicWorkforceTaskPriceAmountInUsd, FlowDefinitionHumanLoopConfigPublicWorkforceTaskPriceAmountInUsdArgs
- Cents
Changes to this property will trigger replacement.
- The fractional portion, in cents, of the amount. Valid value range between
0
and99
. - Dollars
Changes to this property will trigger replacement.
- The whole number of dollars in the amount. Valid value range between
0
and2
. - Tenth
Fractions Of ACent Changes to this property will trigger replacement.
- Fractions of a cent, in tenths. Valid value range between
0
and9
.
- Cents
Changes to this property will trigger replacement.
- The fractional portion, in cents, of the amount. Valid value range between
0
and99
. - Dollars
Changes to this property will trigger replacement.
- The whole number of dollars in the amount. Valid value range between
0
and2
. - Tenth
Fractions Of ACent Changes to this property will trigger replacement.
- Fractions of a cent, in tenths. Valid value range between
0
and9
.
- cents
Changes to this property will trigger replacement.
- The fractional portion, in cents, of the amount. Valid value range between
0
and99
. - dollars
Changes to this property will trigger replacement.
- The whole number of dollars in the amount. Valid value range between
0
and2
. - tenth
Fractions Of ACent Changes to this property will trigger replacement.
- Fractions of a cent, in tenths. Valid value range between
0
and9
.
- cents
Changes to this property will trigger replacement.
- The fractional portion, in cents, of the amount. Valid value range between
0
and99
. - dollars
Changes to this property will trigger replacement.
- The whole number of dollars in the amount. Valid value range between
0
and2
. - tenth
Fractions Of ACent Changes to this property will trigger replacement.
- Fractions of a cent, in tenths. Valid value range between
0
and9
.
- cents
Changes to this property will trigger replacement.
- The fractional portion, in cents, of the amount. Valid value range between
0
and99
. - dollars
Changes to this property will trigger replacement.
- The whole number of dollars in the amount. Valid value range between
0
and2
. - tenth_
fractions_ of_ a_ cent Changes to this property will trigger replacement.
- Fractions of a cent, in tenths. Valid value range between
0
and9
.
- cents
Changes to this property will trigger replacement.
- The fractional portion, in cents, of the amount. Valid value range between
0
and99
. - dollars
Changes to this property will trigger replacement.
- The whole number of dollars in the amount. Valid value range between
0
and2
. - tenth
Fractions Of ACent Changes to this property will trigger replacement.
- Fractions of a cent, in tenths. Valid value range between
0
and9
.
FlowDefinitionHumanLoopRequestSource, FlowDefinitionHumanLoopRequestSourceArgs
- Aws
Managed Human Loop Request Source This property is required. Changes to this property will trigger replacement.
- Specifies whether Amazon Rekognition or Amazon Textract are used as the integration source. Valid values are:
AWS/Rekognition/DetectModerationLabels/Image/V3
andAWS/Textract/AnalyzeDocument/Forms/V1
.
- Aws
Managed Human Loop Request Source This property is required. Changes to this property will trigger replacement.
- Specifies whether Amazon Rekognition or Amazon Textract are used as the integration source. Valid values are:
AWS/Rekognition/DetectModerationLabels/Image/V3
andAWS/Textract/AnalyzeDocument/Forms/V1
.
- aws
Managed Human Loop Request Source This property is required. Changes to this property will trigger replacement.
- Specifies whether Amazon Rekognition or Amazon Textract are used as the integration source. Valid values are:
AWS/Rekognition/DetectModerationLabels/Image/V3
andAWS/Textract/AnalyzeDocument/Forms/V1
.
- aws
Managed Human Loop Request Source This property is required. Changes to this property will trigger replacement.
- Specifies whether Amazon Rekognition or Amazon Textract are used as the integration source. Valid values are:
AWS/Rekognition/DetectModerationLabels/Image/V3
andAWS/Textract/AnalyzeDocument/Forms/V1
.
- aws_
managed_ human_ loop_ request_ source This property is required. Changes to this property will trigger replacement.
- Specifies whether Amazon Rekognition or Amazon Textract are used as the integration source. Valid values are:
AWS/Rekognition/DetectModerationLabels/Image/V3
andAWS/Textract/AnalyzeDocument/Forms/V1
.
- aws
Managed Human Loop Request Source This property is required. Changes to this property will trigger replacement.
- Specifies whether Amazon Rekognition or Amazon Textract are used as the integration source. Valid values are:
AWS/Rekognition/DetectModerationLabels/Image/V3
andAWS/Textract/AnalyzeDocument/Forms/V1
.
FlowDefinitionOutputConfig, FlowDefinitionOutputConfigArgs
- S3Output
Path This property is required. Changes to this property will trigger replacement.
- The Amazon S3 path where the object containing human output will be made available.
- Kms
Key Id Changes to this property will trigger replacement.
- The Amazon Key Management Service (KMS) key ARN for server-side encryption.
- S3Output
Path This property is required. Changes to this property will trigger replacement.
- The Amazon S3 path where the object containing human output will be made available.
- Kms
Key Id Changes to this property will trigger replacement.
- The Amazon Key Management Service (KMS) key ARN for server-side encryption.
- s3Output
Path This property is required. Changes to this property will trigger replacement.
- The Amazon S3 path where the object containing human output will be made available.
- kms
Key Id Changes to this property will trigger replacement.
- The Amazon Key Management Service (KMS) key ARN for server-side encryption.
- s3Output
Path This property is required. Changes to this property will trigger replacement.
- The Amazon S3 path where the object containing human output will be made available.
- kms
Key Id Changes to this property will trigger replacement.
- The Amazon Key Management Service (KMS) key ARN for server-side encryption.
- s3_
output_ path This property is required. Changes to this property will trigger replacement.
- The Amazon S3 path where the object containing human output will be made available.
- kms_
key_ id Changes to this property will trigger replacement.
- The Amazon Key Management Service (KMS) key ARN for server-side encryption.
- s3Output
Path This property is required. Changes to this property will trigger replacement.
- The Amazon S3 path where the object containing human output will be made available.
- kms
Key Id Changes to this property will trigger replacement.
- The Amazon Key Management Service (KMS) key ARN for server-side encryption.
Import
Using pulumi import
, import SageMaker AI Flow Definitions using the flow_definition_name
. For example:
$ pulumi import aws:sagemaker/flowDefinition:FlowDefinition 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.