Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateWorkflowRun

Creates a new execution instance of a workflow definition with specified parameters.

Request Syntax


PUT /workflow-definitions/workflowDefinitionName/workflow-runs HTTP/1.1
Content-type: application/json

{
   "clientInfo": { 
      "compatibilityVersion": number,
      "sdkVersion": "string"
   },
   "clientToken": "string",
   "logGroupName": "string",
   "modelId": "string"
}

URI Request Parameters

The request uses the following URI parameters.

workflowDefinitionName

The name of the workflow definition to execute.

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

Pattern: [a-zA-Z0-9_-]{1,40}

Required: Yes

Request Body

The request accepts the following data in JSON format.

clientInfo

Information about the client making the request, including compatibility version and SDK version.

Type: ClientInfo object

Required: Yes

clientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Type: String

Length Constraints: Minimum length of 33. Maximum length of 256.

Pattern: [a-zA-Z0-9](-*[a-zA-Z0-9]){0,256}

Required: No

logGroupName

The CloudWatch log group name for storing workflow execution logs.

Type: String

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

Pattern: [a-zA-Z0-9_/.-]+

Required: No

modelId

The ID of the AI model to use for workflow execution.

Type: String

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

Required: Yes

Response Syntax


HTTP/1.1 201
Content-type: application/json

{
   "status": "string",
   "workflowRunId": "string"
}

Response Elements

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

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

status

The initial status of the workflow run after creation.

Type: String

Valid Values: RUNNING | SUCCEEDED | FAILED | TIMED_OUT | DELETING

workflowRunId

The unique identifier for the created workflow run.

Type: String

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Errors

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

AccessDeniedException

You don't have sufficient permissions to perform this action.

message: You don't have sufficient permissions to perform this action. Verify your IAM permissions and try again.

HTTP Status Code: 403

ConflictException

The request could not be completed due to a conflict with the current state of the resource.

message: The requested operation conflicts with the current state of the resource.
resourceId: The identifier of the resource that caused the conflict.
resourceType: The type of resource that caused the conflict.

HTTP Status Code: 409

InternalServerException

An internal server error occurred. Please try again later.

message: The service encountered an internal error. Try again later.
reason: The reason for the internal server error.
retryAfterSeconds: The number of seconds to wait before retrying the request.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource was not found.

message: The specified resource was not found.
resourceId: The identifier of the resource that wasn't found.
resourceType: The type of resource that wasn't found.

HTTP Status Code: 404

ThrottlingException

The request was throttled due to too many requests. Please try again later.

message: The request was denied due to request throttling.
quotaCode: The quota code related to the throttling.
retryAfterSeconds: The number of seconds to wait before retrying the throttled request.
serviceCode: The service code where throttling occurred.

HTTP Status Code: 429

ValidationException

The input parameters for the request are invalid.

fieldList: The list of fields that failed validation.
message: The input fails to satisfy the constraints specified by the service.
reason: The reason for the validation failure.

HTTP Status Code: 400