Amazon Appflow 2020-08-23
- Client: Aws\Appflow\AppflowClient
- Service ID: appflow
- Version: 2020-08-23
This page describes the parameters and results for the operations of the Amazon Appflow (2020-08-23), and shows how to use the Aws\Appflow\AppflowClient object to call the described operations. This documentation is specific to the 2020-08-23 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- CreateConnectorProfile ( array $params = [] )
Creates a new connector profile associated with your AWS account.
- CreateFlow ( array $params = [] )
Enables your application to create a new flow using Amazon AppFlow.
- DeleteConnectorProfile ( array $params = [] )
Enables you to delete an existing connector profile.
- DeleteFlow ( array $params = [] )
Enables your application to delete an existing flow.
- DescribeConnectorEntity ( array $params = [] )
Provides details regarding the entity used with the connector, with a description of the data model for each entity.
- DescribeConnectorProfiles ( array $params = [] )
Returns a list of connector-profile details matching the provided connector-profile names and connector-types.
- DescribeConnectors ( array $params = [] )
Describes the connectors vended by Amazon AppFlow for specified connector types.
- DescribeFlow ( array $params = [] )
Provides a description of the specified flow.
- DescribeFlowExecutionRecords ( array $params = [] )
Fetches the execution history of the flow.
- ListConnectorEntities ( array $params = [] )
Returns the list of available connector entities supported by Amazon AppFlow.
- ListFlows ( array $params = [] )
Lists all of the flows associated with your account.
- ListTagsForResource ( array $params = [] )
Retrieves the tags that are associated with a specified flow.
- StartFlow ( array $params = [] )
Activates an existing flow.
- StopFlow ( array $params = [] )
Deactivates the existing flow.
- TagResource ( array $params = [] )
Applies a tag to the specified flow.
- UntagResource ( array $params = [] )
Removes a tag from the specified flow.
- UpdateConnectorProfile ( array $params = [] )
Updates a given connector profile associated with your account.
- UpdateFlow ( array $params = [] )
Updates an existing flow.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Operations
CreateConnectorProfile
$result = $client->createConnectorProfile([/* ... */]); $promise = $client->createConnectorProfileAsync([/* ... */]);
Creates a new connector profile associated with your AWS account. There is a soft quota of 100 connector profiles per AWS account. If you need more connector profiles than this quota allows, you can submit a request to the Amazon AppFlow team through the Amazon AppFlow support channel.
Parameter Syntax
$result = $client->createConnectorProfile([
'connectionMode' => 'Public|Private', // REQUIRED
'connectorProfileConfig' => [ // REQUIRED
'connectorProfileCredentials' => [ // REQUIRED
'Amplitude' => [
'apiKey' => '<string>', // REQUIRED
'secretKey' => '<string>', // REQUIRED
],
'Datadog' => [
'apiKey' => '<string>', // REQUIRED
'applicationKey' => '<string>', // REQUIRED
],
'Dynatrace' => [
'apiToken' => '<string>', // REQUIRED
],
'GoogleAnalytics' => [
'accessToken' => '<string>',
'clientId' => '<string>', // REQUIRED
'clientSecret' => '<string>', // REQUIRED
'oAuthRequest' => [
'authCode' => '<string>',
'redirectUri' => '<string>',
],
'refreshToken' => '<string>',
],
'Honeycode' => [
'accessToken' => '<string>',
'oAuthRequest' => [
'authCode' => '<string>',
'redirectUri' => '<string>',
],
'refreshToken' => '<string>',
],
'InforNexus' => [
'accessKeyId' => '<string>', // REQUIRED
'datakey' => '<string>', // REQUIRED
'secretAccessKey' => '<string>', // REQUIRED
'userId' => '<string>', // REQUIRED
],
'Marketo' => [
'accessToken' => '<string>',
'clientId' => '<string>', // REQUIRED
'clientSecret' => '<string>', // REQUIRED
'oAuthRequest' => [
'authCode' => '<string>',
'redirectUri' => '<string>',
],
],
'Redshift' => [
'password' => '<string>', // REQUIRED
'username' => '<string>', // REQUIRED
],
'Salesforce' => [
'accessToken' => '<string>',
'clientCredentialsArn' => '<string>',
'oAuthRequest' => [
'authCode' => '<string>',
'redirectUri' => '<string>',
],
'refreshToken' => '<string>',
],
'ServiceNow' => [
'password' => '<string>', // REQUIRED
'username' => '<string>', // REQUIRED
],
'Singular' => [
'apiKey' => '<string>', // REQUIRED
],
'Slack' => [
'accessToken' => '<string>',
'clientId' => '<string>', // REQUIRED
'clientSecret' => '<string>', // REQUIRED
'oAuthRequest' => [
'authCode' => '<string>',
'redirectUri' => '<string>',
],
],
'Snowflake' => [
'password' => '<string>', // REQUIRED
'username' => '<string>', // REQUIRED
],
'Trendmicro' => [
'apiSecretKey' => '<string>', // REQUIRED
],
'Veeva' => [
'password' => '<string>', // REQUIRED
'username' => '<string>', // REQUIRED
],
'Zendesk' => [
'accessToken' => '<string>',
'clientId' => '<string>', // REQUIRED
'clientSecret' => '<string>', // REQUIRED
'oAuthRequest' => [
'authCode' => '<string>',
'redirectUri' => '<string>',
],
],
],
'connectorProfileProperties' => [ // REQUIRED
'Amplitude' => [
],
'Datadog' => [
'instanceUrl' => '<string>', // REQUIRED
],
'Dynatrace' => [
'instanceUrl' => '<string>', // REQUIRED
],
'GoogleAnalytics' => [
],
'Honeycode' => [
],
'InforNexus' => [
'instanceUrl' => '<string>', // REQUIRED
],
'Marketo' => [
'instanceUrl' => '<string>', // REQUIRED
],
'Redshift' => [
'bucketName' => '<string>', // REQUIRED
'bucketPrefix' => '<string>',
'databaseUrl' => '<string>', // REQUIRED
'roleArn' => '<string>', // REQUIRED
],
'Salesforce' => [
'instanceUrl' => '<string>',
'isSandboxEnvironment' => true || false,
],
'ServiceNow' => [
'instanceUrl' => '<string>', // REQUIRED
],
'Singular' => [
],
'Slack' => [
'instanceUrl' => '<string>', // REQUIRED
],
'Snowflake' => [
'accountName' => '<string>',
'bucketName' => '<string>', // REQUIRED
'bucketPrefix' => '<string>',
'privateLinkServiceName' => '<string>',
'region' => '<string>',
'stage' => '<string>', // REQUIRED
'warehouse' => '<string>', // REQUIRED
],
'Trendmicro' => [
],
'Veeva' => [
'instanceUrl' => '<string>', // REQUIRED
],
'Zendesk' => [
'instanceUrl' => '<string>', // REQUIRED
],
],
],
'connectorProfileName' => '<string>', // REQUIRED
'connectorType' => 'Salesforce|Singular|Slack|Redshift|S3|Marketo|Googleanalytics|Zendesk|Servicenow|Datadog|Trendmicro|Snowflake|Dynatrace|Infornexus|Amplitude|Veeva|EventBridge|LookoutMetrics|Upsolver|Honeycode|CustomerProfiles', // REQUIRED
'kmsArn' => '<string>',
]);
Parameter Details
Members
- connectionMode
-
- Required: Yes
- Type: string
Indicates the connection mode and specifies whether it is public or private. Private flows use AWS PrivateLink to route data over AWS infrastructure without exposing it to the public internet.
- connectorProfileConfig
-
- Required: Yes
- Type: ConnectorProfileConfig structure
Defines the connector-specific configuration and credentials.
- connectorProfileName
-
- Required: Yes
- Type: string
The name of the connector profile. The name is unique for each
ConnectorProfilein your AWS account. - connectorType
-
- Required: Yes
- Type: string
The type of connector, such as Salesforce, Amplitude, and so on.
- kmsArn
-
- Type: string
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.
Result Syntax
[
'connectorProfileArn' => '<string>',
]
Result Details
Errors
-
The request has invalid or missing parameters.
-
There was a conflict when processing the request (for example, a flow with the given name already exists within the account. Check for conflicting resource names and try again.
-
ServiceQuotaExceededException:
The request would cause a service quota (such as the number of flows) to be exceeded.
-
ConnectorAuthenticationException:
An error occurred when authenticating with the connector endpoint.
-
An internal service error occurred during the processing of your request. Try again later.
CreateFlow
$result = $client->createFlow([/* ... */]); $promise = $client->createFlowAsync([/* ... */]);
Enables your application to create a new flow using Amazon AppFlow. You must create a connector profile before calling this API. Please note that the Request Syntax below shows syntax for multiple destinations, however, you can only transfer data to one item in this list at a time. Amazon AppFlow does not currently support flows to multiple destinations at once.
Parameter Syntax
$result = $client->createFlow([
'description' => '<string>',
'destinationFlowConfigList' => [ // REQUIRED
[
'connectorProfileName' => '<string>',
'connectorType' => 'Salesforce|Singular|Slack|Redshift|S3|Marketo|Googleanalytics|Zendesk|Servicenow|Datadog|Trendmicro|Snowflake|Dynatrace|Infornexus|Amplitude|Veeva|EventBridge|LookoutMetrics|Upsolver|Honeycode|CustomerProfiles', // REQUIRED
'destinationConnectorProperties' => [ // REQUIRED
'CustomerProfiles' => [
'domainName' => '<string>', // REQUIRED
'objectTypeName' => '<string>',
],
'EventBridge' => [
'errorHandlingConfig' => [
'bucketName' => '<string>',
'bucketPrefix' => '<string>',
'failOnFirstDestinationError' => true || false,
],
'object' => '<string>', // REQUIRED
],
'Honeycode' => [
'errorHandlingConfig' => [
'bucketName' => '<string>',
'bucketPrefix' => '<string>',
'failOnFirstDestinationError' => true || false,
],
'object' => '<string>', // REQUIRED
],
'LookoutMetrics' => [
],
'Redshift' => [
'bucketPrefix' => '<string>',
'errorHandlingConfig' => [
'bucketName' => '<string>',
'bucketPrefix' => '<string>',
'failOnFirstDestinationError' => true || false,
],
'intermediateBucketName' => '<string>', // REQUIRED
'object' => '<string>', // REQUIRED
],
'S3' => [
'bucketName' => '<string>', // REQUIRED
'bucketPrefix' => '<string>',
's3OutputFormatConfig' => [
'aggregationConfig' => [
'aggregationType' => 'None|SingleFile',
],
'fileType' => 'CSV|JSON|PARQUET',
'prefixConfig' => [
'prefixFormat' => 'YEAR|MONTH|DAY|HOUR|MINUTE',
'prefixType' => 'FILENAME|PATH|PATH_AND_FILENAME',
],
],
],
'Salesforce' => [
'errorHandlingConfig' => [
'bucketName' => '<string>',
'bucketPrefix' => '<string>',
'failOnFirstDestinationError' => true || false,
],
'idFieldNames' => ['<string>', ...],
'object' => '<string>', // REQUIRED
'writeOperationType' => 'INSERT|UPSERT|UPDATE',
],
'Snowflake' => [
'bucketPrefix' => '<string>',
'errorHandlingConfig' => [
'bucketName' => '<string>',
'bucketPrefix' => '<string>',
'failOnFirstDestinationError' => true || false,
],
'intermediateBucketName' => '<string>', // REQUIRED
'object' => '<string>', // REQUIRED
],
'Upsolver' => [
'bucketName' => '<string>', // REQUIRED
'bucketPrefix' => '<string>',
's3OutputFormatConfig' => [ // REQUIRED
'aggregationConfig' => [
'aggregationType' => 'None|SingleFile',
],
'fileType' => 'CSV|JSON|PARQUET',
'prefixConfig' => [ // REQUIRED
'prefixFormat' => 'YEAR|MONTH|DAY|HOUR|MINUTE',
'prefixType' => 'FILENAME|PATH|PATH_AND_FILENAME',
],
],
],
'Zendesk' => [
'errorHandlingConfig' => [
'bucketName' => '<string>',
'bucketPrefix' => '<string>',
'failOnFirstDestinationError' => true || false,
],
'idFieldNames' => ['<string>', ...],
'object' => '<string>', // REQUIRED
'writeOperationType' => 'INSERT|UPSERT|UPDATE',
],
],
],
// ...
],
'flowName' => '<string>', // REQUIRED
'kmsArn' => '<string>',
'sourceFlowConfig' => [ // REQUIRED
'connectorProfileName' => '<string>',
'connectorType' => 'Salesforce|Singular|Slack|Redshift|S3|Marketo|Googleanalytics|Zendesk|Servicenow|Datadog|Trendmicro|Snowflake|Dynatrace|Infornexus|Amplitude|Veeva|EventBridge|LookoutMetrics|Upsolver|Honeycode|CustomerProfiles', // REQUIRED
'incrementalPullConfig' => [
'datetimeTypeFieldName' => '<string>',
],
'sourceConnectorProperties' => [ // REQUIRED
'Amplitude' => [
'object' => '<string>', // REQUIRED
],
'Datadog' => [
'object' => '<string>', // REQUIRED
],
'Dynatrace' => [
'object' => '<string>', // REQUIRED
],
'GoogleAnalytics' => [
'object' => '<string>', // REQUIRED
],
'InforNexus' => [
'object' => '<string>', // REQUIRED
],
'Marketo' => [
'object' => '<string>', // REQUIRED
],
'S3' => [
'bucketName' => '<string>', // REQUIRED
'bucketPrefix' => '<string>',
],
'Salesforce' => [
'enableDynamicFieldUpdate' => true || false,
'includeDeletedRecords' => true || false,
'object' => '<string>', // REQUIRED
],
'ServiceNow' => [
'object' => '<string>', // REQUIRED
],
'Singular' => [
'object' => '<string>', // REQUIRED
],
'Slack' => [
'object' => '<string>', // REQUIRED
],
'Trendmicro' => [
'object' => '<string>', // REQUIRED
],
'Veeva' => [
'object' => '<string>', // REQUIRED
],
'Zendesk' => [
'object' => '<string>', // REQUIRED
],
],
],
'tags' => ['<string>', ...],
'tasks' => [ // REQUIRED
[
'connectorOperator' => [
'Amplitude' => 'BETWEEN',
'Datadog' => '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',
'Dynatrace' => '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',
'GoogleAnalytics' => 'PROJECTION|BETWEEN',
'InforNexus' => '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',
'Marketo' => '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',
'S3' => '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',
'Salesforce' => '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',
'ServiceNow' => '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',
'Singular' => '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',
'Slack' => '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',
'Trendmicro' => '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',
'Veeva' => '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',
'Zendesk' => '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',
],
'destinationField' => '<string>',
'sourceFields' => ['<string>', ...], // REQUIRED
'taskProperties' => ['<string>', ...],
'taskType' => 'Arithmetic|Filter|Map|Mask|Merge|Truncate|Validate', // REQUIRED
],
// ...
],
'triggerConfig' => [ // REQUIRED
'triggerProperties' => [
'Scheduled' => [
'dataPullMode' => 'Incremental|Complete',
'firstExecutionFrom' => <integer || string || DateTime>,
'scheduleEndTime' => <integer || string || DateTime>,
'scheduleExpression' => '<string>', // REQUIRED
'scheduleOffset' => <integer>,
'scheduleStartTime' => <integer || string || DateTime>,
'timezone' => '<string>',
],
],
'triggerType' => 'Scheduled|Event|OnDemand', // REQUIRED
],
]);
Parameter Details
Members
- description
-
- Type: string
A description of the flow you want to create.
- destinationFlowConfigList
-
- Required: Yes
- Type: Array of DestinationFlowConfig structures
The configuration that controls how Amazon AppFlow places data in the destination connector.
- flowName
-
- Required: Yes
- Type: string
The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
- kmsArn
-
- Type: string
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.
- sourceFlowConfig
-
- Required: Yes
- Type: SourceFlowConfig structure
The configuration that controls how Amazon AppFlow retrieves data from the source connector.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for your flow.
- tasks
-
- Required: Yes
- Type: Array of Task structures
A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
- triggerConfig
-
- Required: Yes
- Type: TriggerConfig structure
The trigger settings that determine how and when the flow runs.
Result Syntax
[
'flowArn' => '<string>',
'flowStatus' => 'Active|Deprecated|Deleted|Draft|Errored|Suspended',
]
Result Details
Members
Errors
-
The request has invalid or missing parameters.
-
An internal service error occurred during the processing of your request. Try again later.
-
The resource specified in the request (such as the source or destination connector profile) is not found.
-
ServiceQuotaExceededException:
The request would cause a service quota (such as the number of flows) to be exceeded.
-
There was a conflict when processing the request (for example, a flow with the given name already exists within the account. Check for conflicting resource names and try again.
-
ConnectorAuthenticationException:
An error occurred when authenticating with the connector endpoint.
-
An error occurred when retrieving data from the connector endpoint.
DeleteConnectorProfile
$result = $client->deleteConnectorProfile([/* ... */]); $promise = $client->deleteConnectorProfileAsync([/* ... */]);
Enables you to delete an existing connector profile.
Parameter Syntax
$result = $client->deleteConnectorProfile([
'connectorProfileName' => '<string>', // REQUIRED
'forceDelete' => true || false,
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The resource specified in the request (such as the source or destination connector profile) is not found.
-
There was a conflict when processing the request (for example, a flow with the given name already exists within the account. Check for conflicting resource names and try again.
-
An internal service error occurred during the processing of your request. Try again later.
DeleteFlow
$result = $client->deleteFlow([/* ... */]); $promise = $client->deleteFlowAsync([/* ... */]);
Enables your application to delete an existing flow. Before deleting the flow, Amazon AppFlow validates the request by checking the flow configuration and status. You can delete flows one at a time.
Parameter Syntax
$result = $client->deleteFlow([
'flowName' => '<string>', // REQUIRED
'forceDelete' => true || false,
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The resource specified in the request (such as the source or destination connector profile) is not found.
-
There was a conflict when processing the request (for example, a flow with the given name already exists within the account. Check for conflicting resource names and try again.
-
An internal service error occurred during the processing of your request. Try again later.
DescribeConnectorEntity
$result = $client->describeConnectorEntity([/* ... */]); $promise = $client->describeConnectorEntityAsync([/* ... */]);
Provides details regarding the entity used with the connector, with a description of the data model for each entity.
Parameter Syntax
$result = $client->describeConnectorEntity([
'connectorEntityName' => '<string>', // REQUIRED
'connectorProfileName' => '<string>',
'connectorType' => 'Salesforce|Singular|Slack|Redshift|S3|Marketo|Googleanalytics|Zendesk|Servicenow|Datadog|Trendmicro|Snowflake|Dynatrace|Infornexus|Amplitude|Veeva|EventBridge|LookoutMetrics|Upsolver|Honeycode|CustomerProfiles',
]);
Parameter Details
Members
- connectorEntityName
-
- Required: Yes
- Type: string
The entity name for that connector.
- connectorProfileName
-
- Type: string
The name of the connector profile. The name is unique for each
ConnectorProfilein the AWS account. - connectorType
-
- Type: string
The type of connector application, such as Salesforce, Amplitude, and so on.
Result Syntax
[
'connectorEntityFields' => [
[
'description' => '<string>',
'destinationProperties' => [
'isCreatable' => true || false,
'isNullable' => true || false,
'isUpdatable' => true || false,
'isUpsertable' => true || false,
'supportedWriteOperations' => ['<string>', ...],
],
'identifier' => '<string>',
'label' => '<string>',
'sourceProperties' => [
'isQueryable' => true || false,
'isRetrievable' => true || false,
],
'supportedFieldTypeDetails' => [
'v1' => [
'fieldType' => '<string>',
'filterOperators' => ['<string>', ...],
'supportedValues' => ['<string>', ...],
],
],
],
// ...
],
]
Result Details
Members
- connectorEntityFields
-
- Required: Yes
- Type: Array of ConnectorEntityField structures
Describes the fields for that connector entity. For example, for an account entity, the fields would be account name, account ID, and so on.
Errors
-
The request has invalid or missing parameters.
-
The resource specified in the request (such as the source or destination connector profile) is not found.
-
ConnectorAuthenticationException:
An error occurred when authenticating with the connector endpoint.
-
An error occurred when retrieving data from the connector endpoint.
-
An internal service error occurred during the processing of your request. Try again later.
DescribeConnectorProfiles
$result = $client->describeConnectorProfiles([/* ... */]); $promise = $client->describeConnectorProfilesAsync([/* ... */]);
Returns a list of connector-profile details matching the provided connector-profile names and connector-types. Both input lists are optional, and you can use them to filter the result.
If no names or connector-types are provided, returns all connector profiles in a paginated form. If there is no match, this operation returns an empty list.
Parameter Syntax
$result = $client->describeConnectorProfiles([
'connectorProfileNames' => ['<string>', ...],
'connectorType' => 'Salesforce|Singular|Slack|Redshift|S3|Marketo|Googleanalytics|Zendesk|Servicenow|Datadog|Trendmicro|Snowflake|Dynatrace|Infornexus|Amplitude|Veeva|EventBridge|LookoutMetrics|Upsolver|Honeycode|CustomerProfiles',
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
- connectorProfileNames
-
- Type: Array of strings
The name of the connector profile. The name is unique for each
ConnectorProfilein the AWS account. - connectorType
-
- Type: string
The type of connector, such as Salesforce, Amplitude, and so on.
- maxResults
-
- Type: int
Specifies the maximum number of items that should be returned in the result set. The default for
maxResultsis 20 (for all paginated API operations). - nextToken
-
- Type: string
The pagination token for the next page of data.
Result Syntax
[
'connectorProfileDetails' => [
[
'connectionMode' => 'Public|Private',
'connectorProfileArn' => '<string>',
'connectorProfileName' => '<string>',
'connectorProfileProperties' => [
'Amplitude' => [
],
'Datadog' => [
'instanceUrl' => '<string>',
],
'Dynatrace' => [
'instanceUrl' => '<string>',
],
'GoogleAnalytics' => [
],
'Honeycode' => [
],
'InforNexus' => [
'instanceUrl' => '<string>',
],
'Marketo' => [
'instanceUrl' => '<string>',
],
'Redshift' => [
'bucketName' => '<string>',
'bucketPrefix' => '<string>',
'databaseUrl' => '<string>',
'roleArn' => '<string>',
],
'Salesforce' => [
'instanceUrl' => '<string>',
'isSandboxEnvironment' => true || false,
],
'ServiceNow' => [
'instanceUrl' => '<string>',
],
'Singular' => [
],
'Slack' => [
'instanceUrl' => '<string>',
],
'Snowflake' => [
'accountName' => '<string>',
'bucketName' => '<string>',
'bucketPrefix' => '<string>',
'privateLinkServiceName' => '<string>',
'region' => '<string>',
'stage' => '<string>',
'warehouse' => '<string>',
],
'Trendmicro' => [
],
'Veeva' => [
'instanceUrl' => '<string>',
],
'Zendesk' => [
'instanceUrl' => '<string>',
],
],
'connectorType' => 'Salesforce|Singular|Slack|Redshift|S3|Marketo|Googleanalytics|Zendesk|Servicenow|Datadog|Trendmicro|Snowflake|Dynatrace|Infornexus|Amplitude|Veeva|EventBridge|LookoutMetrics|Upsolver|Honeycode|CustomerProfiles',
'createdAt' => <DateTime>,
'credentialsArn' => '<string>',
'lastUpdatedAt' => <DateTime>,
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- connectorProfileDetails
-
- Type: Array of ConnectorProfile structures
Returns information about the connector profiles associated with the flow.
- nextToken
-
- Type: string
The pagination token for the next page of data. If
nextToken=null, this means that all records have been fetched.
Errors
-
The request has invalid or missing parameters.
-
An internal service error occurred during the processing of your request. Try again later.
DescribeConnectors
$result = $client->describeConnectors([/* ... */]); $promise = $client->describeConnectorsAsync([/* ... */]);
Describes the connectors vended by Amazon AppFlow for specified connector types. If you don't specify a connector type, this operation describes all connectors vended by Amazon AppFlow. If there are more connectors than can be returned in one page, the response contains a nextToken object, which can be be passed in to the next call to the DescribeConnectors API operation to retrieve the next page.
Parameter Syntax
$result = $client->describeConnectors([
'connectorTypes' => ['<string>', ...],
'nextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'connectorConfigurations' => [
'<ConnectorType>' => [
'canUseAsDestination' => true || false,
'canUseAsSource' => true || false,
'connectorMetadata' => [
'Amplitude' => [
],
'CustomerProfiles' => [
],
'Datadog' => [
],
'Dynatrace' => [
],
'EventBridge' => [
],
'GoogleAnalytics' => [
'oAuthScopes' => ['<string>', ...],
],
'Honeycode' => [
'oAuthScopes' => ['<string>', ...],
],
'InforNexus' => [
],
'Marketo' => [
],
'Redshift' => [
],
'S3' => [
],
'Salesforce' => [
'oAuthScopes' => ['<string>', ...],
],
'ServiceNow' => [
],
'Singular' => [
],
'Slack' => [
'oAuthScopes' => ['<string>', ...],
],
'Snowflake' => [
'supportedRegions' => ['<string>', ...],
],
'Trendmicro' => [
],
'Upsolver' => [
],
'Veeva' => [
],
'Zendesk' => [
'oAuthScopes' => ['<string>', ...],
],
],
'isPrivateLinkEnabled' => true || false,
'isPrivateLinkEndpointUrlRequired' => true || false,
'supportedDestinationConnectors' => ['<string>', ...],
'supportedSchedulingFrequencies' => ['<string>', ...],
'supportedTriggerTypes' => ['<string>', ...],
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- connectorConfigurations
-
- Type: Associative array of custom strings keys (ConnectorType) to ConnectorConfiguration structures
The configuration that is applied to the connectors used in the flow.
- nextToken
-
- Type: string
The pagination token for the next page of data.
Errors
-
The request has invalid or missing parameters.
-
An internal service error occurred during the processing of your request. Try again later.
DescribeFlow
$result = $client->describeFlow([/* ... */]); $promise = $client->describeFlowAsync([/* ... */]);
Provides a description of the specified flow.
Parameter Syntax
$result = $client->describeFlow([
'flowName' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'createdAt' => <DateTime>,
'createdBy' => '<string>',
'description' => '<string>',
'destinationFlowConfigList' => [
[
'connectorProfileName' => '<string>',
'connectorType' => 'Salesforce|Singular|Slack|Redshift|S3|Marketo|Googleanalytics|Zendesk|Servicenow|Datadog|Trendmicro|Snowflake|Dynatrace|Infornexus|Amplitude|Veeva|EventBridge|LookoutMetrics|Upsolver|Honeycode|CustomerProfiles',
'destinationConnectorProperties' => [
'CustomerProfiles' => [
'domainName' => '<string>',
'objectTypeName' => '<string>',
],
'EventBridge' => [
'errorHandlingConfig' => [
'bucketName' => '<string>',
'bucketPrefix' => '<string>',
'failOnFirstDestinationError' => true || false,
],
'object' => '<string>',
],
'Honeycode' => [
'errorHandlingConfig' => [
'bucketName' => '<string>',
'bucketPrefix' => '<string>',
'failOnFirstDestinationError' => true || false,
],
'object' => '<string>',
],
'LookoutMetrics' => [
],
'Redshift' => [
'bucketPrefix' => '<string>',
'errorHandlingConfig' => [
'bucketName' => '<string>',
'bucketPrefix' => '<string>',
'failOnFirstDestinationError' => true || false,
],
'intermediateBucketName' => '<string>',
'object' => '<string>',
],
'S3' => [
'bucketName' => '<string>',
'bucketPrefix' => '<string>',
's3OutputFormatConfig' => [
'aggregationConfig' => [
'aggregationType' => 'None|SingleFile',
],
'fileType' => 'CSV|JSON|PARQUET',
'prefixConfig' => [
'prefixFormat' => 'YEAR|MONTH|DAY|HOUR|MINUTE',
'prefixType' => 'FILENAME|PATH|PATH_AND_FILENAME',
],
],
],
'Salesforce' => [
'errorHandlingConfig' => [
'bucketName' => '<string>',
'bucketPrefix' => '<string>',
'failOnFirstDestinationError' => true || false,
],
'idFieldNames' => ['<string>', ...],
'object' => '<string>',
'writeOperationType' => 'INSERT|UPSERT|UPDATE',
],
'Snowflake' => [
'bucketPrefix' => '<string>',
'errorHandlingConfig' => [
'bucketName' => '<string>',
'bucketPrefix' => '<string>',
'failOnFirstDestinationError' => true || false,
],
'intermediateBucketName' => '<string>',
'object' => '<string>',
],
'Upsolver' => [
'bucketName' => '<string>',
'bucketPrefix' => '<string>',
's3OutputFormatConfig' => [
'aggregationConfig' => [
'aggregationType' => 'None|SingleFile',
],
'fileType' => 'CSV|JSON|PARQUET',
'prefixConfig' => [
'prefixFormat' => 'YEAR|MONTH|DAY|HOUR|MINUTE',
'prefixType' => 'FILENAME|PATH|PATH_AND_FILENAME',
],
],
],
'Zendesk' => [
'errorHandlingConfig' => [
'bucketName' => '<string>',
'bucketPrefix' => '<string>',
'failOnFirstDestinationError' => true || false,
],
'idFieldNames' => ['<string>', ...],
'object' => '<string>',
'writeOperationType' => 'INSERT|UPSERT|UPDATE',
],
],
],
// ...
],
'flowArn' => '<string>',
'flowName' => '<string>',
'flowStatus' => 'Active|Deprecated|Deleted|Draft|Errored|Suspended',
'flowStatusMessage' => '<string>',
'kmsArn' => '<string>',
'lastRunExecutionDetails' => [
'mostRecentExecutionMessage' => '<string>',
'mostRecentExecutionStatus' => 'InProgress|Successful|Error',
'mostRecentExecutionTime' => <DateTime>,
],
'lastUpdatedAt' => <DateTime>,
'lastUpdatedBy' => '<string>',
'sourceFlowConfig' => [
'connectorProfileName' => '<string>',
'connectorType' => 'Salesforce|Singular|Slack|Redshift|S3|Marketo|Googleanalytics|Zendesk|Servicenow|Datadog|Trendmicro|Snowflake|Dynatrace|Infornexus|Amplitude|Veeva|EventBridge|LookoutMetrics|Upsolver|Honeycode|CustomerProfiles',
'incrementalPullConfig' => [
'datetimeTypeFieldName' => '<string>',
],
'sourceConnectorProperties' => [
'Amplitude' => [
'object' => '<string>',
],
'Datadog' => [
'object' => '<string>',
],
'Dynatrace' => [
'object' => '<string>',
],
'GoogleAnalytics' => [
'object' => '<string>',
],
'InforNexus' => [
'object' => '<string>',
],
'Marketo' => [
'object' => '<string>',
],
'S3' => [
'bucketName' => '<string>',
'bucketPrefix' => '<string>',
],
'Salesforce' => [
'enableDynamicFieldUpdate' => true || false,
'includeDeletedRecords' => true || false,
'object' => '<string>',
],
'ServiceNow' => [
'object' => '<string>',
],
'Singular' => [
'object' => '<string>',
],
'Slack' => [
'object' => '<string>',
],
'Trendmicro' => [
'object' => '<string>',
],
'Veeva' => [
'object' => '<string>',
],
'Zendesk' => [
'object' => '<string>',
],
],
],
'tags' => ['<string>', ...],
'tasks' => [
[
'connectorOperator' => [
'Amplitude' => 'BETWEEN',
'Datadog' => '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',
'Dynatrace' => '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',
'GoogleAnalytics' => 'PROJECTION|BETWEEN',
'InforNexus' => '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',
'Marketo' => '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',
'S3' => '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',
'Salesforce' => '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',
'ServiceNow' => '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',
'Singular' => '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',
'Slack' => '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',
'Trendmicro' => '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',
'Veeva' => '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',
'Zendesk' => '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',
],
'destinationField' => '<string>',
'sourceFields' => ['<string>', ...],
'taskProperties' => ['<string>', ...],
'taskType' => 'Arithmetic|Filter|Map|Mask|Merge|Truncate|Validate',
],
// ...
],
'triggerConfig' => [
'triggerProperties' => [
'Scheduled' => [
'dataPullMode' => 'Incremental|Complete',
'firstExecutionFrom' => <DateTime>,
'scheduleEndTime' => <DateTime>,
'scheduleExpression' => '<string>',
'scheduleOffset' => <integer>,
'scheduleStartTime' => <DateTime>,
'timezone' => '<string>',
],
],
'triggerType' => 'Scheduled|Event|OnDemand',
],
]
Result Details
Members
- createdAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Specifies when the flow was created.
- createdBy
-
- Type: string
The ARN of the user who created the flow.
- description
-
- Type: string
A description of the flow.
- destinationFlowConfigList
-
- Type: Array of DestinationFlowConfig structures
The configuration that controls how Amazon AppFlow transfers data to the destination connector.
- flowArn
-
- Type: string
The flow's Amazon Resource Name (ARN).
- flowName
-
- Type: string
The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
- flowStatus
-
- Type: string
Indicates the current status of the flow.
- flowStatusMessage
-
- Type: string
Contains an error message if the flow status is in a suspended or error state. This applies only to scheduled or event-triggered flows.
- kmsArn
-
- Type: string
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.
- lastRunExecutionDetails
-
- Type: ExecutionDetails structure
Describes the details of the most recent flow run.
- lastUpdatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Specifies when the flow was last updated.
- lastUpdatedBy
-
- Type: string
Specifies the user name of the account that performed the most recent update.
- sourceFlowConfig
-
- Type: SourceFlowConfig structure
The configuration that controls how Amazon AppFlow retrieves data from the source connector.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for your flow.
- tasks
-
- Type: Array of Task structures
A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
- triggerConfig
-
- Type: TriggerConfig structure
The trigger settings that determine how and when the flow runs.
Errors
-
The resource specified in the request (such as the source or destination connector profile) is not found.
-
An internal service error occurred during the processing of your request. Try again later.
DescribeFlowExecutionRecords
$result = $client->describeFlowExecutionRecords([/* ... */]); $promise = $client->describeFlowExecutionRecordsAsync([/* ... */]);
Fetches the execution history of the flow.
Parameter Syntax
$result = $client->describeFlowExecutionRecords([
'flowName' => '<string>', // REQUIRED
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
- flowName
-
- Required: Yes
- Type: string
The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
- maxResults
-
- Type: int
Specifies the maximum number of items that should be returned in the result set. The default for
maxResultsis 20 (for all paginated API operations). - nextToken
-
- Type: string
The pagination token for the next page of data.
Result Syntax
[
'flowExecutions' => [
[
'dataPullEndTime' => <DateTime>,
'dataPullStartTime' => <DateTime>,
'executionId' => '<string>',
'executionResult' => [
'bytesProcessed' => <integer>,
'bytesWritten' => <integer>,
'errorInfo' => [
'executionMessage' => '<string>',
'putFailuresCount' => <integer>,
],
'recordsProcessed' => <integer>,
],
'executionStatus' => 'InProgress|Successful|Error',
'lastUpdatedAt' => <DateTime>,
'startedAt' => <DateTime>,
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- flowExecutions
-
- Type: Array of ExecutionRecord structures
Returns a list of all instances when this flow was run.
- nextToken
-
- Type: string
The pagination token for the next page of data.
Errors
-
The request has invalid or missing parameters.
-
The resource specified in the request (such as the source or destination connector profile) is not found.
-
An internal service error occurred during the processing of your request. Try again later.
ListConnectorEntities
$result = $client->listConnectorEntities([/* ... */]); $promise = $client->listConnectorEntitiesAsync([/* ... */]);
Returns the list of available connector entities supported by Amazon AppFlow. For example, you can query Salesforce for Account and Opportunity entities, or query ServiceNow for the Incident entity.
Parameter Syntax
$result = $client->listConnectorEntities([
'connectorProfileName' => '<string>',
'connectorType' => 'Salesforce|Singular|Slack|Redshift|S3|Marketo|Googleanalytics|Zendesk|Servicenow|Datadog|Trendmicro|Snowflake|Dynatrace|Infornexus|Amplitude|Veeva|EventBridge|LookoutMetrics|Upsolver|Honeycode|CustomerProfiles',
'entitiesPath' => '<string>',
]);
Parameter Details
Members
- connectorProfileName
-
- Type: string
The name of the connector profile. The name is unique for each
ConnectorProfilein the AWS account, and is used to query the downstream connector. - connectorType
-
- Type: string
The type of connector, such as Salesforce, Amplitude, and so on.
- entitiesPath
-
- Type: string
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
entitiesPathparameter. 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.
Result Syntax
[
'connectorEntityMap' => [
'<Group>' => [
[
'hasNestedEntities' => true || false,
'label' => '<string>',
'name' => '<string>',
],
// ...
],
// ...
],
]
Result Details
Members
- connectorEntityMap
-
- Required: Yes
- Type: Associative array of custom strings keys (Group) to ConnectorEntity structuress
The response of
ListConnectorEntitieslists entities grouped by category. This map's key represents the group name, and its value contains the list of entities belonging to that group.
Errors
-
The request has invalid or missing parameters.
-
The resource specified in the request (such as the source or destination connector profile) is not found.
-
ConnectorAuthenticationException:
An error occurred when authenticating with the connector endpoint.
-
An error occurred when retrieving data from the connector endpoint.
-
An internal service error occurred during the processing of your request. Try again later.
ListFlows
$result = $client->listFlows([/* ... */]); $promise = $client->listFlowsAsync([/* ... */]);
Lists all of the flows associated with your account.
Parameter Syntax
$result = $client->listFlows([
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'flows' => [
[
'createdAt' => <DateTime>,
'createdBy' => '<string>',
'description' => '<string>',
'destinationConnectorType' => 'Salesforce|Singular|Slack|Redshift|S3|Marketo|Googleanalytics|Zendesk|Servicenow|Datadog|Trendmicro|Snowflake|Dynatrace|Infornexus|Amplitude|Veeva|EventBridge|LookoutMetrics|Upsolver|Honeycode|CustomerProfiles',
'flowArn' => '<string>',
'flowName' => '<string>',
'flowStatus' => 'Active|Deprecated|Deleted|Draft|Errored|Suspended',
'lastRunExecutionDetails' => [
'mostRecentExecutionMessage' => '<string>',
'mostRecentExecutionStatus' => 'InProgress|Successful|Error',
'mostRecentExecutionTime' => <DateTime>,
],
'lastUpdatedAt' => <DateTime>,
'lastUpdatedBy' => '<string>',
'sourceConnectorType' => 'Salesforce|Singular|Slack|Redshift|S3|Marketo|Googleanalytics|Zendesk|Servicenow|Datadog|Trendmicro|Snowflake|Dynatrace|Infornexus|Amplitude|Veeva|EventBridge|LookoutMetrics|Upsolver|Honeycode|CustomerProfiles',
'tags' => ['<string>', ...],
'triggerType' => 'Scheduled|Event|OnDemand',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- flows
-
- Type: Array of FlowDefinition structures
The list of flows associated with your account.
- nextToken
-
- Type: string
The pagination token for next page of data.
Errors
-
The request has invalid or missing parameters.
-
An internal service error occurred during the processing of your request. Try again later.
ListTagsForResource
$result = $client->listTagsForResource([/* ... */]); $promise = $client->listTagsForResourceAsync([/* ... */]);
Retrieves the tags that are associated with a specified flow.
Parameter Syntax
$result = $client->listTagsForResource([
'resourceArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'tags' => ['<string>', ...],
]
Result Details
Members
Errors
-
An internal service error occurred during the processing of your request. Try again later.
-
The request has invalid or missing parameters.
-
The resource specified in the request (such as the source or destination connector profile) is not found.
StartFlow
$result = $client->startFlow([/* ... */]); $promise = $client->startFlowAsync([/* ... */]);
Activates an existing flow. For on-demand flows, this operation runs the flow immediately. For schedule and event-triggered flows, this operation activates the flow.
Parameter Syntax
$result = $client->startFlow([
'flowName' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'executionId' => '<string>',
'flowArn' => '<string>',
'flowStatus' => 'Active|Deprecated|Deleted|Draft|Errored|Suspended',
]
Result Details
Members
Errors
-
The resource specified in the request (such as the source or destination connector profile) is not found.
-
An internal service error occurred during the processing of your request. Try again later.
-
ServiceQuotaExceededException:
The request would cause a service quota (such as the number of flows) to be exceeded.
-
There was a conflict when processing the request (for example, a flow with the given name already exists within the account. Check for conflicting resource names and try again.
StopFlow
$result = $client->stopFlow([/* ... */]); $promise = $client->stopFlowAsync([/* ... */]);
Deactivates the existing flow. For on-demand flows, this operation returns an unsupportedOperationException error message. For schedule and event-triggered flows, this operation deactivates the flow.
Parameter Syntax
$result = $client->stopFlow([
'flowName' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'flowArn' => '<string>',
'flowStatus' => 'Active|Deprecated|Deleted|Draft|Errored|Suspended',
]
Result Details
Members
Errors
-
There was a conflict when processing the request (for example, a flow with the given name already exists within the account. Check for conflicting resource names and try again.
-
The resource specified in the request (such as the source or destination connector profile) is not found.
-
UnsupportedOperationException:
The requested operation is not supported for the current flow.
-
An internal service error occurred during the processing of your request. Try again later.
TagResource
$result = $client->tagResource([/* ... */]); $promise = $client->tagResourceAsync([/* ... */]);
Applies a tag to the specified flow.
Parameter Syntax
$result = $client->tagResource([
'resourceArn' => '<string>', // REQUIRED
'tags' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
An internal service error occurred during the processing of your request. Try again later.
-
The request has invalid or missing parameters.
-
The resource specified in the request (such as the source or destination connector profile) is not found.
UntagResource
$result = $client->untagResource([/* ... */]); $promise = $client->untagResourceAsync([/* ... */]);
Removes a tag from the specified flow.
Parameter Syntax
$result = $client->untagResource([
'resourceArn' => '<string>', // REQUIRED
'tagKeys' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
An internal service error occurred during the processing of your request. Try again later.
-
The request has invalid or missing parameters.
-
The resource specified in the request (such as the source or destination connector profile) is not found.
UpdateConnectorProfile
$result = $client->updateConnectorProfile([/* ... */]); $promise = $client->updateConnectorProfileAsync([/* ... */]);
Updates a given connector profile associated with your account.
Parameter Syntax
$result = $client->updateConnectorProfile([
'connectionMode' => 'Public|Private', // REQUIRED
'connectorProfileConfig' => [ // REQUIRED
'connectorProfileCredentials' => [ // REQUIRED
'Amplitude' => [
'apiKey' => '<string>', // REQUIRED
'secretKey' => '<string>', // REQUIRED
],
'Datadog' => [
'apiKey' => '<string>', // REQUIRED
'applicationKey' => '<string>', // REQUIRED
],
'Dynatrace' => [
'apiToken' => '<string>', // REQUIRED
],
'GoogleAnalytics' => [
'accessToken' => '<string>',
'clientId' => '<string>', // REQUIRED
'clientSecret' => '<string>', // REQUIRED
'oAuthRequest' => [
'authCode' => '<string>',
'redirectUri' => '<string>',
],
'refreshToken' => '<string>',
],
'Honeycode' => [
'accessToken' => '<string>',
'oAuthRequest' => [
'authCode' => '<string>',
'redirectUri' => '<string>',
],
'refreshToken' => '<string>',
],
'InforNexus' => [
'accessKeyId' => '<string>', // REQUIRED
'datakey' => '<string>', // REQUIRED
'secretAccessKey' => '<string>', // REQUIRED
'userId' => '<string>', // REQUIRED
],
'Marketo' => [
'accessToken' => '<string>',
'clientId' => '<string>', // REQUIRED
'clientSecret' => '<string>', // REQUIRED
'oAuthRequest' => [
'authCode' => '<string>',
'redirectUri' => '<string>',
],
],
'Redshift' => [
'password' => '<string>', // REQUIRED
'username' => '<string>', // REQUIRED
],
'Salesforce' => [
'accessToken' => '<string>',
'clientCredentialsArn' => '<string>',
'oAuthRequest' => [
'authCode' => '<string>',
'redirectUri' => '<string>',
],
'refreshToken' => '<string>',
],
'ServiceNow' => [
'password' => '<string>', // REQUIRED
'username' => '<string>', // REQUIRED
],
'Singular' => [
'apiKey' => '<string>', // REQUIRED
],
'Slack' => [
'accessToken' => '<string>',
'clientId' => '<string>', // REQUIRED
'clientSecret' => '<string>', // REQUIRED
'oAuthRequest' => [
'authCode' => '<string>',
'redirectUri' => '<string>',
],
],
'Snowflake' => [
'password' => '<string>', // REQUIRED
'username' => '<string>', // REQUIRED
],
'Trendmicro' => [
'apiSecretKey' => '<string>', // REQUIRED
],
'Veeva' => [
'password' => '<string>', // REQUIRED
'username' => '<string>', // REQUIRED
],
'Zendesk' => [
'accessToken' => '<string>',
'clientId' => '<string>', // REQUIRED
'clientSecret' => '<string>', // REQUIRED
'oAuthRequest' => [
'authCode' => '<string>',
'redirectUri' => '<string>',
],
],
],
'connectorProfileProperties' => [ // REQUIRED
'Amplitude' => [
],
'Datadog' => [
'instanceUrl' => '<string>', // REQUIRED
],
'Dynatrace' => [
'instanceUrl' => '<string>', // REQUIRED
],
'GoogleAnalytics' => [
],
'Honeycode' => [
],
'InforNexus' => [
'instanceUrl' => '<string>', // REQUIRED
],
'Marketo' => [
'instanceUrl' => '<string>', // REQUIRED
],
'Redshift' => [
'bucketName' => '<string>', // REQUIRED
'bucketPrefix' => '<string>',
'databaseUrl' => '<string>', // REQUIRED
'roleArn' => '<string>', // REQUIRED
],
'Salesforce' => [
'instanceUrl' => '<string>',
'isSandboxEnvironment' => true || false,
],
'ServiceNow' => [
'instanceUrl' => '<string>', // REQUIRED
],
'Singular' => [
],
'Slack' => [
'instanceUrl' => '<string>', // REQUIRED
],
'Snowflake' => [
'accountName' => '<string>',
'bucketName' => '<string>', // REQUIRED
'bucketPrefix' => '<string>',
'privateLinkServiceName' => '<string>',
'region' => '<string>',
'stage' => '<string>', // REQUIRED
'warehouse' => '<string>', // REQUIRED
],
'Trendmicro' => [
],
'Veeva' => [
'instanceUrl' => '<string>', // REQUIRED
],
'Zendesk' => [
'instanceUrl' => '<string>', // REQUIRED
],
],
],
'connectorProfileName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- connectionMode
-
- Required: Yes
- Type: string
Indicates the connection mode and if it is public or private.
- connectorProfileConfig
-
- Required: Yes
- Type: ConnectorProfileConfig structure
Defines the connector-specific profile configuration and credentials.
- connectorProfileName
-
- Required: Yes
- Type: string
The name of the connector profile and is unique for each
ConnectorProfilein the AWS Account.
Result Syntax
[
'connectorProfileArn' => '<string>',
]
Result Details
Errors
-
The request has invalid or missing parameters.
-
The resource specified in the request (such as the source or destination connector profile) is not found.
-
There was a conflict when processing the request (for example, a flow with the given name already exists within the account. Check for conflicting resource names and try again.
-
ConnectorAuthenticationException:
An error occurred when authenticating with the connector endpoint.
-
An internal service error occurred during the processing of your request. Try again later.
UpdateFlow
$result = $client->updateFlow([/* ... */]); $promise = $client->updateFlowAsync([/* ... */]);
Updates an existing flow.
Parameter Syntax
$result = $client->updateFlow([
'description' => '<string>',
'destinationFlowConfigList' => [ // REQUIRED
[
'connectorProfileName' => '<string>',
'connectorType' => 'Salesforce|Singular|Slack|Redshift|S3|Marketo|Googleanalytics|Zendesk|Servicenow|Datadog|Trendmicro|Snowflake|Dynatrace|Infornexus|Amplitude|Veeva|EventBridge|LookoutMetrics|Upsolver|Honeycode|CustomerProfiles', // REQUIRED
'destinationConnectorProperties' => [ // REQUIRED
'CustomerProfiles' => [
'domainName' => '<string>', // REQUIRED
'objectTypeName' => '<string>',
],
'EventBridge' => [
'errorHandlingConfig' => [
'bucketName' => '<string>',
'bucketPrefix' => '<string>',
'failOnFirstDestinationError' => true || false,
],
'object' => '<string>', // REQUIRED
],
'Honeycode' => [
'errorHandlingConfig' => [
'bucketName' => '<string>',
'bucketPrefix' => '<string>',
'failOnFirstDestinationError' => true || false,
],
'object' => '<string>', // REQUIRED
],
'LookoutMetrics' => [
],
'Redshift' => [
'bucketPrefix' => '<string>',
'errorHandlingConfig' => [
'bucketName' => '<string>',
'bucketPrefix' => '<string>',
'failOnFirstDestinationError' => true || false,
],
'intermediateBucketName' => '<string>', // REQUIRED
'object' => '<string>', // REQUIRED
],
'S3' => [
'bucketName' => '<string>', // REQUIRED
'bucketPrefix' => '<string>',
's3OutputFormatConfig' => [
'aggregationConfig' => [
'aggregationType' => 'None|SingleFile',
],
'fileType' => 'CSV|JSON|PARQUET',
'prefixConfig' => [
'prefixFormat' => 'YEAR|MONTH|DAY|HOUR|MINUTE',
'prefixType' => 'FILENAME|PATH|PATH_AND_FILENAME',
],
],
],
'Salesforce' => [
'errorHandlingConfig' => [
'bucketName' => '<string>',
'bucketPrefix' => '<string>',
'failOnFirstDestinationError' => true || false,
],
'idFieldNames' => ['<string>', ...],
'object' => '<string>', // REQUIRED
'writeOperationType' => 'INSERT|UPSERT|UPDATE',
],
'Snowflake' => [
'bucketPrefix' => '<string>',
'errorHandlingConfig' => [
'bucketName' => '<string>',
'bucketPrefix' => '<string>',
'failOnFirstDestinationError' => true || false,
],
'intermediateBucketName' => '<string>', // REQUIRED
'object' => '<string>', // REQUIRED
],
'Upsolver' => [
'bucketName' => '<string>', // REQUIRED
'bucketPrefix' => '<string>',
's3OutputFormatConfig' => [ // REQUIRED
'aggregationConfig' => [
'aggregationType' => 'None|SingleFile',
],
'fileType' => 'CSV|JSON|PARQUET',
'prefixConfig' => [ // REQUIRED
'prefixFormat' => 'YEAR|MONTH|DAY|HOUR|MINUTE',
'prefixType' => 'FILENAME|PATH|PATH_AND_FILENAME',
],
],
],
'Zendesk' => [
'errorHandlingConfig' => [
'bucketName' => '<string>',
'bucketPrefix' => '<string>',
'failOnFirstDestinationError' => true || false,
],
'idFieldNames' => ['<string>', ...],
'object' => '<string>', // REQUIRED
'writeOperationType' => 'INSERT|UPSERT|UPDATE',
],
],
],
// ...
],
'flowName' => '<string>', // REQUIRED
'sourceFlowConfig' => [
'connectorProfileName' => '<string>',
'connectorType' => 'Salesforce|Singular|Slack|Redshift|S3|Marketo|Googleanalytics|Zendesk|Servicenow|Datadog|Trendmicro|Snowflake|Dynatrace|Infornexus|Amplitude|Veeva|EventBridge|LookoutMetrics|Upsolver|Honeycode|CustomerProfiles', // REQUIRED
'incrementalPullConfig' => [
'datetimeTypeFieldName' => '<string>',
],
'sourceConnectorProperties' => [ // REQUIRED
'Amplitude' => [
'object' => '<string>', // REQUIRED
],
'Datadog' => [
'object' => '<string>', // REQUIRED
],
'Dynatrace' => [
'object' => '<string>', // REQUIRED
],
'GoogleAnalytics' => [
'object' => '<string>', // REQUIRED
],
'InforNexus' => [
'object' => '<string>', // REQUIRED
],
'Marketo' => [
'object' => '<string>', // REQUIRED
],
'S3' => [
'bucketName' => '<string>', // REQUIRED
'bucketPrefix' => '<string>',
],
'Salesforce' => [
'enableDynamicFieldUpdate' => true || false,
'includeDeletedRecords' => true || false,
'object' => '<string>', // REQUIRED
],
'ServiceNow' => [
'object' => '<string>', // REQUIRED
],
'Singular' => [
'object' => '<string>', // REQUIRED
],
'Slack' => [
'object' => '<string>', // REQUIRED
],
'Trendmicro' => [
'object' => '<string>', // REQUIRED
],
'Veeva' => [
'object' => '<string>', // REQUIRED
],
'Zendesk' => [
'object' => '<string>', // REQUIRED
],
],
],
'tasks' => [ // REQUIRED
[
'connectorOperator' => [
'Amplitude' => 'BETWEEN',
'Datadog' => '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',
'Dynatrace' => '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',
'GoogleAnalytics' => 'PROJECTION|BETWEEN',
'InforNexus' => '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',
'Marketo' => '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',
'S3' => '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',
'Salesforce' => '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',
'ServiceNow' => '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',
'Singular' => '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',
'Slack' => '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',
'Trendmicro' => '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',
'Veeva' => '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',
'Zendesk' => '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',
],
'destinationField' => '<string>',
'sourceFields' => ['<string>', ...], // REQUIRED
'taskProperties' => ['<string>', ...],
'taskType' => 'Arithmetic|Filter|Map|Mask|Merge|Truncate|Validate', // REQUIRED
],
// ...
],
'triggerConfig' => [ // REQUIRED
'triggerProperties' => [
'Scheduled' => [
'dataPullMode' => 'Incremental|Complete',
'firstExecutionFrom' => <integer || string || DateTime>,
'scheduleEndTime' => <integer || string || DateTime>,
'scheduleExpression' => '<string>', // REQUIRED
'scheduleOffset' => <integer>,
'scheduleStartTime' => <integer || string || DateTime>,
'timezone' => '<string>',
],
],
'triggerType' => 'Scheduled|Event|OnDemand', // REQUIRED
],
]);
Parameter Details
Members
- description
-
- Type: string
A description of the flow.
- destinationFlowConfigList
-
- Required: Yes
- Type: Array of DestinationFlowConfig structures
The configuration that controls how Amazon AppFlow transfers data to the destination connector.
- flowName
-
- Required: Yes
- Type: string
The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
- sourceFlowConfig
-
- Type: SourceFlowConfig structure
Contains information about the configuration of the source connector used in the flow.
- tasks
-
- Required: Yes
- Type: Array of Task structures
A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
- triggerConfig
-
- Required: Yes
- Type: TriggerConfig structure
The trigger settings that determine how and when the flow runs.
Result Syntax
[
'flowStatus' => 'Active|Deprecated|Deleted|Draft|Errored|Suspended',
]
Result Details
Errors
-
The request has invalid or missing parameters.
-
The resource specified in the request (such as the source or destination connector profile) is not found.
-
ServiceQuotaExceededException:
The request would cause a service quota (such as the number of flows) to be exceeded.
-
There was a conflict when processing the request (for example, a flow with the given name already exists within the account. Check for conflicting resource names and try again.
-
ConnectorAuthenticationException:
An error occurred when authenticating with the connector endpoint.
-
An error occurred when retrieving data from the connector endpoint.
-
An internal service error occurred during the processing of your request. Try again later.
Shapes
AggregationConfig
Description
The aggregation settings that you can use to customize the output format of your flow data.
Members
AmplitudeConnectorProfileCredentials
Description
The connector-specific credentials required when using Amplitude.
Members
AmplitudeConnectorProfileProperties
Description
The connector-specific profile properties required when using Amplitude.
Members
AmplitudeMetadata
Description
The connector metadata specific to Amplitude.
Members
AmplitudeSourceProperties
Description
The properties that are applied when Amplitude is being used as a source.
Members
ConflictException
Description
There was a conflict when processing the request (for example, a flow with the given name already exists within the account. Check for conflicting resource names and try again.
Members
ConnectorAuthenticationException
Description
An error occurred when authenticating with the connector endpoint.
Members
ConnectorConfiguration
Description
The configuration settings related to a given connector.
Members
- canUseAsDestination
-
- Type: boolean
Specifies whether the connector can be used as a destination.
- canUseAsSource
-
- Type: boolean
Specifies whether the connector can be used as a source.
- connectorMetadata
-
- Type: ConnectorMetadata structure
Specifies connector-specific metadata such as
oAuthScopes,supportedRegions,privateLinkServiceUrl, and so on. - isPrivateLinkEnabled
-
- Type: boolean
Specifies if PrivateLink is enabled for that connector.
- isPrivateLinkEndpointUrlRequired
-
- Type: boolean
Specifies if a PrivateLink endpoint URL is required.
- supportedDestinationConnectors
-
- Type: Array of strings
Lists the connectors that are available for use as destinations.
- supportedSchedulingFrequencies
-
- Type: Array of strings
Specifies the supported flow frequency for that connector.
- supportedTriggerTypes
-
- Type: Array of strings
Specifies the supported trigger types for the flow.
ConnectorEntity
Description
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.
Members
- hasNestedEntities
-
- Type: boolean
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. - label
-
- Type: string
The label applied to the connector entity.
- name
-
- Required: Yes
- Type: string
The name of the connector entity.
ConnectorEntityField
Description
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.
Members
- description
-
- Type: string
A description of the connector entity field.
- destinationProperties
-
- Type: DestinationFieldProperties structure
The properties applied to a field when the connector is being used as a destination.
- identifier
-
- Required: Yes
- Type: string
The unique identifier of the connector field.
- label
-
- Type: string
The label applied to a connector entity field.
- sourceProperties
-
- Type: SourceFieldProperties structure
The properties that can be applied to a field when the connector is being used as a source.
- supportedFieldTypeDetails
-
- Type: SupportedFieldTypeDetails structure
Contains details regarding the supported
FieldType, including the correspondingfilterOperatorsandsupportedValues.
ConnectorMetadata
Description
A structure to specify connector-specific metadata such as oAuthScopes, supportedRegions, privateLinkServiceUrl, and so on.
Members
- Amplitude
-
- Type: AmplitudeMetadata structure
The connector metadata specific to Amplitude.
- CustomerProfiles
-
- Type: CustomerProfilesMetadata structure
The connector metadata specific to Amazon Connect Customer Profiles.
- Datadog
-
- Type: DatadogMetadata structure
The connector metadata specific to Datadog.
- Dynatrace
-
- Type: DynatraceMetadata structure
The connector metadata specific to Dynatrace.
- EventBridge
-
- Type: EventBridgeMetadata structure
The connector metadata specific to Amazon EventBridge.
- GoogleAnalytics
-
- Type: GoogleAnalyticsMetadata structure
The connector metadata specific to Google Analytics.
- Honeycode
-
- Type: HoneycodeMetadata structure
The connector metadata specific to Amazon Honeycode.
- InforNexus
-
- Type: InforNexusMetadata structure
The connector metadata specific to Infor Nexus.
- Marketo
-
- Type: MarketoMetadata structure
The connector metadata specific to Marketo.
- Redshift
-
- Type: RedshiftMetadata structure
The connector metadata specific to Amazon Redshift.
- S3
-
- Type: S3Metadata structure
The connector metadata specific to Amazon S3.
- Salesforce
-
- Type: SalesforceMetadata structure
The connector metadata specific to Salesforce.
- ServiceNow
-
- Type: ServiceNowMetadata structure
The connector metadata specific to ServiceNow.
- Singular
-
- Type: SingularMetadata structure
The connector metadata specific to Singular.
- Slack
-
- Type: SlackMetadata structure
The connector metadata specific to Slack.
- Snowflake
-
- Type: SnowflakeMetadata structure
The connector metadata specific to Snowflake.
- Trendmicro
-
- Type: TrendmicroMetadata structure
The connector metadata specific to Trend Micro.
- Upsolver
-
- Type: UpsolverMetadata structure
The connector metadata specific to Upsolver.
- Veeva
-
- Type: VeevaMetadata structure
The connector metadata specific to Veeva.
- Zendesk
-
- Type: ZendeskMetadata structure
The connector metadata specific to Zendesk.
ConnectorOAuthRequest
Description
Used by select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack.
Members
ConnectorOperator
Description
The operation to be performed on the provided source fields.
Members
- Amplitude
-
- Type: string
The operation to be performed on the provided Amplitude source fields.
- Datadog
-
- Type: string
The operation to be performed on the provided Datadog source fields.
- Dynatrace
-
- Type: string
The operation to be performed on the provided Dynatrace source fields.
- GoogleAnalytics
-
- Type: string
The operation to be performed on the provided Google Analytics source fields.
- InforNexus
-
- Type: string
The operation to be performed on the provided Infor Nexus source fields.
- Marketo
-
- Type: string
The operation to be performed on the provided Marketo source fields.
- S3
-
- Type: string
The operation to be performed on the provided Amazon S3 source fields.
- Salesforce
-
- Type: string
The operation to be performed on the provided Salesforce source fields.
- ServiceNow
-
- Type: string
The operation to be performed on the provided ServiceNow source fields.
- Singular
-
- Type: string
The operation to be performed on the provided Singular source fields.
- Slack
-
- Type: string
The operation to be performed on the provided Slack source fields.
- Trendmicro
-
- Type: string
The operation to be performed on the provided Trend Micro source fields.
- Veeva
-
- Type: string
The operation to be performed on the provided Veeva source fields.
- Zendesk
-
- Type: string
The operation to be performed on the provided Zendesk source fields.
ConnectorProfile
Description
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.
Members
- connectionMode
-
- Type: string
Indicates the connection mode and if it is public or private.
- connectorProfileArn
-
- Type: string
The Amazon Resource Name (ARN) of the connector profile.
- connectorProfileName
-
- Type: string
The name of the connector profile. The name is unique for each
ConnectorProfilein the AWS account. - connectorProfileProperties
-
- Type: ConnectorProfileProperties structure
The connector-specific properties of the profile configuration.
- connectorType
-
- Type: string
The type of connector, such as Salesforce, Amplitude, and so on.
- createdAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Specifies when the connector profile was created.
- credentialsArn
-
- Type: string
The Amazon Resource Name (ARN) of the connector profile credentials.
- lastUpdatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Specifies when the connector profile was last updated.
ConnectorProfileConfig
Description
Defines the connector-specific configuration and credentials for the connector profile.
Members
- connectorProfileCredentials
-
- Required: Yes
- Type: ConnectorProfileCredentials structure
The connector-specific credentials required by each connector.
- connectorProfileProperties
-
- Required: Yes
- Type: ConnectorProfileProperties structure
The connector-specific properties of the profile configuration.
ConnectorProfileCredentials
Description
The connector-specific credentials required by a connector.
Members
- Amplitude
-
- Type: AmplitudeConnectorProfileCredentials structure
The connector-specific credentials required when using Amplitude.
- Datadog
-
- Type: DatadogConnectorProfileCredentials structure
The connector-specific credentials required when using Datadog.
- Dynatrace
-
- Type: DynatraceConnectorProfileCredentials structure
The connector-specific credentials required when using Dynatrace.
- GoogleAnalytics
-
- Type: GoogleAnalyticsConnectorProfileCredentials structure
The connector-specific credentials required when using Google Analytics.
- Honeycode
-
- Type: HoneycodeConnectorProfileCredentials structure
The connector-specific credentials required when using Amazon Honeycode.
- InforNexus
-
- Type: InforNexusConnectorProfileCredentials structure
The connector-specific credentials required when using Infor Nexus.
- Marketo
-
- Type: MarketoConnectorProfileCredentials structure
The connector-specific credentials required when using Marketo.
- Redshift
-
- Type: RedshiftConnectorProfileCredentials structure
The connector-specific credentials required when using Amazon Redshift.
- Salesforce
-
- Type: SalesforceConnectorProfileCredentials structure
The connector-specific credentials required when using Salesforce.
- ServiceNow
-
- Type: ServiceNowConnectorProfileCredentials structure
The connector-specific credentials required when using ServiceNow.
- Singular
-
- Type: SingularConnectorProfileCredentials structure
The connector-specific credentials required when using Singular.
- Slack
-
- Type: SlackConnectorProfileCredentials structure
The connector-specific credentials required when using Slack.
- Snowflake
-
- Type: SnowflakeConnectorProfileCredentials structure
The connector-specific credentials required when using Snowflake.
- Trendmicro
-
- Type: TrendmicroConnectorProfileCredentials structure
The connector-specific credentials required when using Trend Micro.
- Veeva
-
- Type: VeevaConnectorProfileCredentials structure
The connector-specific credentials required when using Veeva.
- Zendesk
-
- Type: ZendeskConnectorProfileCredentials structure
The connector-specific credentials required when using Zendesk.
ConnectorProfileProperties
Description
The connector-specific profile properties required by each connector.
Members
- Amplitude
-
- Type: AmplitudeConnectorProfileProperties structure
The connector-specific properties required by Amplitude.
- Datadog
-
- Type: DatadogConnectorProfileProperties structure
The connector-specific properties required by Datadog.
- Dynatrace
-
- Type: DynatraceConnectorProfileProperties structure
The connector-specific properties required by Dynatrace.
- GoogleAnalytics
-
- Type: GoogleAnalyticsConnectorProfileProperties structure
The connector-specific properties required Google Analytics.
- Honeycode
-
- Type: HoneycodeConnectorProfileProperties structure
The connector-specific properties required by Amazon Honeycode.
- InforNexus
-
- Type: InforNexusConnectorProfileProperties structure
The connector-specific properties required by Infor Nexus.
- Marketo
-
- Type: MarketoConnectorProfileProperties structure
The connector-specific properties required by Marketo.
- Redshift
-
- Type: RedshiftConnectorProfileProperties structure
The connector-specific properties required by Amazon Redshift.
- Salesforce
-
- Type: SalesforceConnectorProfileProperties structure
The connector-specific properties required by Salesforce.
- ServiceNow
-
- Type: ServiceNowConnectorProfileProperties structure
The connector-specific properties required by serviceNow.
- Singular
-
- Type: SingularConnectorProfileProperties structure
The connector-specific properties required by Singular.
- Slack
-
- Type: SlackConnectorProfileProperties structure
The connector-specific properties required by Slack.
- Snowflake
-
- Type: SnowflakeConnectorProfileProperties structure
The connector-specific properties required by Snowflake.
- Trendmicro
-
- Type: TrendmicroConnectorProfileProperties structure
The connector-specific properties required by Trend Micro.
- Veeva
-
- Type: VeevaConnectorProfileProperties structure
The connector-specific properties required by Veeva.
- Zendesk
-
- Type: ZendeskConnectorProfileProperties structure
The connector-specific properties required by Zendesk.
ConnectorServerException
Description
An error occurred when retrieving data from the connector endpoint.
Members
CustomerProfilesDestinationProperties
Description
The properties that are applied when Amazon Connect Customer Profiles is used as a destination.
Members
CustomerProfilesMetadata
Description
The connector metadata specific to Amazon Connect Customer Profiles.
Members
DatadogConnectorProfileCredentials
Description
The connector-specific credentials required by Datadog.
Members
- apiKey
-
- Required: Yes
- Type: string
A unique alphanumeric identifier used to authenticate a user, developer, or calling program to your API.
- applicationKey
-
- Required: Yes
- Type: string
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.
DatadogConnectorProfileProperties
Description
The connector-specific profile properties required by Datadog.
Members
DatadogMetadata
Description
The connector metadata specific to Datadog.
Members
DatadogSourceProperties
Description
The properties that are applied when Datadog is being used as a source.
Members
DestinationConnectorProperties
Description
This stores the information that is required to query a particular connector.
Members
- CustomerProfiles
-
- Type: CustomerProfilesDestinationProperties structure
The properties required to query Amazon Connect Customer Profiles.
- EventBridge
-
- Type: EventBridgeDestinationProperties structure
The properties required to query Amazon EventBridge.
- Honeycode
-
- Type: HoneycodeDestinationProperties structure
The properties required to query Amazon Honeycode.
- LookoutMetrics
-
- Type: LookoutMetricsDestinationProperties structure
The properties required to query Amazon Lookout for Metrics.
- Redshift
-
- Type: RedshiftDestinationProperties structure
The properties required to query Amazon Redshift.
- S3
-
- Type: S3DestinationProperties structure
The properties required to query Amazon S3.
- Salesforce
-
- Type: SalesforceDestinationProperties structure
The properties required to query Salesforce.
- Snowflake
-
- Type: SnowflakeDestinationProperties structure
The properties required to query Snowflake.
- Upsolver
-
- Type: UpsolverDestinationProperties structure
The properties required to query Upsolver.
- Zendesk
-
- Type: ZendeskDestinationProperties structure
DestinationFieldProperties
Description
The properties that can be applied to a field when connector is being used as a destination.
Members
- isCreatable
-
- Type: boolean
Specifies if the destination field can be created by the current user.
- isNullable
-
- Type: boolean
Specifies if the destination field can have a null value.
- isUpdatable
-
- Type: boolean
Specifies whether the field can be updated during an
UPDATEorUPSERTwrite operation. - isUpsertable
-
- Type: boolean
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.
- supportedWriteOperations
-
- Type: Array of strings
A list of supported write operations. For each write operation listed, this field can be used in
idFieldNameswhen that write operation is present as a destination option.
DestinationFlowConfig
Description
Contains information about the configuration of destination connectors present in the flow.
Members
- connectorProfileName
-
- Type: string
The name of the connector profile. This name must be unique for each connector profile in the AWS account.
- connectorType
-
- Required: Yes
- Type: string
The type of connector, such as Salesforce, Amplitude, and so on.
- destinationConnectorProperties
-
- Required: Yes
- Type: DestinationConnectorProperties structure
This stores the information that is required to query a particular connector.
DynatraceConnectorProfileCredentials
Description
The connector-specific profile credentials required by Dynatrace.
Members
DynatraceConnectorProfileProperties
Description
The connector-specific profile properties required by Dynatrace.
Members
DynatraceMetadata
Description
The connector metadata specific to Dynatrace.
Members
DynatraceSourceProperties
Description
The properties that are applied when Dynatrace is being used as a source.
Members
ErrorHandlingConfig
Description
The settings that determine how Amazon AppFlow handles an error when placing data in the 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.
Members
ErrorInfo
Description
Provides details in the event of a failed flow, including the failure count and the related error messages.
Members
EventBridgeDestinationProperties
Description
The properties that are applied when Amazon EventBridge is being used as a destination.
Members
- errorHandlingConfig
-
- Type: ErrorHandlingConfig structure
The settings that determine how Amazon AppFlow handles an error when placing data in the 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.
ErrorHandlingConfigis a part of the destination connector details. - object
-
- Required: Yes
- Type: string
The object specified in the Amazon EventBridge flow destination.
EventBridgeMetadata
Description
The connector metadata specific to Amazon EventBridge.
Members
ExecutionDetails
Description
Describes the details of the flow run, including the timestamp, status, and message.
Members
- mostRecentExecutionMessage
-
- Type: string
Describes the details of the most recent flow run.
- mostRecentExecutionStatus
-
- Type: string
Specifies the status of the most recent flow run.
- mostRecentExecutionTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Specifies the time of the most recent flow run.
ExecutionRecord
Description
Specifies information about the past flow run instances for a given flow.
Members
- dataPullEndTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp that indicates the last new or updated record to be transferred in the flow run.
- dataPullStartTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp that determines the first new or updated record to be transferred in the flow run.
- executionId
-
- Type: string
Specifies the identifier of the given flow run.
- executionResult
-
- Type: ExecutionResult structure
Describes the result of the given flow run.
- executionStatus
-
- Type: string
Specifies the flow run status and whether it is in progress, has completed successfully, or has failed.
- lastUpdatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Specifies the time of the most recent update.
- startedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Specifies the start time of the flow run.
ExecutionResult
Description
Specifies the end result of the flow run.
Members
- bytesProcessed
-
- Type: long (int|float)
The total number of bytes processed by the flow run.
- bytesWritten
-
- Type: long (int|float)
The total number of bytes written as a result of the flow run.
- errorInfo
-
- Type: ErrorInfo structure
Provides any error message information related to the flow run.
- recordsProcessed
-
- Type: long (int|float)
The number of records processed in the flow run.
FieldTypeDetails
Description
Contains details regarding the supported field type and the operators that can be applied for filtering.
Members
- fieldType
-
- Required: Yes
- Type: string
The type of field, such as string, integer, date, and so on.
- filterOperators
-
- Required: Yes
- Type: Array of strings
The list of operators supported by a field.
- supportedValues
-
- Type: Array of strings
The list of values that a field can contain. For example, a Boolean
fieldTypecan have two values: "true" and "false".
FlowDefinition
Description
The properties of the flow, such as its source, destination, trigger type, and so on.
Members
- createdAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Specifies when the flow was created.
- createdBy
-
- Type: string
The ARN of the user who created the flow.
- description
-
- Type: string
A user-entered description of the flow.
- destinationConnectorType
-
- Type: string
Specifies the destination connector type, such as Salesforce, Amazon S3, Amplitude, and so on.
- flowArn
-
- Type: string
The flow's Amazon Resource Name (ARN).
- flowName
-
- Type: string
The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
- flowStatus
-
- Type: string
Indicates the current status of the flow.
- lastRunExecutionDetails
-
- Type: ExecutionDetails structure
Describes the details of the most recent flow run.
- lastUpdatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Specifies when the flow was last updated.
- lastUpdatedBy
-
- Type: string
Specifies the account user name that most recently updated the flow.
- sourceConnectorType
-
- Type: string
Specifies the source connector type, such as Salesforce, Amazon S3, Amplitude, and so on.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for your flow.
- triggerType
-
- Type: string
Specifies the type of flow trigger. This can be
OnDemand,Scheduled, orEvent.
GoogleAnalyticsConnectorProfileCredentials
Description
The connector-specific profile credentials required by Google Analytics.
Members
- accessToken
-
- Type: string
The credentials used to access protected Google Analytics resources.
- clientId
-
- Required: Yes
- Type: string
The identifier for the desired client.
- clientSecret
-
- Required: Yes
- Type: string
The client secret used by the OAuth client to authenticate to the authorization server.
- oAuthRequest
-
- Type: ConnectorOAuthRequest structure
The OAuth requirement needed to request security tokens from the connector endpoint.
- refreshToken
-
- Type: string
The credentials used to acquire new access tokens. This is required only for OAuth2 access tokens, and is not required for OAuth1 access tokens.
GoogleAnalyticsConnectorProfileProperties
Description
The connector-specific profile properties required by Google Analytics.
Members
GoogleAnalyticsMetadata
Description
The connector metadata specific to Google Analytics.
Members
GoogleAnalyticsSourceProperties
Description
The properties that are applied when Google Analytics is being used as a source.
Members
HoneycodeConnectorProfileCredentials
Description
The connector-specific credentials required when using Amazon Honeycode.
Members
- accessToken
-
- Type: string
The credentials used to access protected Amazon Honeycode resources.
- oAuthRequest
-
- Type: ConnectorOAuthRequest structure
Used by select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack.
- refreshToken
-
- Type: string
The credentials used to acquire new access tokens.
HoneycodeConnectorProfileProperties
Description
The connector-specific properties required when using Amazon Honeycode.
Members
HoneycodeDestinationProperties
Description
The properties that are applied when Amazon Honeycode is used as a destination.
Members
- errorHandlingConfig
-
- Type: ErrorHandlingConfig structure
The settings that determine how Amazon AppFlow handles an error when placing data in the 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.
ErrorHandlingConfigis a part of the destination connector details. - object
-
- Required: Yes
- Type: string
The object specified in the Amazon Honeycode flow destination.
HoneycodeMetadata
Description
The connector metadata specific to Amazon Honeycode.
Members
IncrementalPullConfig
Description
Specifies the configuration used when importing incremental records from the source.
Members
InforNexusConnectorProfileCredentials
Description
The connector-specific profile credentials required by Infor Nexus.
Members
- accessKeyId
-
- Required: Yes
- Type: string
The Access Key portion of the credentials.
- datakey
-
- Required: Yes
- Type: string
The encryption keys used to encrypt data.
- secretAccessKey
-
- Required: Yes
- Type: string
The secret key used to sign requests.
- userId
-
- Required: Yes
- Type: string
The identifier for the user.
InforNexusConnectorProfileProperties
Description
The connector-specific profile properties required by Infor Nexus.
Members
InforNexusMetadata
Description
The connector metadata specific to Infor Nexus.
Members
InforNexusSourceProperties
Description
The properties that are applied when Infor Nexus is being used as a source.
Members
InternalServerException
Description
An internal service error occurred during the processing of your request. Try again later.
Members
LookoutMetricsDestinationProperties
Description
The properties that are applied when Amazon Lookout for Metrics is used as a destination.
Members
MarketoConnectorProfileCredentials
Description
The connector-specific profile credentials required by Marketo.
Members
- accessToken
-
- Type: string
The credentials used to access protected Marketo resources.
- clientId
-
- Required: Yes
- Type: string
The identifier for the desired client.
- clientSecret
-
- Required: Yes
- Type: string
The client secret used by the OAuth client to authenticate to the authorization server.
- oAuthRequest
-
- Type: ConnectorOAuthRequest structure
The OAuth requirement needed to request security tokens from the connector endpoint.
MarketoConnectorProfileProperties
Description
The connector-specific profile properties required when using Marketo.
Members
MarketoMetadata
Description
The connector metadata specific to Marketo.
Members
MarketoSourceProperties
Description
The properties that are applied when Marketo is being used as a source.
Members
PrefixConfig
Description
Determines the prefix that Amazon AppFlow applies to the destination folder name. You can name your destination folders according to the flow frequency and date.
Members
RedshiftConnectorProfileCredentials
Description
The connector-specific profile credentials required when using Amazon Redshift.
Members
RedshiftConnectorProfileProperties
Description
The connector-specific profile properties when using Amazon Redshift.
Members
- bucketName
-
- Required: Yes
- Type: string
A name for the associated Amazon S3 bucket.
- bucketPrefix
-
- Type: string
The object key for the destination bucket in which Amazon AppFlow places the files.
- databaseUrl
-
- Required: Yes
- Type: string
The JDBC URL of the Amazon Redshift cluster.
- roleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the IAM role.
RedshiftDestinationProperties
Description
The properties that are applied when Amazon Redshift is being used as a destination.
Members
- bucketPrefix
-
- Type: string
The object key for the bucket in which Amazon AppFlow places the destination files.
- errorHandlingConfig
-
- Type: ErrorHandlingConfig structure
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.
ErrorHandlingConfigis a part of the destination connector details. - intermediateBucketName
-
- Required: Yes
- Type: string
The intermediate bucket that Amazon AppFlow uses when moving data into Amazon Redshift.
- object
-
- Required: Yes
- Type: string
The object specified in the Amazon Redshift flow destination.
RedshiftMetadata
Description
The connector metadata specific to Amazon Redshift.
Members
ResourceNotFoundException
Description
The resource specified in the request (such as the source or destination connector profile) is not found.
Members
S3DestinationProperties
Description
The properties that are applied when Amazon S3 is used as a destination.
Members
- bucketName
-
- Required: Yes
- Type: string
The Amazon S3 bucket name in which Amazon AppFlow places the transferred data.
- bucketPrefix
-
- Type: string
The object key for the destination bucket in which Amazon AppFlow places the files.
- s3OutputFormatConfig
-
- Type: S3OutputFormatConfig structure
The configuration that determines how Amazon AppFlow should format the flow output data when Amazon S3 is used as the destination.
S3Metadata
Description
The connector metadata specific to Amazon S3.
Members
S3OutputFormatConfig
Description
The configuration that determines how Amazon AppFlow should format the flow output data when Amazon S3 is used as the destination.
Members
- aggregationConfig
-
- Type: AggregationConfig structure
The aggregation settings that you can use to customize the output format of your flow data.
- fileType
-
- Type: string
Indicates the file type that Amazon AppFlow places in the Amazon S3 bucket.
- prefixConfig
-
- Type: PrefixConfig structure
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.
S3SourceProperties
Description
The properties that are applied when Amazon S3 is being used as the flow source.
Members
SalesforceConnectorProfileCredentials
Description
The connector-specific profile credentials required when using Salesforce.
Members
- accessToken
-
- Type: string
The credentials used to access protected Salesforce resources.
- clientCredentialsArn
-
- Type: string
The secret manager ARN, which contains the client ID and client secret of the connected app.
- oAuthRequest
-
- Type: ConnectorOAuthRequest structure
The OAuth requirement needed to request security tokens from the connector endpoint.
- refreshToken
-
- Type: string
The credentials used to acquire new access tokens.
SalesforceConnectorProfileProperties
Description
The connector-specific profile properties required when using Salesforce.
Members
SalesforceDestinationProperties
Description
The properties that are applied when Salesforce is being used as a destination.
Members
- errorHandlingConfig
-
- Type: ErrorHandlingConfig structure
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.
ErrorHandlingConfigis a part of the destination connector details. - idFieldNames
-
- Type: Array of strings
The name of the field that Amazon AppFlow uses as an ID when performing a write operation such as update or delete.
- object
-
- Required: Yes
- Type: string
The object specified in the Salesforce flow destination.
- writeOperationType
-
- Type: string
This specifies the type of write operation to be performed in Salesforce. When the value is
UPSERT, thenidFieldNamesis required.
SalesforceMetadata
Description
The connector metadata specific to Salesforce.
Members
SalesforceSourceProperties
Description
The properties that are applied when Salesforce is being used as a source.
Members
- enableDynamicFieldUpdate
-
- Type: boolean
The flag that enables dynamic fetching of new (recently added) fields in the Salesforce objects while running a flow.
- includeDeletedRecords
-
- Type: boolean
Indicates whether Amazon AppFlow includes deleted files in the flow run.
- object
-
- Required: Yes
- Type: string
The object specified in the Salesforce flow source.
ScheduledTriggerProperties
Description
Specifies the configuration details of a schedule-triggered flow as defined by the user. Currently, these settings only apply to the Scheduled trigger type.
Members
- dataPullMode
-
- Type: string
Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run.
- firstExecutionFrom
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Specifies the date range for the records to import from the connector in the first flow run.
- scheduleEndTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Specifies the scheduled end time for a schedule-triggered flow.
- scheduleExpression
-
- Required: Yes
- Type: string
The scheduling expression that determines the rate at which the schedule will run, for example
rate(5minutes). - scheduleOffset
-
- Type: long (int|float)
Specifies the optional offset that is added to the time interval for a schedule-triggered flow.
- scheduleStartTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Specifies the scheduled start time for a schedule-triggered flow.
- timezone
-
- Type: string
Specifies the time zone used when referring to the date and time of a scheduled-triggered flow, such as
America/New_York.
ServiceNowConnectorProfileCredentials
Description
The connector-specific profile credentials required when using ServiceNow.
Members
ServiceNowConnectorProfileProperties
Description
The connector-specific profile properties required when using ServiceNow.
Members
ServiceNowMetadata
Description
The connector metadata specific to ServiceNow.
Members
ServiceNowSourceProperties
Description
The properties that are applied when ServiceNow is being used as a source.
Members
ServiceQuotaExceededException
Description
The request would cause a service quota (such as the number of flows) to be exceeded.
Members
SingularConnectorProfileCredentials
Description
The connector-specific profile credentials required when using Singular.
Members
SingularConnectorProfileProperties
Description
The connector-specific profile properties required when using Singular.
Members
SingularMetadata
Description
The connector metadata specific to Singular.
Members
SingularSourceProperties
Description
The properties that are applied when Singular is being used as a source.
Members
SlackConnectorProfileCredentials
Description
The connector-specific profile credentials required when using Slack.
Members
- accessToken
-
- Type: string
The credentials used to access protected Slack resources.
- clientId
-
- Required: Yes
- Type: string
The identifier for the client.
- clientSecret
-
- Required: Yes
- Type: string
The client secret used by the OAuth client to authenticate to the authorization server.
- oAuthRequest
-
- Type: ConnectorOAuthRequest structure
The OAuth requirement needed to request security tokens from the connector endpoint.
SlackConnectorProfileProperties
Description
The connector-specific profile properties required when using Slack.
Members
SlackMetadata
Description
The connector metadata specific to Slack.
Members
SlackSourceProperties
Description
The properties that are applied when Slack is being used as a source.
Members
SnowflakeConnectorProfileCredentials
Description
The connector-specific profile credentials required when using Snowflake.
Members
SnowflakeConnectorProfileProperties
Description
The connector-specific profile properties required when using Snowflake.
Members
- accountName
-
- Type: string
The name of the account.
- bucketName
-
- Required: Yes
- Type: string
The name of the Amazon S3 bucket associated with Snowflake.
- bucketPrefix
-
- Type: string
The bucket path that refers to the Amazon S3 bucket associated with Snowflake.
- privateLinkServiceName
-
- Type: string
The Snowflake Private Link service name to be used for private data transfers.
- region
-
- Type: string
The AWS Region of the Snowflake account.
- stage
-
- Required: Yes
- Type: string
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>.
- warehouse
-
- Required: Yes
- Type: string
The name of the Snowflake warehouse.
SnowflakeDestinationProperties
Description
The properties that are applied when Snowflake is being used as a destination.
Members
- bucketPrefix
-
- Type: string
The object key for the destination bucket in which Amazon AppFlow places the files.
- errorHandlingConfig
-
- Type: ErrorHandlingConfig structure
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.
ErrorHandlingConfigis a part of the destination connector details. - intermediateBucketName
-
- Required: Yes
- Type: string
The intermediate bucket that Amazon AppFlow uses when moving data into Snowflake.
- object
-
- Required: Yes
- Type: string
The object specified in the Snowflake flow destination.
SnowflakeMetadata
Description
The connector metadata specific to Snowflake.
Members
SourceConnectorProperties
Description
Specifies the information that is required to query a particular connector.
Members
- Amplitude
-
- Type: AmplitudeSourceProperties structure
Specifies the information that is required for querying Amplitude.
- Datadog
-
- Type: DatadogSourceProperties structure
Specifies the information that is required for querying Datadog.
- Dynatrace
-
- Type: DynatraceSourceProperties structure
Specifies the information that is required for querying Dynatrace.
- GoogleAnalytics
-
- Type: GoogleAnalyticsSourceProperties structure
Specifies the information that is required for querying Google Analytics.
- InforNexus
-
- Type: InforNexusSourceProperties structure
Specifies the information that is required for querying Infor Nexus.
- Marketo
-
- Type: MarketoSourceProperties structure
Specifies the information that is required for querying Marketo.
- S3
-
- Type: S3SourceProperties structure
Specifies the information that is required for querying Amazon S3.
- Salesforce
-
- Type: SalesforceSourceProperties structure
Specifies the information that is required for querying Salesforce.
- ServiceNow
-
- Type: ServiceNowSourceProperties structure
Specifies the information that is required for querying ServiceNow.
- Singular
-
- Type: SingularSourceProperties structure
Specifies the information that is required for querying Singular.
- Slack
-
- Type: SlackSourceProperties structure
Specifies the information that is required for querying Slack.
- Trendmicro
-
- Type: TrendmicroSourceProperties structure
Specifies the information that is required for querying Trend Micro.
- Veeva
-
- Type: VeevaSourceProperties structure
Specifies the information that is required for querying Veeva.
- Zendesk
-
- Type: ZendeskSourceProperties structure
Specifies the information that is required for querying Zendesk.
SourceFieldProperties
Description
The properties that can be applied to a field when the connector is being used as a source.
Members
SourceFlowConfig
Description
Contains information about the configuration of the source connector used in the flow.
Members
- connectorProfileName
-
- Type: string
The name of the connector profile. This name must be unique for each connector profile in the AWS account.
- connectorType
-
- Required: Yes
- Type: string
The type of connector, such as Salesforce, Amplitude, and so on.
- incrementalPullConfig
-
- Type: IncrementalPullConfig structure
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.
- sourceConnectorProperties
-
- Required: Yes
- Type: SourceConnectorProperties structure
Specifies the information that is required to query a particular source connector.
SupportedFieldTypeDetails
Description
Contains details regarding all the supported FieldTypes and their corresponding filterOperators and supportedValues.
Members
- v1
-
- Required: Yes
- Type: FieldTypeDetails structure
The initial supported version for
fieldType. If this is later changed to a different version, v2 will be introduced.
Task
Description
A class for modeling different type of tasks. Task implementation varies based on the TaskType.
Members
- connectorOperator
-
- Type: ConnectorOperator structure
The operation to be performed on the provided source fields.
- destinationField
-
- Type: string
A field in a destination connector, or a field value against which Amazon AppFlow validates a source field.
- sourceFields
-
- Required: Yes
- Type: Array of strings
The source fields to which a particular task is applied.
- taskProperties
-
- Type: Associative array of custom strings keys (OperatorPropertiesKeys) to strings
A map used to store task-related information. The execution service looks for particular information based on the
TaskType. - taskType
-
- Required: Yes
- Type: string
Specifies the particular task implementation that Amazon AppFlow performs.
TrendmicroConnectorProfileCredentials
Description
The connector-specific profile credentials required when using Trend Micro.
Members
TrendmicroConnectorProfileProperties
Description
The connector-specific profile properties required when using Trend Micro.
Members
TrendmicroMetadata
Description
The connector metadata specific to Trend Micro.
Members
TrendmicroSourceProperties
Description
The properties that are applied when using Trend Micro as a flow source.
Members
TriggerConfig
Description
The trigger settings that determine how and when Amazon AppFlow runs the specified flow.
Members
- triggerProperties
-
- Type: TriggerProperties structure
Specifies the configuration details of a schedule-triggered flow as defined by the user. Currently, these settings only apply to the
Scheduledtrigger type. - triggerType
-
- Required: Yes
- Type: string
Specifies the type of flow trigger. This can be
OnDemand,Scheduled, orEvent.
TriggerProperties
Description
Specifies the configuration details that control the trigger for a flow. Currently, these settings only apply to the Scheduled trigger type.
Members
- Scheduled
-
- Type: ScheduledTriggerProperties structure
Specifies the configuration details of a schedule-triggered flow as defined by the user.
UnsupportedOperationException
Description
The requested operation is not supported for the current flow.
Members
UpsolverDestinationProperties
Description
The properties that are applied when Upsolver is used as a destination.
Members
- bucketName
-
- Required: Yes
- Type: string
The Upsolver Amazon S3 bucket name in which Amazon AppFlow places the transferred data.
- bucketPrefix
-
- Type: string
The object key for the destination Upsolver Amazon S3 bucket in which Amazon AppFlow places the files.
- s3OutputFormatConfig
-
- Required: Yes
- Type: UpsolverS3OutputFormatConfig structure
The configuration that determines how data is formatted when Upsolver is used as the flow destination.
UpsolverMetadata
Description
The connector metadata specific to Upsolver.
Members
UpsolverS3OutputFormatConfig
Description
The configuration that determines how Amazon AppFlow formats the flow output data when Upsolver is used as the destination.
Members
- aggregationConfig
-
- Type: AggregationConfig structure
The aggregation settings that you can use to customize the output format of your flow data.
- fileType
-
- Type: string
Indicates the file type that Amazon AppFlow places in the Upsolver Amazon S3 bucket.
- prefixConfig
-
- Required: Yes
- Type: PrefixConfig structure
Determines the prefix that Amazon AppFlow applies to the destination folder name. You can name your destination folders according to the flow frequency and date.
ValidationException
VeevaConnectorProfileCredentials
Description
The connector-specific profile credentials required when using Veeva.
Members
VeevaConnectorProfileProperties
Description
The connector-specific profile properties required when using Veeva.
Members
VeevaMetadata
Description
The connector metadata specific to Veeva.
Members
VeevaSourceProperties
Description
The properties that are applied when using Veeva as a flow source.
Members
ZendeskConnectorProfileCredentials
Description
The connector-specific profile credentials required when using Zendesk.
Members
- accessToken
-
- Type: string
The credentials used to access protected Zendesk resources.
- clientId
-
- Required: Yes
- Type: string
The identifier for the desired client.
- clientSecret
-
- Required: Yes
- Type: string
The client secret used by the OAuth client to authenticate to the authorization server.
- oAuthRequest
-
- Type: ConnectorOAuthRequest structure
The OAuth requirement needed to request security tokens from the connector endpoint.
ZendeskConnectorProfileProperties
Description
The connector-specific profile properties required when using Zendesk.
Members
ZendeskDestinationProperties
Members
- errorHandlingConfig
-
- Type: ErrorHandlingConfig structure
The settings that determine how Amazon AppFlow handles an error when placing data in the 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.
ErrorHandlingConfigis a part of the destination connector details. - idFieldNames
-
- Type: Array of strings
A list of field names that can be used as an ID field when performing a write operation.
- object
-
- Required: Yes
- Type: string
- writeOperationType
-
- Type: string
The possible write operations in the destination connector. When this value is not provided, this defaults to the
INSERToperation.
ZendeskMetadata
Description
The connector metadata specific to Zendesk.