ListFlowDefinitions
Returns information about the flow definitions in your account.
Request Syntax
{
"CreationTimeAfter": number
,
"CreationTimeBefore": number
,
"MaxResults": number
,
"NextToken": "string
",
"SortOrder": "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.
- CreationTimeAfter
-
A filter that returns only flow definitions with a creation time greater than or equal to the specified timestamp.
Type: Timestamp
Required: No
- CreationTimeBefore
-
A filter that returns only flow definitions that were created before the specified timestamp.
Type: Timestamp
Required: No
- MaxResults
-
The total number of items to return. If the total number of available items is more than the value specified in
MaxResults
, then aNextToken
will be provided in the output that you can use to resume pagination.Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NextToken
-
A token to resume pagination.
Type: String
Length Constraints: Maximum length of 8192.
Pattern:
.*
Required: No
- SortOrder
-
An optional value that specifies whether you want the results sorted in
Ascending
orDescending
order.Type: String
Valid Values:
Ascending | Descending
Required: No
Response Syntax
{
"FlowDefinitionSummaries": [
{
"CreationTime": number,
"FailureReason": "string",
"FlowDefinitionArn": "string",
"FlowDefinitionName": "string",
"FlowDefinitionStatus": "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.
- FlowDefinitionSummaries
-
An array of objects describing the flow definitions.
Type: Array of FlowDefinitionSummary objects
- NextToken
-
A token to resume pagination.
Type: String
Length Constraints: Maximum length of 8192.
Pattern:
.*
Errors
For information about the errors that are common to all actions, see Common Errors.
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: