Amazon Chime SDK Chime Attendees API

The Chime Attendees API from Amazon Chime SDK — 4 operation(s) for chime attendees.

GitHub OpenAPI

Operations 6

POST /meetings/{MeetingId}/attendees?operation=batch-create Batch Create Attendee #
PUT /meetings/{MeetingId}/attendees/capabilities?operation=batch-update-except Batch Update Attendee Capabilities Except #
POST /meetings/{MeetingId}/attendees Create Attendee #
GET /meetings/{MeetingId}/attendees List Attendees #
DELETE /meetings/{MeetingId}/attendees/{AttendeeId} Delete Attendee #
GET /meetings/{MeetingId}/attendees/{AttendeeId} Get Attendee #

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-attendees-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-attendees-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon Chime SDK Meetings Attendees API
  version: '2021-07-15'
  description: Generated from AWS's published Smithy model for Amazon Chime SDK Meetings. 6 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://meetings-chime.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /meetings/{MeetingId}/attendees?operation=batch-create:
    post:
      operationId: BatchCreateAttendee
      summary: Batch Create Attendee
      description: Creates up to 100 attendees for an active Amazon Chime SDK meeting. For more information about the Amazon
        Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchCreateAttendeeResponse'
        '400':
          description: BadRequestException; LimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '500':
          description: ServiceFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceFailureException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
        '422':
          description: UnprocessableEntityException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnprocessableEntityException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchCreateAttendeeRequest'
      tags:
      - Attendees
  /meetings/{MeetingId}/attendees/capabilities?operation=batch-update-except:
    put:
      operationId: BatchUpdateAttendeeCapabilitiesExcept
      summary: Batch Update Attendee Capabilities Except
      description: 'Updates AttendeeCapabilities except the capabilities listed in an ExcludedAttendeeIds table. You use the
        capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information
        about those values, see . When using capabilities, be aware of these corner cases: If you specify MeetingFeatures:Video:MaxResolution:None
        when you create a meeting, all API requests that include SendReceive, Send, or Receive for AttendeeCapabilities:Video
        will be rejected with ValidationError 400. If you specify MeetingFeatures:Content:MaxResolution:None when you create
        a meeting, all API requests that include SendReceive, Send, or Receive for AttendeeCapabilities:Content will be rejected
        with ValidationError 400. You can''t set content capabilities to SendReceive or Receive unless you also set video
        capabilities to SendReceive or Receive. If you don''t set the video capability to receive, the response will contain
        an HTTP 400 Bad Request status code. However, you can set your video capability to receive and you set your content
        capability to not receive. If meeting features is defined as Video:MaxResolution:None but Content:MaxResolution is
        defined as somet'
      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'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '500':
          description: ServiceFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceFailureException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchUpdateAttendeeCapabilitiesExceptRequest'
      tags:
      - Attendees
  /meetings/{MeetingId}/attendees:
    post:
      operationId: CreateAttendee
      summary: Create Attendee
      description: Creates a new attendee for an active Amazon Chime SDK meeting. For more information about the Amazon Chime
        SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateAttendeeResponse'
        '400':
          description: BadRequestException; LimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '500':
          description: ServiceFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceFailureException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
        '422':
          description: UnprocessableEntityException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnprocessableEntityException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAttendeeRequest'
      tags:
      - Attendees
    get:
      operationId: ListAttendees
      summary: List Attendees
      description: Lists the attendees for the specified Amazon Chime SDK meeting. For more information about the Amazon Chime
        SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAttendeesResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '500':
          description: ServiceFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceFailureException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListAttendeesRequest'
      tags:
      - Attendees
  /meetings/{MeetingId}/attendees/{AttendeeId}:
    delete:
      operationId: DeleteAttendee
      summary: Delete Attendee
      description: Deletes an attendee from the specified Amazon Chime SDK meeting and deletes their JoinToken. Attendees
        are automatically deleted when a Amazon Chime SDK meeting is deleted. For more information about the Amazon Chime
        SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '500':
          description: ServiceFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceFailureException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteAttendeeRequest'
      tags:
      - Attendees
    get:
      operationId: GetAttendee
      summary: Get Attendee
      description: Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID. For more information
        about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAttendeeResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '500':
          description: ServiceFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceFailureException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetAttendeeRequest'
      tags:
      - Attendees
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:
    Attendee:
      type: object
      properties:
        ExternalUserId:
          type: string
          description: 'The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed
            by a builder application. Pattern: [-_&@+=,(){}\[\]\/«».:|''"#a-zA-Z0-9À-ÿ\s]* Values that begin with aws: are
            reserved. You can''t configure a value that uses this prefix. Case insensitive.'
        AttendeeId:
          type: string
          description: The Amazon Chime SDK attendee ID.
        JoinToken:
          type: string
          description: The join token used by the Amazon Chime SDK attendee.
        Capabilities:
          $ref: '#/components/schemas/AttendeeCapabilities'
    AttendeeCapabilities:
      type: object
      properties:
        Audio:
          type: string
          enum:
          - SendReceive
          - Send
          - Receive
          - None
          description: The audio capability assigned to an attendee.
        Video:
          type: string
          enum:
          - SendReceive
          - Send
          - Receive
          - None
          description: The video capability assigned to an attendee.
        Content:
          type: string
          enum:
          - SendReceive
          - Send
          - Receive
          - None
          description: The content capability assigned to an attendee.
      required:
      - Audio
      - Video
      - Content
    AttendeeIdItem:
      type: object
      properties:
        AttendeeId:
          type: string
          description: A list of one or more attendee IDs.
      required:
      - AttendeeId
    BadRequestException:
      type: object
      properties:
        Code:
          type: string
        Message:
          type: string
        RequestId:
          type: string
          description: The request id associated with the call responsible for the exception.
    BatchCreateAttendeeRequest:
      type: object
      properties:
        MeetingId:
          type: string
          description: The Amazon Chime SDK ID of the meeting to which you're adding attendees.
        Attendees:
          type: array
          items:
            $ref: '#/components/schemas/CreateAttendeeRequestItem'
          description: The attendee information, including attendees' IDs and join tokens.
      required:
      - MeetingId
      - Attendees
    BatchCreateAttendeeResponse:
      type: object
      properties:
        Attendees:
          type: array
          items:
            $ref: '#/components/schemas/Attendee'
          description: The attendee information, including attendees' IDs and join tokens.
        Errors:
          type: array
          items:
            $ref: '#/components/schemas/CreateAttendeeError'
          description: If the action fails for one or more of the attendees in the request, a list of the attendees is returned,
            along with error codes and error messages.
    BatchUpdateAttendeeCapabilitiesExceptRequest:
      type: object
      properties:
        MeetingId:
          type: string
          description: The ID of the meeting associated with the update request.
        ExcludedAttendeeIds:
          type: array
          items:
            $ref: '#/components/schemas/AttendeeIdItem'
          description: The AttendeeIDs that you want to exclude from one or more capabilities.
        Capabilities:
          $ref: '#/components/schemas/AttendeeCapabilities'
      required:
      - MeetingId
      - ExcludedAttendeeIds
      - Capabilities
    ConflictException:
      type: object
      properties:
        Code:
          type: string
        Message:
          type: string
        RequestId:
          type: string
          description: The ID of the request involved in the conflict.
    CreateAttendeeError:
      type: object
      properties:
        ExternalUserId:
          type: string
          description: 'The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed
            by a builder application. Pattern: [-_&@+=,(){}\[\]\/«».:|''"#a-zA-Z0-9À-ÿ\s]* Values that begin with aws: are
            reserved. You can''t configure a value that uses this prefix. Case insensitive.'
        ErrorCode:
          type: string
          description: The error code.
        ErrorMessage:
          type: string
          description: The error message.
    CreateAttendeeRequest:
      type: object
      properties:
        MeetingId:
          type: string
          description: The unique ID of the meeting.
        ExternalUserId:
          type: string
          description: 'The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed
            by a builder application. Pattern: [-_&@+=,(){}\[\]\/«».:|''"#a-zA-Z0-9À-ÿ\s]* Values that begin with aws: are
            reserved. You can''t configure a value that uses this prefix.'
        Capabilities:
          $ref: '#/components/schemas/AttendeeCapabilities'
      required:
      - MeetingId
      - ExternalUserId
    CreateAttendeeRequestItem:
      type: object
      properties:
        ExternalUserId:
          type: string
          description: 'The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed
            by a builder application. Pattern: [-_&@+=,(){}\[\]\/«».:|''"#a-zA-Z0-9À-ÿ\s]* Values that begin with aws: are
            reserved. You can''t configure a value that uses this prefix. Case insensitive.'
        Capabilities:
          $ref: '#/components/schemas/AttendeeCapabilities'
      required:
      - ExternalUserId
    CreateAttendeeResponse:
      type: object
      properties:
        Attendee:
          $ref: '#/components/schemas/Attendee'
    DeleteAttendeeRequest:
      type: object
      properties:
        MeetingId:
          type: string
          description: The Amazon Chime SDK meeting ID.
        AttendeeId:
          type: string
          description: The Amazon Chime SDK attendee ID.
      required:
      - MeetingId
      - AttendeeId
    ForbiddenException:
      type: object
      properties:
        Code:
          type: string
        Message:
          type: string
        RequestId:
          type: string
          description: The request id associated with the call responsible for the exception.
    GetAttendeeRequest:
      type: object
      properties:
        MeetingId:
          type: string
          description: The Amazon Chime SDK meeting ID.
        AttendeeId:
          type: string
          description: The Amazon Chime SDK attendee ID.
      required:
      - MeetingId
      - AttendeeId
    GetAttendeeResponse:
      type: object
      properties:
        Attendee:
          $ref: '#/components/schemas/Attendee'
    ListAttendeesRequest:
      type: object
      properties:
        MeetingId:
          type: string
          description: The Amazon Chime SDK meeting ID.
        NextToken:
          type: string
          description: The token to use to retrieve the next page of results.
        MaxResults:
          type: integer
          description: The maximum number of results to return in a single call.
      required:
      - MeetingId
    ListAttendeesResponse:
      type: object
      properties:
        Attendees:
          type: array
          items:
            $ref: '#/components/schemas/Attendee'
          description: The Amazon Chime SDK attendee information.
        NextToken:
          type: string
          description: The token to use to retrieve the next page of results.
    NotFoundException:
      type: object
      properties:
        Code:
          type: string
        Message:
          type: string
        RequestId:
          type: string
          description: The request ID associated with the call responsible for the exception.
    ServiceFailureException:
      type: object
      properties:
        Code:
          type: string
        Message:
          type: string
        RequestId:
          type: string
          description: The ID of the failed request.
    ServiceUnavailableException:
      type: object
      properties:
        Code:
          type: string
        Message:
          type: string
        RequestId:
          type: string
          description: The request id associated with the call responsible for the exception.
        RetryAfterSeconds:
          type: string
          description: The number of seconds the caller should wait before retrying.
    ThrottlingException:
      type: object
      properties:
        Code:
          type: string
        Message:
          type: string
        RequestId:
          type: string
          description: The ID of the request that exceeded the throttling limit.
    UnauthorizedException:
      type: object
      properties:
        Code:
          type: string
        Message:
          type: string
        RequestId:
          type: string
          description: The request id associated with the call responsible for the exception.
    UnprocessableEntityException:
      type: object
      properties:
        Code:
          type: string
        Message:
          type: string
        RequestId:
          type: string
          description: The request id associated with the call responsible for the exception.
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/chime-sdk-meetings/service/2021-07-15/chime-sdk-meetings-2021-07-15.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)