Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

Usage

import * as mod from "https://aws-api.deno.dev/v0.4/services/appflow.ts?docs=full";

§Classes

Appflow

§Interfaces

AggregationConfig

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

AmplitudeConnectorProfileCredentials

The connector-specific credentials required when using Amplitude.

AmplitudeConnectorProfileProperties

The connector-specific profile properties required when using Amplitude.

AmplitudeMetadata

The connector metadata specific to Amplitude.

AmplitudeSourceProperties

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

ApiKeyCredentials

The API key credentials required for API key authentication.

AuthenticationConfig

Contains information about the authentication config that the connector supports.

AuthParameter

Information about required authentication parameters.

BasicAuthCredentials

The basic auth credentials required for basic authentication.

ConnectorConfiguration

The configuration settings related to a given connector.

ConnectorDetail

Information about the registered connector.

ConnectorEntity

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.

ConnectorEntityField

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.

ConnectorMetadata

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

ConnectorOAuthRequest

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

ConnectorOperator

The operation to be performed on the provided source fields.

ConnectorProfile

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.

ConnectorProfileConfig

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

ConnectorProfileCredentials

The connector-specific credentials required by a connector.

ConnectorProfileProperties

The connector-specific profile properties required by each connector.

ConnectorProvisioningConfig

Contains information about the configuration of the connector being registered.

ConnectorRuntimeSetting

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

CreateConnectorProfileRequest
CreateConnectorProfileResponse
CreateFlowRequest
CreateFlowResponse
CustomAuthConfig

Configuration information required for custom authentication.

CustomAuthCredentials

The custom credentials required for custom authentication.

CustomConnectorDestinationProperties

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

CustomConnectorProfileCredentials

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

CustomConnectorProfileProperties

The profile properties required by the custom connector.

CustomConnectorSourceProperties

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

CustomerProfilesDestinationProperties

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

CustomerProfilesMetadata

The connector metadata specific to Amazon Connect Customer Profiles.

DatadogConnectorProfileCredentials

The connector-specific credentials required by Datadog.

DatadogConnectorProfileProperties

The connector-specific profile properties required by Datadog.

DatadogMetadata

The connector metadata specific to Datadog.

DatadogSourceProperties

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

DeleteConnectorProfileRequest
DeleteFlowRequest
DescribeConnectorEntityRequest
DescribeConnectorEntityResponse
DescribeConnectorProfilesRequest
DescribeConnectorProfilesResponse
DescribeConnectorRequest
DescribeConnectorResponse
DescribeConnectorsRequest
DescribeConnectorsResponse
DescribeFlowExecutionRecordsRequest
DescribeFlowExecutionRecordsResponse
DescribeFlowRequest
DescribeFlowResponse
DestinationConnectorProperties

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

DestinationFieldProperties

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

DestinationFlowConfig

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

DynatraceConnectorProfileCredentials

The connector-specific profile credentials required by Dynatrace.

DynatraceConnectorProfileProperties

The connector-specific profile properties required by Dynatrace.

DynatraceMetadata

The connector metadata specific to Dynatrace.

DynatraceSourceProperties

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

ErrorHandlingConfig

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.

ErrorInfo

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

EventBridgeDestinationProperties

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

EventBridgeMetadata

The connector metadata specific to Amazon EventBridge.

ExecutionDetails

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

ExecutionRecord

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

ExecutionResult

Specifies the end result of the flow run.

FieldTypeDetails

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

FlowDefinition

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

GlueDataCatalogConfig

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.

GoogleAnalyticsConnectorProfileCredentials

The connector-specific profile credentials required by Google Analytics.

GoogleAnalyticsConnectorProfileProperties

The connector-specific profile properties required by Google Analytics.

GoogleAnalyticsMetadata

The connector metadata specific to Google Analytics.

GoogleAnalyticsSourceProperties

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

HoneycodeConnectorProfileCredentials

The connector-specific credentials required when using Amazon Honeycode.

HoneycodeConnectorProfileProperties

The connector-specific properties required when using Amazon Honeycode.

HoneycodeDestinationProperties

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

HoneycodeMetadata

The connector metadata specific to Amazon Honeycode.

IncrementalPullConfig

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

InforNexusConnectorProfileCredentials

The connector-specific profile credentials required by Infor Nexus.

InforNexusConnectorProfileProperties

The connector-specific profile properties required by Infor Nexus.

InforNexusMetadata

The connector metadata specific to Infor Nexus.

InforNexusSourceProperties

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

LambdaConnectorProvisioningConfig

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

ListConnectorEntitiesRequest
ListConnectorEntitiesResponse
ListConnectorsRequest
ListConnectorsResponse
ListFlowsRequest
ListFlowsResponse
ListTagsForResourceRequest
ListTagsForResourceResponse
LookoutMetricsDestinationProperties

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

MarketoConnectorProfileCredentials

The connector-specific profile credentials required by Marketo.

MarketoConnectorProfileProperties

The connector-specific profile properties required when using Marketo.

MarketoDestinationProperties

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

MarketoMetadata

The connector metadata specific to Marketo.

MarketoSourceProperties

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

MetadataCatalogConfig

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.

MetadataCatalogDetail

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

OAuth2Credentials

The OAuth 2.0 credentials required for OAuth 2.0 authentication.

OAuth2CustomParameter

Custom parameter required for OAuth 2.0 authentication.

OAuth2Defaults

Contains the default values required for OAuth 2.0 authentication.

OAuth2Properties

The OAuth 2.0 properties required for OAuth 2.0 authentication.

OAuthCredentials

The OAuth credentials required for OAuth type authentication.

OAuthProperties

The OAuth properties required for OAuth type authentication.

PardotConnectorProfileCredentials

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

PardotConnectorProfileProperties

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

PardotMetadata

The connector metadata specific to Salesforce Pardot.

PardotSourceProperties

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

PrefixConfig

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

PrivateConnectionProvisioningState

Specifies the private connection provisioning state.

Range

The range of values that the property supports.

RedshiftConnectorProfileCredentials

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

RedshiftConnectorProfileProperties

The connector-specific profile properties when using Amazon Redshift.

RedshiftDestinationProperties

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

RedshiftMetadata

The connector metadata specific to Amazon Redshift.

RegisterConnectorRequest
RegisterConnectorResponse
RegistrationOutput

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

S3DestinationProperties

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

S3InputFormatConfig

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

S3Metadata

The connector metadata specific to Amazon S3.

S3OutputFormatConfig

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

S3SourceProperties

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

SalesforceConnectorProfileCredentials

The connector-specific profile credentials required when using Salesforce.

SalesforceConnectorProfileProperties

The connector-specific profile properties required when using Salesforce.

SalesforceDestinationProperties

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

SalesforceMetadata

The connector metadata specific to Salesforce.

SalesforceSourceProperties

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

SAPODataConnectorProfileCredentials

The connector-specific profile credentials required when using SAPOData.

SAPODataConnectorProfileProperties

The connector-specific profile properties required when using SAPOData.

SAPODataDestinationProperties

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

SAPODataMetadata

The connector metadata specific to SAPOData.

SAPODataSourceProperties

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

ScheduledTriggerProperties

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

ServiceNowConnectorProfileCredentials

The connector-specific profile credentials required when using ServiceNow.

ServiceNowConnectorProfileProperties

The connector-specific profile properties required when using ServiceNow.

ServiceNowMetadata

The connector metadata specific to ServiceNow.

ServiceNowSourceProperties

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

SingularConnectorProfileCredentials

The connector-specific profile credentials required when using Singular.

SingularConnectorProfileProperties

The connector-specific profile properties required when using Singular.

SingularMetadata

The connector metadata specific to Singular.

SingularSourceProperties

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

SlackConnectorProfileCredentials

The connector-specific profile credentials required when using Slack.

SlackConnectorProfileProperties

The connector-specific profile properties required when using Slack.

SlackMetadata

The connector metadata specific to Slack.

SlackSourceProperties

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

SnowflakeConnectorProfileCredentials

The connector-specific profile credentials required when using Snowflake.

SnowflakeConnectorProfileProperties

The connector-specific profile properties required when using Snowflake.

SnowflakeDestinationProperties

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

SnowflakeMetadata

The connector metadata specific to Snowflake.

SourceConnectorProperties

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

SourceFieldProperties

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

SourceFlowConfig

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

StartFlowRequest
StartFlowResponse
StopFlowRequest
StopFlowResponse
SuccessResponseHandlingConfig

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

SupportedFieldTypeDetails

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

TagResourceRequest
Task

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

TrendmicroConnectorProfileCredentials

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

TrendmicroConnectorProfileProperties

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

TrendmicroMetadata

The connector metadata specific to Trend Micro.

TrendmicroSourceProperties

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

TriggerConfig

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

TriggerProperties

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

UnregisterConnectorRequest
UntagResourceRequest
UpdateConnectorProfileRequest
UpdateConnectorProfileResponse
UpdateConnectorRegistrationRequest
UpdateConnectorRegistrationResponse
UpdateFlowRequest
UpdateFlowResponse
UpsolverDestinationProperties

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

UpsolverMetadata

The connector metadata specific to Upsolver.

UpsolverS3OutputFormatConfig

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

VeevaConnectorProfileCredentials

The connector-specific profile credentials required when using Veeva.

VeevaConnectorProfileProperties

The connector-specific profile properties required when using Veeva.

VeevaMetadata

The connector metadata specific to Veeva.

VeevaSourceProperties

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

ZendeskConnectorProfileCredentials

The connector-specific profile credentials required when using Zendesk.

ZendeskConnectorProfileProperties

The connector-specific profile properties required when using Zendesk.

ZendeskDestinationProperties

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

ZendeskMetadata

The connector metadata specific to Zendesk.

ZendeskSourceProperties

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

§Type Aliases

AggregationType
AmplitudeConnectorOperator
AuthenticationType
CatalogType
ConnectionMode
ConnectorProvisioningType

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

ConnectorType
DatadogConnectorOperator
DataPullMode
DynatraceConnectorOperator
ExecutionStatus
FileType
FlowStatus
GoogleAnalyticsConnectorOperator
InforNexusConnectorOperator
MarketoConnectorOperator
OAuth2CustomPropType
OAuth2GrantType
Operator
OperatorPropertiesKeys
Operators
PardotConnectorOperator
PathPrefix
PrefixFormat
PrefixType
PrivateConnectionProvisioningFailureCause
PrivateConnectionProvisioningStatus
S3ConnectorOperator
S3InputFileType
SalesforceConnectorOperator
SalesforceDataTransferApi
SAPODataConnectorOperator
ScheduleFrequencyType
ServiceNowConnectorOperator
SingularConnectorOperator
SlackConnectorOperator
TaskType
TrendmicroConnectorOperator
TriggerType
VeevaConnectorOperator
WriteOperationType

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

ZendeskConnectorOperator