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-lex:amazon-lex-channels-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 Lex Model Building V2 Channels API
  version: '2020-08-07'
  description: Generated from AWS's published Smithy model for Amazon Lex Model Building V2. 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://models.lex.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /bots/{botName}/aliases/{botAlias}/channels/{name}:
    delete:
      operationId: DeleteBotChannelAssociation
      summary: Delete Bot Channel Association
      description: Deletes the association between an Amazon Lex bot and a messaging platform. This operation requires permission
        for the lex:DeleteBotChannelAssociation action.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '429':
          description: LimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
      deprecated: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteBotChannelAssociationRequest'
      tags:
      - Channels
    get:
      operationId: GetBotChannelAssociation
      summary: Get Bot Channel Association
      description: Returns information about the association between an Amazon Lex bot and a messaging platform. This operation
        requires permissions for the lex:GetBotChannelAssociation action.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetBotChannelAssociationResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '429':
          description: LimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
      deprecated: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetBotChannelAssociationRequest'
      tags:
      - Channels
  /bots/{botName}/aliases/{botAlias}/channels:
    get:
      operationId: GetBotChannelAssociations
      summary: Get Bot Channel Associations
      description: Returns a list of all of the channels associated with the specified bot. The GetBotChannelAssociations
        operation requires permissions for the lex:GetBotChannelAssociations action.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetBotChannelAssociationsResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '429':
          description: LimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
      deprecated: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetBotChannelAssociationsRequest'
      tags:
      - Channels
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: lex
  schemas:
    BadRequestException:
      type: object
      properties:
        message:
          type: string
    BotChannelAssociation:
      type: object
      properties:
        name:
          type: string
          description: The name of the association between the bot and the channel.
        description:
          type: string
          description: A text description of the association you are creating.
        botAlias:
          type: string
          description: An alias pointing to the specific version of the Amazon Lex bot to which this association is being
            made.
        botName:
          type: string
          description: The name of the Amazon Lex bot to which this association is being made. Currently, Amazon Lex supports
            associations with Facebook and Slack, and Twilio.
        createdDate:
          type: string
          format: date-time
          description: The date that the association between the Amazon Lex bot and the channel was created.
        type:
          type: string
          enum:
          - Facebook
          - Slack
          - Twilio-Sms
          - Kik
          description: Specifies the type of association by indicating the type of channel being established between the Amazon
            Lex bot and the external messaging platform.
        botConfiguration:
          type: object
          additionalProperties:
            type: string
          description: Provides information necessary to communicate with the messaging platform.
        status:
          type: string
          enum:
          - IN_PROGRESS
          - CREATED
          - FAILED
          description: The status of the bot channel. CREATED - The channel has been created and is ready for use. IN_PROGRESS
            - Channel creation is in progress. FAILED - There was an error creating the channel. For information about the
            reason for the failure, see the failureReason field.
        failureReason:
          type: string
          description: If status is FAILED, Amazon Lex provides the reason that it failed to create the association.
    ConflictException:
      type: object
      properties:
        message:
          type: string
    DeleteBotChannelAssociationRequest:
      type: object
      properties:
        name:
          type: string
          description: The name of the association. The name is case sensitive.
        botName:
          type: string
          description: The name of the Amazon Lex bot.
        botAlias:
          type: string
          description: An alias that points to the specific version of the Amazon Lex bot to which this association is being
            made.
      required:
      - name
      - botName
      - botAlias
    GetBotChannelAssociationRequest:
      type: object
      properties:
        name:
          type: string
          description: The name of the association between the bot and the channel. The name is case sensitive.
        botName:
          type: string
          description: The name of the Amazon Lex bot.
        botAlias:
          type: string
          description: An alias pointing to the specific version of the Amazon Lex bot to which this association is being
            made.
      required:
      - name
      - botName
      - botAlias
    GetBotChannelAssociationResponse:
      type: object
      properties:
        name:
          type: string
          description: The name of the association between the bot and the channel.
        description:
          type: string
          description: A description of the association between the bot and the channel.
        botAlias:
          type: string
          description: An alias pointing to the specific version of the Amazon Lex bot to which this association is being
            made.
        botName:
          type: string
          description: The name of the Amazon Lex bot.
        createdDate:
          type: string
          format: date-time
          description: The date that the association between the bot and the channel was created.
        type:
          type: string
          enum:
          - Facebook
          - Slack
          - Twilio-Sms
          - Kik
          description: The type of the messaging platform.
        botConfiguration:
          type: object
          additionalProperties:
            type: string
          description: Provides information that the messaging platform needs to communicate with the Amazon Lex bot.
        status:
          type: string
          enum:
          - IN_PROGRESS
          - CREATED
          - FAILED
          description: The status of the bot channel. CREATED - The channel has been created and is ready for use. IN_PROGRESS
            - Channel creation is in progress. FAILED - There was an error creating the channel. For information about the
            reason for the failure, see the failureReason field.
        failureReason:
          type: string
          description: If status is FAILED, Amazon Lex provides the reason that it failed to create the association.
    GetBotChannelAssociationsRequest:
      type: object
      properties:
        botName:
          type: string
          description: The name of the Amazon Lex bot in the association.
        botAlias:
          type: string
          description: An alias pointing to the specific version of the Amazon Lex bot to which this association is being
            made.
        nextToken:
          type: string
          description: A pagination token for fetching the next page of associations. If the response to this call is truncated,
            Amazon Lex returns a pagination token in the response. To fetch the next page of associations, specify the pagination
            token in the next request.
        maxResults:
          type: integer
          description: The maximum number of associations to return in the response. The default is 50.
        nameContains:
          type: string
          description: Substring to match in channel association names. An association will be returned if any part of its
            name matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz." To return all bot channel associations,
            use a hyphen ("-") as the nameContains parameter.
      required:
      - botName
      - botAlias
    GetBotChannelAssociationsResponse:
      type: object
      properties:
        botChannelAssociations:
          type: array
          items:
            $ref: '#/components/schemas/BotChannelAssociation'
          description: An array of objects, one for each association, that provides information about the Amazon Lex bot and
            its association with the channel.
        nextToken:
          type: string
          description: A pagination token that fetches the next page of associations. If the response to this call is truncated,
            Amazon Lex returns a pagination token in the response. To fetch the next page of associations, specify the pagination
            token in the next request.
    InternalFailureException:
      type: object
      properties:
        message:
          type: string
    LimitExceededException:
      type: object
      properties:
        retryAfterSeconds:
          type: string
        message:
          type: string
    NotFoundException:
      type: object
      properties:
        message:
          type: string
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/lex-model-building-service/service/2017-04-19/lex-model-building-service-2017-04-19.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)