Package-level declarations

Types

Link copied to clipboard

AppFlow/Requester has invalid or missing permissions.

Link copied to clipboard

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

Link copied to clipboard
sealed class AggregationType
Link copied to clipboard
Link copied to clipboard

The connector-specific credentials required when using Amplitude.

Link copied to clipboard

The connector-specific profile properties required when using Amplitude.

Link copied to clipboard

The connector metadata specific to Amplitude.

Link copied to clipboard

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

Link copied to clipboard

The API key credentials required for API key authentication.

Link copied to clipboard

Base class for all service related exceptions thrown by the Appflow client

Link copied to clipboard

Contains information about the authentication config that the connector supports.

Link copied to clipboard
sealed class AuthenticationType
Link copied to clipboard

Information about required authentication parameters.

Link copied to clipboard

The basic auth credentials required for basic authentication.

Link copied to clipboard
sealed class CatalogType
Link copied to clipboard

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.

Link copied to clipboard
sealed class ConnectionMode
Link copied to clipboard

An error occurred when authenticating with the connector endpoint.

Link copied to clipboard

The configuration settings related to a given connector.

Link copied to clipboard

Information about the registered connector.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

The operation to be performed on the provided source fields.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

The connector-specific credentials required by a connector.

Link copied to clipboard

The connector-specific profile properties required by each connector.

Link copied to clipboard

Contains information about the configuration of the connector being registered.

Link copied to clipboard

The type of provisioning that the connector supports, such as Lambda.

Link copied to clipboard

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

Link copied to clipboard

An error occurred when retrieving data from the connector endpoint.

Link copied to clipboard
sealed class ConnectorType
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Configuration information required for custom authentication.

Link copied to clipboard

The custom credentials required for custom authentication.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

The profile properties required by the custom connector.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

The connector metadata specific to Amazon Connect Customer Profiles.

Link copied to clipboard
Link copied to clipboard

The connector-specific credentials required by Datadog.

Link copied to clipboard

The connector-specific profile properties required by Datadog.

Link copied to clipboard

The connector metadata specific to Datadog.

Link copied to clipboard

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

Link copied to clipboard
sealed class DataPullMode
Link copied to clipboard

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

Link copied to clipboard
sealed class DataTransferApiType
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard

The connector-specific profile credentials required by Dynatrace.

Link copied to clipboard

The connector-specific profile properties required by Dynatrace.

Link copied to clipboard

The connector metadata specific to Dynatrace.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard
class ErrorInfo

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

Link copied to clipboard

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

Link copied to clipboard

The connector metadata specific to Amazon EventBridge.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Specifies the end result of the flow run.

Link copied to clipboard
sealed class ExecutionStatus
Link copied to clipboard

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

Link copied to clipboard
sealed class FileType
Link copied to clipboard

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

Link copied to clipboard
sealed class FlowStatus
Link copied to clipboard

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.

The connector-specific profile credentials required by Google Analytics.

The connector-specific profile properties required by Google Analytics.

Link copied to clipboard

The connector metadata specific to Google Analytics.

Link copied to clipboard

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

Link copied to clipboard

The connector-specific credentials required when using Amazon Honeycode.

Link copied to clipboard

The connector-specific properties required when using Amazon Honeycode.

Link copied to clipboard

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

Link copied to clipboard

The connector metadata specific to Amazon Honeycode.

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard

The connector-specific profile credentials required by Infor Nexus.

Link copied to clipboard

The connector-specific profile properties required by Infor Nexus.

Link copied to clipboard

The connector metadata specific to Infor Nexus.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard

The connector-specific profile credentials required by Marketo.

Link copied to clipboard

The connector-specific profile properties required when using Marketo.

Link copied to clipboard

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

Link copied to clipboard

The connector metadata specific to Marketo.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

The OAuth 2.0 credentials required for OAuth 2.0 authentication.

Link copied to clipboard

Custom parameter required for OAuth 2.0 authentication.

Link copied to clipboard
Link copied to clipboard

Contains the default values required for OAuth 2.0 authentication.

Link copied to clipboard
sealed class OAuth2GrantType
Link copied to clipboard

The OAuth 2.0 properties required for OAuth 2.0 authentication.

Link copied to clipboard

The OAuth credentials required for OAuth type authentication.

Link copied to clipboard

The OAuth properties required for OAuth type authentication.

Link copied to clipboard
sealed class Operator
Link copied to clipboard
Link copied to clipboard
sealed class Operators
Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

The connector metadata specific to Salesforce Pardot.

Link copied to clipboard

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

Link copied to clipboard
sealed class PathPrefix
Link copied to clipboard

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

Link copied to clipboard
sealed class PrefixFormat
Link copied to clipboard
sealed class PrefixType
Link copied to clipboard

Specifies the private connection provisioning state.

Link copied to clipboard
class Range

The range of values that the property supports.

Link copied to clipboard

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

Link copied to clipboard

The connector-specific profile properties when using Amazon Redshift.

Link copied to clipboard

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

Link copied to clipboard

The connector metadata specific to Amazon Redshift.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
sealed class S3ConnectorOperator
Link copied to clipboard

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

Link copied to clipboard
sealed class S3InputFileType
Link copied to clipboard

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

Link copied to clipboard

The connector metadata specific to Amazon S3.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard

The connector-specific profile credentials required when using Salesforce.

Link copied to clipboard

The connector-specific profile properties required when using Salesforce.

Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard

The connector metadata specific to Salesforce.

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard

The connector-specific profile credentials required when using SAPOData.

Link copied to clipboard

The connector-specific profile properties required when using SAPOData.

Link copied to clipboard

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

Link copied to clipboard

The connector metadata specific to SAPOData.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The connector-specific profile credentials required when using ServiceNow.

Link copied to clipboard

The connector-specific profile properties required when using ServiceNow.

Link copied to clipboard

The connector metadata specific to ServiceNow.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard

The connector-specific profile credentials required when using Singular.

Link copied to clipboard

The connector-specific profile properties required when using Singular.

Link copied to clipboard

The connector metadata specific to Singular.

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard

The connector-specific profile credentials required when using Slack.

Link copied to clipboard

The connector-specific profile properties required when using Slack.

Link copied to clipboard

The connector metadata specific to Slack.

Link copied to clipboard

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

Link copied to clipboard

The connector-specific profile credentials required when using Snowflake.

Link copied to clipboard

The connector-specific profile properties required when using Snowflake.

Link copied to clipboard

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

Link copied to clipboard

The connector metadata specific to Snowflake.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class Task

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

Link copied to clipboard
sealed class TaskType
Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

The connector metadata specific to Trend Micro.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
sealed class TriggerType
Link copied to clipboard

The requested operation is not supported for the current flow.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard

The connector metadata specific to Upsolver.

Link copied to clipboard

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

Link copied to clipboard

The request has invalid or missing parameters.

Link copied to clipboard
Link copied to clipboard

The connector-specific profile credentials required when using Veeva.

Link copied to clipboard

The connector-specific profile properties required when using Veeva.

Link copied to clipboard

The connector metadata specific to Veeva.

Link copied to clipboard

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

Link copied to clipboard
sealed class WriteOperationType

The possible write operations in the destination connector. When this value is not provided, this defaults to the INSERT operation.

Link copied to clipboard
Link copied to clipboard

The connector-specific profile credentials required when using Zendesk.

Link copied to clipboard

The connector-specific profile properties required when using Zendesk.

Link copied to clipboard

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

Link copied to clipboard

The connector metadata specific to Zendesk.

Link copied to clipboard

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