Amazon Connect

Amazon Connect Connect Contact Flow Modules API

The Connect Contact Flow Modules API from Amazon Connect — 2 operation(s) for connect contact flow modules.

Documentation GitHub OpenAPI

Operations 3

PUT /contact-flow-modules/{InstanceId} Create Contact Flow Module #

DELETE /contact-flow-modules/{InstanceId}/{ContactFlowModuleId} Delete Contact Flow Module #

GET /contact-flow-modules/{InstanceId}/{ContactFlowModuleId} Describe Contact Flow Module #

Specifications

⚙

OpenAPI

https://artifacts.apis.io/amazon-connect/openapi/amazon-connect-contact-flow-modules-api-openapi.yml

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-contact-flow-modules-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.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.1.0
info:
  title: Amazon Connect Service Contact Flow Modules API
  version: '2017-08-08'
  description: Generated from AWS's published Smithy model for Amazon Connect Service. 3 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://connect.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /contact-flow-modules/{InstanceId}:
    put:
      operationId: CreateContactFlowModule
      summary: Create Contact Flow Module
      description: Creates a flow module for the specified Connect Customer instance.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateContactFlowModuleResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: DuplicateResourceException; IdempotencyException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DuplicateResourceException'
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '400':
          description: InvalidContactFlowModuleException; InvalidParameterException; InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidContactFlowModuleException'
        '429':
          description: LimitExceededException; ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateContactFlowModuleRequest'
      tags:
      - Contact Flow Modules
  /contact-flow-modules/{InstanceId}/{ContactFlowModuleId}:
    delete:
      operationId: DeleteContactFlowModule
      summary: Delete Contact Flow Module
      description: Deletes the specified flow module.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteContactFlowModuleResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '400':
          description: InvalidParameterException; InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteContactFlowModuleRequest'
      tags:
      - Contact Flow Modules
    get:
      operationId: DescribeContactFlowModule
      summary: Describe Contact Flow Module
      description: Describes the specified flow module. Use the $SAVED alias in the request to describe the SAVED content
        of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. After a flow is published, $SAVED needs to be supplied
        to view saved content that has not been published.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeContactFlowModuleResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '400':
          description: InvalidParameterException; InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeContactFlowModuleRequest'
      tags:
      - Contact Flow Modules
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: connect
  schemas:
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
    ContactFlowModule:
      type: object
      properties:
        Arn:
          type: string
          description: The Amazon Resource Name (ARN).
        Id:
          type: string
          description: The identifier of the flow module.
        Name:
          type: string
          description: The name of the flow module.
        Content:
          type: string
          description: The JSON string that represents the content of the flow. For an example, see Example flow in Connect
            Customer Flow language.
        Description:
          type: string
          description: The description of the flow module.
        State:
          type: string
          enum:
          - ACTIVE
          - ARCHIVED
          description: The type of flow module.
        Status:
          type: string
          enum:
          - PUBLISHED
          - SAVED
          description: The status of the flow module.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1",
            "key2":"value2"} }.'
        FlowModuleContentSha256:
          type: string
          description: Hash of the module content for integrity verification.
        Version:
          type: integer
          description: The version of the flow module.
        VersionDescription:
          type: string
          description: Description of the version.
        Settings:
          type: string
          description: The configuration settings for the flow module.
        ExternalInvocationConfiguration:
          $ref: '#/components/schemas/ExternalInvocationConfiguration'
    CreateContactFlowModuleRequest:
      type: object
      properties:
        InstanceId:
          type: string
          description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource
            Name (ARN) of the instance.
        Name:
          type: string
          description: The name of the flow module.
        Description:
          type: string
          description: The description of the flow module.
        Content:
          type: string
          description: The JSON string that represents the content of the flow. For an example, see Example flow in Connect
            Customer Flow language.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1",
            "key2":"value2"} }.'
        ClientToken:
          type: string
          description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not
            provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making
            retries safe with idempotent APIs.
        Settings:
          type: string
          description: The configuration settings for the flow module.
        ExternalInvocationConfiguration:
          $ref: '#/components/schemas/ExternalInvocationConfiguration'
      required:
      - InstanceId
      - Name
      - Content
    CreateContactFlowModuleResponse:
      type: object
      properties:
        Id:
          type: string
          description: The identifier of the flow module.
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the flow module.
    DeleteContactFlowModuleRequest:
      type: object
      properties:
        InstanceId:
          type: string
          description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource
            Name (ARN) of the instance.
        ContactFlowModuleId:
          type: string
          description: The identifier of the flow module.
      required:
      - InstanceId
      - ContactFlowModuleId
    DeleteContactFlowModuleResponse:
      type: object
      properties: {}
    DescribeContactFlowModuleRequest:
      type: object
      properties:
        InstanceId:
          type: string
          description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource
            Name (ARN) of the instance.
        ContactFlowModuleId:
          type: string
          description: The identifier of the flow module.
      required:
      - InstanceId
      - ContactFlowModuleId
    DescribeContactFlowModuleResponse:
      type: object
      properties:
        ContactFlowModule:
          $ref: '#/components/schemas/ContactFlowModule'
    DuplicateResourceException:
      type: object
      properties:
        Message:
          type: string
    ExternalInvocationConfiguration:
      type: object
      properties:
        Enabled:
          type: boolean
          description: Enable external invocation.
    InternalServiceException:
      type: object
      properties:
        Message:
          type: string
          description: The message.
    InvalidContactFlowModuleException:
      type: object
      properties:
        Problems:
          type: array
          items:
            $ref: '#/components/schemas/ProblemDetail'
    InvalidParameterException:
      type: object
      properties:
        Message:
          type: string
          description: The message about the parameters.
    LimitExceededException:
      type: object
      properties:
        Message:
          type: string
          description: The message about the limit.
    ProblemDetail:
      type: object
      properties:
        message:
          type: string
          description: The problem detail's message.
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
          description: The message about the resource.
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/connect/service/2017-08-08/connect-2017-08-08.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)