Amazon Chime SDK Chime Channel Flows API

The Chime Channel Flows API from Amazon Chime SDK — 2 operation(s) for chime channel flows.

GitHub OpenAPI

Operations 7

PUT /channels/{ChannelArn}/channel-flow Associate Channel Flow #
POST /channel-flows Create Channel Flow #
GET /channel-flows List Channel Flows #
DELETE /channel-flows/{ChannelFlowArn} Delete Channel Flow #
GET /channel-flows/{ChannelFlowArn} Describe Channel Flow #
PUT /channel-flows/{ChannelFlowArn} Update Channel Flow #
DELETE /channels/{ChannelArn}/channel-flow/{ChannelFlowArn} Disassociate Channel Flow #

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-chime:amazon-chime-channel-flows-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-chime-channel-flows-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon Chime SDK Meetings Channel Flows API
  version: '2021-07-15'
  description: Generated from AWS's published Smithy model for Amazon Chime SDK Meetings. 7 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://messaging-chime.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /channels/{ChannelArn}/channel-flow:
    put:
      operationId: AssociateChannelFlow
      summary: Associate Channel Flow
      description: Associates a channel flow with a channel. Once associated, all messages to that channel go through channel
        flow processors. To stop processing, use the DisassociateChannelFlow API. Only administrators or channel moderators
        can associate a channel flow. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser
        or AppInstanceBot that makes the API call as the value in the header.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessagingChimeBadRequestException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessagingChimeConflictException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessagingChimeForbiddenException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessagingChimeNotFoundException'
        '500':
          description: ServiceFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessagingChimeServiceFailureException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessagingChimeServiceUnavailableException'
        '429':
          description: ThrottledClientException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottledClientException'
        '401':
          description: UnauthorizedClientException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedClientException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AssociateChannelFlowRequest'
      tags:
      - Channel Flows
  /channel-flows:
    post:
      operationId: CreateChannelFlow
      summary: Create Channel Flow
      description: 'Creates a channel flow, a container for processors. Processors are AWS Lambda functions that perform actions
        on chat messages, such as stripping out profanity. You can associate channel flows with channels, and the processors
        in the channel flow then take action on all messages sent to that channel. This is a developer API. Channel flows
        process the following items: New and updated messages Persistent and non-persistent messages The Standard message
        type Channel flows don''t process Control or System messages. For more information about the message types provided
        by Chime SDK messaging, refer to Message types in the Amazon Chime developer guide.'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateChannelFlowResponse'
        '400':
          description: BadRequestException; ResourceLimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessagingChimeBadRequestException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessagingChimeConflictException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessagingChimeForbiddenException'
        '500':
          description: ServiceFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessagingChimeServiceFailureException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessagingChimeServiceUnavailableException'
        '429':
          description: ThrottledClientException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottledClientException'
        '401':
          description: UnauthorizedClientException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedClientException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateChannelFlowRequest'
      tags:
      - Channel Flows
    get:
      operationId: ListChannelFlows
      summary: List Channel Flows
      description: Returns a paginated lists of all the channel flows created under a single Chime. This is a developer API.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListChannelFlowsResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessagingChimeBadRequestException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessagingChimeForbiddenException'
        '500':
          description: ServiceFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessagingChimeServiceFailureException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessagingChimeServiceUnavailableException'
        '429':
          description: ThrottledClientException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottledClientException'
        '401':
          description: UnauthorizedClientException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedClientException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListChannelFlowsRequest'
      tags:
      - Channel Flows
  /channel-flows/{ChannelFlowArn}:
    delete:
      operationId: DeleteChannelFlow
      summary: Delete Channel Flow
      description: Deletes a channel flow, an irreversible process. This is a developer API. This API works only when the
        channel flow is not associated with any channel. To get a list of all channels that a channel flow is associated with,
        use the ListChannelsAssociatedWithChannelFlow API. Use the DisassociateChannelFlow API to disassociate a channel flow
        from all channels.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessagingChimeBadRequestException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessagingChimeConflictException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessagingChimeForbiddenException'
        '500':
          description: ServiceFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessagingChimeServiceFailureException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessagingChimeServiceUnavailableException'
        '429':
          description: ThrottledClientException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottledClientException'
        '401':
          description: UnauthorizedClientException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedClientException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteChannelFlowRequest'
      tags:
      - Channel Flows
    get:
      operationId: DescribeChannelFlow
      summary: Describe Channel Flow
      description: Returns the full details of a channel flow in an Amazon Chime AppInstance. This is a developer API.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeChannelFlowResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessagingChimeBadRequestException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessagingChimeForbiddenException'
        '500':
          description: ServiceFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessagingChimeServiceFailureException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessagingChimeServiceUnavailableException'
        '429':
          description: ThrottledClientException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottledClientException'
        '401':
          description: UnauthorizedClientException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedClientException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeChannelFlowRequest'
      tags:
      - Channel Flows
    put:
      operationId: UpdateChannelFlow
      summary: Update Channel Flow
      description: Updates channel flow attributes. This is a developer API.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateChannelFlowResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessagingChimeBadRequestException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessagingChimeConflictException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessagingChimeForbiddenException'
        '500':
          description: ServiceFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessagingChimeServiceFailureException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessagingChimeServiceUnavailableException'
        '429':
          description: ThrottledClientException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottledClientException'
        '401':
          description: UnauthorizedClientException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedClientException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateChannelFlowRequest'
      tags:
      - Channel Flows
  /channels/{ChannelArn}/channel-flow/{ChannelFlowArn}:
    delete:
      operationId: DisassociateChannelFlow
      summary: Disassociate Channel Flow
      description: Disassociates a channel flow from all its channels. Once disassociated, all messages to that channel stop
        going through the channel flow processor. Only administrators or channel moderators can disassociate a channel flow.
        The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes
        the API call as the value in the header.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessagingChimeBadRequestException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessagingChimeConflictException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessagingChimeForbiddenException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessagingChimeNotFoundException'
        '500':
          description: ServiceFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessagingChimeServiceFailureException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessagingChimeServiceUnavailableException'
        '429':
          description: ThrottledClientException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottledClientException'
        '401':
          description: UnauthorizedClientException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedClientException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DisassociateChannelFlowRequest'
      tags:
      - Channel Flows
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: chime
  schemas:
    AssociateChannelFlowRequest:
      type: object
      properties:
        ChannelArn:
          type: string
          description: The ARN of the channel.
        ChannelFlowArn:
          type: string
          description: The ARN of the channel flow.
        ChimeBearer:
          type: string
          description: The AppInstanceUserArn of the user making the API call.
      required:
      - ChannelArn
      - ChannelFlowArn
      - ChimeBearer
    ChannelFlow:
      type: object
      properties:
        ChannelFlowArn:
          type: string
          description: The ARN of the channel flow.
        Processors:
          type: array
          items:
            $ref: '#/components/schemas/Processor'
          description: Information about the processor Lambda functions.
        Name:
          type: string
          description: The name of the channel flow.
        CreatedTimestamp:
          type: string
          format: date-time
          description: The time at which the channel flow was created.
        LastUpdatedTimestamp:
          type: string
          format: date-time
          description: The time at which a channel flow was updated.
    ChannelFlowSummary:
      type: object
      properties:
        ChannelFlowArn:
          type: string
          description: The ARN of the channel flow.
        Name:
          type: string
          description: The name of the channel flow.
        Processors:
          type: array
          items:
            $ref: '#/components/schemas/Processor'
          description: Information about the processor Lambda functions.
    CreateChannelFlowRequest:
      type: object
      properties:
        AppInstanceArn:
          type: string
          description: The ARN of the channel flow request.
        Processors:
          type: array
          items:
            $ref: '#/components/schemas/Processor'
          description: Information about the processor Lambda functions.
        Name:
          type: string
          description: The name of the channel flow.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/MessagingChimeTag'
          description: The tags for the creation request.
        ClientRequestToken:
          type: string
          description: The client token for the request. An Idempotency token.
      required:
      - AppInstanceArn
      - Processors
      - Name
      - ClientRequestToken
    CreateChannelFlowResponse:
      type: object
      properties:
        ChannelFlowArn:
          type: string
          description: The ARN of the channel flow.
    DeleteChannelFlowRequest:
      type: object
      properties:
        ChannelFlowArn:
          type: string
          description: The ARN of the channel flow.
      required:
      - ChannelFlowArn
    DescribeChannelFlowRequest:
      type: object
      properties:
        ChannelFlowArn:
          type: string
          description: The ARN of the channel flow.
      required:
      - ChannelFlowArn
    DescribeChannelFlowResponse:
      type: object
      properties:
        ChannelFlow:
          $ref: '#/components/schemas/ChannelFlow'
    DisassociateChannelFlowRequest:
      type: object
      properties:
        ChannelArn:
          type: string
          description: The ARN of the channel.
        ChannelFlowArn:
          type: string
          description: The ARN of the channel flow.
        ChimeBearer:
          type: string
          description: The AppInstanceUserArn of the user making the API call.
      required:
      - ChannelArn
      - ChannelFlowArn
      - ChimeBearer
    LambdaConfiguration:
      type: object
      properties:
        ResourceArn:
          type: string
          description: The ARN of the Lambda message processing function.
        InvocationType:
          type: string
          enum:
          - ASYNC
          description: Controls how the Lambda function is invoked.
      required:
      - ResourceArn
      - InvocationType
    ListChannelFlowsRequest:
      type: object
      properties:
        AppInstanceArn:
          type: string
          description: The ARN of the app instance.
        MaxResults:
          type: integer
          description: The maximum number of channel flows that you want to return.
        NextToken:
          type: string
          description: The token passed by previous API calls until all requested channel flows are returned.
      required:
      - AppInstanceArn
    ListChannelFlowsResponse:
      type: object
      properties:
        ChannelFlows:
          type: array
          items:
            $ref: '#/components/schemas/ChannelFlowSummary'
          description: The information about each channel flow.
        NextToken:
          type: string
          description: The token passed by previous API calls until all requested channels are returned.
    MessagingChimeBadRequestException:
      type: object
      properties:
        Code:
          type: string
          enum:
          - BadRequest
          - Conflict
          - Forbidden
          - NotFound
          - PreconditionFailed
          - ResourceLimitExceeded
          - ServiceFailure
          - AccessDenied
          - ServiceUnavailable
          - Throttled
          - Throttling
          - Unauthorized
          - Unprocessable
          - VoiceConnectorGroupAssociationsExist
          - PhoneNumberAssociationsExist
        Message:
          type: string
    MessagingChimeConflictException:
      type: object
      properties:
        Code:
          type: string
          enum:
          - BadRequest
          - Conflict
          - Forbidden
          - NotFound
          - PreconditionFailed
          - ResourceLimitExceeded
          - ServiceFailure
          - AccessDenied
          - ServiceUnavailable
          - Throttled
          - Throttling
          - Unauthorized
          - Unprocessable
          - VoiceConnectorGroupAssociationsExist
          - PhoneNumberAssociationsExist
        Message:
          type: string
    MessagingChimeForbiddenException:
      type: object
      properties:
        Code:
          type: string
          enum:
          - BadRequest
          - Conflict
          - Forbidden
          - NotFound
          - PreconditionFailed
          - ResourceLimitExceeded
          - ServiceFailure
          - AccessDenied
          - ServiceUnavailable
          - Throttled
          - Throttling
          - Unauthorized
          - Unprocessable
          - VoiceConnectorGroupAssociationsExist
          - PhoneNumberAssociationsExist
        Message:
          type: string
    MessagingChimeNotFoundException:
      type: object
      properties:
        Code:
          type: string
          enum:
          - BadRequest
          - Conflict
          - Forbidden
          - NotFound
          - PreconditionFailed
          - ResourceLimitExceeded
          - ServiceFailure
          - AccessDenied
          - ServiceUnavailable
          - Throttled
          - Throttling
          - Unauthorized
          - Unprocessable
          - VoiceConnectorGroupAssociationsExist
          - PhoneNumberAssociationsExist
        Message:
          type: string
    MessagingChimeServiceFailureException:
      type: object
      properties:
        Code:
          type: string
          enum:
          - BadRequest
          - Conflict
          - Forbidden
          - NotFound
          - PreconditionFailed
          - ResourceLimitExceeded
          - ServiceFailure
          - AccessDenied
          - ServiceUnavailable
          - Throttled
          - Throttling
          - Unauthorized
          - Unprocessable
          - VoiceConnectorGroupAssociationsExist
          - PhoneNumberAssociationsExist
        Message:
          type: string
    MessagingChimeServiceUnavailableException:
      type: object
      properties:
        Code:
          type: string
          enum:
          - BadRequest
          - Conflict
          - Forbidden
          - NotFound
          - PreconditionFailed
          - ResourceLimitExceeded
          - ServiceFailure
          - AccessDenied
          - ServiceUnavailable
          - Throttled
          - Throttling
          - Unauthorized
          - Unprocessable
          - VoiceConnectorGroupAssociationsExist
          - PhoneNumberAssociationsExist
        Message:
          type: string
    MessagingChimeTag:
      type: object
      properties:
        Key:
          type: string
          description: The key in a tag.
        Value:
          type: string
          description: The value in a tag.
      required:
      - Key
      - Value
    Processor:
      type: object
      properties:
        Name:
          type: string
          description: The name of the channel flow.
        Configuration:
          $ref: '#/components/schemas/ProcessorConfiguration'
        ExecutionOrder:
          type: integer
          description: The sequence in which processors run. If you have multiple processors in a channel flow, message processing
            goes through each processor in the sequence. The value determines the sequence. At this point, we support only
            1 processor within a flow.
        FallbackAction:
          type: string
          enum:
          - CONTINUE
          - ABORT
          description: Determines whether to continue with message processing or stop it in cases where communication with
            a processor fails. If a processor has a fallback action of ABORT and communication with it fails, the processor
            sets the message status to FAILED and does not send the message to any recipients. Note that if the last processor
            in the channel flow sequence has a fallback action of CONTINUE and communication with the processor fails, then
            the message is considered processed and sent to recipients of the channel.
      required:
      - Name
      - Configuration
      - ExecutionOrder
      - FallbackAction
    ProcessorConfiguration:
      type: object
      properties:
        Lambda:
          $ref: '#/components/schemas/LambdaConfiguration'
      required:
      - Lambda
    ThrottledClientException:
      type: object
      properties:
        Code:
          type: string
          enum:
          - BadRequest
          - Conflict
          - Forbidden
          - NotFound
          - PreconditionFailed
          - ResourceLimitExceeded
          - ServiceFailure
          - AccessDenied
          - ServiceUnavailable
          - Throttled
          - Throttling
          - Unauthorized
          - Unprocessable
          - VoiceConnectorGroupAssociationsExist
          - PhoneNumberAssociationsExist
        Message:
          type: string
    UnauthorizedClientException:
      type: object
      properties:
        Code:
          type: string
          enum:
          - BadRequest
          - Conflict
          - Forbidden
          - NotFound
          - PreconditionFailed
          - ResourceLimitExceeded
          - ServiceFailure
          - AccessDenied
          - ServiceUnavailable
          - Throttled
          - Throttling
          - Unauthorized
          - Unprocessable
          - VoiceConnectorGroupAssociationsExist
          - PhoneNumberAssociationsExist
        Message:
          type: string
    UpdateChannelFlowRequest:
      type: object
      properties:
        ChannelFlowArn:
          type: string
          description: The ARN of the channel flow.
        Processors:
          type: array
          items:
            $ref: '#/components/schemas/Processor'
          description: Information about the processor Lambda functions
        Name:
          type: string
          description: The name of the channel flow.
      required:
      - ChannelFlowArn
      - Processors
      - Name
    UpdateChannelFlowResponse:
      type: object
      properties:
        ChannelFlowArn:
          type: string
          description: The ARN of the channel flow.
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/chime-sdk-messaging/service/2021-05-15/chime-sdk-messaging-2021-05-15.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)