Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . appflow ]

list-flows¶

Description¶

Lists all of the flows associated with your account.

Synopsis¶

  list-flows
[--max-results <value>]
[--next-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options¶

--max-results (integer)

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

--next-token (string)

The pagination token for next page of data.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

json
text
table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output¶

flows -> (list)

The list of flows associated with your account.

(structure)

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 -> (timestamp)

Specifies when the flow was created.

lastUpdatedAt -> (timestamp)

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 -> (map)

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

key -> (string)

value -> (string)

lastRunExecutionDetails -> (structure)

Describes the details of the most recent flow run.

mostRecentExecutionMessage -> (string)

Describes the details of the most recent flow run.

mostRecentExecutionTime -> (timestamp)

Specifies the time of the most recent flow run.

mostRecentExecutionStatus -> (string)

Specifies the status of the most recent flow run.

nextToken -> (string)