Amazon Chime SDK Chime Retention Settings API

The Chime Retention Settings API from Amazon Chime SDK — 2 operation(s) for chime retention settings.

GitHub OpenAPI

Operations 4

GET /app-instances/{AppInstanceArn}/retention-settings Get App Instance Retention Settings #
PUT /app-instances/{AppInstanceArn}/retention-settings Put App Instance Retention Settings #
GET /accounts/{AccountId}/retention-settings Get Retention Settings #
PUT /accounts/{AccountId}/retention-settings Put Retention Settings #

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-retention-settings-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-retention-settings-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon Chime SDK Meetings Retention Settings 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://identity-chime.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /app-instances/{AppInstanceArn}/retention-settings:
    get:
      operationId: GetAppInstanceRetentionSettings
      summary: Get App Instance Retention Settings
      description: Gets the retention settings for an AppInstance.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAppInstanceRetentionSettingsResponse'
        '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/GetAppInstanceRetentionSettingsRequest'
      tags:
      - Retention Settings
    put:
      operationId: PutAppInstanceRetentionSettings
      summary: Put App Instance Retention Settings
      description: Sets the amount of time in days that a given AppInstance retains data.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutAppInstanceRetentionSettingsResponse'
        '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/PutAppInstanceRetentionSettingsRequest'
      tags:
      - Retention Settings
  /accounts/{AccountId}/retention-settings:
    get:
      operationId: GetRetentionSettings
      summary: Get Retention Settings
      description: Gets the retention settings for the specified Amazon Chime Enterprise account. For more information about
        retention settings, see Managing Chat Retention Policies in the Amazon Chime Administration Guide.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetRetentionSettingsResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChimeBadRequestException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChimeForbiddenException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChimeNotFoundException'
        '500':
          description: ServiceFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChimeServiceFailureException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChimeServiceUnavailableException'
        '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/GetRetentionSettingsRequest'
      tags:
      - Retention Settings
      servers:
      - url: https://chime.{region}.amazonaws.com
        variables:
          region:
            default: us-east-1
    put:
      operationId: PutRetentionSettings
      summary: Put Retention Settings
      description: Puts retention settings for the specified Amazon Chime Enterprise account. We recommend using AWS CloudTrail
        to monitor usage of this API for your account. For more information, see Logging Amazon Chime API Calls with AWS CloudTrail
        in the Amazon Chime Administration Guide. To turn off existing retention settings, remove the number of days from
        the corresponding RetentionDays field in the RetentionSettings object. For more information about retention settings,
        see Managing Chat Retention Policies in the Amazon Chime Administration Guide.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutRetentionSettingsResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChimeBadRequestException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChimeConflictException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChimeForbiddenException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChimeNotFoundException'
        '500':
          description: ServiceFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChimeServiceFailureException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChimeServiceUnavailableException'
        '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/PutRetentionSettingsRequest'
      tags:
      - Retention Settings
      servers:
      - url: https://chime.{region}.amazonaws.com
        variables:
          region:
            default: us-east-1
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:
    AppInstanceRetentionSettings:
      type: object
      properties:
        ChannelRetentionSettings:
          $ref: '#/components/schemas/ChannelRetentionSettings'
    ChannelRetentionSettings:
      type: object
      properties:
        RetentionDays:
          type: integer
          description: The time in days to retain the messages in a channel.
    ChimeBadRequestException:
      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
    ChimeConflictException:
      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
    ChimeForbiddenException:
      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
    ChimeNotFoundException:
      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
    ChimeServiceFailureException:
      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
    ChimeServiceUnavailableException:
      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
    ConversationRetentionSettings:
      type: object
      properties:
        RetentionDays:
          type: integer
          description: The number of days for which to retain conversation messages.
    GetAppInstanceRetentionSettingsRequest:
      type: object
      properties:
        AppInstanceArn:
          type: string
          description: The ARN of the AppInstance.
      required:
      - AppInstanceArn
    GetAppInstanceRetentionSettingsResponse:
      type: object
      properties:
        AppInstanceRetentionSettings:
          $ref: '#/components/schemas/AppInstanceRetentionSettings'
        InitiateDeletionTimestamp:
          type: string
          format: date-time
          description: The timestamp representing the time at which the specified items are retained, in Epoch Seconds.
    GetRetentionSettingsRequest:
      type: object
      properties:
        AccountId:
          type: string
          description: The Amazon Chime account ID.
      required:
      - AccountId
    GetRetentionSettingsResponse:
      type: object
      properties:
        RetentionSettings:
          $ref: '#/components/schemas/RetentionSettings'
        InitiateDeletionTimestamp:
          type: string
          format: date-time
          description: The timestamp representing the time at which the specified items are permanently deleted, in ISO 8601
            format.
    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
    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
    PutAppInstanceRetentionSettingsRequest:
      type: object
      properties:
        AppInstanceArn:
          type: string
          description: The ARN of the AppInstance.
        AppInstanceRetentionSettings:
          $ref: '#/components/schemas/AppInstanceRetentionSettings'
      required:
      - AppInstanceArn
      - AppInstanceRetentionSettings
    PutAppInstanceRetentionSettingsResponse:
      type: object
      properties:
        AppInstanceRetentionSettings:
          $ref: '#/components/schemas/AppInstanceRetentionSettings'
        InitiateDeletionTimestamp:
          type: string
          format: date-time
          description: The time at which the API deletes data.
    PutRetentionSettingsRequest:
      type: object
      properties:
        AccountId:
          type: string
          description: The Amazon Chime account ID.
        RetentionSettings:
          $ref: '#/components/schemas/RetentionSettings'
      required:
      - AccountId
      - RetentionSettings
    PutRetentionSettingsResponse:
      type: object
      properties:
        RetentionSettings:
          $ref: '#/components/schemas/RetentionSettings'
        InitiateDeletionTimestamp:
          type: string
          format: date-time
          description: The timestamp representing the time at which the specified items are permanently deleted, in ISO 8601
            format.
    RetentionSettings:
      type: object
      properties:
        RoomRetentionSettings:
          $ref: '#/components/schemas/RoomRetentionSettings'
        ConversationRetentionSettings:
          $ref: '#/components/schemas/ConversationRetentionSettings'
    RoomRetentionSettings:
      type: object
      properties:
        RetentionDays:
          type: integer
          description: The number of days for which to retain chat-room messages.
    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-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)
  sources:
  - https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/chime-sdk-identity/service/2021-04-20/chime-sdk-identity-2021-04-20.json
  - https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/chime/service/2018-05-01/chime-2018-05-01.json