Package-level declarations

Types

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

Link copied to clipboard
data class ConnectorProfileApiKeyCredentials(val apiKey: String, val apiSecretKey: String? = null)
Link copied to clipboard
data class ConnectorProfileBasicAuthCredentials(val password: String, val username: String)
Link copied to clipboard
data class ConnectorProfileConfig(val connectorProfileCredentials: ConnectorProfileCredentials? = null, val connectorProfileProperties: ConnectorProfileProperties? = null)

Connector specific configurations needed to create connector profile

Link copied to clipboard
data class ConnectorProfileConnectorOAuthRequest(val authCode: String? = null, val redirectUri: String? = null)
Link copied to clipboard

Connector specific configuration needed to create connector profile based on Authentication mechanism

Link copied to clipboard
data class ConnectorProfileCustomAuthCredentials(val credentialsMap: Map<String, String>? = null, val customAuthenticationType: String)
data class ConnectorProfileCustomConnectorProfileProperties(val oAuth2Properties: ConnectorProfileOAuth2Properties? = null, val profileProperties: Map<String, String>? = null)
data class ConnectorProfileDatadogConnectorProfileCredentials(val apiKey: String, val applicationKey: String)
data class ConnectorProfileGoogleAnalyticsConnectorProfileCredentials(val accessToken: String? = null, val clientId: String, val clientSecret: String, val connectorOAuthRequest: ConnectorProfileConnectorOAuthRequest? = null, val refreshToken: String? = null)
data class ConnectorProfileInforNexusConnectorProfileCredentials(val accessKeyId: String, val datakey: String, val secretAccessKey: String, val userId: String)
data class ConnectorProfileMarketoConnectorProfileCredentials(val accessToken: String? = null, val clientId: String, val clientSecret: String, val connectorOAuthRequest: ConnectorProfileConnectorOAuthRequest? = null)
Link copied to clipboard
data class ConnectorProfileOAuth2Credentials(val accessToken: String? = null, val clientId: String? = null, val clientSecret: String? = null, val oAuthRequest: ConnectorProfileConnectorOAuthRequest? = null, val refreshToken: String? = null)
Link copied to clipboard
data class ConnectorProfileOAuth2Properties(val oAuth2GrantType: ConnectorProfileOAuth2GrantType? = null, val tokenUrl: String? = null, val tokenUrlCustomProperties: Map<String, String>? = null)
Link copied to clipboard
data class ConnectorProfileOAuthProperties(val authCodeUrl: String? = null, val oAuthScopes: List<String>? = null, val tokenUrl: String? = null)
data class ConnectorProfilePardotConnectorProfileCredentials(val accessToken: String? = null, val clientCredentialsArn: String? = null, val connectorOAuthRequest: ConnectorProfileConnectorOAuthRequest? = null, val refreshToken: String? = null)
data class ConnectorProfilePardotConnectorProfileProperties(val businessUnitId: String, val instanceUrl: String? = null, val isSandboxEnvironment: Boolean? = null)
Link copied to clipboard

Connector specific properties needed to create connector profile - currently not needed for Amplitude, Trendmicro, Googleanalytics and Singular

data class ConnectorProfileRedshiftConnectorProfileCredentials(val password: String? = null, val username: String? = null)
data class ConnectorProfileRedshiftConnectorProfileProperties(val bucketName: String, val bucketPrefix: String? = null, val clusterIdentifier: String? = null, val dataApiRoleArn: String? = null, val databaseName: String? = null, val databaseUrl: String? = null, val isRedshiftServerless: Boolean? = null, val roleArn: String, val workgroupName: String? = null)
data class ConnectorProfileSalesforceConnectorProfileCredentials(val accessToken: String? = null, val clientCredentialsArn: String? = null, val connectorOAuthRequest: ConnectorProfileConnectorOAuthRequest? = null, val jwtToken: String? = null, val oAuth2GrantType: ConnectorProfileOAuth2GrantType? = null, val refreshToken: String? = null)
data class ConnectorProfileSalesforceConnectorProfileProperties(val instanceUrl: String? = null, val isSandboxEnvironment: Boolean? = null, val usePrivateLinkForMetadataAndAuthorization: Boolean? = null)
data class ConnectorProfileSapoDataConnectorProfileCredentialsOAuthCredentialsProperties(val accessToken: String? = null, val clientId: String? = null, val clientSecret: String? = null, val connectorOAuthRequest: ConnectorProfileConnectorOAuthRequest? = null, val refreshToken: String? = null)

The SAPOData OAuth type authentication credentials.

data class ConnectorProfileSapoDataConnectorProfileProperties(val applicationHostUrl: String? = null, val applicationServicePath: String? = null, val clientNumber: String? = null, val disableSso: Boolean? = null, val logonLanguage: String? = null, val oAuthProperties: ConnectorProfileOAuthProperties? = null, val portNumber: Int? = null, val privateLinkServiceName: String? = null)
data class ConnectorProfileServiceNowConnectorProfileCredentials(val oAuth2Credentials: ConnectorProfileOAuth2Credentials? = null, val password: String? = null, val username: String? = null)
data class ConnectorProfileSlackConnectorProfileCredentials(val accessToken: String? = null, val clientId: String, val clientSecret: String, val connectorOAuthRequest: ConnectorProfileConnectorOAuthRequest? = null)
data class ConnectorProfileSnowflakeConnectorProfileProperties(val accountName: String? = null, val bucketName: String, val bucketPrefix: String? = null, val privateLinkServiceName: String? = null, val region: String? = null, val stage: String, val warehouse: String)
data class ConnectorProfileZendeskConnectorProfileCredentials(val accessToken: String? = null, val clientId: String, val clientSecret: String, val connectorOAuthRequest: ConnectorProfileConnectorOAuthRequest? = null)
Link copied to clipboard

Contains information about the configuration of the connector being registered.

Link copied to clipboard
data class FlowAggregationConfig(val aggregationType: FlowAggregationType? = null, val targetFileSize: Int? = null)
Link copied to clipboard
data class FlowAmplitudeSourceProperties(val object: String)
Link copied to clipboard
data class FlowConnectorOperator(val amplitude: FlowAmplitudeConnectorOperator? = null, val customConnector: FlowOperator? = null, val datadog: FlowDatadogConnectorOperator? = null, val dynatrace: FlowDynatraceConnectorOperator? = null, val googleAnalytics: FlowGoogleAnalyticsConnectorOperator? = null, val inforNexus: FlowInforNexusConnectorOperator? = null, val marketo: FlowMarketoConnectorOperator? = null, val pardot: FlowPardotConnectorOperator? = null, val s3: FlowS3ConnectorOperator? = null, val salesforce: FlowSalesforceConnectorOperator? = null, val sapoData: FlowSapoDataConnectorOperator? = null, val serviceNow: FlowServiceNowConnectorOperator? = null, val singular: FlowSingularConnectorOperator? = null, val slack: FlowSlackConnectorOperator? = null, val trendmicro: FlowTrendmicroConnectorOperator? = null, val veeva: FlowVeevaConnectorOperator? = null, val zendesk: FlowZendeskConnectorOperator? = null)

Operation to be performed on provided source fields

Link copied to clipboard
data class FlowCustomConnectorDestinationProperties(val customProperties: Map<String, String>? = null, val entityName: String, val errorHandlingConfig: FlowErrorHandlingConfig? = null, val idFieldNames: List<String>? = null, val writeOperationType: FlowWriteOperationType? = null)
Link copied to clipboard
data class FlowCustomConnectorSourceProperties(val customProperties: Map<String, String>? = null, val dataTransferApi: FlowCustomConnectorSourcePropertiesDataTransferApiProperties? = null, val entityName: String)

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

Link copied to clipboard
data class FlowDatadogSourceProperties(val object: String)
Link copied to clipboard
data class FlowDestinationConnectorProperties(val customConnector: FlowCustomConnectorDestinationProperties? = null, val eventBridge: FlowEventBridgeDestinationProperties? = null, val lookoutMetrics: FlowLookoutMetricsDestinationProperties? = null, val marketo: FlowMarketoDestinationProperties? = null, val redshift: FlowRedshiftDestinationProperties? = null, val s3: FlowS3DestinationProperties? = null, val salesforce: FlowSalesforceDestinationProperties? = null, val sapoData: FlowSapoDataDestinationProperties? = null, val snowflake: FlowSnowflakeDestinationProperties? = null, val upsolver: FlowUpsolverDestinationProperties? = null, val zendesk: FlowZendeskDestinationProperties? = null)

Destination connector details

Link copied to clipboard
data class FlowDestinationFlowConfig(val apiVersion: String? = null, val connectorProfileName: String? = null, val connectorType: FlowConnectorType, val destinationConnectorProperties: FlowDestinationConnectorProperties)

Configurations of destination connector.

Link copied to clipboard
data class FlowDynatraceSourceProperties(val object: String)
Link copied to clipboard
data class FlowErrorHandlingConfig(val bucketName: String? = null, val bucketPrefix: String? = null, val failOnFirstError: Boolean? = null)
Link copied to clipboard
data class FlowEventBridgeDestinationProperties(val errorHandlingConfig: FlowErrorHandlingConfig? = null, val object: String)
Link copied to clipboard
data class FlowGlueDataCatalog(val databaseName: String, val roleArn: String, val tablePrefix: String)

Trigger settings of the flow.

Link copied to clipboard
Link copied to clipboard
data class FlowIncrementalPullConfig(val datetimeTypeFieldName: String? = null)

Configuration for scheduled incremental data pull

Link copied to clipboard
data class FlowInforNexusSourceProperties(val object: String)
Link copied to clipboard
data class FlowLookoutMetricsDestinationProperties(val object: String? = null)
Link copied to clipboard
data class FlowMarketoDestinationProperties(val errorHandlingConfig: FlowErrorHandlingConfig? = null, val object: String)
Link copied to clipboard
data class FlowMarketoSourceProperties(val object: String)
Link copied to clipboard
data class FlowMetadataCatalogConfig(val glueDataCatalog: FlowGlueDataCatalog? = null)

Configurations of metadata catalog of the flow.

Link copied to clipboard
data class FlowPardotSourceProperties(val object: String)
Link copied to clipboard
data class FlowPrefixConfig(val pathPrefixHierarchy: List<FlowPathPrefix>? = null, val prefixFormat: FlowPrefixFormat? = null, val prefixType: FlowPrefixType? = null)
Link copied to clipboard
data class FlowRedshiftDestinationProperties(val bucketPrefix: String? = null, val errorHandlingConfig: FlowErrorHandlingConfig? = null, val intermediateBucketName: String, val object: String)
Link copied to clipboard
data class FlowS3DestinationProperties(val bucketName: String, val bucketPrefix: String? = null, val s3OutputFormatConfig: FlowS3OutputFormatConfig? = null)
Link copied to clipboard
data class FlowS3InputFormatConfig(val s3InputFileType: FlowS3InputFormatConfigS3InputFileType? = null)
Link copied to clipboard
data class FlowS3OutputFormatConfig(val aggregationConfig: FlowAggregationConfig? = null, val fileType: FlowFileType? = null, val prefixConfig: FlowPrefixConfig? = null, val preserveSourceDataTyping: Boolean? = null)
Link copied to clipboard
data class FlowS3SourceProperties(val bucketName: String, val bucketPrefix: String, val s3InputFormatConfig: FlowS3InputFormatConfig? = null)
Link copied to clipboard
data class FlowSalesforceDestinationProperties(val dataTransferApi: FlowDataTransferApi? = null, val errorHandlingConfig: FlowErrorHandlingConfig? = null, val idFieldNames: List<String>? = null, val object: String, val writeOperationType: FlowWriteOperationType? = null)
Link copied to clipboard
data class FlowSalesforceSourceProperties(val dataTransferApi: FlowDataTransferApi? = null, val enableDynamicFieldUpdate: Boolean? = null, val includeDeletedRecords: Boolean? = null, val object: String)
Link copied to clipboard
data class FlowSapoDataDestinationProperties(val errorHandlingConfig: FlowErrorHandlingConfig? = null, val idFieldNames: List<String>? = null, val objectPath: String, val successResponseHandlingConfig: FlowSuccessResponseHandlingConfig? = null, val writeOperationType: FlowWriteOperationType? = null)
Link copied to clipboard
data class FlowSapoDataPaginationConfig(val maxPageSize: Int)

SAP Source connector page size

Link copied to clipboard
data class FlowSapoDataParallelismConfig(val maxParallelism: Int)

SAP Source connector parallelism factor

Link copied to clipboard
data class FlowSapoDataSourceProperties(val objectPath: String, val paginationConfig: FlowSapoDataPaginationConfig? = null, val parallelismConfig: FlowSapoDataParallelismConfig? = null)
Link copied to clipboard
data class FlowScheduledTriggerProperties(val dataPullMode: FlowScheduledTriggerPropertiesDataPullMode? = null, val firstExecutionFrom: Double? = null, val flowErrorDeactivationThreshold: Int? = null, val scheduleEndTime: Double? = null, val scheduleExpression: String, val scheduleOffset: Double? = null, val scheduleStartTime: Double? = null, val timeZone: String? = null)

Details required for scheduled trigger type

Link copied to clipboard
data class FlowServiceNowSourceProperties(val object: String)
Link copied to clipboard
data class FlowSingularSourceProperties(val object: String)
Link copied to clipboard
data class FlowSlackSourceProperties(val object: String)
Link copied to clipboard
data class FlowSnowflakeDestinationProperties(val bucketPrefix: String? = null, val errorHandlingConfig: FlowErrorHandlingConfig? = null, val intermediateBucketName: String, val object: String)
Link copied to clipboard
data class FlowSourceConnectorProperties(val amplitude: FlowAmplitudeSourceProperties? = null, val customConnector: FlowCustomConnectorSourceProperties? = null, val datadog: FlowDatadogSourceProperties? = null, val dynatrace: FlowDynatraceSourceProperties? = null, val googleAnalytics: FlowGoogleAnalyticsSourceProperties? = null, val inforNexus: FlowInforNexusSourceProperties? = null, val marketo: FlowMarketoSourceProperties? = null, val pardot: FlowPardotSourceProperties? = null, val s3: FlowS3SourceProperties? = null, val salesforce: FlowSalesforceSourceProperties? = null, val sapoData: FlowSapoDataSourceProperties? = null, val serviceNow: FlowServiceNowSourceProperties? = null, val singular: FlowSingularSourceProperties? = null, val slack: FlowSlackSourceProperties? = null, val trendmicro: FlowTrendmicroSourceProperties? = null, val veeva: FlowVeevaSourceProperties? = null, val zendesk: FlowZendeskSourceProperties? = null)

Source connector details required to query a connector

Link copied to clipboard
data class FlowSourceFlowConfig(val apiVersion: String? = null, val connectorProfileName: String? = null, val connectorType: FlowConnectorType, val incrementalPullConfig: FlowIncrementalPullConfig? = null, val sourceConnectorProperties: FlowSourceConnectorProperties)

Configurations of Source connector of the flow.

Link copied to clipboard
data class FlowSuccessResponseHandlingConfig(val bucketName: String? = null, val bucketPrefix: String? = null)
Link copied to clipboard
data class FlowTask(val connectorOperator: FlowConnectorOperator? = null, val destinationField: String? = null, val sourceFields: List<String>, val taskProperties: List<FlowTaskPropertiesObject>? = null, val taskType: FlowTaskType)
Link copied to clipboard

An object used to store task related info

Link copied to clipboard
data class FlowTrendmicroSourceProperties(val object: String)
Link copied to clipboard
data class FlowTriggerConfig(val triggerProperties: FlowScheduledTriggerProperties? = null, val triggerType: FlowTriggerType)

Trigger settings of the flow.

Link copied to clipboard
data class FlowUpsolverDestinationProperties(val bucketName: String, val bucketPrefix: String? = null, val s3OutputFormatConfig: FlowUpsolverS3OutputFormatConfig)
Link copied to clipboard
data class FlowUpsolverS3OutputFormatConfig(val aggregationConfig: FlowAggregationConfig? = null, val fileType: FlowFileType? = null, val prefixConfig: FlowPrefixConfig)
Link copied to clipboard
data class FlowVeevaSourceProperties(val documentType: String? = null, val includeAllVersions: Boolean? = null, val includeRenditions: Boolean? = null, val includeSourceFiles: Boolean? = null, val object: String)
Link copied to clipboard
data class FlowZendeskDestinationProperties(val errorHandlingConfig: FlowErrorHandlingConfig? = null, val idFieldNames: List<String>? = null, val object: String, val writeOperationType: FlowWriteOperationType? = null)
Link copied to clipboard
data class FlowZendeskSourceProperties(val object: String)
Link copied to clipboard
data class GetConnectorProfileResult(val connectionMode: ConnectorProfileConnectionMode? = null, val connectorProfileArn: String? = null, val credentialsArn: String? = null)
Link copied to clipboard
data class GetConnectorResult(val connectorArn: String? = null, val connectorProvisioningConfig: ConnectorProvisioningConfig? = null, val connectorProvisioningType: String? = null, val description: String? = null)
Link copied to clipboard
data class GetFlowResult(val description: String? = null, val destinationFlowConfigList: List<FlowDestinationFlowConfig>? = null, val flowArn: String? = null, val flowStatus: FlowStatus? = null, val metadataCatalogConfig: FlowMetadataCatalogConfig? = null, val sourceFlowConfig: FlowSourceFlowConfig? = null, val tags: List<Tag>? = null, val tasks: List<FlowTask>? = null, val triggerConfig: FlowTriggerConfig? = null)