Navigation Guide
You are on the package index page for the Client of a service. Return to the Client landing page

@aws-sdk/client-appflow

Description

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.

Installation

NPM

npm install @aws-sdk/client-appflow

Yarn

yarn add @aws-sdk/client-appflow

pnpm

pnpm add @aws-sdk/client-appflow

Types

Type Name	Type
AccessDeniedException	Class
AggregationConfig	Interface
AggregationType	TypeAlias
AggregationTypeenum	Variable
AmplitudeConnectorOperator	TypeAlias
AmplitudeConnectorOperatorenum	Variable
AmplitudeConnectorProfileCredentials	Interface
AmplitudeConnectorProfileProperties	Interface
AmplitudeMetadata	Interface
AmplitudeSourceProperties	Interface
ApiKeyCredentials	Interface
Appflow	Class
Appflow	Interface
AppflowClient	Class
AppflowClientConfig	Interface
AppflowClientConfigType	TypeAlias
AppflowClientResolvedConfig	Interface
AppflowClientResolvedConfigType	TypeAlias
AppflowPaginationConfiguration	Interface
AppflowServiceException	Class
AuthenticationConfig	Interface
AuthenticationType	TypeAlias
AuthenticationTypeenum	Variable
AuthParameter	Interface
BasicAuthCredentials	Interface
CancelFlowExecutionsCommand	Class
CancelFlowExecutionsCommandInput	Interface
CancelFlowExecutionsCommandOutput	Interface
CancelFlowExecutionsRequest	Interface
CancelFlowExecutionsResponse	Interface
CatalogType	TypeAlias
CatalogTypeenum	Variable
ClientDefaults	Interface
ClientInputEndpointParameters	Interface
ConflictException	Class
ConnectionMode	TypeAlias
ConnectionModeenum	Variable
ConnectorAuthenticationException	Class
ConnectorConfiguration	Interface
ConnectorDetail	Interface
ConnectorEntity	Interface
ConnectorEntityField	Interface
ConnectorMetadata	Interface
ConnectorOAuthRequest	Interface
ConnectorOperator	Interface
ConnectorProfile	Interface
ConnectorProfileConfig	Interface
ConnectorProfileCredentials	Interface
ConnectorProfileProperties	Interface
ConnectorProvisioningConfig	Interface
ConnectorProvisioningType	TypeAlias
ConnectorProvisioningTypeenum	Variable
ConnectorRuntimeSetting	Interface
ConnectorServerException	Class
ConnectorType	TypeAlias
ConnectorTypeenum	Variable
CreateConnectorProfileCommand	Class
CreateConnectorProfileCommandInput	Interface
CreateConnectorProfileCommandOutput	Interface
CreateConnectorProfileRequest	Interface
CreateConnectorProfileResponse	Interface
CreateFlowCommand	Class
CreateFlowCommandInput	Interface
CreateFlowCommandOutput	Interface
CreateFlowRequest	Interface
CreateFlowResponse	Interface
CustomAuthConfig	Interface
CustomAuthCredentials	Interface
CustomConnectorDestinationProperties	Interface
CustomConnectorProfileCredentials	Interface
CustomConnectorProfileProperties	Interface
CustomConnectorSourceProperties	Interface
CustomerProfilesDestinationProperties	Interface
CustomerProfilesMetadata	Interface
DatadogConnectorOperator	TypeAlias
DatadogConnectorOperatorenum	Variable
DatadogConnectorProfileCredentials	Interface
DatadogConnectorProfileProperties	Interface
DatadogMetadata	Interface
DatadogSourceProperties	Interface
DataPullMode	TypeAlias
DataPullModeenum	Variable
DataTransferApi	Interface
DataTransferApiType	TypeAlias
DataTransferApiTypeenum	Variable
DeleteConnectorProfileCommand	Class
DeleteConnectorProfileCommandInput	Interface
DeleteConnectorProfileCommandOutput	Interface
DeleteConnectorProfileRequest	Interface
DeleteConnectorProfileResponse	Interface
DeleteFlowCommand	Class
DeleteFlowCommandInput	Interface
DeleteFlowCommandOutput	Interface
DeleteFlowRequest	Interface
DeleteFlowResponse	Interface
DescribeConnectorCommand	Class
DescribeConnectorCommandInput	Interface
DescribeConnectorCommandOutput	Interface
DescribeConnectorEntityCommand	Class
DescribeConnectorEntityCommandInput	Interface
DescribeConnectorEntityCommandOutput	Interface
DescribeConnectorEntityRequest	Interface
DescribeConnectorEntityResponse	Interface
DescribeConnectorProfilesCommand	Class
DescribeConnectorProfilesCommandInput	Interface
DescribeConnectorProfilesCommandOutput	Interface
DescribeConnectorProfilesRequest	Interface
DescribeConnectorProfilesResponse	Interface
DescribeConnectorRequest	Interface
DescribeConnectorResponse	Interface
DescribeConnectorsCommand	Class
DescribeConnectorsCommandInput	Interface
DescribeConnectorsCommandOutput	Interface
DescribeConnectorsRequest	Interface
DescribeConnectorsResponse	Interface
DescribeFlowCommand	Class
DescribeFlowCommandInput	Interface
DescribeFlowCommandOutput	Interface
DescribeFlowExecutionRecordsCommand	Class
DescribeFlowExecutionRecordsCommandInput	Interface
DescribeFlowExecutionRecordsCommandOutput	Interface
DescribeFlowExecutionRecordsRequest	Interface
DescribeFlowExecutionRecordsResponse	Interface
DescribeFlowRequest	Interface
DescribeFlowResponse	Interface
DestinationConnectorProperties	Interface
DestinationFieldProperties	Interface
DestinationFlowConfig	Interface
DynatraceConnectorOperator	TypeAlias
DynatraceConnectorOperatorenum	Variable
DynatraceConnectorProfileCredentials	Interface
DynatraceConnectorProfileProperties	Interface
DynatraceMetadata	Interface
DynatraceSourceProperties	Interface
ErrorHandlingConfig	Interface
ErrorInfo	Interface
EventBridgeDestinationProperties	Interface
EventBridgeMetadata	Interface
ExecutionDetails	Interface
ExecutionRecord	Interface
ExecutionResult	Interface
ExecutionStatus	TypeAlias
ExecutionStatusenum	Variable
FieldTypeDetails	Interface
FileType	TypeAlias
FileTypeenum	Variable
FlowDefinition	Interface
FlowStatus	TypeAlias
FlowStatusenum	Variable
GlueDataCatalogConfig	Interface
GoogleAnalyticsConnectorOperator	TypeAlias
GoogleAnalyticsConnectorOperatorenum	Variable
GoogleAnalyticsConnectorProfileCredentials	Interface
GoogleAnalyticsConnectorProfileProperties	Interface
GoogleAnalyticsMetadata	Interface
GoogleAnalyticsSourceProperties	Interface
HoneycodeConnectorProfileCredentials	Interface
HoneycodeConnectorProfileProperties	Interface
HoneycodeDestinationProperties	Interface
HoneycodeMetadata	Interface
IncrementalPullConfig	Interface
InforNexusConnectorOperator	TypeAlias
InforNexusConnectorOperatorenum	Variable
InforNexusConnectorProfileCredentials	Interface
InforNexusConnectorProfileProperties	Interface
InforNexusMetadata	Interface
InforNexusSourceProperties	Interface
InternalServerException	Class
LambdaConnectorProvisioningConfig	Interface
ListConnectorEntitiesCommand	Class
ListConnectorEntitiesCommandInput	Interface
ListConnectorEntitiesCommandOutput	Interface
ListConnectorEntitiesRequest	Interface
ListConnectorEntitiesResponse	Interface
ListConnectorsCommand	Class
ListConnectorsCommandInput	Interface
ListConnectorsCommandOutput	Interface
ListConnectorsRequest	Interface
ListConnectorsResponse	Interface
ListFlowsCommand	Class
ListFlowsCommandInput	Interface
ListFlowsCommandOutput	Interface
ListFlowsRequest	Interface
ListFlowsResponse	Interface
ListTagsForResourceCommand	Class
ListTagsForResourceCommandInput	Interface
ListTagsForResourceCommandOutput	Interface
ListTagsForResourceRequest	Interface
ListTagsForResourceResponse	Interface
LookoutMetricsDestinationProperties	Interface
MarketoConnectorOperator	TypeAlias
MarketoConnectorOperatorenum	Variable
MarketoConnectorProfileCredentials	Interface
MarketoConnectorProfileProperties	Interface
MarketoDestinationProperties	Interface
MarketoMetadata	Interface
MarketoSourceProperties	Interface
MetadataCatalogConfig	Interface
MetadataCatalogDetail	Interface
OAuth2Credentials	Interface
OAuth2CustomParameter	Interface
OAuth2CustomPropType	TypeAlias
OAuth2CustomPropTypeenum	Variable
OAuth2Defaults	Interface
OAuth2GrantType	TypeAlias
OAuth2GrantTypeenum	Variable
OAuth2Properties	Interface
OAuthCredentials	Interface
OAuthProperties	Interface
Operator	TypeAlias
Operatorenum	Variable
OperatorPropertiesKeys	TypeAlias
OperatorPropertiesKeysenum	Variable
Operators	TypeAlias
Operatorsenum	Variable
paginateDescribeConnectorProfiles	Variable
paginateDescribeConnectors	Variable
paginateDescribeFlowExecutionRecords	Variable
paginateListConnectors	Variable
paginateListFlows	Variable
PardotConnectorOperator	TypeAlias
PardotConnectorOperatorenum	Variable
PardotConnectorProfileCredentials	Interface
PardotConnectorProfileProperties	Interface
PardotMetadata	Interface
PardotSourceProperties	Interface
PathPrefix	TypeAlias
PathPrefixenum	Variable
PrefixConfig	Interface
PrefixFormat	TypeAlias
PrefixFormatenum	Variable
PrefixType	TypeAlias
PrefixTypeenum	Variable
PrivateConnectionProvisioningFailureCause	TypeAlias
PrivateConnectionProvisioningFailureCauseenum	Variable
PrivateConnectionProvisioningState	Interface
PrivateConnectionProvisioningStatus	TypeAlias
PrivateConnectionProvisioningStatusenum	Variable
Range	Interface
RedshiftConnectorProfileCredentials	Interface
RedshiftConnectorProfileProperties	Interface
RedshiftDestinationProperties	Interface
RedshiftMetadata	Interface
RegisterConnectorCommand	Class
RegisterConnectorCommandInput	Interface
RegisterConnectorCommandOutput	Interface
RegisterConnectorRequest	Interface
RegisterConnectorResponse	Interface
RegistrationOutput	Interface
ResetConnectorMetadataCacheCommand	Class
ResetConnectorMetadataCacheCommandInput	Interface
ResetConnectorMetadataCacheCommandOutput	Interface
ResetConnectorMetadataCacheRequest	Interface
ResetConnectorMetadataCacheResponse	Interface
ResourceNotFoundException	Class
RuntimeExtension	Interface
S3ConnectorOperator	TypeAlias
S3ConnectorOperatorenum	Variable
S3DestinationProperties	Interface
S3InputFileType	TypeAlias
S3InputFileTypeenum	Variable
S3InputFormatConfig	Interface
S3Metadata	Interface
S3OutputFormatConfig	Interface
S3SourceProperties	Interface
SalesforceConnectorOperator	TypeAlias
SalesforceConnectorOperatorenum	Variable
SalesforceConnectorProfileCredentials	Interface
SalesforceConnectorProfileProperties	Interface
SalesforceDataTransferApi	TypeAlias
SalesforceDataTransferApienum	Variable
SalesforceDestinationProperties	Interface
SalesforceMetadata	Interface
SalesforceSourceProperties	Interface
SAPODataConnectorOperator	TypeAlias
SAPODataConnectorOperatorenum	Variable
SAPODataConnectorProfileCredentials	Interface
SAPODataConnectorProfileProperties	Interface
SAPODataDestinationProperties	Interface
SAPODataMetadata	Interface
SAPODataPaginationConfig	Interface
SAPODataParallelismConfig	Interface
SAPODataSourceProperties	Interface
ScheduledTriggerProperties	Interface
ScheduleFrequencyType	TypeAlias
ScheduleFrequencyTypeenum	Variable
ServiceInputTypes	TypeAlias
ServiceNowConnectorOperator	TypeAlias
ServiceNowConnectorOperatorenum	Variable
ServiceNowConnectorProfileCredentials	Interface
ServiceNowConnectorProfileProperties	Interface
ServiceNowMetadata	Interface
ServiceNowSourceProperties	Interface
ServiceOutputTypes	TypeAlias
ServiceQuotaExceededException	Class
SingularConnectorOperator	TypeAlias
SingularConnectorOperatorenum	Variable
SingularConnectorProfileCredentials	Interface
SingularConnectorProfileProperties	Interface
SingularMetadata	Interface
SingularSourceProperties	Interface
SlackConnectorOperator	TypeAlias
SlackConnectorOperatorenum	Variable
SlackConnectorProfileCredentials	Interface
SlackConnectorProfileProperties	Interface
SlackMetadata	Interface
SlackSourceProperties	Interface
SnowflakeConnectorProfileCredentials	Interface
SnowflakeConnectorProfileProperties	Interface
SnowflakeDestinationProperties	Interface
SnowflakeMetadata	Interface
SourceConnectorProperties	Interface
SourceFieldProperties	Interface
SourceFlowConfig	Interface
StartFlowCommand	Class
StartFlowCommandInput	Interface
StartFlowCommandOutput	Interface
StartFlowRequest	Interface
StartFlowResponse	Interface
StopFlowCommand	Class
StopFlowCommandInput	Interface
StopFlowCommandOutput	Interface
StopFlowRequest	Interface
StopFlowResponse	Interface
SuccessResponseHandlingConfig	Interface
SupportedDataTransferType	TypeAlias
SupportedDataTransferTypeenum	Variable
SupportedFieldTypeDetails	Interface
TagResourceCommand	Class
TagResourceCommandInput	Interface
TagResourceCommandOutput	Interface
TagResourceRequest	Interface
TagResourceResponse	Interface
Task	Interface
TaskType	TypeAlias
TaskTypeenum	Variable
ThrottlingException	Class
TrendmicroConnectorOperator	TypeAlias
TrendmicroConnectorOperatorenum	Variable
TrendmicroConnectorProfileCredentials	Interface
TrendmicroConnectorProfileProperties	Interface
TrendmicroMetadata	Interface
TrendmicroSourceProperties	Interface
TriggerConfig	Interface
TriggerProperties	Interface
TriggerType	TypeAlias
TriggerTypeenum	Variable
UnregisterConnectorCommand	Class
UnregisterConnectorCommandInput	Interface
UnregisterConnectorCommandOutput	Interface
UnregisterConnectorRequest	Interface
UnregisterConnectorResponse	Interface
UnsupportedOperationException	Class
UntagResourceCommand	Class
UntagResourceCommandInput	Interface
UntagResourceCommandOutput	Interface
UntagResourceRequest	Interface
UntagResourceResponse	Interface
UpdateConnectorProfileCommand	Class
UpdateConnectorProfileCommandInput	Interface
UpdateConnectorProfileCommandOutput	Interface
UpdateConnectorProfileRequest	Interface
UpdateConnectorProfileResponse	Interface
UpdateConnectorRegistrationCommand	Class
UpdateConnectorRegistrationCommandInput	Interface
UpdateConnectorRegistrationCommandOutput	Interface
UpdateConnectorRegistrationRequest	Interface
UpdateConnectorRegistrationResponse	Interface
UpdateFlowCommand	Class
UpdateFlowCommandInput	Interface
UpdateFlowCommandOutput	Interface
UpdateFlowRequest	Interface
UpdateFlowResponse	Interface
UpsolverDestinationProperties	Interface
UpsolverMetadata	Interface
UpsolverS3OutputFormatConfig	Interface
ValidationException	Class
VeevaConnectorOperator	TypeAlias
VeevaConnectorOperatorenum	Variable
VeevaConnectorProfileCredentials	Interface
VeevaConnectorProfileProperties	Interface
VeevaMetadata	Interface
VeevaSourceProperties	Interface
WriteOperationType	TypeAlias
WriteOperationTypeenum	Variable
ZendeskConnectorOperator	TypeAlias
ZendeskConnectorOperatorenum	Variable
ZendeskConnectorProfileCredentials	Interface
ZendeskConnectorProfileProperties	Interface
ZendeskDestinationProperties	Interface
ZendeskMetadata	Interface
ZendeskSourceProperties	Interface

Getting Started

References

@aws-sdk/client-appflow

Description

Installation

Types

Table of Contents

Search