POST

/create-flow

http://appflow.{region}.amazonaws.com/create-flow

Enables your application to create a new flow using Amazon AppFlow. You must create a connector profile before calling this API. Please note that the Request Syntax below shows syntax for multiple destinations, however, you can only transfer data to one item in this list at a time. Amazon AppFlow does not currently support flows to multiple destinations at once.

Access Token Required: API Key

Body Params

tagsobject

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

tasksarrayrequired

A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.

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.

flowNamestringrequired

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

clientTokenstring

The <code>clientToken</code> parameter is an idempotency token. It ensures that your <code>CreateFlow</code> request completes only once. You choose the value to pass. For example, if you don't receive a response from your request, you can safely retry the request with the same <code>clientToken</code> parameter value. If you omit a <code>clientToken</code> value, the Amazon Web Services SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases. If you specify input parameters that differ from your first request, an error occurs. If you use a different value for <code>clientToken</code>, Amazon AppFlow considers it a new call to <code>CreateFlow</code>. The token is active for 8 hours.

descriptionstring

A description of the flow you want to create.

triggerConfigobjectrequired

The trigger settings that determine how and when Amazon AppFlow runs the specified flow.

sourceFlowConfigobjectrequired

Contains information about the configuration of the source connector used in the flow.

metadataCatalogConfigobject

Specifies the configuration that Amazon AppFlow uses when it catalogs your data. When Amazon AppFlow catalogs your data, it stores metadata in a data catalog.

destinationFlowConfigListarrayrequired

The configuration that controls how Amazon AppFlow places data in the destination connector.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://appflow.{region}.amazonaws.com/create-flow' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}