String aggregationType
Specifies whether Amazon AppFlow aggregates the flow records into a single file, or leave them unaggregated.
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.
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.
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.
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
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 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
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.
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 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.
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 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 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.
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.
CustomConnectorDestinationProperties customConnector
The properties that are required to query the custom Connector.
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.
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.
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 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.
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 source.
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
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.
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 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 the IAM role.
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 connectorArn
The ARN of the connector being registered.
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
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 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 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.
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.
String objectPath
The object path specified in the SAPOData flow source.
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
Specifies the scheduled start time for a schedule-triggered flow.
Date scheduleEndTime
Specifies the scheduled end time for a schedule-triggered flow.
String timezone
Specifies the time zone used when referring to the date and time of a scheduled-triggered flow, such as
America/New_York.
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.
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
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 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 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.
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.
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 © 2022. All rights reserved.