ConnectorConfiguration
The configuration settings related to a given connector.
Contents
authenticationConfig
The authentication config required for the connector.
Type: AuthenticationConfig (p. 161) object Required: No
canUseAsDestination
Specifies whether the connector can be used as a destination.
Type: Boolean Required: No canUseAsSource
Specifies whether the connector can be used as a source.
Type: Boolean Required: No connectorArn
The Amazon Resource Name (ARN) for the registered connector.
Type: String
Length Constraints: Maximum length of 512.
Pattern: arn:aws:.*:.*:[0-9]+:.*
Required: No connectorDescription
A description about the connector.
Type: String
Length Constraints: Maximum length of 2048.
Pattern: [\w!@#\-.?,\s]*
Required: No connectorLabel
The label used for registering the connector.
Type: String
Length Constraints: Maximum length of 256.
Pattern: [a-zA-Z0-9][\w!@#.-]+
Contents
Required: No connectorMetadata
Specifies connector-specific metadata such as oAuthScopes, supportedRegions, privateLinkServiceUrl, and so on.
Type: ConnectorMetadata (p. 178) object Required: No
connectorModes
The connection modes that the connector supports.
Type: Array of strings
Length Constraints: Maximum length of 256.
Pattern: \S+
Required: No connectorName
The connector name.
Type: String
Length Constraints: Maximum length of 256.
Pattern: .*
Required: No connectorOwner
The owner who developed the connector.
Type: String
Length Constraints: Maximum length of 256.
Pattern: .*
Required: No
connectorProvisioningConfig
The configuration required for registering the connector.
Type: ConnectorProvisioningConfig (p. 195) object Required: No
connectorProvisioningType
The provisioning type used to register the connector.
Type: String
Valid Values: LAMBDA Required: No
connectorRuntimeSettings
The required connector runtime settings.
Contents
Type: Array of ConnectorRuntimeSetting (p. 196) objects Required: No
connectorType
The connector type.
Type: String
Valid Values: Salesforce | Singular | Slack | Redshift | S3 | Marketo |
Googleanalytics | Zendesk | Servicenow | Datadog | Trendmicro | Snowflake | Dynatrace | Infornexus | Amplitude | Veeva | EventBridge | LookoutMetrics | Upsolver | Honeycode | CustomerProfiles | SAPOData | CustomConnector
Required: No connectorVersion
The connector version.
Type: String
Length Constraints: Maximum length of 256.
Pattern: \S+
Required: No isPrivateLinkEnabled
Specifies if PrivateLink is enabled for that connector.
Type: Boolean Required: No
isPrivateLinkEndpointUrlRequired
Specifies if a PrivateLink endpoint URL is required.
Type: Boolean Required: No logoURL
Logo URL of the connector.
Type: String
Length Constraints: Maximum length of 256.
Pattern: ^(https?|ftp|file)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/
%=~_|]
Required: No registeredAt
The date on which the connector was registered.
Type: Timestamp Required: No
Contents
registeredBy
Information about who registered the connector.
Type: String
Length Constraints: Maximum length of 512.
Pattern: \S+
Required: No supportedApiVersions
A list of API versions that are supported by the connector.
Type: Array of strings
Length Constraints: Maximum length of 256.
Pattern: \S+
Required: No
supportedDestinationConnectors
Lists the connectors that are available for use as destinations.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 100 items.
Valid Values: Salesforce | Singular | Slack | Redshift | S3 | Marketo |
Googleanalytics | Zendesk | Servicenow | Datadog | Trendmicro | Snowflake | Dynatrace | Infornexus | Amplitude | Veeva | EventBridge | LookoutMetrics | Upsolver | Honeycode | CustomerProfiles | SAPOData | CustomConnector
Required: No supportedOperators
A list of operators supported by the connector.
Type: Array of strings
Valid Values: PROJECTION | LESS_THAN | GREATER_THAN | CONTAINS | BETWEEN | LESS_THAN_OR_EQUAL_TO | GREATER_THAN_OR_EQUAL_TO | EQUAL_TO | NOT_EQUAL_TO
| ADDITION | MULTIPLICATION | DIVISION | SUBTRACTION | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NON_NEGATIVE | VALIDATE_NUMERIC | NO_OP
Required: No
supportedSchedulingFrequencies
Specifies the supported flow frequency for that connector.
Type: Array of strings
Valid Values: BYMINUTE | HOURLY | DAILY | WEEKLY | MONTHLY | ONCE Required: No
supportedTriggerTypes
Specifies the supported trigger types for the flow.
See Also
Type: Array of strings
Valid Values: Scheduled | Event | OnDemand Required: No
supportedWriteOperations
A list of write operations supported by the connector.
Type: Array of strings
Valid Values: INSERT | UPSERT | UPDATE | DELETE Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ConnectorDetail
ConnectorDetail
Information about the registered connector.
Contents
applicationType
The application type of the connector.
Type: String
Length Constraints: Maximum length of 512.
Pattern: \S+
Required: No connectorDescription
A description about the registered connector.
Type: String
Length Constraints: Maximum length of 2048.
Pattern: [\w!@#\-.?,\s]*
Required: No connectorLabel
A label used for the connector.
Type: String
Length Constraints: Maximum length of 256.
Pattern: [a-zA-Z0-9][\w!@#.-]+
Required: No connectorModes
The connection mode that the connector supports.
Type: Array of strings
Length Constraints: Maximum length of 256.
Pattern: \S+
Required: No connectorName
The name of the connector.
Type: String
Length Constraints: Maximum length of 256.
Pattern: .*
Contents
Required: No connectorOwner
The owner of the connector.
Type: String
Length Constraints: Maximum length of 256.
Pattern: .*
Required: No
connectorProvisioningType
The provisioning type that the connector uses.
Type: String
Valid Values: LAMBDA Required: No
connectorType
The connector type.
Type: String
Valid Values: Salesforce | Singular | Slack | Redshift | S3 | Marketo |
Googleanalytics | Zendesk | Servicenow | Datadog | Trendmicro | Snowflake | Dynatrace | Infornexus | Amplitude | Veeva | EventBridge | LookoutMetrics | Upsolver | Honeycode | CustomerProfiles | SAPOData | CustomConnector
Required: No connectorVersion
The connector version.
Type: String
Length Constraints: Maximum length of 256.
Pattern: \S+
Required: No registeredAt
The time at which the connector was registered.
Type: Timestamp Required: No registeredBy
The user who registered the connector.
Type: String
Length Constraints: Maximum length of 512.
Pattern: \S+
See Also
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ConnectorEntity
ConnectorEntity
The high-level entity that can be queried in Amazon AppFlow. For example, a Salesforce entity might be an Account or Opportunity, whereas a ServiceNow entity might be an Incident.
Contents
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.
Type: Boolean Required: No label
The label applied to the connector entity.
Type: String
Length Constraints: Maximum length of 128.
Pattern: .*
Required: No name
The name of the connector entity.
Type: String
Length Constraints: Maximum length of 128.
Pattern: \S+
Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ConnectorEntityField
ConnectorEntityField
Describes the data model of a connector field. For example, for an account entity, the fields would be account name, account ID, and so on.
Contents
customProperties
A map that has specific properties related to the ConnectorEntityField.
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern: [\w]+
Value Length Constraints: Maximum length of 2048.
Value Pattern: \S+
Required: No defaultValue
Default value that can be assigned to this field.
Type: String
Length Constraints: Maximum length of 2048.
Pattern: .*
Required: No description
A description of the connector entity field.
Type: String
Length Constraints: Maximum length of 1024.
Pattern: [\s\w/!@#+=.-]*
Required: No destinationProperties
The properties applied to a field when the connector is being used as a destination.
Type: DestinationFieldProperties (p. 213) object Required: No
identifier
The unique identifier of the connector field.
Type: String
Length Constraints: Maximum length of 128.
See Also
Pattern: \S+
Required: Yes isDeprecated
Booelan value that indicates whether this field is deprecated or not.
Type: Boolean Required: No isPrimaryKey
Booelan value that indicates whether this field can be used as a primary key.
Type: Boolean Required: No label
The label applied to a connector entity field.
Type: String
Length Constraints: Maximum length of 128.
Pattern: .*
Required: No parentIdentifier
The parent identifier of the connector field.
Type: String
Length Constraints: Maximum length of 128.
Pattern: \S+
Required: No sourceProperties
The properties that can be applied to a field when the connector is being used as a source.
Type: SourceFieldProperties (p. 317) object Required: No
supportedFieldTypeDetails
Contains details regarding the supported FieldType, including the corresponding filterOperators and supportedValues.
Type: SupportedFieldTypeDetails (p. 321) object Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
See Also
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ConnectorMetadata
ConnectorMetadata
A structure to specify connector-specific metadata such as oAuthScopes, supportedRegions, privateLinkServiceUrl, and so on.
Contents
Amplitude
The connector metadata specific to Amplitude.
Type: AmplitudeMetadata (p. 158) object Required: No
CustomerProfiles
The connector metadata specific to Amazon Connect Customer Profiles.
Type: CustomerProfilesMetadata (p. 206) object Required: No
Datadog
The connector metadata specific to Datadog.
Type: DatadogMetadata (p. 209) object Required: No
Dynatrace
The connector metadata specific to Dynatrace.
Type: DynatraceMetadata (p. 219) object Required: No
EventBridge
The connector metadata specific to Amazon EventBridge.
Type: EventBridgeMetadata (p. 224) object Required: No
GoogleAnalytics
The connector metadata specific to Google Analytics.
Type: GoogleAnalyticsMetadata (p. 237) object Required: No
Honeycode
The connector metadata specific to Amazon Honeycode.
Type: HoneycodeMetadata (p. 242) object Required: No
Contents
InforNexus
The connector metadata specific to Infor Nexus.
Type: InforNexusMetadata (p. 247) object Required: No
Marketo
The connector metadata specific to Marketo.
Type: MarketoMetadata (p. 255) object Required: No
Redshift
The connector metadata specific to Amazon Redshift.
Type: RedshiftMetadata (p. 273) object Required: No
S3
The connector metadata specific to Amazon S3.
Type: S3Metadata (p. 276) object Required: No
Salesforce
The connector metadata specific to Salesforce.
Type: SalesforceMetadata (p. 284) object Required: No
SAPOData
The connector metadata specific to SAPOData.
Type: SAPODataMetadata (p. 291) object Required: No
ServiceNow
The connector metadata specific to ServiceNow.
Type: ServiceNowMetadata (p. 297) object Required: No
Singular
The connector metadata specific to Singular.
Type: SingularMetadata (p. 301) object Required: No
Slack
The connector metadata specific to Slack.
See Also
Type: SlackMetadata (p. 306) object Required: No
Snowflake
The connector metadata specific to Snowflake.
Type: SnowflakeMetadata (p. 313) object Required: No
Trendmicro
The connector metadata specific to Trend Micro.
Type: TrendmicroMetadata (p. 326) object Required: No
Upsolver
The connector metadata specific to Upsolver.
Type: UpsolverMetadata (p. 331) object Required: No
Veeva
The connector metadata specific to Veeva.
Type: VeevaMetadata (p. 335) object Required: No
Zendesk
The connector metadata specific to Zendesk.
Type: ZendeskMetadata (p. 343) object Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ConnectorOAuthRequest
ConnectorOAuthRequest
Used by select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack.
Contents
authCode
The code provided by the connector when it has been authenticated via the connected app.
Type: String
Length Constraints: Maximum length of 512.
Pattern: \S+
Required: No redirectUri
The URL to which the authentication server redirects the browser after authorization has been granted.
Type: String
Length Constraints: Maximum length of 512.
Pattern: \S+
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ConnectorOperator
ConnectorOperator
The operation to be performed on the provided source fields.
Contents
Amplitude
The operation to be performed on the provided Amplitude source fields.
Type: String
Valid Values: BETWEEN Required: No
CustomConnector
Operators supported by the custom connector.
Type: String
Valid Values: PROJECTION | LESS_THAN | GREATER_THAN | CONTAINS | BETWEEN | LESS_THAN_OR_EQUAL_TO | GREATER_THAN_OR_EQUAL_TO | EQUAL_TO | NOT_EQUAL_TO
| ADDITION | MULTIPLICATION | DIVISION | SUBTRACTION | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NON_NEGATIVE | VALIDATE_NUMERIC | NO_OP
Required: No Datadog
The operation to be performed on the provided Datadog source fields.
Type: String
Valid Values: PROJECTION | BETWEEN | EQUAL_TO | ADDITION | MULTIPLICATION
| DIVISION | SUBTRACTION | MASK_ALL | MASK_FIRST_N | MASK_LAST_N
| VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NON_NEGATIVE | VALIDATE_NUMERIC | NO_OP
Required: No Dynatrace
The operation to be performed on the provided Dynatrace source fields.
Type: String
Valid Values: PROJECTION | BETWEEN | EQUAL_TO | ADDITION | MULTIPLICATION
| DIVISION | SUBTRACTION | MASK_ALL | MASK_FIRST_N | MASK_LAST_N
| VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NON_NEGATIVE | VALIDATE_NUMERIC | NO_OP
Required: No GoogleAnalytics
The operation to be performed on the provided Google Analytics source fields.
Type: String
Contents
Valid Values: PROJECTION | BETWEEN Required: No
InforNexus
The operation to be performed on the provided Infor Nexus source fields.
Type: String
Valid Values: PROJECTION | BETWEEN | EQUAL_TO | ADDITION | MULTIPLICATION
| DIVISION | SUBTRACTION | MASK_ALL | MASK_FIRST_N | MASK_LAST_N
| VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NON_NEGATIVE | VALIDATE_NUMERIC | NO_OP
Required: No Marketo
The operation to be performed on the provided Marketo source fields.
Type: String
Valid Values: PROJECTION | LESS_THAN | GREATER_THAN | BETWEEN | ADDITION
| MULTIPLICATION | DIVISION | SUBTRACTION | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NON_NEGATIVE
| VALIDATE_NUMERIC | NO_OP Required: No
S3
The operation to be performed on the provided Amazon S3 source fields.
Type: String
Valid Values: PROJECTION | LESS_THAN | GREATER_THAN | BETWEEN |
LESS_THAN_OR_EQUAL_TO | GREATER_THAN_OR_EQUAL_TO | EQUAL_TO | NOT_EQUAL_TO
| ADDITION | MULTIPLICATION | DIVISION | SUBTRACTION | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NON_NEGATIVE | VALIDATE_NUMERIC | NO_OP
Required: No Salesforce
The operation to be performed on the provided Salesforce source fields.
Type: String
Valid Values: PROJECTION | LESS_THAN | CONTAINS | GREATER_THAN | BETWEEN | LESS_THAN_OR_EQUAL_TO | GREATER_THAN_OR_EQUAL_TO | EQUAL_TO | NOT_EQUAL_TO
| ADDITION | MULTIPLICATION | DIVISION | SUBTRACTION | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NON_NEGATIVE | VALIDATE_NUMERIC | NO_OP
Required: No SAPOData
The operation to be performed on the provided SAPOData source fields.
Type: String
Contents
Valid Values: PROJECTION | LESS_THAN | CONTAINS | GREATER_THAN | BETWEEN | LESS_THAN_OR_EQUAL_TO | GREATER_THAN_OR_EQUAL_TO | EQUAL_TO | NOT_EQUAL_TO
| ADDITION | MULTIPLICATION | DIVISION | SUBTRACTION | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NON_NEGATIVE | VALIDATE_NUMERIC | NO_OP
Required: No ServiceNow
The operation to be performed on the provided ServiceNow source fields.
Type: String
Valid Values: PROJECTION | CONTAINS | LESS_THAN | GREATER_THAN | BETWEEN | LESS_THAN_OR_EQUAL_TO | GREATER_THAN_OR_EQUAL_TO | EQUAL_TO | NOT_EQUAL_TO
| ADDITION | MULTIPLICATION | DIVISION | SUBTRACTION | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NON_NEGATIVE | VALIDATE_NUMERIC | NO_OP
Required: No Singular
The operation to be performed on the provided Singular source fields.
Type: String
Valid Values: PROJECTION | EQUAL_TO | ADDITION | MULTIPLICATION | DIVISION | SUBTRACTION | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NON_NEGATIVE | VALIDATE_NUMERIC | NO_OP Required: No
Slack
The operation to be performed on the provided Slack source fields.
Type: String
Valid Values: PROJECTION | LESS_THAN | GREATER_THAN | BETWEEN |
LESS_THAN_OR_EQUAL_TO | GREATER_THAN_OR_EQUAL_TO | EQUAL_TO | ADDITION
| MULTIPLICATION | DIVISION | SUBTRACTION | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NON_NEGATIVE
| VALIDATE_NUMERIC | NO_OP Required: No
Trendmicro
The operation to be performed on the provided Trend Micro source fields.
Type: String
Valid Values: PROJECTION | EQUAL_TO | ADDITION | MULTIPLICATION | DIVISION | SUBTRACTION | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NON_NEGATIVE | VALIDATE_NUMERIC | NO_OP Required: No
Veeva
The operation to be performed on the provided Veeva source fields.
Type: String
See Also
Valid Values: PROJECTION | LESS_THAN | GREATER_THAN | CONTAINS | BETWEEN | LESS_THAN_OR_EQUAL_TO | GREATER_THAN_OR_EQUAL_TO | EQUAL_TO | NOT_EQUAL_TO
| ADDITION | MULTIPLICATION | DIVISION | SUBTRACTION | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NON_NEGATIVE | VALIDATE_NUMERIC | NO_OP
Required: No Zendesk
The operation to be performed on the provided Zendesk source fields.
Type: String
Valid Values: PROJECTION | GREATER_THAN | ADDITION | MULTIPLICATION | DIVISION
| SUBTRACTION | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NON_NEGATIVE | VALIDATE_NUMERIC | NO_OP
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ConnectorProfile
ConnectorProfile
Describes an instance of a connector. This includes the provided name, credentials ARN, connection-mode, and so on. To keep the API intuitive and extensible, the fields that are common to all types of connector profiles are explicitly specified at the top level. The rest of the connector-specific properties are available via the connectorProfileProperties field.
Contents
connectionMode
Indicates the connection mode and if it is public or private.
Type: String
Valid Values: Public | Private Required: No
connectorLabel
The label for the connector profile being created.
Type: String
Length Constraints: Maximum length of 256.
Pattern: [a-zA-Z0-9][\w!@#.-]+
Required: No connectorProfileArn
The Amazon Resource Name (ARN) of the connector profile.
Type: String
Length Constraints: Maximum length of 512.
Pattern: arn:aws:appflow:.*:[0-9]+:.*
Required: No connectorProfileName
The name of the connector profile. The name is unique for each ConnectorProfile in the AWS account.
Type: String
Length Constraints: Maximum length of 256.
Pattern: [\w/!@#+=.-]+
Required: No
connectorProfileProperties
The connector-specific properties of the profile configuration.
Type: ConnectorProfileProperties (p. 192) object Required: No
See Also
connectorType
The type of connector, such as Salesforce, Amplitude, and so on.
Type: String
Valid Values: Salesforce | Singular | Slack | Redshift | S3 | Marketo |
Googleanalytics | Zendesk | Servicenow | Datadog | Trendmicro | Snowflake | Dynatrace | Infornexus | Amplitude | Veeva | EventBridge | LookoutMetrics | Upsolver | Honeycode | CustomerProfiles | SAPOData | CustomConnector
Required: No createdAt
Specifies when the connector profile was created.
Type: Timestamp Required: No credentialsArn
The Amazon Resource Name (ARN) of the connector profile credentials.
Type: String
Length Constraints: Maximum length of 512.
Pattern: arn:aws:.*:.*:[0-9]+:.*
Required: No lastUpdatedAt
Specifies when the connector profile was last updated.
Type: Timestamp Required: No
privateConnectionProvisioningState
Specifies the private connection provisioning state.
Type: PrivateConnectionProvisioningState (p. 266) object Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3