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

ListActs

Lists all acts within a specific session with their current status and execution details.

Request Syntax


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

{
   "sortOrder": "string"
}

URI Request Parameters

The request uses the following URI parameters.

maxResults

The maximum number of acts 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*

sessionId

The unique identifier of the session to list acts for.

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

workflowDefinitionName

The name of the workflow definition containing the session.

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

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

Required: Yes

workflowRunId

The unique identifier of the workflow run containing the session.

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

Request Body

The request accepts the following data in JSON format.

sortOrder

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

Type: String

Valid Values: Ascending | Descending

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

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

actSummaries

A list of summary information for acts in the session.

Type: Array of ActSummary objects

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*

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