Query to list all workflows.
Request Syntax
POST /domains/DomainName/workflows?max-results=MaxResults&next-token=NextToken HTTP/1.1
Content-type: application/json
{
"QueryEndDate": number,
"QueryStartDate": number,
"Status": "string",
"WorkflowType": "string"
}URI Request Parameters
The request uses the following URI parameters.
- DomainName
-
The unique name of the domain.
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[a-zA-Z0-9_-]+$Required: Yes
- MaxResults
-
The maximum number of results to return per page.
Valid Range: Minimum value of 1. Maximum value of 100.
- NextToken
-
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
Length Constraints: Minimum length of 1. Maximum length of 1024.
Request Body
The request accepts the following data in JSON format.
- QueryEndDate
-
Retrieve workflows ended after timestamp.
Type: Timestamp
Required: No
- QueryStartDate
-
Retrieve workflows started after timestamp.
Type: Timestamp
Required: No
- Status
-
Status of workflow execution.
Type: String
Valid Values:
NOT_STARTED | IN_PROGRESS | COMPLETE | FAILED | SPLIT | RETRY | CANCELLEDRequired: No
- WorkflowType
-
The type of workflow. The only supported value is APPFLOW_INTEGRATION.
Type: String
Valid Values:
APPFLOW_INTEGRATIONRequired: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"Items": [
{
"CreatedAt": number,
"LastUpdatedAt": number,
"Status": "string",
"StatusDescription": "string",
"WorkflowId": "string",
"WorkflowType": "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.
- Items
-
List containing workflow details.
Type: Array of ListWorkflowsItem objects
- NextToken
-
If there are additional results, this is the token for the next set of results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
- BadRequestException
-
The input you provided is invalid.
HTTP Status Code: 400
- InternalServerException
-
An internal service error occurred.
HTTP Status Code: 500
- ResourceNotFoundException
-
The requested resource does not exist, or access was denied.
HTTP Status Code: 404
- ThrottlingException
-
You exceeded the maximum number of requests.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
