ListExecutions
Lists all in-progress executions for the specified workflow.
Note
If the specified workflow ID cannot be found, ListExecutions returns a
ResourceNotFound exception.
Request Syntax
{
"MaxResults": number,
"NextToken": "string",
"WorkflowId": "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.
- MaxResults
-
The maximum number of items to return.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
- NextToken
-
ListExecutionsreturns theNextTokenparameter in the output. You can then pass theNextTokenparameter in a subsequent command to continue listing additional executions.This is useful for pagination, for instance. If you have 100 executions for a workflow, you might only want to list first 10. If so, call the API by specifying the
max-results:aws transfer list-executions --max-results 10This returns details for the first 10 executions, as well as the pointer (
NextToken) to the eleventh execution. You can now call the API again, supplying theNextTokenvalue you received:aws transfer list-executions --max-results 10 --next-token $somePointerReturnedFromPreviousListResultThis call returns the next 10 executions, the 11th through the 20th. You can then repeat the call until the details for all 100 executions have been returned.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 6144.
Required: No
- WorkflowId
-
A unique identifier for the workflow.
Type: String
Length Constraints: Fixed length of 19.
Pattern:
w-([a-z0-9]{17})Required: Yes
Response Syntax
{
"Executions": [
{
"ExecutionId": "string",
"InitialFileLocation": {
"EfsFileLocation": {
"FileSystemId": "string",
"Path": "string"
},
"S3FileLocation": {
"Bucket": "string",
"Etag": "string",
"Key": "string",
"VersionId": "string"
}
},
"ServiceMetadata": {
"UserDetails": {
"ServerId": "string",
"SessionId": "string",
"UserName": "string"
}
},
"Status": "string"
}
],
"NextToken": "string",
"WorkflowId": "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.
- Executions
-
Returns the details for each execution, in a
ListedExecutionarray.Type: Array of ListedExecution objects
- NextToken
-
ListExecutionsreturns theNextTokenparameter in the output. You can then pass theNextTokenparameter in a subsequent command to continue listing additional executions.Type: String
Length Constraints: Minimum length of 1. Maximum length of 6144.
- WorkflowId
-
A unique identifier for the workflow.
Type: String
Length Constraints: Fixed length of 19.
Pattern:
w-([a-z0-9]{17})
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServiceError
-
This exception is thrown when an error occurs in the AWS Transfer Family service.
HTTP Status Code: 500
- InvalidNextTokenException
-
The
NextTokenparameter that was passed is invalid.HTTP Status Code: 400
- InvalidRequestException
-
This exception is thrown when the client submits a malformed request.
HTTP Status Code: 400
- ResourceNotFoundException
-
This exception is thrown when a resource is not found by the AWSTransfer Family service.
HTTP Status Code: 400
- ServiceUnavailableException
-
The request has failed because the AWSTransfer Family service is not available.
HTTP Status Code: 500
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
