Table Of Contents

Feedback

User Guide

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

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . sagemaker ]

describe-flow-definition

Description

Returns information about the specified flow definition.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-flow-definition
--flow-definition-name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--flow-definition-name (string)

The name of the flow definition.

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

FlowDefinitionName -> (string)

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

FlowDefinitionStatus -> (string)

The status of the flow definition. Valid values are listed below.

CreationTime -> (timestamp)

The timestamp when the flow definition was created.

HumanLoopRequestSource -> (structure)

Container for configuring the source of human task requests. Used to specify if Amazon Rekognition or Amazon Textract is used as an integration source.

AwsManagedHumanLoopRequestSource -> (string)

Specifies whether Amazon Rekognition or Amazon Textract are used as the integration source. The default field settings and JSON parsing rules are different based on the integration source. Valid values:

HumanLoopActivationConfig -> (structure)

An object containing information about what triggers a human review workflow.

HumanLoopActivationConditionsConfig -> (structure)

Container structure for defining under what conditions SageMaker creates a human loop.

HumanLoopActivationConditions -> (string)

JSON expressing use-case specific conditions declaratively. If any condition is matched, atomic tasks are created against the configured work team. The set of conditions is different for Rekognition and Textract. For more information about how to structure the JSON, see JSON Schema for Human Loop Activation Conditions in Amazon Augmented AI in the Amazon SageMaker Developer Guide .

HumanLoopConfig -> (structure)

An object containing information about who works on the task, the workforce task price, and other task details.

WorkteamArn -> (string)

Amazon Resource Name (ARN) of a team of workers.

HumanTaskUiArn -> (string)

The Amazon Resource Name (ARN) of the human task user interface.

TaskTitle -> (string)

A title for the human worker task.

TaskDescription -> (string)

A description for the human worker task.

TaskCount -> (integer)

The number of distinct workers who will perform the same task on each object. For example, if TaskCount is set to 3 for an image classification labeling job, three workers will classify each input image. Increasing TaskCount can improve label accuracy.

TaskAvailabilityLifetimeInSeconds -> (integer)

The length of time that a task remains available for labeling by human workers.

TaskTimeLimitInSeconds -> (integer)

The amount of time that a worker has to complete a task.

TaskKeywords -> (list)

Keywords used to describe the task so that workers can discover the task.

(string)

PublicWorkforceTaskPrice -> (structure)

Defines the amount of money paid to an Amazon Mechanical Turk worker for each task performed.

Use one of the following prices for bounding box tasks. Prices are in US dollars and should be based on the complexity of the task; the longer it takes in your initial testing, the more you should offer.

  • 0.036
  • 0.048
  • 0.060
  • 0.072
  • 0.120
  • 0.240
  • 0.360
  • 0.480
  • 0.600
  • 0.720
  • 0.840
  • 0.960
  • 1.080
  • 1.200

Use one of the following prices for image classification, text classification, and custom tasks. Prices are in US dollars.

  • 0.012
  • 0.024
  • 0.036
  • 0.048
  • 0.060
  • 0.072
  • 0.120
  • 0.240
  • 0.360
  • 0.480
  • 0.600
  • 0.720
  • 0.840
  • 0.960
  • 1.080
  • 1.200

Use one of the following prices for semantic segmentation tasks. Prices are in US dollars.

  • 0.840
  • 0.960
  • 1.080
  • 1.200

Use one of the following prices for Textract AnalyzeDocument Important Form Key Amazon Augmented AI review tasks. Prices are in US dollars.

  • 2.400
  • 2.280
  • 2.160
  • 2.040
  • 1.920
  • 1.800
  • 1.680
  • 1.560
  • 1.440
  • 1.320
  • 1.200
  • 1.080
  • 0.960
  • 0.840
  • 0.720
  • 0.600
  • 0.480
  • 0.360
  • 0.240
  • 0.120
  • 0.072
  • 0.060
  • 0.048
  • 0.036
  • 0.024
  • 0.012

Use one of the following prices for Rekognition DetectModerationLabels Amazon Augmented AI review tasks. Prices are in US dollars.

  • 1.200
  • 1.080
  • 0.960
  • 0.840
  • 0.720
  • 0.600
  • 0.480
  • 0.360
  • 0.240
  • 0.120
  • 0.072
  • 0.060
  • 0.048
  • 0.036
  • 0.024
  • 0.012

Use one of the following prices for Amazon Augmented AI custom human review tasks. Prices are in US dollars.

  • 1.200
  • 1.080
  • 0.960
  • 0.840
  • 0.720
  • 0.600
  • 0.480
  • 0.360
  • 0.240
  • 0.120
  • 0.072
  • 0.060
  • 0.048
  • 0.036
  • 0.024
  • 0.012

AmountInUsd -> (structure)

Defines the amount of money paid to an Amazon Mechanical Turk worker in United States dollars.

Dollars -> (integer)

The whole number of dollars in the amount.

Cents -> (integer)

The fractional portion, in cents, of the amount.

TenthFractionsOfACent -> (integer)

Fractions of a cent, in tenths.

OutputConfig -> (structure)

An object containing information about the output file.

S3OutputPath -> (string)

The Amazon S3 path where the object containing human output will be made available.

KmsKeyId -> (string)

The Amazon Key Management Service (KMS) key ID for server-side encryption.

RoleArn -> (string)

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) execution role for the flow definition.

FailureReason -> (string)