Amazon Connect Connect Workflows API

The Connect Workflows API from Amazon Connect — 3 operation(s) for connect workflows.

GitHub OpenAPI

Operations 4

POST /domains/{DomainName}/workflows/integrations Create Integration Workflow #
DELETE /domains/{DomainName}/workflows/{WorkflowId} Delete Workflow #
GET /domains/{DomainName}/workflows/{WorkflowId} Get Workflow #
POST /domains/{DomainName}/workflows List Workflows #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-connect:amazon-connect-workflows-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amazon-connect-workflows-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon Connect Service Workflows API
  version: '2017-08-08'
  description: Generated from AWS's published Smithy model for Amazon Connect Service. 4 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://profile.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /domains/{DomainName}/workflows/integrations:
    post:
      operationId: CreateIntegrationWorkflow
      summary: Create Integration Workflow
      description: 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.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateIntegrationWorkflowResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateIntegrationWorkflowRequest'
      tags:
      - Workflows
  /domains/{DomainName}/workflows/{WorkflowId}:
    delete:
      operationId: DeleteWorkflow
      summary: Delete Workflow
      description: Deletes the specified workflow and all its corresponding resources. This is an async process.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteWorkflowResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteWorkflowRequest'
      tags:
      - Workflows
    get:
      operationId: GetWorkflow
      summary: Get Workflow
      description: Get details of specified workflow.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetWorkflowResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetWorkflowRequest'
      tags:
      - Workflows
  /domains/{DomainName}/workflows:
    post:
      operationId: ListWorkflows
      summary: List Workflows
      description: Query to list all workflows.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListWorkflowsResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListWorkflowsRequest'
      tags:
      - Workflows
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: profile
  schemas:
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
    AppflowIntegration:
      type: object
      properties:
        FlowDefinition:
          $ref: '#/components/schemas/FlowDefinition'
        Batches:
          type: array
          items:
            $ref: '#/components/schemas/Batch'
          description: Batches in workflow of type APPFLOW_INTEGRATION.
      required:
      - FlowDefinition
    AppflowIntegrationWorkflowAttributes:
      type: object
      properties:
        SourceConnectorType:
          type: string
          enum:
          - Salesforce
          - Marketo
          - Zendesk
          - Servicenow
          - S3
          description: Specifies the source connector type, such as Salesforce, ServiceNow, and Marketo. Indicates source
            of ingestion.
        ConnectorProfileName:
          type: string
          description: The name of the AppFlow connector profile used for ingestion.
        RoleArn:
          type: string
          description: 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.
      required:
      - SourceConnectorType
      - ConnectorProfileName
    AppflowIntegrationWorkflowMetrics:
      type: object
      properties:
        RecordsProcessed:
          type: integer
          description: Number of records processed in APPFLOW_INTEGRATION workflow.
        StepsCompleted:
          type: integer
          description: Total steps completed in APPFLOW_INTEGRATION workflow.
        TotalSteps:
          type: integer
          description: Total steps in APPFLOW_INTEGRATION workflow.
      required:
      - RecordsProcessed
      - StepsCompleted
      - TotalSteps
    BadRequestException:
      type: object
      properties:
        Message:
          type: string
    Batch:
      type: object
      properties:
        StartTime:
          type: string
          format: date-time
          description: Start time of batch to split ingestion.
        EndTime:
          type: string
          format: date-time
          description: End time of batch to split ingestion.
      required:
      - StartTime
      - EndTime
    ConnectorOperator:
      type: object
      properties:
        Marketo:
          type: string
          enum:
          - PROJECTION
          - LESS_THAN
          - GREATER_THAN
          - BETWEEN
          - ADDITION
          - MULTIPLICATION
          - DIVISION
          - SUBTRACTION
          - MASK_ALL
          - MASK_FIRST_N
          - MASK_LAST_N
          - VALIDATE_NON_NULL
          - VALIDATE_NON_ZERO
          - VALIDATE_NON_NEGATIVE
          - VALIDATE_NUMERIC
          - NO_OP
          description: The operation to be performed on the provided Marketo source fields.
        S3:
          type: string
          enum:
          - PROJECTION
          - LESS_THAN
          - GREATER_THAN
          - BETWEEN
          - LESS_THAN_OR_EQUAL_TO
          - GREATER_THAN_OR_EQUAL_TO
          - EQUAL_TO
          - NOT_EQUAL_TO
          - ADDITION
          - MULTIPLICATION
          - DIVISION
          - SUBTRACTION
          - MASK_ALL
          - MASK_FIRST_N
          - MASK_LAST_N
          - VALIDATE_NON_NULL
          - VALIDATE_NON_ZERO
          - VALIDATE_NON_NEGATIVE
          - VALIDATE_NUMERIC
          - NO_OP
          description: The operation to be performed on the provided Amazon S3 source fields.
        Salesforce:
          type: string
          enum:
          - PROJECTION
          - LESS_THAN
          - CONTAINS
          - GREATER_THAN
          - BETWEEN
          - LESS_THAN_OR_EQUAL_TO
          - GREATER_THAN_OR_EQUAL_TO
          - EQUAL_TO
          - NOT_EQUAL_TO
          - ADDITION
          - MULTIPLICATION
          - DIVISION
          - SUBTRACTION
          - MASK_ALL
          - MASK_FIRST_N
          - MASK_LAST_N
          - VALIDATE_NON_NULL
          - VALIDATE_NON_ZERO
          - VALIDATE_NON_NEGATIVE
          - VALIDATE_NUMERIC
          - NO_OP
          description: The operation to be performed on the provided Salesforce source fields.
        ServiceNow:
          type: string
          enum:
          - PROJECTION
          - CONTAINS
          - LESS_THAN
          - GREATER_THAN
          - BETWEEN
          - LESS_THAN_OR_EQUAL_TO
          - GREATER_THAN_OR_EQUAL_TO
          - EQUAL_TO
          - NOT_EQUAL_TO
          - ADDITION
          - MULTIPLICATION
          - DIVISION
          - SUBTRACTION
          - MASK_ALL
          - MASK_FIRST_N
          - MASK_LAST_N
          - VALIDATE_NON_NULL
          - VALIDATE_NON_ZERO
          - VALIDATE_NON_NEGATIVE
          - VALIDATE_NUMERIC
          - NO_OP
          description: The operation to be performed on the provided ServiceNow source fields.
        Zendesk:
          type: string
          enum:
          - PROJECTION
          - GREATER_THAN
          - ADDITION
          - MULTIPLICATION
          - DIVISION
          - SUBTRACTION
          - MASK_ALL
          - MASK_FIRST_N
          - MASK_LAST_N
          - VALIDATE_NON_NULL
          - VALIDATE_NON_ZERO
          - VALIDATE_NON_NEGATIVE
          - VALIDATE_NUMERIC
          - NO_OP
          description: The operation to be performed on the provided Zendesk source fields.
    CreateIntegrationWorkflowRequest:
      type: object
      properties:
        DomainName:
          type: string
          description: The unique name of the domain.
        WorkflowType:
          type: string
          enum:
          - APPFLOW_INTEGRATION
          description: The type of workflow. The only supported value is APPFLOW_INTEGRATION.
        IntegrationConfig:
          $ref: '#/components/schemas/ProfileIntegrationConfig'
        ObjectTypeName:
          type: string
          description: The name of the profile object type.
        RoleArn:
          type: string
          description: 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.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: The tags used to organize, track, or control access for this resource.
      required:
      - DomainName
      - WorkflowType
      - IntegrationConfig
      - ObjectTypeName
      - RoleArn
    CreateIntegrationWorkflowResponse:
      type: object
      properties:
        WorkflowId:
          type: string
          description: Unique identifier for the workflow.
        Message:
          type: string
          description: A message indicating create request was received.
      required:
      - WorkflowId
      - Message
    DeleteWorkflowRequest:
      type: object
      properties:
        DomainName:
          type: string
          description: The unique name of the domain.
        WorkflowId:
          type: string
          description: Unique identifier for the workflow.
      required:
      - DomainName
      - WorkflowId
    DeleteWorkflowResponse:
      type: object
      properties: {}
    FlowDefinition:
      type: object
      properties:
        Description:
          type: string
          description: A description of the flow you want to create.
        FlowName:
          type: string
          description: The specified name of the flow. Use underscores (_) or hyphens (-) only. Spaces are not allowed.
        KmsArn:
          type: string
          description: The Amazon Resource Name of the AWS Key Management Service (KMS) key you provide for encryption.
        SourceFlowConfig:
          $ref: '#/components/schemas/SourceFlowConfig'
        Tasks:
          type: array
          items:
            $ref: '#/components/schemas/Task'
          description: A list of tasks that Customer Profiles performs while transferring the data in the flow run.
        TriggerConfig:
          $ref: '#/components/schemas/TriggerConfig'
      required:
      - FlowName
      - KmsArn
      - SourceFlowConfig
      - Tasks
      - TriggerConfig
    GetWorkflowRequest:
      type: object
      properties:
        DomainName:
          type: string
          description: The unique name of the domain.
        WorkflowId:
          type: string
          description: Unique identifier for the workflow.
      required:
      - DomainName
      - WorkflowId
    GetWorkflowResponse:
      type: object
      properties:
        WorkflowId:
          type: string
          description: Unique identifier for the workflow.
        WorkflowType:
          type: string
          enum:
          - APPFLOW_INTEGRATION
          description: The type of workflow. The only supported value is APPFLOW_INTEGRATION.
        Status:
          type: string
          enum:
          - NOT_STARTED
          - IN_PROGRESS
          - COMPLETE
          - FAILED
          - SPLIT
          - RETRY
          - CANCELLED
          description: Status of workflow execution.
        ErrorDescription:
          type: string
          description: Workflow error messages during execution (if any).
        StartDate:
          type: string
          format: date-time
          description: The timestamp that represents when workflow execution started.
        LastUpdatedAt:
          type: string
          format: date-time
          description: The timestamp that represents when workflow execution last updated.
        Attributes:
          $ref: '#/components/schemas/WorkflowAttributes'
        Metrics:
          $ref: '#/components/schemas/WorkflowMetrics'
    IncrementalPullConfig:
      type: object
      properties:
        DatetimeTypeFieldName:
          type: string
          description: A field that specifies the date time or timestamp field as the criteria to use when importing incremental
            records from the source.
    ListWorkflowsItem:
      type: object
      properties:
        WorkflowType:
          type: string
          enum:
          - APPFLOW_INTEGRATION
          description: The type of workflow. The only supported value is APPFLOW_INTEGRATION.
        WorkflowId:
          type: string
          description: Unique identifier for the workflow.
        Status:
          type: string
          enum:
          - NOT_STARTED
          - IN_PROGRESS
          - COMPLETE
          - FAILED
          - SPLIT
          - RETRY
          - CANCELLED
          description: Status of workflow execution.
        StatusDescription:
          type: string
          description: Description for workflow execution status.
        CreatedAt:
          type: string
          format: date-time
          description: Creation timestamp for workflow.
        LastUpdatedAt:
          type: string
          format: date-time
          description: Last updated timestamp for workflow.
      required:
      - WorkflowType
      - WorkflowId
      - Status
      - StatusDescription
      - CreatedAt
      - LastUpdatedAt
    ListWorkflowsRequest:
      type: object
      properties:
        DomainName:
          type: string
          description: The unique name of the domain.
        WorkflowType:
          type: string
          enum:
          - APPFLOW_INTEGRATION
          description: The type of workflow. The only supported value is APPFLOW_INTEGRATION.
        Status:
          type: string
          enum:
          - NOT_STARTED
          - IN_PROGRESS
          - COMPLETE
          - FAILED
          - SPLIT
          - RETRY
          - CANCELLED
          description: Status of workflow execution.
        QueryStartDate:
          type: string
          format: date-time
          description: Retrieve workflows started after timestamp.
        QueryEndDate:
          type: string
          format: date-time
          description: Retrieve workflows ended after timestamp.
        NextToken:
          type: string
          description: The token for the next set of results. Use the value returned in the previous response in the next
            request to retrieve the next set of results.
        MaxResults:
          type: integer
          description: The maximum number of results to return per page.
      required:
      - DomainName
    ListWorkflowsResponse:
      type: object
      properties:
        Items:
          type: array
          items:
            $ref: '#/components/schemas/ListWorkflowsItem'
          description: List containing workflow details.
        NextToken:
          type: string
          description: If there are additional results, this is the token for the next set of results.
    MarketoSourceProperties:
      type: object
      properties:
        Object:
          type: string
          description: The object specified in the Marketo flow source.
      required:
      - Object
    ProfileIntegrationConfig:
      type: object
      properties:
        AppflowIntegration:
          $ref: '#/components/schemas/AppflowIntegration'
    ProfileInternalServerException:
      type: object
      properties:
        Message:
          type: string
    ProfileResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
    S3SourceProperties:
      type: object
      properties:
        BucketName:
          type: string
          description: The Amazon S3 bucket name where the source files are stored.
        BucketPrefix:
          type: string
          description: The object key for the Amazon S3 bucket in which the source files are stored.
      required:
      - BucketName
    SalesforceSourceProperties:
      type: object
      properties:
        Object:
          type: string
          description: The object specified in the Salesforce flow source.
        EnableDynamicFieldUpdate:
          type: boolean
          description: The flag that enables dynamic fetching of new (recently added) fields in the Salesforce objects while
            running a flow.
        IncludeDeletedRecords:
          type: boolean
          description: Indicates whether Amazon AppFlow includes deleted files in the flow run.
      required:
      - Object
    ScheduledTriggerProperties:
      type: object
      properties:
        ScheduleExpression:
          type: string
          description: The scheduling expression that determines the rate at which the schedule will run, for example rate
            (5 minutes).
        DataPullMode:
          type: string
          enum:
          - Incremental
          - Complete
          description: Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for
            each flow run.
        ScheduleStartTime:
          type: string
          format: date-time
          description: Specifies the scheduled start time for a scheduled-trigger flow.
        ScheduleEndTime:
          type: string
          format: date-time
          description: Specifies the scheduled end time for a scheduled-trigger flow.
        Timezone:
          type: string
          description: Specifies the time zone used when referring to the date and time of a scheduled-triggered flow, such
            as America/New_York.
        ScheduleOffset:
          type: integer
          description: Specifies the optional offset that is added to the time interval for a schedule-triggered flow.
        FirstExecutionFrom:
          type: string
          format: date-time
          description: Specifies the date range for the records to import from the connector in the first flow run.
      required:
      - ScheduleExpression
    ServiceNowSourceProperties:
      type: object
      properties:
        Object:
          type: string
          description: The object specified in the ServiceNow flow source.
      required:
      - Object
    SourceConnectorProperties:
      type: object
      properties:
        Marketo:
          $ref: '#/components/schemas/MarketoSourceProperties'
        S3:
          $ref: '#/components/schemas/S3SourceProperties'
        Salesforce:
          $ref: '#/components/schemas/SalesforceSourceProperties'
        ServiceNow:
          $ref: '#/components/schemas/ServiceNowSourceProperties'
        Zendesk:
          $ref: '#/components/schemas/ZendeskSourceProperties'
    SourceFlowConfig:
      type: object
      properties:
        ConnectorProfileName:
          type: string
          description: The name of the AppFlow connector profile. This name must be unique for each connector profile in the
            AWS account.
        ConnectorType:
          type: string
          enum:
          - Salesforce
          - Marketo
          - Zendesk
          - Servicenow
          - S3
          description: The type of connector, such as Salesforce, Marketo, and so on.
        IncrementalPullConfig:
          $ref: '#/components/schemas/IncrementalPullConfig'
        SourceConnectorProperties:
          $ref: '#/components/schemas/SourceConnectorProperties'
      required:
      - ConnectorType
      - SourceConnectorProperties
    Task:
      type: object
      properties:
        ConnectorOperator:
          $ref: '#/components/schemas/ConnectorOperator'
        DestinationField:
          type: string
          description: A field in a destination connector, or a field value against which Amazon AppFlow validates a source
            field.
        SourceFields:
          type: array
          items:
            type: string
          description: The source fields to which a particular task is applied.
        TaskProperties:
          type: object
          additionalProperties:
            type: string
          description: A map used to store task-related information. The service looks for particular information based on
            the TaskType.
        TaskType:
          type: string
          enum:
          - Arithmetic
          - Filter
          - Map
          - Mask
          - Merge
          - Truncate
          - Validate
          description: Specifies the particular task implementation that Amazon AppFlow performs.
      required:
      - SourceFields
      - TaskType
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
    TriggerConfig:
      type: object
      properties:
        TriggerType:
          type: string
          enum:
          - Scheduled
          - Event
          - OnDemand
          description: Specifies the type of flow trigger. It can be OnDemand, Scheduled, or Event.
        TriggerProperties:
          $ref: '#/components/schemas/TriggerProperties'
      required:
      - TriggerType
    TriggerProperties:
      type: object
      properties:
        Scheduled:
          $ref: '#/components/schemas/ScheduledTriggerProperties'
    WorkflowAttributes:
      type: object
      properties:
        AppflowIntegration:
          $ref: '#/components/schemas/AppflowIntegrationWorkflowAttributes'
    WorkflowMetrics:
      type: object
      properties:
        AppflowIntegration:
          $ref: '#/components/schemas/AppflowIntegrationWorkflowMetrics'
    ZendeskSourceProperties:
      type: object
      properties:
        Object:
          type: string
          description: The object specified in the Zendesk flow source.
      required:
      - Object
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/customer-profiles/service/2020-08-15/customer-profiles-2020-08-15.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)