NAME

Paws::Appflow - Perl Interface to AWS Amazon Appflow

SYNOPSIS

  use Paws;
  my $obj = Paws->service('Appflow');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

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 AWS services like Amazon S3 and Amazon Redshift.

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

Actions (https://docs.aws.amazon.com/appflow/1.0/APIReference/API_Operations.html): An alphabetical list of all Amazon AppFlow API operations.
Data types (https://docs.aws.amazon.com/appflow/1.0/APIReference/API_Types.html): An alphabetical list of all Amazon AppFlow data types.
Common parameters (https://docs.aws.amazon.com/appflow/1.0/APIReference/CommonParameters.html): Parameters that all Query operations can use.
Common errors (https://docs.aws.amazon.com/appflow/1.0/APIReference/CommonErrors.html): 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 (https://docs.aws.amazon.com/appflow/latest/userguide/what-is-appflow.html).

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 (https://help.salesforce.com/articleView?id=remoteaccess_authenticate.htm) documentation.

For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/appflow-2020-08-23>

METHODS

CreateConnectorProfile

ConnectionMode => Str
ConnectorProfileConfig => Paws::Appflow::ConnectorProfileConfig
ConnectorProfileName => Str
ConnectorType => Str
[KmsArn => Str]

Each argument is described in detail in: Paws::Appflow::CreateConnectorProfile

Returns: a Paws::Appflow::CreateConnectorProfileResponse instance

Creates a new connector profile associated with your AWS account. There is a soft quota of 100 connector profiles per AWS account. If you need more connector profiles than this quota allows, you can submit a request to the Amazon AppFlow team through the Amazon AppFlow support channel.

CreateFlow

DestinationFlowConfigList => ArrayRef[Paws::Appflow::DestinationFlowConfig]
FlowName => Str
SourceFlowConfig => Paws::Appflow::SourceFlowConfig
Tasks => ArrayRef[Paws::Appflow::Task]
TriggerConfig => Paws::Appflow::TriggerConfig
[Description => Str]
[KmsArn => Str]
[Tags => Paws::Appflow::TagMap]

Each argument is described in detail in: Paws::Appflow::CreateFlow

Returns: a Paws::Appflow::CreateFlowResponse instance

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.

DeleteConnectorProfile

ConnectorProfileName => Str
[ForceDelete => Bool]

Each argument is described in detail in: Paws::Appflow::DeleteConnectorProfile

Returns: a Paws::Appflow::DeleteConnectorProfileResponse instance

Enables you to delete an existing connector profile.

DeleteFlow

FlowName => Str
[ForceDelete => Bool]

Each argument is described in detail in: Paws::Appflow::DeleteFlow

Returns: a Paws::Appflow::DeleteFlowResponse instance

Enables your application to delete an existing flow. Before deleting the flow, Amazon AppFlow validates the request by checking the flow configuration and status. You can delete flows one at a time.

DescribeConnectorEntity

ConnectorEntityName => Str
[ConnectorProfileName => Str]
[ConnectorType => Str]

Each argument is described in detail in: Paws::Appflow::DescribeConnectorEntity

Returns: a Paws::Appflow::DescribeConnectorEntityResponse instance

Provides details regarding the entity used with the connector, with a description of the data model for each entity.

DescribeConnectorProfiles

[ConnectorProfileNames => ArrayRef[Str|Undef]]
[ConnectorType => Str]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Appflow::DescribeConnectorProfiles

Returns: a Paws::Appflow::DescribeConnectorProfilesResponse instance

Returns a list of "connector-profile" details matching the provided "connector-profile" names and "connector-types". Both input lists are optional, and you can use them to filter the result.

If no names or "connector-types" are provided, returns all connector profiles in a paginated form. If there is no match, this operation returns an empty list.

DescribeConnectors

[ConnectorTypes => ArrayRef[Str|Undef]]
[NextToken => Str]

Each argument is described in detail in: Paws::Appflow::DescribeConnectors

Returns: a Paws::Appflow::DescribeConnectorsResponse instance

Describes the connectors vended by Amazon AppFlow for specified connector types. If you don't specify a connector type, this operation describes all connectors vended by Amazon AppFlow. If there are more connectors than can be returned in one page, the response contains a "nextToken" object, which can be be passed in to the next call to the "DescribeConnectors" API operation to retrieve the next page.

DescribeFlow

FlowName => Str

Each argument is described in detail in: Paws::Appflow::DescribeFlow

Returns: a Paws::Appflow::DescribeFlowResponse instance

Provides a description of the specified flow.

DescribeFlowExecutionRecords

FlowName => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Appflow::DescribeFlowExecutionRecords

Returns: a Paws::Appflow::DescribeFlowExecutionRecordsResponse instance

Fetches the execution history of the flow.

ListConnectorEntities

[ConnectorProfileName => Str]
[ConnectorType => Str]
[EntitiesPath => Str]

Each argument is described in detail in: Paws::Appflow::ListConnectorEntities

Returns: a Paws::Appflow::ListConnectorEntitiesResponse instance

Returns the list of available connector entities supported by Amazon AppFlow. For example, you can query Salesforce for Account and Opportunity entities, or query ServiceNow for the Incident entity.

ListFlows

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Appflow::ListFlows

Returns: a Paws::Appflow::ListFlowsResponse instance

Lists all of the flows associated with your account.

ListTagsForResource

ResourceArn => Str

Each argument is described in detail in: Paws::Appflow::ListTagsForResource

Returns: a Paws::Appflow::ListTagsForResourceResponse instance

Retrieves the tags that are associated with a specified flow.

StartFlow

FlowName => Str

Each argument is described in detail in: Paws::Appflow::StartFlow

Returns: a Paws::Appflow::StartFlowResponse instance

Activates an existing flow. For on-demand flows, this operation runs the flow immediately. For schedule and event-triggered flows, this operation activates the flow.

StopFlow

FlowName => Str

Each argument is described in detail in: Paws::Appflow::StopFlow

Returns: a Paws::Appflow::StopFlowResponse instance

Deactivates the existing flow. For on-demand flows, this operation returns an "unsupportedOperationException" error message. For schedule and event-triggered flows, this operation deactivates the flow.