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

ListFlows

Lists all of the flows associated with your account.

Request Syntax


POST /list-flows HTTP/1.1
Content-type: application/json

{
   "maxResults": number,
   "nextToken": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

maxResults

Specifies the maximum number of items that should be returned in the result set.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

nextToken

The pagination token for next page of data.

Type: String

Length Constraints: Maximum length of 2048.

Pattern: \S+

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "flows": [ 
      { 
         "createdAt": number,
         "createdBy": "string",
         "description": "string",
         "destinationConnectorLabel": "string",
         "destinationConnectorType": "string",
         "flowArn": "string",
         "flowName": "string",
         "flowStatus": "string",
         "lastRunExecutionDetails": { 
            "mostRecentExecutionMessage": "string",
            "mostRecentExecutionStatus": "string",
            "mostRecentExecutionTime": number
         },
         "lastUpdatedAt": number,
         "lastUpdatedBy": "string",
         "sourceConnectorLabel": "string",
         "sourceConnectorType": "string",
         "tags": { 
            "string" : "string" 
         },
         "triggerType": "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.

flows

The list of flows associated with your account.

Type: Array of FlowDefinition objects

nextToken

The pagination token for next page of data.

Type: String

Length Constraints: Maximum length of 2048.

Pattern: \S+

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerException

An internal service error occurred during the processing of your request. Try again later.

HTTP Status Code: 500

ValidationException

The request has invalid or missing parameters.

HTTP Status Code: 400

Examples

ListFlows examples

This example shows a sample request for the ListFlows API. In the second sample, note that MaxResults will show a number between 1 and 100.

Sample Request


{
  "flowList": [
    {
      "createdAt": "created_time_value",
      "createdBy": "arn:aws:iam::<AccountId>:user/BetaTestUser",
      "description": "test flow 1 description",
      "destinationConnectorType": "S3",
      "destinationConnectorLabel": "MyCustomDestinationConnector",
      "flowArn": "arn:aws:appflow:region:<AccountId>:flow/test-flow-1",
      "flowName": "test-flow-1",
      "flowStatus": "Active",
      "lastRunExecutionDetails":
      {
        "mostRecentExecutionMessage": "Successfully ran the flow",
        "mostRecentExecutionStatus": "Successful",
        "mostRecentExecutionTime": "execution_time_value"
      },
      "lastUpdatedAt": "lastupdated_time_value",
      "lastUpdatedBy": "arn:aws:iam::<AccountId>:user/BetaTestUser",
      "sourceConnectorType": "Salesforce",
      "sourceConnectorLabel": "MyCustomSourceConnector",
      "tags":
      {
        "internalId": "<InternalId>",
        "resourceArn": "arn:aws:appflow:region:<AccountId>:flow/test-flow-1"
      },
      "triggerType": "OnDemand"
    }
  ],
  "nextToken": "next_token_value"
}


{
  "maxResults": 1
}