Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1423398235.2 KB

Provides a description of the specified flow.

post/describe-flow

Request body

flowNamestring required

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

Response

Success

flowArnstring

The flow's Amazon Resource Name (ARN).

descriptionstring

A description of the flow.

flowNamestring

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

kmsArnstring

The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. This is required if you do not want to use the Amazon AppFlow-managed KMS key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.

flowStatus'Active' | 'Deprecated' | 'Deleted' | 'Draft' | 'Errored' | 'Suspended'

Indicates the current status of the flow.

flowStatusMessagestring

Contains an error message if the flow status is in a suspended or error state. This applies only to scheduled or event-triggered flows.

createdAtstring date-time

Specifies when the flow was created.

lastUpdatedAtstring date-time

Specifies when the flow was last updated.

createdBystring

The ARN of the user who created the flow.

lastUpdatedBystring

Specifies the user name of the account that performed the most recent update.

tagsobject

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

schemaVersioninteger
<p>The version number of your data schema. Amazon AppFlow assigns this version number. The version number increases by one when you change any of the following settings in your flow configuration:</p> <ul> <li> <p>Source-to-destination field mappings</p> </li> <li> <p>Field data types</p> </li> <li> <p>Partition keys</p> </li> </ul>