String aggregationType
Specifies whether Amazon AppFlow aggregates the flow records into a single file, or leave them unaggregated.
Long targetFileSize
The desired file size, in MB, for each output file that Amazon AppFlow writes to the flow destination. For each file, Amazon AppFlow attempts to achieve the size that you specify. The actual file sizes might differ from this target based on the number and size of the records that each file contains.
String object
The object specified in the Amplitude flow source.
Boolean isBasicAuthSupported
Indicates whether basic authentication is supported by the connector.
Boolean isApiKeyAuthSupported
Indicates whether API key authentication is supported by the connector
Boolean isOAuth2Supported
Indicates whether OAuth 2.0 authentication is supported by the connector.
Boolean isCustomAuthSupported
Indicates whether custom authentication is supported by the connector
OAuth2Defaults oAuth2Defaults
Contains the default values required for OAuth 2.0 authentication.
List<E> customAuthConfigs
Contains information required for custom authentication.
String key
The authentication key required to authenticate with the connector.
Boolean isRequired
Indicates whether this authentication parameter is required.
String label
Label used for authentication parameter.
String description
A description about the authentication parameter.
Boolean isSensitiveField
Indicates whether this authentication parameter is a sensitive field.
List<E> connectorSuppliedValues
Contains default values for this authentication parameter that are supplied by the connector.
String flowName
The name of a flow with active runs that you want to cancel.
List<E> executionIds
The ID of each active run to cancel. These runs must belong to the flow you specify in your request.
If you omit this parameter, your request ends all active runs that belong to the flow.
Boolean canUseAsSource
Specifies whether the connector can be used as a source.
Boolean canUseAsDestination
Specifies whether the connector can be used as a destination.
List<E> supportedDestinationConnectors
Lists the connectors that are available for use as destinations.
List<E> supportedSchedulingFrequencies
Specifies the supported flow frequency for that connector.
Boolean isPrivateLinkEnabled
Specifies if PrivateLink is enabled for that connector.
Boolean isPrivateLinkEndpointUrlRequired
Specifies if a PrivateLink endpoint URL is required.
List<E> supportedTriggerTypes
Specifies the supported trigger types for the flow.
ConnectorMetadata connectorMetadata
Specifies connector-specific metadata such as oAuthScopes, supportedRegions,
privateLinkServiceUrl, and so on.
String connectorType
The connector type.
String connectorLabel
The label used for registering the connector.
String connectorDescription
A description about the connector.
String connectorOwner
The owner who developed the connector.
String connectorName
The connector name.
String connectorVersion
The connector version.
String connectorArn
The Amazon Resource Name (ARN) for the registered connector.
List<E> connectorModes
The connection modes that the connector supports.
AuthenticationConfig authenticationConfig
The authentication config required for the connector.
List<E> connectorRuntimeSettings
The required connector runtime settings.
List<E> supportedApiVersions
A list of API versions that are supported by the connector.
List<E> supportedOperators
A list of operators supported by the connector.
List<E> supportedWriteOperations
A list of write operations supported by the connector.
String connectorProvisioningType
The provisioning type used to register the connector.
ConnectorProvisioningConfig connectorProvisioningConfig
The configuration required for registering the connector.
String logoURL
Logo URL of the connector.
Date registeredAt
The date on which the connector was registered.
String registeredBy
Information about who registered the connector.
List<E> supportedDataTransferTypes
The data transfer types that the connector supports.
Structured records.
Files or binary data.
List<E> supportedDataTransferApis
The APIs of the connector application that Amazon AppFlow can use to transfer your data.
String connectorDescription
A description about the registered connector.
String connectorName
The name of the connector.
String connectorOwner
The owner of the connector.
String connectorVersion
The connector version.
String applicationType
The application type of the connector.
String connectorType
The connector type.
String connectorLabel
A label used for the connector.
Date registeredAt
The time at which the connector was registered.
String registeredBy
The user who registered the connector.
String connectorProvisioningType
The provisioning type that the connector uses.
List<E> connectorModes
The connection mode that the connector supports.
List<E> supportedDataTransferTypes
The data transfer types that the connector supports.
Structured records.
Files or binary data.
String name
The name of the connector entity.
String label
The label applied to the connector entity.
Boolean hasNestedEntities
Specifies whether the connector entity is a parent or a category and has more entities nested underneath it. If
another call is made with entitiesPath = "the_current_entity_name_with_hasNestedEntities_true", then
it returns the nested entities underneath it. This provides a way to retrieve all supported entities in a
recursive fashion.
String identifier
The unique identifier of the connector field.
String parentIdentifier
The parent identifier of the connector field.
String label
The label applied to a connector entity field.
Boolean isPrimaryKey
Booelan value that indicates whether this field can be used as a primary key.
String defaultValue
Default value that can be assigned to this field.
Boolean isDeprecated
Booelan value that indicates whether this field is deprecated or not.
SupportedFieldTypeDetails supportedFieldTypeDetails
Contains details regarding the supported FieldType, including the corresponding
filterOperators and supportedValues.
String description
A description of the connector entity field.
SourceFieldProperties sourceProperties
The properties that can be applied to a field when the connector is being used as a source.
DestinationFieldProperties destinationProperties
The properties applied to a field when the connector is being used as a destination.
Map<K,V> customProperties
A map that has specific properties related to the ConnectorEntityField.
AmplitudeMetadata amplitude
The connector metadata specific to Amplitude.
DatadogMetadata datadog
The connector metadata specific to Datadog.
DynatraceMetadata dynatrace
The connector metadata specific to Dynatrace.
GoogleAnalyticsMetadata googleAnalytics
The connector metadata specific to Google Analytics.
InforNexusMetadata inforNexus
The connector metadata specific to Infor Nexus.
MarketoMetadata marketo
The connector metadata specific to Marketo.
RedshiftMetadata redshift
The connector metadata specific to Amazon Redshift.
S3Metadata s3
The connector metadata specific to Amazon S3.
SalesforceMetadata salesforce
The connector metadata specific to Salesforce.
ServiceNowMetadata serviceNow
The connector metadata specific to ServiceNow.
SingularMetadata singular
The connector metadata specific to Singular.
SlackMetadata slack
The connector metadata specific to Slack.
SnowflakeMetadata snowflake
The connector metadata specific to Snowflake.
TrendmicroMetadata trendmicro
The connector metadata specific to Trend Micro.
VeevaMetadata veeva
The connector metadata specific to Veeva.
ZendeskMetadata zendesk
The connector metadata specific to Zendesk.
EventBridgeMetadata eventBridge
The connector metadata specific to Amazon EventBridge.
UpsolverMetadata upsolver
The connector metadata specific to Upsolver.
CustomerProfilesMetadata customerProfiles
The connector metadata specific to Amazon Connect Customer Profiles.
HoneycodeMetadata honeycode
The connector metadata specific to Amazon Honeycode.
SAPODataMetadata sAPOData
PardotMetadata pardot
The connector metadata specific to Salesforce Pardot.
String amplitude
The operation to be performed on the provided Amplitude source fields.
String datadog
The operation to be performed on the provided Datadog source fields.
String dynatrace
The operation to be performed on the provided Dynatrace source fields.
String googleAnalytics
The operation to be performed on the provided Google Analytics source fields.
String inforNexus
The operation to be performed on the provided Infor Nexus source fields.
String marketo
The operation to be performed on the provided Marketo source fields.
String s3
The operation to be performed on the provided Amazon S3 source fields.
String salesforce
The operation to be performed on the provided Salesforce source fields.
String serviceNow
The operation to be performed on the provided ServiceNow source fields.
String singular
The operation to be performed on the provided Singular source fields.
String slack
The operation to be performed on the provided Slack source fields.
String trendmicro
The operation to be performed on the provided Trend Micro source fields.
String veeva
The operation to be performed on the provided Veeva source fields.
String zendesk
The operation to be performed on the provided Zendesk source fields.
String sAPOData
The operation to be performed on the provided SAPOData source fields.
String customConnector
Operators supported by the custom connector.
String pardot
The operation to be performed on the provided Salesforce Pardot source fields.
String connectorProfileArn
The Amazon Resource Name (ARN) of the connector profile.
String connectorProfileName
The name of the connector profile. The name is unique for each ConnectorProfile in the Amazon Web
Services account.
String connectorType
The type of connector, such as Salesforce, Amplitude, and so on.
String connectorLabel
The label for the connector profile being created.
String connectionMode
Indicates the connection mode and if it is public or private.
String credentialsArn
The Amazon Resource Name (ARN) of the connector profile credentials.
ConnectorProfileProperties connectorProfileProperties
The connector-specific properties of the profile configuration.
Date createdAt
Specifies when the connector profile was created.
Date lastUpdatedAt
Specifies when the connector profile was last updated.
PrivateConnectionProvisioningState privateConnectionProvisioningState
Specifies the private connection provisioning state.
ConnectorProfileProperties connectorProfileProperties
The connector-specific properties of the profile configuration.
ConnectorProfileCredentials connectorProfileCredentials
The connector-specific credentials required by each connector.
AmplitudeConnectorProfileCredentials amplitude
The connector-specific credentials required when using Amplitude.
DatadogConnectorProfileCredentials datadog
The connector-specific credentials required when using Datadog.
DynatraceConnectorProfileCredentials dynatrace
The connector-specific credentials required when using Dynatrace.
GoogleAnalyticsConnectorProfileCredentials googleAnalytics
The connector-specific credentials required when using Google Analytics.
HoneycodeConnectorProfileCredentials honeycode
The connector-specific credentials required when using Amazon Honeycode.
InforNexusConnectorProfileCredentials inforNexus
The connector-specific credentials required when using Infor Nexus.
MarketoConnectorProfileCredentials marketo
The connector-specific credentials required when using Marketo.
RedshiftConnectorProfileCredentials redshift
The connector-specific credentials required when using Amazon Redshift.
SalesforceConnectorProfileCredentials salesforce
The connector-specific credentials required when using Salesforce.
ServiceNowConnectorProfileCredentials serviceNow
The connector-specific credentials required when using ServiceNow.
SingularConnectorProfileCredentials singular
The connector-specific credentials required when using Singular.
SlackConnectorProfileCredentials slack
The connector-specific credentials required when using Slack.
SnowflakeConnectorProfileCredentials snowflake
The connector-specific credentials required when using Snowflake.
TrendmicroConnectorProfileCredentials trendmicro
The connector-specific credentials required when using Trend Micro.
VeevaConnectorProfileCredentials veeva
The connector-specific credentials required when using Veeva.
ZendeskConnectorProfileCredentials zendesk
The connector-specific credentials required when using Zendesk.
SAPODataConnectorProfileCredentials sAPOData
CustomConnectorProfileCredentials customConnector
PardotConnectorProfileCredentials pardot
The connector-specific credentials required when using Salesforce Pardot.
AmplitudeConnectorProfileProperties amplitude
The connector-specific properties required by Amplitude.
DatadogConnectorProfileProperties datadog
The connector-specific properties required by Datadog.
DynatraceConnectorProfileProperties dynatrace
The connector-specific properties required by Dynatrace.
GoogleAnalyticsConnectorProfileProperties googleAnalytics
The connector-specific properties required Google Analytics.
HoneycodeConnectorProfileProperties honeycode
The connector-specific properties required by Amazon Honeycode.
InforNexusConnectorProfileProperties inforNexus
The connector-specific properties required by Infor Nexus.
MarketoConnectorProfileProperties marketo
The connector-specific properties required by Marketo.
RedshiftConnectorProfileProperties redshift
The connector-specific properties required by Amazon Redshift.
SalesforceConnectorProfileProperties salesforce
The connector-specific properties required by Salesforce.
ServiceNowConnectorProfileProperties serviceNow
The connector-specific properties required by serviceNow.
SingularConnectorProfileProperties singular
The connector-specific properties required by Singular.
SlackConnectorProfileProperties slack
The connector-specific properties required by Slack.
SnowflakeConnectorProfileProperties snowflake
The connector-specific properties required by Snowflake.
TrendmicroConnectorProfileProperties trendmicro
The connector-specific properties required by Trend Micro.
VeevaConnectorProfileProperties veeva
The connector-specific properties required by Veeva.
ZendeskConnectorProfileProperties zendesk
The connector-specific properties required by Zendesk.
SAPODataConnectorProfileProperties sAPOData
CustomConnectorProfileProperties customConnector
The properties required by the custom connector.
PardotConnectorProfileProperties pardot
The connector-specific properties required by Salesforce Pardot.
LambdaConnectorProvisioningConfig lambda
Contains information about the configuration of the lambda which is being registered as the connector.
String key
Contains value information about the connector runtime setting.
String dataType
Data type of the connector runtime setting.
Boolean isRequired
Indicates whether this connector runtime setting is required.
String label
A label used for connector runtime setting.
String description
A description about the connector runtime setting.
String scope
Indicates the scope of the connector runtime setting.
List<E> connectorSuppliedValueOptions
Contains default values for the connector runtime setting that are supplied by the connector.
String connectorProfileName
The name of the connector profile. The name is unique for each ConnectorProfile in your Amazon Web
Services account.
String kmsArn
The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. This is required if you do not want to use the Amazon AppFlow-managed KMS key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.
String connectorType
The type of connector, such as Salesforce, Amplitude, and so on.
String connectorLabel
The label of the connector. The label is unique for each ConnectorRegistration in your Amazon Web
Services account. Only needed if calling for CUSTOMCONNECTOR connector type/.
String connectionMode
Indicates the connection mode and specifies whether it is public or private. Private flows use Amazon Web Services PrivateLink to route data over Amazon Web Services infrastructure without exposing it to the public internet.
ConnectorProfileConfig connectorProfileConfig
Defines the connector-specific configuration and credentials.
String clientToken
The clientToken parameter is an idempotency token. It ensures that your
CreateConnectorProfile request completes only once. You choose the value to pass. For example, if
you don't receive a response from your request, you can safely retry the request with the same
clientToken parameter value.
If you omit a clientToken value, the Amazon Web Services SDK that you are using inserts a value for
you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own
value for other use cases.
If you specify input parameters that differ from your first request, an error occurs. If you use a different
value for clientToken, Amazon AppFlow considers it a new call to CreateConnectorProfile
. The token is active for 8 hours.
String connectorProfileArn
The Amazon Resource Name (ARN) of the connector profile.
String flowName
The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
String description
A description of the flow you want to create.
String kmsArn
The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. This is required if you do not want to use the Amazon AppFlow-managed KMS key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.
TriggerConfig triggerConfig
The trigger settings that determine how and when the flow runs.
SourceFlowConfig sourceFlowConfig
The configuration that controls how Amazon AppFlow retrieves data from the source connector.
List<E> destinationFlowConfigList
The configuration that controls how Amazon AppFlow places data in the destination connector.
List<E> tasks
A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
Map<K,V> tags
The tags used to organize, track, or control access for your flow.
MetadataCatalogConfig metadataCatalogConfig
Specifies the configuration that Amazon AppFlow uses when it catalogs the data that's transferred by the associated flow. When Amazon AppFlow catalogs the data from a flow, it stores metadata in a data catalog.
String clientToken
The clientToken parameter is an idempotency token. It ensures that your CreateFlow
request completes only once. You choose the value to pass. For example, if you don't receive a response from your
request, you can safely retry the request with the same clientToken parameter value.
If you omit a clientToken value, the Amazon Web Services SDK that you are using inserts a value for
you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own
value for other use cases.
If you specify input parameters that differ from your first request, an error occurs. If you use a different
value for clientToken, Amazon AppFlow considers it a new call to CreateFlow. The token
is active for 8 hours.
String entityName
The entity specified in the custom connector as a destination in the flow.
ErrorHandlingConfig errorHandlingConfig
The settings that determine how Amazon AppFlow handles an error when placing data in the custom connector as destination.
String writeOperationType
Specifies the type of write operation to be performed in the custom connector when it's used as destination.
List<E> idFieldNames
The name of the field that Amazon AppFlow uses as an ID when performing a write operation such as update, delete, or upsert.
Map<K,V> customProperties
The custom properties that are specific to the connector when it's used as a destination in the flow.
String authenticationType
The authentication type that the custom connector uses for authenticating while creating a connector profile.
BasicAuthCredentials basic
The basic credentials that are required for the authentication of the user.
OAuth2Credentials oauth2
The OAuth 2.0 credentials required for the authentication of the user.
ApiKeyCredentials apiKey
The API keys required for the authentication of the user.
CustomAuthCredentials custom
If the connector uses the custom authentication mechanism, this holds the required credentials.
Map<K,V> profileProperties
A map of properties that are required to create a profile for the custom connector.
OAuth2Properties oAuth2Properties
String entityName
The entity specified in the custom connector as a source in the flow.
Map<K,V> customProperties
Custom properties that are required to use the custom connector as a source.
DataTransferApi dataTransferApi
The API of the connector application that Amazon AppFlow uses to transfer your data.
String apiKey
A unique alphanumeric identifier used to authenticate a user, developer, or calling program to your API.
String applicationKey
Application keys, in conjunction with your API key, give you full access to Datadog’s programmatic API. Application keys are associated with the user account that created them. The application key is used to log all requests made to the API.
String instanceUrl
The location of the Datadog resource.
String object
The object specified in the Datadog flow source.
String name
The name of the connector application API.
String type
You can specify one of the following types:
The default. Optimizes a flow for datasets that fluctuate in size from small to large. For each flow run, Amazon AppFlow chooses to use the SYNC or ASYNC API type based on the amount of data that the run transfers.
A synchronous API. This type of API optimizes a flow for small to medium-sized datasets.
An asynchronous API. This type of API optimizes a flow for large datasets.
String connectorEntityName
The entity name for that connector.
String connectorType
The type of connector application, such as Salesforce, Amplitude, and so on.
String connectorProfileName
The name of the connector profile. The name is unique for each ConnectorProfile in the Amazon Web
Services account.
String apiVersion
The version of the API that's used by the connector.
List<E> connectorProfileNames
The name of the connector profile. The name is unique for each ConnectorProfile in the Amazon Web
Services account.
String connectorType
The type of connector, such as Salesforce, Amplitude, and so on.
String connectorLabel
The name of the connector. The name is unique for each ConnectorRegistration in your Amazon Web
Services account. Only needed if calling for CUSTOMCONNECTOR connector type/.
Integer maxResults
Specifies the maximum number of items that should be returned in the result set. The default for
maxResults is 20 (for all paginated API operations).
String nextToken
The pagination token for the next page of data.
String connectorType
The connector type, such as CUSTOMCONNECTOR, Saleforce, Marketo. Please choose CUSTOMCONNECTOR for Lambda based custom connectors.
String connectorLabel
The label of the connector. The label is unique for each ConnectorRegistration in your Amazon Web
Services account. Only needed if calling for CUSTOMCONNECTOR connector type/.
ConnectorConfiguration connectorConfiguration
Configuration info of all the connectors that the user requested.
String flowName
The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
Integer maxResults
Specifies the maximum number of items that should be returned in the result set. The default for
maxResults is 20 (for all paginated API operations).
String nextToken
The pagination token for the next page of data.
String flowName
The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
String flowArn
The flow's Amazon Resource Name (ARN).
String description
A description of the flow.
String flowName
The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
String kmsArn
The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. This is required if you do not want to use the Amazon AppFlow-managed KMS key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.
String flowStatus
Indicates the current status of the flow.
String flowStatusMessage
Contains an error message if the flow status is in a suspended or error state. This applies only to scheduled or event-triggered flows.
SourceFlowConfig sourceFlowConfig
The configuration that controls how Amazon AppFlow retrieves data from the source connector.
List<E> destinationFlowConfigList
The configuration that controls how Amazon AppFlow transfers data to the destination connector.
ExecutionDetails lastRunExecutionDetails
Describes the details of the most recent flow run.
TriggerConfig triggerConfig
The trigger settings that determine how and when the flow runs.
List<E> tasks
A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
Date createdAt
Specifies when the flow was created.
Date lastUpdatedAt
Specifies when the flow was last updated.
String createdBy
The ARN of the user who created the flow.
String lastUpdatedBy
Specifies the user name of the account that performed the most recent update.
Map<K,V> tags
The tags used to organize, track, or control access for your flow.
MetadataCatalogConfig metadataCatalogConfig
Specifies the configuration that Amazon AppFlow uses when it catalogs the data that's transferred by the associated flow. When Amazon AppFlow catalogs the data from a flow, it stores metadata in a data catalog.
List<E> lastRunMetadataCatalogDetails
Describes the metadata catalog, metadata table, and data partitions that Amazon AppFlow used for the associated flow run.
Long schemaVersion
The version number of your data schema. Amazon AppFlow assigns this version number. The version number increases by one when you change any of the following settings in your flow configuration:
Source-to-destination field mappings
Field data types
Partition keys
RedshiftDestinationProperties redshift
The properties required to query Amazon Redshift.
S3DestinationProperties s3
The properties required to query Amazon S3.
SalesforceDestinationProperties salesforce
The properties required to query Salesforce.
SnowflakeDestinationProperties snowflake
The properties required to query Snowflake.
EventBridgeDestinationProperties eventBridge
The properties required to query Amazon EventBridge.
LookoutMetricsDestinationProperties lookoutMetrics
The properties required to query Amazon Lookout for Metrics.
UpsolverDestinationProperties upsolver
The properties required to query Upsolver.
HoneycodeDestinationProperties honeycode
The properties required to query Amazon Honeycode.
CustomerProfilesDestinationProperties customerProfiles
The properties required to query Amazon Connect Customer Profiles.
ZendeskDestinationProperties zendesk
The properties required to query Zendesk.
MarketoDestinationProperties marketo
The properties required to query Marketo.
CustomConnectorDestinationProperties customConnector
The properties that are required to query the custom Connector.
SAPODataDestinationProperties sAPOData
The properties required to query SAPOData.
Boolean isCreatable
Specifies if the destination field can be created by the current user.
Boolean isNullable
Specifies if the destination field can have a null value.
Boolean isUpsertable
Specifies if the flow run can either insert new rows in the destination field if they do not already exist, or update them if they do.
Boolean isUpdatable
Specifies whether the field can be updated during an UPDATE or UPSERT write operation.
Boolean isDefaultedOnCreate
Specifies whether the field can use the default value during a Create operation.
List<E> supportedWriteOperations
A list of supported write operations. For each write operation listed, this field can be used in
idFieldNames when that write operation is present as a destination option.
String connectorType
The type of connector, such as Salesforce, Amplitude, and so on.
String apiVersion
The API version that the destination connector uses.
String connectorProfileName
The name of the connector profile. This name must be unique for each connector profile in the Amazon Web Services account.
DestinationConnectorProperties destinationConnectorProperties
This stores the information that is required to query a particular connector.
String apiToken
The API tokens used by Dynatrace API to authenticate various API calls.
String instanceUrl
The location of the Dynatrace resource.
String object
The object specified in the Dynatrace flow source.
Boolean failOnFirstDestinationError
Specifies if the flow should fail after the first instance of a failure when attempting to place data in the destination.
String bucketPrefix
Specifies the Amazon S3 bucket prefix.
String bucketName
Specifies the name of the Amazon S3 bucket.
String object
The object specified in the Amazon EventBridge flow destination.
ErrorHandlingConfig errorHandlingConfig
String mostRecentExecutionMessage
Describes the details of the most recent flow run.
Date mostRecentExecutionTime
Specifies the time of the most recent flow run.
String mostRecentExecutionStatus
Specifies the status of the most recent flow run.
String executionId
Specifies the identifier of the given flow run.
String executionStatus
Specifies the flow run status and whether it is in progress, has completed successfully, or has failed.
ExecutionResult executionResult
Describes the result of the given flow run.
Date startedAt
Specifies the start time of the flow run.
Date lastUpdatedAt
Specifies the time of the most recent update.
Date dataPullStartTime
The timestamp that determines the first new or updated record to be transferred in the flow run.
Date dataPullEndTime
The timestamp that indicates the last new or updated record to be transferred in the flow run.
List<E> metadataCatalogDetails
Describes the metadata catalog, metadata table, and data partitions that Amazon AppFlow used for the associated flow run.
ErrorInfo errorInfo
Provides any error message information related to the flow run.
Long bytesProcessed
The total number of bytes processed by the flow run.
Long bytesWritten
The total number of bytes written as a result of the flow run.
Long recordsProcessed
The number of records processed in the flow run.
Long numParallelProcesses
The number of processes that Amazon AppFlow ran at the same time when it retrieved your data.
Long maxPageSize
The maximum number of records that Amazon AppFlow receives in each page of the response from your SAP application.
String fieldType
The type of field, such as string, integer, date, and so on.
List<E> filterOperators
The list of operators supported by a field.
List<E> supportedValues
The list of values that a field can contain. For example, a Boolean fieldType can have two values:
"true" and "false".
String valueRegexPattern
The regular expression pattern for the field name.
String supportedDateFormat
The date format that the field supports.
Range fieldValueRange
The range of values this field can hold.
Range fieldLengthRange
This is the allowable length range for this field's value.
String flowArn
The flow's Amazon Resource Name (ARN).
String description
A user-entered description of the flow.
String flowName
The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
String flowStatus
Indicates the current status of the flow.
String sourceConnectorType
Specifies the source connector type, such as Salesforce, Amazon S3, Amplitude, and so on.
String sourceConnectorLabel
The label of the source connector in the flow.
String destinationConnectorType
Specifies the destination connector type, such as Salesforce, Amazon S3, Amplitude, and so on.
String destinationConnectorLabel
The label of the destination connector in the flow.
String triggerType
Specifies the type of flow trigger. This can be OnDemand, Scheduled, or
Event.
Date createdAt
Specifies when the flow was created.
Date lastUpdatedAt
Specifies when the flow was last updated.
String createdBy
The ARN of the user who created the flow.
String lastUpdatedBy
Specifies the account user name that most recently updated the flow.
Map<K,V> tags
The tags used to organize, track, or control access for your flow.
ExecutionDetails lastRunExecutionDetails
Describes the details of the most recent flow run.
String roleArn
The Amazon Resource Name (ARN) of an IAM role that grants Amazon AppFlow the permissions it needs to create Data Catalog tables, databases, and partitions.
For an example IAM policy that has the required permissions, see Identity-based policy examples for Amazon AppFlow.
String databaseName
The name of the Data Catalog database that stores the metadata tables that Amazon AppFlow creates in your Amazon Web Services account. These tables contain metadata for the data that's transferred by the flow that you configure with this parameter.
When you configure a new flow with this parameter, you must specify an existing database.
String tablePrefix
A naming prefix for each Data Catalog table that Amazon AppFlow creates for the flow that you configure with this setting. Amazon AppFlow adds the prefix to the beginning of the each table name.
String clientId
The identifier for the desired client.
String clientSecret
The client secret used by the OAuth client to authenticate to the authorization server.
String accessToken
The credentials used to access protected Google Analytics resources.
String refreshToken
The credentials used to acquire new access tokens. This is required only for OAuth2 access tokens, and is not required for OAuth1 access tokens.
ConnectorOAuthRequest oAuthRequest
The OAuth requirement needed to request security tokens from the connector endpoint.
String object
The object specified in the Google Analytics flow source.
String accessToken
The credentials used to access protected Amazon Honeycode resources.
String refreshToken
The credentials used to acquire new access tokens.
ConnectorOAuthRequest oAuthRequest
String object
The object specified in the Amazon Honeycode flow destination.
ErrorHandlingConfig errorHandlingConfig
String datetimeTypeFieldName
A field that specifies the date time or timestamp field as the criteria to use when importing incremental records from the source.
String instanceUrl
The location of the Infor Nexus resource.
String object
The object specified in the Infor Nexus flow source.
String lambdaArn
Lambda ARN of the connector being registered.
String connectorProfileName
The name of the connector profile. The name is unique for each ConnectorProfile in the Amazon Web
Services account, and is used to query the downstream connector.
String connectorType
The type of connector, such as Salesforce, Amplitude, and so on.
String entitiesPath
This optional parameter is specific to connector implementation. Some connectors support multiple levels or
categories of entities. You can find out the list of roots for such providers by sending a request without the
entitiesPath parameter. If the connector supports entities at different roots, this initial request
returns the list of roots. Otherwise, this request returns all entities supported by the provider.
String apiVersion
The version of the API that's used by the connector.
Integer maxResults
The maximum number of items that the operation returns in the response.
String nextToken
A token that was provided by your prior ListConnectorEntities operation if the response was too big
for the page size. You specify this token to get the next page of results in paginated response.
Map<K,V> connectorEntityMap
The response of ListConnectorEntities lists entities grouped by category. This map's key represents
the group name, and its value contains the list of entities belonging to that group.
String nextToken
A token that you specify in your next ListConnectorEntities operation to get the next page of
results in paginated response. The ListConnectorEntities operation provides this token if the
response is too big for the page size.
String resourceArn
The Amazon Resource Name (ARN) of the specified flow.
String clientId
The identifier for the desired client.
String clientSecret
The client secret used by the OAuth client to authenticate to the authorization server.
String accessToken
The credentials used to access protected Marketo resources.
ConnectorOAuthRequest oAuthRequest
The OAuth requirement needed to request security tokens from the connector endpoint.
String instanceUrl
The location of the Marketo resource.
String object
The object specified in the Marketo flow destination.
ErrorHandlingConfig errorHandlingConfig
String object
The object specified in the Marketo flow source.
GlueDataCatalogConfig glueDataCatalog
Specifies the configuration that Amazon AppFlow uses when it catalogs your data with the Glue Data Catalog.
String catalogType
The type of metadata catalog that Amazon AppFlow used for the associated flow run. This parameter returns the following value:
The metadata catalog is provided by the Glue Data Catalog. Glue includes the Glue Data Catalog as a component.
String tableName
The name of the table that stores the metadata for the associated flow run. The table stores metadata that represents the data that the flow transferred. Amazon AppFlow stores the table in the metadata catalog.
RegistrationOutput tableRegistrationOutput
Describes the status of the attempt from Amazon AppFlow to register the metadata table with the metadata catalog. Amazon AppFlow creates or updates this table for the associated flow run.
RegistrationOutput partitionRegistrationOutput
Describes the status of the attempt from Amazon AppFlow to register the data partitions with the metadata catalog. The data partitions organize the flow output into a hierarchical path, such as a folder path in an S3 bucket. Amazon AppFlow creates the partitions (if they don't already exist) based on your flow configuration.
String clientId
The identifier for the desired client.
String clientSecret
The client secret used by the OAuth client to authenticate to the authorization server.
String accessToken
The access token used to access the connector on your behalf.
String refreshToken
The refresh token used to refresh an expired access token.
ConnectorOAuthRequest oAuthRequest
String key
The key of the custom parameter required for OAuth 2.0 authentication.
Boolean isRequired
Indicates whether the custom parameter for OAuth 2.0 authentication is required.
String label
The label of the custom parameter used for OAuth 2.0 authentication.
String description
A description about the custom parameter used for OAuth 2.0 authentication.
Boolean isSensitiveField
Indicates whether this authentication custom parameter is a sensitive field.
List<E> connectorSuppliedValues
Contains default values for this authentication parameter that are supplied by the connector.
String type
Indicates whether custom parameter is used with TokenUrl or AuthUrl.
List<E> oauthScopes
OAuth 2.0 scopes that the connector supports.
List<E> tokenUrls
Token URLs that can be used for OAuth 2.0 authentication.
List<E> authCodeUrls
Auth code URLs that can be used for OAuth 2.0 authentication.
List<E> oauth2GrantTypesSupported
OAuth 2.0 grant types supported by the connector.
List<E> oauth2CustomProperties
List of custom parameters required for OAuth 2.0 authentication.
String tokenUrl
The token URL required for OAuth 2.0 authentication.
String oAuth2GrantType
The OAuth 2.0 grant type used by connector for OAuth 2.0 authentication.
Map<K,V> tokenUrlCustomProperties
Associates your token URL with a map of properties that you define. Use this parameter to provide any additional details that the connector requires to authenticate your request.
String clientId
The identifier for the desired client.
String clientSecret
The client secret used by the OAuth client to authenticate to the authorization server.
String accessToken
The access token used to access protected SAPOData resources.
String refreshToken
The refresh token used to refresh expired access token.
ConnectorOAuthRequest oAuthRequest
The OAuth requirement needed to request security tokens from the connector endpoint.
String tokenUrl
The token url required to fetch access/refresh tokens using authorization code and also to refresh expired access token using refresh token.
String authCodeUrl
The authorization code url required to redirect to SAP Login Page to fetch authorization code for OAuth type authentication.
List<E> oAuthScopes
The OAuth scopes required for OAuth type authentication.
String accessToken
The credentials used to access protected Salesforce Pardot resources.
String refreshToken
The credentials used to acquire new access tokens.
ConnectorOAuthRequest oAuthRequest
String clientCredentialsArn
The secret manager ARN, which contains the client ID and client secret of the connected app.
String instanceUrl
The location of the Salesforce Pardot resource.
Boolean isSandboxEnvironment
Indicates whether the connector profile applies to a sandbox or production environment.
String businessUnitId
The business unit id of Salesforce Pardot instance.
String object
The object specified in the Salesforce Pardot flow source.
String prefixType
Determines the format of the prefix, and whether it applies to the file name, file path, or both.
String prefixFormat
Determines the level of granularity for the date and time that's included in the prefix.
List<E> pathPrefixHierarchy
Specifies whether the destination file path includes either or both of the following elements:
The ID that Amazon AppFlow assigns to the flow run.
The version number of your data schema. Amazon AppFlow assigns this version number. The version number increases by one when you change any of the following settings in your flow configuration:
Source-to-destination field mappings
Field data types
Partition keys
String databaseUrl
The JDBC URL of the Amazon Redshift cluster.
String bucketName
A name for the associated Amazon S3 bucket.
String bucketPrefix
The object key for the destination bucket in which Amazon AppFlow places the files.
String roleArn
The Amazon Resource Name (ARN) of IAM role that grants Amazon Redshift read-only access to Amazon S3. For more information, and for the polices that you attach to this role, see Allow Amazon Redshift to access your Amazon AppFlow data in Amazon S3.
String dataApiRoleArn
The Amazon Resource Name (ARN) of an IAM role that permits Amazon AppFlow to access your Amazon Redshift database through the Data API. For more information, and for the polices that you attach to this role, see Allow Amazon AppFlow to access Amazon Redshift databases with the Data API.
Boolean isRedshiftServerless
Indicates whether the connector profile defines a connection to an Amazon Redshift Serverless data warehouse.
String clusterIdentifier
The unique ID that's assigned to an Amazon Redshift cluster.
String workgroupName
The name of an Amazon Redshift workgroup.
String databaseName
The name of an Amazon Redshift database.
String object
The object specified in the Amazon Redshift flow destination.
String intermediateBucketName
The intermediate bucket that Amazon AppFlow uses when moving data into Amazon Redshift.
String bucketPrefix
The object key for the bucket in which Amazon AppFlow places the destination files.
ErrorHandlingConfig errorHandlingConfig
The settings that determine how Amazon AppFlow handles an error when placing data in the Amazon Redshift
destination. For example, this setting would determine if the flow should fail after one insertion error, or
continue and attempt to insert every record regardless of the initial failure. ErrorHandlingConfig
is a part of the destination connector details.
String connectorLabel
The name of the connector. The name is unique for each ConnectorRegistration in your Amazon Web
Services account.
String description
A description about the connector that's being registered.
String connectorProvisioningType
The provisioning type of the connector. Currently the only supported value is LAMBDA.
ConnectorProvisioningConfig connectorProvisioningConfig
The provisioning type of the connector. Currently the only supported value is LAMBDA.
String clientToken
The clientToken parameter is an idempotency token. It ensures that your
RegisterConnector request completes only once. You choose the value to pass. For example, if you
don't receive a response from your request, you can safely retry the request with the same
clientToken parameter value.
If you omit a clientToken value, the Amazon Web Services SDK that you are using inserts a value for
you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own
value for other use cases.
If you specify input parameters that differ from your first request, an error occurs. If you use a different
value for clientToken, Amazon AppFlow considers it a new call to RegisterConnector. The
token is active for 8 hours.
String connectorArn
The ARN of the connector being registered.
String message
Explains the status of the registration attempt from Amazon AppFlow. If the attempt fails, the message explains why.
String result
Indicates the number of resources that Amazon AppFlow created or updated. Possible resources include metadata tables and data partitions.
String status
Indicates the status of the registration attempt from Amazon AppFlow.
String connectorProfileName
The name of the connector profile that you want to reset cached metadata for.
You can omit this parameter if you're resetting the cache for any of the following connectors: Amazon Connect, Amazon EventBridge, Amazon Lookout for Metrics, Amazon S3, or Upsolver. If you're resetting the cache for any other connector, you must include this parameter in your request.
String connectorType
The type of connector to reset cached metadata for.
You must include this parameter in your request if you're resetting the cache for any of the following connectors: Amazon Connect, Amazon EventBridge, Amazon Lookout for Metrics, Amazon S3, or Upsolver. If you're resetting the cache for any other connector, you can omit this parameter from your request.
String connectorEntityName
Use this parameter if you want to reset cached metadata about the details for an individual entity.
If you don't include this parameter in your request, Amazon AppFlow only resets cached metadata about entity names, not entity details.
String entitiesPath
Use this parameter only if you’re resetting the cached metadata about a nested entity. Only some connectors support nested entities. A nested entity is one that has another entity as a parent. To use this parameter, specify the name of the parent entity.
To look up the parent-child relationship of entities, you can send a ListConnectorEntities request that omits the entitiesPath parameter. Amazon AppFlow will return a list of top-level entities. For each one, it indicates whether the entity has nested entities. Then, in a subsequent ListConnectorEntities request, you can specify a parent entity name for the entitiesPath parameter. Amazon AppFlow will return a list of the child entities for that parent.
String apiVersion
The API version that you specified in the connector profile that you’re resetting cached metadata for. You must use this parameter only if the connector supports multiple API versions or if the connector type is CustomConnector.
To look up how many versions a connector supports, use the DescribeConnectors action. In the response, find the value that Amazon AppFlow returns for the connectorVersion parameter.
To look up the connector type, use the DescribeConnectorProfiles action. In the response, find the value that Amazon AppFlow returns for the connectorType parameter.
To look up the API version that you specified in a connector profile, use the DescribeConnectorProfiles action.
String bucketName
The Amazon S3 bucket name in which Amazon AppFlow places the transferred data.
String bucketPrefix
The object key for the destination bucket in which Amazon AppFlow places the files.
S3OutputFormatConfig s3OutputFormatConfig
String s3InputFileType
The file type that Amazon AppFlow gets from your Amazon S3 bucket.
String fileType
Indicates the file type that Amazon AppFlow places in the Amazon S3 bucket.
PrefixConfig prefixConfig
Determines the prefix that Amazon AppFlow applies to the folder name in the Amazon S3 bucket. You can name folders according to the flow frequency and date.
AggregationConfig aggregationConfig
Boolean preserveSourceDataTyping
If your file output format is Parquet, use this parameter to set whether Amazon AppFlow preserves the data types in your source data when it writes the output to Amazon S3.
true: Amazon AppFlow preserves the data types when it writes to Amazon S3. For example, an integer
or 1 in your source data is still an integer in your output.
false: Amazon AppFlow converts all of the source data into strings when it writes to Amazon S3. For
example, an integer of 1 in your source data becomes the string "1" in the output.
String bucketName
The Amazon S3 bucket name where the source files are stored.
String bucketPrefix
The object key for the Amazon S3 bucket in which the source files are stored.
S3InputFormatConfig s3InputFormatConfig
String accessToken
The credentials used to access protected Salesforce resources.
String refreshToken
The credentials used to acquire new access tokens.
ConnectorOAuthRequest oAuthRequest
The OAuth requirement needed to request security tokens from the connector endpoint.
String clientCredentialsArn
The secret manager ARN, which contains the client ID and client secret of the connected app.
String oAuth2GrantType
Specifies the OAuth 2.0 grant type that Amazon AppFlow uses when it requests an access token from Salesforce. Amazon AppFlow requires an access token each time it attempts to access your Salesforce records.
You can specify one of the following values:
Amazon AppFlow passes an authorization code when it requests the access token from Salesforce. Amazon AppFlow receives the authorization code from Salesforce after you log in to your Salesforce account and authorize Amazon AppFlow to access your records.
Amazon AppFlow passes client credentials (a client ID and client secret) when it requests the access token from Salesforce. You provide these credentials to Amazon AppFlow when you define the connection to your Salesforce account.
Amazon AppFlow passes a JSON web token (JWT) when it requests the access token from Salesforce. You provide the JWT to Amazon AppFlow when you define the connection to your Salesforce account. When you use this grant type, you don't need to log in to your Salesforce account to authorize Amazon AppFlow to access your records.
String jwtToken
A JSON web token (JWT) that authorizes Amazon AppFlow to access your Salesforce records.
String instanceUrl
The location of the Salesforce resource.
Boolean isSandboxEnvironment
Indicates whether the connector profile applies to a sandbox or production environment.
Boolean usePrivateLinkForMetadataAndAuthorization
If the connection mode for the connector profile is private, this parameter sets whether Amazon AppFlow uses the private network to send metadata and authorization calls to Salesforce. Amazon AppFlow sends private calls through Amazon Web Services PrivateLink. These calls travel through Amazon Web Services infrastructure without being exposed to the public internet.
Set either of the following values:
Amazon AppFlow sends all calls to Salesforce over the private network.
These private calls are:
Calls to get metadata about your Salesforce records. This metadata describes your Salesforce objects and their fields.
Calls to get or refresh access tokens that allow Amazon AppFlow to access your Salesforce records.
Calls to transfer your Salesforce records as part of a flow run.
The default value. Amazon AppFlow sends some calls to Salesforce privately and other calls over the public internet.
The public calls are:
Calls to get metadata about your Salesforce records.
Calls to get or refresh access tokens.
The private calls are:
Calls to transfer your Salesforce records as part of a flow run.
String object
The object specified in the Salesforce flow destination.
List<E> idFieldNames
The name of the field that Amazon AppFlow uses as an ID when performing a write operation such as update or delete.
ErrorHandlingConfig errorHandlingConfig
The settings that determine how Amazon AppFlow handles an error when placing data in the Salesforce destination.
For example, this setting would determine if the flow should fail after one insertion error, or continue and
attempt to insert every record regardless of the initial failure. ErrorHandlingConfig is a part of
the destination connector details.
String writeOperationType
This specifies the type of write operation to be performed in Salesforce. When the value is UPSERT,
then idFieldNames is required.
String dataTransferApi
Specifies which Salesforce API is used by Amazon AppFlow when your flow transfers data to Salesforce.
The default. Amazon AppFlow selects which API to use based on the number of records that your flow transfers to Salesforce. If your flow transfers fewer than 1,000 records, Amazon AppFlow uses Salesforce REST API. If your flow transfers 1,000 records or more, Amazon AppFlow uses Salesforce Bulk API 2.0.
Each of these Salesforce APIs structures data differently. If Amazon AppFlow selects the API automatically, be aware that, for recurring flows, the data output might vary from one flow run to the next. For example, if a flow runs daily, it might use REST API on one day to transfer 900 records, and it might use Bulk API 2.0 on the next day to transfer 1,100 records. For each of these flow runs, the respective Salesforce API formats the data differently. Some of the differences include how dates are formatted and null values are represented. Also, Bulk API 2.0 doesn't transfer Salesforce compound fields.
By choosing this option, you optimize flow performance for both small and large data transfers, but the tradeoff is inconsistent formatting in the output.
Amazon AppFlow uses only Salesforce Bulk API 2.0. This API runs asynchronous data transfers, and it's optimal for large sets of data. By choosing this option, you ensure that your flow writes consistent output, but you optimize performance only for large data transfers.
Note that Bulk API 2.0 does not transfer Salesforce compound fields.
Amazon AppFlow uses only Salesforce REST API. By choosing this option, you ensure that your flow writes consistent output, but you decrease performance for large data transfers that are better suited for Bulk API 2.0. In some cases, if your flow attempts to transfer a vary large set of data, it might fail with a timed out error.
List<E> oAuthScopes
The desired authorization scope for the Salesforce account.
List<E> dataTransferApis
The Salesforce APIs that you can have Amazon AppFlow use when your flows transfers data to or from Salesforce.
List<E> oauth2GrantTypesSupported
The OAuth 2.0 grant types that Amazon AppFlow can use when it requests an access token from Salesforce. Amazon AppFlow requires an access token each time it attempts to access your Salesforce records.
Amazon AppFlow passes an authorization code when it requests the access token from Salesforce. Amazon AppFlow receives the authorization code from Salesforce after you log in to your Salesforce account and authorize Amazon AppFlow to access your records.
Amazon AppFlow passes client credentials (a client ID and client secret) when it requests the access token from Salesforce. You provide these credentials to Amazon AppFlow when you define the connection to your Salesforce account.
Amazon AppFlow passes a JSON web token (JWT) when it requests the access token from Salesforce. You provide the JWT to Amazon AppFlow when you define the connection to your Salesforce account. When you use this grant type, you don't need to log in to your Salesforce account to authorize Amazon AppFlow to access your records.
String object
The object specified in the Salesforce flow source.
Boolean enableDynamicFieldUpdate
The flag that enables dynamic fetching of new (recently added) fields in the Salesforce objects while running a flow.
Boolean includeDeletedRecords
Indicates whether Amazon AppFlow includes deleted files in the flow run.
String dataTransferApi
Specifies which Salesforce API is used by Amazon AppFlow when your flow transfers data from Salesforce.
The default. Amazon AppFlow selects which API to use based on the number of records that your flow transfers from Salesforce. If your flow transfers fewer than 1,000,000 records, Amazon AppFlow uses Salesforce REST API. If your flow transfers 1,000,000 records or more, Amazon AppFlow uses Salesforce Bulk API 2.0.
Each of these Salesforce APIs structures data differently. If Amazon AppFlow selects the API automatically, be aware that, for recurring flows, the data output might vary from one flow run to the next. For example, if a flow runs daily, it might use REST API on one day to transfer 900,000 records, and it might use Bulk API 2.0 on the next day to transfer 1,100,000 records. For each of these flow runs, the respective Salesforce API formats the data differently. Some of the differences include how dates are formatted and null values are represented. Also, Bulk API 2.0 doesn't transfer Salesforce compound fields.
By choosing this option, you optimize flow performance for both small and large data transfers, but the tradeoff is inconsistent formatting in the output.
Amazon AppFlow uses only Salesforce Bulk API 2.0. This API runs asynchronous data transfers, and it's optimal for large sets of data. By choosing this option, you ensure that your flow writes consistent output, but you optimize performance only for large data transfers.
Note that Bulk API 2.0 does not transfer Salesforce compound fields.
Amazon AppFlow uses only Salesforce REST API. By choosing this option, you ensure that your flow writes consistent output, but you decrease performance for large data transfers that are better suited for Bulk API 2.0. In some cases, if your flow attempts to transfer a vary large set of data, it might fail wituh a timed out error.
BasicAuthCredentials basicAuthCredentials
The SAPOData basic authentication credentials.
OAuthCredentials oAuthCredentials
The SAPOData OAuth type authentication credentials.
String applicationHostUrl
The location of the SAPOData resource.
String applicationServicePath
The application path to catalog service.
Integer portNumber
The port number of the SAPOData instance.
String clientNumber
The client number for the client creating the connection.
String logonLanguage
The logon language of SAPOData instance.
String privateLinkServiceName
The SAPOData Private Link service name to be used for private data transfers.
OAuthProperties oAuthProperties
The SAPOData OAuth properties required for OAuth type authentication.
Boolean disableSSO
If you set this parameter to true, Amazon AppFlow bypasses the single sign-on (SSO) settings in your
SAP account when it accesses your SAP OData instance.
Whether you need this option depends on the types of credentials that you applied to your SAP OData connection profile. If your profile uses basic authentication credentials, SAP SSO can prevent Amazon AppFlow from connecting to your account with your username and password. In this case, bypassing SSO makes it possible for Amazon AppFlow to connect successfully. However, if your profile uses OAuth credentials, this parameter has no affect.
String objectPath
The object path specified in the SAPOData flow destination.
SuccessResponseHandlingConfig successResponseHandlingConfig
Determines how Amazon AppFlow handles the success response that it gets from the connector after placing data.
For example, this setting would determine where to write the response from a destination connector upon a successful insert operation.
List<E> idFieldNames
ErrorHandlingConfig errorHandlingConfig
String writeOperationType
Integer maxPageSize
The maximum number of records that Amazon AppFlow receives in each page of the response from your SAP application. For transfers of OData records, the maximum page size is 3,000. For transfers of data that comes from an ODP provider, the maximum page size is 10,000.
Integer maxParallelism
The maximum number of processes that Amazon AppFlow runs at the same time when it retrieves your data from your SAP application.
String objectPath
The object path specified in the SAPOData flow source.
SAPODataParallelismConfig parallelismConfig
Sets the number of concurrent processes that transfers OData records from your SAP instance.
SAPODataPaginationConfig paginationConfig
Sets the page size for each concurrent process that transfers OData records from your SAP instance.
String scheduleExpression
The scheduling expression that determines the rate at which the schedule will run, for example
rate(5minutes).
String dataPullMode
Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run.
Date scheduleStartTime
The time at which the scheduled flow starts. The time is formatted as a timestamp that follows the ISO 8601
standard, such as 2022-04-26T13:00:00-07:00.
Date scheduleEndTime
The time at which the scheduled flow ends. The time is formatted as a timestamp that follows the ISO 8601
standard, such as 2022-04-27T13:00:00-07:00.
String timezone
Specifies the time zone used when referring to the dates and times of a scheduled flow, such as
America/New_York. This time zone is only a descriptive label. It doesn't affect how Amazon AppFlow
interprets the timestamps that you specify to schedule the flow.
If you want to schedule a flow by using times in a particular time zone, indicate the time zone as a UTC offset
in your timestamps. For example, the UTC offsets for the America/New_York timezone are
-04:00 EDT and -05:00 EST.
Long scheduleOffset
Specifies the optional offset that is added to the time interval for a schedule-triggered flow.
Date firstExecutionFrom
Specifies the date range for the records to import from the connector in the first flow run.
Integer flowErrorDeactivationThreshold
Defines how many times a scheduled flow fails consecutively before Amazon AppFlow deactivates it.
String username
The name of the user.
String password
The password that corresponds to the user name.
OAuth2Credentials oAuth2Credentials
The OAuth 2.0 credentials required to authenticate the user.
String instanceUrl
The location of the ServiceNow resource.
String object
The object specified in the ServiceNow flow source.
String apiKey
A unique alphanumeric identifier used to authenticate a user, developer, or calling program to your API.
String object
The object specified in the Singular flow source.
String clientId
The identifier for the client.
String clientSecret
The client secret used by the OAuth client to authenticate to the authorization server.
String accessToken
The credentials used to access protected Slack resources.
ConnectorOAuthRequest oAuthRequest
The OAuth requirement needed to request security tokens from the connector endpoint.
String instanceUrl
The location of the Slack resource.
String object
The object specified in the Slack flow source.
String warehouse
The name of the Snowflake warehouse.
String stage
The name of the Amazon S3 stage that was created while setting up an Amazon S3 stage in the Snowflake account. This is written in the following format: < Database>< Schema><Stage Name>.
String bucketName
The name of the Amazon S3 bucket associated with Snowflake.
String bucketPrefix
The bucket path that refers to the Amazon S3 bucket associated with Snowflake.
String privateLinkServiceName
The Snowflake Private Link service name to be used for private data transfers.
String accountName
The name of the account.
String region
The Amazon Web Services Region of the Snowflake account.
String object
The object specified in the Snowflake flow destination.
String intermediateBucketName
The intermediate bucket that Amazon AppFlow uses when moving data into Snowflake.
String bucketPrefix
The object key for the destination bucket in which Amazon AppFlow places the files.
ErrorHandlingConfig errorHandlingConfig
The settings that determine how Amazon AppFlow handles an error when placing data in the Snowflake destination.
For example, this setting would determine if the flow should fail after one insertion error, or continue and
attempt to insert every record regardless of the initial failure. ErrorHandlingConfig is a part of
the destination connector details.
AmplitudeSourceProperties amplitude
Specifies the information that is required for querying Amplitude.
DatadogSourceProperties datadog
Specifies the information that is required for querying Datadog.
DynatraceSourceProperties dynatrace
Specifies the information that is required for querying Dynatrace.
GoogleAnalyticsSourceProperties googleAnalytics
Specifies the information that is required for querying Google Analytics.
InforNexusSourceProperties inforNexus
Specifies the information that is required for querying Infor Nexus.
MarketoSourceProperties marketo
Specifies the information that is required for querying Marketo.
S3SourceProperties s3
Specifies the information that is required for querying Amazon S3.
SalesforceSourceProperties salesforce
Specifies the information that is required for querying Salesforce.
ServiceNowSourceProperties serviceNow
Specifies the information that is required for querying ServiceNow.
SingularSourceProperties singular
Specifies the information that is required for querying Singular.
SlackSourceProperties slack
Specifies the information that is required for querying Slack.
TrendmicroSourceProperties trendmicro
Specifies the information that is required for querying Trend Micro.
VeevaSourceProperties veeva
Specifies the information that is required for querying Veeva.
ZendeskSourceProperties zendesk
Specifies the information that is required for querying Zendesk.
SAPODataSourceProperties sAPOData
CustomConnectorSourceProperties customConnector
PardotSourceProperties pardot
Specifies the information that is required for querying Salesforce Pardot.
Boolean isRetrievable
Indicates whether the field can be returned in a search result.
Boolean isQueryable
Indicates if the field can be queried.
Boolean isTimestampFieldForIncrementalQueries
Indicates if this timestamp field can be used for incremental queries.
String connectorType
The type of connector, such as Salesforce, Amplitude, and so on.
String apiVersion
The API version of the connector when it's used as a source in the flow.
String connectorProfileName
The name of the connector profile. This name must be unique for each connector profile in the Amazon Web Services account.
SourceConnectorProperties sourceConnectorProperties
Specifies the information that is required to query a particular source connector.
IncrementalPullConfig incrementalPullConfig
Defines the configuration for a scheduled incremental data pull. If a valid configuration is provided, the fields specified in the configuration are used when querying for the incremental data pull.
String flowName
The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
String clientToken
The clientToken parameter is an idempotency token. It ensures that your StartFlow
request completes only once. You choose the value to pass. For example, if you don't receive a response from your
request, you can safely retry the request with the same clientToken parameter value.
If you omit a clientToken value, the Amazon Web Services SDK that you are using inserts a value for
you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own
value for other use cases.
If you specify input parameters that differ from your first request, an error occurs for flows that run on a
schedule or based on an event. However, the error doesn't occur for flows that run on demand. You set the
conditions that initiate your flow for the triggerConfig parameter.
If you use a different value for clientToken, Amazon AppFlow considers it a new call to
StartFlow. The token is active for 8 hours.
String flowArn
The flow's Amazon Resource Name (ARN).
String flowStatus
Indicates the current status of the flow.
String executionId
Returns the internal execution ID of an on-demand flow when the flow is started. For scheduled or event-triggered flows, this value is null.
String flowName
The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
FieldTypeDetails v1
The initial supported version for fieldType. If this is later changed to a different version, v2
will be introduced.
List<E> sourceFields
The source fields to which a particular task is applied.
ConnectorOperator connectorOperator
The operation to be performed on the provided source fields.
String destinationField
A field in a destination connector, or a field value against which Amazon AppFlow validates a source field.
String taskType
Specifies the particular task implementation that Amazon AppFlow performs.
Map<K,V> taskProperties
A map used to store task-related information. The execution service looks for particular information based on the
TaskType.
String apiSecretKey
The Secret Access Key portion of the credentials.
String object
The object specified in the Trend Micro flow source.
String triggerType
Specifies the type of flow trigger. This can be OnDemand, Scheduled, or
Event.
TriggerProperties triggerProperties
Specifies the configuration details of a schedule-triggered flow as defined by the user. Currently, these
settings only apply to the Scheduled trigger type.
ScheduledTriggerProperties scheduled
Specifies the configuration details of a schedule-triggered flow as defined by the user.
String connectorLabel
The label of the connector. The label is unique for each ConnectorRegistration in your Amazon Web
Services account.
Boolean forceDelete
Indicates whether Amazon AppFlow should unregister the connector, even if it is currently in use in one or more connector profiles. The default value is false.
String connectorProfileName
The name of the connector profile and is unique for each ConnectorProfile in the Amazon Web Services
account.
String connectionMode
Indicates the connection mode and if it is public or private.
ConnectorProfileConfig connectorProfileConfig
Defines the connector-specific profile configuration and credentials.
String clientToken
The clientToken parameter is an idempotency token. It ensures that your
UpdateConnectorProfile request completes only once. You choose the value to pass. For example, if
you don't receive a response from your request, you can safely retry the request with the same
clientToken parameter value.
If you omit a clientToken value, the Amazon Web Services SDK that you are using inserts a value for
you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own
value for other use cases.
If you specify input parameters that differ from your first request, an error occurs. If you use a different
value for clientToken, Amazon AppFlow considers it a new call to UpdateConnectorProfile
. The token is active for 8 hours.
String connectorProfileArn
The Amazon Resource Name (ARN) of the connector profile.
String connectorLabel
The name of the connector. The name is unique for each connector registration in your AWS account.
String description
A description about the update that you're applying to the connector.
ConnectorProvisioningConfig connectorProvisioningConfig
String clientToken
The clientToken parameter is an idempotency token. It ensures that your
UpdateConnectorRegistration request completes only once. You choose the value to pass. For example,
if you don't receive a response from your request, you can safely retry the request with the same
clientToken parameter value.
If you omit a clientToken value, the Amazon Web Services SDK that you are using inserts a value for
you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own
value for other use cases.
If you specify input parameters that differ from your first request, an error occurs. If you use a different
value for clientToken, Amazon AppFlow considers it a new call to
UpdateConnectorRegistration. The token is active for 8 hours.
String connectorArn
The ARN of the connector being updated.
String flowName
The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
String description
A description of the flow.
TriggerConfig triggerConfig
The trigger settings that determine how and when the flow runs.
SourceFlowConfig sourceFlowConfig
List<E> destinationFlowConfigList
The configuration that controls how Amazon AppFlow transfers data to the destination connector.
List<E> tasks
A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
MetadataCatalogConfig metadataCatalogConfig
Specifies the configuration that Amazon AppFlow uses when it catalogs the data that's transferred by the associated flow. When Amazon AppFlow catalogs the data from a flow, it stores metadata in a data catalog.
String clientToken
The clientToken parameter is an idempotency token. It ensures that your UpdateFlow
request completes only once. You choose the value to pass. For example, if you don't receive a response from your
request, you can safely retry the request with the same clientToken parameter value.
If you omit a clientToken value, the Amazon Web Services SDK that you are using inserts a value for
you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own
value for other use cases.
If you specify input parameters that differ from your first request, an error occurs. If you use a different
value for clientToken, Amazon AppFlow considers it a new call to UpdateFlow. The token
is active for 8 hours.
String flowStatus
Indicates the current status of the flow.
String bucketName
The Upsolver Amazon S3 bucket name in which Amazon AppFlow places the transferred data.
String bucketPrefix
The object key for the destination Upsolver Amazon S3 bucket in which Amazon AppFlow places the files.
UpsolverS3OutputFormatConfig s3OutputFormatConfig
The configuration that determines how data is formatted when Upsolver is used as the flow destination.
String fileType
Indicates the file type that Amazon AppFlow places in the Upsolver Amazon S3 bucket.
PrefixConfig prefixConfig
AggregationConfig aggregationConfig
String instanceUrl
The location of the Veeva resource.
String object
The object specified in the Veeva flow source.
String documentType
The document type specified in the Veeva document extract flow.
Boolean includeSourceFiles
Boolean value to include source files in Veeva document extract flow.
Boolean includeRenditions
Boolean value to include file renditions in Veeva document extract flow.
Boolean includeAllVersions
Boolean value to include All Versions of files in Veeva document extract flow.
String clientId
The identifier for the desired client.
String clientSecret
The client secret used by the OAuth client to authenticate to the authorization server.
String accessToken
The credentials used to access protected Zendesk resources.
ConnectorOAuthRequest oAuthRequest
The OAuth requirement needed to request security tokens from the connector endpoint.
String instanceUrl
The location of the Zendesk resource.
String object
The object specified in the Zendesk flow destination.
List<E> idFieldNames
ErrorHandlingConfig errorHandlingConfig
String writeOperationType
String object
The object specified in the Zendesk flow source.
Copyright © 2024. All rights reserved.