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

ListWorkflowRuns

Lists all workflow runs for a specific workflow definition with optional filtering and pagination.

Request Syntax


POST /workflow-definitions/workflowDefinitionName/workflow-runs?maxResults=maxResults&nextToken=nextToken HTTP/1.1
Content-type: application/json

{
   "sortOrder": "string"
}

URI Request Parameters

The request uses the following URI parameters.

maxResults

The maximum number of workflow runs to return in a single response.

Valid Range: Minimum value of 1. Maximum value of 100.

nextToken

The token for retrieving the next page of results.

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

Pattern: \S*

workflowDefinitionName

The name of the workflow definition to list workflow runs for.

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.

sortOrder

The sort order for the returned workflow runs (ascending or descending).

Type: String

Valid Values: Ascending | Descending

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "workflowRunSummaries": [ 
      { 
         "endedAt": "string",
         "startedAt": "string",
         "status": "string",
         "traceLocation": { 
            "location": "string",
            "locationType": "string"
         },
         "workflowRunArn": "string",
         "workflowRunId": "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.

nextToken

The token for retrieving the next page of results, if available.

Type: String

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

Pattern: \S*

workflowRunSummaries

A list of summary information for workflow runs.

Type: Array of WorkflowRunSummary objects

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