Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

list_flows

list_flows(**kwargs)

Lists all of the flows associated with your account.

See also: AWS API Documentation

Request Syntax

response = client.list_flows(
    maxResults=123,
    nextToken='string'
)
Parameters
  • maxResults (integer) -- Specifies the maximum number of items that should be returned in the result set.
  • nextToken (string) -- The pagination token for next page of data.
Return type

dict

Returns

Response Syntax

{
    'flows': [
        {
            'flowArn': 'string',
            'description': 'string',
            'flowName': 'string',
            'flowStatus': 'Active'|'Deprecated'|'Deleted'|'Draft'|'Errored'|'Suspended',
            'sourceConnectorType': 'Salesforce'|'Singular'|'Slack'|'Redshift'|'S3'|'Marketo'|'Googleanalytics'|'Zendesk'|'Servicenow'|'Datadog'|'Trendmicro'|'Snowflake'|'Dynatrace'|'Infornexus'|'Amplitude'|'Veeva'|'EventBridge'|'LookoutMetrics'|'Upsolver'|'Honeycode'|'CustomerProfiles'|'SAPOData'|'CustomConnector'|'Pardot',
            'sourceConnectorLabel': 'string',
            'destinationConnectorType': 'Salesforce'|'Singular'|'Slack'|'Redshift'|'S3'|'Marketo'|'Googleanalytics'|'Zendesk'|'Servicenow'|'Datadog'|'Trendmicro'|'Snowflake'|'Dynatrace'|'Infornexus'|'Amplitude'|'Veeva'|'EventBridge'|'LookoutMetrics'|'Upsolver'|'Honeycode'|'CustomerProfiles'|'SAPOData'|'CustomConnector'|'Pardot',
            'destinationConnectorLabel': 'string',
            'triggerType': 'Scheduled'|'Event'|'OnDemand',
            'createdAt': datetime(2015, 1, 1),
            'lastUpdatedAt': datetime(2015, 1, 1),
            'createdBy': 'string',
            'lastUpdatedBy': 'string',
            'tags': {
                'string': 'string'
            },
            'lastRunExecutionDetails': {
                'mostRecentExecutionMessage': 'string',
                'mostRecentExecutionTime': datetime(2015, 1, 1),
                'mostRecentExecutionStatus': 'InProgress'|'Successful'|'Error'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • flows (list) --

      The list of flows associated with your account.

      • (dict) --

        The properties of the flow, such as its source, destination, trigger type, and so on.

        • flowArn (string) --

          The flow's Amazon Resource Name (ARN).

        • description (string) --

          A user-entered description of the flow.

        • flowName (string) --

          The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

        • flowStatus (string) --

          Indicates the current status of the flow.

        • sourceConnectorType (string) --

          Specifies the source connector type, such as Salesforce, Amazon S3, Amplitude, and so on.

        • sourceConnectorLabel (string) --

          The label of the source connector in the flow.

        • destinationConnectorType (string) --

          Specifies the destination connector type, such as Salesforce, Amazon S3, Amplitude, and so on.

        • destinationConnectorLabel (string) --

          The label of the destination connector in the flow.

        • triggerType (string) --

          Specifies the type of flow trigger. This can be OnDemand , Scheduled , or Event .

        • createdAt (datetime) --

          Specifies when the flow was created.

        • lastUpdatedAt (datetime) --

          Specifies when the flow was last updated.

        • createdBy (string) --

          The ARN of the user who created the flow.

        • lastUpdatedBy (string) --

          Specifies the account user name that most recently updated the flow.

        • tags (dict) --

          The tags used to organize, track, or control access for your flow.

          • (string) --
            • (string) --
        • lastRunExecutionDetails (dict) --

          Describes the details of the most recent flow run.

          • mostRecentExecutionMessage (string) --

            Describes the details of the most recent flow run.

          • mostRecentExecutionTime (datetime) --

            Specifies the time of the most recent flow run.

          • mostRecentExecutionStatus (string) --

            Specifies the status of the most recent flow run.

    • nextToken (string) --

      The pagination token for next page of data.

Exceptions

  • Appflow.Client.exceptions.ValidationException
  • Appflow.Client.exceptions.InternalServerException