ListWorkflows
Lists all workflows associated with your Amazon Web Services account for your current region.
Request Syntax
{
"MaxResults": number
,
"NextToken": "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
-
Specifies the maximum number of workflows to return.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
- NextToken
-
ListWorkflows
returns theNextToken
parameter in the output. You can then pass theNextToken
parameter in a subsequent command to continue listing additional workflows.Type: String
Length Constraints: Minimum length of 1. Maximum length of 6144.
Required: No
Response Syntax
{
"NextToken": "string",
"Workflows": [
{
"Arn": "string",
"Description": "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.
- NextToken
-
ListWorkflows
returns theNextToken
parameter in the output. You can then pass theNextToken
parameter in a subsequent command to continue listing additional workflows.Type: String
Length Constraints: Minimum length of 1. Maximum length of 6144.
- Workflows
-
Returns the
Arn
,WorkflowId
, andDescription
for each workflow.Type: Array of ListedWorkflow objects
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 Amazon Transfer Family service.
HTTP Status Code: 500
- InvalidNextTokenException
-
The
NextToken
parameter 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
- ServiceUnavailableException
-
The request has failed because the AmazonTransfer Family service is not available.
HTTP Status Code: 500
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: