Amazon Chime SDK Chime App Instances API

The Chime App Instances API from Amazon Chime SDK — 2 operation(s) for chime app instances.

GitHub OpenAPI

Operations 5

POST /app-instances Create App Instance #
GET /app-instances List App Instances #
DELETE /app-instances/{AppInstanceArn} Delete App Instance #
GET /app-instances/{AppInstanceArn} Describe App Instance #
PUT /app-instances/{AppInstanceArn} Update App Instance #

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-instances-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-instances-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon Chime SDK Meetings App Instances 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-instances:
    post:
      operationId: CreateAppInstance
      summary: Create App Instance
      description: Creates an Amazon Chime SDK messaging AppInstance under an AWS account. Only SDK messaging customers use
        this API. CreateAppInstance supports idempotency behavior as described in the AWS API Standard. identity
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateAppInstanceResponse'
        '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/CreateAppInstanceRequest'
      tags:
      - App Instances
    get:
      operationId: ListAppInstances
      summary: List App Instances
      description: Lists all Amazon Chime AppInstances created under a single AWS account.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAppInstancesResponse'
        '400':
          description: BadRequestException
          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/ListAppInstancesRequest'
      tags:
      - App Instances
  /app-instances/{AppInstanceArn}:
    delete:
      operationId: DeleteAppInstance
      summary: Delete App Instance
      description: Deletes an AppInstance and all associated data asynchronously.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '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/DeleteAppInstanceRequest'
      tags:
      - App Instances
    get:
      operationId: DescribeAppInstance
      summary: Describe App Instance
      description: Returns the full details of an AppInstance.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeAppInstanceResponse'
        '400':
          description: BadRequestException
          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/DescribeAppInstanceRequest'
      tags:
      - App Instances
    put:
      operationId: UpdateAppInstance
      summary: Update App Instance
      description: Updates AppInstance metadata.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateAppInstanceResponse'
        '400':
          description: BadRequestException
          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/UpdateAppInstanceRequest'
      tags:
      - App Instances
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:
    AppInstance:
      type: object
      properties:
        AppInstanceArn:
          type: string
          description: The ARN of the messaging instance.
        Name:
          type: string
          description: The name of an AppInstance.
        CreatedTimestamp:
          type: string
          format: date-time
          description: The time at which an AppInstance was created. In epoch milliseconds.
        LastUpdatedTimestamp:
          type: string
          format: date-time
          description: The time an AppInstance was last updated. In epoch milliseconds.
        Metadata:
          type: string
          description: The metadata of an AppInstance.
    AppInstanceSummary:
      type: object
      properties:
        AppInstanceArn:
          type: string
          description: The AppInstance ARN.
        Name:
          type: string
          description: The name of the AppInstance.
        Metadata:
          type: string
          description: The metadata of the AppInstance.
    CreateAppInstanceRequest:
      type: object
      properties:
        Name:
          type: string
          description: The name of the AppInstance.
        Metadata:
          type: string
          description: The metadata of the AppInstance. Limited to a 1KB string in UTF-8.
        ClientRequestToken:
          type: string
          description: The unique ID of the request. Use different tokens to create different AppInstances.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/IdentityChimeTag'
          description: Tags assigned to the AppInstance.
      required:
      - Name
      - ClientRequestToken
    CreateAppInstanceResponse:
      type: object
      properties:
        AppInstanceArn:
          type: string
          description: The Amazon Resource Number (ARN) of the AppInstance.
    DeleteAppInstanceRequest:
      type: object
      properties:
        AppInstanceArn:
          type: string
          description: The ARN of the AppInstance.
      required:
      - AppInstanceArn
    DescribeAppInstanceRequest:
      type: object
      properties:
        AppInstanceArn:
          type: string
          description: The ARN of the AppInstance.
      required:
      - AppInstanceArn
    DescribeAppInstanceResponse:
      type: object
      properties:
        AppInstance:
          $ref: '#/components/schemas/AppInstance'
    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
    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
    ListAppInstancesRequest:
      type: object
      properties:
        MaxResults:
          type: integer
          description: The maximum number of AppInstances that you want to return.
        NextToken:
          type: string
          description: The token passed by previous API requests until you reach the maximum number of AppInstances.
    ListAppInstancesResponse:
      type: object
      properties:
        AppInstances:
          type: array
          items:
            $ref: '#/components/schemas/AppInstanceSummary'
          description: The information for each AppInstance.
        NextToken:
          type: string
          description: The token passed by previous API requests until the maximum number of AppInstances is reached.
    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
    UpdateAppInstanceRequest:
      type: object
      properties:
        AppInstanceArn:
          type: string
          description: The ARN of the AppInstance.
        Name:
          type: string
          description: The name that you want to change.
        Metadata:
          type: string
          description: The metadata that you want to change.
      required:
      - AppInstanceArn
      - Name
      - Metadata
    UpdateAppInstanceResponse:
      type: object
      properties:
        AppInstanceArn:
          type: string
          description: The ARN of the AppInstance.
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)