# Actions
The following actions are supported:
+ [CancelFlowExecutions](API_CancelFlowExecutions.md)
+ [CreateConnectorProfile](API_CreateConnectorProfile.md)
+ [CreateFlow](API_CreateFlow.md)
+ [DeleteConnectorProfile](API_DeleteConnectorProfile.md)
+ [DeleteFlow](API_DeleteFlow.md)
+ [DescribeConnector](API_DescribeConnector.md)
+ [DescribeConnectorEntity](API_DescribeConnectorEntity.md)
+ [DescribeConnectorProfiles](API_DescribeConnectorProfiles.md)
+ [DescribeConnectors](API_DescribeConnectors.md)
+ [DescribeFlow](API_DescribeFlow.md)
+ [DescribeFlowExecutionRecords](API_DescribeFlowExecutionRecords.md)
+ [ListConnectorEntities](API_ListConnectorEntities.md)
+ [ListConnectors](API_ListConnectors.md)
+ [ListFlows](API_ListFlows.md)
+ [ListTagsForResource](API_ListTagsForResource.md)
+ [RegisterConnector](API_RegisterConnector.md)
+ [ResetConnectorMetadataCache](API_ResetConnectorMetadataCache.md)
+ [StartFlow](API_StartFlow.md)
+ [StopFlow](API_StopFlow.md)
+ [TagResource](API_TagResource.md)
+ [UnregisterConnector](API_UnregisterConnector.md)
+ [UntagResource](API_UntagResource.md)
+ [UpdateConnectorProfile](API_UpdateConnectorProfile.md)
+ [UpdateConnectorRegistration](API_UpdateConnectorRegistration.md)
+ [UpdateFlow](API_UpdateFlow.md)
# CancelFlowExecutions
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`.
**Note**
When you cancel a run, you still incur charges for any data that the run already processed before the cancellation. If the run had already written some data to the flow destination, then that data remains in the destination. If you configured the flow to use a batch API (such as the Salesforce Bulk API 2.0), then the run will finish reading or writing its entire batch of data after the cancellation. For these operations, the data processing charges for Amazon AppFlow apply. For the pricing information, see [Amazon AppFlow pricing](http://aws.amazon.com/appflow/pricing/).
## Request Syntax
```
POST /cancel-flow-executions HTTP/1.1
Content-type: application/json
{
"executionIds": [ "string" ],
"flowName": "string"
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [executionIds](#API_CancelFlowExecutions_RequestSyntax) **
The ID of each active run to cancel. These runs must belong to the flow you specify in your request.
If you omit this parameter, your request ends all active runs that belong to the flow.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 100 items.
Length Constraints: Maximum length of 256.
Pattern: `\S+`
Required: No
** [flowName](#API_CancelFlowExecutions_RequestSyntax) **
The name of a flow with active runs that you want to cancel.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `[a-zA-Z0-9][\w!@#.-]+`
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"invalidExecutions": [ "string" ]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [invalidExecutions](#API_CancelFlowExecutions_ResponseSyntax) **
The IDs of runs that Amazon AppFlow couldn't cancel. These runs might be ineligible for canceling because they haven't started yet or have already completed.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 100 items.
Length Constraints: Maximum length of 256.
Pattern: `\S+`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
AppFlow/Requester has invalid or missing permissions.
HTTP Status Code: 403
** InternalServerException **
An internal service error occurred during the processing of your request. Try again later.
HTTP Status Code: 500
** ResourceNotFoundException **
The resource specified in the request (such as the source or destination connector profile) is not found.
HTTP Status Code: 404
** ThrottlingException **
API calls have exceeded the maximum allowed API request rate per account and per Region.
HTTP Status Code: 429
** ValidationException **
The request has invalid or missing parameters.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appflow-2020-08-23/CancelFlowExecutions)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appflow-2020-08-23/CancelFlowExecutions)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appflow-2020-08-23/CancelFlowExecutions)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appflow-2020-08-23/CancelFlowExecutions)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appflow-2020-08-23/CancelFlowExecutions)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appflow-2020-08-23/CancelFlowExecutions)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appflow-2020-08-23/CancelFlowExecutions)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appflow-2020-08-23/CancelFlowExecutions)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appflow-2020-08-23/CancelFlowExecutions)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appflow-2020-08-23/CancelFlowExecutions)
# CreateConnectorProfile
Creates a new connector profile associated with your AWS account. There is a soft quota of 100 connector profiles per AWS account. If you need more connector profiles than this quota allows, you can submit a request to the Amazon AppFlow team through the Amazon AppFlow support channel. In each connector profile that you create, you can provide the credentials and properties for only one connector.
## Request Syntax
```
POST /create-connector-profile HTTP/1.1
Content-type: application/json
{
"clientToken": "string",
"connectionMode": "string",
"connectorLabel": "string",
"connectorProfileConfig": {
"connectorProfileCredentials": {
"Amplitude": {
"apiKey": "string",
"secretKey": "string"
},
"CustomConnector": {
"apiKey": {
"apiKey": "string",
"apiSecretKey": "string"
},
"authenticationType": "string",
"basic": {
"password": "string",
"username": "string"
},
"custom": {
"credentialsMap": {
"string" : "string"
},
"customAuthenticationType": "string"
},
"oauth2": {
"accessToken": "string",
"clientId": "string",
"clientSecret": "string",
"oAuthRequest": {
"authCode": "string",
"redirectUri": "string"
},
"refreshToken": "string"
}
},
"Datadog": {
"apiKey": "string",
"applicationKey": "string"
},
"Dynatrace": {
"apiToken": "string"
},
"GoogleAnalytics": {
"accessToken": "string",
"clientId": "string",
"clientSecret": "string",
"oAuthRequest": {
"authCode": "string",
"redirectUri": "string"
},
"refreshToken": "string"
},
"Honeycode": {
"accessToken": "string",
"oAuthRequest": {
"authCode": "string",
"redirectUri": "string"
},
"refreshToken": "string"
},
"InforNexus": {
"accessKeyId": "string",
"datakey": "string",
"secretAccessKey": "string",
"userId": "string"
},
"Marketo": {
"accessToken": "string",
"clientId": "string",
"clientSecret": "string",
"oAuthRequest": {
"authCode": "string",
"redirectUri": "string"
}
},
"Pardot": {
"accessToken": "string",
"clientCredentialsArn": "string",
"oAuthRequest": {
"authCode": "string",
"redirectUri": "string"
},
"refreshToken": "string"
},
"Redshift": {
"password": "string",
"username": "string"
},
"Salesforce": {
"accessToken": "string",
"clientCredentialsArn": "string",
"jwtToken": "string",
"oAuth2GrantType": "string",
"oAuthRequest": {
"authCode": "string",
"redirectUri": "string"
},
"refreshToken": "string"
},
"SAPOData": {
"basicAuthCredentials": {
"password": "string",
"username": "string"
},
"oAuthCredentials": {
"accessToken": "string",
"clientId": "string",
"clientSecret": "string",
"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"
},
"Slack": {
"accessToken": "string",
"clientId": "string",
"clientSecret": "string",
"oAuthRequest": {
"authCode": "string",
"redirectUri": "string"
}
},
"Snowflake": {
"password": "string",
"username": "string"
},
"Trendmicro": {
"apiSecretKey": "string"
},
"Veeva": {
"password": "string",
"username": "string"
},
"Zendesk": {
"accessToken": "string",
"clientId": "string",
"clientSecret": "string",
"oAuthRequest": {
"authCode": "string",
"redirectUri": "string"
}
}
},
"connectorProfileProperties": {
"Amplitude": {
},
"CustomConnector": {
"oAuth2Properties": {
"oAuth2GrantType": "string",
"tokenUrl": "string",
"tokenUrlCustomProperties": {
"string" : "string"
}
},
"profileProperties": {
"string" : "string"
}
},
"Datadog": {
"instanceUrl": "string"
},
"Dynatrace": {
"instanceUrl": "string"
},
"GoogleAnalytics": {
},
"Honeycode": {
},
"InforNexus": {
"instanceUrl": "string"
},
"Marketo": {
"instanceUrl": "string"
},
"Pardot": {
"businessUnitId": "string",
"instanceUrl": "string",
"isSandboxEnvironment": boolean
},
"Redshift": {
"bucketName": "string",
"bucketPrefix": "string",
"clusterIdentifier": "string",
"dataApiRoleArn": "string",
"databaseName": "string",
"databaseUrl": "string",
"isRedshiftServerless": boolean,
"roleArn": "string",
"workgroupName": "string"
},
"Salesforce": {
"instanceUrl": "string",
"isSandboxEnvironment": boolean,
"usePrivateLinkForMetadataAndAuthorization": boolean
},
"SAPOData": {
"applicationHostUrl": "string",
"applicationServicePath": "string",
"clientNumber": "string",
"disableSSO": boolean,
"logonLanguage": "string",
"oAuthProperties": {
"authCodeUrl": "string",
"oAuthScopes": [ "string" ],
"tokenUrl": "string"
},
"portNumber": number,
"privateLinkServiceName": "string"
},
"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"
}
}
},
"connectorProfileName": "string",
"connectorType": "string",
"kmsArn": "string"
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [clientToken](#API_CreateConnectorProfile_RequestSyntax) **
The `clientToken` parameter is an idempotency token. It ensures that your `CreateConnectorProfile` request completes only once. You choose the value to pass. For example, if you don't receive a response from your request, you can safely retry the request with the same `clientToken` parameter value.
If you omit a `clientToken` value, the AWS SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases.
If you specify input parameters that differ from your first request, an error occurs. If you use a different value for `clientToken`, Amazon AppFlow considers it a new call to `CreateConnectorProfile`. The token is active for 8 hours.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `[ -~]+`
Required: No
** [connectionMode](#API_CreateConnectorProfile_RequestSyntax) **
Indicates the connection mode and specifies whether it is public or private. Private flows use AWS PrivateLink to route data over AWS infrastructure without exposing it to the public internet.
Type: String
Valid Values: `Public | Private`
Required: Yes
** [connectorLabel](#API_CreateConnectorProfile_RequestSyntax) **
The label of the connector. The label is unique for each `ConnectorRegistration` in your AWS account. Only needed if calling for CUSTOMCONNECTOR connector type/.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `[a-zA-Z0-9][\w!@#.-]+`
Required: No
** [connectorProfileConfig](#API_CreateConnectorProfile_RequestSyntax) **
Defines the connector-specific configuration and credentials.
Type: [ConnectorProfileConfig](API_ConnectorProfileConfig.md) object
Required: Yes
** [connectorProfileName](#API_CreateConnectorProfile_RequestSyntax) **
The name of the connector profile. The name is unique for each `ConnectorProfile` in your AWS account.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `[\w/!@#+=.-]+`
Required: Yes
** [connectorType](#API_CreateConnectorProfile_RequestSyntax) **
The type of connector, such as Salesforce, Amplitude, and so on.
Type: String
Valid Values: `Salesforce | Singular | Slack | Redshift | S3 | Marketo | Googleanalytics | Zendesk | Servicenow | Datadog | Trendmicro | Snowflake | Dynatrace | Infornexus | Amplitude | Veeva | EventBridge | LookoutMetrics | Upsolver | Honeycode | CustomerProfiles | SAPOData | CustomConnector | Pardot`
Required: Yes
** [kmsArn](#API_CreateConnectorProfile_RequestSyntax) **
The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. This is required if you do not want to use the Amazon AppFlow-managed KMS key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern: `arn:aws:kms:.*:[0-9]+:.*`
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"connectorProfileArn": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [connectorProfileArn](#API_CreateConnectorProfile_ResponseSyntax) **
The Amazon Resource Name (ARN) of the connector profile.
Type: String
Length Constraints: Maximum length of 512.
Pattern: `arn:aws:appflow:.*:[0-9]+:.*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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.
HTTP Status Code: 409
** ConnectorAuthenticationException **
An error occurred when authenticating with the connector endpoint.
HTTP Status Code: 401
** InternalServerException **
An internal service error occurred during the processing of your request. Try again later.
HTTP Status Code: 500
** ServiceQuotaExceededException **
The request would cause a service quota (such as the number of flows) to be exceeded.
HTTP Status Code: 402
** ValidationException **
The request has invalid or missing parameters.
HTTP Status Code: 400
## Examples
### CustomConnector
This example shows a sample request for the `CreateConnectorProfile` API (without OAuth) and a sample response.
#### Sample Request
```
{
"connectorProfileName": "Connector_Profile_Name_Value",
"kmsArn": null,
"connectorType": "CUSTOMCONNECTOR",
"connectorLabel": "MyCustomConnector",
"connectionMode": "Public",
"connectorProfileConfig":
{
"connectorProfileProperties":
{
"salesforce":
{
"instanceUrl": "InstanceUrl_value",
"isSandboxEnvironment": false
}
},
"connectorProfileCredentials":
{
"salesforce":
{
"accessToken": "",
"refreshToken": "",
"oauthRequest":
{
"authCode": null,
"redirectUri": null
}
}
}
}
}
```
#### Sample Response
```
{
"connectorProfileArn": "arn:aws:appflow:region::connectorprofile/Connector_Profile_Name"
}
```
### Salesforce without OAuth
This example shows a sample request for the `CreateConnectorProfile` API (without OAuth) and a sample response.
#### Sample Request
```
{
"connectorProfileName": "Connector_Profile_Name_Value",
"kmsArn": null,
"connectorType": "Salesforce",
"connectorLabel": "Salesforce",
"connectionMode": "Public",
"connectorProfileConfig": {
"connectorProfileProperties": {
"salesforce": {
"instanceUrl": "InstanceUrl_value",
"isSandboxEnvironment": false
}
},
"connectorProfileCredentials": {
"salesforce": {
"accessToken": "",
"refreshToken": "",
"oauthRequest": {
"authCode": null,
"redirectUri": null
}
}
}
}
}
```
#### Sample Response
```
{
"connectorProfileArn": "arn:aws:appflow:region::connectorprofile/Connector_Profile_Name"
}
```
### Salesforce with OAuth
These examples show a request with OAuth and a sample response.
#### Sample Request
```
{
"connectorProfileName": "connector-profile-name_value",
"kmsArn": null,
"connectorType": "Salesforce",
"connectionMode": "Public",
"connectorProfileConfig": {
"connectorProfileProperties": {
"salesforce": {
"isSandboxEnvironment": false
}
},
"connectorProfileCredentials": {
"salesforce": {
"oauthRequest": {
"authCode": "",
"redirectUri": "redirectUri"
}
}
}
}
}
```
#### Sample Response
```
{
"connectorProfileArn": "arn:aws:appflow:region::connectorprofile/connector-profile-name"
}
```
### Zendesk
This example shows a sample request and response for the `CreateConnectorProfile` API using Zendesk.
#### Sample Request
```
{
"connectorProfileName": "connector-profile-name",
"connectorType": "Zendesk",
"connectionMode": "Public",
"connectorProfileConfig": {
"connectorProfileProperties": {
"zendesk": {
"instanceUrl": "Zendesk_Url"
}
},
"connectorProfileCredentials": {
"zendesk": {
"clientId": "aws_integration_to_zendesk",
"clientSecret": "",
"accessToken": "",
"oauthRequest": {
"authCode": null,
"redirectUri": null
}
}
}
}
}
```
#### Sample Response
```
{
"connectorProfileArn": "arn:aws:appflow:region::connectorprofile/connector-profile-name"
}
```
### Google Analytics
This example shows a sample request and response for the `CreateConnectorProfile` API using Google Analytics.
#### Sample Request
```
{
"connectorProfileName": "connector-profile-name",
"connectorType": "Googleanalytics",
"connectionMode": "Public",
"connectorProfileConfig": {
"connectorProfileProperties": {
"googleAnalytics": {}
},
"connectorProfileCredentials": {
"googleAnalytics": {
"clientId": "",
"clientSecret": "",
"accessToken": "",
"refreshToken": "",
"oauthRequest": {
"authCode": null,
"redirectUri": null
}
}
}
}
}
```
```
{
"connectorProfileArn": "arn:aws:appflow:region::connectorprofile/connector-profile-name"
}
```
### Marketo
This example shows a sample request and response for the `CreateConnectorProfile` API using Marketo.
#### Sample Request
```
{
"connectorProfileName": "Connector-profile-new",
"connectorType": "Marketo",
"connectionMode": "Public",
"connectorProfileConfig": {
"connectorProfileProperties": {
"marketo": {
"instanceUrl": "Marketo_Url"
}
},
"connectorProfileCredentials": {
"marketo": {
"clientId": ">",
"clientSecret": "",
"accessToken": "",
"oauthRequest": {
"authCode": null,
"redirectUri": null
}
}
}
}
}
```
#### Sample Response
```
{
"connectorProfileArn": "arn:aws:appflow:region::connectorprofile/Connector-profile-new"
}
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appflow-2020-08-23/CreateConnectorProfile)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appflow-2020-08-23/CreateConnectorProfile)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appflow-2020-08-23/CreateConnectorProfile)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appflow-2020-08-23/CreateConnectorProfile)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appflow-2020-08-23/CreateConnectorProfile)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appflow-2020-08-23/CreateConnectorProfile)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appflow-2020-08-23/CreateConnectorProfile)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appflow-2020-08-23/CreateConnectorProfile)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appflow-2020-08-23/CreateConnectorProfile)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appflow-2020-08-23/CreateConnectorProfile)
# CreateFlow
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.
## Request Syntax
```
POST /create-flow HTTP/1.1
Content-type: application/json
{
"clientToken": "string",
"description": "string",
"destinationFlowConfigList": [
{
"apiVersion": "string",
"connectorProfileName": "string",
"connectorType": "string",
"destinationConnectorProperties": {
"CustomConnector": {
"customProperties": {
"string" : "string"
},
"entityName": "string",
"errorHandlingConfig": {
"bucketName": "string",
"bucketPrefix": "string",
"failOnFirstDestinationError": boolean
},
"idFieldNames": [ "string" ],
"writeOperationType": "string"
},
"CustomerProfiles": {
"domainName": "string",
"objectTypeName": "string"
},
"EventBridge": {
"errorHandlingConfig": {
"bucketName": "string",
"bucketPrefix": "string",
"failOnFirstDestinationError": boolean
},
"object": "string"
},
"Honeycode": {
"errorHandlingConfig": {
"bucketName": "string",
"bucketPrefix": "string",
"failOnFirstDestinationError": boolean
},
"object": "string"
},
"LookoutMetrics": {
},
"Marketo": {
"errorHandlingConfig": {
"bucketName": "string",
"bucketPrefix": "string",
"failOnFirstDestinationError": boolean
},
"object": "string"
},
"Redshift": {
"bucketPrefix": "string",
"errorHandlingConfig": {
"bucketName": "string",
"bucketPrefix": "string",
"failOnFirstDestinationError": boolean
},
"intermediateBucketName": "string",
"object": "string"
},
"S3": {
"bucketName": "string",
"bucketPrefix": "string",
"s3OutputFormatConfig": {
"aggregationConfig": {
"aggregationType": "string",
"targetFileSize": number
},
"fileType": "string",
"prefixConfig": {
"pathPrefixHierarchy": [ "string" ],
"prefixFormat": "string",
"prefixType": "string"
},
"preserveSourceDataTyping": boolean
}
},
"Salesforce": {
"dataTransferApi": "string",
"errorHandlingConfig": {
"bucketName": "string",
"bucketPrefix": "string",
"failOnFirstDestinationError": boolean
},
"idFieldNames": [ "string" ],
"object": "string",
"writeOperationType": "string"
},
"SAPOData": {
"errorHandlingConfig": {
"bucketName": "string",
"bucketPrefix": "string",
"failOnFirstDestinationError": boolean
},
"idFieldNames": [ "string" ],
"objectPath": "string",
"successResponseHandlingConfig": {
"bucketName": "string",
"bucketPrefix": "string"
},
"writeOperationType": "string"
},
"Snowflake": {
"bucketPrefix": "string",
"errorHandlingConfig": {
"bucketName": "string",
"bucketPrefix": "string",
"failOnFirstDestinationError": boolean
},
"intermediateBucketName": "string",
"object": "string"
},
"Upsolver": {
"bucketName": "string",
"bucketPrefix": "string",
"s3OutputFormatConfig": {
"aggregationConfig": {
"aggregationType": "string",
"targetFileSize": number
},
"fileType": "string",
"prefixConfig": {
"pathPrefixHierarchy": [ "string" ],
"prefixFormat": "string",
"prefixType": "string"
}
}
},
"Zendesk": {
"errorHandlingConfig": {
"bucketName": "string",
"bucketPrefix": "string",
"failOnFirstDestinationError": boolean
},
"idFieldNames": [ "string" ],
"object": "string",
"writeOperationType": "string"
}
}
}
],
"flowName": "string",
"kmsArn": "string",
"metadataCatalogConfig": {
"glueDataCatalog": {
"databaseName": "string",
"roleArn": "string",
"tablePrefix": "string"
}
},
"sourceFlowConfig": {
"apiVersion": "string",
"connectorProfileName": "string",
"connectorType": "string",
"incrementalPullConfig": {
"datetimeTypeFieldName": "string"
},
"sourceConnectorProperties": {
"Amplitude": {
"object": "string"
},
"CustomConnector": {
"customProperties": {
"string" : "string"
},
"dataTransferApi": {
"Name": "string",
"Type": "string"
},
"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": "string"
}
},
"Salesforce": {
"dataTransferApi": "string",
"enableDynamicFieldUpdate": boolean,
"includeDeletedRecords": boolean,
"object": "string"
},
"SAPOData": {
"objectPath": "string",
"paginationConfig": {
"maxPageSize": number
},
"parallelismConfig": {
"maxParallelism": number
}
},
"ServiceNow": {
"object": "string"
},
"Singular": {
"object": "string"
},
"Slack": {
"object": "string"
},
"Trendmicro": {
"object": "string"
},
"Veeva": {
"documentType": "string",
"includeAllVersions": boolean,
"includeRenditions": boolean,
"includeSourceFiles": boolean,
"object": "string"
},
"Zendesk": {
"object": "string"
}
}
},
"tags": {
"string" : "string"
},
"tasks": [
{
"connectorOperator": {
"Amplitude": "string",
"CustomConnector": "string",
"Datadog": "string",
"Dynatrace": "string",
"GoogleAnalytics": "string",
"InforNexus": "string",
"Marketo": "string",
"Pardot": "string",
"S3": "string",
"Salesforce": "string",
"SAPOData": "string",
"ServiceNow": "string",
"Singular": "string",
"Slack": "string",
"Trendmicro": "string",
"Veeva": "string",
"Zendesk": "string"
},
"destinationField": "string",
"sourceFields": [ "string" ],
"taskProperties": {
"string" : "string"
},
"taskType": "string"
}
],
"triggerConfig": {
"triggerProperties": {
"Scheduled": {
"dataPullMode": "string",
"firstExecutionFrom": number,
"flowErrorDeactivationThreshold": number,
"scheduleEndTime": number,
"scheduleExpression": "string",
"scheduleOffset": number,
"scheduleStartTime": number,
"timezone": "string"
}
},
"triggerType": "string"
}
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [clientToken](#API_CreateFlow_RequestSyntax) **
The `clientToken` parameter is an idempotency token. It ensures that your `CreateFlow` request completes only once. You choose the value to pass. For example, if you don't receive a response from your request, you can safely retry the request with the same `clientToken` parameter value.
If you omit a `clientToken` value, the AWS SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases.
If you specify input parameters that differ from your first request, an error occurs. If you use a different value for `clientToken`, Amazon AppFlow considers it a new call to `CreateFlow`. The token is active for 8 hours.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `[ -~]+`
Required: No
** [description](#API_CreateFlow_RequestSyntax) **
A description of the flow you want to create.
Type: String
Length Constraints: Maximum length of 2048.
Pattern: `[\w!@#\-.?,\s]*`
Required: No
** [destinationFlowConfigList](#API_CreateFlow_RequestSyntax) **
The configuration that controls how Amazon AppFlow places data in the destination connector.
Type: Array of [DestinationFlowConfig](API_DestinationFlowConfig.md) objects
Required: Yes
** [flowName](#API_CreateFlow_RequestSyntax) **
The specified name of the flow. Spaces are not allowed. Use underscores (\$1) or hyphens (-) only.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `[a-zA-Z0-9][\w!@#.-]+`
Required: Yes
** [kmsArn](#API_CreateFlow_RequestSyntax) **
The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. This is required if you do not want to use the Amazon AppFlow-managed KMS key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern: `arn:aws:kms:.*:[0-9]+:.*`
Required: No
** [metadataCatalogConfig](#API_CreateFlow_RequestSyntax) **
Specifies the configuration that Amazon AppFlow uses when it catalogs the data that's transferred by the associated flow. When Amazon AppFlow catalogs the data from a flow, it stores metadata in a data catalog.
Type: [MetadataCatalogConfig](API_MetadataCatalogConfig.md) object
Required: No
** [sourceFlowConfig](#API_CreateFlow_RequestSyntax) **
The configuration that controls how Amazon AppFlow retrieves data from the source connector.
Type: [SourceFlowConfig](API_SourceFlowConfig.md) object
Required: Yes
** [tags](#API_CreateFlow_RequestSyntax) **
The tags used to organize, track, or control access for your flow.
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`
Value Length Constraints: Maximum length of 256.
Value Pattern: `[\s\w+-=\.:/@]*`
Required: No
** [tasks](#API_CreateFlow_RequestSyntax) **
A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
Type: Array of [Task](API_Task.md) objects
Required: Yes
** [triggerConfig](#API_CreateFlow_RequestSyntax) **
The trigger settings that determine how and when the flow runs.
Type: [TriggerConfig](API_TriggerConfig.md) object
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"flowArn": "string",
"flowStatus": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [flowArn](#API_CreateFlow_ResponseSyntax) **
The flow's Amazon Resource Name (ARN).
Type: String
Length Constraints: Maximum length of 512.
Pattern: `arn:aws:appflow:.*:[0-9]+:.*`
** [flowStatus](#API_CreateFlow_ResponseSyntax) **
Indicates the current status of the flow.
Type: String
Valid Values: `Active | Deprecated | Deleted | Draft | Errored | Suspended`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
AppFlow/Requester has invalid or missing permissions.
HTTP Status Code: 403
** 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.
HTTP Status Code: 409
** ConnectorAuthenticationException **
An error occurred when authenticating with the connector endpoint.
HTTP Status Code: 401
** ConnectorServerException **
An error occurred when retrieving data from the connector endpoint.
HTTP Status Code: 400
** InternalServerException **
An internal service error occurred during the processing of your request. Try again later.
HTTP Status Code: 500
** ResourceNotFoundException **
The resource specified in the request (such as the source or destination connector profile) is not found.
HTTP Status Code: 404
** ServiceQuotaExceededException **
The request would cause a service quota (such as the number of flows) to be exceeded.
HTTP Status Code: 402
** ValidationException **
The request has invalid or missing parameters.
HTTP Status Code: 400
## Examples
### Salesforce
This example shows a sample request for the `CreateFlow` API using Salesforce. If you see the error shown in the second sample, it is because of an expired access or refresh token. Retrieve a new access or refresh token to proceed.
#### Sample Request
```
{
"flowName": "testFlowSaleforce",
"description": "TestFlow",
"triggerConfig": {
"triggerType": "Scheduled",
"triggerProperties": {
"scheduledTriggerProperties" : {
"scheduleExpression" : "rate(1minutes)"
}
}
},
"sourceFlowConfig": {
"connectorType": "Salesforce",
"connectorLabel":"MyCustomConnector",
"connectorProfileName": "Connector_Profile_Name",
"sourceConnectorProperties": {
"salesforce": {
"object": "account"
}
}
},
"destinationFlowConfigList": [
{
"connectorType": "S3",
"connectorLabel":"MyCustomConnector",
"destinationConnectorProperties": {
"s3": {
"bucketName": "BucketName",
"bucketKey": "BucketKey"
}
}
}
],
"tasks": [
{
"sourceFields": [
"CreatedDate"
],
"taskProperties": {
},
"destinationField": "CreatedDate",
"taskType": "Map"
},
{
"destinationField": "LastActivityDate",
"sourceFields": [
"LastActivityDate"
],
"taskProperties": {
},
"taskType": "Map"
}
]
}
```
```
{
"message": "Error while authenticating to connector"
}
```
### Zendesk
This example shows a sample request for the `CreateFlow` API using Zendesk.
#### Sample Request
```
{
"useDefaultEncryption": false,
"flowName": "testFlowZendesk",
"description": "TestFlow",
"triggerConfig": {
"triggerType": "Scheduled",
"triggerProperties": {
"scheduledTriggerProperties" : {
"scheduleExpression" : "rate(1minutes)"
}
}
},
"sourceFlowConfig": {
"connectorType": "Zendesk",
"connectorProfileName": "connector-profile-name",
"sourceConnectorProperties": {
"zendesk": {
"object": "tickets"
}
}
},
"destinationFlowConfigList": [
{
"connectorType": "S3",
"connectorProfileName": "Test",
"destinationConnectorProperties": {
"s3": {
"bucketName": "BucketName",
"bucketKey": "BucketKey"
}
}
}
],
"tasks": [
{
"destinationField": "url",
"sourceFields": [
"url"
],
"taskProperties": {
"SOURCE_DATA_TYPE": "integer"
},
"taskType": "Map"
}
]
}
```
### Google Analytics
This example shows a sample request for the `CreateFlow` API using Google Analytics.
#### Sample Request
```
{
"useDefaultEncryption": false,
"flowName": "testFlowGAnalytics",
"description": "TestFlow",
"triggerConfig": {
"triggerType": "Scheduled",
"triggerProperties": {
"scheduledTriggerProperties" : {
"scheduleExpression" : "rate(1minutes)"
}
}
},
"sourceFlowConfig": {
"connectorType": "Googleanalytics",
"connectorProfileName": "connector-profile-name",
"sourceConnectorProperties": {
"googleanalytics": {
"object": "ObjectID"
}
}
},
"destinationFlowConfigList": [
{
"connectorType": "S3",
"connectorProfileName": "Test",
"destinationConnectorProperties": {
"s3": {
"bucketName": "BucketName",
"bucketKey": "BucketKey"
}
}
}
],
"tasks": [
{
"destinationField": "url",
"sourceFields": [
"url"
],
"taskProperties": {
"SOURCE_DATA_TYPE": "integer"
},
"taskType": "Map"
}
]
}
```
### Marketo
This example shows a sample request for the `CreateFlow` API using Marketo.
#### Sample Request
```
{
"flowName": "testMarketo",
"description": "TestFlow",
"triggerConfig": {
"triggerType": "Scheduled",
"triggerProperties": {
"scheduledTriggerProperties" : {
"scheduleExpression" : "rate(1minutes)"
}
}
},
"sourceFlowConfig": {
"connectorType": "Marketo",
"connectorProfileName": "Connector-profile-new",
"sourceConnectorProperties": {
"marketo": {
"object": "leads"
}
}
},
"destinationFlowConfigList": [
{
"connectorType": "S3",
"connectorProfileName": "Test",
"destinationConnectorProperties": {
"s3": {
"bucketName": "BucketName",
"bucketKey": "BucketKey"
}
}
}
],
"tasks": [
{
"connectorOperator": {
"marketo":"BETWEEN"
},
"sourceFields": [
"updatedAt"
],
"taskProperties": {
"DATA_TYPE": "datetime",
"LOWER_BOUND": "Lower_Bound_value",
"UPPER_BOUND": "Upper_Bound_value"
},
"taskType": "Filter"
},
{
"destinationField": "company",
"sourceFields": [
"company"
],
"taskProperties": {
"SOURCE_DATA_TYPE": "string"
},
"taskType": "Map"
}
]
}
```
### Connection credentials
This Java example shows credentials associated with a connection. In this case, the example uses OAuth. These credentials are stored in secrets manager after the profile is created.
```
ConnectorProfileCredentials credentials = new ConnectorProfileCredentials().withSalesforce(
new SalesforceConnectorProfileCredentials().withAccessToken(accessToken)
.withRefreshToken(refreshToken));
```
### Connection properties
This Java example shows other properties associated with a connection to Salesforce.
```
ConnectorProfileProperties properties = new ConnectorProfileProperties().withSalesforce(
new SalesforceConnectorProfileProperties().withInstanceUrl(instanceUrl));
```
### Connector profile creation
To create a flow, you must first create a connector profile. This Java example shows information about connecting to Salesforce.
```
amazonAppflow.createConnectorProfile(new CreateConnectorProfileRequest().withConnectorProfileConfig(
new ConnectorProfileConfig().withConnectorProfileCredentials(credentials)
.withConnectorProfileProperties(properties))
.withConnectorProfileName(salesforceProfileName)
.withConnectorType(ConnectorType.Salesforce)
.withConnectionMode(ConnectionMode.Public));
```
### Source connection properties
This Java example shows properties for a source connection. `Account` is the object in Salesforce that we want to retrieve. You can find a list of all supported objects by using the `listConnectorEntity` API. The `ConnectorProfileName` is the connector profile, the creation of which is seen in the previous example.
```
SourceFlowConfig sourceFlowConfig = new SourceFlowConfig().withSourceConnectorProperties(
new SourceConnectorProperties().withSalesforce(new SalesforceSourceProperties().withObject("Account")))
.withConnectorType(ConnectorType.Salesforce)
.withConnectorProfileName(salesforceProfileName);
```
### Destination connection properties
This Java example shows properties for a destination connection. Note that many AWS connectors such as Amazon S3 don't require a connector profile. Amazon AppFlow accesses S3 buckets through a bucket resource policy, therefore a connector profile isn't needed.
```
DestinationFlowConfig destinationFlowConfig = new DestinationFlowConfig().withConnectorType(ConnectorType.S3)
.withDestinationConnectorProperties(new DestinationConnectorProperties().withS3(
new S3DestinationProperties().withBucketName(bucketName).withBucketPrefix("testPrefix")));
```
### Tasks
Tasks describe what to do with the data once it has been retrieved, but before it is sent to the destination. Most connectors require a projection task. A projection task describes what fields should be retrieved from the source object. Fields that can be retrieved can be discovered by making a call to the `DescribeConnectorEntity` API.
```
Task projectionTask = new Task().withTaskType(TaskType.Filter)
.withConnectorOperator(new ConnectorOperator().withSalesforce(SalesforceConnectorOperator.PROJECTION))
.withSourceFields("Id", "Name");
```
### Mapping task
Most flows also require at least one mapping task. Mapping tasks map a source field to a destination field. This Java example shows the mapping between the retrieved field, `Id`, to a new field, `AccountId`.
```
Task createdMappingTask = new Task().withTaskType(TaskType.Map)
.withConnectorOperator(new ConnectorOperator().withSalesforce(SalesforceConnectorOperator.NO_OP))
.withSourceFields("Id")
.withDestinationField("AccountId");
amazonAppflow.createFlow(new CreateFlowRequest().withFlowName(salesforceFlowName)
.withTriggerConfig(new TriggerConfig().withTriggerType(TriggerType.OnDemand))
.withSourceFlowConfig(sourceFlowConfig)
.withDestinationFlowConfigList(destinationFlowConfig)
.withTasks(projectionTask, idMappingTask, createdMappingTask));
```
### Sample imports
This Java example shows sample imports.
```
import com.amazonaws.services.appflow.AmazonAppflow;
import com.amazonaws.services.appflow.model.ConnectionMode;
import com.amazonaws.services.appflow.model.ConnectorOperator;
import com.amazonaws.services.appflow.model.ConnectorProfileConfig;
import com.amazonaws.services.appflow.model.ConnectorProfileCredentials;
import com.amazonaws.services.appflow.model.ConnectorProfileProperties;
import com.amazonaws.services.appflow.model.ConnectorType;
import com.amazonaws.services.appflow.model.CreateConnectorProfileRequest;
import com.amazonaws.services.appflow.model.CreateFlowRequest;
import com.amazonaws.services.appflow.model.DeleteConnectorProfileRequest;
import com.amazonaws.services.appflow.model.DeleteFlowRequest;
import com.amazonaws.services.appflow.model.DestinationConnectorProperties;
import com.amazonaws.services.appflow.model.DestinationFlowConfig;
import com.amazonaws.services.appflow.model.S3DestinationProperties;
import com.amazonaws.services.appflow.model.SalesforceConnectorOperator;
import com.amazonaws.services.appflow.model.SalesforceConnectorProfileCredentials;
import com.amazonaws.services.appflow.model.SalesforceConnectorProfileProperties;
import com.amazonaws.services.appflow.model.SalesforceSourceProperties;
import com.amazonaws.services.appflow.model.SourceConnectorProperties;
import com.amazonaws.services.appflow.model.SourceFlowConfig;
import com.amazonaws.services.appflow.model.Task;
import com.amazonaws.services.appflow.model.TaskType;
import com.amazonaws.services.appflow.model.TriggerConfig;
import com.amazonaws.services.appflow.model.TriggerType;
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appflow-2020-08-23/CreateFlow)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appflow-2020-08-23/CreateFlow)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appflow-2020-08-23/CreateFlow)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appflow-2020-08-23/CreateFlow)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appflow-2020-08-23/CreateFlow)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appflow-2020-08-23/CreateFlow)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appflow-2020-08-23/CreateFlow)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appflow-2020-08-23/CreateFlow)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appflow-2020-08-23/CreateFlow)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appflow-2020-08-23/CreateFlow)
# DeleteConnectorProfile
Enables you to delete an existing connector profile.
## Request Syntax
```
POST /delete-connector-profile HTTP/1.1
Content-type: application/json
{
"connectorProfileName": "string",
"forceDelete": boolean
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [connectorProfileName](#API_DeleteConnectorProfile_RequestSyntax) **
The name of the connector profile. The name is unique for each `ConnectorProfile` in your account.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `[\w/!@#+=.-]+`
Required: Yes
** [forceDelete](#API_DeleteConnectorProfile_RequestSyntax) **
Indicates whether Amazon AppFlow should delete the profile, even if it is currently in use in one or more flows.
Type: Boolean
Required: No
## Response Syntax
```
HTTP/1.1 200
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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.
HTTP Status Code: 409
** InternalServerException **
An internal service error occurred during the processing of your request. Try again later.
HTTP Status Code: 500
** ResourceNotFoundException **
The resource specified in the request (such as the source or destination connector profile) is not found.
HTTP Status Code: 404
## Examples
### Marketo
This example shows a sample request and response for the `CreateConnectorProfile` API using Marketo. If `forceDelete` is false, and there are flows associated, you will see a message similar to that shown in the third sample.
#### Sample Request
```
{
"connectorProfileName": "testMarketoProfile",
"forceDelete": "true"
}
```
#### Sample Response
```
{
"deleted": true,
"flowNames": null
}
```
```
{
"message": "Conflict executing request: Connector profile: testMarketoProfile is associated with one or more flows. If you still want to *delete* it, *then* make *delete* request *with* forceDelete flag *as* true. *Some* of the associated flows are: [myTestFlow1]"
}
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appflow-2020-08-23/DeleteConnectorProfile)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appflow-2020-08-23/DeleteConnectorProfile)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appflow-2020-08-23/DeleteConnectorProfile)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appflow-2020-08-23/DeleteConnectorProfile)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appflow-2020-08-23/DeleteConnectorProfile)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appflow-2020-08-23/DeleteConnectorProfile)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appflow-2020-08-23/DeleteConnectorProfile)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appflow-2020-08-23/DeleteConnectorProfile)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appflow-2020-08-23/DeleteConnectorProfile)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appflow-2020-08-23/DeleteConnectorProfile)
# DeleteFlow
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.
## Request Syntax
```
POST /delete-flow HTTP/1.1
Content-type: application/json
{
"flowName": "string",
"forceDelete": boolean
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [flowName](#API_DeleteFlow_RequestSyntax) **
The specified name of the flow. Spaces are not allowed. Use underscores (\$1) or hyphens (-) only.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `[a-zA-Z0-9][\w!@#.-]+`
Required: Yes
** [forceDelete](#API_DeleteFlow_RequestSyntax) **
Indicates whether Amazon AppFlow should delete the flow, even if it is currently in use.
Type: Boolean
Required: No
## Response Syntax
```
HTTP/1.1 200
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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.
HTTP Status Code: 409
** InternalServerException **
An internal service error occurred during the processing of your request. Try again later.
HTTP Status Code: 500
** ResourceNotFoundException **
The resource specified in the request (such as the source or destination connector profile) is not found.
HTTP Status Code: 404
## Examples
### An active scheduled flow with forceDelete false
This example shows an active scheduled flow with `forceDelete` false. The result is that a conflict exception is thrown.
#### Sample Request
```
{
"flowName": "flowName_value"
}
```
#### Sample Response
```
{
"message": "Conflict executing request: Flow is in active state, please set forceDelete to true or deactivate the flow: flowName_value"
}
```
### An active scheduled flow with forceDelete true
This example shows an active scheduled flow with `forceDelete` true. The result is that the flow is deleted successfully.
#### Sample Request
```
{
"flowName": "flowName_value",
"forceDelete": true
}
```
#### Sample Response
```
{}
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appflow-2020-08-23/DeleteFlow)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appflow-2020-08-23/DeleteFlow)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appflow-2020-08-23/DeleteFlow)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appflow-2020-08-23/DeleteFlow)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appflow-2020-08-23/DeleteFlow)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appflow-2020-08-23/DeleteFlow)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appflow-2020-08-23/DeleteFlow)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appflow-2020-08-23/DeleteFlow)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appflow-2020-08-23/DeleteFlow)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appflow-2020-08-23/DeleteFlow)
# DescribeConnector
Describes the given custom connector registered in your AWS account. This API can be used for custom connectors that are registered in your account and also for Amazon authored connectors.
## Request Syntax
```
POST /describe-connector HTTP/1.1
Content-type: application/json
{
"connectorLabel": "string",
"connectorType": "string"
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [connectorLabel](#API_DescribeConnector_RequestSyntax) **
The label of the connector. The label is unique for each `ConnectorRegistration` in your AWS account. Only needed if calling for CUSTOMCONNECTOR connector type/.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `[a-zA-Z0-9][\w!@#.-]+`
Required: No
** [connectorType](#API_DescribeConnector_RequestSyntax) **
The connector type, such as CUSTOMCONNECTOR, Saleforce, Marketo. Please choose CUSTOMCONNECTOR for Lambda based custom connectors.
Type: String
Valid Values: `Salesforce | Singular | Slack | Redshift | S3 | Marketo | Googleanalytics | Zendesk | Servicenow | Datadog | Trendmicro | Snowflake | Dynatrace | Infornexus | Amplitude | Veeva | EventBridge | LookoutMetrics | Upsolver | Honeycode | CustomerProfiles | SAPOData | CustomConnector | Pardot`
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"connectorConfiguration": {
"authenticationConfig": {
"customAuthConfigs": [
{
"authParameters": [
{
"connectorSuppliedValues": [ "string" ],
"description": "string",
"isRequired": boolean,
"isSensitiveField": boolean,
"key": "string",
"label": "string"
}
],
"customAuthenticationType": "string"
}
],
"isApiKeyAuthSupported": boolean,
"isBasicAuthSupported": boolean,
"isCustomAuthSupported": boolean,
"isOAuth2Supported": boolean,
"oAuth2Defaults": {
"authCodeUrls": [ "string" ],
"oauth2CustomProperties": [
{
"connectorSuppliedValues": [ "string" ],
"description": "string",
"isRequired": boolean,
"isSensitiveField": boolean,
"key": "string",
"label": "string",
"type": "string"
}
],
"oauth2GrantTypesSupported": [ "string" ],
"oauthScopes": [ "string" ],
"tokenUrls": [ "string" ]
}
},
"canUseAsDestination": boolean,
"canUseAsSource": boolean,
"connectorArn": "string",
"connectorDescription": "string",
"connectorLabel": "string",
"connectorMetadata": {
"Amplitude": {
},
"CustomerProfiles": {
},
"Datadog": {
},
"Dynatrace": {
},
"EventBridge": {
},
"GoogleAnalytics": {
"oAuthScopes": [ "string" ]
},
"Honeycode": {
"oAuthScopes": [ "string" ]
},
"InforNexus": {
},
"Marketo": {
},
"Pardot": {
},
"Redshift": {
},
"S3": {
},
"Salesforce": {
"dataTransferApis": [ "string" ],
"oauth2GrantTypesSupported": [ "string" ],
"oAuthScopes": [ "string" ]
},
"SAPOData": {
},
"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": "string",
"connectorRuntimeSettings": [
{
"connectorSuppliedValueOptions": [ "string" ],
"dataType": "string",
"description": "string",
"isRequired": boolean,
"key": "string",
"label": "string",
"scope": "string"
}
],
"connectorType": "string",
"connectorVersion": "string",
"isPrivateLinkEnabled": boolean,
"isPrivateLinkEndpointUrlRequired": boolean,
"logoURL": "string",
"registeredAt": number,
"registeredBy": "string",
"supportedApiVersions": [ "string" ],
"supportedDataTransferApis": [
{
"Name": "string",
"Type": "string"
}
],
"supportedDataTransferTypes": [ "string" ],
"supportedDestinationConnectors": [ "string" ],
"supportedOperators": [ "string" ],
"supportedSchedulingFrequencies": [ "string" ],
"supportedTriggerTypes": [ "string" ],
"supportedWriteOperations": [ "string" ]
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [connectorConfiguration](#API_DescribeConnector_ResponseSyntax) **
Configuration info of all the connectors that the user requested.
Type: [ConnectorConfiguration](API_ConnectorConfiguration.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
An internal service error occurred during the processing of your request. Try again later.
HTTP Status Code: 500
** ResourceNotFoundException **
The resource specified in the request (such as the source or destination connector profile) is not found.
HTTP Status Code: 404
** ValidationException **
The request has invalid or missing parameters.
HTTP Status Code: 400
## Examples
### Describing the given connector
This example shows a sample request for the `DescribeConnector` API and a sample response.
#### Sample Request
```
{
"connectorType": "connectorType",
"connectorLabel": "connectorLabel"
}
```
#### Sample Response
```
{
"connectorConfiguration":
{
"authenticationConfig": null,
"canUseAsDestination": true,
"canUseAsSource": true,
"connectorArn": null,
"connectorDescription": "Salesforce",
"connectorLabel": null,
"connectorMetadata":
{
"Amplitude": null,
"AppIntegrations": null,
"CustomerProfiles": null,
"Datadog": null,
"Dynatrace": null,
"EventBridge": null,
"GoogleAnalytics": null,
"Honeycode": null,
"InforNexus": null,
"Locke": null,
"Marketo": null,
"Pardot": null,
"Redshift": null,
"S3": null,
"SAPOData": null,
"Salesforce":
{
"oAuthScopes":
[
"api",
"refresh_token",
"id"
]
},
"ServiceNow": null,
"Singular": null,
"Slack": null,
"Snowflake": null,
"Trendmicro": null,
"Upsolver": null,
"Veeva": null,
"Zendesk": null
},
"connectorModes": null,
"connectorName": null,
"connectorOwner": null,
"connectorProvisioningConfig": null,
"connectorProvisioningType": null,
"connectorRuntimeSettings": null,
"connectorType": "SALESFORCE",
"connectorVersion": null,
"isPrivateLinkEnabled": true,
"isPrivateLinkEndpointUrlRequired": false,
"logoURL": "insert-logo-here",
"registeredAt": null,
"registeredBy": null,
"supportedApiVersions": null,
"supportedDestinationConnectors":
[
"S3",
"Snowflake",
"Redshift",
"Salesforce",
"EventBridge",
"LookoutMetrics",
"Locke",
"Honeycode",
"Upsolver",
"CustomerProfiles",
"Zendesk",
"Marketo",
"CustomConnector"
],
"supportedOperators": null,
"supportedSchedulingFrequencies":
[
"BYMINUTE",
"HOURLY",
"DAILY",
"WEEKLY",
"MONTHLY",
"ONCE"
],
"supportedTriggerTypes":
[
"Scheduled",
"OnDemand",
"Event"
],
"supportedWriteOperations": null
}
}
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appflow-2020-08-23/DescribeConnector)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appflow-2020-08-23/DescribeConnector)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appflow-2020-08-23/DescribeConnector)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appflow-2020-08-23/DescribeConnector)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appflow-2020-08-23/DescribeConnector)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appflow-2020-08-23/DescribeConnector)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appflow-2020-08-23/DescribeConnector)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appflow-2020-08-23/DescribeConnector)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appflow-2020-08-23/DescribeConnector)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appflow-2020-08-23/DescribeConnector)
# DescribeConnectorEntity
Provides details regarding the entity used with the connector, with a description of the data model for each field in that entity.
## Request Syntax
```
POST /describe-connector-entity HTTP/1.1
Content-type: application/json
{
"apiVersion": "string",
"connectorEntityName": "string",
"connectorProfileName": "string",
"connectorType": "string"
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [apiVersion](#API_DescribeConnectorEntity_RequestSyntax) **
The version of the API that's used by the connector.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `\S+`
Required: No
** [connectorEntityName](#API_DescribeConnectorEntity_RequestSyntax) **
The entity name for that connector.
Type: String
Length Constraints: Maximum length of 1024.
Pattern: `\S+`
Required: Yes
** [connectorProfileName](#API_DescribeConnectorEntity_RequestSyntax) **
The name of the connector profile. The name is unique for each `ConnectorProfile` in the AWS account.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `[\w/!@#+=.-]+`
Required: No
** [connectorType](#API_DescribeConnectorEntity_RequestSyntax) **
The type of connector application, such as Salesforce, Amplitude, and so on.
Type: String
Valid Values: `Salesforce | Singular | Slack | Redshift | S3 | Marketo | Googleanalytics | Zendesk | Servicenow | Datadog | Trendmicro | Snowflake | Dynatrace | Infornexus | Amplitude | Veeva | EventBridge | LookoutMetrics | Upsolver | Honeycode | CustomerProfiles | SAPOData | CustomConnector | Pardot`
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"connectorEntityFields": [
{
"customProperties": {
"string" : "string"
},
"defaultValue": "string",
"description": "string",
"destinationProperties": {
"isCreatable": boolean,
"isDefaultedOnCreate": boolean,
"isNullable": boolean,
"isUpdatable": boolean,
"isUpsertable": boolean,
"supportedWriteOperations": [ "string" ]
},
"identifier": "string",
"isDeprecated": boolean,
"isPrimaryKey": boolean,
"label": "string",
"parentIdentifier": "string",
"sourceProperties": {
"isQueryable": boolean,
"isRetrievable": boolean,
"isTimestampFieldForIncrementalQueries": boolean
},
"supportedFieldTypeDetails": {
"v1": {
"fieldLengthRange": {
"maximum": number,
"minimum": number
},
"fieldType": "string",
"fieldValueRange": {
"maximum": number,
"minimum": number
},
"filterOperators": [ "string" ],
"supportedDateFormat": "string",
"supportedValues": [ "string" ],
"valueRegexPattern": "string"
}
}
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [connectorEntityFields](#API_DescribeConnectorEntity_ResponseSyntax) **
Describes the fields for that connector entity. For example, for an *account* entity, the fields would be *account name*, *account ID*, and so on.
Type: Array of [ConnectorEntityField](API_ConnectorEntityField.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ConnectorAuthenticationException **
An error occurred when authenticating with the connector endpoint.
HTTP Status Code: 401
** ConnectorServerException **
An error occurred when retrieving data from the connector endpoint.
HTTP Status Code: 400
** InternalServerException **
An internal service error occurred during the processing of your request. Try again later.
HTTP Status Code: 500
** ResourceNotFoundException **
The resource specified in the request (such as the source or destination connector profile) is not found.
HTTP Status Code: 404
** ValidationException **
The request has invalid or missing parameters.
HTTP Status Code: 400
## Examples
### DescribeConnectorEntity example
This example shows a sample request and response for the `DescribeConnectorEntity` API
#### Sample Request
```
{
"connectorEntityName": "tickets",
"connectorProfileName": "connector_profile_name",
"connectorType": "Zendesk"
}
```
#### Sample Response
```
{
"connectorEntityFields": [
{
"description": "Account ID",
"destinationProperties": {
"isCreatable": false,
"isNullable": false,
"isUpdatable": false,
"isUpsertable": false,
"supportedWriteOperations": [
"UPDATE",
"UPSERT"
]
},
"identifier": "Id",
"label": "Account ID",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "id",
"filterOperators": [
"EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Deleted",
"destinationProperties": {
"isCreatable": false,
"isNullable": false,
"isUpdatable": false,
"isUpsertable": false,
"supportedWriteOperations": []
},
"identifier": "IsDeleted",
"label": "Deleted",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "boolean",
"filterOperators": [
"EQUAL_TO"
],
"supportedValues": [
"true",
"false"
]
}
}
},
{
"description": "Master Record ID",
"destinationProperties": {
"isCreatable": false,
"isNullable": true,
"isUpdatable": false,
"isUpsertable": false,
"supportedWriteOperations": []
},
"identifier": "MasterRecordId",
"label": "Master Record ID",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "reference",
"filterOperators": [
"EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Account Name",
"destinationProperties": {
"isCreatable": true,
"isNullable": false,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "Name",
"label": "Account Name",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "string",
"filterOperators": [
"CONTAINS",
"EQUAL_TO",
"NOT_EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Account Type",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "Type",
"label": "Account Type",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "picklist",
"filterOperators": [
"EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Parent Account ID",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "ParentId",
"label": "Parent Account ID",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "reference",
"filterOperators": [
"EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Billing Street",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "BillingStreet",
"label": "Billing Street",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "textarea",
"filterOperators": [
"EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Billing City",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "BillingCity",
"label": "Billing City",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "string",
"filterOperators": [
"CONTAINS",
"EQUAL_TO",
"NOT_EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Billing State/Province",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "BillingState",
"label": "Billing State/Province",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "string",
"filterOperators": [
"CONTAINS",
"EQUAL_TO",
"NOT_EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Billing Zip/Postal Code",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "BillingPostalCode",
"label": "Billing Zip/Postal Code",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "string",
"filterOperators": [
"CONTAINS",
"EQUAL_TO",
"NOT_EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Billing Country",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "BillingCountry",
"label": "Billing Country",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "string",
"filterOperators": [
"CONTAINS",
"EQUAL_TO",
"NOT_EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Billing Latitude",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "BillingLatitude",
"label": "Billing Latitude",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "double",
"filterOperators": [
"NOT_EQUAL_TO",
"EQUAL_TO",
"LESS_THAN",
"LESS_THAN_OR_EQUAL_TO",
"GREATER_THAN",
"GREATER_THAN_OR_EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Billing Longitude",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "BillingLongitude",
"label": "Billing Longitude",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "double",
"filterOperators": [
"NOT_EQUAL_TO",
"EQUAL_TO",
"LESS_THAN",
"LESS_THAN_OR_EQUAL_TO",
"GREATER_THAN",
"GREATER_THAN_OR_EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Billing Geocode Accuracy",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "BillingGeocodeAccuracy",
"label": "Billing Geocode Accuracy",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "picklist",
"filterOperators": [
"EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Billing Address",
"destinationProperties": {
"isCreatable": false,
"isNullable": true,
"isUpdatable": false,
"isUpsertable": false,
"supportedWriteOperations": []
},
"identifier": "BillingAddress",
"label": "Billing Address",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "address",
"filterOperators": [
"EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Shipping Street",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "ShippingStreet",
"label": "Shipping Street",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "textarea",
"filterOperators": [
"EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Shipping City",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "ShippingCity",
"label": "Shipping City",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "string",
"filterOperators": [
"CONTAINS",
"EQUAL_TO",
"NOT_EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Shipping State/Province",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "ShippingState",
"label": "Shipping State/Province",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "string",
"filterOperators": [
"CONTAINS",
"EQUAL_TO",
"NOT_EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Shipping Zip/Postal Code",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "ShippingPostalCode",
"label": "Shipping Zip/Postal Code",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "string",
"filterOperators": [
"CONTAINS",
"EQUAL_TO",
"NOT_EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Shipping Country",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "ShippingCountry",
"label": "Shipping Country",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "string",
"filterOperators": [
"CONTAINS",
"EQUAL_TO",
"NOT_EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Shipping Latitude",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "ShippingLatitude",
"label": "Shipping Latitude",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "double",
"filterOperators": [
"NOT_EQUAL_TO",
"EQUAL_TO",
"LESS_THAN",
"LESS_THAN_OR_EQUAL_TO",
"GREATER_THAN",
"GREATER_THAN_OR_EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Shipping Longitude",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "ShippingLongitude",
"label": "Shipping Longitude",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "double",
"filterOperators": [
"NOT_EQUAL_TO",
"EQUAL_TO",
"LESS_THAN",
"LESS_THAN_OR_EQUAL_TO",
"GREATER_THAN",
"GREATER_THAN_OR_EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Shipping Geocode Accuracy",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "ShippingGeocodeAccuracy",
"label": "Shipping Geocode Accuracy",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "picklist",
"filterOperators": [
"EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Shipping Address",
"destinationProperties": {
"isCreatable": false,
"isNullable": true,
"isUpdatable": false,
"isUpsertable": false,
"supportedWriteOperations": []
},
"identifier": "ShippingAddress",
"label": "Shipping Address",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "address",
"filterOperators": [
"EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Account Phone",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "Phone",
"label": "Account Phone",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "phone",
"filterOperators": [
"EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Account Fax",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "Fax",
"label": "Account Fax",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "phone",
"filterOperators": [
"EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Account Number",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "AccountNumber",
"label": "Account Number",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "string",
"filterOperators": [
"CONTAINS",
"EQUAL_TO",
"NOT_EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Website",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "Website",
"label": "Website",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "url",
"filterOperators": [
"EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Photo URL",
"destinationProperties": {
"isCreatable": false,
"isNullable": true,
"isUpdatable": false,
"isUpsertable": false,
"supportedWriteOperations": []
},
"identifier": "PhotoUrl",
"label": "Photo URL",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "url",
"filterOperators": [
"EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "SIC Code",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "Sic",
"label": "SIC Code",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "string",
"filterOperators": [
"CONTAINS",
"EQUAL_TO",
"NOT_EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Industry",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "Industry",
"label": "Industry",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "picklist",
"filterOperators": [
"EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Annual Revenue",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "AnnualRevenue",
"label": "Annual Revenue",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "currency",
"filterOperators": [
"EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Employees",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "NumberOfEmployees",
"label": "Employees",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "int",
"filterOperators": [
"NOT_EQUAL_TO",
"EQUAL_TO",
"LESS_THAN",
"LESS_THAN_OR_EQUAL_TO",
"GREATER_THAN",
"GREATER_THAN_OR_EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Ownership",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "Ownership",
"label": "Ownership",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "picklist",
"filterOperators": [
"EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Ticker Symbol",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "TickerSymbol",
"label": "Ticker Symbol",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "string",
"filterOperators": [
"CONTAINS",
"EQUAL_TO",
"NOT_EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Account Description",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "Description",
"label": "Account Description",
"sourceProperties": {
"isQueryable": false,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "textarea",
"filterOperators": [
"EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Account Rating",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "Rating",
"label": "Account Rating",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "picklist",
"filterOperators": [
"EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Account Site",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "Site",
"label": "Account Site",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "string",
"filterOperators": [
"CONTAINS",
"EQUAL_TO",
"NOT_EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Owner ID",
"destinationProperties": {
"isCreatable": true,
"isNullable": false,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "OwnerId",
"label": "Owner ID",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "reference",
"filterOperators": [
"EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Created Date",
"destinationProperties": {
"isCreatable": false,
"isNullable": false,
"isUpdatable": false,
"isUpsertable": false,
"supportedWriteOperations": []
},
"identifier": "CreatedDate",
"label": "Created Date",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "datetime",
"filterOperators": [
"EQUAL_TO",
"LESS_THAN",
"LESS_THAN_OR_EQUAL_TO",
"GREATER_THAN",
"GREATER_THAN_OR_EQUAL_TO",
"BETWEEN"
],
"supportedValues": []
}
}
},
{
"description": "Created By ID",
"destinationProperties": {
"isCreatable": false,
"isNullable": false,
"isUpdatable": false,
"isUpsertable": false,
"supportedWriteOperations": []
},
"identifier": "CreatedById",
"label": "Created By ID",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "reference",
"filterOperators": [
"EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Last Modified Date",
"destinationProperties": {
"isCreatable": false,
"isNullable": false,
"isUpdatable": false,
"isUpsertable": false,
"supportedWriteOperations": []
},
"identifier": "LastModifiedDate",
"label": "Last Modified Date",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "datetime",
"filterOperators": [
"EQUAL_TO",
"LESS_THAN",
"LESS_THAN_OR_EQUAL_TO",
"GREATER_THAN",
"GREATER_THAN_OR_EQUAL_TO",
"BETWEEN"
],
"supportedValues": []
}
}
},
{
"description": "Last Modified By ID",
"destinationProperties": {
"isCreatable": false,
"isNullable": false,
"isUpdatable": false,
"isUpsertable": false,
"supportedWriteOperations": []
},
"identifier": "LastModifiedById",
"label": "Last Modified By ID",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "reference",
"filterOperators": [
"EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "System Modstamp",
"destinationProperties": {
"isCreatable": false,
"isNullable": false,
"isUpdatable": false,
"isUpsertable": false,
"supportedWriteOperations": []
},
"identifier": "SystemModstamp",
"label": "System Modstamp",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "datetime",
"filterOperators": [
"EQUAL_TO",
"LESS_THAN",
"LESS_THAN_OR_EQUAL_TO",
"GREATER_THAN",
"GREATER_THAN_OR_EQUAL_TO",
"BETWEEN"
],
"supportedValues": []
}
}
},
{
"description": "Last Activity",
"destinationProperties": {
"isCreatable": false,
"isNullable": true,
"isUpdatable": false,
"isUpsertable": false,
"supportedWriteOperations": []
},
"identifier": "LastActivityDate",
"label": "Last Activity",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "date",
"filterOperators": [
"EQUAL_TO",
"LESS_THAN",
"LESS_THAN_OR_EQUAL_TO",
"GREATER_THAN",
"GREATER_THAN_OR_EQUAL_TO",
"BETWEEN"
],
"supportedValues": []
}
}
},
{
"description": "Last Viewed Date",
"destinationProperties": {
"isCreatable": false,
"isNullable": true,
"isUpdatable": false,
"isUpsertable": false,
"supportedWriteOperations": []
},
"identifier": "LastViewedDate",
"label": "Last Viewed Date",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "datetime",
"filterOperators": [
"EQUAL_TO",
"LESS_THAN",
"LESS_THAN_OR_EQUAL_TO",
"GREATER_THAN",
"GREATER_THAN_OR_EQUAL_TO",
"BETWEEN"
],
"supportedValues": []
}
}
},
{
"description": "Last Referenced Date",
"destinationProperties": {
"isCreatable": false,
"isNullable": true,
"isUpdatable": false,
"isUpsertable": false,
"supportedWriteOperations": []
},
"identifier": "LastReferencedDate",
"label": "Last Referenced Date",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "datetime",
"filterOperators": [
"EQUAL_TO",
"LESS_THAN",
"LESS_THAN_OR_EQUAL_TO",
"GREATER_THAN",
"GREATER_THAN_OR_EQUAL_TO",
"BETWEEN"
],
"supportedValues": []
}
}
},
{
"description": "Data.com Key",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "Jigsaw",
"label": "Data.com Key",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "string",
"filterOperators": [
"CONTAINS",
"EQUAL_TO",
"NOT_EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Jigsaw Company ID",
"destinationProperties": {
"isCreatable": false,
"isNullable": true,
"isUpdatable": false,
"isUpsertable": false,
"supportedWriteOperations": []
},
"identifier": "JigsawCompanyId",
"label": "Jigsaw Company ID",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "string",
"filterOperators": [
"CONTAINS",
"EQUAL_TO",
"NOT_EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Clean Status",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "CleanStatus",
"label": "Clean Status",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "picklist",
"filterOperators": [
"EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Account Source",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "AccountSource",
"label": "Account Source",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "picklist",
"filterOperators": [
"EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "D-U-N-S Number",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "DunsNumber",
"label": "D-U-N-S Number",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "string",
"filterOperators": [
"CONTAINS",
"EQUAL_TO",
"NOT_EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Tradestyle",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "Tradestyle",
"label": "Tradestyle",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "string",
"filterOperators": [
"CONTAINS",
"EQUAL_TO",
"NOT_EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "NAICS Code",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "NaicsCode",
"label": "NAICS Code",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "string",
"filterOperators": [
"CONTAINS",
"EQUAL_TO",
"NOT_EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "NAICS Description",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "NaicsDesc",
"label": "NAICS Description",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "string",
"filterOperators": [
"CONTAINS",
"EQUAL_TO",
"NOT_EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Year Started",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "YearStarted",
"label": "Year Started",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "string",
"filterOperators": [
"CONTAINS",
"EQUAL_TO",
"NOT_EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "SIC Description",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "SicDesc",
"label": "SIC Description",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "string",
"filterOperators": [
"CONTAINS",
"EQUAL_TO",
"NOT_EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "D&B Company ID",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "DandbCompanyId",
"label": "D&B Company ID",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "reference",
"filterOperators": [
"EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Operating Hour ID",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "OperatingHoursId",
"label": "Operating Hour ID",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "reference",
"filterOperators": [
"EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Customer Priority",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "CustomerPriority__c",
"label": "Customer Priority",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "picklist",
"filterOperators": [
"EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "SLA",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "SLA__c",
"label": "SLA",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "picklist",
"filterOperators": [
"EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Active",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "Active__c",
"label": "Active",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "picklist",
"filterOperators": [
"EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Number of Locations",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "NumberofLocations__c",
"label": "Number of Locations",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "double",
"filterOperators": [
"NOT_EQUAL_TO",
"EQUAL_TO",
"LESS_THAN",
"LESS_THAN_OR_EQUAL_TO",
"GREATER_THAN",
"GREATER_THAN_OR_EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Upsell Opportunity",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "UpsellOpportunity__c",
"label": "Upsell Opportunity",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "picklist",
"filterOperators": [
"EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "SLA Serial Number",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "SLASerialNumber__c",
"label": "SLA Serial Number",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "string",
"filterOperators": [
"CONTAINS",
"EQUAL_TO",
"NOT_EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "SLA Expiration Date",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "SLAExpirationDate__c",
"label": "SLA Expiration Date",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "date",
"filterOperators": [
"EQUAL_TO",
"LESS_THAN",
"LESS_THAN_OR_EQUAL_TO",
"GREATER_THAN",
"GREATER_THAN_OR_EQUAL_TO",
"BETWEEN"
],
"supportedValues": []
}
}
},
{
"description": "extId",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": [
"UPSERT"
]
},
"identifier": "extId__c",
"label": "extId",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "string",
"filterOperators": [
"CONTAINS",
"EQUAL_TO",
"NOT_EQUAL_TO"
],
"supportedValues": []
}
}
}
]
}
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appflow-2020-08-23/DescribeConnectorEntity)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appflow-2020-08-23/DescribeConnectorEntity)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appflow-2020-08-23/DescribeConnectorEntity)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appflow-2020-08-23/DescribeConnectorEntity)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appflow-2020-08-23/DescribeConnectorEntity)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appflow-2020-08-23/DescribeConnectorEntity)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appflow-2020-08-23/DescribeConnectorEntity)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appflow-2020-08-23/DescribeConnectorEntity)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appflow-2020-08-23/DescribeConnectorEntity)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appflow-2020-08-23/DescribeConnectorEntity)
# DescribeConnectorProfiles
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.
## Request Syntax
```
POST /describe-connector-profiles HTTP/1.1
Content-type: application/json
{
"connectorLabel": "string",
"connectorProfileNames": [ "string" ],
"connectorType": "string",
"maxResults": number,
"nextToken": "string"
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [connectorLabel](#API_DescribeConnectorProfiles_RequestSyntax) **
The name of the connector. The name is unique for each `ConnectorRegistration` in your AWS account. Only needed if calling for CUSTOMCONNECTOR connector type/.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `[a-zA-Z0-9][\w!@#.-]+`
Required: No
** [connectorProfileNames](#API_DescribeConnectorProfiles_RequestSyntax) **
The name of the connector profile. The name is unique for each `ConnectorProfile` in the AWS account.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 100 items.
Length Constraints: Maximum length of 256.
Pattern: `[\w/!@#+=.-]+`
Required: No
** [connectorType](#API_DescribeConnectorProfiles_RequestSyntax) **
The type of connector, such as Salesforce, Amplitude, and so on.
Type: String
Valid Values: `Salesforce | Singular | Slack | Redshift | S3 | Marketo | Googleanalytics | Zendesk | Servicenow | Datadog | Trendmicro | Snowflake | Dynatrace | Infornexus | Amplitude | Veeva | EventBridge | LookoutMetrics | Upsolver | Honeycode | CustomerProfiles | SAPOData | CustomConnector | Pardot`
Required: No
** [maxResults](#API_DescribeConnectorProfiles_RequestSyntax) **
Specifies the maximum number of items that should be returned in the result set. The default for `maxResults` is 20 (for all paginated API operations).
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
** [nextToken](#API_DescribeConnectorProfiles_RequestSyntax) **
The pagination token for the next page of data.
Type: String
Length Constraints: Maximum length of 2048.
Pattern: `\S+`
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"connectorProfileDetails": [
{
"connectionMode": "string",
"connectorLabel": "string",
"connectorProfileArn": "string",
"connectorProfileName": "string",
"connectorProfileProperties": {
"Amplitude": {
},
"CustomConnector": {
"oAuth2Properties": {
"oAuth2GrantType": "string",
"tokenUrl": "string",
"tokenUrlCustomProperties": {
"string" : "string"
}
},
"profileProperties": {
"string" : "string"
}
},
"Datadog": {
"instanceUrl": "string"
},
"Dynatrace": {
"instanceUrl": "string"
},
"GoogleAnalytics": {
},
"Honeycode": {
},
"InforNexus": {
"instanceUrl": "string"
},
"Marketo": {
"instanceUrl": "string"
},
"Pardot": {
"businessUnitId": "string",
"instanceUrl": "string",
"isSandboxEnvironment": boolean
},
"Redshift": {
"bucketName": "string",
"bucketPrefix": "string",
"clusterIdentifier": "string",
"dataApiRoleArn": "string",
"databaseName": "string",
"databaseUrl": "string",
"isRedshiftServerless": boolean,
"roleArn": "string",
"workgroupName": "string"
},
"Salesforce": {
"instanceUrl": "string",
"isSandboxEnvironment": boolean,
"usePrivateLinkForMetadataAndAuthorization": boolean
},
"SAPOData": {
"applicationHostUrl": "string",
"applicationServicePath": "string",
"clientNumber": "string",
"disableSSO": boolean,
"logonLanguage": "string",
"oAuthProperties": {
"authCodeUrl": "string",
"oAuthScopes": [ "string" ],
"tokenUrl": "string"
},
"portNumber": number,
"privateLinkServiceName": "string"
},
"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": "string",
"createdAt": number,
"credentialsArn": "string",
"lastUpdatedAt": number,
"privateConnectionProvisioningState": {
"failureCause": "string",
"failureMessage": "string",
"status": "string"
}
}
],
"nextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [connectorProfileDetails](#API_DescribeConnectorProfiles_ResponseSyntax) **
Returns information about the connector profiles associated with the flow.
Type: Array of [ConnectorProfile](API_ConnectorProfile.md) objects
** [nextToken](#API_DescribeConnectorProfiles_ResponseSyntax) **
The pagination token for the next page of data. If `nextToken=null`, this means that all records have been fetched.
Type: String
Length Constraints: Maximum length of 2048.
Pattern: `\S+`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
An internal service error occurred during the processing of your request. Try again later.
HTTP Status Code: 500
** ValidationException **
The request has invalid or missing parameters.
HTTP Status Code: 400
## Examples
### DescribeConnectorProfiles example
This example shows a sample request and response for the `DescribeConnectorProfiles` API.
#### Sample Request
```
{
"connectorProfileNames": ["OldMarketoProfile","non-existing-name"],
"connectorTypes": ["Marketo","Salesforce"]
}
```
#### Sample Response
```
{
"connectorProfileDetails": [
{
"arn": "arn:aws:appflow:region::connectorprofile/OldMarketoProfile",
"configuration": {
"api_version": "v1",
"connection_mode": "Public",
"credentials_arn": "arn:aws:secretsmanager:region::secret:",
"instanceUrl": "MarketoUrl"
},
"connectionMode": "Public",
"connectorProfileArn": "arn:aws:appflow:region::connectorprofile/OldMarketoProfile",
"connectorProfileName": "OldMarketoProfile",
"connectorProfileProps": {
"Amplitude": null,
"Datadog": null,
"Dynatrace": null,
"GoogleAnalytics": null,
"InforNexus": null,
"Marketo": {
"apiVersion": "v1",
"instanceUrl": "MarketoUrl"
},
"Redshift": null,
"Salesforce": null,
"ServiceNow": null,
"Singular": null,
"Slack": null,
"Snowflake": null,
"Trendmicro": null,
"Veeva": null,
"Zendesk": null
},
"connectorType": "Marketo",
"createdAt": "created_at_value",
"credentialsArn": "arn:aws:secretsmanager:region::secret:",
"label": "OldMarketoProfile",
"lastUpdated": "lastupdated_value",
"lastUpdatedAt": "lastupdated_at_value"
}
],
"nextToken": null
}
```
### DescribeConnectorProfiles example
This example shows a sample request and response for the `DescribeConnectorProfiles` API.
#### Sample Request
```
{
"connectorProfileNames": ["OldMarketoProfile", "non-existing-name"],
"connectorTypes": ["Marketo", "Salesforce", "CustomConnector"],
"connectorLabel": "MyCustomConnectorLabel"
}
```
#### Sample Response
```
{
"connectorProfileDetails": [
{
"arn": "arn:aws:appflow:region::connectorprofile/OldMarketoProfile",
"configuration":
{
"api_version": "v1",
"connection_mode": "Public",
"credentials_arn": "arn:aws:secretsmanager:region::secret:",
"instanceUrl": "MarketoUrl"
},
"connectionMode": "Public",
"connectorProfileArn": "arn:aws:appflow:region::connectorprofile/OldMarketoProfile",
"connectorProfileName": "OldMarketoProfile",
"connectorProfileProps":
{
"Amplitude": null,
"Datadog": null,
"Dynatrace": null,
"GoogleAnalytics": null,
"InforNexus": null,
"Marketo":
{
"apiVersion": "v1",
"instanceUrl": "MarketoUrl"
},
"Redshift": null,
"Salesforce": null,
"ServiceNow": null,
"Singular": null,
"Slack": null,
"Snowflake": null,
"Trendmicro": null,
"Veeva": null,
"Zendesk": null
},
"connectorType": "Marketo",
"createdAt": "2022-02-22T15:31:41.467000-08:00",
"credentialsArn": "arn:aws:secretsmanager:region::secret:",
"label": "OldMarketoProfile",
"lastUpdatedAt": "2022-02-22T15:31:41.467000-08:00"
}
],
"nextToken": null
}
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appflow-2020-08-23/DescribeConnectorProfiles)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appflow-2020-08-23/DescribeConnectorProfiles)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appflow-2020-08-23/DescribeConnectorProfiles)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appflow-2020-08-23/DescribeConnectorProfiles)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appflow-2020-08-23/DescribeConnectorProfiles)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appflow-2020-08-23/DescribeConnectorProfiles)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appflow-2020-08-23/DescribeConnectorProfiles)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appflow-2020-08-23/DescribeConnectorProfiles)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appflow-2020-08-23/DescribeConnectorProfiles)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appflow-2020-08-23/DescribeConnectorProfiles)
# DescribeConnectors
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.
## Request Syntax
```
POST /describe-connectors HTTP/1.1
Content-type: application/json
{
"connectorTypes": [ "string" ],
"maxResults": number,
"nextToken": "string"
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [connectorTypes](#API_DescribeConnectors_RequestSyntax) **
The type of connector, such as Salesforce, Amplitude, and so on.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 100 items.
Valid Values: `Salesforce | Singular | Slack | Redshift | S3 | Marketo | Googleanalytics | Zendesk | Servicenow | Datadog | Trendmicro | Snowflake | Dynatrace | Infornexus | Amplitude | Veeva | EventBridge | LookoutMetrics | Upsolver | Honeycode | CustomerProfiles | SAPOData | CustomConnector | Pardot`
Required: No
** [maxResults](#API_DescribeConnectors_RequestSyntax) **
The maximum number of items that should be returned in the result set. The default is 20.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
** [nextToken](#API_DescribeConnectors_RequestSyntax) **
The pagination token for the next page of data.
Type: String
Length Constraints: Maximum length of 2048.
Pattern: `\S+`
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"connectorConfigurations": {
"string" : {
"authenticationConfig": {
"customAuthConfigs": [
{
"authParameters": [
{
"connectorSuppliedValues": [ "string" ],
"description": "string",
"isRequired": boolean,
"isSensitiveField": boolean,
"key": "string",
"label": "string"
}
],
"customAuthenticationType": "string"
}
],
"isApiKeyAuthSupported": boolean,
"isBasicAuthSupported": boolean,
"isCustomAuthSupported": boolean,
"isOAuth2Supported": boolean,
"oAuth2Defaults": {
"authCodeUrls": [ "string" ],
"oauth2CustomProperties": [
{
"connectorSuppliedValues": [ "string" ],
"description": "string",
"isRequired": boolean,
"isSensitiveField": boolean,
"key": "string",
"label": "string",
"type": "string"
}
],
"oauth2GrantTypesSupported": [ "string" ],
"oauthScopes": [ "string" ],
"tokenUrls": [ "string" ]
}
},
"canUseAsDestination": boolean,
"canUseAsSource": boolean,
"connectorArn": "string",
"connectorDescription": "string",
"connectorLabel": "string",
"connectorMetadata": {
"Amplitude": {
},
"CustomerProfiles": {
},
"Datadog": {
},
"Dynatrace": {
},
"EventBridge": {
},
"GoogleAnalytics": {
"oAuthScopes": [ "string" ]
},
"Honeycode": {
"oAuthScopes": [ "string" ]
},
"InforNexus": {
},
"Marketo": {
},
"Pardot": {
},
"Redshift": {
},
"S3": {
},
"Salesforce": {
"dataTransferApis": [ "string" ],
"oauth2GrantTypesSupported": [ "string" ],
"oAuthScopes": [ "string" ]
},
"SAPOData": {
},
"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": "string",
"connectorRuntimeSettings": [
{
"connectorSuppliedValueOptions": [ "string" ],
"dataType": "string",
"description": "string",
"isRequired": boolean,
"key": "string",
"label": "string",
"scope": "string"
}
],
"connectorType": "string",
"connectorVersion": "string",
"isPrivateLinkEnabled": boolean,
"isPrivateLinkEndpointUrlRequired": boolean,
"logoURL": "string",
"registeredAt": number,
"registeredBy": "string",
"supportedApiVersions": [ "string" ],
"supportedDataTransferApis": [
{
"Name": "string",
"Type": "string"
}
],
"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": "string",
"connectorType": "string",
"connectorVersion": "string",
"registeredAt": number,
"registeredBy": "string",
"supportedDataTransferTypes": [ "string" ]
}
],
"nextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [connectorConfigurations](#API_DescribeConnectors_ResponseSyntax) **
The configuration that is applied to the connectors used in the flow.
Type: String to [ConnectorConfiguration](API_ConnectorConfiguration.md) object map
Valid Keys: `Salesforce | Singular | Slack | Redshift | S3 | Marketo | Googleanalytics | Zendesk | Servicenow | Datadog | Trendmicro | Snowflake | Dynatrace | Infornexus | Amplitude | Veeva | EventBridge | LookoutMetrics | Upsolver | Honeycode | CustomerProfiles | SAPOData | CustomConnector | Pardot`
** [connectors](#API_DescribeConnectors_ResponseSyntax) **
Information about the connectors supported in Amazon AppFlow.
Type: Array of [ConnectorDetail](API_ConnectorDetail.md) objects
** [nextToken](#API_DescribeConnectors_ResponseSyntax) **
The pagination token for the next page of data.
Type: String
Length Constraints: Maximum length of 2048.
Pattern: `\S+`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
An internal service error occurred during the processing of your request. Try again later.
HTTP Status Code: 500
** ValidationException **
The request has invalid or missing parameters.
HTTP Status Code: 400
## Examples
### DescribeConnectors example
This example shows a sample request and response for the `DescribeConnectors` API using Marketo and Salesforce. The second sample shows how to proceed if you receive `nextToken`.
#### Sample Request
```
{
"connectorTypes": ["Marketo","Salesforce"]
}
```
```
{
"connectorTypes": ["Marketo","Salesforce"],
"nextToken": "nextToken_value"
}
```
#### Sample Response
```
{
"connectorConfigurations": {
"Marketo": {
"canUseAsDestination": false,
"canUseAsSource": true,
"compatibleConnectors": [
"S3",
"Snowflake",
"Salesforce",
"Redshift"
],
"connectorMetadata": {
"Amplitude": null,
"Datadog": null,
"Dynatrace": null,
"GoogleAnalytics": null,
"InforNexus": null,
"Marketo": {},
"Redshift": null,
"S3": null,
"Salesforce": null,
"ServiceNow": null,
"Singular": null,
"Slack": null,
"Snowflake": null,
"Trendmicro": null,
"Veeva": null,
"Zendesk": null
},
"connectorSpecificConfiguration": {
"api_version": "v1"
},
"credentialKeys": [
"accessToken",
"clientId",
"clientSecret"
],
"displayName": "Marketo",
"hasLogoImage": false,
"isPrivateLinkEnabled": false,
"isPrivateLinkEndpointUrlRequired": false,
"privateLinkEndpointServiceUrl": null,
"supportedDestinationConnectors": [
"S3",
"Snowflake",
"Salesforce",
"Redshift"
],
"supportedFrequencies": [
"Hour",
"Day",
"Week",
"Month",
"Once"
],
"supportedRegions": null,
"supportedSchedulingFrequencies": [
"Hour",
"Day",
"Week",
"Month",
"Once"
],
"supportedTriggerTypes": [
"Scheduled",
"OnDemand"
],
"supportedTriggers": [
"Scheduled",
"OnDemand"
]
},
"Salesforce": {
"canUseAsDestination": true,
"canUseAsSource": true,
"compatibleConnectors": [
"S3",
"Snowflake",
"Redshift",
"Salesforce"
],
"connectorMetadata": {
"Amplitude": null,
"Datadog": null,
"Dynatrace": null,
"GoogleAnalytics": null,
"InforNexus": null,
"Marketo": null,
"Redshift": null,
"S3": null,
"Salesforce": {
"authScopes": [
"api",
"refresh_token",
"id"
]
},
"ServiceNow": null,
"Singular": null,
"Slack": null,
"Snowflake": null,
"Trendmicro": null,
"Veeva": null,
"Zendesk": null
},
"connectorSpecificConfiguration": {
"api_version": "v47.0",
"auth_scopes": "[api, refresh_token, id]",
"bulk_api_path": "services/data",
"query_api_path": "query",
"sobject_api_path": "sobjects"
},
"credentialKeys": [
"accessToken",
"refreshToken",
"clientId",
"clientSecret"
],
"displayName": "Salesforce",
"hasLogoImage": false,
"isPrivateLinkEnabled": false,
"isPrivateLinkEndpointUrlRequired": false,
"privateLinkEndpointServiceUrl": null,
"supportedDestinationConnectors": [
"S3",
"Snowflake",
"Redshift",
"Salesforce"
],
"supportedFrequencies": [
"Minute",
"Hour",
"Day",
"Week",
"Month",
"Once"
],
"supportedRegions": null,
"supportedSchedulingFrequencies": [
"Minute",
"Hour",
"Day",
"Week",
"Month",
"Once"
],
"supportedTriggerTypes": [
"Scheduled",
"OnDemand",
"Event"
],
"supportedTriggers": [
"Scheduled",
"OnDemand",
"Event"
]
}
},
"nextToken": null,
"pageToken": null
}
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appflow-2020-08-23/DescribeConnectors)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appflow-2020-08-23/DescribeConnectors)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appflow-2020-08-23/DescribeConnectors)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appflow-2020-08-23/DescribeConnectors)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appflow-2020-08-23/DescribeConnectors)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appflow-2020-08-23/DescribeConnectors)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appflow-2020-08-23/DescribeConnectors)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appflow-2020-08-23/DescribeConnectors)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appflow-2020-08-23/DescribeConnectors)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appflow-2020-08-23/DescribeConnectors)
# DescribeFlow
Provides a description of the specified flow.
## Request Syntax
```
POST /describe-flow HTTP/1.1
Content-type: application/json
{
"flowName": "string"
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [flowName](#API_DescribeFlow_RequestSyntax) **
The specified name of the flow. Spaces are not allowed. Use underscores (\$1) or hyphens (-) only.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `[a-zA-Z0-9][\w!@#.-]+`
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"createdAt": number,
"createdBy": "string",
"description": "string",
"destinationFlowConfigList": [
{
"apiVersion": "string",
"connectorProfileName": "string",
"connectorType": "string",
"destinationConnectorProperties": {
"CustomConnector": {
"customProperties": {
"string" : "string"
},
"entityName": "string",
"errorHandlingConfig": {
"bucketName": "string",
"bucketPrefix": "string",
"failOnFirstDestinationError": boolean
},
"idFieldNames": [ "string" ],
"writeOperationType": "string"
},
"CustomerProfiles": {
"domainName": "string",
"objectTypeName": "string"
},
"EventBridge": {
"errorHandlingConfig": {
"bucketName": "string",
"bucketPrefix": "string",
"failOnFirstDestinationError": boolean
},
"object": "string"
},
"Honeycode": {
"errorHandlingConfig": {
"bucketName": "string",
"bucketPrefix": "string",
"failOnFirstDestinationError": boolean
},
"object": "string"
},
"LookoutMetrics": {
},
"Marketo": {
"errorHandlingConfig": {
"bucketName": "string",
"bucketPrefix": "string",
"failOnFirstDestinationError": boolean
},
"object": "string"
},
"Redshift": {
"bucketPrefix": "string",
"errorHandlingConfig": {
"bucketName": "string",
"bucketPrefix": "string",
"failOnFirstDestinationError": boolean
},
"intermediateBucketName": "string",
"object": "string"
},
"S3": {
"bucketName": "string",
"bucketPrefix": "string",
"s3OutputFormatConfig": {
"aggregationConfig": {
"aggregationType": "string",
"targetFileSize": number
},
"fileType": "string",
"prefixConfig": {
"pathPrefixHierarchy": [ "string" ],
"prefixFormat": "string",
"prefixType": "string"
},
"preserveSourceDataTyping": boolean
}
},
"Salesforce": {
"dataTransferApi": "string",
"errorHandlingConfig": {
"bucketName": "string",
"bucketPrefix": "string",
"failOnFirstDestinationError": boolean
},
"idFieldNames": [ "string" ],
"object": "string",
"writeOperationType": "string"
},
"SAPOData": {
"errorHandlingConfig": {
"bucketName": "string",
"bucketPrefix": "string",
"failOnFirstDestinationError": boolean
},
"idFieldNames": [ "string" ],
"objectPath": "string",
"successResponseHandlingConfig": {
"bucketName": "string",
"bucketPrefix": "string"
},
"writeOperationType": "string"
},
"Snowflake": {
"bucketPrefix": "string",
"errorHandlingConfig": {
"bucketName": "string",
"bucketPrefix": "string",
"failOnFirstDestinationError": boolean
},
"intermediateBucketName": "string",
"object": "string"
},
"Upsolver": {
"bucketName": "string",
"bucketPrefix": "string",
"s3OutputFormatConfig": {
"aggregationConfig": {
"aggregationType": "string",
"targetFileSize": number
},
"fileType": "string",
"prefixConfig": {
"pathPrefixHierarchy": [ "string" ],
"prefixFormat": "string",
"prefixType": "string"
}
}
},
"Zendesk": {
"errorHandlingConfig": {
"bucketName": "string",
"bucketPrefix": "string",
"failOnFirstDestinationError": boolean
},
"idFieldNames": [ "string" ],
"object": "string",
"writeOperationType": "string"
}
}
}
],
"flowArn": "string",
"flowName": "string",
"flowStatus": "string",
"flowStatusMessage": "string",
"kmsArn": "string",
"lastRunExecutionDetails": {
"mostRecentExecutionMessage": "string",
"mostRecentExecutionStatus": "string",
"mostRecentExecutionTime": number
},
"lastRunMetadataCatalogDetails": [
{
"catalogType": "string",
"partitionRegistrationOutput": {
"message": "string",
"result": "string",
"status": "string"
},
"tableName": "string",
"tableRegistrationOutput": {
"message": "string",
"result": "string",
"status": "string"
}
}
],
"lastUpdatedAt": number,
"lastUpdatedBy": "string",
"metadataCatalogConfig": {
"glueDataCatalog": {
"databaseName": "string",
"roleArn": "string",
"tablePrefix": "string"
}
},
"schemaVersion": number,
"sourceFlowConfig": {
"apiVersion": "string",
"connectorProfileName": "string",
"connectorType": "string",
"incrementalPullConfig": {
"datetimeTypeFieldName": "string"
},
"sourceConnectorProperties": {
"Amplitude": {
"object": "string"
},
"CustomConnector": {
"customProperties": {
"string" : "string"
},
"dataTransferApi": {
"Name": "string",
"Type": "string"
},
"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": "string"
}
},
"Salesforce": {
"dataTransferApi": "string",
"enableDynamicFieldUpdate": boolean,
"includeDeletedRecords": boolean,
"object": "string"
},
"SAPOData": {
"objectPath": "string",
"paginationConfig": {
"maxPageSize": number
},
"parallelismConfig": {
"maxParallelism": number
}
},
"ServiceNow": {
"object": "string"
},
"Singular": {
"object": "string"
},
"Slack": {
"object": "string"
},
"Trendmicro": {
"object": "string"
},
"Veeva": {
"documentType": "string",
"includeAllVersions": boolean,
"includeRenditions": boolean,
"includeSourceFiles": boolean,
"object": "string"
},
"Zendesk": {
"object": "string"
}
}
},
"tags": {
"string" : "string"
},
"tasks": [
{
"connectorOperator": {
"Amplitude": "string",
"CustomConnector": "string",
"Datadog": "string",
"Dynatrace": "string",
"GoogleAnalytics": "string",
"InforNexus": "string",
"Marketo": "string",
"Pardot": "string",
"S3": "string",
"Salesforce": "string",
"SAPOData": "string",
"ServiceNow": "string",
"Singular": "string",
"Slack": "string",
"Trendmicro": "string",
"Veeva": "string",
"Zendesk": "string"
},
"destinationField": "string",
"sourceFields": [ "string" ],
"taskProperties": {
"string" : "string"
},
"taskType": "string"
}
],
"triggerConfig": {
"triggerProperties": {
"Scheduled": {
"dataPullMode": "string",
"firstExecutionFrom": number,
"flowErrorDeactivationThreshold": number,
"scheduleEndTime": number,
"scheduleExpression": "string",
"scheduleOffset": number,
"scheduleStartTime": number,
"timezone": "string"
}
},
"triggerType": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [createdAt](#API_DescribeFlow_ResponseSyntax) **
Specifies when the flow was created.
Type: Timestamp
** [createdBy](#API_DescribeFlow_ResponseSyntax) **
The ARN of the user who created the flow.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `\S+`
** [description](#API_DescribeFlow_ResponseSyntax) **
A description of the flow.
Type: String
Length Constraints: Maximum length of 2048.
Pattern: `[\w!@#\-.?,\s]*`
** [destinationFlowConfigList](#API_DescribeFlow_ResponseSyntax) **
The configuration that controls how Amazon AppFlow transfers data to the destination connector.
Type: Array of [DestinationFlowConfig](API_DestinationFlowConfig.md) objects
** [flowArn](#API_DescribeFlow_ResponseSyntax) **
The flow's Amazon Resource Name (ARN).
Type: String
Length Constraints: Maximum length of 512.
Pattern: `arn:aws:appflow:.*:[0-9]+:.*`
** [flowName](#API_DescribeFlow_ResponseSyntax) **
The specified name of the flow. Spaces are not allowed. Use underscores (\$1) or hyphens (-) only.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `[a-zA-Z0-9][\w!@#.-]+`
** [flowStatus](#API_DescribeFlow_ResponseSyntax) **
Indicates the current status of the flow.
Type: String
Valid Values: `Active | Deprecated | Deleted | Draft | Errored | Suspended`
** [flowStatusMessage](#API_DescribeFlow_ResponseSyntax) **
Contains an error message if the flow status is in a suspended or error state. This applies only to scheduled or event-triggered flows.
Type: String
Length Constraints: Maximum length of 2048.
Pattern: `[\s\w/!@#+=.-]*`
** [kmsArn](#API_DescribeFlow_ResponseSyntax) **
The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. This is required if you do not want to use the Amazon AppFlow-managed KMS key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern: `arn:aws:kms:.*:[0-9]+:.*`
** [lastRunExecutionDetails](#API_DescribeFlow_ResponseSyntax) **
Describes the details of the most recent flow run.
Type: [ExecutionDetails](API_ExecutionDetails.md) object
** [lastRunMetadataCatalogDetails](#API_DescribeFlow_ResponseSyntax) **
Describes the metadata catalog, metadata table, and data partitions that Amazon AppFlow used for the associated flow run.
Type: Array of [MetadataCatalogDetail](API_MetadataCatalogDetail.md) objects
** [lastUpdatedAt](#API_DescribeFlow_ResponseSyntax) **
Specifies when the flow was last updated.
Type: Timestamp
** [lastUpdatedBy](#API_DescribeFlow_ResponseSyntax) **
Specifies the user name of the account that performed the most recent update.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `\S+`
** [metadataCatalogConfig](#API_DescribeFlow_ResponseSyntax) **
Specifies the configuration that Amazon AppFlow uses when it catalogs the data that's transferred by the associated flow. When Amazon AppFlow catalogs the data from a flow, it stores metadata in a data catalog.
Type: [MetadataCatalogConfig](API_MetadataCatalogConfig.md) object
** [schemaVersion](#API_DescribeFlow_ResponseSyntax) **
The version number of your data schema. Amazon AppFlow assigns this version number. The version number increases by one when you change any of the following settings in your flow configuration:
+ Source-to-destination field mappings
+ Field data types
+ Partition keys
Type: Long
** [sourceFlowConfig](#API_DescribeFlow_ResponseSyntax) **
The configuration that controls how Amazon AppFlow retrieves data from the source connector.
Type: [SourceFlowConfig](API_SourceFlowConfig.md) object
** [tags](#API_DescribeFlow_ResponseSyntax) **
The tags used to organize, track, or control access for your flow.
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`
Value Length Constraints: Maximum length of 256.
Value Pattern: `[\s\w+-=\.:/@]*`
** [tasks](#API_DescribeFlow_ResponseSyntax) **
A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
Type: Array of [Task](API_Task.md) objects
** [triggerConfig](#API_DescribeFlow_ResponseSyntax) **
The trigger settings that determine how and when the flow runs.
Type: [TriggerConfig](API_TriggerConfig.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
An internal service error occurred during the processing of your request. Try again later.
HTTP Status Code: 500
** ResourceNotFoundException **
The resource specified in the request (such as the source or destination connector profile) is not found.
HTTP Status Code: 404
## Examples
### DescribeFlow example
This example shows a sample request and response for the `DescribeFlow` API.
#### Sample Request
```
{
"flowName": "name"
}
```
#### Sample Response
```
{
"createdAt": "2022-02-22T15:31:41.467000-08:00",
"createdBy": "user",
"description": null,
"destinationFlowConfigList": [
{
"aggregationConfig": null,
"connectorProfileName": "connector_profile_name",
"connectorType": "S3",
"destinationConnectorProps":
{
"Redshift": null,
"S3":
{
"bucketKey": null,
"bucketName": "salesforceaccountflowbucket"
},
"Salesforce": null,
"Snowflake": null
}
}
],
"flowArn": "flow_arn_value",
"flowName": "test_flow_ondemand_10",
"flowStatus": "Active",
"flowStatusMessage": null,
"kmsArn": null,
"lastRunExecutionDetails": null,
"lastUpdatedAt": "2022-02-22T15:31:41.467000-08:00",
"lastUpdatedBy": "user",
"sourceFlowConfig":
{
"connectorProfileName": "connectorProfileName",
"connectorType": "Salesforce",
"sourceConnectorProps":
{
"Amplitude": null,
"Datadog": null,
"Dynatrace": null,
"GoogleAnalytics": null,
"InforNexus": null,
"Marketo": null,
"Redshift": null,
"S3": null,
"Salesforce":
{
"object": "Account"
},
"ServiceNow": null,
"Singular": null,
"Slack": null,
"Snowflake": null,
"Trendmicro": null,
"Veeva": null,
"Zendesk": null
}
},
"tags":
{
"internalId": "Internal_Id_value",
"resourceArn": "resource_arn_value"
},
"tasks": [
{
"connectorOperator": null,
"destinationField": "Id",
"operator": "NO_OP",
"sourceFields": ["Id"],
"taskProperties":
{
"DESTINATION_DATA_TYPE": "id",
"SOURCE_DATA_TYPE": "id"
},
"taskType": "Mapping"
},
{
"connectorOperator": null,
"destinationField": "Name",
"operator": "NO_OP",
"sourceFields": ["Name"],
"taskProperties":
{
"DESTINATION_DATA_TYPE": "string",
"SOURCE_DATA_TYPE": "string"
},
"taskType": "Mapping"
},
{
"connectorOperator": null,
"destinationField": null,
"operator": "PROJECTION",
"sourceFields": ["Id","Name"],
"taskProperties":
{},
"taskType": "Filtering"
}
],
"triggerConfig":
{
"triggerProps":
{
"ScheduledTriggerProps": null
},
"triggerType": "OnDemand"
}
}
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appflow-2020-08-23/DescribeFlow)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appflow-2020-08-23/DescribeFlow)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appflow-2020-08-23/DescribeFlow)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appflow-2020-08-23/DescribeFlow)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appflow-2020-08-23/DescribeFlow)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appflow-2020-08-23/DescribeFlow)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appflow-2020-08-23/DescribeFlow)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appflow-2020-08-23/DescribeFlow)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appflow-2020-08-23/DescribeFlow)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appflow-2020-08-23/DescribeFlow)
# DescribeFlowExecutionRecords
Fetches the execution history of the flow.
## Request Syntax
```
POST /describe-flow-execution-records HTTP/1.1
Content-type: application/json
{
"flowName": "string",
"maxResults": number,
"nextToken": "string"
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [flowName](#API_DescribeFlowExecutionRecords_RequestSyntax) **
The specified name of the flow. Spaces are not allowed. Use underscores (\$1) or hyphens (-) only.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `[a-zA-Z0-9][\w!@#.-]+`
Required: Yes
** [maxResults](#API_DescribeFlowExecutionRecords_RequestSyntax) **
Specifies the maximum number of items that should be returned in the result set. The default for `maxResults` is 20 (for all paginated API operations).
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
** [nextToken](#API_DescribeFlowExecutionRecords_RequestSyntax) **
The pagination token for the next page of data.
Type: String
Length Constraints: Maximum length of 2048.
Pattern: `\S+`
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"flowExecutions": [
{
"dataPullEndTime": number,
"dataPullStartTime": number,
"executionId": "string",
"executionResult": {
"bytesProcessed": number,
"bytesWritten": number,
"errorInfo": {
"executionMessage": "string",
"putFailuresCount": number
},
"maxPageSize": number,
"numParallelProcesses": number,
"recordsProcessed": number
},
"executionStatus": "string",
"lastUpdatedAt": number,
"metadataCatalogDetails": [
{
"catalogType": "string",
"partitionRegistrationOutput": {
"message": "string",
"result": "string",
"status": "string"
},
"tableName": "string",
"tableRegistrationOutput": {
"message": "string",
"result": "string",
"status": "string"
}
}
],
"startedAt": number
}
],
"nextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [flowExecutions](#API_DescribeFlowExecutionRecords_ResponseSyntax) **
Returns a list of all instances when this flow was run.
Type: Array of [ExecutionRecord](API_ExecutionRecord.md) objects
** [nextToken](#API_DescribeFlowExecutionRecords_ResponseSyntax) **
The pagination token for the next page of data.
Type: String
Length Constraints: Maximum length of 2048.
Pattern: `\S+`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
An internal service error occurred during the processing of your request. Try again later.
HTTP Status Code: 500
** ResourceNotFoundException **
The resource specified in the request (such as the source or destination connector profile) is not found.
HTTP Status Code: 404
** ValidationException **
The request has invalid or missing parameters.
HTTP Status Code: 400
## Examples
### DescribeFlowExecutionRecords examples
This example shows sample requests and responses for the `DescribeFlowExecutionRecords` API.
#### Sample Request
```
{
"flowName": "name",
"maxResults": 1
}
```
#### Sample Response
```
{
"flowExecutionList": [
{
"executionId": "Execution_ID",
"executionMessage": "Request failed with Trendmicro Status Code 404: , RequestId: RequestId_value",
"executionMetadata":
{
"bytesProcessed": 234,
"bytesWritten": 0,
"numFailures": 878,
"numFilteredRecords": 0,
"numPutFailures": 978978,
"reason": null,
"recordsProcessed": 23342,
"terminateFlow": false
},
"executionResult":
{
"bytesProcessed": 234,
"bytesWritten": 0,
"errorInfo":
{
"executionMessage": "Request failed with Trendmicro Status Code 404: , RequestId: RequestId_value",
"putFailuresCount": 978978
},
"recordsProcessed": 23342
},
"executionStartTime": "2022-02-22T15:31:41.467000-08:00",
"executionStatus": "Error",
"lastUpdatedAt": "2022-02-22T15:31:41.467000-08:00",
"startedAt": "2022-02-22T15:31:41.467000-08:00"
}
],
"nextToken": "next_token_value"
}
```
#### Sample Request
```
{
"flowName": "test-new-create",
"maxResults": 1,
"nextToken": "next_token_value"
}
```
#### Sample Response
```
{
"flowExecutionList": [
{
"executionId": "execution_id_value",
"executionMessage": "Request failed with Trendmicro Status Code 404: , RequestId: RequestId_value",
"executionMetadata": {
"bytesProcessed": 234,
"bytesWritten": 0,
"numFailures": 0,
"numFilteredRecords": 0,
"numPutFailures": 0,
"reason": null,
"recordsProcessed": 23342,
"terminateFlow": false
},
"executionResult": {
"bytesProcessed": 234,
"bytesWritten": 0,
"errorInfo": null,
"recordsProcessed": 23342
},
"executionStartTime": "execution_start_time_value",
"executionStatus": "Successful",
"lastUpdatedAt": "lastupdated_at_value",
"lastUpdatedTime": "lastupdated_time_value",
"startedAt": "started_at_value"
}
],
"nextToken": "next_token_value"
}
```
#### Sample Request
```
{
"flowName": "name",
"maxResults": 1,
"nextToken": "next_token_value"
}
```
#### Sample Response
```
{
"flowExecutionList": [
{
"executionId": "execution_id_value-delete",
"executionMessage": "Request failed with Trendmicro Status Code 404: , RequestId: RequestId_value",
"executionMetadata": {
"bytesProcessed": 0,
"bytesWritten": 0,
"numFailures": 0,
"numFilteredRecords": 0,
"numPutFailures": 0,
"reason": null,
"recordsProcessed": 0,
"terminateFlow": false
},
"executionResult": {
"bytesProcessed": 0,
"bytesWritten": 0,
"errorInfo": {
"executionMessage": "Request failed with Trendmicro Status Code 404: , RequestId: RequestId_value",
"putFailuresCount": 0
},
"recordsProcessed": 0
},
"executionStartTime": "execution_start_time_value",
"executionStatus": "Error",
"lastUpdatedAt": "lastupdated_at_value",
"lastUpdatedTime": "lastupdated_time_value",
"startedAt": "started_at_value"
}
],
"nextToken": "next_token_value"
}
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appflow-2020-08-23/DescribeFlowExecutionRecords)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appflow-2020-08-23/DescribeFlowExecutionRecords)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appflow-2020-08-23/DescribeFlowExecutionRecords)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appflow-2020-08-23/DescribeFlowExecutionRecords)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appflow-2020-08-23/DescribeFlowExecutionRecords)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appflow-2020-08-23/DescribeFlowExecutionRecords)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appflow-2020-08-23/DescribeFlowExecutionRecords)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appflow-2020-08-23/DescribeFlowExecutionRecords)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appflow-2020-08-23/DescribeFlowExecutionRecords)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appflow-2020-08-23/DescribeFlowExecutionRecords)
# ListConnectorEntities
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.
## Request Syntax
```
POST /list-connector-entities HTTP/1.1
Content-type: application/json
{
"apiVersion": "string",
"connectorProfileName": "string",
"connectorType": "string",
"entitiesPath": "string",
"maxResults": number,
"nextToken": "string"
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [apiVersion](#API_ListConnectorEntities_RequestSyntax) **
The version of the API that's used by the connector.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `\S+`
Required: No
** [connectorProfileName](#API_ListConnectorEntities_RequestSyntax) **
The name of the connector profile. The name is unique for each `ConnectorProfile` in the AWS account, and is used to query the downstream connector.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `[\w/!@#+=.-]+`
Required: No
** [connectorType](#API_ListConnectorEntities_RequestSyntax) **
The type of connector, such as Salesforce, Amplitude, and so on.
Type: String
Valid Values: `Salesforce | Singular | Slack | Redshift | S3 | Marketo | Googleanalytics | Zendesk | Servicenow | Datadog | Trendmicro | Snowflake | Dynatrace | Infornexus | Amplitude | Veeva | EventBridge | LookoutMetrics | Upsolver | Honeycode | CustomerProfiles | SAPOData | CustomConnector | Pardot`
Required: No
** [entitiesPath](#API_ListConnectorEntities_RequestSyntax) **
This optional parameter is specific to connector implementation. Some connectors support multiple levels or categories of entities. You can find out the list of roots for such providers by sending a request without the `entitiesPath` parameter. If the connector supports entities at different roots, this initial request returns the list of roots. Otherwise, this request returns all entities supported by the provider.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `[\s\w/!@#+=,.-]*`
Required: No
** [maxResults](#API_ListConnectorEntities_RequestSyntax) **
The maximum number of items that the operation returns in the response.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 10000.
Required: No
** [nextToken](#API_ListConnectorEntities_RequestSyntax) **
A token that was provided by your prior `ListConnectorEntities` operation if the response was too big for the page size. You specify this token to get the next page of results in paginated response.
Type: String
Length Constraints: Maximum length of 2048.
Pattern: `\S+`
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"connectorEntityMap": {
"string" : [
{
"hasNestedEntities": boolean,
"label": "string",
"name": "string"
}
]
},
"nextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [connectorEntityMap](#API_ListConnectorEntities_ResponseSyntax) **
The response of `ListConnectorEntities` lists entities grouped by category. This map's key represents the group name, and its value contains the list of entities belonging to that group.
Type: String to array of [ConnectorEntity](API_ConnectorEntity.md) objects map
Key Length Constraints: Maximum length of 128.
Key Pattern: `\S+`
** [nextToken](#API_ListConnectorEntities_ResponseSyntax) **
A token that you specify in your next `ListConnectorEntities` operation to get the next page of results in paginated response. The `ListConnectorEntities` operation provides this token if the response is too big for the page size.
Type: String
Length Constraints: Maximum length of 2048.
Pattern: `\S+`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ConnectorAuthenticationException **
An error occurred when authenticating with the connector endpoint.
HTTP Status Code: 401
** ConnectorServerException **
An error occurred when retrieving data from the connector endpoint.
HTTP Status Code: 400
** InternalServerException **
An internal service error occurred during the processing of your request. Try again later.
HTTP Status Code: 500
** ResourceNotFoundException **
The resource specified in the request (such as the source or destination connector profile) is not found.
HTTP Status Code: 404
** ValidationException **
The request has invalid or missing parameters.
HTTP Status Code: 400
## Examples
### ListConnectorEntities example
This example shows sample requests and a sample response for the `ListConnectorEntities` API. The second sample request shows a request without the optional `connectorType`).
#### Sample Request
```
{
"connectorType": "Slack",
"connectorProfileName": "vmSlackProfile"
}
```
#### Sample Request
```
{
"connectorProfileName": "vmSlackProfile"
}
```
#### Sample Response
```
{
"connectorEntityMap":
{
"Objects":
[
{"hasNestedEntities": true,
"label": "Conversations","name": "conversations"}
]
}
}
```
#### Sample Request
```
{
"connectorProfileName": "vmSlackProfile",
"connectorType": "Slack",
"entitiesPath": "conversations"
}
```
#### Sample Response
```
{
"connectorEntityMap":
{
"Channels": [
{
"hasNestedEntities": false,
"label": "new-to-slack",
"name": "conversations/CQCFDC534"
},
{
"hasNestedEntities": false,
"label": "advising",
"name": "conversations/CQDSNS2AX"
},
{
"hasNestedEntities": false,
"label": "general",
"name": "conversations/CQTFBK48N"
},
{
"hasNestedEntities": false,
"label": "random",
"name": "conversations/CQTFBK6CE"
},
{
"hasNestedEntities": false,
"label": "investing",
"name": "conversations/CQTFBKDT8"
},
{
"hasNestedEntities": false,
"label": "memories",
"name": "conversations/CS44VCEC9"
},
{
"hasNestedEntities": false,
"label": "home-of-nyc",
"name": "conversations/CV84P3D7A"
},
{
"hasNestedEntities": false,
"label": "marketing",
"name": "conversations/C012DDQRU95"
},
{
"hasNestedEntities": false,
"label": "home-of-phi",
"name": "conversations/C012DTFRBL7"
},
{
"hasNestedEntities": false,
"label": "home-of-philadelphia",
"name": "conversations/C012N003VU6"
},
{
"hasNestedEntities": false,
"label": "lol",
"name": "conversations/C012NJTMZEJ"
},
{
"hasNestedEntities": false,
"label": "home-of-atlanta",
"name": "conversations/C012P2739BQ"
},
{
"hasNestedEntities": false,
"label": "it-support",
"name": "conversations/C012SRQMLRH"
},
{
"hasNestedEntities": false,
"label": "home-of-nashville",
"name": "conversations/C012U9TM5DZ"
},
{
"hasNestedEntities": false,
"label": "home-of-texas",
"name": "conversations/C012VHLB63X"
},
{
"hasNestedEntities": false,
"label": "data",
"name": "conversations/C012Z3VMA7N"
},
{
"hasNestedEntities": false,
"label": "home-of-san-francisco",
"name": "conversations/C01308U07HA"
},
{
"hasNestedEntities": false,
"label": "slack-feedback",
"name": "conversations/C0131PCV93N"
},
{
"hasNestedEntities": false,
"label": "home-of-seattle",
"name": "conversations/C0136MRRQHX"
},
{
"hasNestedEntities": false,
"label": "operations",
"name": "conversations/C0136QPJ1KK"
},
{
"hasNestedEntities": false,
"label": "product",
"name": "conversations/C0137S730KT"
},
{
"hasNestedEntities": false,
"label": "dev",
"name": "conversations/C013HUHSRGQ"
},
{
"hasNestedEntities": false,
"label": "infra",
"name": "conversations/C013KP5TQ2J"
},
{
"hasNestedEntities": false,
"label": "pets",
"name": "conversations/C013NTC2L0G"
},
{
"hasNestedEntities": false,
"label": "founders",
"name": "conversations/C014M9JBWCU"
}
]
}
}
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appflow-2020-08-23/ListConnectorEntities)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appflow-2020-08-23/ListConnectorEntities)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appflow-2020-08-23/ListConnectorEntities)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appflow-2020-08-23/ListConnectorEntities)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appflow-2020-08-23/ListConnectorEntities)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appflow-2020-08-23/ListConnectorEntities)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appflow-2020-08-23/ListConnectorEntities)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appflow-2020-08-23/ListConnectorEntities)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appflow-2020-08-23/ListConnectorEntities)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appflow-2020-08-23/ListConnectorEntities)
# ListConnectors
Returns the list of all registered custom connectors in your AWS account. This API lists only custom connectors registered in this account, not the AWS authored connectors.
## Request Syntax
```
POST /list-connectors HTTP/1.1
Content-type: application/json
{
"maxResults": number,
"nextToken": "string"
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [maxResults](#API_ListConnectors_RequestSyntax) **
Specifies the maximum number of items that should be returned in the result set. The default for `maxResults` is 20 (for all paginated API operations).
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
** [nextToken](#API_ListConnectors_RequestSyntax) **
The pagination token for the next page of data.
Type: String
Length Constraints: Maximum length of 2048.
Pattern: `\S+`
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"connectors": [
{
"applicationType": "string",
"connectorDescription": "string",
"connectorLabel": "string",
"connectorModes": [ "string" ],
"connectorName": "string",
"connectorOwner": "string",
"connectorProvisioningType": "string",
"connectorType": "string",
"connectorVersion": "string",
"registeredAt": number,
"registeredBy": "string",
"supportedDataTransferTypes": [ "string" ]
}
],
"nextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [connectors](#API_ListConnectors_ResponseSyntax) **
Contains information about the connectors supported by Amazon AppFlow.
Type: Array of [ConnectorDetail](API_ConnectorDetail.md) objects
** [nextToken](#API_ListConnectors_ResponseSyntax) **
The pagination token for the next page of data. If nextToken=null, this means that all records have been fetched.
Type: String
Length Constraints: Maximum length of 2048.
Pattern: `\S+`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
An internal service error occurred during the processing of your request. Try again later.
HTTP Status Code: 500
** ValidationException **
The request has invalid or missing parameters.
HTTP Status Code: 400
## Examples
### Listing connectors
This example shows a sample request for the `ListConnector` API and a sample response.
#### Sample Request
```
{
"maxResults": 1,
"nextToken": "nextToken_value"
}
```
#### Sample Response
```
{
"connectors":
[
{
"connectorArn": "Arn of connector1",
"connectorDescription": "Some Sample Connector1",
"connectorName": "Salesforce custom connector1",
"connectorOwner": "AppFlow",
"connectorVersion": "1.0",
"applicationType": "Salesforce",
"connectorType": "CUSTOMCONNECTOR",
"connectorLabel": "MyCustomConnector",
"registeredAt": 1628732168.132,
"registeredBy": "CUSTOM",
"tags": null,
"connectorModes":
[
"SOURCE",
"DESTINATION"
],
"connectorProvisioningType": "LAMBDA"
},
{
"connectorArn": "Arn of connector2",
"connectorDescription": "Some Sample Connector2",
"connectorName": "Salesforce custom connector2",
"connectorOwner": "AppFlow",
"connectorVersion": "1.0",
"applicationType": "Salesforce",
"connectorType": "CUSTOMCONNECTOR",
"connectorLabel": "MyCustomConnector",
"registeredAt": 1628732168.132,
"registeredBy": "CUSTOM",
"tags": null,
"connectorModes":
[
"SOURCE",
"DESTINATION"
],
"connectorProvisioningType": "LAMBDA"
}
],
"nextToken": null
}
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appflow-2020-08-23/ListConnectors)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appflow-2020-08-23/ListConnectors)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appflow-2020-08-23/ListConnectors)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appflow-2020-08-23/ListConnectors)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appflow-2020-08-23/ListConnectors)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appflow-2020-08-23/ListConnectors)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appflow-2020-08-23/ListConnectors)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appflow-2020-08-23/ListConnectors)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appflow-2020-08-23/ListConnectors)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appflow-2020-08-23/ListConnectors)
# ListFlows
Lists all of the flows associated with your account.
## Request Syntax
```
POST /list-flows HTTP/1.1
Content-type: application/json
{
"maxResults": number,
"nextToken": "string"
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [maxResults](#API_ListFlows_RequestSyntax) **
Specifies the maximum number of items that should be returned in the result set.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
** [nextToken](#API_ListFlows_RequestSyntax) **
The pagination token for next page of data.
Type: String
Length Constraints: Maximum length of 2048.
Pattern: `\S+`
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"flows": [
{
"createdAt": number,
"createdBy": "string",
"description": "string",
"destinationConnectorLabel": "string",
"destinationConnectorType": "string",
"flowArn": "string",
"flowName": "string",
"flowStatus": "string",
"lastRunExecutionDetails": {
"mostRecentExecutionMessage": "string",
"mostRecentExecutionStatus": "string",
"mostRecentExecutionTime": number
},
"lastUpdatedAt": number,
"lastUpdatedBy": "string",
"sourceConnectorLabel": "string",
"sourceConnectorType": "string",
"tags": {
"string" : "string"
},
"triggerType": "string"
}
],
"nextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [flows](#API_ListFlows_ResponseSyntax) **
The list of flows associated with your account.
Type: Array of [FlowDefinition](API_FlowDefinition.md) objects
** [nextToken](#API_ListFlows_ResponseSyntax) **
The pagination token for next page of data.
Type: String
Length Constraints: Maximum length of 2048.
Pattern: `\S+`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
An internal service error occurred during the processing of your request. Try again later.
HTTP Status Code: 500
** ValidationException **
The request has invalid or missing parameters.
HTTP Status Code: 400
## Examples
### ListFlows examples
This example shows a sample request for the `ListFlows` API. In the second sample, note that `MaxResults` will show a number between 1 and 100.
#### Sample Request
```
{
"flowList": [
{
"createdAt": "created_time_value",
"createdBy": "arn:aws:iam:::user/BetaTestUser",
"description": "test flow 1 description",
"destinationConnectorType": "S3",
"destinationConnectorLabel": "MyCustomDestinationConnector",
"flowArn": "arn:aws:appflow:region::flow/test-flow-1",
"flowName": "test-flow-1",
"flowStatus": "Active",
"lastRunExecutionDetails":
{
"mostRecentExecutionMessage": "Successfully ran the flow",
"mostRecentExecutionStatus": "Successful",
"mostRecentExecutionTime": "execution_time_value"
},
"lastUpdatedAt": "lastupdated_time_value",
"lastUpdatedBy": "arn:aws:iam:::user/BetaTestUser",
"sourceConnectorType": "Salesforce",
"sourceConnectorLabel": "MyCustomSourceConnector",
"tags":
{
"internalId": "",
"resourceArn": "arn:aws:appflow:region::flow/test-flow-1"
},
"triggerType": "OnDemand"
}
],
"nextToken": "next_token_value"
}
```
```
{
"maxResults": 1
}
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appflow-2020-08-23/ListFlows)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appflow-2020-08-23/ListFlows)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appflow-2020-08-23/ListFlows)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appflow-2020-08-23/ListFlows)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appflow-2020-08-23/ListFlows)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appflow-2020-08-23/ListFlows)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appflow-2020-08-23/ListFlows)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appflow-2020-08-23/ListFlows)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appflow-2020-08-23/ListFlows)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appflow-2020-08-23/ListFlows)
# ListTagsForResource
Retrieves the tags that are associated with a specified flow.
## Request Syntax
```
GET /tags/resourceArn HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [resourceArn](#API_ListTagsForResource_RequestSyntax) **
The Amazon Resource Name (ARN) of the specified flow.
Length Constraints: Maximum length of 512.
Pattern: `arn:aws:.*:.*:[0-9]+:.*`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"tags": {
"string" : "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [tags](#API_ListTagsForResource_ResponseSyntax) **
The tags used to organize, track, or control access for your flow.
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`
Value Length Constraints: Maximum length of 256.
Value Pattern: `[\s\w+-=\.:/@]*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
An internal service error occurred during the processing of your request. Try again later.
HTTP Status Code: 500
** ResourceNotFoundException **
The resource specified in the request (such as the source or destination connector profile) is not found.
HTTP Status Code: 404
** ValidationException **
The request has invalid or missing parameters.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appflow-2020-08-23/ListTagsForResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appflow-2020-08-23/ListTagsForResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appflow-2020-08-23/ListTagsForResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appflow-2020-08-23/ListTagsForResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appflow-2020-08-23/ListTagsForResource)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appflow-2020-08-23/ListTagsForResource)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appflow-2020-08-23/ListTagsForResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appflow-2020-08-23/ListTagsForResource)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appflow-2020-08-23/ListTagsForResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appflow-2020-08-23/ListTagsForResource)
# RegisterConnector
Registers a new custom connector with your AWS account. Before you can register the connector, you must deploy the associated AWS lambda function in your account.
## Request Syntax
```
POST /register-connector HTTP/1.1
Content-type: application/json
{
"clientToken": "string",
"connectorLabel": "string",
"connectorProvisioningConfig": {
"lambda": {
"lambdaArn": "string"
}
},
"connectorProvisioningType": "string",
"description": "string"
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [clientToken](#API_RegisterConnector_RequestSyntax) **
The `clientToken` parameter is an idempotency token. It ensures that your `RegisterConnector` request completes only once. You choose the value to pass. For example, if you don't receive a response from your request, you can safely retry the request with the same `clientToken` parameter value.
If you omit a `clientToken` value, the AWS SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases.
If you specify input parameters that differ from your first request, an error occurs. If you use a different value for `clientToken`, Amazon AppFlow considers it a new call to `RegisterConnector`. The token is active for 8 hours.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `[ -~]+`
Required: No
** [connectorLabel](#API_RegisterConnector_RequestSyntax) **
The name of the connector. The name is unique for each `ConnectorRegistration` in your AWS account.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `[a-zA-Z0-9][\w!@#.-]+`
Required: No
** [connectorProvisioningConfig](#API_RegisterConnector_RequestSyntax) **
The provisioning type of the connector. Currently the only supported value is LAMBDA.
Type: [ConnectorProvisioningConfig](API_ConnectorProvisioningConfig.md) object
Required: No
** [connectorProvisioningType](#API_RegisterConnector_RequestSyntax) **
The provisioning type of the connector. Currently the only supported value is LAMBDA.
Type: String
Valid Values: `LAMBDA`
Required: No
** [description](#API_RegisterConnector_RequestSyntax) **
A description about the connector that's being registered.
Type: String
Length Constraints: Maximum length of 1024.
Pattern: `[\s\w/!@#+=.-]*`
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"connectorArn": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [connectorArn](#API_RegisterConnector_ResponseSyntax) **
The ARN of the connector being registered.
Type: String
Length Constraints: Maximum length of 512.
Pattern: `arn:aws:.*:.*:[0-9]+:.*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
AppFlow/Requester has invalid or missing permissions.
HTTP Status Code: 403
** 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.
HTTP Status Code: 409
** ConnectorAuthenticationException **
An error occurred when authenticating with the connector endpoint.
HTTP Status Code: 401
** ConnectorServerException **
An error occurred when retrieving data from the connector endpoint.
HTTP Status Code: 400
** InternalServerException **
An internal service error occurred during the processing of your request. Try again later.
HTTP Status Code: 500
** ResourceNotFoundException **
The resource specified in the request (such as the source or destination connector profile) is not found.
HTTP Status Code: 404
** ServiceQuotaExceededException **
The request would cause a service quota (such as the number of flows) to be exceeded.
HTTP Status Code: 402
** ThrottlingException **
API calls have exceeded the maximum allowed API request rate per account and per Region.
HTTP Status Code: 429
** ValidationException **
The request has invalid or missing parameters.
HTTP Status Code: 400
## Examples
### Registering a connector
This example shows a sample request for the `RegisterConnector` API and a sample response.
#### Sample Request
```
{
"connectorLabel": "Connector_Label_Value",
"connectorProvisioningType": "LAMBDA",
"connectorProvisioningConfig":
{
"lambda":
{
"lambdaArn": "lambda arn"
}
}
}
```
#### Sample Response
```
{
"connectorArn": "arn:aws:appflow:region::connector/Connector_Label"
}
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appflow-2020-08-23/RegisterConnector)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appflow-2020-08-23/RegisterConnector)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appflow-2020-08-23/RegisterConnector)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appflow-2020-08-23/RegisterConnector)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appflow-2020-08-23/RegisterConnector)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appflow-2020-08-23/RegisterConnector)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appflow-2020-08-23/RegisterConnector)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appflow-2020-08-23/RegisterConnector)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appflow-2020-08-23/RegisterConnector)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appflow-2020-08-23/RegisterConnector)
# ResetConnectorMetadataCache
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.
## Request Syntax
```
POST /reset-connector-metadata-cache HTTP/1.1
Content-type: application/json
{
"apiVersion": "string",
"connectorEntityName": "string",
"connectorProfileName": "string",
"connectorType": "string",
"entitiesPath": "string"
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [apiVersion](#API_ResetConnectorMetadataCache_RequestSyntax) **
The API version that you specified in the connector profile that you’re resetting cached metadata for. You must use this parameter only if the connector supports multiple API versions or if the connector type is CustomConnector.
To look up how many versions a connector supports, use the DescribeConnectors action. In the response, find the value that Amazon AppFlow returns for the connectorVersion parameter.
To look up the connector type, use the DescribeConnectorProfiles action. In the response, find the value that Amazon AppFlow returns for the connectorType parameter.
To look up the API version that you specified in a connector profile, use the DescribeConnectorProfiles action.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `\S+`
Required: No
** [connectorEntityName](#API_ResetConnectorMetadataCache_RequestSyntax) **
Use this parameter if you want to reset cached metadata about the details for an individual entity.
If you don't include this parameter in your request, Amazon AppFlow only resets cached metadata about entity names, not entity details.
Type: String
Length Constraints: Maximum length of 1024.
Pattern: `\S+`
Required: No
** [connectorProfileName](#API_ResetConnectorMetadataCache_RequestSyntax) **
The name of the connector profile that you want to reset cached metadata for.
You can omit this parameter if you're resetting the cache for any of the following connectors: Amazon Connect, Amazon EventBridge, Amazon Lookout for Metrics, Amazon S3, or Upsolver. If you're resetting the cache for any other connector, you must include this parameter in your request.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `[\w/!@#+=.-]+`
Required: No
** [connectorType](#API_ResetConnectorMetadataCache_RequestSyntax) **
The type of connector to reset cached metadata for.
You must include this parameter in your request if you're resetting the cache for any of the following connectors: Amazon Connect, Amazon EventBridge, Amazon Lookout for Metrics, Amazon S3, or Upsolver. If you're resetting the cache for any other connector, you can omit this parameter from your request.
Type: String
Valid Values: `Salesforce | Singular | Slack | Redshift | S3 | Marketo | Googleanalytics | Zendesk | Servicenow | Datadog | Trendmicro | Snowflake | Dynatrace | Infornexus | Amplitude | Veeva | EventBridge | LookoutMetrics | Upsolver | Honeycode | CustomerProfiles | SAPOData | CustomConnector | Pardot`
Required: No
** [entitiesPath](#API_ResetConnectorMetadataCache_RequestSyntax) **
Use this parameter only if you’re resetting the cached metadata about a nested entity. Only some connectors support nested entities. A nested entity is one that has another entity as a parent. To use this parameter, specify the name of the parent entity.
To look up the parent-child relationship of entities, you can send a ListConnectorEntities request that omits the entitiesPath parameter. Amazon AppFlow will return a list of top-level entities. For each one, it indicates whether the entity has nested entities. Then, in a subsequent ListConnectorEntities request, you can specify a parent entity name for the entitiesPath parameter. Amazon AppFlow will return a list of the child entities for that parent.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `[\s\w/!@#+=,.-]*`
Required: No
## Response Syntax
```
HTTP/1.1 200
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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.
HTTP Status Code: 409
** InternalServerException **
An internal service error occurred during the processing of your request. Try again later.
HTTP Status Code: 500
** ResourceNotFoundException **
The resource specified in the request (such as the source or destination connector profile) is not found.
HTTP Status Code: 404
** ValidationException **
The request has invalid or missing parameters.
HTTP Status Code: 400
## Examples
### Reset cache of entity names
The following example shows the request body for a call to reset the cached metadata for entity names.
#### Sample Request
```
{
"apiVersion": "v1.0",
"connectorProfileName": "MyCustomConnector"
}
```
#### Sample Response
```
{}
```
### Reset cache of entity details
The following example shows the request body for a call to reset the cached metadata about the details for a specific entity.
#### Sample Request
```
{
"apiVersion": "v1.0",
"connectorProfileName": "MyCustomConnector",
"connectorEntityName": "EntityName"
}
```
#### Sample Response
```
{}
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appflow-2020-08-23/ResetConnectorMetadataCache)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appflow-2020-08-23/ResetConnectorMetadataCache)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appflow-2020-08-23/ResetConnectorMetadataCache)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appflow-2020-08-23/ResetConnectorMetadataCache)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appflow-2020-08-23/ResetConnectorMetadataCache)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appflow-2020-08-23/ResetConnectorMetadataCache)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appflow-2020-08-23/ResetConnectorMetadataCache)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appflow-2020-08-23/ResetConnectorMetadataCache)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appflow-2020-08-23/ResetConnectorMetadataCache)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appflow-2020-08-23/ResetConnectorMetadataCache)
# StartFlow
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.
## Request Syntax
```
POST /start-flow HTTP/1.1
Content-type: application/json
{
"clientToken": "string",
"flowName": "string"
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [clientToken](#API_StartFlow_RequestSyntax) **
The `clientToken` parameter is an idempotency token. It ensures that your `StartFlow` request completes only once. You choose the value to pass. For example, if you don't receive a response from your request, you can safely retry the request with the same `clientToken` parameter value.
If you omit a `clientToken` value, the AWS SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases.
If you specify input parameters that differ from your first request, an error occurs for flows that run on a schedule or based on an event. However, the error doesn't occur for flows that run on demand. You set the conditions that initiate your flow for the `triggerConfig` parameter.
If you use a different value for `clientToken`, Amazon AppFlow considers it a new call to `StartFlow`. The token is active for 8 hours.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `[ -~]+`
Required: No
** [flowName](#API_StartFlow_RequestSyntax) **
The specified name of the flow. Spaces are not allowed. Use underscores (\$1) or hyphens (-) only.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `[a-zA-Z0-9][\w!@#.-]+`
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"executionId": "string",
"flowArn": "string",
"flowStatus": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [executionId](#API_StartFlow_ResponseSyntax) **
Returns the internal execution ID of an on-demand flow when the flow is started. For scheduled or event-triggered flows, this value is null.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `\S+`
** [flowArn](#API_StartFlow_ResponseSyntax) **
The flow's Amazon Resource Name (ARN).
Type: String
Length Constraints: Maximum length of 512.
Pattern: `arn:aws:appflow:.*:[0-9]+:.*`
** [flowStatus](#API_StartFlow_ResponseSyntax) **
Indicates the current status of the flow.
Type: String
Valid Values: `Active | Deprecated | Deleted | Draft | Errored | Suspended`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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.
HTTP Status Code: 409
** InternalServerException **
An internal service error occurred during the processing of your request. Try again later.
HTTP Status Code: 500
** ResourceNotFoundException **
The resource specified in the request (such as the source or destination connector profile) is not found.
HTTP Status Code: 404
** ServiceQuotaExceededException **
The request would cause a service quota (such as the number of flows) to be exceeded.
HTTP Status Code: 402
## Examples
### StartFlow example
This example shows a sample request and response for the `StartFlow` API.
#### Sample Request
```
{
"flowName": "name"
}
```
#### Sample Response
```
{
"flowArn": "arn:aws:appflow:region::flow/test_flow_ondemand_1",
"flowStatus": "Active"
}
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appflow-2020-08-23/StartFlow)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appflow-2020-08-23/StartFlow)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appflow-2020-08-23/StartFlow)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appflow-2020-08-23/StartFlow)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appflow-2020-08-23/StartFlow)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appflow-2020-08-23/StartFlow)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appflow-2020-08-23/StartFlow)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appflow-2020-08-23/StartFlow)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appflow-2020-08-23/StartFlow)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appflow-2020-08-23/StartFlow)
# StopFlow
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.
## Request Syntax
```
POST /stop-flow HTTP/1.1
Content-type: application/json
{
"flowName": "string"
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [flowName](#API_StopFlow_RequestSyntax) **
The specified name of the flow. Spaces are not allowed. Use underscores (\$1) or hyphens (-) only.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `[a-zA-Z0-9][\w!@#.-]+`
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"flowArn": "string",
"flowStatus": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [flowArn](#API_StopFlow_ResponseSyntax) **
The flow's Amazon Resource Name (ARN).
Type: String
Length Constraints: Maximum length of 512.
Pattern: `arn:aws:appflow:.*:[0-9]+:.*`
** [flowStatus](#API_StopFlow_ResponseSyntax) **
Indicates the current status of the flow.
Type: String
Valid Values: `Active | Deprecated | Deleted | Draft | Errored | Suspended`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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.
HTTP Status Code: 409
** InternalServerException **
An internal service error occurred during the processing of your request. Try again later.
HTTP Status Code: 500
** ResourceNotFoundException **
The resource specified in the request (such as the source or destination connector profile) is not found.
HTTP Status Code: 404
** UnsupportedOperationException **
The requested operation is not supported for the current flow.
HTTP Status Code: 400
## Examples
### StopFlow example
This example shows a sample request and response for the `StopFlow` API.
#### Sample Request
```
{
"flowName": "name"
}
```
#### Sample Response
```
{
"flowArn": "arn:aws:appflow:region::flow/test_flow_ondemand_1",
"flowStatus": "Suspended"
}
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appflow-2020-08-23/StopFlow)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appflow-2020-08-23/StopFlow)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appflow-2020-08-23/StopFlow)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appflow-2020-08-23/StopFlow)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appflow-2020-08-23/StopFlow)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appflow-2020-08-23/StopFlow)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appflow-2020-08-23/StopFlow)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appflow-2020-08-23/StopFlow)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appflow-2020-08-23/StopFlow)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appflow-2020-08-23/StopFlow)
# TagResource
Applies a tag to the specified flow.
## Request Syntax
```
POST /tags/resourceArn HTTP/1.1
Content-type: application/json
{
"tags": {
"string" : "string"
}
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [resourceArn](#API_TagResource_RequestSyntax) **
The Amazon Resource Name (ARN) of the flow that you want to tag.
Length Constraints: Maximum length of 512.
Pattern: `arn:aws:.*:.*:[0-9]+:.*`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [tags](#API_TagResource_RequestSyntax) **
The tags used to organize, track, or control access for your flow.
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`
Value Length Constraints: Maximum length of 256.
Value Pattern: `[\s\w+-=\.:/@]*`
Required: Yes
## Response Syntax
```
HTTP/1.1 200
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
An internal service error occurred during the processing of your request. Try again later.
HTTP Status Code: 500
** ResourceNotFoundException **
The resource specified in the request (such as the source or destination connector profile) is not found.
HTTP Status Code: 404
** ValidationException **
The request has invalid or missing parameters.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appflow-2020-08-23/TagResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appflow-2020-08-23/TagResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appflow-2020-08-23/TagResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appflow-2020-08-23/TagResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appflow-2020-08-23/TagResource)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appflow-2020-08-23/TagResource)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appflow-2020-08-23/TagResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appflow-2020-08-23/TagResource)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appflow-2020-08-23/TagResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appflow-2020-08-23/TagResource)
# UnregisterConnector
Unregisters the custom connector registered in your account that matches the connector label provided in the request.
## Request Syntax
```
POST /unregister-connector HTTP/1.1
Content-type: application/json
{
"connectorLabel": "string",
"forceDelete": boolean
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [connectorLabel](#API_UnregisterConnector_RequestSyntax) **
The label of the connector. The label is unique for each `ConnectorRegistration` in your AWS account.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `[a-zA-Z0-9][\w!@#.-]+`
Required: Yes
** [forceDelete](#API_UnregisterConnector_RequestSyntax) **
Indicates whether Amazon AppFlow should unregister the connector, even if it is currently in use in one or more connector profiles. The default value is false.
Type: Boolean
Required: No
## Response Syntax
```
HTTP/1.1 200
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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.
HTTP Status Code: 409
** InternalServerException **
An internal service error occurred during the processing of your request. Try again later.
HTTP Status Code: 500
** ResourceNotFoundException **
The resource specified in the request (such as the source or destination connector profile) is not found.
HTTP Status Code: 404
## Examples
### Unregister connectors
This example shows a sample request for the `UnregisterConnector` API and a sample response.
#### Sample Request
```
{
"connectorLabel": "MySampleCustomConnector",
"forceDelete": true
}
```
```
{
"message": "Conflict executing request: Connector: MySampleCustomConnector is associated with one or more connector profiles. If you still want to *delete* it, *then* make *delete* request *with* forceDelete flag *as* true. *Some* of the associated connector profiles are: [myTestProfile1, myTestProfile2]"
}
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appflow-2020-08-23/UnregisterConnector)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appflow-2020-08-23/UnregisterConnector)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appflow-2020-08-23/UnregisterConnector)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appflow-2020-08-23/UnregisterConnector)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appflow-2020-08-23/UnregisterConnector)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appflow-2020-08-23/UnregisterConnector)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appflow-2020-08-23/UnregisterConnector)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appflow-2020-08-23/UnregisterConnector)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appflow-2020-08-23/UnregisterConnector)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appflow-2020-08-23/UnregisterConnector)
# UntagResource
Removes a tag from the specified flow.
## Request Syntax
```
DELETE /tags/resourceArn?tagKeys=tagKeys HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [resourceArn](#API_UntagResource_RequestSyntax) **
The Amazon Resource Name (ARN) of the flow that you want to untag.
Length Constraints: Maximum length of 512.
Pattern: `arn:aws:.*:.*:[0-9]+:.*`
Required: Yes
** [tagKeys](#API_UntagResource_RequestSyntax) **
The tag keys associated with the tag that you want to remove from your flow.
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
An internal service error occurred during the processing of your request. Try again later.
HTTP Status Code: 500
** ResourceNotFoundException **
The resource specified in the request (such as the source or destination connector profile) is not found.
HTTP Status Code: 404
** ValidationException **
The request has invalid or missing parameters.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appflow-2020-08-23/UntagResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appflow-2020-08-23/UntagResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appflow-2020-08-23/UntagResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appflow-2020-08-23/UntagResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appflow-2020-08-23/UntagResource)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appflow-2020-08-23/UntagResource)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appflow-2020-08-23/UntagResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appflow-2020-08-23/UntagResource)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appflow-2020-08-23/UntagResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appflow-2020-08-23/UntagResource)
# UpdateConnectorProfile
Updates a given connector profile associated with your account.
## Request Syntax
```
POST /update-connector-profile HTTP/1.1
Content-type: application/json
{
"clientToken": "string",
"connectionMode": "string",
"connectorProfileConfig": {
"connectorProfileCredentials": {
"Amplitude": {
"apiKey": "string",
"secretKey": "string"
},
"CustomConnector": {
"apiKey": {
"apiKey": "string",
"apiSecretKey": "string"
},
"authenticationType": "string",
"basic": {
"password": "string",
"username": "string"
},
"custom": {
"credentialsMap": {
"string" : "string"
},
"customAuthenticationType": "string"
},
"oauth2": {
"accessToken": "string",
"clientId": "string",
"clientSecret": "string",
"oAuthRequest": {
"authCode": "string",
"redirectUri": "string"
},
"refreshToken": "string"
}
},
"Datadog": {
"apiKey": "string",
"applicationKey": "string"
},
"Dynatrace": {
"apiToken": "string"
},
"GoogleAnalytics": {
"accessToken": "string",
"clientId": "string",
"clientSecret": "string",
"oAuthRequest": {
"authCode": "string",
"redirectUri": "string"
},
"refreshToken": "string"
},
"Honeycode": {
"accessToken": "string",
"oAuthRequest": {
"authCode": "string",
"redirectUri": "string"
},
"refreshToken": "string"
},
"InforNexus": {
"accessKeyId": "string",
"datakey": "string",
"secretAccessKey": "string",
"userId": "string"
},
"Marketo": {
"accessToken": "string",
"clientId": "string",
"clientSecret": "string",
"oAuthRequest": {
"authCode": "string",
"redirectUri": "string"
}
},
"Pardot": {
"accessToken": "string",
"clientCredentialsArn": "string",
"oAuthRequest": {
"authCode": "string",
"redirectUri": "string"
},
"refreshToken": "string"
},
"Redshift": {
"password": "string",
"username": "string"
},
"Salesforce": {
"accessToken": "string",
"clientCredentialsArn": "string",
"jwtToken": "string",
"oAuth2GrantType": "string",
"oAuthRequest": {
"authCode": "string",
"redirectUri": "string"
},
"refreshToken": "string"
},
"SAPOData": {
"basicAuthCredentials": {
"password": "string",
"username": "string"
},
"oAuthCredentials": {
"accessToken": "string",
"clientId": "string",
"clientSecret": "string",
"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"
},
"Slack": {
"accessToken": "string",
"clientId": "string",
"clientSecret": "string",
"oAuthRequest": {
"authCode": "string",
"redirectUri": "string"
}
},
"Snowflake": {
"password": "string",
"username": "string"
},
"Trendmicro": {
"apiSecretKey": "string"
},
"Veeva": {
"password": "string",
"username": "string"
},
"Zendesk": {
"accessToken": "string",
"clientId": "string",
"clientSecret": "string",
"oAuthRequest": {
"authCode": "string",
"redirectUri": "string"
}
}
},
"connectorProfileProperties": {
"Amplitude": {
},
"CustomConnector": {
"oAuth2Properties": {
"oAuth2GrantType": "string",
"tokenUrl": "string",
"tokenUrlCustomProperties": {
"string" : "string"
}
},
"profileProperties": {
"string" : "string"
}
},
"Datadog": {
"instanceUrl": "string"
},
"Dynatrace": {
"instanceUrl": "string"
},
"GoogleAnalytics": {
},
"Honeycode": {
},
"InforNexus": {
"instanceUrl": "string"
},
"Marketo": {
"instanceUrl": "string"
},
"Pardot": {
"businessUnitId": "string",
"instanceUrl": "string",
"isSandboxEnvironment": boolean
},
"Redshift": {
"bucketName": "string",
"bucketPrefix": "string",
"clusterIdentifier": "string",
"dataApiRoleArn": "string",
"databaseName": "string",
"databaseUrl": "string",
"isRedshiftServerless": boolean,
"roleArn": "string",
"workgroupName": "string"
},
"Salesforce": {
"instanceUrl": "string",
"isSandboxEnvironment": boolean,
"usePrivateLinkForMetadataAndAuthorization": boolean
},
"SAPOData": {
"applicationHostUrl": "string",
"applicationServicePath": "string",
"clientNumber": "string",
"disableSSO": boolean,
"logonLanguage": "string",
"oAuthProperties": {
"authCodeUrl": "string",
"oAuthScopes": [ "string" ],
"tokenUrl": "string"
},
"portNumber": number,
"privateLinkServiceName": "string"
},
"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"
}
}
},
"connectorProfileName": "string"
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [clientToken](#API_UpdateConnectorProfile_RequestSyntax) **
The `clientToken` parameter is an idempotency token. It ensures that your `UpdateConnectorProfile` request completes only once. You choose the value to pass. For example, if you don't receive a response from your request, you can safely retry the request with the same `clientToken` parameter value.
If you omit a `clientToken` value, the AWS SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases.
If you specify input parameters that differ from your first request, an error occurs. If you use a different value for `clientToken`, Amazon AppFlow considers it a new call to `UpdateConnectorProfile`. The token is active for 8 hours.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `[ -~]+`
Required: No
** [connectionMode](#API_UpdateConnectorProfile_RequestSyntax) **
Indicates the connection mode and if it is public or private.
Type: String
Valid Values: `Public | Private`
Required: Yes
** [connectorProfileConfig](#API_UpdateConnectorProfile_RequestSyntax) **
Defines the connector-specific profile configuration and credentials.
Type: [ConnectorProfileConfig](API_ConnectorProfileConfig.md) object
Required: Yes
** [connectorProfileName](#API_UpdateConnectorProfile_RequestSyntax) **
The name of the connector profile and is unique for each `ConnectorProfile` in the AWS account.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `[\w/!@#+=.-]+`
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"connectorProfileArn": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [connectorProfileArn](#API_UpdateConnectorProfile_ResponseSyntax) **
The Amazon Resource Name (ARN) of the connector profile.
Type: String
Length Constraints: Maximum length of 512.
Pattern: `arn:aws:appflow:.*:[0-9]+:.*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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.
HTTP Status Code: 409
** ConnectorAuthenticationException **
An error occurred when authenticating with the connector endpoint.
HTTP Status Code: 401
** InternalServerException **
An internal service error occurred during the processing of your request. Try again later.
HTTP Status Code: 500
** ResourceNotFoundException **
The resource specified in the request (such as the source or destination connector profile) is not found.
HTTP Status Code: 404
** ValidationException **
The request has invalid or missing parameters.
HTTP Status Code: 400
## Examples
### UpdateConnectorProfile example using Salesforce
This example shows a sample request and response for the `UpdateConnectorProfile` API using Salesforce.
#### Sample Request
```
{
"connectorProfileName": "Connector_Profile_Name_value",
"kmsArn": null,
"connectorType": "Salesforce",
"connectionMode": "Public",
"connectorProfileConfig":
{
"connectorProfileProperties":
{
"salesforce":
{
"instanceUrl": "Instance_url_value",
"isSandboxEnvironment": false
}
},
"connectorProfileCredentials":
{
"salesforce":
{
"accessToken": "",
"refreshToken": "",
"oauthRequest":
{
"authCode": null,
"redirectUri": null
}
}
}
}
}
```
#### Sample Response
```
{
"connectorProfileArn": "arn:aws:appflow:region::connectorprofile/Connector_Profile_Name"
}
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appflow-2020-08-23/UpdateConnectorProfile)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appflow-2020-08-23/UpdateConnectorProfile)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appflow-2020-08-23/UpdateConnectorProfile)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appflow-2020-08-23/UpdateConnectorProfile)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appflow-2020-08-23/UpdateConnectorProfile)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appflow-2020-08-23/UpdateConnectorProfile)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appflow-2020-08-23/UpdateConnectorProfile)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appflow-2020-08-23/UpdateConnectorProfile)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appflow-2020-08-23/UpdateConnectorProfile)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appflow-2020-08-23/UpdateConnectorProfile)
# UpdateConnectorRegistration
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
## Request Syntax
```
POST /update-connector-registration HTTP/1.1
Content-type: application/json
{
"clientToken": "string",
"connectorLabel": "string",
"connectorProvisioningConfig": {
"lambda": {
"lambdaArn": "string"
}
},
"description": "string"
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [clientToken](#API_UpdateConnectorRegistration_RequestSyntax) **
The `clientToken` parameter is an idempotency token. It ensures that your `UpdateConnectorRegistration` request completes only once. You choose the value to pass. For example, if you don't receive a response from your request, you can safely retry the request with the same `clientToken` parameter value.
If you omit a `clientToken` value, the AWS SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases.
If you specify input parameters that differ from your first request, an error occurs. If you use a different value for `clientToken`, Amazon AppFlow considers it a new call to `UpdateConnectorRegistration`. The token is active for 8 hours.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `[ -~]+`
Required: No
** [connectorLabel](#API_UpdateConnectorRegistration_RequestSyntax) **
The name of the connector. The name is unique for each connector registration in your AWS account.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `[a-zA-Z0-9][\w!@#.-]+`
Required: Yes
** [connectorProvisioningConfig](#API_UpdateConnectorRegistration_RequestSyntax) **
Contains information about the configuration of the connector being registered.
Type: [ConnectorProvisioningConfig](API_ConnectorProvisioningConfig.md) object
Required: No
** [description](#API_UpdateConnectorRegistration_RequestSyntax) **
A description about the update that you're applying to the connector.
Type: String
Length Constraints: Maximum length of 1024.
Pattern: `[\s\w/!@#+=.-]*`
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"connectorArn": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [connectorArn](#API_UpdateConnectorRegistration_ResponseSyntax) **
The ARN of the connector being updated.
Type: String
Length Constraints: Maximum length of 512.
Pattern: `arn:aws:.*:.*:[0-9]+:.*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
AppFlow/Requester has invalid or missing permissions.
HTTP Status Code: 403
** 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.
HTTP Status Code: 409
** ConnectorAuthenticationException **
An error occurred when authenticating with the connector endpoint.
HTTP Status Code: 401
** ConnectorServerException **
An error occurred when retrieving data from the connector endpoint.
HTTP Status Code: 400
** InternalServerException **
An internal service error occurred during the processing of your request. Try again later.
HTTP Status Code: 500
** ResourceNotFoundException **
The resource specified in the request (such as the source or destination connector profile) is not found.
HTTP Status Code: 404
** ServiceQuotaExceededException **
The request would cause a service quota (such as the number of flows) to be exceeded.
HTTP Status Code: 402
** ThrottlingException **
API calls have exceeded the maximum allowed API request rate per account and per Region.
HTTP Status Code: 429
** ValidationException **
The request has invalid or missing parameters.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appflow-2020-08-23/UpdateConnectorRegistration)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appflow-2020-08-23/UpdateConnectorRegistration)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appflow-2020-08-23/UpdateConnectorRegistration)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appflow-2020-08-23/UpdateConnectorRegistration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appflow-2020-08-23/UpdateConnectorRegistration)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appflow-2020-08-23/UpdateConnectorRegistration)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appflow-2020-08-23/UpdateConnectorRegistration)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appflow-2020-08-23/UpdateConnectorRegistration)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appflow-2020-08-23/UpdateConnectorRegistration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appflow-2020-08-23/UpdateConnectorRegistration)
# UpdateFlow
Updates an existing flow.
## Request Syntax
```
POST /update-flow HTTP/1.1
Content-type: application/json
{
"clientToken": "string",
"description": "string",
"destinationFlowConfigList": [
{
"apiVersion": "string",
"connectorProfileName": "string",
"connectorType": "string",
"destinationConnectorProperties": {
"CustomConnector": {
"customProperties": {
"string" : "string"
},
"entityName": "string",
"errorHandlingConfig": {
"bucketName": "string",
"bucketPrefix": "string",
"failOnFirstDestinationError": boolean
},
"idFieldNames": [ "string" ],
"writeOperationType": "string"
},
"CustomerProfiles": {
"domainName": "string",
"objectTypeName": "string"
},
"EventBridge": {
"errorHandlingConfig": {
"bucketName": "string",
"bucketPrefix": "string",
"failOnFirstDestinationError": boolean
},
"object": "string"
},
"Honeycode": {
"errorHandlingConfig": {
"bucketName": "string",
"bucketPrefix": "string",
"failOnFirstDestinationError": boolean
},
"object": "string"
},
"LookoutMetrics": {
},
"Marketo": {
"errorHandlingConfig": {
"bucketName": "string",
"bucketPrefix": "string",
"failOnFirstDestinationError": boolean
},
"object": "string"
},
"Redshift": {
"bucketPrefix": "string",
"errorHandlingConfig": {
"bucketName": "string",
"bucketPrefix": "string",
"failOnFirstDestinationError": boolean
},
"intermediateBucketName": "string",
"object": "string"
},
"S3": {
"bucketName": "string",
"bucketPrefix": "string",
"s3OutputFormatConfig": {
"aggregationConfig": {
"aggregationType": "string",
"targetFileSize": number
},
"fileType": "string",
"prefixConfig": {
"pathPrefixHierarchy": [ "string" ],
"prefixFormat": "string",
"prefixType": "string"
},
"preserveSourceDataTyping": boolean
}
},
"Salesforce": {
"dataTransferApi": "string",
"errorHandlingConfig": {
"bucketName": "string",
"bucketPrefix": "string",
"failOnFirstDestinationError": boolean
},
"idFieldNames": [ "string" ],
"object": "string",
"writeOperationType": "string"
},
"SAPOData": {
"errorHandlingConfig": {
"bucketName": "string",
"bucketPrefix": "string",
"failOnFirstDestinationError": boolean
},
"idFieldNames": [ "string" ],
"objectPath": "string",
"successResponseHandlingConfig": {
"bucketName": "string",
"bucketPrefix": "string"
},
"writeOperationType": "string"
},
"Snowflake": {
"bucketPrefix": "string",
"errorHandlingConfig": {
"bucketName": "string",
"bucketPrefix": "string",
"failOnFirstDestinationError": boolean
},
"intermediateBucketName": "string",
"object": "string"
},
"Upsolver": {
"bucketName": "string",
"bucketPrefix": "string",
"s3OutputFormatConfig": {
"aggregationConfig": {
"aggregationType": "string",
"targetFileSize": number
},
"fileType": "string",
"prefixConfig": {
"pathPrefixHierarchy": [ "string" ],
"prefixFormat": "string",
"prefixType": "string"
}
}
},
"Zendesk": {
"errorHandlingConfig": {
"bucketName": "string",
"bucketPrefix": "string",
"failOnFirstDestinationError": boolean
},
"idFieldNames": [ "string" ],
"object": "string",
"writeOperationType": "string"
}
}
}
],
"flowName": "string",
"metadataCatalogConfig": {
"glueDataCatalog": {
"databaseName": "string",
"roleArn": "string",
"tablePrefix": "string"
}
},
"sourceFlowConfig": {
"apiVersion": "string",
"connectorProfileName": "string",
"connectorType": "string",
"incrementalPullConfig": {
"datetimeTypeFieldName": "string"
},
"sourceConnectorProperties": {
"Amplitude": {
"object": "string"
},
"CustomConnector": {
"customProperties": {
"string" : "string"
},
"dataTransferApi": {
"Name": "string",
"Type": "string"
},
"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": "string"
}
},
"Salesforce": {
"dataTransferApi": "string",
"enableDynamicFieldUpdate": boolean,
"includeDeletedRecords": boolean,
"object": "string"
},
"SAPOData": {
"objectPath": "string",
"paginationConfig": {
"maxPageSize": number
},
"parallelismConfig": {
"maxParallelism": number
}
},
"ServiceNow": {
"object": "string"
},
"Singular": {
"object": "string"
},
"Slack": {
"object": "string"
},
"Trendmicro": {
"object": "string"
},
"Veeva": {
"documentType": "string",
"includeAllVersions": boolean,
"includeRenditions": boolean,
"includeSourceFiles": boolean,
"object": "string"
},
"Zendesk": {
"object": "string"
}
}
},
"tasks": [
{
"connectorOperator": {
"Amplitude": "string",
"CustomConnector": "string",
"Datadog": "string",
"Dynatrace": "string",
"GoogleAnalytics": "string",
"InforNexus": "string",
"Marketo": "string",
"Pardot": "string",
"S3": "string",
"Salesforce": "string",
"SAPOData": "string",
"ServiceNow": "string",
"Singular": "string",
"Slack": "string",
"Trendmicro": "string",
"Veeva": "string",
"Zendesk": "string"
},
"destinationField": "string",
"sourceFields": [ "string" ],
"taskProperties": {
"string" : "string"
},
"taskType": "string"
}
],
"triggerConfig": {
"triggerProperties": {
"Scheduled": {
"dataPullMode": "string",
"firstExecutionFrom": number,
"flowErrorDeactivationThreshold": number,
"scheduleEndTime": number,
"scheduleExpression": "string",
"scheduleOffset": number,
"scheduleStartTime": number,
"timezone": "string"
}
},
"triggerType": "string"
}
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [clientToken](#API_UpdateFlow_RequestSyntax) **
The `clientToken` parameter is an idempotency token. It ensures that your `UpdateFlow` request completes only once. You choose the value to pass. For example, if you don't receive a response from your request, you can safely retry the request with the same `clientToken` parameter value.
If you omit a `clientToken` value, the AWS SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases.
If you specify input parameters that differ from your first request, an error occurs. If you use a different value for `clientToken`, Amazon AppFlow considers it a new call to `UpdateFlow`. The token is active for 8 hours.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `[ -~]+`
Required: No
** [description](#API_UpdateFlow_RequestSyntax) **
A description of the flow.
Type: String
Length Constraints: Maximum length of 2048.
Pattern: `[\w!@#\-.?,\s]*`
Required: No
** [destinationFlowConfigList](#API_UpdateFlow_RequestSyntax) **
The configuration that controls how Amazon AppFlow transfers data to the destination connector.
Type: Array of [DestinationFlowConfig](API_DestinationFlowConfig.md) objects
Required: Yes
** [flowName](#API_UpdateFlow_RequestSyntax) **
The specified name of the flow. Spaces are not allowed. Use underscores (\$1) or hyphens (-) only.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `[a-zA-Z0-9][\w!@#.-]+`
Required: Yes
** [metadataCatalogConfig](#API_UpdateFlow_RequestSyntax) **
Specifies the configuration that Amazon AppFlow uses when it catalogs the data that's transferred by the associated flow. When Amazon AppFlow catalogs the data from a flow, it stores metadata in a data catalog.
Type: [MetadataCatalogConfig](API_MetadataCatalogConfig.md) object
Required: No
** [sourceFlowConfig](#API_UpdateFlow_RequestSyntax) **
Contains information about the configuration of the source connector used in the flow.
Type: [SourceFlowConfig](API_SourceFlowConfig.md) object
Required: Yes
** [tasks](#API_UpdateFlow_RequestSyntax) **
A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
Type: Array of [Task](API_Task.md) objects
Required: Yes
** [triggerConfig](#API_UpdateFlow_RequestSyntax) **
The trigger settings that determine how and when the flow runs.
Type: [TriggerConfig](API_TriggerConfig.md) object
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"flowStatus": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [flowStatus](#API_UpdateFlow_ResponseSyntax) **
Indicates the current status of the flow.
Type: String
Valid Values: `Active | Deprecated | Deleted | Draft | Errored | Suspended`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
AppFlow/Requester has invalid or missing permissions.
HTTP Status Code: 403
** 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.
HTTP Status Code: 409
** ConnectorAuthenticationException **
An error occurred when authenticating with the connector endpoint.
HTTP Status Code: 401
** ConnectorServerException **
An error occurred when retrieving data from the connector endpoint.
HTTP Status Code: 400
** InternalServerException **
An internal service error occurred during the processing of your request. Try again later.
HTTP Status Code: 500
** ResourceNotFoundException **
The resource specified in the request (such as the source or destination connector profile) is not found.
HTTP Status Code: 404
** ServiceQuotaExceededException **
The request would cause a service quota (such as the number of flows) to be exceeded.
HTTP Status Code: 402
** ValidationException **
The request has invalid or missing parameters.
HTTP Status Code: 400
## Examples
### Salesforce
This example shows a sample request for the `UpdateFlow` API using Salesforce.
#### Sample Request
```
{
"flowName": "testFlow-newpayload",
"description": "TestFlow",
"triggerConfig": {
"triggerType": "OnDemand"
},
"sourceFlowConfig": {
"connectorType": "Salesforce",
"connectorProfileName": "Connector_Profile_Name",
"sourceConnectorProperties": {
"salesforce": {
"object": "account"
}
}
},
"destinationFlowConfigList": [
{
"connectorType": "S3",
"connectorProfileName": "Test",
"destinationConnectorProperties": {
"s3": {
"bucketName": "Bucket_Name_value",
"bucketKey": "Bucket_Name_value"
}
}
}
],
"tasks": [
{
"sourceFields": ["CreatedDate"],
"taskProperties": {},
"destinationField": "CreatedDate",
"taskType": "Map"
},
{
"destinationField": "LastActivityDate",
"sourceFields": ["LastActivityDate"],
"taskProperties": {},
"taskType": "Map"
}
]
}
```
### Zendesk
This example shows a sample request for the `UpdateFlow` API using Zendesk.
#### Sample Request
```
{
"useDefaultEncryption": false,
"flowName": "testFlowZendesk",
"description": "TestFlow",
"triggerConfig": {
"triggerType": "OnDemand"
},
"sourceFlowConfig": {
"connectorType": "Zendesk",
"connectorProfileName": "connector-profile-name",
"sourceConnectorProperties": {
"zendesk": {
"object": "tickets"
}
}
},
"destinationFlowConfigList": [
{
"connectorType": "S3",
"connectorProfileName": "Test",
"destinationConnectorProperties": {
"s3": {
"bucketName": "Bucket_Name_Value",
"bucketKey": "Bucket_Name_Value"
}
}
}
],
"tasks": [
{
"destinationField": "url",
"sourceFields": ["url"],
"taskProperties": {
"SOURCE_DATA_TYPE": "integer"
},
"taskType": "Map"
}
]
}
```
### Google Analytics
This example shows a sample request for the `UpdateFlow` API using Google Analytics.
#### Sample Request
```
{
"useDefaultEncryption": false,
"flowName": "testFlowGAnalytics",
"description": "TestFlow",
"triggerConfig": {
"triggerType": "OnDemand"
},
"sourceFlowConfig": {
"connectorType": "Googleanalytics",
"connectorProfileName": "connector-profile-name",
"sourceConnectorProperties": {
"googleanalytics": {
"object": "Object_ID"
}
}
},
"destinationFlowConfigList": [
{
"connectorType": "S3",
"connectorProfileName": "Test",
"destinationConnectorProperties": {
"s3": {
"bucketName": "Bucket_Name_Value",
"bucketKey": "Bucket_Name_Value"
}
}
}
],
"tasks": [
{
"destinationField": "url",
"sourceFields": ["url"],
"taskProperties": {
"SOURCE_DATA_TYPE": "integer"
},
"taskType": "Map"
}
]
}
```
### Marketo
This example shows a sample request for the `UpdateFlow` API using Marketo.
#### Sample Request
```
{
"flowName": "testMarketo",
"description": "TestFlow",
"triggerConfig": {
"triggerType": "OnDemand"
},
"sourceFlowConfig": {
"connectorType": "Marketo",
"connectorProfileName": "Connector-profile-new",
"sourceConnectorProperties": {
"marketo": {
"object": "leads"
}
}
},
"destinationFlowConfigList": [
{
"connectorType": "S3",
"connectorProfileName": "Test",
"destinationConnectorProperties": {
"s3": {
"bucketName": "Bucket_Name_Value",
"bucketKey": "Bucket_Name_Value"
}
}
}
],
"tasks": [
{
"connectorOperator": {
"marketo":"BETWEEN"
},
"sourceFields": [
"updatedAt"
],
"taskProperties": {
"DATA_TYPE": "datetime",
"LOWER_BOUND": "Lower_Bound_value",
"UPPER_BOUND": "Upper_Bound_value"
},
"taskType": "Filter"
},
{
"destinationField": "company",
"sourceFields": [
"company"
],
"taskProperties": {
"SOURCE_DATA_TYPE": "string"
},
"taskType": "Map"
}
]
}
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appflow-2020-08-23/UpdateFlow)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appflow-2020-08-23/UpdateFlow)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appflow-2020-08-23/UpdateFlow)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appflow-2020-08-23/UpdateFlow)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appflow-2020-08-23/UpdateFlow)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appflow-2020-08-23/UpdateFlow)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appflow-2020-08-23/UpdateFlow)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appflow-2020-08-23/UpdateFlow)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appflow-2020-08-23/UpdateFlow)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appflow-2020-08-23/UpdateFlow)