Amazon.Appflow.Model

AppFlow/Requester has invalid or missing permissions.

The aggregation settings that you can use to customize the output format of your flow data.

The connector-specific credentials required when using Amplitude.

The connector-specific profile properties required when using Amplitude.

The connector metadata specific to Amplitude.

The properties that are applied when Amplitude is being used as a source.

The API key credentials required for API key authentication.

Paginators for the Appflow service

Contains information about the authentication config that the connector supports.

Information about required authentication parameters.

The basic auth credentials required for basic authentication.

Container for the parameters to the CancelFlowExecutions operation. Cancels active runs for a flow.

You can cancel all of the active runs for a flow, or you can cancel specific runs by providing their IDs.

You can cancel a flow run only when the run is in progress. You can't cancel a run that has already completed or failed. You also can't cancel a run that's scheduled to occur but hasn't started yet. To prevent a scheduled run, you can deactivate the flow with the StopFlow action.

You cannot resume a run after you cancel it.

When you send your request, the status for each run becomes CancelStarted. When the cancellation completes, the status becomes Canceled.

This is the response object from the CancelFlowExecutions operation.

There was a conflict when processing the request (for example, a flow with the given name already exists within the account. Check for conflicting resource names and try again.

An error occurred when authenticating with the connector endpoint.

The configuration settings related to a given connector.

Information about the registered connector.

The high-level entity that can be queried in Amazon AppFlow. For example, a Salesforce entity might be an Account or Opportunity, whereas a ServiceNow entity might be an Incident.

Describes the data model of a connector field. For example, for an account entity, the fields would be account name, account ID, and so on.

A structure to specify connector-specific metadata such as oAuthScopes, supportedRegions, privateLinkServiceUrl, and so on.

Used by select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack.

The operation to be performed on the provided source fields.

Describes an instance of a connector. This includes the provided name, credentials ARN, connection-mode, and so on. To keep the API intuitive and extensible, the fields that are common to all types of connector profiles are explicitly specified at the top level. The rest of the connector-specific properties are available via the connectorProfileProperties field.

Defines the connector-specific configuration and credentials for the connector profile.

The connector-specific credentials required by a connector.

The connector-specific profile properties required by each connector.

Contains information about the configuration of the connector being registered.

Contains information about the connector runtime settings that are required for flow execution.

An error occurred when retrieving data from the connector endpoint.

Container for the parameters to the CreateConnectorProfile operation. Creates a new connector profile associated with your Amazon Web Services account. There is a soft quota of 100 connector profiles per Amazon Web Services 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. In each connector profile that you create, you can provide the credentials and properties for only one connector.

This is the response object from the CreateConnectorProfile operation.

Container for the parameters to the CreateFlow operation. 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.

This is the response object from the CreateFlow operation.

Configuration information required for custom authentication.

The custom credentials required for custom authentication.

The properties that are applied when the custom connector is being used as a destination.

The connector-specific profile credentials that are required when using the custom connector.

The profile properties required by the custom connector.

The properties that are applied when the custom connector is being used as a source.

The properties that are applied when Amazon Connect Customer Profiles is used as a destination.

The connector metadata specific to Amazon Connect Customer Profiles.

The connector-specific credentials required by Datadog.

The connector-specific profile properties required by Datadog.

The connector metadata specific to Datadog.

The properties that are applied when Datadog is being used as a source.

The API of the connector application that Amazon AppFlow uses to transfer your data.

Container for the parameters to the DeleteConnectorProfile operation. Enables you to delete an existing connector profile.

This is the response object from the DeleteConnectorProfile operation.

Container for the parameters to the DeleteFlow operation. 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.

This is the response object from the DeleteFlow operation.

Container for the parameters to the DescribeConnectorEntity operation. Provides details regarding the entity used with the connector, with a description of the data model for each field in that entity.

This is the response object from the DescribeConnectorEntity operation.

Container for the parameters to the DescribeConnectorProfiles operation. 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.

This is the response object from the DescribeConnectorProfiles operation.

Container for the parameters to the DescribeConnector operation. Describes the given custom connector registered in your Amazon Web Services account. This API can be used for custom connectors that are registered in your account and also for Amazon authored connectors.

This is the response object from the DescribeConnector operation.

Container for the parameters to the DescribeConnectors operation. 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.

This is the response object from the DescribeConnectors operation.

Container for the parameters to the DescribeFlowExecutionRecords operation. Fetches the execution history of the flow.

This is the response object from the DescribeFlowExecutionRecords operation.

Container for the parameters to the DescribeFlow operation. Provides a description of the specified flow.

This is the response object from the DescribeFlow operation.

This stores the information that is required to query a particular connector.

The properties that can be applied to a field when connector is being used as a destination.

Contains information about the configuration of destination connectors present in the flow.

The connector-specific profile credentials required by Dynatrace.

The connector-specific profile properties required by Dynatrace.

The connector metadata specific to Dynatrace.

The properties that are applied when Dynatrace is being used as a source.

The settings that determine how Amazon AppFlow handles an error when placing data in the destination. For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. ErrorHandlingConfig is a part of the destination connector details.

Provides details in the event of a failed flow, including the failure count and the related error messages.

The properties that are applied when Amazon EventBridge is being used as a destination.

The connector metadata specific to Amazon EventBridge.

Describes the details of the flow run, including the timestamp, status, and message.

Specifies information about the past flow run instances for a given flow.

Specifies the end result of the flow run.

Contains details regarding the supported field type and the operators that can be applied for filtering.

The properties of the flow, such as its source, destination, trigger type, and so on.

Specifies the configuration that Amazon AppFlow uses when it catalogs your data with the Glue Data Catalog. When Amazon AppFlow catalogs your data, it stores metadata in Data Catalog tables. This metadata represents the data that's transferred by the flow that you configure with these settings.

You can configure a flow with these settings only when the flow destination is Amazon S3.

The connector-specific profile credentials required by Google Analytics.

The connector-specific profile properties required by Google Analytics.

The connector metadata specific to Google Analytics.

The properties that are applied when Google Analytics is being used as a source.

The connector-specific credentials required when using Amazon Honeycode.

The connector-specific properties required when using Amazon Honeycode.

The properties that are applied when Amazon Honeycode is used as a destination.

The connector metadata specific to Amazon Honeycode.

Specifies the configuration used when importing incremental records from the source.

The connector-specific profile credentials required by Infor Nexus.

The connector-specific profile properties required by Infor Nexus.

The connector metadata specific to Infor Nexus.

The properties that are applied when Infor Nexus is being used as a source.

An internal service error occurred during the processing of your request. Try again later.

Contains information about the configuration of the lambda which is being registered as the connector.

Container for the parameters to the ListConnectorEntities operation. 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.

This is the response object from the ListConnectorEntities operation.

Container for the parameters to the ListConnectors operation. Returns the list of all registered custom connectors in your Amazon Web Services account. This API lists only custom connectors registered in this account, not the Amazon Web Services authored connectors.

This is the response object from the ListConnectors operation.

Container for the parameters to the ListFlows operation. Lists all of the flows associated with your account.

This is the response object from the ListFlows operation.

Container for the parameters to the ListTagsForResource operation. Retrieves the tags that are associated with a specified flow.

This is the response object from the ListTagsForResource operation.

The properties that are applied when Amazon Lookout for Metrics is used as a destination.

The connector-specific profile credentials required by Marketo.

The connector-specific profile properties required when using Marketo.

The properties that Amazon AppFlow applies when you use Marketo as a flow destination.

The connector metadata specific to Marketo.

The properties that are applied when Marketo is being used as a source.

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.

Describes the metadata catalog, metadata table, and data partitions that Amazon AppFlow used for the associated flow run.

The OAuth 2.0 credentials required for OAuth 2.0 authentication.

Custom parameter required for OAuth 2.0 authentication.

Contains the default values required for OAuth 2.0 authentication.

The OAuth 2.0 properties required for OAuth 2.0 authentication.

The OAuth credentials required for OAuth type authentication.

The OAuth properties required for OAuth type authentication.

The connector-specific profile credentials required when using Salesforce Pardot.

The connector-specific profile properties required when using Salesforce Pardot.

The connector metadata specific to Salesforce Pardot.

The properties that are applied when Salesforce Pardot is being used as a source.

Specifies elements that Amazon AppFlow includes in the file and folder names in the flow destination.

Specifies the private connection provisioning state.

The range of values that the property supports.

The connector-specific profile credentials required when using Amazon Redshift.

The connector-specific profile properties when using Amazon Redshift.

The properties that are applied when Amazon Redshift is being used as a destination.

The connector metadata specific to Amazon Redshift.

Container for the parameters to the RegisterConnector operation. Registers a new custom connector with your Amazon Web Services account. Before you can register the connector, you must deploy the associated AWS lambda function in your account.

This is the response object from the RegisterConnector operation.

Describes the status of an attempt from Amazon AppFlow to register a resource.

When you run a flow that you've configured to use a metadata catalog, Amazon AppFlow registers a metadata table and data partitions with that catalog. This operation provides the status of that registration attempt. The operation also indicates how many related resources Amazon AppFlow created or updated.

Container for the parameters to the ResetConnectorMetadataCache operation. Resets metadata about your connector entities that Amazon AppFlow stored in its cache. Use this action when you want Amazon AppFlow to return the latest information about the data that you have in a source application.

Amazon AppFlow returns metadata about your entities when you use the ListConnectorEntities or DescribeConnectorEntities actions. Following these actions, Amazon AppFlow caches the metadata to reduce the number of API requests that it must send to the source application. Amazon AppFlow automatically resets the cache once every hour, but you can use this action when you want to get the latest metadata right away.

This is the response object from the ResetConnectorMetadataCache operation.

The resource specified in the request (such as the source or destination connector profile) is not found.

The properties that are applied when Amazon S3 is used as a destination.

When you use Amazon S3 as the source, the configuration format that you provide the flow input data.

The connector metadata specific to Amazon S3.

The configuration that determines how Amazon AppFlow should format the flow output data when Amazon S3 is used as the destination.

The properties that are applied when Amazon S3 is being used as the flow source.

The connector-specific profile credentials required when using Salesforce.

The connector-specific profile properties required when using Salesforce.

The properties that are applied when Salesforce is being used as a destination.

The connector metadata specific to Salesforce.

The properties that are applied when Salesforce is being used as a source.

The connector-specific profile credentials required when using SAPOData.

The connector-specific profile properties required when using SAPOData.

The properties that are applied when using SAPOData as a flow destination

The connector metadata specific to SAPOData.

Sets the page size for each concurrent process that transfers OData records from your SAP instance. A concurrent process is query that retrieves a batch of records as part of a flow run. Amazon AppFlow can run multiple concurrent processes in parallel to transfer data faster.

Sets the number of concurrent processes that transfer OData records from your SAP instance. A concurrent process is query that retrieves a batch of records as part of a flow run. Amazon AppFlow can run multiple concurrent processes in parallel to transfer data faster.

The properties that are applied when using SAPOData as a flow source.

Specifies the configuration details of a schedule-triggered flow as defined by the user. Currently, these settings only apply to the Scheduled trigger type.

The connector-specific profile credentials required when using ServiceNow.

The connector-specific profile properties required when using ServiceNow.

The connector metadata specific to ServiceNow.

The properties that are applied when ServiceNow is being used as a source.

The request would cause a service quota (such as the number of flows) to be exceeded.

The connector-specific profile credentials required when using Singular.

The connector-specific profile properties required when using Singular.

The connector metadata specific to Singular.

The properties that are applied when Singular is being used as a source.

The connector-specific profile credentials required when using Slack.

The connector-specific profile properties required when using Slack.

The connector metadata specific to Slack.

The properties that are applied when Slack is being used as a source.

The connector-specific profile credentials required when using Snowflake.

The connector-specific profile properties required when using Snowflake.

The properties that are applied when Snowflake is being used as a destination.

The connector metadata specific to Snowflake.

Specifies the information that is required to query a particular connector.

The properties that can be applied to a field when the connector is being used as a source.

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

Container for the parameters to the StartFlow operation. 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.

This is the response object from the StartFlow operation.

Container for the parameters to the StopFlow operation. 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.

This is the response object from the StopFlow operation.

Determines how Amazon AppFlow handles the success response that it gets from the connector after placing data.

For example, this setting would determine where to write the response from the destination connector upon a successful insert operation.

Contains details regarding all the supported FieldTypes and their corresponding filterOperators and supportedValues.

Container for the parameters to the TagResource operation. Applies a tag to the specified flow.

This is the response object from the TagResource operation.

A class for modeling different type of tasks. Task implementation varies based on the TaskType.

API calls have exceeded the maximum allowed API request rate per account and per Region.

The connector-specific profile credentials required when using Trend Micro.

The connector-specific profile properties required when using Trend Micro.

The connector metadata specific to Trend Micro.

The properties that are applied when using Trend Micro as a flow source.

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

Specifies the configuration details that control the trigger for a flow. Currently, these settings only apply to the Scheduled trigger type.

Container for the parameters to the UnregisterConnector operation. Unregisters the custom connector registered in your account that matches the connector label provided in the request.

This is the response object from the UnregisterConnector operation.

The requested operation is not supported for the current flow.

Container for the parameters to the UntagResource operation. Removes a tag from the specified flow.

This is the response object from the UntagResource operation.

Container for the parameters to the UpdateConnectorProfile operation. Updates a given connector profile associated with your account.

This is the response object from the UpdateConnectorProfile operation.

Container for the parameters to the UpdateConnectorRegistration operation. Updates a custom connector that you've previously registered. This operation updates the connector with one of the following:

• The latest version of the AWS Lambda function that's assigned to the connector

• A new AWS Lambda function that you specify

This is the response object from the UpdateConnectorRegistration operation.

Container for the parameters to the UpdateFlow operation. Updates an existing flow.

This is the response object from the UpdateFlow operation.

The properties that are applied when Upsolver is used as a destination.

The connector metadata specific to Upsolver.

The configuration that determines how Amazon AppFlow formats the flow output data when Upsolver is used as the destination.

The request has invalid or missing parameters.

The connector-specific profile credentials required when using Veeva.

The connector-specific profile properties required when using Veeva.

The connector metadata specific to Veeva.

The properties that are applied when using Veeva as a flow source.

The connector-specific profile credentials required when using Zendesk.

The connector-specific profile properties required when using Zendesk.

The properties that are applied when Zendesk is used as a destination.

The connector metadata specific to Zendesk.

The properties that are applied when using Zendesk as a flow source.

Paginators for the Appflow service

Paginator for the DescribeConnectorProfiles operation

Paginator for the DescribeConnectors operation

Paginator for the DescribeFlowExecutionRecords operation

Paginator for the ListConnectors operation

Paginator for the ListFlows operation