Skip to content

aws.sagemaker.describe_flow_definition

Example SQL Queries

SELECT * FROM
aws.sagemaker.describe_flow_definition
WHERE
"flow_definition_name" = 'VALUE';

Description

Returns information about the specified flow definition.

Table Definition

Column NameColumn Data Type
flow_definition_name Required Input Column

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

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

creation_time

The timestamp when the flow definition was created.

TIMESTAMP_S
failure_reason

The reason your flow definition failed.

VARCHAR
flow_definition_arn

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

VARCHAR
flow_definition_status

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

VARCHAR
human_loop_activation_config

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

STRUCT(
"human_loop_activation_conditions_config" STRUCT(
"human_loop_activation_conditions" VARCHAR
)
)
Show child fields
human_loop_activation_config.human_loop_activation_conditions_config

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

Show child fields
human_loop_activation_config.human_loop_activation_conditions_config.human_loop_activation_conditions

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.

human_loop_config

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

STRUCT(
"workteam_arn" VARCHAR,
"human_task_ui_arn" VARCHAR,
"task_title" VARCHAR,
"task_description" VARCHAR,
"task_count" BIGINT,
"task_availability_lifetime_in_seconds" BIGINT,
"task_time_limit_in_seconds" BIGINT,
"task_keywords" VARCHAR[],
"public_workforce_task_price" STRUCT(
"amount_in_usd" STRUCT(
"dollars" BIGINT,
"cents" BIGINT,
"tenth_fractions_of_a_cent" BIGINT
)
)
)
Show child fields
human_loop_config.human_task_ui_arn

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

You can use standard HTML and Crowd HTML Elements to create a custom worker task template. You use this template to create a human task UI.

To learn how to create a custom HTML template, see Create Custom Worker Task Template.

To learn how to create a human task UI, which is a worker task template that can be used in a flow definition, see Create and Delete a Worker Task Templates.

human_loop_config.public_workforce_task_price

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

Show child fields
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.

Show child fields
human_loop_config.public_workforce_task_price.amount_in_usd.cents

The fractional portion, in cents, of the amount.

human_loop_config.public_workforce_task_price.amount_in_usd.dollars

The whole number of dollars in the amount.

human_loop_config.public_workforce_task_price.amount_in_usd.tenth_fractions_of_a_cent

Fractions of a cent, in tenths.

human_loop_config.task_availability_lifetime_in_seconds

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

human_loop_config.task_count

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.

human_loop_config.task_description

A description for the human worker task.

human_loop_config.task_keywords[]
human_loop_config.task_time_limit_in_seconds

The amount of time that a worker has to complete a task. The default value is 3,600 seconds (1 hour).

human_loop_config.task_title

A title for the human worker task.

human_loop_config.workteam_arn

Amazon Resource Name (ARN) of a team of workers. To learn more about the types of workforces and work teams you can create and use with Amazon A2I, see Create and Manage Workforces.

human_loop_request_source

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

STRUCT(
"aws_managed_human_loop_request_source" VARCHAR
)
Show child fields
human_loop_request_source.aws_managed_human_loop_request_source

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:

output_config

An object containing information about the output file.

STRUCT(
"s3_output_path" VARCHAR,
"kms_key_id" VARCHAR
)
Show child fields
output_config.kms_key_id

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

output_config.s3_output_path

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

To learn more about the format of Amazon A2I output data, see Amazon A2I Output Data.

role_arn

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

VARCHAR