This example shows a sample request and response for the DescribeFlow API.
Sample Request
{ "flowName": <name of the flow in double quotes>
}
Sample Response
{
"createdAt": created_at_value, "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": last_updated_at_value, "lastUpdatedBy": "user",
Examples
"sourceFlowConfig": {
"connectorProfileName": "connectorProfileName", "connectorType": "Salesforce",
"sourceConnectorProps": { "Amplitude": null,
"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"
}
See Also
],
"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
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DescribeFlowExecutionRecords
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 (p. 96)
The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
Type: String
Length Constraints: Maximum length of 256.
Pattern: [a-zA-Z0-9][\w!@#.-]+
Required: Yes maxResults (p. 96)
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 (p. 96)
The pagination token for the next page of data.
Type: String
Length Constraints: Maximum length of 2048.
Pattern: \S+
Required: No
Response Syntax
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 },
"recordsProcessed": number },
"executionStatus": "string", "lastUpdatedAt": number, "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 (p. 97)
Returns a list of all instances when this flow was run.
Type: Array of ExecutionRecord (p. 226) objects nextToken (p. 97)
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 Errors (p. 347).
InternalServerException
An internal service error occurred during the processing of your request. Try again later.
HTTP Status Code: 500
Examples
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":"test-new-create", // flow created using CreateFlow API "maxResults":1 // Any number between 1 and 100.
}
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": execution_start_time_value, "executionStatus": "Error",
"lastUpdatedAt": lastupdated_at_value, "lastUpdatedTime": lastupdated_time_value, "startedAt": started_at_value
}
Examples
],
"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":"test-new-create", "maxResults":1,
"nextToken": "next_token_value"
}
Sample Response
{
"flowExecutionList": [ {
See Also
"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
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
ListConnectorEntities
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"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
apiVersion (p. 101)
The version of the API that's used by the connector.
Type: String
Length Constraints: Maximum length of 256.
Pattern: \S+
Required: No
connectorProfileName (p. 101)
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 (p. 101)
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 |
Response Syntax
Dynatrace | Infornexus | Amplitude | Veeva | EventBridge | LookoutMetrics | Upsolver | Honeycode | CustomerProfiles | SAPOData | CustomConnector
Required: No entitiesPath (p. 101)
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
Response Syntax
HTTP/1.1 200
Content-type: application/json {
"connectorEntityMap": { "string" : [
{
"hasNestedEntities": boolean, "label": "string",
"name": "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 (p. 102)
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 (p. 174) objects map Key Length Constraints: Maximum length of 128.
Key Pattern: \S+
Errors
For information about the errors that are common to all actions, see Common Errors (p. 347).
Examples
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