DescribeFlowDefinition - Amazon SageMaker Service

DescribeFlowDefinition

Returns information about the specified flow definition.

Request Syntax

{ "FlowDefinitionName": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

FlowDefinitionName

The name of the flow definition.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: ^[a-z0-9](-*[a-z0-9])*

Required: Yes

Response Syntax

{ "CreationTime": number, "FailureReason": "string", "FlowDefinitionArn": "string", "FlowDefinitionName": "string", "FlowDefinitionStatus": "string", "HumanLoopActivationConfig": { "HumanLoopActivationConditionsConfig": { "HumanLoopActivationConditions": "string" } }, "HumanLoopConfig": { "HumanTaskUiArn": "string", "PublicWorkforceTaskPrice": { "AmountInUsd": { "Cents": number, "Dollars": number, "TenthFractionsOfACent": number } }, "TaskAvailabilityLifetimeInSeconds": number, "TaskCount": number, "TaskDescription": "string", "TaskKeywords": [ "string" ], "TaskTimeLimitInSeconds": number, "TaskTitle": "string", "WorkteamArn": "string" }, "HumanLoopRequestSource": { "AwsManagedHumanLoopRequestSource": "string" }, "OutputConfig": { "KmsKeyId": "string", "S3OutputPath": "string" }, "RoleArn": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

CreationTime

The timestamp when the flow definition was created.

Type: Timestamp

FailureReason

Type: String

Length Constraints: Maximum length of 1024.

FlowDefinitionArn

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

Type: String

Length Constraints: Maximum length of 1024.

Pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:flow-definition/.*

FlowDefinitionName

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: ^[a-z0-9](-*[a-z0-9])*

FlowDefinitionStatus

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

Type: String

Valid Values: Initializing | Active | Failed | Deleting

HumanLoopActivationConfig

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

Type: HumanLoopActivationConfig object

HumanLoopConfig

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

Type: HumanLoopConfig object

HumanLoopRequestSource

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

Type: HumanLoopRequestSource object

OutputConfig

An object containing information about the output file.

Type: FlowDefinitionOutputConfig object

RoleArn

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

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$

Errors

For information about the errors that are common to all actions, see Common Errors.

ResourceNotFound

Resource being access is not found.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: