Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . sagemaker ]

create-flow-definition

Description

Creates a flow definition.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-flow-definition
--flow-definition-name <value>
[--human-loop-activation-config <value>]
--human-loop-config <value>
--output-config <value>
--role-arn <value>
[--tags <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--flow-definition-name (string)

The name of your flow definition.

--human-loop-activation-config (structure)

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

Shorthand Syntax:

HumanLoopRequestSource={AwsManagedHumanLoopRequestSource=string},HumanLoopActivationConditionsConfig={HumanLoopActivationConditions=string}

JSON Syntax:

{
  "HumanLoopRequestSource": {
    "AwsManagedHumanLoopRequestSource": "AWS/Rekognition/DetectModerationLabels/Image/V3"|"AWS/Textract/AnalyzeDocument/Forms/V1"
  },
  "HumanLoopActivationConditionsConfig": {
    "HumanLoopActivationConditions": "string"
  }
}

--human-loop-config (structure)

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

Shorthand Syntax:

WorkteamArn=string,HumanTaskUiArn=string,TaskTitle=string,TaskDescription=string,TaskCount=integer,TaskAvailabilityLifetimeInSeconds=integer,TaskTimeLimitInSeconds=integer,TaskKeywords=string,string,PublicWorkforceTaskPrice={AmountInUsd={Dollars=integer,Cents=integer,TenthFractionsOfACent=integer}}

JSON Syntax:

{
  "WorkteamArn": "string",
  "HumanTaskUiArn": "string",
  "TaskTitle": "string",
  "TaskDescription": "string",
  "TaskCount": integer,
  "TaskAvailabilityLifetimeInSeconds": integer,
  "TaskTimeLimitInSeconds": integer,
  "TaskKeywords": ["string", ...],
  "PublicWorkforceTaskPrice": {
    "AmountInUsd": {
      "Dollars": integer,
      "Cents": integer,
      "TenthFractionsOfACent": integer
    }
  }
}

--output-config (structure)

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

Shorthand Syntax:

S3OutputPath=string,KmsKeyId=string

JSON Syntax:

{
  "S3OutputPath": "string",
  "KmsKeyId": "string"
}

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

--tags (list)

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.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

FlowDefinitionArn -> (string)

The Amazon Resource Name (ARN) of the flow definition you create.