Amazon Chime SDK Chime Bans API

The Chime Bans API from Amazon Chime SDK — 2 operation(s) for chime bans.

GitHub OpenAPI

Operations 4

POST /channels/{ChannelArn}/bans Create Channel Ban #
GET /channels/{ChannelArn}/bans List Channel Bans #
DELETE /channels/{ChannelArn}/bans/{MemberArn} Delete Channel Ban #
GET /channels/{ChannelArn}/bans/{MemberArn} Describe Channel Ban #

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-bans-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-bans-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon Chime SDK Meetings Bans API
  version: '2021-07-15'
  description: Generated from AWS's published Smithy model for Amazon Chime SDK Meetings. 4 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://messaging-chime.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /channels/{ChannelArn}/bans:
    post:
      operationId: CreateChannelBan
      summary: Create Channel Ban
      description: Permanently bans a member from a channel. Moderators can't add banned members to a channel. To undo a ban,
        you first have to DeleteChannelBan, and then CreateChannelMembership. Bans are cleaned up when you delete users or
        channels. If you ban a user who is already part of a channel, that user is automatically kicked from the channel.
        The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes
        the API call as the value in the header.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateChannelBanResponse'
        '400':
          description: BadRequestException; ResourceLimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessagingChimeBadRequestException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessagingChimeConflictException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessagingChimeForbiddenException'
        '500':
          description: ServiceFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessagingChimeServiceFailureException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessagingChimeServiceUnavailableException'
        '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/CreateChannelBanRequest'
      tags:
      - Bans
    get:
      operationId: ListChannelBans
      summary: List Channel Bans
      description: Lists all the users and bots banned from a particular channel. The x-amz-chime-bearer request header is
        mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListChannelBansResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessagingChimeBadRequestException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessagingChimeForbiddenException'
        '500':
          description: ServiceFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessagingChimeServiceFailureException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessagingChimeServiceUnavailableException'
        '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/ListChannelBansRequest'
      tags:
      - Bans
  /channels/{ChannelArn}/bans/{MemberArn}:
    delete:
      operationId: DeleteChannelBan
      summary: Delete Channel Ban
      description: Removes a member from a channel's ban list. The x-amz-chime-bearer request header is mandatory. Use the
        ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessagingChimeBadRequestException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessagingChimeForbiddenException'
        '500':
          description: ServiceFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessagingChimeServiceFailureException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessagingChimeServiceUnavailableException'
        '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/DeleteChannelBanRequest'
      tags:
      - Bans
    get:
      operationId: DescribeChannelBan
      summary: Describe Channel Ban
      description: Returns the full details of a channel ban. The x-amz-chime-bearer request header is mandatory. Use the
        ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeChannelBanResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessagingChimeBadRequestException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessagingChimeForbiddenException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessagingChimeNotFoundException'
        '500':
          description: ServiceFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessagingChimeServiceFailureException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessagingChimeServiceUnavailableException'
        '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/DescribeChannelBanRequest'
      tags:
      - Bans
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:
    ChannelBan:
      type: object
      properties:
        Member:
          $ref: '#/components/schemas/Identity'
        ChannelArn:
          type: string
          description: The ARN of the channel from which a member is being banned.
        CreatedTimestamp:
          type: string
          format: date-time
          description: The time at which the ban was created.
        CreatedBy:
          $ref: '#/components/schemas/Identity'
    ChannelBanSummary:
      type: object
      properties:
        Member:
          $ref: '#/components/schemas/Identity'
    CreateChannelBanRequest:
      type: object
      properties:
        ChannelArn:
          type: string
          description: The ARN of the ban request.
        MemberArn:
          type: string
          description: The AppInstanceUserArn of the member being banned.
        ChimeBearer:
          type: string
          description: The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
      required:
      - ChannelArn
      - MemberArn
      - ChimeBearer
    CreateChannelBanResponse:
      type: object
      properties:
        ChannelArn:
          type: string
          description: The ARN of the response to the ban request.
        Member:
          $ref: '#/components/schemas/Identity'
    DeleteChannelBanRequest:
      type: object
      properties:
        ChannelArn:
          type: string
          description: The ARN of the channel from which the AppInstanceUser was banned.
        MemberArn:
          type: string
          description: The ARN of the AppInstanceUser that you want to reinstate.
        ChimeBearer:
          type: string
          description: The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
      required:
      - ChannelArn
      - MemberArn
      - ChimeBearer
    DescribeChannelBanRequest:
      type: object
      properties:
        ChannelArn:
          type: string
          description: The ARN of the channel from which the user is banned.
        MemberArn:
          type: string
          description: The AppInstanceUserArn of the member being banned.
        ChimeBearer:
          type: string
          description: The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
      required:
      - ChannelArn
      - MemberArn
      - ChimeBearer
    DescribeChannelBanResponse:
      type: object
      properties:
        ChannelBan:
          $ref: '#/components/schemas/ChannelBan'
    Identity:
      type: object
      properties:
        Arn:
          type: string
          description: The ARN in an Identity.
        Name:
          type: string
          description: The name in an Identity.
    ListChannelBansRequest:
      type: object
      properties:
        ChannelArn:
          type: string
          description: The ARN of the channel.
        MaxResults:
          type: integer
          description: The maximum number of bans that you want returned.
        NextToken:
          type: string
          description: The token passed by previous API calls until all requested bans are returned.
        ChimeBearer:
          type: string
          description: The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
      required:
      - ChannelArn
      - ChimeBearer
    ListChannelBansResponse:
      type: object
      properties:
        ChannelArn:
          type: string
          description: The ARN of the channel.
        NextToken:
          type: string
          description: The token passed by previous API calls until all requested bans are returned.
        ChannelBans:
          type: array
          items:
            $ref: '#/components/schemas/ChannelBanSummary'
          description: The information for each requested ban.
    MessagingChimeBadRequestException:
      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
    MessagingChimeConflictException:
      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
    MessagingChimeForbiddenException:
      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
    MessagingChimeNotFoundException:
      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
    MessagingChimeServiceFailureException:
      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
    MessagingChimeServiceUnavailableException:
      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
    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
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/chime-sdk-messaging/service/2021-05-15/chime-sdk-messaging-2021-05-15.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)