Class: Aws::SageMaker::Types::CreateFlowDefinitionRequest

Inherits:

Struct

• Object
• Struct
• Aws::SageMaker::Types::CreateFlowDefinitionRequest

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-sagemaker/types.rb

Overview

Note:

When making an API call, you may pass CreateFlowDefinitionRequest data as a hash:

{
  flow_definition_name: "FlowDefinitionName", # required
  human_loop_activation_config: {
    human_loop_request_source: { # required
      aws_managed_human_loop_request_source: "AWS/Rekognition/DetectModerationLabels/Image/V3", # required, accepts AWS/Rekognition/DetectModerationLabels/Image/V3, AWS/Textract/AnalyzeDocument/Forms/V1
    },
    human_loop_activation_conditions_config: { # required
      human_loop_activation_conditions: "HumanLoopActivationConditions", # required
    },
  },
  human_loop_config: { # required
    workteam_arn: "WorkteamArn", # required
    human_task_ui_arn: "HumanTaskUiArn", # required
    task_title: "FlowDefinitionTaskTitle", # required
    task_description: "FlowDefinitionTaskDescription", # required
    task_count: 1, # required
    task_availability_lifetime_in_seconds: 1,
    task_time_limit_in_seconds: 1,
    task_keywords: ["FlowDefinitionTaskKeyword"],
    public_workforce_task_price: {
      amount_in_usd: {
        dollars: 1,
        cents: 1,
        tenth_fractions_of_a_cent: 1,
      },
    },
  },
  output_config: { # required
    s3_output_path: "S3Uri", # required
    kms_key_id: "KmsKeyId",
  },
  role_arn: "RoleArn", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

See Also:

• AWS API Documentation

Instance Attribute Summary

• #flow_definition_name ⇒ String

  The name of your flow definition.

• #human_loop_activation_config ⇒ Types::HumanLoopActivationConfig

  An object containing information about the events that trigger a human workflow.

• #human_loop_config ⇒ Types::HumanLoopConfig

  An object containing information about the tasks the human reviewers will perform.

• #output_config ⇒ Types::FlowDefinitionOutputConfig

  An object containing information about where the human review results will be uploaded.

• #role_arn ⇒ String

  The Amazon Resource Name (ARN) of the role needed to call other services on your behalf.

• #tags ⇒ Array<Types::Tag>

  An array of key-value pairs that contain metadata to help you categorize and organize a flow definition.

Instance Attribute Details

#flow_definition_name ⇒ String

The name of your flow definition.

Returns:

• (String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 2905

class CreateFlowDefinitionRequest < Struct.new(
  :flow_definition_name,
  :human_loop_activation_config,
  :human_loop_config,
  :output_config,
  :role_arn,
  :tags)
  include Aws::Structure
end

#human_loop_activation_config ⇒ Types::HumanLoopActivationConfig

An object containing information about the events that trigger a human workflow.

Returns:

• (Types::HumanLoopActivationConfig)

# File 'lib/aws-sdk-sagemaker/types.rb', line 2905

class CreateFlowDefinitionRequest < Struct.new(
  :flow_definition_name,
  :human_loop_activation_config,
  :human_loop_config,
  :output_config,
  :role_arn,
  :tags)
  include Aws::Structure
end

#human_loop_config ⇒ Types::HumanLoopConfig

An object containing information about the tasks the human reviewers will perform.

Returns:

• (Types::HumanLoopConfig)

# File 'lib/aws-sdk-sagemaker/types.rb', line 2905

class CreateFlowDefinitionRequest < Struct.new(
  :flow_definition_name,
  :human_loop_activation_config,
  :human_loop_config,
  :output_config,
  :role_arn,
  :tags)
  include Aws::Structure
end

#output_config ⇒ Types::FlowDefinitionOutputConfig

An object containing information about where the human review results will be uploaded.

Returns:

• (Types::FlowDefinitionOutputConfig)

# File 'lib/aws-sdk-sagemaker/types.rb', line 2905

class CreateFlowDefinitionRequest < Struct.new(
  :flow_definition_name,
  :human_loop_activation_config,
  :human_loop_config,
  :output_config,
  :role_arn,
  :tags)
  include Aws::Structure
end

#role_arn ⇒ String

The Amazon Resource Name (ARN) of the role needed to call other services on your behalf. For example, ‘arn:aws:iam::1234567890:role/service-role/AmazonSageMaker-ExecutionRole-20180111T151298`.

Returns:

• (String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 2905

class CreateFlowDefinitionRequest < Struct.new(
  :flow_definition_name,
  :human_loop_activation_config,
  :human_loop_config,
  :output_config,
  :role_arn,
  :tags)
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

An array of key-value pairs that contain metadata to help you categorize and organize a flow definition. Each tag consists of a key and a value, both of which you define.

Returns:

• (Array<Types::Tag>)

# File 'lib/aws-sdk-sagemaker/types.rb', line 2905

class CreateFlowDefinitionRequest < Struct.new(
  :flow_definition_name,
  :human_loop_activation_config,
  :human_loop_config,
  :output_config,
  :role_arn,
  :tags)
  include Aws::Structure
end