@aws-sdk/client-appflow

Description

AWS SDK for JavaScript Appflow Client for Node.js, Browser and React Native.

Welcome to the Amazon AppFlow API reference. This guide is for developers who need
detailed information about the Amazon AppFlow API operations, data types, and errors.

Amazon AppFlow is a fully managed integration service that enables you to securely
transfer data between software as a service (SaaS) applications like Salesforce, Marketo,
Slack, and ServiceNow, and Amazon Web Services like Amazon S3 and Amazon Redshift.

Use the following links to get started on the Amazon AppFlow API:

• 
  

  
  Actions: An alphabetical list of all Amazon AppFlow API operations.

  
  


• 
  

  
  Data
  types: An alphabetical list of all Amazon AppFlow data types.

  
  


• 
  

  
  Common parameters: Parameters that all Query operations can use.

  
  


• 
  

  
  Common
  errors: Client and server errors that all operations can return.

  
  

If you're new to Amazon AppFlow, we recommend that you review the Amazon AppFlow
User Guide.

Amazon AppFlow API users can use vendor-specific mechanisms for OAuth, and include
applicable OAuth attributes (such as auth-code and redirecturi) with
the connector-specific ConnectorProfileProperties when creating a new connector
profile using Amazon AppFlow API operations. For example, Salesforce users can refer to
the
Authorize Apps with OAuth
documentation.

Installing

To install this package, simply type add or install @aws-sdk/client-appflow
using your favorite package manager:
- npm install @aws-sdk/client-appflow
- yarn add @aws-sdk/client-appflow
- pnpm add @aws-sdk/client-appflow

Getting Started

$3

The AWS SDK is modulized by clients and commands.
To send a request, you only need to import the AppflowClient and
the commands you need, for example ListFlowsCommand:

``js
// ES5 example
const { AppflowClient, ListFlowsCommand } = require("@aws-sdk/client-appflow");
`

`ts
// ES6+ example
import { AppflowClient, ListFlowsCommand } from "@aws-sdk/client-appflow";
`

$3

To send a request, you:

- Initiate client with configuration (e.g. credentials, region).
- Initiate command with input parameters.
- Call send operation on client with command object as input.
- If you are using a custom http handler, you may call destroy() to close open connections.

`js
// a client can be shared by different commands.
const client = new AppflowClient({ region: "REGION" });

const params = { /* input parameters / };
const command = new ListFlowsCommand(params);
`

#### Async/await

We recommend using await
operator to wait for the promise returned by send operation as follows:

`js
// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}
`

Async-await is clean, concise, intuitive, easy to debug and has better error handling
as compared to using Promise chains or callbacks.

#### Promises

You can also use Promise chaining
to execute send operation.

`js
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
`

Promises can also be called using .catch() and .finally() as follows:

`js
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
`

#### Callbacks

We do not recommend using callbacks because of callback hell,
but they are supported by the send operation.

`js
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
`

#### v2 compatible style

The client can also send requests using v2 compatible style.
However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
on modular packages in AWS SDK for JavaScript

`ts
import * as AWS from "@aws-sdk/client-appflow";
const client = new AWS.Appflow({ region: "REGION" });

// async/await.
try {
const data = await client.listFlows(params);
// process data.
} catch (error) {
// error handling.
}

// Promises.
client
.listFlows(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});

// callbacks.
client.listFlows(params, (err, data) => {
// process err and data.
});
`

$3

When the service returns an exception, the error will include the exception information,
as well as response metadata (e.g. request id).

`js
try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}
`

Getting Help

Please use these community resources for getting help.
We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

- Visit Developer Guide
or API Reference.
- Check out the blog posts tagged with aws-sdk-js
on AWS Developer Blog.
- Ask a question on StackOverflow and tag it with aws-sdk-js.
- Join the AWS JavaScript community on gitter.
- If it turns out that you may have found a bug, please open an issue.

To test your universal JavaScript code in Node.js, browser and react-native environments,
visit our code samples repo.

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-appflow` package is updated.
To contribute to client you can check our generate clients scripts.

License

This SDK is distributed under the
Apache License, Version 2.0,
see LICENSE for more information.

Client Commands (Operations List)

CancelFlowExecutions

Command API Reference / Input / Output

CreateConnectorProfile

Command API Reference / Input / Output

CreateFlow

Command API Reference / Input / Output

DeleteConnectorProfile

Command API Reference / Input / Output

DeleteFlow

Command API Reference / Input / Output

DescribeConnector

Command API Reference / Input / Output

DescribeConnectorEntity

Command API Reference / Input / Output

DescribeConnectorProfiles

Command API Reference / Input / Output

DescribeConnectors

Command API Reference / Input / Output

DescribeFlow

Command API Reference / Input / Output

DescribeFlowExecutionRecords

Command API Reference / Input / Output

ListConnectorEntities

Command API Reference / Input / Output

ListConnectors

Command API Reference / Input / Output

ListFlows

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

RegisterConnector

Command API Reference / Input / Output

ResetConnectorMetadataCache

Command API Reference / Input / Output

StartFlow

Command API Reference / Input / Output

StopFlow

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

UnregisterConnector

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output

UpdateConnectorProfile

Command API Reference / Input / Output

UpdateConnectorRegistration

Command API Reference / Input / Output

UpdateFlow

Command API Reference / Input / Output