CancelFlowExecutions

$result = $client->cancelFlowExecutions([/* ... */]);
$promise = $client->cancelFlowExecutionsAsync([/* ... */]);

Cancels active runs for a flow.

You can cancel all of the active runs for a flow, or you can cancel specific runs by providing their IDs.

You can cancel a flow run only when the run is in progress. You can't cancel a run that has already completed or failed. You also can't cancel a run that's scheduled to occur but hasn't started yet. To prevent a scheduled run, you can deactivate the flow with the StopFlow action.

You cannot resume a run after you cancel it.

When you send your request, the status for each run becomes CancelStarted. When the cancellation completes, the status becomes Canceled.

Parameter Syntax

$result = $client->cancelFlowExecutions([
    'executionIds' => ['<string>', ...],
    'flowName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'invalidExecutions' => ['<string>', ...],
]

Result Details

Errors

ValidationException:

The request has invalid or missing parameters.

AccessDeniedException:

AppFlow/Requester has invalid or missing permissions.

ResourceNotFoundException:

The resource specified in the request (such as the source or destination connector profile) is not found.

ThrottlingException:

API calls have exceeded the maximum allowed API request rate per account and per Region.

InternalServerException:

An internal service error occurred during the processing of your request. Try again later.

CreateConnectorProfile

$result = $client->createConnectorProfile([/* ... */]);
$promise = $client->createConnectorProfileAsync([/* ... */]);

Creates a new connector profile associated with your Amazon Web Services account. There is a soft quota of 100 connector profiles per Amazon Web Services account. If you need more connector profiles than this quota allows, you can submit a request to the Amazon AppFlow team through the Amazon AppFlow support channel. In each connector profile that you create, you can provide the credentials and properties for only one connector.

Parameter Syntax

$result = $client->createConnectorProfile([
    'clientToken' => '<string>',
    'connectionMode' => 'Public|Private', // REQUIRED
    'connectorLabel' => '<string>',
    'connectorProfileConfig' => [ // REQUIRED
        'connectorProfileCredentials' => [
            'Amplitude' => [
                'apiKey' => '<string>', // REQUIRED
                'secretKey' => '<string>', // REQUIRED
            ],
            'CustomConnector' => [
                'apiKey' => [
                    'apiKey' => '<string>', // REQUIRED
                    'apiSecretKey' => '<string>',
                ],
                'authenticationType' => 'OAUTH2|APIKEY|BASIC|CUSTOM', // REQUIRED
                'basic' => [
                    'password' => '<string>', // REQUIRED
                    'username' => '<string>', // REQUIRED
                ],
                'custom' => [
                    'credentialsMap' => ['<string>', ...],
                    'customAuthenticationType' => '<string>', // REQUIRED
                ],
                'oauth2' => [
                    'accessToken' => '<string>',
                    'clientId' => '<string>',
                    'clientSecret' => '<string>',
                    'oAuthRequest' => [
                        'authCode' => '<string>',
                        'redirectUri' => '<string>',
                    ],
                    'refreshToken' => '<string>',
                ],
            ],
            '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>',
                ],
            ],
            'Pardot' => [
                'accessToken' => '<string>',
                'clientCredentialsArn' => '<string>',
                'oAuthRequest' => [
                    'authCode' => '<string>',
                    'redirectUri' => '<string>',
                ],
                'refreshToken' => '<string>',
            ],
            'Redshift' => [
                'password' => '<string>',
                'username' => '<string>',
            ],
            'SAPOData' => [
                'basicAuthCredentials' => [
                    'password' => '<string>', // REQUIRED
                    'username' => '<string>', // REQUIRED
                ],
                'oAuthCredentials' => [
                    'accessToken' => '<string>',
                    'clientId' => '<string>', // REQUIRED
                    'clientSecret' => '<string>', // REQUIRED
                    'oAuthRequest' => [
                        'authCode' => '<string>',
                        'redirectUri' => '<string>',
                    ],
                    'refreshToken' => '<string>',
                ],
            ],
            'Salesforce' => [
                'accessToken' => '<string>',
                'clientCredentialsArn' => '<string>',
                'jwtToken' => '<string>',
                'oAuth2GrantType' => 'CLIENT_CREDENTIALS|AUTHORIZATION_CODE|JWT_BEARER',
                'oAuthRequest' => [
                    'authCode' => '<string>',
                    'redirectUri' => '<string>',
                ],
                'refreshToken' => '<string>',
            ],
            'ServiceNow' => [
                'oAuth2Credentials' => [
                    'accessToken' => '<string>',
                    'clientId' => '<string>',
                    'clientSecret' => '<string>',
                    'oAuthRequest' => [
                        'authCode' => '<string>',
                        'redirectUri' => '<string>',
                    ],
                    'refreshToken' => '<string>',
                ],
                'password' => '<string>',
                'username' => '<string>',
            ],
            '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' => [
            ],
            'CustomConnector' => [
                'oAuth2Properties' => [
                    'oAuth2GrantType' => 'CLIENT_CREDENTIALS|AUTHORIZATION_CODE|JWT_BEARER', // REQUIRED
                    'tokenUrl' => '<string>', // REQUIRED
                    'tokenUrlCustomProperties' => ['<string>', ...],
                ],
                'profileProperties' => ['<string>', ...],
            ],
            'Datadog' => [
                'instanceUrl' => '<string>', // REQUIRED
            ],
            'Dynatrace' => [
                'instanceUrl' => '<string>', // REQUIRED
            ],
            'GoogleAnalytics' => [
            ],
            'Honeycode' => [
            ],
            'InforNexus' => [
                'instanceUrl' => '<string>', // REQUIRED
            ],
            'Marketo' => [
                'instanceUrl' => '<string>', // REQUIRED
            ],
            'Pardot' => [
                'businessUnitId' => '<string>',
                'instanceUrl' => '<string>',
                'isSandboxEnvironment' => true || false,
            ],
            'Redshift' => [
                'bucketName' => '<string>', // REQUIRED
                'bucketPrefix' => '<string>',
                'clusterIdentifier' => '<string>',
                'dataApiRoleArn' => '<string>',
                'databaseName' => '<string>',
                'databaseUrl' => '<string>',
                'isRedshiftServerless' => true || false,
                'roleArn' => '<string>', // REQUIRED
                'workgroupName' => '<string>',
            ],
            'SAPOData' => [
                'applicationHostUrl' => '<string>', // REQUIRED
                'applicationServicePath' => '<string>', // REQUIRED
                'clientNumber' => '<string>', // REQUIRED
                'disableSSO' => true || false,
                'logonLanguage' => '<string>',
                'oAuthProperties' => [
                    'authCodeUrl' => '<string>', // REQUIRED
                    'oAuthScopes' => ['<string>', ...], // REQUIRED
                    'tokenUrl' => '<string>', // REQUIRED
                ],
                'portNumber' => <integer>, // REQUIRED
                'privateLinkServiceName' => '<string>',
            ],
            'Salesforce' => [
                'instanceUrl' => '<string>',
                'isSandboxEnvironment' => true || false,
                'usePrivateLinkForMetadataAndAuthorization' => 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|SAPOData|CustomConnector|Pardot', // REQUIRED
    'kmsArn' => '<string>',
]);

Parameter Details

Result Syntax

[
    'connectorProfileArn' => '<string>',
]

Result Details

Errors

ValidationException:

The request has invalid or missing parameters.

ConflictException:

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.

InternalServerException:

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([
    'clientToken' => '<string>',
    'description' => '<string>',
    'destinationFlowConfigList' => [ // REQUIRED
        [
            'apiVersion' => '<string>',
            'connectorProfileName' => '<string>',
            'connectorType' => 'Salesforce|Singular|Slack|Redshift|S3|Marketo|Googleanalytics|Zendesk|Servicenow|Datadog|Trendmicro|Snowflake|Dynatrace|Infornexus|Amplitude|Veeva|EventBridge|LookoutMetrics|Upsolver|Honeycode|CustomerProfiles|SAPOData|CustomConnector|Pardot', // REQUIRED
            'destinationConnectorProperties' => [ // REQUIRED
                'CustomConnector' => [
                    'customProperties' => ['<string>', ...],
                    'entityName' => '<string>', // REQUIRED
                    'errorHandlingConfig' => [
                        'bucketName' => '<string>',
                        'bucketPrefix' => '<string>',
                        'failOnFirstDestinationError' => true || false,
                    ],
                    'idFieldNames' => ['<string>', ...],
                    'writeOperationType' => 'INSERT|UPSERT|UPDATE|DELETE',
                ],
                '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' => [
                ],
                'Marketo' => [
                    'errorHandlingConfig' => [
                        'bucketName' => '<string>',
                        'bucketPrefix' => '<string>',
                        'failOnFirstDestinationError' => true || false,
                    ],
                    'object' => '<string>', // REQUIRED
                ],
                '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',
                            'targetFileSize' => <integer>,
                        ],
                        'fileType' => 'CSV|JSON|PARQUET',
                        'prefixConfig' => [
                            'pathPrefixHierarchy' => ['<string>', ...],
                            'prefixFormat' => 'YEAR|MONTH|DAY|HOUR|MINUTE',
                            'prefixType' => 'FILENAME|PATH|PATH_AND_FILENAME',
                        ],
                        'preserveSourceDataTyping' => true || false,
                    ],
                ],
                'SAPOData' => [
                    'errorHandlingConfig' => [
                        'bucketName' => '<string>',
                        'bucketPrefix' => '<string>',
                        'failOnFirstDestinationError' => true || false,
                    ],
                    'idFieldNames' => ['<string>', ...],
                    'objectPath' => '<string>', // REQUIRED
                    'successResponseHandlingConfig' => [
                        'bucketName' => '<string>',
                        'bucketPrefix' => '<string>',
                    ],
                    'writeOperationType' => 'INSERT|UPSERT|UPDATE|DELETE',
                ],
                'Salesforce' => [
                    'dataTransferApi' => 'AUTOMATIC|BULKV2|REST_SYNC',
                    'errorHandlingConfig' => [
                        'bucketName' => '<string>',
                        'bucketPrefix' => '<string>',
                        'failOnFirstDestinationError' => true || false,
                    ],
                    'idFieldNames' => ['<string>', ...],
                    'object' => '<string>', // REQUIRED
                    'writeOperationType' => 'INSERT|UPSERT|UPDATE|DELETE',
                ],
                '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',
                            'targetFileSize' => <integer>,
                        ],
                        'fileType' => 'CSV|JSON|PARQUET',
                        'prefixConfig' => [ // REQUIRED
                            'pathPrefixHierarchy' => ['<string>', ...],
                            '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|DELETE',
                ],
            ],
        ],
        // ...
    ],
    'flowName' => '<string>', // REQUIRED
    'kmsArn' => '<string>',
    'metadataCatalogConfig' => [
        'glueDataCatalog' => [
            'databaseName' => '<string>', // REQUIRED
            'roleArn' => '<string>', // REQUIRED
            'tablePrefix' => '<string>', // REQUIRED
        ],
    ],
    'sourceFlowConfig' => [ // REQUIRED
        'apiVersion' => '<string>',
        'connectorProfileName' => '<string>',
        'connectorType' => 'Salesforce|Singular|Slack|Redshift|S3|Marketo|Googleanalytics|Zendesk|Servicenow|Datadog|Trendmicro|Snowflake|Dynatrace|Infornexus|Amplitude|Veeva|EventBridge|LookoutMetrics|Upsolver|Honeycode|CustomerProfiles|SAPOData|CustomConnector|Pardot', // REQUIRED
        'incrementalPullConfig' => [
            'datetimeTypeFieldName' => '<string>',
        ],
        'sourceConnectorProperties' => [ // REQUIRED
            'Amplitude' => [
                'object' => '<string>', // REQUIRED
            ],
            'CustomConnector' => [
                'customProperties' => ['<string>', ...],
                'dataTransferApi' => [
                    'Name' => '<string>',
                    'Type' => 'SYNC|ASYNC|AUTOMATIC',
                ],
                'entityName' => '<string>', // REQUIRED
            ],
            'Datadog' => [
                'object' => '<string>', // REQUIRED
            ],
            'Dynatrace' => [
                'object' => '<string>', // REQUIRED
            ],
            'GoogleAnalytics' => [
                'object' => '<string>', // REQUIRED
            ],
            'InforNexus' => [
                'object' => '<string>', // REQUIRED
            ],
            'Marketo' => [
                'object' => '<string>', // REQUIRED
            ],
            'Pardot' => [
                'object' => '<string>', // REQUIRED
            ],
            'S3' => [
                'bucketName' => '<string>', // REQUIRED
                'bucketPrefix' => '<string>',
                's3InputFormatConfig' => [
                    's3InputFileType' => 'CSV|JSON',
                ],
            ],
            'SAPOData' => [
                'objectPath' => '<string>',
                'paginationConfig' => [
                    'maxPageSize' => <integer>, // REQUIRED
                ],
                'parallelismConfig' => [
                    'maxParallelism' => <integer>, // REQUIRED
                ],
            ],
            'Salesforce' => [
                'dataTransferApi' => 'AUTOMATIC|BULKV2|REST_SYNC',
                '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' => [
                'documentType' => '<string>',
                'includeAllVersions' => true || false,
                'includeRenditions' => true || false,
                'includeSourceFiles' => true || false,
                'object' => '<string>', // REQUIRED
            ],
            'Zendesk' => [
                'object' => '<string>', // REQUIRED
            ],
        ],
    ],
    'tags' => ['<string>', ...],
    'tasks' => [ // REQUIRED
        [
            'connectorOperator' => [
                'Amplitude' => 'BETWEEN',
                'CustomConnector' => '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',
                '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',
                'Pardot' => 'PROJECTION|EQUAL_TO|NO_OP|ADDITION|MULTIPLICATION|DIVISION|SUBTRACTION|MASK_ALL|MASK_FIRST_N|MASK_LAST_N|VALIDATE_NON_NULL|VALIDATE_NON_ZERO|VALIDATE_NON_NEGATIVE|VALIDATE_NUMERIC',
                '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',
                'SAPOData' => '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',
                '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|Map_all|Mask|Merge|Passthrough|Truncate|Validate|Partition', // REQUIRED
        ],
        // ...
    ],
    'triggerConfig' => [ // REQUIRED
        'triggerProperties' => [
            'Scheduled' => [
                'dataPullMode' => 'Incremental|Complete',
                'firstExecutionFrom' => <integer || string || DateTime>,
                'flowErrorDeactivationThreshold' => <integer>,
                'scheduleEndTime' => <integer || string || DateTime>,
                'scheduleExpression' => '<string>', // REQUIRED
                'scheduleOffset' => <integer>,
                'scheduleStartTime' => <integer || string || DateTime>,
                'timezone' => '<string>',
            ],
        ],
        'triggerType' => 'Scheduled|Event|OnDemand', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'flowArn' => '<string>',
    'flowStatus' => 'Active|Deprecated|Deleted|Draft|Errored|Suspended',
]

Result Details

Errors

ValidationException:

The request has invalid or missing parameters.

InternalServerException:

An internal service error occurred during the processing of your request. Try again later.

ResourceNotFoundException:

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.

ConflictException:

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.

ConnectorServerException:

An error occurred when retrieving data from the connector endpoint.

AccessDeniedException:

AppFlow/Requester has invalid or missing permissions.

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

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The resource specified in the request (such as the source or destination connector profile) is not found.

ConflictException:

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.

InternalServerException:

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

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The resource specified in the request (such as the source or destination connector profile) is not found.

ConflictException:

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.

InternalServerException:

An internal service error occurred during the processing of your request. Try again later.

DescribeConnector

$result = $client->describeConnector([/* ... */]);
$promise = $client->describeConnectorAsync([/* ... */]);

Describes the given custom connector registered in your Amazon Web Services account. This API can be used for custom connectors that are registered in your account and also for Amazon authored connectors.

Parameter Syntax

$result = $client->describeConnector([
    'connectorLabel' => '<string>',
    'connectorType' => 'Salesforce|Singular|Slack|Redshift|S3|Marketo|Googleanalytics|Zendesk|Servicenow|Datadog|Trendmicro|Snowflake|Dynatrace|Infornexus|Amplitude|Veeva|EventBridge|LookoutMetrics|Upsolver|Honeycode|CustomerProfiles|SAPOData|CustomConnector|Pardot', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'connectorConfiguration' => [
        'authenticationConfig' => [
            'customAuthConfigs' => [
                [
                    'authParameters' => [
                        [
                            'connectorSuppliedValues' => ['<string>', ...],
                            'description' => '<string>',
                            'isRequired' => true || false,
                            'isSensitiveField' => true || false,
                            'key' => '<string>',
                            'label' => '<string>',
                        ],
                        // ...
                    ],
                    'customAuthenticationType' => '<string>',
                ],
                // ...
            ],
            'isApiKeyAuthSupported' => true || false,
            'isBasicAuthSupported' => true || false,
            'isCustomAuthSupported' => true || false,
            'isOAuth2Supported' => true || false,
            'oAuth2Defaults' => [
                'authCodeUrls' => ['<string>', ...],
                'oauth2CustomProperties' => [
                    [
                        'connectorSuppliedValues' => ['<string>', ...],
                        'description' => '<string>',
                        'isRequired' => true || false,
                        'isSensitiveField' => true || false,
                        'key' => '<string>',
                        'label' => '<string>',
                        'type' => 'TOKEN_URL|AUTH_URL',
                    ],
                    // ...
                ],
                'oauth2GrantTypesSupported' => ['<string>', ...],
                'oauthScopes' => ['<string>', ...],
                'tokenUrls' => ['<string>', ...],
            ],
        ],
        'canUseAsDestination' => true || false,
        'canUseAsSource' => true || false,
        'connectorArn' => '<string>',
        'connectorDescription' => '<string>',
        'connectorLabel' => '<string>',
        'connectorMetadata' => [
            'Amplitude' => [
            ],
            'CustomerProfiles' => [
            ],
            'Datadog' => [
            ],
            'Dynatrace' => [
            ],
            'EventBridge' => [
            ],
            'GoogleAnalytics' => [
                'oAuthScopes' => ['<string>', ...],
            ],
            'Honeycode' => [
                'oAuthScopes' => ['<string>', ...],
            ],
            'InforNexus' => [
            ],
            'Marketo' => [
            ],
            'Pardot' => [
            ],
            'Redshift' => [
            ],
            'S3' => [
            ],
            'SAPOData' => [
            ],
            'Salesforce' => [
                'dataTransferApis' => ['<string>', ...],
                'oAuthScopes' => ['<string>', ...],
                'oauth2GrantTypesSupported' => ['<string>', ...],
            ],
            'ServiceNow' => [
            ],
            'Singular' => [
            ],
            'Slack' => [
                'oAuthScopes' => ['<string>', ...],
            ],
            'Snowflake' => [
                'supportedRegions' => ['<string>', ...],
            ],
            'Trendmicro' => [
            ],
            'Upsolver' => [
            ],
            'Veeva' => [
            ],
            'Zendesk' => [
                'oAuthScopes' => ['<string>', ...],
            ],
        ],
        'connectorModes' => ['<string>', ...],
        'connectorName' => '<string>',
        'connectorOwner' => '<string>',
        'connectorProvisioningConfig' => [
            'lambda' => [
                'lambdaArn' => '<string>',
            ],
        ],
        'connectorProvisioningType' => 'LAMBDA',
        'connectorRuntimeSettings' => [
            [
                'connectorSuppliedValueOptions' => ['<string>', ...],
                'dataType' => '<string>',
                'description' => '<string>',
                'isRequired' => true || false,
                'key' => '<string>',
                'label' => '<string>',
                'scope' => '<string>',
            ],
            // ...
        ],
        'connectorType' => 'Salesforce|Singular|Slack|Redshift|S3|Marketo|Googleanalytics|Zendesk|Servicenow|Datadog|Trendmicro|Snowflake|Dynatrace|Infornexus|Amplitude|Veeva|EventBridge|LookoutMetrics|Upsolver|Honeycode|CustomerProfiles|SAPOData|CustomConnector|Pardot',
        'connectorVersion' => '<string>',
        'isPrivateLinkEnabled' => true || false,
        'isPrivateLinkEndpointUrlRequired' => true || false,
        'logoURL' => '<string>',
        'registeredAt' => <DateTime>,
        'registeredBy' => '<string>',
        'supportedApiVersions' => ['<string>', ...],
        'supportedDataTransferApis' => [
            [
                'Name' => '<string>',
                'Type' => 'SYNC|ASYNC|AUTOMATIC',
            ],
            // ...
        ],
        'supportedDataTransferTypes' => ['<string>', ...],
        'supportedDestinationConnectors' => ['<string>', ...],
        'supportedOperators' => ['<string>', ...],
        'supportedSchedulingFrequencies' => ['<string>', ...],
        'supportedTriggerTypes' => ['<string>', ...],
        'supportedWriteOperations' => ['<string>', ...],
    ],
]

Result Details

Errors

ValidationException:

The request has invalid or missing parameters.

InternalServerException:

An internal service error occurred during the processing of your request. Try again later.

ResourceNotFoundException:

The resource specified in the request (such as the source or destination connector profile) is not found.

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 field in that entity.

Parameter Syntax

$result = $client->describeConnectorEntity([
    'apiVersion' => '<string>',
    '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|SAPOData|CustomConnector|Pardot',
]);

Parameter Details

Result Syntax

[
    'connectorEntityFields' => [
        [
            'customProperties' => ['<string>', ...],
            'defaultValue' => '<string>',
            'description' => '<string>',
            'destinationProperties' => [
                'isCreatable' => true || false,
                'isDefaultedOnCreate' => true || false,
                'isNullable' => true || false,
                'isUpdatable' => true || false,
                'isUpsertable' => true || false,
                'supportedWriteOperations' => ['<string>', ...],
            ],
            'identifier' => '<string>',
            'isDeprecated' => true || false,
            'isPrimaryKey' => true || false,
            'label' => '<string>',
            'parentIdentifier' => '<string>',
            'sourceProperties' => [
                'isQueryable' => true || false,
                'isRetrievable' => true || false,
                'isTimestampFieldForIncrementalQueries' => true || false,
            ],
            'supportedFieldTypeDetails' => [
                'v1' => [
                    'fieldLengthRange' => [
                        'maximum' => <float>,
                        'minimum' => <float>,
                    ],
                    'fieldType' => '<string>',
                    'fieldValueRange' => [
                        'maximum' => <float>,
                        'minimum' => <float>,
                    ],
                    'filterOperators' => ['<string>', ...],
                    'supportedDateFormat' => '<string>',
                    'supportedValues' => ['<string>', ...],
                    'valueRegexPattern' => '<string>',
                ],
            ],
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The request has invalid or missing parameters.

ResourceNotFoundException:

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.

ConnectorServerException:

An error occurred when retrieving data from the connector endpoint.

InternalServerException:

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([
    'connectorLabel' => '<string>',
    'connectorProfileNames' => ['<string>', ...],
    'connectorType' => 'Salesforce|Singular|Slack|Redshift|S3|Marketo|Googleanalytics|Zendesk|Servicenow|Datadog|Trendmicro|Snowflake|Dynatrace|Infornexus|Amplitude|Veeva|EventBridge|LookoutMetrics|Upsolver|Honeycode|CustomerProfiles|SAPOData|CustomConnector|Pardot',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'connectorProfileDetails' => [
        [
            'connectionMode' => 'Public|Private',
            'connectorLabel' => '<string>',
            'connectorProfileArn' => '<string>',
            'connectorProfileName' => '<string>',
            'connectorProfileProperties' => [
                'Amplitude' => [
                ],
                'CustomConnector' => [
                    'oAuth2Properties' => [
                        'oAuth2GrantType' => 'CLIENT_CREDENTIALS|AUTHORIZATION_CODE|JWT_BEARER',
                        'tokenUrl' => '<string>',
                        'tokenUrlCustomProperties' => ['<string>', ...],
                    ],
                    'profileProperties' => ['<string>', ...],
                ],
                'Datadog' => [
                    'instanceUrl' => '<string>',
                ],
                'Dynatrace' => [
                    'instanceUrl' => '<string>',
                ],
                'GoogleAnalytics' => [
                ],
                'Honeycode' => [
                ],
                'InforNexus' => [
                    'instanceUrl' => '<string>',
                ],
                'Marketo' => [
                    'instanceUrl' => '<string>',
                ],
                'Pardot' => [
                    'businessUnitId' => '<string>',
                    'instanceUrl' => '<string>',
                    'isSandboxEnvironment' => true || false,
                ],
                'Redshift' => [
                    'bucketName' => '<string>',
                    'bucketPrefix' => '<string>',
                    'clusterIdentifier' => '<string>',
                    'dataApiRoleArn' => '<string>',
                    'databaseName' => '<string>',
                    'databaseUrl' => '<string>',
                    'isRedshiftServerless' => true || false,
                    'roleArn' => '<string>',
                    'workgroupName' => '<string>',
                ],
                'SAPOData' => [
                    'applicationHostUrl' => '<string>',
                    'applicationServicePath' => '<string>',
                    'clientNumber' => '<string>',
                    'disableSSO' => true || false,
                    'logonLanguage' => '<string>',
                    'oAuthProperties' => [
                        'authCodeUrl' => '<string>',
                        'oAuthScopes' => ['<string>', ...],
                        'tokenUrl' => '<string>',
                    ],
                    'portNumber' => <integer>,
                    'privateLinkServiceName' => '<string>',
                ],
                'Salesforce' => [
                    'instanceUrl' => '<string>',
                    'isSandboxEnvironment' => true || false,
                    'usePrivateLinkForMetadataAndAuthorization' => 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|SAPOData|CustomConnector|Pardot',
            'createdAt' => <DateTime>,
            'credentialsArn' => '<string>',
            'lastUpdatedAt' => <DateTime>,
            'privateConnectionProvisioningState' => [
                'failureCause' => 'CONNECTOR_AUTHENTICATION|CONNECTOR_SERVER|INTERNAL_SERVER|ACCESS_DENIED|VALIDATION',
                'failureMessage' => '<string>',
                'status' => 'FAILED|PENDING|CREATED',
            ],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The request has invalid or missing parameters.

InternalServerException:

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>', ...],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'connectorConfigurations' => [
        '<ConnectorType>' => [
            'authenticationConfig' => [
                'customAuthConfigs' => [
                    [
                        'authParameters' => [
                            [
                                'connectorSuppliedValues' => ['<string>', ...],
                                'description' => '<string>',
                                'isRequired' => true || false,
                                'isSensitiveField' => true || false,
                                'key' => '<string>',
                                'label' => '<string>',
                            ],
                            // ...
                        ],
                        'customAuthenticationType' => '<string>',
                    ],
                    // ...
                ],
                'isApiKeyAuthSupported' => true || false,
                'isBasicAuthSupported' => true || false,
                'isCustomAuthSupported' => true || false,
                'isOAuth2Supported' => true || false,
                'oAuth2Defaults' => [
                    'authCodeUrls' => ['<string>', ...],
                    'oauth2CustomProperties' => [
                        [
                            'connectorSuppliedValues' => ['<string>', ...],
                            'description' => '<string>',
                            'isRequired' => true || false,
                            'isSensitiveField' => true || false,
                            'key' => '<string>',
                            'label' => '<string>',
                            'type' => 'TOKEN_URL|AUTH_URL',
                        ],
                        // ...
                    ],
                    'oauth2GrantTypesSupported' => ['<string>', ...],
                    'oauthScopes' => ['<string>', ...],
                    'tokenUrls' => ['<string>', ...],
                ],
            ],
            'canUseAsDestination' => true || false,
            'canUseAsSource' => true || false,
            'connectorArn' => '<string>',
            'connectorDescription' => '<string>',
            'connectorLabel' => '<string>',
            'connectorMetadata' => [
                'Amplitude' => [
                ],
                'CustomerProfiles' => [
                ],
                'Datadog' => [
                ],
                'Dynatrace' => [
                ],
                'EventBridge' => [
                ],
                'GoogleAnalytics' => [
                    'oAuthScopes' => ['<string>', ...],
                ],
                'Honeycode' => [
                    'oAuthScopes' => ['<string>', ...],
                ],
                'InforNexus' => [
                ],
                'Marketo' => [
                ],
                'Pardot' => [
                ],
                'Redshift' => [
                ],
                'S3' => [
                ],
                'SAPOData' => [
                ],
                'Salesforce' => [
                    'dataTransferApis' => ['<string>', ...],
                    'oAuthScopes' => ['<string>', ...],
                    'oauth2GrantTypesSupported' => ['<string>', ...],
                ],
                'ServiceNow' => [
                ],
                'Singular' => [
                ],
                'Slack' => [
                    'oAuthScopes' => ['<string>', ...],
                ],
                'Snowflake' => [
                    'supportedRegions' => ['<string>', ...],
                ],
                'Trendmicro' => [
                ],
                'Upsolver' => [
                ],
                'Veeva' => [
                ],
                'Zendesk' => [
                    'oAuthScopes' => ['<string>', ...],
                ],
            ],
            'connectorModes' => ['<string>', ...],
            'connectorName' => '<string>',
            'connectorOwner' => '<string>',
            'connectorProvisioningConfig' => [
                'lambda' => [
                    'lambdaArn' => '<string>',
                ],
            ],
            'connectorProvisioningType' => 'LAMBDA',
            'connectorRuntimeSettings' => [
                [
                    'connectorSuppliedValueOptions' => ['<string>', ...],
                    'dataType' => '<string>',
                    'description' => '<string>',
                    'isRequired' => true || false,
                    'key' => '<string>',
                    'label' => '<string>',
                    'scope' => '<string>',
                ],
                // ...
            ],
            'connectorType' => 'Salesforce|Singular|Slack|Redshift|S3|Marketo|Googleanalytics|Zendesk|Servicenow|Datadog|Trendmicro|Snowflake|Dynatrace|Infornexus|Amplitude|Veeva|EventBridge|LookoutMetrics|Upsolver|Honeycode|CustomerProfiles|SAPOData|CustomConnector|Pardot',
            'connectorVersion' => '<string>',
            'isPrivateLinkEnabled' => true || false,
            'isPrivateLinkEndpointUrlRequired' => true || false,
            'logoURL' => '<string>',
            'registeredAt' => <DateTime>,
            'registeredBy' => '<string>',
            'supportedApiVersions' => ['<string>', ...],
            'supportedDataTransferApis' => [
                [
                    'Name' => '<string>',
                    'Type' => 'SYNC|ASYNC|AUTOMATIC',
                ],
                // ...
            ],
            'supportedDataTransferTypes' => ['<string>', ...],
            'supportedDestinationConnectors' => ['<string>', ...],
            'supportedOperators' => ['<string>', ...],
            'supportedSchedulingFrequencies' => ['<string>', ...],
            'supportedTriggerTypes' => ['<string>', ...],
            'supportedWriteOperations' => ['<string>', ...],
        ],
        // ...
    ],
    'connectors' => [
        [
            'applicationType' => '<string>',
            'connectorDescription' => '<string>',
            'connectorLabel' => '<string>',
            'connectorModes' => ['<string>', ...],
            'connectorName' => '<string>',
            'connectorOwner' => '<string>',
            'connectorProvisioningType' => 'LAMBDA',
            'connectorType' => 'Salesforce|Singular|Slack|Redshift|S3|Marketo|Googleanalytics|Zendesk|Servicenow|Datadog|Trendmicro|Snowflake|Dynatrace|Infornexus|Amplitude|Veeva|EventBridge|LookoutMetrics|Upsolver|Honeycode|CustomerProfiles|SAPOData|CustomConnector|Pardot',
            'connectorVersion' => '<string>',
            'registeredAt' => <DateTime>,
            'registeredBy' => '<string>',
            'supportedDataTransferTypes' => ['<string>', ...],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The request has invalid or missing parameters.

InternalServerException:

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

Result Syntax

[
    'createdAt' => <DateTime>,
    'createdBy' => '<string>',
    'description' => '<string>',
    'destinationFlowConfigList' => [
        [
            'apiVersion' => '<string>',
            'connectorProfileName' => '<string>',
            'connectorType' => 'Salesforce|Singular|Slack|Redshift|S3|Marketo|Googleanalytics|Zendesk|Servicenow|Datadog|Trendmicro|Snowflake|Dynatrace|Infornexus|Amplitude|Veeva|EventBridge|LookoutMetrics|Upsolver|Honeycode|CustomerProfiles|SAPOData|CustomConnector|Pardot',
            'destinationConnectorProperties' => [
                'CustomConnector' => [
                    'customProperties' => ['<string>', ...],
                    'entityName' => '<string>',
                    'errorHandlingConfig' => [
                        'bucketName' => '<string>',
                        'bucketPrefix' => '<string>',
                        'failOnFirstDestinationError' => true || false,
                    ],
                    'idFieldNames' => ['<string>', ...],
                    'writeOperationType' => 'INSERT|UPSERT|UPDATE|DELETE',
                ],
                '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' => [
                ],
                'Marketo' => [
                    'errorHandlingConfig' => [
                        'bucketName' => '<string>',
                        'bucketPrefix' => '<string>',
                        'failOnFirstDestinationError' => true || false,
                    ],
                    'object' => '<string>',
                ],
                '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',
                            'targetFileSize' => <integer>,
                        ],
                        'fileType' => 'CSV|JSON|PARQUET',
                        'prefixConfig' => [
                            'pathPrefixHierarchy' => ['<string>', ...],
                            'prefixFormat' => 'YEAR|MONTH|DAY|HOUR|MINUTE',
                            'prefixType' => 'FILENAME|PATH|PATH_AND_FILENAME',
                        ],
                        'preserveSourceDataTyping' => true || false,
                    ],
                ],
                'SAPOData' => [
                    'errorHandlingConfig' => [
                        'bucketName' => '<string>',
                        'bucketPrefix' => '<string>',
                        'failOnFirstDestinationError' => true || false,
                    ],
                    'idFieldNames' => ['<string>', ...],
                    'objectPath' => '<string>',
                    'successResponseHandlingConfig' => [
                        'bucketName' => '<string>',
                        'bucketPrefix' => '<string>',
                    ],
                    'writeOperationType' => 'INSERT|UPSERT|UPDATE|DELETE',
                ],
                'Salesforce' => [
                    'dataTransferApi' => 'AUTOMATIC|BULKV2|REST_SYNC',
                    'errorHandlingConfig' => [
                        'bucketName' => '<string>',
                        'bucketPrefix' => '<string>',
                        'failOnFirstDestinationError' => true || false,
                    ],
                    'idFieldNames' => ['<string>', ...],
                    'object' => '<string>',
                    'writeOperationType' => 'INSERT|UPSERT|UPDATE|DELETE',
                ],
                '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',
                            'targetFileSize' => <integer>,
                        ],
                        'fileType' => 'CSV|JSON|PARQUET',
                        'prefixConfig' => [
                            'pathPrefixHierarchy' => ['<string>', ...],
                            '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|DELETE',
                ],
            ],
        ],
        // ...
    ],
    'flowArn' => '<string>',
    'flowName' => '<string>',
    'flowStatus' => 'Active|Deprecated|Deleted|Draft|Errored|Suspended',
    'flowStatusMessage' => '<string>',
    'kmsArn' => '<string>',
    'lastRunExecutionDetails' => [
        'mostRecentExecutionMessage' => '<string>',
        'mostRecentExecutionStatus' => 'InProgress|Successful|Error|CancelStarted|Canceled',
        'mostRecentExecutionTime' => <DateTime>,
    ],
    'lastRunMetadataCatalogDetails' => [
        [
            'catalogType' => 'GLUE',
            'partitionRegistrationOutput' => [
                'message' => '<string>',
                'result' => '<string>',
                'status' => 'InProgress|Successful|Error|CancelStarted|Canceled',
            ],
            'tableName' => '<string>',
            'tableRegistrationOutput' => [
                'message' => '<string>',
                'result' => '<string>',
                'status' => 'InProgress|Successful|Error|CancelStarted|Canceled',
            ],
        ],
        // ...
    ],
    'lastUpdatedAt' => <DateTime>,
    'lastUpdatedBy' => '<string>',
    'metadataCatalogConfig' => [
        'glueDataCatalog' => [
            'databaseName' => '<string>',
            'roleArn' => '<string>',
            'tablePrefix' => '<string>',
        ],
    ],
    'schemaVersion' => <integer>,
    'sourceFlowConfig' => [
        'apiVersion' => '<string>',
        'connectorProfileName' => '<string>',
        'connectorType' => 'Salesforce|Singular|Slack|Redshift|S3|Marketo|Googleanalytics|Zendesk|Servicenow|Datadog|Trendmicro|Snowflake|Dynatrace|Infornexus|Amplitude|Veeva|EventBridge|LookoutMetrics|Upsolver|Honeycode|CustomerProfiles|SAPOData|CustomConnector|Pardot',
        'incrementalPullConfig' => [
            'datetimeTypeFieldName' => '<string>',
        ],
        'sourceConnectorProperties' => [
            'Amplitude' => [
                'object' => '<string>',
            ],
            'CustomConnector' => [
                'customProperties' => ['<string>', ...],
                'dataTransferApi' => [
                    'Name' => '<string>',
                    'Type' => 'SYNC|ASYNC|AUTOMATIC',
                ],
                'entityName' => '<string>',
            ],
            'Datadog' => [
                'object' => '<string>',
            ],
            'Dynatrace' => [
                'object' => '<string>',
            ],
            'GoogleAnalytics' => [
                'object' => '<string>',
            ],
            'InforNexus' => [
                'object' => '<string>',
            ],
            'Marketo' => [
                'object' => '<string>',
            ],
            'Pardot' => [
                'object' => '<string>',
            ],
            'S3' => [
                'bucketName' => '<string>',
                'bucketPrefix' => '<string>',
                's3InputFormatConfig' => [
                    's3InputFileType' => 'CSV|JSON',
                ],
            ],
            'SAPOData' => [
                'objectPath' => '<string>',
                'paginationConfig' => [
                    'maxPageSize' => <integer>,
                ],
                'parallelismConfig' => [
                    'maxParallelism' => <integer>,
                ],
            ],
            'Salesforce' => [
                'dataTransferApi' => 'AUTOMATIC|BULKV2|REST_SYNC',
                'enableDynamicFieldUpdate' => true || false,
                'includeDeletedRecords' => true || false,
                'object' => '<string>',
            ],
            'ServiceNow' => [
                'object' => '<string>',
            ],
            'Singular' => [
                'object' => '<string>',
            ],
            'Slack' => [
                'object' => '<string>',
            ],
            'Trendmicro' => [
                'object' => '<string>',
            ],
            'Veeva' => [
                'documentType' => '<string>',
                'includeAllVersions' => true || false,
                'includeRenditions' => true || false,
                'includeSourceFiles' => true || false,
                'object' => '<string>',
            ],
            'Zendesk' => [
                'object' => '<string>',
            ],
        ],
    ],
    'tags' => ['<string>', ...],
    'tasks' => [
        [
            'connectorOperator' => [
                'Amplitude' => 'BETWEEN',
                'CustomConnector' => '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',
                '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',
                'Pardot' => 'PROJECTION|EQUAL_TO|NO_OP|ADDITION|MULTIPLICATION|DIVISION|SUBTRACTION|MASK_ALL|MASK_FIRST_N|MASK_LAST_N|VALIDATE_NON_NULL|VALIDATE_NON_ZERO|VALIDATE_NON_NEGATIVE|VALIDATE_NUMERIC',
                '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',
                'SAPOData' => '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',
                '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|Map_all|Mask|Merge|Passthrough|Truncate|Validate|Partition',
        ],
        // ...
    ],
    'triggerConfig' => [
        'triggerProperties' => [
            'Scheduled' => [
                'dataPullMode' => 'Incremental|Complete',
                'firstExecutionFrom' => <DateTime>,
                'flowErrorDeactivationThreshold' => <integer>,
                'scheduleEndTime' => <DateTime>,
                'scheduleExpression' => '<string>',
                'scheduleOffset' => <integer>,
                'scheduleStartTime' => <DateTime>,
                'timezone' => '<string>',
            ],
        ],
        'triggerType' => 'Scheduled|Event|OnDemand',
    ],
]

Result Details

Errors

ResourceNotFoundException:

The resource specified in the request (such as the source or destination connector profile) is not found.

InternalServerException:

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

Result Syntax

[
    'flowExecutions' => [
        [
            'dataPullEndTime' => <DateTime>,
            'dataPullStartTime' => <DateTime>,
            'executionId' => '<string>',
            'executionResult' => [
                'bytesProcessed' => <integer>,
                'bytesWritten' => <integer>,
                'errorInfo' => [
                    'executionMessage' => '<string>',
                    'putFailuresCount' => <integer>,
                ],
                'maxPageSize' => <integer>,
                'numParallelProcesses' => <integer>,
                'recordsProcessed' => <integer>,
            ],
            'executionStatus' => 'InProgress|Successful|Error|CancelStarted|Canceled',
            'lastUpdatedAt' => <DateTime>,
            'metadataCatalogDetails' => [
                [
                    'catalogType' => 'GLUE',
                    'partitionRegistrationOutput' => [
                        'message' => '<string>',
                        'result' => '<string>',
                        'status' => 'InProgress|Successful|Error|CancelStarted|Canceled',
                    ],
                    'tableName' => '<string>',
                    'tableRegistrationOutput' => [
                        'message' => '<string>',
                        'result' => '<string>',
                        'status' => 'InProgress|Successful|Error|CancelStarted|Canceled',
                    ],
                ],
                // ...
            ],
            'startedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The request has invalid or missing parameters.

ResourceNotFoundException:

The resource specified in the request (such as the source or destination connector profile) is not found.

InternalServerException:

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([
    'apiVersion' => '<string>',
    'connectorProfileName' => '<string>',
    'connectorType' => 'Salesforce|Singular|Slack|Redshift|S3|Marketo|Googleanalytics|Zendesk|Servicenow|Datadog|Trendmicro|Snowflake|Dynatrace|Infornexus|Amplitude|Veeva|EventBridge|LookoutMetrics|Upsolver|Honeycode|CustomerProfiles|SAPOData|CustomConnector|Pardot',
    'entitiesPath' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'connectorEntityMap' => [
        '<Group>' => [
            [
                'hasNestedEntities' => true || false,
                'label' => '<string>',
                'name' => '<string>',
            ],
            // ...
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The request has invalid or missing parameters.

ResourceNotFoundException:

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.

ConnectorServerException:

An error occurred when retrieving data from the connector endpoint.

InternalServerException:

An internal service error occurred during the processing of your request. Try again later.

ListConnectors

$result = $client->listConnectors([/* ... */]);
$promise = $client->listConnectorsAsync([/* ... */]);

Returns the list of all registered custom connectors in your Amazon Web Services account. This API lists only custom connectors registered in this account, not the Amazon Web Services authored connectors.

Parameter Syntax

$result = $client->listConnectors([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'connectors' => [
        [
            'applicationType' => '<string>',
            'connectorDescription' => '<string>',
            'connectorLabel' => '<string>',
            'connectorModes' => ['<string>', ...],
            'connectorName' => '<string>',
            'connectorOwner' => '<string>',
            'connectorProvisioningType' => 'LAMBDA',
            'connectorType' => 'Salesforce|Singular|Slack|Redshift|S3|Marketo|Googleanalytics|Zendesk|Servicenow|Datadog|Trendmicro|Snowflake|Dynatrace|Infornexus|Amplitude|Veeva|EventBridge|LookoutMetrics|Upsolver|Honeycode|CustomerProfiles|SAPOData|CustomConnector|Pardot',
            'connectorVersion' => '<string>',
            'registeredAt' => <DateTime>,
            'registeredBy' => '<string>',
            'supportedDataTransferTypes' => ['<string>', ...],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The request has invalid or missing parameters.

InternalServerException:

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

Result Syntax

[
    'flows' => [
        [
            'createdAt' => <DateTime>,
            'createdBy' => '<string>',
            'description' => '<string>',
            'destinationConnectorLabel' => '<string>',
            'destinationConnectorType' => 'Salesforce|Singular|Slack|Redshift|S3|Marketo|Googleanalytics|Zendesk|Servicenow|Datadog|Trendmicro|Snowflake|Dynatrace|Infornexus|Amplitude|Veeva|EventBridge|LookoutMetrics|Upsolver|Honeycode|CustomerProfiles|SAPOData|CustomConnector|Pardot',
            'flowArn' => '<string>',
            'flowName' => '<string>',
            'flowStatus' => 'Active|Deprecated|Deleted|Draft|Errored|Suspended',
            'lastRunExecutionDetails' => [
                'mostRecentExecutionMessage' => '<string>',
                'mostRecentExecutionStatus' => 'InProgress|Successful|Error|CancelStarted|Canceled',
                'mostRecentExecutionTime' => <DateTime>,
            ],
            'lastUpdatedAt' => <DateTime>,
            'lastUpdatedBy' => '<string>',
            'sourceConnectorLabel' => '<string>',
            'sourceConnectorType' => 'Salesforce|Singular|Slack|Redshift|S3|Marketo|Googleanalytics|Zendesk|Servicenow|Datadog|Trendmicro|Snowflake|Dynatrace|Infornexus|Amplitude|Veeva|EventBridge|LookoutMetrics|Upsolver|Honeycode|CustomerProfiles|SAPOData|CustomConnector|Pardot',
            'tags' => ['<string>', ...],
            'triggerType' => 'Scheduled|Event|OnDemand',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The request has invalid or missing parameters.

InternalServerException:

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

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Errors

InternalServerException:

An internal service error occurred during the processing of your request. Try again later.

ValidationException:

The request has invalid or missing parameters.

ResourceNotFoundException:

The resource specified in the request (such as the source or destination connector profile) is not found.

RegisterConnector

$result = $client->registerConnector([/* ... */]);
$promise = $client->registerConnectorAsync([/* ... */]);

Registers a new custom connector with your Amazon Web Services account. Before you can register the connector, you must deploy the associated AWS lambda function in your account.

Parameter Syntax

$result = $client->registerConnector([
    'clientToken' => '<string>',
    'connectorLabel' => '<string>',
    'connectorProvisioningConfig' => [
        'lambda' => [
            'lambdaArn' => '<string>', // REQUIRED
        ],
    ],
    'connectorProvisioningType' => 'LAMBDA',
    'description' => '<string>',
]);

Parameter Details

Result Syntax

[
    'connectorArn' => '<string>',
]

Result Details

Errors

ValidationException:

The request has invalid or missing parameters.

ConflictException:

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.

AccessDeniedException:

AppFlow/Requester has invalid or missing permissions.

ResourceNotFoundException:

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.

ThrottlingException:

API calls have exceeded the maximum allowed API request rate per account and per Region.

InternalServerException:

An internal service error occurred during the processing of your request. Try again later.

ConnectorServerException:

An error occurred when retrieving data from the connector endpoint.

ConnectorAuthenticationException:

An error occurred when authenticating with the connector endpoint.

ResetConnectorMetadataCache

$result = $client->resetConnectorMetadataCache([/* ... */]);
$promise = $client->resetConnectorMetadataCacheAsync([/* ... */]);

Resets metadata about your connector entities that Amazon AppFlow stored in its cache. Use this action when you want Amazon AppFlow to return the latest information about the data that you have in a source application.

Amazon AppFlow returns metadata about your entities when you use the ListConnectorEntities or DescribeConnectorEntities actions. Following these actions, Amazon AppFlow caches the metadata to reduce the number of API requests that it must send to the source application. Amazon AppFlow automatically resets the cache once every hour, but you can use this action when you want to get the latest metadata right away.

Parameter Syntax

$result = $client->resetConnectorMetadataCache([
    'apiVersion' => '<string>',
    'connectorEntityName' => '<string>',
    'connectorProfileName' => '<string>',
    'connectorType' => 'Salesforce|Singular|Slack|Redshift|S3|Marketo|Googleanalytics|Zendesk|Servicenow|Datadog|Trendmicro|Snowflake|Dynatrace|Infornexus|Amplitude|Veeva|EventBridge|LookoutMetrics|Upsolver|Honeycode|CustomerProfiles|SAPOData|CustomConnector|Pardot',
    'entitiesPath' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The request has invalid or missing parameters.

ResourceNotFoundException:

The resource specified in the request (such as the source or destination connector profile) is not found.

ConflictException:

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.

InternalServerException:

An internal service error occurred during the processing of your request. Try again later.

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([
    'clientToken' => '<string>',
    'flowName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'executionId' => '<string>',
    'flowArn' => '<string>',
    'flowStatus' => 'Active|Deprecated|Deleted|Draft|Errored|Suspended',
]

Result Details

Errors

ResourceNotFoundException:

The resource specified in the request (such as the source or destination connector profile) is not found.

InternalServerException:

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.

ConflictException:

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

Result Syntax

[
    'flowArn' => '<string>',
    'flowStatus' => 'Active|Deprecated|Deleted|Draft|Errored|Suspended',
]

Result Details

Errors

ConflictException:

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.

ResourceNotFoundException:

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.

InternalServerException:

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

Result Syntax

[]

Result Details

Errors

InternalServerException:

An internal service error occurred during the processing of your request. Try again later.

ValidationException:

The request has invalid or missing parameters.

ResourceNotFoundException:

The resource specified in the request (such as the source or destination connector profile) is not found.

UnregisterConnector

$result = $client->unregisterConnector([/* ... */]);
$promise = $client->unregisterConnectorAsync([/* ... */]);

Unregisters the custom connector registered in your account that matches the connector label provided in the request.

Parameter Syntax

$result = $client->unregisterConnector([
    'connectorLabel' => '<string>', // REQUIRED
    'forceDelete' => true || false,
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The resource specified in the request (such as the source or destination connector profile) is not found.

ConflictException:

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.

InternalServerException:

An internal service error occurred during the processing of your request. Try again later.

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

Result Syntax

[]

Result Details

Errors

InternalServerException:

An internal service error occurred during the processing of your request. Try again later.

ValidationException:

The request has invalid or missing parameters.

ResourceNotFoundException:

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([
    'clientToken' => '<string>',
    'connectionMode' => 'Public|Private', // REQUIRED
    'connectorProfileConfig' => [ // REQUIRED
        'connectorProfileCredentials' => [
            'Amplitude' => [
                'apiKey' => '<string>', // REQUIRED
                'secretKey' => '<string>', // REQUIRED
            ],
            'CustomConnector' => [
                'apiKey' => [
                    'apiKey' => '<string>', // REQUIRED
                    'apiSecretKey' => '<string>',
                ],
                'authenticationType' => 'OAUTH2|APIKEY|BASIC|CUSTOM', // REQUIRED
                'basic' => [
                    'password' => '<string>', // REQUIRED
                    'username' => '<string>', // REQUIRED
                ],
                'custom' => [
                    'credentialsMap' => ['<string>', ...],
                    'customAuthenticationType' => '<string>', // REQUIRED
                ],
                'oauth2' => [
                    'accessToken' => '<string>',
                    'clientId' => '<string>',
                    'clientSecret' => '<string>',
                    'oAuthRequest' => [
                        'authCode' => '<string>',
                        'redirectUri' => '<string>',
                    ],
                    'refreshToken' => '<string>',
                ],
            ],
            '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>',
                ],
            ],
            'Pardot' => [
                'accessToken' => '<string>',
                'clientCredentialsArn' => '<string>',
                'oAuthRequest' => [
                    'authCode' => '<string>',
                    'redirectUri' => '<string>',
                ],
                'refreshToken' => '<string>',
            ],
            'Redshift' => [
                'password' => '<string>',
                'username' => '<string>',
            ],
            'SAPOData' => [
                'basicAuthCredentials' => [
                    'password' => '<string>', // REQUIRED
                    'username' => '<string>', // REQUIRED
                ],
                'oAuthCredentials' => [
                    'accessToken' => '<string>',
                    'clientId' => '<string>', // REQUIRED
                    'clientSecret' => '<string>', // REQUIRED
                    'oAuthRequest' => [
                        'authCode' => '<string>',
                        'redirectUri' => '<string>',
                    ],
                    'refreshToken' => '<string>',
                ],
            ],
            'Salesforce' => [
                'accessToken' => '<string>',
                'clientCredentialsArn' => '<string>',
                'jwtToken' => '<string>',
                'oAuth2GrantType' => 'CLIENT_CREDENTIALS|AUTHORIZATION_CODE|JWT_BEARER',
                'oAuthRequest' => [
                    'authCode' => '<string>',
                    'redirectUri' => '<string>',
                ],
                'refreshToken' => '<string>',
            ],
            'ServiceNow' => [
                'oAuth2Credentials' => [
                    'accessToken' => '<string>',
                    'clientId' => '<string>',
                    'clientSecret' => '<string>',
                    'oAuthRequest' => [
                        'authCode' => '<string>',
                        'redirectUri' => '<string>',
                    ],
                    'refreshToken' => '<string>',
                ],
                'password' => '<string>',
                'username' => '<string>',
            ],
            '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' => [
            ],
            'CustomConnector' => [
                'oAuth2Properties' => [
                    'oAuth2GrantType' => 'CLIENT_CREDENTIALS|AUTHORIZATION_CODE|JWT_BEARER', // REQUIRED
                    'tokenUrl' => '<string>', // REQUIRED
                    'tokenUrlCustomProperties' => ['<string>', ...],
                ],
                'profileProperties' => ['<string>', ...],
            ],
            'Datadog' => [
                'instanceUrl' => '<string>', // REQUIRED
            ],
            'Dynatrace' => [
                'instanceUrl' => '<string>', // REQUIRED
            ],
            'GoogleAnalytics' => [
            ],
            'Honeycode' => [
            ],
            'InforNexus' => [
                'instanceUrl' => '<string>', // REQUIRED
            ],
            'Marketo' => [
                'instanceUrl' => '<string>', // REQUIRED
            ],
            'Pardot' => [
                'businessUnitId' => '<string>',
                'instanceUrl' => '<string>',
                'isSandboxEnvironment' => true || false,
            ],
            'Redshift' => [
                'bucketName' => '<string>', // REQUIRED
                'bucketPrefix' => '<string>',
                'clusterIdentifier' => '<string>',
                'dataApiRoleArn' => '<string>',
                'databaseName' => '<string>',
                'databaseUrl' => '<string>',
                'isRedshiftServerless' => true || false,
                'roleArn' => '<string>', // REQUIRED
                'workgroupName' => '<string>',
            ],
            'SAPOData' => [
                'applicationHostUrl' => '<string>', // REQUIRED
                'applicationServicePath' => '<string>', // REQUIRED
                'clientNumber' => '<string>', // REQUIRED
                'disableSSO' => true || false,
                'logonLanguage' => '<string>',
                'oAuthProperties' => [
                    'authCodeUrl' => '<string>', // REQUIRED
                    'oAuthScopes' => ['<string>', ...], // REQUIRED
                    'tokenUrl' => '<string>', // REQUIRED
                ],
                'portNumber' => <integer>, // REQUIRED
                'privateLinkServiceName' => '<string>',
            ],
            'Salesforce' => [
                'instanceUrl' => '<string>',
                'isSandboxEnvironment' => true || false,
                'usePrivateLinkForMetadataAndAuthorization' => 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

Result Syntax

[
    'connectorProfileArn' => '<string>',
]

Result Details

Errors

ValidationException:

The request has invalid or missing parameters.

ResourceNotFoundException:

The resource specified in the request (such as the source or destination connector profile) is not found.

ConflictException:

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.

InternalServerException:

An internal service error occurred during the processing of your request. Try again later.

UpdateConnectorRegistration

$result = $client->updateConnectorRegistration([/* ... */]);
$promise = $client->updateConnectorRegistrationAsync([/* ... */]);

Updates a custom connector that you've previously registered. This operation updates the connector with one of the following:

• The latest version of the AWS Lambda function that's assigned to the connector

• A new AWS Lambda function that you specify

Parameter Syntax

$result = $client->updateConnectorRegistration([
    'clientToken' => '<string>',
    'connectorLabel' => '<string>', // REQUIRED
    'connectorProvisioningConfig' => [
        'lambda' => [
            'lambdaArn' => '<string>', // REQUIRED
        ],
    ],
    'description' => '<string>',
]);

Parameter Details

Result Syntax

[
    'connectorArn' => '<string>',
]

Result Details

Errors

ValidationException:

The request has invalid or missing parameters.

ConflictException:

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.

AccessDeniedException:

AppFlow/Requester has invalid or missing permissions.

ResourceNotFoundException:

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.

ThrottlingException:

API calls have exceeded the maximum allowed API request rate per account and per Region.

InternalServerException:

An internal service error occurred during the processing of your request. Try again later.

ConnectorServerException:

An error occurred when retrieving data from the connector endpoint.

ConnectorAuthenticationException:

An error occurred when authenticating with the connector endpoint.

UpdateFlow

$result = $client->updateFlow([/* ... */]);
$promise = $client->updateFlowAsync([/* ... */]);

Updates an existing flow.

Parameter Syntax

$result = $client->updateFlow([
    'clientToken' => '<string>',
    'description' => '<string>',
    'destinationFlowConfigList' => [ // REQUIRED
        [
            'apiVersion' => '<string>',
            'connectorProfileName' => '<string>',
            'connectorType' => 'Salesforce|Singular|Slack|Redshift|S3|Marketo|Googleanalytics|Zendesk|Servicenow|Datadog|Trendmicro|Snowflake|Dynatrace|Infornexus|Amplitude|Veeva|EventBridge|LookoutMetrics|Upsolver|Honeycode|CustomerProfiles|SAPOData|CustomConnector|Pardot', // REQUIRED
            'destinationConnectorProperties' => [ // REQUIRED
                'CustomConnector' => [
                    'customProperties' => ['<string>', ...],
                    'entityName' => '<string>', // REQUIRED
                    'errorHandlingConfig' => [
                        'bucketName' => '<string>',
                        'bucketPrefix' => '<string>',
                        'failOnFirstDestinationError' => true || false,
                    ],
                    'idFieldNames' => ['<string>', ...],
                    'writeOperationType' => 'INSERT|UPSERT|UPDATE|DELETE',
                ],
                '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' => [
                ],
                'Marketo' => [
                    'errorHandlingConfig' => [
                        'bucketName' => '<string>',
                        'bucketPrefix' => '<string>',
                        'failOnFirstDestinationError' => true || false,
                    ],
                    'object' => '<string>', // REQUIRED
                ],
                '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',
                            'targetFileSize' => <integer>,
                        ],
                        'fileType' => 'CSV|JSON|PARQUET',
                        'prefixConfig' => [
                            'pathPrefixHierarchy' => ['<string>', ...],
                            'prefixFormat' => 'YEAR|MONTH|DAY|HOUR|MINUTE',
                            'prefixType' => 'FILENAME|PATH|PATH_AND_FILENAME',
                        ],
                        'preserveSourceDataTyping' => true || false,
                    ],
                ],
                'SAPOData' => [
                    'errorHandlingConfig' => [
                        'bucketName' => '<string>',
                        'bucketPrefix' => '<string>',
                        'failOnFirstDestinationError' => true || false,
                    ],
                    'idFieldNames' => ['<string>', ...],
                    'objectPath' => '<string>', // REQUIRED
                    'successResponseHandlingConfig' => [
                        'bucketName' => '<string>',
                        'bucketPrefix' => '<string>',
                    ],
                    'writeOperationType' => 'INSERT|UPSERT|UPDATE|DELETE',
                ],
                'Salesforce' => [
                    'dataTransferApi' => 'AUTOMATIC|BULKV2|REST_SYNC',
                    'errorHandlingConfig' => [
                        'bucketName' => '<string>',
                        'bucketPrefix' => '<string>',
                        'failOnFirstDestinationError' => true || false,
                    ],
                    'idFieldNames' => ['<string>', ...],
                    'object' => '<string>', // REQUIRED
                    'writeOperationType' => 'INSERT|UPSERT|UPDATE|DELETE',
                ],
                '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',
                            'targetFileSize' => <integer>,
                        ],
                        'fileType' => 'CSV|JSON|PARQUET',
                        'prefixConfig' => [ // REQUIRED
                            'pathPrefixHierarchy' => ['<string>', ...],
                            '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|DELETE',
                ],
            ],
        ],
        // ...
    ],
    'flowName' => '<string>', // REQUIRED
    'metadataCatalogConfig' => [
        'glueDataCatalog' => [
            'databaseName' => '<string>', // REQUIRED
            'roleArn' => '<string>', // REQUIRED
            'tablePrefix' => '<string>', // REQUIRED
        ],
    ],
    'sourceFlowConfig' => [ // REQUIRED
        'apiVersion' => '<string>',
        'connectorProfileName' => '<string>',
        'connectorType' => 'Salesforce|Singular|Slack|Redshift|S3|Marketo|Googleanalytics|Zendesk|Servicenow|Datadog|Trendmicro|Snowflake|Dynatrace|Infornexus|Amplitude|Veeva|EventBridge|LookoutMetrics|Upsolver|Honeycode|CustomerProfiles|SAPOData|CustomConnector|Pardot', // REQUIRED
        'incrementalPullConfig' => [
            'datetimeTypeFieldName' => '<string>',
        ],
        'sourceConnectorProperties' => [ // REQUIRED
            'Amplitude' => [
                'object' => '<string>', // REQUIRED
            ],
            'CustomConnector' => [
                'customProperties' => ['<string>', ...],
                'dataTransferApi' => [
                    'Name' => '<string>',
                    'Type' => 'SYNC|ASYNC|AUTOMATIC',
                ],
                'entityName' => '<string>', // REQUIRED
            ],
            'Datadog' => [
                'object' => '<string>', // REQUIRED
            ],
            'Dynatrace' => [
                'object' => '<string>', // REQUIRED
            ],
            'GoogleAnalytics' => [
                'object' => '<string>', // REQUIRED
            ],
            'InforNexus' => [
                'object' => '<string>', // REQUIRED
            ],
            'Marketo' => [
                'object' => '<string>', // REQUIRED
            ],
            'Pardot' => [
                'object' => '<string>', // REQUIRED
            ],
            'S3' => [
                'bucketName' => '<string>', // REQUIRED
                'bucketPrefix' => '<string>',
                's3InputFormatConfig' => [
                    's3InputFileType' => 'CSV|JSON',
                ],
            ],
            'SAPOData' => [
                'objectPath' => '<string>',
                'paginationConfig' => [
                    'maxPageSize' => <integer>, // REQUIRED
                ],
                'parallelismConfig' => [
                    'maxParallelism' => <integer>, // REQUIRED
                ],
            ],
            'Salesforce' => [
                'dataTransferApi' => 'AUTOMATIC|BULKV2|REST_SYNC',
                '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' => [
                'documentType' => '<string>',
                'includeAllVersions' => true || false,
                'includeRenditions' => true || false,
                'includeSourceFiles' => true || false,
                'object' => '<string>', // REQUIRED
            ],
            'Zendesk' => [
                'object' => '<string>', // REQUIRED
            ],
        ],
    ],
    'tasks' => [ // REQUIRED
        [
            'connectorOperator' => [
                'Amplitude' => 'BETWEEN',
                'CustomConnector' => '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',
                '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',
                'Pardot' => 'PROJECTION|EQUAL_TO|NO_OP|ADDITION|MULTIPLICATION|DIVISION|SUBTRACTION|MASK_ALL|MASK_FIRST_N|MASK_LAST_N|VALIDATE_NON_NULL|VALIDATE_NON_ZERO|VALIDATE_NON_NEGATIVE|VALIDATE_NUMERIC',
                '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',
                'SAPOData' => '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',
                '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|Map_all|Mask|Merge|Passthrough|Truncate|Validate|Partition', // REQUIRED
        ],
        // ...
    ],
    'triggerConfig' => [ // REQUIRED
        'triggerProperties' => [
            'Scheduled' => [
                'dataPullMode' => 'Incremental|Complete',
                'firstExecutionFrom' => <integer || string || DateTime>,
                'flowErrorDeactivationThreshold' => <integer>,
                'scheduleEndTime' => <integer || string || DateTime>,
                'scheduleExpression' => '<string>', // REQUIRED
                'scheduleOffset' => <integer>,
                'scheduleStartTime' => <integer || string || DateTime>,
                'timezone' => '<string>',
            ],
        ],
        'triggerType' => 'Scheduled|Event|OnDemand', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'flowStatus' => 'Active|Deprecated|Deleted|Draft|Errored|Suspended',
]

Result Details

Errors

ValidationException:

The request has invalid or missing parameters.

ResourceNotFoundException:

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.

ConflictException:

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.

ConnectorServerException:

An error occurred when retrieving data from the connector endpoint.

InternalServerException:

An internal service error occurred during the processing of your request. Try again later.

AccessDeniedException:

AppFlow/Requester has invalid or missing permissions.