CreateFlowDefinition
Creates a flow definition.
Request Syntax
{
"FlowDefinitionName": "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",
"Tags": [
{
"Key": "string",
"Value": "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 your flow definition.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
^[a-z0-9](-*[a-z0-9]){0,62}Required: Yes
- HumanLoopActivationConfig
-
An object containing information about the events that trigger a human workflow.
Type: HumanLoopActivationConfig object
Required: No
- HumanLoopConfig
-
An object containing information about the tasks the human reviewers will perform.
Type: HumanLoopConfig object
Required: No
- HumanLoopRequestSource
-
Container for configuring the source of human task requests. Use to specify if Amazon Rekognition or Amazon Textract is used as an integration source.
Type: HumanLoopRequestSource object
Required: No
- OutputConfig
-
An object containing information about where the human review results will be uploaded.
Type: FlowDefinitionOutputConfig object
Required: Yes
- RoleArn
-
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.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+=,.@\-_/]+$Required: Yes
- Tags
-
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.
Type: Array of Tag objects
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Required: No
Response Syntax
{
"FlowDefinitionArn": "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.
- FlowDefinitionArn
-
The Amazon Resource Name (ARN) of the flow definition you create.
Type: String
Length Constraints: Maximum length of 1024.
Pattern:
arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]+:[0-9]{12}:flow-definition/.*
Errors
For information about the errors that are common to all actions, see Common Errors.
- ResourceInUse
-
Resource being accessed is in use.
HTTP Status Code: 400
- ResourceLimitExceeded
-
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
