Amazon Chime SDK Chime App Instance Users API

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

GitHub OpenAPI

Operations 5

POST /app-instance-users Create App Instance User #
GET /app-instance-users List App Instance Users #
DELETE /app-instance-users/{AppInstanceUserArn} Delete App Instance User #
GET /app-instance-users/{AppInstanceUserArn} Describe App Instance User #
PUT /app-instance-users/{AppInstanceUserArn} Update App Instance User #

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-users-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-users-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon Chime SDK Meetings App Instance Users 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-users:
    post:
      operationId: CreateAppInstanceUser
      summary: Create App Instance User
      description: Creates a user under an Amazon Chime AppInstance. The request consists of a unique appInstanceUserId and
        Name for that user.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateAppInstanceUserResponse'
        '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/CreateAppInstanceUserRequest'
      tags:
      - App Instance Users
    get:
      operationId: ListAppInstanceUsers
      summary: List App Instance Users
      description: List all AppInstanceUsers created under a single AppInstance.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAppInstanceUsersResponse'
        '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/ListAppInstanceUsersRequest'
      tags:
      - App Instance Users
  /app-instance-users/{AppInstanceUserArn}:
    delete:
      operationId: DeleteAppInstanceUser
      summary: Delete App Instance User
      description: Deletes an AppInstanceUser.
      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/DeleteAppInstanceUserRequest'
      tags:
      - App Instance Users
    get:
      operationId: DescribeAppInstanceUser
      summary: Describe App Instance User
      description: Returns the full details of an AppInstanceUser.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeAppInstanceUserResponse'
        '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/DescribeAppInstanceUserRequest'
      tags:
      - App Instance Users
    put:
      operationId: UpdateAppInstanceUser
      summary: Update App Instance User
      description: Updates the details of an AppInstanceUser. You can update names and metadata.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateAppInstanceUserResponse'
        '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/UpdateAppInstanceUserRequest'
      tags:
      - App Instance Users
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:
    AppInstanceUser:
      type: object
      properties:
        AppInstanceUserArn:
          type: string
          description: The ARN of the AppInstanceUser.
        Name:
          type: string
          description: The name of the AppInstanceUser.
        Metadata:
          type: string
          description: The metadata of the AppInstanceUser.
        CreatedTimestamp:
          type: string
          format: date-time
          description: The time at which the AppInstanceUser was created.
        LastUpdatedTimestamp:
          type: string
          format: date-time
          description: The time at which the AppInstanceUser was last updated.
        ExpirationSettings:
          $ref: '#/components/schemas/IdentityChimeExpirationSettings'
    AppInstanceUserSummary:
      type: object
      properties:
        AppInstanceUserArn:
          type: string
          description: The ARN of the AppInstanceUser.
        Name:
          type: string
          description: The name of an AppInstanceUser.
        Metadata:
          type: string
          description: The metadata of the AppInstanceUser.
    CreateAppInstanceUserRequest:
      type: object
      properties:
        AppInstanceArn:
          type: string
          description: The ARN of the AppInstance request.
        AppInstanceUserId:
          type: string
          description: The user ID of the AppInstance.
        Name:
          type: string
          description: The user's name.
        Metadata:
          type: string
          description: The request's metadata. Limited to a 1KB string in UTF-8.
        ClientRequestToken:
          type: string
          description: The unique ID of the request. Use different tokens to request additional AppInstances.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/IdentityChimeTag'
          description: Tags assigned to the AppInstanceUser.
        ExpirationSettings:
          $ref: '#/components/schemas/IdentityChimeExpirationSettings'
      required:
      - AppInstanceArn
      - AppInstanceUserId
      - Name
      - ClientRequestToken
    CreateAppInstanceUserResponse:
      type: object
      properties:
        AppInstanceUserArn:
          type: string
          description: The user's ARN.
    DeleteAppInstanceUserRequest:
      type: object
      properties:
        AppInstanceUserArn:
          type: string
          description: The ARN of the user request being deleted.
      required:
      - AppInstanceUserArn
    DescribeAppInstanceUserRequest:
      type: object
      properties:
        AppInstanceUserArn:
          type: string
          description: The ARN of the AppInstanceUser.
      required:
      - AppInstanceUserArn
    DescribeAppInstanceUserResponse:
      type: object
      properties:
        AppInstanceUser:
          $ref: '#/components/schemas/AppInstanceUser'
    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
    IdentityChimeExpirationSettings:
      type: object
      properties:
        ExpirationDays:
          type: integer
          description: The period in days after which an AppInstanceUser will be automatically deleted.
        ExpirationCriterion:
          type: string
          enum:
          - CREATED_TIMESTAMP
          description: Specifies the conditions under which an AppInstanceUser will expire.
      required:
      - ExpirationDays
      - ExpirationCriterion
    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
    ListAppInstanceUsersRequest:
      type: object
      properties:
        AppInstanceArn:
          type: string
          description: The ARN of the AppInstance.
        MaxResults:
          type: integer
          description: The maximum number of requests that you want returned.
        NextToken:
          type: string
          description: The token passed by previous API calls until all requested users are returned.
      required:
      - AppInstanceArn
    ListAppInstanceUsersResponse:
      type: object
      properties:
        AppInstanceArn:
          type: string
          description: The ARN of the AppInstance.
        AppInstanceUsers:
          type: array
          items:
            $ref: '#/components/schemas/AppInstanceUserSummary'
          description: The information for each requested AppInstanceUser.
        NextToken:
          type: string
          description: The token passed by previous API calls until all requested users 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
    UpdateAppInstanceUserRequest:
      type: object
      properties:
        AppInstanceUserArn:
          type: string
          description: The ARN of the AppInstanceUser.
        Name:
          type: string
          description: The name of the AppInstanceUser.
        Metadata:
          type: string
          description: The metadata of the AppInstanceUser.
      required:
      - AppInstanceUserArn
      - Name
      - Metadata
    UpdateAppInstanceUserResponse:
      type: object
      properties:
        AppInstanceUserArn:
          type: string
          description: The ARN of the AppInstanceUser.
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)