# WARNING: DO NOT EDIT, AUTO-GENERATED CODE!
# See https://github.com/aws-beam/aws-codegen for more details.
defmodule AWS.Appflow do
@moduledoc """
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 Amazon Web 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.
"""
alias AWS.Client
alias AWS.Request
@typedoc """
## Example:
custom_auth_config() :: %{
"authParameters" => list(auth_parameter()),
"customAuthenticationType" => String.t() | atom()
}
"""
@type custom_auth_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
event_bridge_metadata() :: %{}
"""
@type event_bridge_metadata() :: %{}
@typedoc """
## Example:
create_connector_profile_response() :: %{
"connectorProfileArn" => String.t() | atom()
}
"""
@type create_connector_profile_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
service_now_metadata() :: %{}
"""
@type service_now_metadata() :: %{}
@typedoc """
## Example:
metadata_catalog_detail() :: %{
"catalogType" => list(any()),
"partitionRegistrationOutput" => registration_output(),
"tableName" => String.t() | atom(),
"tableRegistrationOutput" => registration_output()
}
"""
@type metadata_catalog_detail() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
salesforce_connector_profile_properties() :: %{
"instanceUrl" => String.t() | atom(),
"isSandboxEnvironment" => boolean(),
"usePrivateLinkForMetadataAndAuthorization" => boolean()
}
"""
@type salesforce_connector_profile_properties() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
honeycode_destination_properties() :: %{
"errorHandlingConfig" => error_handling_config(),
"object" => String.t() | atom()
}
"""
@type honeycode_destination_properties() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
lookout_metrics_destination_properties() :: %{}
"""
@type lookout_metrics_destination_properties() :: %{}
@typedoc """
## Example:
infor_nexus_connector_profile_properties() :: %{
"instanceUrl" => String.t() | atom()
}
"""
@type infor_nexus_connector_profile_properties() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
describe_connectors_request() :: %{
optional("connectorTypes") => list(list(any())()),
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom()
}
"""
@type describe_connectors_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
slack_connector_profile_credentials() :: %{
"accessToken" => String.t() | atom(),
"clientId" => String.t() | atom(),
"clientSecret" => String.t() | atom(),
"oAuthRequest" => connector_o_auth_request()
}
"""
@type slack_connector_profile_credentials() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
dynatrace_source_properties() :: %{
"object" => String.t() | atom()
}
"""
@type dynatrace_source_properties() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
flow_definition() :: %{
"createdAt" => non_neg_integer(),
"createdBy" => String.t() | atom(),
"description" => String.t() | atom(),
"destinationConnectorLabel" => String.t() | atom(),
"destinationConnectorType" => list(any()),
"flowArn" => String.t() | atom(),
"flowName" => String.t() | atom(),
"flowStatus" => list(any()),
"lastRunExecutionDetails" => execution_details(),
"lastUpdatedAt" => non_neg_integer(),
"lastUpdatedBy" => String.t() | atom(),
"sourceConnectorLabel" => String.t() | atom(),
"sourceConnectorType" => list(any()),
"tags" => map(),
"triggerType" => list(any())
}
"""
@type flow_definition() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
describe_connector_response() :: %{
"connectorConfiguration" => connector_configuration()
}
"""
@type describe_connector_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
register_connector_request() :: %{
optional("clientToken") => String.t() | atom(),
optional("connectorLabel") => String.t() | atom(),
optional("connectorProvisioningConfig") => connector_provisioning_config(),
optional("connectorProvisioningType") => list(any()),
optional("description") => String.t() | atom()
}
"""
@type register_connector_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
redshift_destination_properties() :: %{
"bucketPrefix" => String.t() | atom(),
"errorHandlingConfig" => error_handling_config(),
"intermediateBucketName" => String.t() | atom(),
"object" => String.t() | atom()
}
"""
@type redshift_destination_properties() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_connector_profile_request() :: %{
optional("clientToken") => String.t() | atom(),
required("connectionMode") => list(any()),
required("connectorProfileConfig") => connector_profile_config(),
required("connectorProfileName") => String.t() | atom()
}
"""
@type update_connector_profile_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_connector_registration_request() :: %{
optional("clientToken") => String.t() | atom(),
optional("connectorProvisioningConfig") => connector_provisioning_config(),
optional("description") => String.t() | atom(),
required("connectorLabel") => String.t() | atom()
}
"""
@type update_connector_registration_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
s_a_p_o_data_source_properties() :: %{
"objectPath" => String.t() | atom(),
"paginationConfig" => s_a_p_o_data_pagination_config(),
"parallelismConfig" => s_a_p_o_data_parallelism_config()
}
"""
@type s_a_p_o_data_source_properties() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_flow_request() :: %{
optional("clientToken") => String.t() | atom(),
optional("description") => String.t() | atom(),
optional("metadataCatalogConfig") => metadata_catalog_config(),
required("destinationFlowConfigList") => list(destination_flow_config()),
required("flowName") => String.t() | atom(),
required("sourceFlowConfig") => source_flow_config(),
required("tasks") => list(task()),
required("triggerConfig") => trigger_config()
}
"""
@type update_flow_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
describe_flow_execution_records_response() :: %{
"flowExecutions" => list(execution_record()),
"nextToken" => String.t() | atom()
}
"""
@type describe_flow_execution_records_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
throttling_exception() :: %{
"message" => String.t() | atom()
}
"""
@type throttling_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
s_a_p_o_data_connector_profile_credentials() :: %{
"basicAuthCredentials" => basic_auth_credentials(),
"oAuthCredentials" => o_auth_credentials()
}
"""
@type s_a_p_o_data_connector_profile_credentials() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
stop_flow_response() :: %{
"flowArn" => String.t() | atom(),
"flowStatus" => list(any())
}
"""
@type stop_flow_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
s_a_p_o_data_destination_properties() :: %{
"errorHandlingConfig" => error_handling_config(),
"idFieldNames" => list(String.t() | atom()),
"objectPath" => String.t() | atom(),
"successResponseHandlingConfig" => success_response_handling_config(),
"writeOperationType" => list(any())
}
"""
@type s_a_p_o_data_destination_properties() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
describe_connector_profiles_request() :: %{
optional("connectorLabel") => String.t() | atom(),
optional("connectorProfileNames") => list(String.t() | atom()),
optional("connectorType") => list(any()),
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom()
}
"""
@type describe_connector_profiles_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
o_auth_credentials() :: %{
"accessToken" => String.t() | atom(),
"clientId" => String.t() | atom(),
"clientSecret" => String.t() | atom(),
"oAuthRequest" => connector_o_auth_request(),
"refreshToken" => String.t() | atom()
}
"""
@type o_auth_credentials() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
access_denied_exception() :: %{
"message" => String.t() | atom()
}
"""
@type access_denied_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
connector_profile() :: %{
"connectionMode" => list(any()),
"connectorLabel" => String.t() | atom(),
"connectorProfileArn" => String.t() | atom(),
"connectorProfileName" => String.t() | atom(),
"connectorProfileProperties" => connector_profile_properties(),
"connectorType" => list(any()),
"createdAt" => non_neg_integer(),
"credentialsArn" => String.t() | atom(),
"lastUpdatedAt" => non_neg_integer(),
"privateConnectionProvisioningState" => private_connection_provisioning_state()
}
"""
@type connector_profile() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
google_analytics_metadata() :: %{
"oAuthScopes" => list(String.t() | atom())
}
"""
@type google_analytics_metadata() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
singular_connector_profile_properties() :: %{}
"""
@type singular_connector_profile_properties() :: %{}
@typedoc """
## Example:
salesforce_connector_profile_credentials() :: %{
"accessToken" => String.t() | atom(),
"clientCredentialsArn" => String.t() | atom(),
"jwtToken" => String.t() | atom(),
"oAuth2GrantType" => list(any()),
"oAuthRequest" => connector_o_auth_request(),
"refreshToken" => String.t() | atom()
}
"""
@type salesforce_connector_profile_credentials() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
salesforce_destination_properties() :: %{
"dataTransferApi" => list(any()),
"errorHandlingConfig" => error_handling_config(),
"idFieldNames" => list(String.t() | atom()),
"object" => String.t() | atom(),
"writeOperationType" => list(any())
}
"""
@type salesforce_destination_properties() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
connector_profile_credentials() :: %{
"Amplitude" => amplitude_connector_profile_credentials(),
"CustomConnector" => custom_connector_profile_credentials(),
"Datadog" => datadog_connector_profile_credentials(),
"Dynatrace" => dynatrace_connector_profile_credentials(),
"GoogleAnalytics" => google_analytics_connector_profile_credentials(),
"Honeycode" => honeycode_connector_profile_credentials(),
"InforNexus" => infor_nexus_connector_profile_credentials(),
"Marketo" => marketo_connector_profile_credentials(),
"Pardot" => pardot_connector_profile_credentials(),
"Redshift" => redshift_connector_profile_credentials(),
"SAPOData" => s_a_p_o_data_connector_profile_credentials(),
"Salesforce" => salesforce_connector_profile_credentials(),
"ServiceNow" => service_now_connector_profile_credentials(),
"Singular" => singular_connector_profile_credentials(),
"Slack" => slack_connector_profile_credentials(),
"Snowflake" => snowflake_connector_profile_credentials(),
"Trendmicro" => trendmicro_connector_profile_credentials(),
"Veeva" => veeva_connector_profile_credentials(),
"Zendesk" => zendesk_connector_profile_credentials()
}
"""
@type connector_profile_credentials() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
marketo_connector_profile_credentials() :: %{
"accessToken" => String.t() | atom(),
"clientId" => String.t() | atom(),
"clientSecret" => String.t() | atom(),
"oAuthRequest" => connector_o_auth_request()
}
"""
@type marketo_connector_profile_credentials() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
connector_entity() :: %{
"hasNestedEntities" => boolean(),
"label" => String.t() | atom(),
"name" => String.t() | atom()
}
"""
@type connector_entity() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
connector_authentication_exception() :: %{
"message" => String.t() | atom()
}
"""
@type connector_authentication_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
execution_record() :: %{
"dataPullEndTime" => non_neg_integer(),
"dataPullStartTime" => non_neg_integer(),
"executionId" => String.t() | atom(),
"executionResult" => execution_result(),
"executionStatus" => list(any()),
"lastUpdatedAt" => non_neg_integer(),
"metadataCatalogDetails" => list(metadata_catalog_detail()),
"startedAt" => non_neg_integer()
}
"""
@type execution_record() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
scheduled_trigger_properties() :: %{
"dataPullMode" => list(any()),
"firstExecutionFrom" => non_neg_integer(),
"flowErrorDeactivationThreshold" => integer(),
"scheduleEndTime" => non_neg_integer(),
"scheduleExpression" => String.t() | atom(),
"scheduleOffset" => float(),
"scheduleStartTime" => non_neg_integer(),
"timezone" => String.t() | atom()
}
"""
@type scheduled_trigger_properties() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
custom_connector_profile_credentials() :: %{
"apiKey" => api_key_credentials(),
"authenticationType" => list(any()),
"basic" => basic_auth_credentials(),
"custom" => custom_auth_credentials(),
"oauth2" => o_auth2_credentials()
}
"""
@type custom_connector_profile_credentials() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
dynatrace_metadata() :: %{}
"""
@type dynatrace_metadata() :: %{}
@typedoc """
## Example:
connector_metadata() :: %{
"Amplitude" => amplitude_metadata(),
"CustomerProfiles" => customer_profiles_metadata(),
"Datadog" => datadog_metadata(),
"Dynatrace" => dynatrace_metadata(),
"EventBridge" => event_bridge_metadata(),
"GoogleAnalytics" => google_analytics_metadata(),
"Honeycode" => honeycode_metadata(),
"InforNexus" => infor_nexus_metadata(),
"Marketo" => marketo_metadata(),
"Pardot" => pardot_metadata(),
"Redshift" => redshift_metadata(),
"S3" => s3_metadata(),
"SAPOData" => s_a_p_o_data_metadata(),
"Salesforce" => salesforce_metadata(),
"ServiceNow" => service_now_metadata(),
"Singular" => singular_metadata(),
"Slack" => slack_metadata(),
"Snowflake" => snowflake_metadata(),
"Trendmicro" => trendmicro_metadata(),
"Upsolver" => upsolver_metadata(),
"Veeva" => veeva_metadata(),
"Zendesk" => zendesk_metadata()
}
"""
@type connector_metadata() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
marketo_source_properties() :: %{
"object" => String.t() | atom()
}
"""
@type marketo_source_properties() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
success_response_handling_config() :: %{
"bucketName" => String.t() | atom(),
"bucketPrefix" => String.t() | atom()
}
"""
@type success_response_handling_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
o_auth2_properties() :: %{
"oAuth2GrantType" => list(any()),
"tokenUrl" => String.t() | atom(),
"tokenUrlCustomProperties" => map()
}
"""
@type o_auth2_properties() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
salesforce_source_properties() :: %{
"dataTransferApi" => list(any()),
"enableDynamicFieldUpdate" => boolean(),
"includeDeletedRecords" => boolean(),
"object" => String.t() | atom()
}
"""
@type salesforce_source_properties() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
google_analytics_connector_profile_credentials() :: %{
"accessToken" => String.t() | atom(),
"clientId" => String.t() | atom(),
"clientSecret" => String.t() | atom(),
"oAuthRequest" => connector_o_auth_request(),
"refreshToken" => String.t() | atom()
}
"""
@type google_analytics_connector_profile_credentials() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
reset_connector_metadata_cache_request() :: %{
optional("apiVersion") => String.t() | atom(),
optional("connectorEntityName") => String.t() | atom(),
optional("connectorProfileName") => String.t() | atom(),
optional("connectorType") => list(any()),
optional("entitiesPath") => String.t() | atom()
}
"""
@type reset_connector_metadata_cache_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
glue_data_catalog_config() :: %{
"databaseName" => String.t() | atom(),
"roleArn" => String.t() | atom(),
"tablePrefix" => String.t() | atom()
}
"""
@type glue_data_catalog_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_connectors_request() :: %{
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom()
}
"""
@type list_connectors_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
redshift_connector_profile_properties() :: %{
"bucketName" => String.t() | atom(),
"bucketPrefix" => String.t() | atom(),
"clusterIdentifier" => String.t() | atom(),
"dataApiRoleArn" => String.t() | atom(),
"databaseName" => String.t() | atom(),
"databaseUrl" => String.t() | atom(),
"isRedshiftServerless" => boolean(),
"roleArn" => String.t() | atom(),
"workgroupName" => String.t() | atom()
}
"""
@type redshift_connector_profile_properties() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
source_field_properties() :: %{
"isQueryable" => boolean(),
"isRetrievable" => boolean(),
"isTimestampFieldForIncrementalQueries" => boolean()
}
"""
@type source_field_properties() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
honeycode_connector_profile_credentials() :: %{
"accessToken" => String.t() | atom(),
"oAuthRequest" => connector_o_auth_request(),
"refreshToken" => String.t() | atom()
}
"""
@type honeycode_connector_profile_credentials() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
customer_profiles_destination_properties() :: %{
"domainName" => String.t() | atom(),
"objectTypeName" => String.t() | atom()
}
"""
@type customer_profiles_destination_properties() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
reset_connector_metadata_cache_response() :: %{}
"""
@type reset_connector_metadata_cache_response() :: %{}
@typedoc """
## Example:
zendesk_destination_properties() :: %{
"errorHandlingConfig" => error_handling_config(),
"idFieldNames" => list(String.t() | atom()),
"object" => String.t() | atom(),
"writeOperationType" => list(any())
}
"""
@type zendesk_destination_properties() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
salesforce_metadata() :: %{
"dataTransferApis" => list(list(any())()),
"oAuthScopes" => list(String.t() | atom()),
"oauth2GrantTypesSupported" => list(list(any())())
}
"""
@type salesforce_metadata() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
slack_connector_profile_properties() :: %{
"instanceUrl" => String.t() | atom()
}
"""
@type slack_connector_profile_properties() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_flow_request() :: %{
optional("forceDelete") => boolean(),
required("flowName") => String.t() | atom()
}
"""
@type delete_flow_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
validation_exception() :: %{
"message" => String.t() | atom()
}
"""
@type validation_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
service_now_connector_profile_properties() :: %{
"instanceUrl" => String.t() | atom()
}
"""
@type service_now_connector_profile_properties() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
pardot_source_properties() :: %{
"object" => String.t() | atom()
}
"""
@type pardot_source_properties() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
datadog_source_properties() :: %{
"object" => String.t() | atom()
}
"""
@type datadog_source_properties() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
zendesk_source_properties() :: %{
"object" => String.t() | atom()
}
"""
@type zendesk_source_properties() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
range() :: %{
"maximum" => float(),
"minimum" => float()
}
"""
@type range() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
destination_connector_properties() :: %{
"CustomConnector" => custom_connector_destination_properties(),
"CustomerProfiles" => customer_profiles_destination_properties(),
"EventBridge" => event_bridge_destination_properties(),
"Honeycode" => honeycode_destination_properties(),
"LookoutMetrics" => lookout_metrics_destination_properties(),
"Marketo" => marketo_destination_properties(),
"Redshift" => redshift_destination_properties(),
"S3" => s3_destination_properties(),
"SAPOData" => s_a_p_o_data_destination_properties(),
"Salesforce" => salesforce_destination_properties(),
"Snowflake" => snowflake_destination_properties(),
"Upsolver" => upsolver_destination_properties(),
"Zendesk" => zendesk_destination_properties()
}
"""
@type destination_connector_properties() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
describe_flow_response() :: %{
"createdAt" => non_neg_integer(),
"createdBy" => String.t() | atom(),
"description" => String.t() | atom(),
"destinationFlowConfigList" => list(destination_flow_config()),
"flowArn" => String.t() | atom(),
"flowName" => String.t() | atom(),
"flowStatus" => list(any()),
"flowStatusMessage" => String.t() | atom(),
"kmsArn" => String.t() | atom(),
"lastRunExecutionDetails" => execution_details(),
"lastRunMetadataCatalogDetails" => list(metadata_catalog_detail()),
"lastUpdatedAt" => non_neg_integer(),
"lastUpdatedBy" => String.t() | atom(),
"metadataCatalogConfig" => metadata_catalog_config(),
"schemaVersion" => float(),
"sourceFlowConfig" => source_flow_config(),
"tags" => map(),
"tasks" => list(task()),
"triggerConfig" => trigger_config()
}
"""
@type describe_flow_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_connector_profile_response() :: %{}
"""
@type delete_connector_profile_response() :: %{}
@typedoc """
## Example:
veeva_source_properties() :: %{
"documentType" => String.t() | atom(),
"includeAllVersions" => boolean(),
"includeRenditions" => boolean(),
"includeSourceFiles" => boolean(),
"object" => String.t() | atom()
}
"""
@type veeva_source_properties() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
connector_provisioning_config() :: %{
"lambda" => lambda_connector_provisioning_config()
}
"""
@type connector_provisioning_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
describe_flow_execution_records_request() :: %{
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom(),
required("flowName") => String.t() | atom()
}
"""
@type describe_flow_execution_records_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
registration_output() :: %{
"message" => String.t() | atom(),
"result" => String.t() | atom(),
"status" => list(any())
}
"""
@type registration_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_connector_profile_request() :: %{
optional("clientToken") => String.t() | atom(),
optional("connectorLabel") => String.t() | atom(),
optional("kmsArn") => String.t() | atom(),
required("connectionMode") => list(any()),
required("connectorProfileConfig") => connector_profile_config(),
required("connectorProfileName") => String.t() | atom(),
required("connectorType") => list(any())
}
"""
@type create_connector_profile_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
internal_server_exception() :: %{
"message" => String.t() | atom()
}
"""
@type internal_server_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
honeycode_connector_profile_properties() :: %{}
"""
@type honeycode_connector_profile_properties() :: %{}
@typedoc """
## Example:
veeva_connector_profile_properties() :: %{
"instanceUrl" => String.t() | atom()
}
"""
@type veeva_connector_profile_properties() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
trendmicro_source_properties() :: %{
"object" => String.t() | atom()
}
"""
@type trendmicro_source_properties() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
zendesk_connector_profile_credentials() :: %{
"accessToken" => String.t() | atom(),
"clientId" => String.t() | atom(),
"clientSecret" => String.t() | atom(),
"oAuthRequest" => connector_o_auth_request()
}
"""
@type zendesk_connector_profile_credentials() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
amplitude_connector_profile_properties() :: %{}
"""
@type amplitude_connector_profile_properties() :: %{}
@typedoc """
## Example:
resource_not_found_exception() :: %{
"message" => String.t() | atom()
}
"""
@type resource_not_found_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
o_auth2_defaults() :: %{
"authCodeUrls" => list(String.t() | atom()),
"oauth2CustomProperties" => list(o_auth2_custom_parameter()),
"oauth2GrantTypesSupported" => list(list(any())()),
"oauthScopes" => list(String.t() | atom()),
"tokenUrls" => list(String.t() | atom())
}
"""
@type o_auth2_defaults() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
basic_auth_credentials() :: %{
"password" => String.t() | atom(),
"username" => String.t() | atom()
}
"""
@type basic_auth_credentials() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
s3_metadata() :: %{}
"""
@type s3_metadata() :: %{}
@typedoc """
## Example:
connector_entity_field() :: %{
"customProperties" => map(),
"defaultValue" => String.t() | atom(),
"description" => String.t() | atom(),
"destinationProperties" => destination_field_properties(),
"identifier" => String.t() | atom(),
"isDeprecated" => boolean(),
"isPrimaryKey" => boolean(),
"label" => String.t() | atom(),
"parentIdentifier" => String.t() | atom(),
"sourceProperties" => source_field_properties(),
"supportedFieldTypeDetails" => supported_field_type_details()
}
"""
@type connector_entity_field() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
tag_resource_request() :: %{
required("tags") => map()
}
"""
@type tag_resource_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
zendesk_connector_profile_properties() :: %{
"instanceUrl" => String.t() | atom()
}
"""
@type zendesk_connector_profile_properties() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
dynatrace_connector_profile_properties() :: %{
"instanceUrl" => String.t() | atom()
}
"""
@type dynatrace_connector_profile_properties() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
amplitude_source_properties() :: %{
"object" => String.t() | atom()
}
"""
@type amplitude_source_properties() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
destination_field_properties() :: %{
"isCreatable" => boolean(),
"isDefaultedOnCreate" => boolean(),
"isNullable" => boolean(),
"isUpdatable" => boolean(),
"isUpsertable" => boolean(),
"supportedWriteOperations" => list(list(any())())
}
"""
@type destination_field_properties() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
s3_destination_properties() :: %{
"bucketName" => String.t() | atom(),
"bucketPrefix" => String.t() | atom(),
"s3OutputFormatConfig" => s3_output_format_config()
}
"""
@type s3_destination_properties() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
marketo_connector_profile_properties() :: %{
"instanceUrl" => String.t() | atom()
}
"""
@type marketo_connector_profile_properties() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
pardot_connector_profile_properties() :: %{
"businessUnitId" => String.t() | atom(),
"instanceUrl" => String.t() | atom(),
"isSandboxEnvironment" => boolean()
}
"""
@type pardot_connector_profile_properties() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
unsupported_operation_exception() :: %{
"message" => String.t() | atom()
}
"""
@type unsupported_operation_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
singular_source_properties() :: %{
"object" => String.t() | atom()
}
"""
@type singular_source_properties() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_flows_response() :: %{
"flows" => list(flow_definition()),
"nextToken" => String.t() | atom()
}
"""
@type list_flows_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_connector_entities_response() :: %{
"connectorEntityMap" => map(),
"nextToken" => String.t() | atom()
}
"""
@type list_connector_entities_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
tag_resource_response() :: %{}
"""
@type tag_resource_response() :: %{}
@typedoc """
## Example:
veeva_metadata() :: %{}
"""
@type veeva_metadata() :: %{}
@typedoc """
## Example:
redshift_metadata() :: %{}
"""
@type redshift_metadata() :: %{}
@typedoc """
## Example:
dynatrace_connector_profile_credentials() :: %{
"apiToken" => String.t() | atom()
}
"""
@type dynatrace_connector_profile_credentials() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
auth_parameter() :: %{
"connectorSuppliedValues" => list(String.t() | atom()),
"description" => String.t() | atom(),
"isRequired" => boolean(),
"isSensitiveField" => boolean(),
"key" => String.t() | atom(),
"label" => String.t() | atom()
}
"""
@type auth_parameter() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
customer_profiles_metadata() :: %{}
"""
@type customer_profiles_metadata() :: %{}
@typedoc """
## Example:
trendmicro_connector_profile_properties() :: %{}
"""
@type trendmicro_connector_profile_properties() :: %{}
@typedoc """
## Example:
error_info() :: %{
"executionMessage" => String.t() | atom(),
"putFailuresCount" => float()
}
"""
@type error_info() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
custom_connector_profile_properties() :: %{
"oAuth2Properties" => o_auth2_properties(),
"profileProperties" => map()
}
"""
@type custom_connector_profile_properties() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
lambda_connector_provisioning_config() :: %{
"lambdaArn" => String.t() | atom()
}
"""
@type lambda_connector_provisioning_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
google_analytics_source_properties() :: %{
"object" => String.t() | atom()
}
"""
@type google_analytics_source_properties() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
service_now_source_properties() :: %{
"object" => String.t() | atom()
}
"""
@type service_now_source_properties() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_flows_request() :: %{
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom()
}
"""
@type list_flows_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
describe_connectors_response() :: %{
"connectorConfigurations" => map(),
"connectors" => list(connector_detail()),
"nextToken" => String.t() | atom()
}
"""
@type describe_connectors_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
connector_o_auth_request() :: %{
"authCode" => String.t() | atom(),
"redirectUri" => String.t() | atom()
}
"""
@type connector_o_auth_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
infor_nexus_connector_profile_credentials() :: %{
"accessKeyId" => String.t() | atom(),
"datakey" => String.t() | atom(),
"secretAccessKey" => String.t() | atom(),
"userId" => String.t() | atom()
}
"""
@type infor_nexus_connector_profile_credentials() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
datadog_connector_profile_properties() :: %{
"instanceUrl" => String.t() | atom()
}
"""
@type datadog_connector_profile_properties() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
upsolver_destination_properties() :: %{
"bucketName" => String.t() | atom(),
"bucketPrefix" => String.t() | atom(),
"s3OutputFormatConfig" => upsolver_s3_output_format_config()
}
"""
@type upsolver_destination_properties() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
amplitude_connector_profile_credentials() :: %{
"apiKey" => String.t() | atom(),
"secretKey" => String.t() | atom()
}
"""
@type amplitude_connector_profile_credentials() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
cancel_flow_executions_request() :: %{
optional("executionIds") => list(String.t() | atom()),
required("flowName") => String.t() | atom()
}
"""
@type cancel_flow_executions_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
source_connector_properties() :: %{
"Amplitude" => amplitude_source_properties(),
"CustomConnector" => custom_connector_source_properties(),
"Datadog" => datadog_source_properties(),
"Dynatrace" => dynatrace_source_properties(),
"GoogleAnalytics" => google_analytics_source_properties(),
"InforNexus" => infor_nexus_source_properties(),
"Marketo" => marketo_source_properties(),
"Pardot" => pardot_source_properties(),
"S3" => s3_source_properties(),
"SAPOData" => s_a_p_o_data_source_properties(),
"Salesforce" => salesforce_source_properties(),
"ServiceNow" => service_now_source_properties(),
"Singular" => singular_source_properties(),
"Slack" => slack_source_properties(),
"Trendmicro" => trendmicro_source_properties(),
"Veeva" => veeva_source_properties(),
"Zendesk" => zendesk_source_properties()
}
"""
@type source_connector_properties() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
upsolver_metadata() :: %{}
"""
@type upsolver_metadata() :: %{}
@typedoc """
## Example:
execution_result() :: %{
"bytesProcessed" => float(),
"bytesWritten" => float(),
"errorInfo" => error_info(),
"maxPageSize" => float(),
"numParallelProcesses" => float(),
"recordsProcessed" => float()
}
"""
@type execution_result() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
service_now_connector_profile_credentials() :: %{
"oAuth2Credentials" => o_auth2_credentials(),
"password" => String.t() | atom(),
"username" => String.t() | atom()
}
"""
@type service_now_connector_profile_credentials() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_flow_response() :: %{
"flowStatus" => list(any())
}
"""
@type update_flow_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
conflict_exception() :: %{
"message" => String.t() | atom()
}
"""
@type conflict_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
describe_connector_entity_request() :: %{
optional("apiVersion") => String.t() | atom(),
optional("connectorProfileName") => String.t() | atom(),
optional("connectorType") => list(any()),
required("connectorEntityName") => String.t() | atom()
}
"""
@type describe_connector_entity_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
field_type_details() :: %{
"fieldLengthRange" => range(),
"fieldType" => String.t() | atom(),
"fieldValueRange" => range(),
"filterOperators" => list(list(any())()),
"supportedDateFormat" => String.t() | atom(),
"supportedValues" => list(String.t() | atom()),
"valueRegexPattern" => String.t() | atom()
}
"""
@type field_type_details() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
untag_resource_response() :: %{}
"""
@type untag_resource_response() :: %{}
@typedoc """
## Example:
describe_connector_entity_response() :: %{
"connectorEntityFields" => list(connector_entity_field())
}
"""
@type describe_connector_entity_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
s_a_p_o_data_pagination_config() :: %{
"maxPageSize" => integer()
}
"""
@type s_a_p_o_data_pagination_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
describe_connector_request() :: %{
optional("connectorLabel") => String.t() | atom(),
required("connectorType") => list(any())
}
"""
@type describe_connector_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
trigger_properties() :: %{
"Scheduled" => scheduled_trigger_properties()
}
"""
@type trigger_properties() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
unregister_connector_response() :: %{}
"""
@type unregister_connector_response() :: %{}
@typedoc """
## Example:
marketo_metadata() :: %{}
"""
@type marketo_metadata() :: %{}
@typedoc """
## Example:
untag_resource_request() :: %{
required("tagKeys") => list(String.t() | atom())
}
"""
@type untag_resource_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
cancel_flow_executions_response() :: %{
"invalidExecutions" => list(String.t() | atom())
}
"""
@type cancel_flow_executions_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
datadog_metadata() :: %{}
"""
@type datadog_metadata() :: %{}
@typedoc """
## Example:
amplitude_metadata() :: %{}
"""
@type amplitude_metadata() :: %{}
@typedoc """
## Example:
task() :: %{
"connectorOperator" => connector_operator(),
"destinationField" => String.t() | atom(),
"sourceFields" => list(String.t() | atom()),
"taskProperties" => map(),
"taskType" => list(any())
}
"""
@type task() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
redshift_connector_profile_credentials() :: %{
"password" => String.t() | atom(),
"username" => String.t() | atom()
}
"""
@type redshift_connector_profile_credentials() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
describe_connector_profiles_response() :: %{
"connectorProfileDetails" => list(connector_profile()),
"nextToken" => String.t() | atom()
}
"""
@type describe_connector_profiles_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
honeycode_metadata() :: %{
"oAuthScopes" => list(String.t() | atom())
}
"""
@type honeycode_metadata() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
veeva_connector_profile_credentials() :: %{
"password" => String.t() | atom(),
"username" => String.t() | atom()
}
"""
@type veeva_connector_profile_credentials() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
s_a_p_o_data_connector_profile_properties() :: %{
"applicationHostUrl" => String.t() | atom(),
"applicationServicePath" => String.t() | atom(),
"clientNumber" => String.t() | atom(),
"disableSSO" => boolean(),
"logonLanguage" => String.t() | atom(),
"oAuthProperties" => o_auth_properties(),
"portNumber" => integer(),
"privateLinkServiceName" => String.t() | atom()
}
"""
@type s_a_p_o_data_connector_profile_properties() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_connector_profile_response() :: %{
"connectorProfileArn" => String.t() | atom()
}
"""
@type update_connector_profile_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
google_analytics_connector_profile_properties() :: %{}
"""
@type google_analytics_connector_profile_properties() :: %{}
@typedoc """
## Example:
private_connection_provisioning_state() :: %{
"failureCause" => list(any()),
"failureMessage" => String.t() | atom(),
"status" => list(any())
}
"""
@type private_connection_provisioning_state() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_flow_response() :: %{}
"""
@type delete_flow_response() :: %{}
@typedoc """
## Example:
delete_connector_profile_request() :: %{
optional("forceDelete") => boolean(),
required("connectorProfileName") => String.t() | atom()
}
"""
@type delete_connector_profile_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
datadog_connector_profile_credentials() :: %{
"apiKey" => String.t() | atom(),
"applicationKey" => String.t() | atom()
}
"""
@type datadog_connector_profile_credentials() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
slack_source_properties() :: %{
"object" => String.t() | atom()
}
"""
@type slack_source_properties() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
unregister_connector_request() :: %{
optional("forceDelete") => boolean(),
required("connectorLabel") => String.t() | atom()
}
"""
@type unregister_connector_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
api_key_credentials() :: %{
"apiKey" => String.t() | atom(),
"apiSecretKey" => String.t() | atom()
}
"""
@type api_key_credentials() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
connector_configuration() :: %{
"authenticationConfig" => authentication_config(),
"canUseAsDestination" => boolean(),
"canUseAsSource" => boolean(),
"connectorArn" => String.t() | atom(),
"connectorDescription" => String.t() | atom(),
"connectorLabel" => String.t() | atom(),
"connectorMetadata" => connector_metadata(),
"connectorModes" => list(String.t() | atom()),
"connectorName" => String.t() | atom(),
"connectorOwner" => String.t() | atom(),
"connectorProvisioningConfig" => connector_provisioning_config(),
"connectorProvisioningType" => list(any()),
"connectorRuntimeSettings" => list(connector_runtime_setting()),
"connectorType" => list(any()),
"connectorVersion" => String.t() | atom(),
"isPrivateLinkEnabled" => boolean(),
"isPrivateLinkEndpointUrlRequired" => boolean(),
"logoURL" => String.t() | atom(),
"registeredAt" => non_neg_integer(),
"registeredBy" => String.t() | atom(),
"supportedApiVersions" => list(String.t() | atom()),
"supportedDataTransferApis" => list(data_transfer_api()),
"supportedDataTransferTypes" => list(list(any())()),
"supportedDestinationConnectors" => list(list(any())()),
"supportedOperators" => list(list(any())()),
"supportedSchedulingFrequencies" => list(list(any())()),
"supportedTriggerTypes" => list(list(any())()),
"supportedWriteOperations" => list(list(any())())
}
"""
@type connector_configuration() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_tags_for_resource_response() :: %{
"tags" => map()
}
"""
@type list_tags_for_resource_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
aggregation_config() :: %{
"aggregationType" => list(any()),
"targetFileSize" => float()
}
"""
@type aggregation_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
data_transfer_api() :: %{
"Name" => String.t() | atom(),
"Type" => list(any())
}
"""
@type data_transfer_api() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
connector_profile_config() :: %{
"connectorProfileCredentials" => connector_profile_credentials(),
"connectorProfileProperties" => connector_profile_properties()
}
"""
@type connector_profile_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
trigger_config() :: %{
"triggerProperties" => trigger_properties(),
"triggerType" => list(any())
}
"""
@type trigger_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_connector_registration_response() :: %{
"connectorArn" => String.t() | atom()
}
"""
@type update_connector_registration_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
connector_detail() :: %{
"applicationType" => String.t() | atom(),
"connectorDescription" => String.t() | atom(),
"connectorLabel" => String.t() | atom(),
"connectorModes" => list(String.t() | atom()),
"connectorName" => String.t() | atom(),
"connectorOwner" => String.t() | atom(),
"connectorProvisioningType" => list(any()),
"connectorType" => list(any()),
"connectorVersion" => String.t() | atom(),
"registeredAt" => non_neg_integer(),
"registeredBy" => String.t() | atom(),
"supportedDataTransferTypes" => list(list(any())())
}
"""
@type connector_detail() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
snowflake_destination_properties() :: %{
"bucketPrefix" => String.t() | atom(),
"errorHandlingConfig" => error_handling_config(),
"intermediateBucketName" => String.t() | atom(),
"object" => String.t() | atom()
}
"""
@type snowflake_destination_properties() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
supported_field_type_details() :: %{
"v1" => field_type_details()
}
"""
@type supported_field_type_details() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
s_a_p_o_data_parallelism_config() :: %{
"maxParallelism" => integer()
}
"""
@type s_a_p_o_data_parallelism_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
connector_operator() :: %{
"Amplitude" => list(any()),
"CustomConnector" => list(any()),
"Datadog" => list(any()),
"Dynatrace" => list(any()),
"GoogleAnalytics" => list(any()),
"InforNexus" => list(any()),
"Marketo" => list(any()),
"Pardot" => list(any()),
"S3" => list(any()),
"SAPOData" => list(any()),
"Salesforce" => list(any()),
"ServiceNow" => list(any()),
"Singular" => list(any()),
"Slack" => list(any()),
"Trendmicro" => list(any()),
"Veeva" => list(any()),
"Zendesk" => list(any())
}
"""
@type connector_operator() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
start_flow_response() :: %{
"executionId" => String.t() | atom(),
"flowArn" => String.t() | atom(),
"flowStatus" => list(any())
}
"""
@type start_flow_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_flow_request() :: %{
optional("clientToken") => String.t() | atom(),
optional("description") => String.t() | atom(),
optional("kmsArn") => String.t() | atom(),
optional("metadataCatalogConfig") => metadata_catalog_config(),
optional("tags") => map(),
required("destinationFlowConfigList") => list(destination_flow_config()),
required("flowName") => String.t() | atom(),
required("sourceFlowConfig") => source_flow_config(),
required("tasks") => list(task()),
required("triggerConfig") => trigger_config()
}
"""
@type create_flow_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
infor_nexus_source_properties() :: %{
"object" => String.t() | atom()
}
"""
@type infor_nexus_source_properties() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_connector_entities_request() :: %{
optional("apiVersion") => String.t() | atom(),
optional("connectorProfileName") => String.t() | atom(),
optional("connectorType") => list(any()),
optional("entitiesPath") => String.t() | atom(),
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom()
}
"""
@type list_connector_entities_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
o_auth2_credentials() :: %{
"accessToken" => String.t() | atom(),
"clientId" => String.t() | atom(),
"clientSecret" => String.t() | atom(),
"oAuthRequest" => connector_o_auth_request(),
"refreshToken" => String.t() | atom()
}
"""
@type o_auth2_credentials() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
stop_flow_request() :: %{
required("flowName") => String.t() | atom()
}
"""
@type stop_flow_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
s3_source_properties() :: %{
"bucketName" => String.t() | atom(),
"bucketPrefix" => String.t() | atom(),
"s3InputFormatConfig" => s3_input_format_config()
}
"""
@type s3_source_properties() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
start_flow_request() :: %{
optional("clientToken") => String.t() | atom(),
required("flowName") => String.t() | atom()
}
"""
@type start_flow_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
pardot_metadata() :: %{}
"""
@type pardot_metadata() :: %{}
@typedoc """
## Example:
pardot_connector_profile_credentials() :: %{
"accessToken" => String.t() | atom(),
"clientCredentialsArn" => String.t() | atom(),
"oAuthRequest" => connector_o_auth_request(),
"refreshToken" => String.t() | atom()
}
"""
@type pardot_connector_profile_credentials() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
event_bridge_destination_properties() :: %{
"errorHandlingConfig" => error_handling_config(),
"object" => String.t() | atom()
}
"""
@type event_bridge_destination_properties() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
prefix_config() :: %{
"pathPrefixHierarchy" => list(list(any())()),
"prefixFormat" => list(any()),
"prefixType" => list(any())
}
"""
@type prefix_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
o_auth2_custom_parameter() :: %{
"connectorSuppliedValues" => list(String.t() | atom()),
"description" => String.t() | atom(),
"isRequired" => boolean(),
"isSensitiveField" => boolean(),
"key" => String.t() | atom(),
"label" => String.t() | atom(),
"type" => list(any())
}
"""
@type o_auth2_custom_parameter() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
s_a_p_o_data_metadata() :: %{}
"""
@type s_a_p_o_data_metadata() :: %{}
@typedoc """
## Example:
custom_auth_credentials() :: %{
"credentialsMap" => map(),
"customAuthenticationType" => String.t() | atom()
}
"""
@type custom_auth_credentials() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
source_flow_config() :: %{
"apiVersion" => String.t() | atom(),
"connectorProfileName" => String.t() | atom(),
"connectorType" => list(any()),
"incrementalPullConfig" => incremental_pull_config(),
"sourceConnectorProperties" => source_connector_properties()
}
"""
@type source_flow_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
infor_nexus_metadata() :: %{}
"""
@type infor_nexus_metadata() :: %{}
@typedoc """
## Example:
singular_connector_profile_credentials() :: %{
"apiKey" => String.t() | atom()
}
"""
@type singular_connector_profile_credentials() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
zendesk_metadata() :: %{
"oAuthScopes" => list(String.t() | atom())
}
"""
@type zendesk_metadata() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
singular_metadata() :: %{}
"""
@type singular_metadata() :: %{}
@typedoc """
## Example:
create_flow_response() :: %{
"flowArn" => String.t() | atom(),
"flowStatus" => list(any())
}
"""
@type create_flow_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
error_handling_config() :: %{
"bucketName" => String.t() | atom(),
"bucketPrefix" => String.t() | atom(),
"failOnFirstDestinationError" => boolean()
}
"""
@type error_handling_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
trendmicro_connector_profile_credentials() :: %{
"apiSecretKey" => String.t() | atom()
}
"""
@type trendmicro_connector_profile_credentials() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
custom_connector_destination_properties() :: %{
"customProperties" => map(),
"entityName" => String.t() | atom(),
"errorHandlingConfig" => error_handling_config(),
"idFieldNames" => list(String.t() | atom()),
"writeOperationType" => list(any())
}
"""
@type custom_connector_destination_properties() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
trendmicro_metadata() :: %{}
"""
@type trendmicro_metadata() :: %{}
@typedoc """
## Example:
s3_input_format_config() :: %{
"s3InputFileType" => list(any())
}
"""
@type s3_input_format_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
marketo_destination_properties() :: %{
"errorHandlingConfig" => error_handling_config(),
"object" => String.t() | atom()
}
"""
@type marketo_destination_properties() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
incremental_pull_config() :: %{
"datetimeTypeFieldName" => String.t() | atom()
}
"""
@type incremental_pull_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
snowflake_connector_profile_properties() :: %{
"accountName" => String.t() | atom(),
"bucketName" => String.t() | atom(),
"bucketPrefix" => String.t() | atom(),
"privateLinkServiceName" => String.t() | atom(),
"region" => String.t() | atom(),
"stage" => String.t() | atom(),
"warehouse" => String.t() | atom()
}
"""
@type snowflake_connector_profile_properties() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
snowflake_metadata() :: %{
"supportedRegions" => list(String.t() | atom())
}
"""
@type snowflake_metadata() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
execution_details() :: %{
"mostRecentExecutionMessage" => String.t() | atom(),
"mostRecentExecutionStatus" => list(any()),
"mostRecentExecutionTime" => non_neg_integer()
}
"""
@type execution_details() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
connector_server_exception() :: %{
"message" => String.t() | atom()
}
"""
@type connector_server_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
o_auth_properties() :: %{
"authCodeUrl" => String.t() | atom(),
"oAuthScopes" => list(String.t() | atom()),
"tokenUrl" => String.t() | atom()
}
"""
@type o_auth_properties() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
s3_output_format_config() :: %{
"aggregationConfig" => aggregation_config(),
"fileType" => list(any()),
"prefixConfig" => prefix_config(),
"preserveSourceDataTyping" => boolean()
}
"""
@type s3_output_format_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
connector_profile_properties() :: %{
"Amplitude" => amplitude_connector_profile_properties(),
"CustomConnector" => custom_connector_profile_properties(),
"Datadog" => datadog_connector_profile_properties(),
"Dynatrace" => dynatrace_connector_profile_properties(),
"GoogleAnalytics" => google_analytics_connector_profile_properties(),
"Honeycode" => honeycode_connector_profile_properties(),
"InforNexus" => infor_nexus_connector_profile_properties(),
"Marketo" => marketo_connector_profile_properties(),
"Pardot" => pardot_connector_profile_properties(),
"Redshift" => redshift_connector_profile_properties(),
"SAPOData" => s_a_p_o_data_connector_profile_properties(),
"Salesforce" => salesforce_connector_profile_properties(),
"ServiceNow" => service_now_connector_profile_properties(),
"Singular" => singular_connector_profile_properties(),
"Slack" => slack_connector_profile_properties(),
"Snowflake" => snowflake_connector_profile_properties(),
"Trendmicro" => trendmicro_connector_profile_properties(),
"Veeva" => veeva_connector_profile_properties(),
"Zendesk" => zendesk_connector_profile_properties()
}
"""
@type connector_profile_properties() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
upsolver_s3_output_format_config() :: %{
"aggregationConfig" => aggregation_config(),
"fileType" => list(any()),
"prefixConfig" => prefix_config()
}
"""
@type upsolver_s3_output_format_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
describe_flow_request() :: %{
required("flowName") => String.t() | atom()
}
"""
@type describe_flow_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
register_connector_response() :: %{
"connectorArn" => String.t() | atom()
}
"""
@type register_connector_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
custom_connector_source_properties() :: %{
"customProperties" => map(),
"dataTransferApi" => data_transfer_api(),
"entityName" => String.t() | atom()
}
"""
@type custom_connector_source_properties() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
authentication_config() :: %{
"customAuthConfigs" => list(custom_auth_config()),
"isApiKeyAuthSupported" => boolean(),
"isBasicAuthSupported" => boolean(),
"isCustomAuthSupported" => boolean(),
"isOAuth2Supported" => boolean(),
"oAuth2Defaults" => o_auth2_defaults()
}
"""
@type authentication_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
connector_runtime_setting() :: %{
"connectorSuppliedValueOptions" => list(String.t() | atom()),
"dataType" => String.t() | atom(),
"description" => String.t() | atom(),
"isRequired" => boolean(),
"key" => String.t() | atom(),
"label" => String.t() | atom(),
"scope" => String.t() | atom()
}
"""
@type connector_runtime_setting() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
metadata_catalog_config() :: %{
"glueDataCatalog" => glue_data_catalog_config()
}
"""
@type metadata_catalog_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
snowflake_connector_profile_credentials() :: %{
"password" => String.t() | atom(),
"username" => String.t() | atom()
}
"""
@type snowflake_connector_profile_credentials() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_tags_for_resource_request() :: %{}
"""
@type list_tags_for_resource_request() :: %{}
@typedoc """
## Example:
service_quota_exceeded_exception() :: %{
"message" => String.t() | atom()
}
"""
@type service_quota_exceeded_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
destination_flow_config() :: %{
"apiVersion" => String.t() | atom(),
"connectorProfileName" => String.t() | atom(),
"connectorType" => list(any()),
"destinationConnectorProperties" => destination_connector_properties()
}
"""
@type destination_flow_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
slack_metadata() :: %{
"oAuthScopes" => list(String.t() | atom())
}
"""
@type slack_metadata() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_connectors_response() :: %{
"connectors" => list(connector_detail()),
"nextToken" => String.t() | atom()
}
"""
@type list_connectors_response() :: %{(String.t() | atom()) => any()}
@type cancel_flow_executions_errors() ::
resource_not_found_exception()
| internal_server_exception()
| validation_exception()
| access_denied_exception()
| throttling_exception()
@type create_connector_profile_errors() ::
service_quota_exceeded_exception()
| conflict_exception()
| internal_server_exception()
| validation_exception()
| connector_authentication_exception()
@type create_flow_errors() ::
service_quota_exceeded_exception()
| connector_server_exception()
| conflict_exception()
| resource_not_found_exception()
| internal_server_exception()
| validation_exception()
| connector_authentication_exception()
| access_denied_exception()
@type delete_connector_profile_errors() ::
conflict_exception() | resource_not_found_exception() | internal_server_exception()
@type delete_flow_errors() ::
conflict_exception() | resource_not_found_exception() | internal_server_exception()
@type describe_connector_errors() ::
resource_not_found_exception() | internal_server_exception() | validation_exception()
@type describe_connector_entity_errors() ::
connector_server_exception()
| resource_not_found_exception()
| internal_server_exception()
| validation_exception()
| connector_authentication_exception()
@type describe_connector_profiles_errors() ::
internal_server_exception() | validation_exception()
@type describe_connectors_errors() :: internal_server_exception() | validation_exception()
@type describe_flow_errors() :: resource_not_found_exception() | internal_server_exception()
@type describe_flow_execution_records_errors() ::
resource_not_found_exception() | internal_server_exception() | validation_exception()
@type list_connector_entities_errors() ::
connector_server_exception()
| resource_not_found_exception()
| internal_server_exception()
| validation_exception()
| connector_authentication_exception()
@type list_connectors_errors() :: internal_server_exception() | validation_exception()
@type list_flows_errors() :: internal_server_exception() | validation_exception()
@type list_tags_for_resource_errors() ::
resource_not_found_exception() | internal_server_exception() | validation_exception()
@type register_connector_errors() ::
service_quota_exceeded_exception()
| connector_server_exception()
| conflict_exception()
| resource_not_found_exception()
| internal_server_exception()
| validation_exception()
| connector_authentication_exception()
| access_denied_exception()
| throttling_exception()
@type reset_connector_metadata_cache_errors() ::
conflict_exception()
| resource_not_found_exception()
| internal_server_exception()
| validation_exception()
@type start_flow_errors() ::
service_quota_exceeded_exception()
| conflict_exception()
| resource_not_found_exception()
| internal_server_exception()
@type stop_flow_errors() ::
conflict_exception()
| unsupported_operation_exception()
| resource_not_found_exception()
| internal_server_exception()
@type tag_resource_errors() ::
resource_not_found_exception() | internal_server_exception() | validation_exception()
@type unregister_connector_errors() ::
conflict_exception() | resource_not_found_exception() | internal_server_exception()
@type untag_resource_errors() ::
resource_not_found_exception() | internal_server_exception() | validation_exception()
@type update_connector_profile_errors() ::
conflict_exception()
| resource_not_found_exception()
| internal_server_exception()
| validation_exception()
| connector_authentication_exception()
@type update_connector_registration_errors() ::
service_quota_exceeded_exception()
| connector_server_exception()
| conflict_exception()
| resource_not_found_exception()
| internal_server_exception()
| validation_exception()
| connector_authentication_exception()
| access_denied_exception()
| throttling_exception()
@type update_flow_errors() ::
service_quota_exceeded_exception()
| connector_server_exception()
| conflict_exception()
| resource_not_found_exception()
| internal_server_exception()
| validation_exception()
| connector_authentication_exception()
| access_denied_exception()
def metadata do
%{
api_version: "2020-08-23",
content_type: "application/x-amz-json-1.1",
credential_scope: nil,
endpoint_prefix: "appflow",
global?: false,
hostname: nil,
protocol: "rest-json",
service_id: "Appflow",
signature_version: "v4",
signing_name: "appflow",
target_prefix: nil
}
end
@doc """
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`.
When you cancel a run, you still incur charges for any data that the run already
processed before the cancellation. If the run had already written some data to
the flow
destination, then that data remains in the destination. If you configured the
flow to use a
batch API (such as the Salesforce Bulk API 2.0), then the run will finish
reading or writing
its entire batch of data after the cancellation. For these operations, the data
processing
charges for Amazon AppFlow apply. For the pricing information, see [Amazon AppFlow pricing](http://aws.amazon.com/appflow/pricing/).
"""
@spec cancel_flow_executions(map(), cancel_flow_executions_request(), list()) ::
{:ok, cancel_flow_executions_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, cancel_flow_executions_errors()}
def cancel_flow_executions(%Client{} = client, input, options \\ []) do
url_path = "/cancel-flow-executions"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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.
"""
@spec create_connector_profile(map(), create_connector_profile_request(), list()) ::
{:ok, create_connector_profile_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_connector_profile_errors()}
def create_connector_profile(%Client{} = client, input, options \\ []) do
url_path = "/create-connector-profile"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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.
"""
@spec create_flow(map(), create_flow_request(), list()) ::
{:ok, create_flow_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_flow_errors()}
def create_flow(%Client{} = client, input, options \\ []) do
url_path = "/create-flow"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Enables you to delete an existing connector profile.
"""
@spec delete_connector_profile(map(), delete_connector_profile_request(), list()) ::
{:ok, delete_connector_profile_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_connector_profile_errors()}
def delete_connector_profile(%Client{} = client, input, options \\ []) do
url_path = "/delete-connector-profile"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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.
"""
@spec delete_flow(map(), delete_flow_request(), list()) ::
{:ok, delete_flow_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_flow_errors()}
def delete_flow(%Client{} = client, input, options \\ []) do
url_path = "/delete-flow"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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.
"""
@spec describe_connector(map(), describe_connector_request(), list()) ::
{:ok, describe_connector_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, describe_connector_errors()}
def describe_connector(%Client{} = client, input, options \\ []) do
url_path = "/describe-connector"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Provides details regarding the entity used with the connector, with a
description of the
data model for each field in that entity.
"""
@spec describe_connector_entity(map(), describe_connector_entity_request(), list()) ::
{:ok, describe_connector_entity_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, describe_connector_entity_errors()}
def describe_connector_entity(%Client{} = client, input, options \\ []) do
url_path = "/describe-connector-entity"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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.
"""
@spec describe_connector_profiles(map(), describe_connector_profiles_request(), list()) ::
{:ok, describe_connector_profiles_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, describe_connector_profiles_errors()}
def describe_connector_profiles(%Client{} = client, input, options \\ []) do
url_path = "/describe-connector-profiles"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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.
"""
@spec describe_connectors(map(), describe_connectors_request(), list()) ::
{:ok, describe_connectors_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, describe_connectors_errors()}
def describe_connectors(%Client{} = client, input, options \\ []) do
url_path = "/describe-connectors"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Provides a description of the specified flow.
"""
@spec describe_flow(map(), describe_flow_request(), list()) ::
{:ok, describe_flow_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, describe_flow_errors()}
def describe_flow(%Client{} = client, input, options \\ []) do
url_path = "/describe-flow"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Fetches the execution history of the flow.
"""
@spec describe_flow_execution_records(map(), describe_flow_execution_records_request(), list()) ::
{:ok, describe_flow_execution_records_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, describe_flow_execution_records_errors()}
def describe_flow_execution_records(%Client{} = client, input, options \\ []) do
url_path = "/describe-flow-execution-records"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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.
"""
@spec list_connector_entities(map(), list_connector_entities_request(), list()) ::
{:ok, list_connector_entities_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_connector_entities_errors()}
def list_connector_entities(%Client{} = client, input, options \\ []) do
url_path = "/list-connector-entities"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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.
"""
@spec list_connectors(map(), list_connectors_request(), list()) ::
{:ok, list_connectors_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_connectors_errors()}
def list_connectors(%Client{} = client, input, options \\ []) do
url_path = "/list-connectors"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Lists all of the flows associated with your account.
"""
@spec list_flows(map(), list_flows_request(), list()) ::
{:ok, list_flows_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_flows_errors()}
def list_flows(%Client{} = client, input, options \\ []) do
url_path = "/list-flows"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Retrieves the tags that are associated with a specified flow.
"""
@spec list_tags_for_resource(map(), String.t() | atom(), list()) ::
{:ok, list_tags_for_resource_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_tags_for_resource_errors()}
def list_tags_for_resource(%Client{} = client, resource_arn, options \\ []) do
url_path = "/tags/#{AWS.Util.encode_uri(resource_arn)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
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.
"""
@spec register_connector(map(), register_connector_request(), list()) ::
{:ok, register_connector_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, register_connector_errors()}
def register_connector(%Client{} = client, input, options \\ []) do
url_path = "/register-connector"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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.
"""
@spec reset_connector_metadata_cache(map(), reset_connector_metadata_cache_request(), list()) ::
{:ok, reset_connector_metadata_cache_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, reset_connector_metadata_cache_errors()}
def reset_connector_metadata_cache(%Client{} = client, input, options \\ []) do
url_path = "/reset-connector-metadata-cache"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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.
"""
@spec start_flow(map(), start_flow_request(), list()) ::
{:ok, start_flow_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, start_flow_errors()}
def start_flow(%Client{} = client, input, options \\ []) do
url_path = "/start-flow"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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.
"""
@spec stop_flow(map(), stop_flow_request(), list()) ::
{:ok, stop_flow_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, stop_flow_errors()}
def stop_flow(%Client{} = client, input, options \\ []) do
url_path = "/stop-flow"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Applies a tag to the specified flow.
"""
@spec tag_resource(map(), String.t() | atom(), tag_resource_request(), list()) ::
{:ok, tag_resource_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, tag_resource_errors()}
def tag_resource(%Client{} = client, resource_arn, input, options \\ []) do
url_path = "/tags/#{AWS.Util.encode_uri(resource_arn)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Unregisters the custom connector registered in your account that matches the
connector
label provided in the request.
"""
@spec unregister_connector(map(), unregister_connector_request(), list()) ::
{:ok, unregister_connector_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, unregister_connector_errors()}
def unregister_connector(%Client{} = client, input, options \\ []) do
url_path = "/unregister-connector"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Removes a tag from the specified flow.
"""
@spec untag_resource(map(), String.t() | atom(), untag_resource_request(), list()) ::
{:ok, untag_resource_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, untag_resource_errors()}
def untag_resource(%Client{} = client, resource_arn, input, options \\ []) do
url_path = "/tags/#{AWS.Util.encode_uri(resource_arn)}"
headers = []
custom_headers = []
{query_params, input} =
[
{"tagKeys", "tagKeys"}
]
|> Request.build_params(input)
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Updates a given connector profile associated with your account.
"""
@spec update_connector_profile(map(), update_connector_profile_request(), list()) ::
{:ok, update_connector_profile_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_connector_profile_errors()}
def update_connector_profile(%Client{} = client, input, options \\ []) do
url_path = "/update-connector-profile"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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
"""
@spec update_connector_registration(map(), update_connector_registration_request(), list()) ::
{:ok, update_connector_registration_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_connector_registration_errors()}
def update_connector_registration(%Client{} = client, input, options \\ []) do
url_path = "/update-connector-registration"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Updates an existing flow.
"""
@spec update_flow(map(), update_flow_request(), list()) ::
{:ok, update_flow_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_flow_errors()}
def update_flow(%Client{} = client, input, options \\ []) do
url_path = "/update-flow"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
end