flow_definitions

Creates, updates, deletes, gets or lists a flow_definitions resource.

Overview

Name	flow_definitions
Type	Resource
Id	aws.sagemaker.flow_definitions

Fields

The following fields are returned by SELECT queries:

describe_flow_definition

Name	Datatype	Description
creation_time	string (date-time)	The timestamp when the flow definition was created.
failure_reason	string	The reason your flow definition failed.
flow_definition_arn	string	The Amazon Resource Name (ARN) of the flow defintion. (pattern: <code>arn:aws[a-z-]:sagemaker:[a-z0-9-]+:[0-9]{12}:flow-definition/.</code>)
flow_definition_name	string	The Amazon Resource Name (ARN) of the flow definition. (pattern: <code>[a-z0-9](-*[a-z0-9]){0,62}</code>)
flow_definition_status	string	The status of the flow definition. Valid values are listed below. (Initializing, Active, Failed, Deleting)
human_loop_activation_config	object	An object containing information about what triggers a human review workflow.
human_loop_config	object	An object containing information about who works on the task, the workforce task price, and other task details.
human_loop_request_source	object	Container for configuring the source of human task requests. Used to specify if Amazon Rekognition or Amazon Textract is used as an integration source.
output_config	object	An object containing information about the output file.
role_arn	string	The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) execution role for the flow definition. (pattern: <code>arn:aws[a-z-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@-_/]+</code>)

list_flow_definitions

Name	Datatype	Description
creation_time	string (date-time)	The timestamp when SageMaker created the flow definition.
failure_reason	string	The reason why the flow definition creation failed. A failure reason is returned only when the flow definition status is Failed.
flow_definition_arn	string	The Amazon Resource Name (ARN) of the flow definition. (pattern: <code>arn:aws[a-z-]:sagemaker:[a-z0-9-]+:[0-9]{12}:flow-definition/.</code>)
flow_definition_name	string	The name of the flow definition. (pattern: <code>[a-z0-9](-*[a-z0-9]){0,62}</code>)
flow_definition_status	string	The status of the flow definition. Valid values: (Initializing, Active, Failed, Deleting)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_flow_definition	select	region		Returns information about the specified flow definition.
list_flow_definitions	select	region		Returns information about the flow definitions in your account.
create_flow_definition	insert	region, FlowDefinitionName, OutputConfig, RoleArn		Creates a flow definition.
delete_flow_definition	delete	region		Deletes the specified flow definition.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_flow_definition

Returns information about the specified flow definition.

SELECT
creation_time,
failure_reason,
flow_definition_arn,
flow_definition_name,
flow_definition_status,
human_loop_activation_config,
human_loop_config,
human_loop_request_source,
output_config,
role_arn
FROM aws.sagemaker.flow_definitions
WHERE region = '{{ region }}' -- required
;

list_flow_definitions

Returns information about the flow definitions in your account.

SELECT
creation_time,
failure_reason,
flow_definition_arn,
flow_definition_name,
flow_definition_status
FROM aws.sagemaker.flow_definitions
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_flow_definition

Creates a flow definition.

INSERT INTO aws.sagemaker.flow_definitions (
FlowDefinitionName,
HumanLoopRequestSource,
HumanLoopActivationConfig,
HumanLoopConfig,
OutputConfig,
RoleArn,
Tags,
region
)
SELECT 
'{{ FlowDefinitionName }}' /* required */,
'{{ HumanLoopRequestSource }}',
'{{ HumanLoopActivationConfig }}',
'{{ HumanLoopConfig }}',
'{{ OutputConfig }}' /* required */,
'{{ RoleArn }}' /* required */,
'{{ Tags }}',
'{{ region }}'
RETURNING
flow_definition_arn
;

Manifest

# Description fields are for documentation purposes
- name: flow_definitions
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the flow_definitions resource.
  - name: FlowDefinitionName
    value: "{{ FlowDefinitionName }}"
    description: |
      The name of your flow definition.
  - name: HumanLoopRequestSource
    description: |
      Container for configuring the source of human task requests. Use to specify if Amazon Rekognition or Amazon Textract is used as an integration source.
    value:
      AwsManagedHumanLoopRequestSource: "{{ AwsManagedHumanLoopRequestSource }}"
  - name: HumanLoopActivationConfig
    description: |
      An object containing information about the events that trigger a human workflow.
    value:
      HumanLoopActivationConditionsConfig:
        HumanLoopActivationConditions: "{{ HumanLoopActivationConditions }}"
  - name: HumanLoopConfig
    description: |
      An object containing information about the tasks the human reviewers will perform.
    value:
      WorkteamArn: "{{ WorkteamArn }}"
      HumanTaskUiArn: "{{ HumanTaskUiArn }}"
      TaskTitle: "{{ TaskTitle }}"
      TaskDescription: "{{ TaskDescription }}"
      TaskCount: {{ TaskCount }}
      TaskAvailabilityLifetimeInSeconds: {{ TaskAvailabilityLifetimeInSeconds }}
      TaskTimeLimitInSeconds: {{ TaskTimeLimitInSeconds }}
      TaskKeywords:
        - "{{ TaskKeywords }}"
      PublicWorkforceTaskPrice:
        AmountInUsd:
          Dollars: {{ Dollars }}
          Cents: {{ Cents }}
          TenthFractionsOfACent: {{ TenthFractionsOfACent }}
  - name: OutputConfig
    description: |
      An object containing information about where the human review results will be uploaded.
    value:
      S3OutputPath: "{{ S3OutputPath }}"
      KmsKeyId: "{{ KmsKeyId }}"
  - name: RoleArn
    value: "{{ RoleArn }}"
    description: |
      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.
  - name: Tags
    description: |
      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.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

DELETE examples

delete_flow_definition

Deletes the specified flow definition.

DELETE FROM aws.sagemaker.flow_definitions
WHERE region = '{{ region }}' --required
;