Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateIntegrationWorkflow

Creates an integration workflow. An integration workflow is an async process which ingests historic data and sets up an integration for ongoing updates. The supported Amazon AppFlow sources are Salesforce, ServiceNow, and Marketo.

Request Syntax


POST /domains/DomainName/workflows/integrations HTTP/1.1
Content-type: application/json

{
   "IntegrationConfig": { 
      "AppflowIntegration": { 
         "Batches": [ 
            { 
               "EndTime": number,
               "StartTime": number
            }
         ],
         "FlowDefinition": { 
            "Description": "string",
            "FlowName": "string",
            "KmsArn": "string",
            "SourceFlowConfig": { 
               "ConnectorProfileName": "string",
               "ConnectorType": "string",
               "IncrementalPullConfig": { 
                  "DatetimeTypeFieldName": "string"
               },
               "SourceConnectorProperties": { 
                  "Marketo": { 
                     "Object": "string"
                  },
                  "S3": { 
                     "BucketName": "string",
                     "BucketPrefix": "string"
                  },
                  "Salesforce": { 
                     "EnableDynamicFieldUpdate": boolean,
                     "IncludeDeletedRecords": boolean,
                     "Object": "string"
                  },
                  "ServiceNow": { 
                     "Object": "string"
                  },
                  "Zendesk": { 
                     "Object": "string"
                  }
               }
            },
            "Tasks": [ 
               { 
                  "ConnectorOperator": { 
                     "Marketo": "string",
                     "S3": "string",
                     "Salesforce": "string",
                     "ServiceNow": "string",
                     "Zendesk": "string"
                  },
                  "DestinationField": "string",
                  "SourceFields": [ "string" ],
                  "TaskProperties": { 
                     "string" : "string" 
                  },
                  "TaskType": "string"
               }
            ],
            "TriggerConfig": { 
               "TriggerProperties": { 
                  "Scheduled": { 
                     "DataPullMode": "string",
                     "FirstExecutionFrom": number,
                     "ScheduleEndTime": number,
                     "ScheduleExpression": "string",
                     "ScheduleOffset": number,
                     "ScheduleStartTime": number,
                     "Timezone": "string"
                  }
               },
               "TriggerType": "string"
            }
         }
      }
   },
   "ObjectTypeName": "string",
   "RoleArn": "string",
   "Tags": { 
      "string" : "string" 
   },
   "WorkflowType": "string"
}

URI Request Parameters

The request uses the following URI parameters.

DomainName

The unique name of the domain.

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[a-zA-Z0-9_-]+$

Required: Yes

Request Body

The request accepts the following data in JSON format.

IntegrationConfig

Configuration data for integration workflow.

Type: IntegrationConfig object

Required: Yes

ObjectTypeName

The name of the profile object type.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^[a-zA-Z_][a-zA-Z_0-9-]*$

Required: Yes

RoleArn

The Amazon Resource Name (ARN) of the IAM role. Customer Profiles assumes this role to create resources on your behalf as part of workflow execution.

Type: String

Length Constraints: Maximum length of 512.

Pattern: arn:aws:iam:.*:[0-9]+:.*

Required: Yes

Tags

The tags used to organize, track, or control access for this resource.

Type: String to string map

Map Entries: 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.

Required: No

WorkflowType

The type of workflow. The only supported value is APPFLOW_INTEGRATION.

Type: String

Valid Values: APPFLOW_INTEGRATION

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Message": "string",
   "WorkflowId": "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.

Message

A message indicating create request was received.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

WorkflowId

Unique identifier for the workflow.

Type: String

Pattern: [a-f0-9]{32}

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

BadRequestException

The input you provided is invalid.

HTTP Status Code: 400

InternalServerException

An internal service error occurred.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource does not exist, or access was denied.

HTTP Status Code: 404

ThrottlingException

You exceeded the maximum number of requests.

HTTP Status Code: 429