Amazon Chime SDK Chime App Instance Bots API

The Chime App Instance Bots API from Amazon Chime SDK — 2 operation(s) for chime app instance bots.

GitHub OpenAPI

Operations 5

POST /app-instance-bots Create App Instance Bot #
GET /app-instance-bots List App Instance Bots #
DELETE /app-instance-bots/{AppInstanceBotArn} Delete App Instance Bot #
GET /app-instance-bots/{AppInstanceBotArn} Describe App Instance Bot #
PUT /app-instance-bots/{AppInstanceBotArn} Update App Instance Bot #

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-app-instance-bots-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-app-instance-bots-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon Chime SDK Meetings App Instance Bots API
  version: '2021-07-15'
  description: Generated from AWS's published Smithy model for Amazon Chime SDK Meetings. 5 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://identity-chime.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /app-instance-bots:
    post:
      operationId: CreateAppInstanceBot
      summary: Create App Instance Bot
      description: Creates a bot under an Amazon Chime AppInstance. The request consists of a unique Configuration and Name
        for that bot.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateAppInstanceBotResponse'
        '400':
          description: BadRequestException; ResourceLimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentityChimeBadRequestException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentityChimeConflictException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentityChimeForbiddenException'
        '500':
          description: ServiceFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentityChimeServiceFailureException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentityChimeServiceUnavailableException'
        '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/CreateAppInstanceBotRequest'
      tags:
      - App Instance Bots
    get:
      operationId: ListAppInstanceBots
      summary: List App Instance Bots
      description: Lists all AppInstanceBots created under a single AppInstance.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAppInstanceBotsResponse'
        '400':
          description: BadRequestException; ResourceLimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentityChimeBadRequestException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentityChimeForbiddenException'
        '500':
          description: ServiceFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentityChimeServiceFailureException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentityChimeServiceUnavailableException'
        '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/ListAppInstanceBotsRequest'
      tags:
      - App Instance Bots
  /app-instance-bots/{AppInstanceBotArn}:
    delete:
      operationId: DeleteAppInstanceBot
      summary: Delete App Instance Bot
      description: Deletes an AppInstanceBot.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '400':
          description: BadRequestException; ResourceLimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentityChimeBadRequestException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentityChimeConflictException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentityChimeForbiddenException'
        '500':
          description: ServiceFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentityChimeServiceFailureException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentityChimeServiceUnavailableException'
        '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/DeleteAppInstanceBotRequest'
      tags:
      - App Instance Bots
    get:
      operationId: DescribeAppInstanceBot
      summary: Describe App Instance Bot
      description: The AppInstanceBot's information.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeAppInstanceBotResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentityChimeBadRequestException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentityChimeForbiddenException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentityChimeNotFoundException'
        '500':
          description: ServiceFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentityChimeServiceFailureException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentityChimeServiceUnavailableException'
        '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/DescribeAppInstanceBotRequest'
      tags:
      - App Instance Bots
    put:
      operationId: UpdateAppInstanceBot
      summary: Update App Instance Bot
      description: Updates the name and metadata of an AppInstanceBot.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateAppInstanceBotResponse'
        '400':
          description: BadRequestException; ResourceLimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentityChimeBadRequestException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentityChimeConflictException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentityChimeForbiddenException'
        '500':
          description: ServiceFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentityChimeServiceFailureException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentityChimeServiceUnavailableException'
        '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/UpdateAppInstanceBotRequest'
      tags:
      - App Instance Bots
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:
    AppInstanceBot:
      type: object
      properties:
        AppInstanceBotArn:
          type: string
          description: The ARN of the AppInstanceBot.
        Name:
          type: string
          description: The name of the AppInstanceBot.
        Configuration:
          $ref: '#/components/schemas/Configuration'
        CreatedTimestamp:
          type: string
          format: date-time
          description: The time at which the AppInstanceBot was created.
        LastUpdatedTimestamp:
          type: string
          format: date-time
          description: The time at which the AppInstanceBot was last updated.
        Metadata:
          type: string
          description: The metadata for an AppInstanceBot.
    AppInstanceBotSummary:
      type: object
      properties:
        AppInstanceBotArn:
          type: string
          description: The ARN of the AppInstanceBot.
        Name:
          type: string
          description: The name of the AppInstanceBox.
        Metadata:
          type: string
          description: The metadata of the AppInstanceBot.
    Configuration:
      type: object
      properties:
        Lex:
          $ref: '#/components/schemas/LexConfiguration'
      required:
      - Lex
    CreateAppInstanceBotRequest:
      type: object
      properties:
        AppInstanceArn:
          type: string
          description: The ARN of the AppInstance request.
        Name:
          type: string
          description: The user's name.
        Metadata:
          type: string
          description: The request metadata. Limited to a 1KB string in UTF-8.
        ClientRequestToken:
          type: string
          description: The unique ID for the client making the request. Use different tokens for different AppInstanceBots.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/IdentityChimeTag'
          description: The tags assigned to the AppInstanceBot.
        Configuration:
          $ref: '#/components/schemas/Configuration'
      required:
      - AppInstanceArn
      - ClientRequestToken
      - Configuration
    CreateAppInstanceBotResponse:
      type: object
      properties:
        AppInstanceBotArn:
          type: string
          description: The ARN of the AppinstanceBot.
    DeleteAppInstanceBotRequest:
      type: object
      properties:
        AppInstanceBotArn:
          type: string
          description: The ARN of the AppInstanceBot being deleted.
      required:
      - AppInstanceBotArn
    DescribeAppInstanceBotRequest:
      type: object
      properties:
        AppInstanceBotArn:
          type: string
          description: The ARN of the AppInstanceBot.
      required:
      - AppInstanceBotArn
    DescribeAppInstanceBotResponse:
      type: object
      properties:
        AppInstanceBot:
          $ref: '#/components/schemas/AppInstanceBot'
    IdentityChimeBadRequestException:
      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
    IdentityChimeConflictException:
      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
    IdentityChimeForbiddenException:
      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
    IdentityChimeNotFoundException:
      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
    IdentityChimeServiceFailureException:
      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
    IdentityChimeServiceUnavailableException:
      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
    IdentityChimeTag:
      type: object
      properties:
        Key:
          type: string
          description: The key in a tag.
        Value:
          type: string
          description: The value in a tag.
      required:
      - Key
      - Value
    InvokedBy:
      type: object
      properties:
        StandardMessages:
          type: string
          enum:
          - AUTO
          - ALL
          - MENTIONS
          - NONE
          description: 'Sets standard messages as the bot trigger. For standard messages: ALL: The bot processes all standard
            messages. AUTO: The bot responds to ALL messages when the channel has one other non-hidden member, and responds
            to MENTIONS when the channel has more than one other non-hidden member. MENTIONS: The bot processes all standard
            messages that have a message attribute with CHIME.mentions and a value of the bot ARN. NONE: The bot processes
            no standard messages.'
        TargetedMessages:
          type: string
          enum:
          - ALL
          - NONE
          description: 'Sets targeted messages as the bot trigger. For targeted messages: ALL: The bot processes all TargetedMessages
            sent to it. The bot then responds with a targeted message back to the sender. NONE: The bot processes no targeted
            messages.'
      required:
      - StandardMessages
      - TargetedMessages
    LexConfiguration:
      type: object
      properties:
        RespondsTo:
          type: string
          enum:
          - STANDARD_MESSAGES
          description: Deprecated. Use InvokedBy instead. Determines whether the Amazon Lex V2 bot responds to all standard
            messages. Control messages are not supported.
        InvokedBy:
          $ref: '#/components/schemas/InvokedBy'
        LexBotAliasArn:
          type: string
          description: 'The ARN of the Amazon Lex V2 bot''s alias. The ARN uses this format: arn:aws:lex:REGION:ACCOUNT:bot-alias/MYBOTID/MYBOTALIAS'
        LocaleId:
          type: string
          description: Identifies the Amazon Lex V2 bot's language and locale. The string must match one of the supported
            locales in Amazon Lex V2. All of the intents, slot types, and slots used in the bot must have the same locale.
            For more information, see Supported languages in the Amazon Lex V2 Developer Guide.
        WelcomeIntent:
          type: string
          description: The name of the welcome intent configured in the Amazon Lex V2 bot.
      required:
      - LexBotAliasArn
      - LocaleId
    ListAppInstanceBotsRequest:
      type: object
      properties:
        AppInstanceArn:
          type: string
          description: The ARN of the AppInstance.
        MaxResults:
          type: integer
          description: The maximum number of requests to return.
        NextToken:
          type: string
          description: The token passed by previous API calls until all requested bots are returned.
      required:
      - AppInstanceArn
    ListAppInstanceBotsResponse:
      type: object
      properties:
        AppInstanceArn:
          type: string
          description: The ARN of the AppInstance.
        AppInstanceBots:
          type: array
          items:
            $ref: '#/components/schemas/AppInstanceBotSummary'
          description: The information for each requested AppInstanceBot.
        NextToken:
          type: string
          description: The token passed by previous API calls until all requested bots are returned.
    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
    UpdateAppInstanceBotRequest:
      type: object
      properties:
        AppInstanceBotArn:
          type: string
          description: The ARN of the AppInstanceBot.
        Name:
          type: string
          description: The name of the AppInstanceBot.
        Metadata:
          type: string
          description: The metadata of the AppInstanceBot.
        Configuration:
          $ref: '#/components/schemas/Configuration'
      required:
      - AppInstanceBotArn
      - Name
      - Metadata
    UpdateAppInstanceBotResponse:
      type: object
      properties:
        AppInstanceBotArn:
          type: string
          description: The ARN of the AppInstanceBot.
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/chime-sdk-identity/service/2021-04-20/chime-sdk-identity-2021-04-20.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)