Amazon Chime SDK Chime Voice Profile Domains API

The Chime Voice Profile Domains API from Amazon Chime SDK — 2 operation(s) for chime voice profile domains.

GitHub OpenAPI

Operations 5

POST /voice-profile-domains Create Voice Profile Domain #
GET /voice-profile-domains List Voice Profile Domains #
DELETE /voice-profile-domains/{VoiceProfileDomainId} Delete Voice Profile Domain #
GET /voice-profile-domains/{VoiceProfileDomainId} Get Voice Profile Domain #
PUT /voice-profile-domains/{VoiceProfileDomainId} Update Voice Profile Domain #

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-voice-profile-domains-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-voice-profile-domains-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon Chime SDK Meetings Voice Profile Domains 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://voice-chime.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /voice-profile-domains:
    post:
      operationId: CreateVoiceProfileDomain
      summary: Create Voice Profile Domain
      description: Creates a voice profile domain, a collection of voice profiles, their voice prints, and encrypted enrollment
        audio. Before creating any voice profiles, you must provide all notices and obtain all consents from the speaker as
        required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon
        Chime SDK. For more information about voice profile domains, see Using Amazon Chime SDK Voice Analytics in the Amazon
        Chime SDK Developer Guide.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateVoiceProfileDomainResponse'
        '403':
          description: AccessDeniedException; ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: BadRequestException; ResourceLimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeBadRequestException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeConflictException'
        '500':
          description: ServiceFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeServiceFailureException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeServiceUnavailableException'
        '429':
          description: ThrottledClientException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeThrottledClientException'
        '401':
          description: UnauthorizedClientException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeUnauthorizedClientException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateVoiceProfileDomainRequest'
      tags:
      - Voice Profile Domains
    get:
      operationId: ListVoiceProfileDomains
      summary: List Voice Profile Domains
      description: Lists the specified voice profile domains in the administrator's AWS account.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListVoiceProfileDomainsResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeBadRequestException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeForbiddenException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeNotFoundException'
        '500':
          description: ServiceFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeServiceFailureException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeServiceUnavailableException'
        '429':
          description: ThrottledClientException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeThrottledClientException'
        '401':
          description: UnauthorizedClientException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeUnauthorizedClientException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListVoiceProfileDomainsRequest'
      tags:
      - Voice Profile Domains
  /voice-profile-domains/{VoiceProfileDomainId}:
    delete:
      operationId: DeleteVoiceProfileDomain
      summary: Delete Voice Profile Domain
      description: 'Deletes all voice profiles in the domain. WARNING: This action is not reversible.'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '403':
          description: AccessDeniedException; ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeBadRequestException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeConflictException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeNotFoundException'
        '500':
          description: ServiceFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeServiceFailureException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeServiceUnavailableException'
        '429':
          description: ThrottledClientException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeThrottledClientException'
        '401':
          description: UnauthorizedClientException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeUnauthorizedClientException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteVoiceProfileDomainRequest'
      tags:
      - Voice Profile Domains
    get:
      operationId: GetVoiceProfileDomain
      summary: Get Voice Profile Domain
      description: Retrieves the details of the specified voice profile domain.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetVoiceProfileDomainResponse'
        '403':
          description: AccessDeniedException; ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeBadRequestException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeNotFoundException'
        '500':
          description: ServiceFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeServiceFailureException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeServiceUnavailableException'
        '429':
          description: ThrottledClientException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeThrottledClientException'
        '401':
          description: UnauthorizedClientException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeUnauthorizedClientException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetVoiceProfileDomainRequest'
      tags:
      - Voice Profile Domains
    put:
      operationId: UpdateVoiceProfileDomain
      summary: Update Voice Profile Domain
      description: Updates the settings for the specified voice profile domain.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateVoiceProfileDomainResponse'
        '403':
          description: AccessDeniedException; ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeBadRequestException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeNotFoundException'
        '500':
          description: ServiceFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeServiceFailureException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeServiceUnavailableException'
        '429':
          description: ThrottledClientException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeThrottledClientException'
        '401':
          description: UnauthorizedClientException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeUnauthorizedClientException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateVoiceProfileDomainRequest'
      tags:
      - Voice Profile Domains
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:
    AccessDeniedException:
      type: object
      properties:
        Code:
          type: string
          enum:
          - BadRequest
          - Conflict
          - Forbidden
          - NotFound
          - PreconditionFailed
          - ResourceLimitExceeded
          - ServiceFailure
          - AccessDenied
          - ServiceUnavailable
          - Throttled
          - Throttling
          - Unauthorized
          - Unprocessable
          - VoiceConnectorGroupAssociationsExist
          - PhoneNumberAssociationsExist
          - Gone
          - Validation
        Message:
          type: string
    CreateVoiceProfileDomainRequest:
      type: object
      properties:
        Name:
          type: string
          description: The name of the voice profile domain.
        Description:
          type: string
          description: A description of the voice profile domain.
        ServerSideEncryptionConfiguration:
          $ref: '#/components/schemas/ServerSideEncryptionConfiguration'
        ClientRequestToken:
          type: string
          description: The unique identifier for the client request. Use a different token for different domain creation requests.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The tags assigned to the domain.
      required:
      - Name
      - ServerSideEncryptionConfiguration
    CreateVoiceProfileDomainResponse:
      type: object
      properties:
        VoiceProfileDomain:
          $ref: '#/components/schemas/VoiceProfileDomain'
    DeleteVoiceProfileDomainRequest:
      type: object
      properties:
        VoiceProfileDomainId:
          type: string
          description: The voice profile domain ID.
      required:
      - VoiceProfileDomainId
    GetVoiceProfileDomainRequest:
      type: object
      properties:
        VoiceProfileDomainId:
          type: string
          description: The voice profile domain ID.
      required:
      - VoiceProfileDomainId
    GetVoiceProfileDomainResponse:
      type: object
      properties:
        VoiceProfileDomain:
          $ref: '#/components/schemas/VoiceProfileDomain'
    ListVoiceProfileDomainsRequest:
      type: object
      properties:
        NextToken:
          type: string
          description: The token used to return the next page of results.
        MaxResults:
          type: integer
          description: The maximum number of results to return in a single call.
    ListVoiceProfileDomainsResponse:
      type: object
      properties:
        VoiceProfileDomains:
          type: array
          items:
            $ref: '#/components/schemas/VoiceProfileDomainSummary'
          description: The list of voice profile domains.
        NextToken:
          type: string
          description: The token used to return the next page of results.
    ServerSideEncryptionConfiguration:
      type: object
      properties:
        KmsKeyArn:
          type: string
          description: The ARN of the KMS key used to encrypt the enrollment data in a voice profile domain. Asymmetric customer
            managed keys are not supported.
      required:
      - KmsKeyArn
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: The tag's key.
        Value:
          type: string
          description: The tag's value.
      required:
      - Key
      - Value
    UpdateVoiceProfileDomainRequest:
      type: object
      properties:
        VoiceProfileDomainId:
          type: string
          description: The domain ID.
        Name:
          type: string
          description: The name of the voice profile domain.
        Description:
          type: string
          description: The description of the voice profile domain.
      required:
      - VoiceProfileDomainId
    UpdateVoiceProfileDomainResponse:
      type: object
      properties:
        VoiceProfileDomain:
          $ref: '#/components/schemas/VoiceProfileDomain'
    VoiceChimeBadRequestException:
      type: object
      properties:
        Code:
          type: string
          enum:
          - BadRequest
          - Conflict
          - Forbidden
          - NotFound
          - PreconditionFailed
          - ResourceLimitExceeded
          - ServiceFailure
          - AccessDenied
          - ServiceUnavailable
          - Throttled
          - Throttling
          - Unauthorized
          - Unprocessable
          - VoiceConnectorGroupAssociationsExist
          - PhoneNumberAssociationsExist
          - Gone
          - Validation
        Message:
          type: string
    VoiceChimeConflictException:
      type: object
      properties:
        Code:
          type: string
          enum:
          - BadRequest
          - Conflict
          - Forbidden
          - NotFound
          - PreconditionFailed
          - ResourceLimitExceeded
          - ServiceFailure
          - AccessDenied
          - ServiceUnavailable
          - Throttled
          - Throttling
          - Unauthorized
          - Unprocessable
          - VoiceConnectorGroupAssociationsExist
          - PhoneNumberAssociationsExist
          - Gone
          - Validation
        Message:
          type: string
    VoiceChimeForbiddenException:
      type: object
      properties:
        Code:
          type: string
          enum:
          - BadRequest
          - Conflict
          - Forbidden
          - NotFound
          - PreconditionFailed
          - ResourceLimitExceeded
          - ServiceFailure
          - AccessDenied
          - ServiceUnavailable
          - Throttled
          - Throttling
          - Unauthorized
          - Unprocessable
          - VoiceConnectorGroupAssociationsExist
          - PhoneNumberAssociationsExist
          - Gone
          - Validation
        Message:
          type: string
    VoiceChimeNotFoundException:
      type: object
      properties:
        Code:
          type: string
          enum:
          - BadRequest
          - Conflict
          - Forbidden
          - NotFound
          - PreconditionFailed
          - ResourceLimitExceeded
          - ServiceFailure
          - AccessDenied
          - ServiceUnavailable
          - Throttled
          - Throttling
          - Unauthorized
          - Unprocessable
          - VoiceConnectorGroupAssociationsExist
          - PhoneNumberAssociationsExist
          - Gone
          - Validation
        Message:
          type: string
    VoiceChimeServiceFailureException:
      type: object
      properties:
        Code:
          type: string
          enum:
          - BadRequest
          - Conflict
          - Forbidden
          - NotFound
          - PreconditionFailed
          - ResourceLimitExceeded
          - ServiceFailure
          - AccessDenied
          - ServiceUnavailable
          - Throttled
          - Throttling
          - Unauthorized
          - Unprocessable
          - VoiceConnectorGroupAssociationsExist
          - PhoneNumberAssociationsExist
          - Gone
          - Validation
        Message:
          type: string
    VoiceChimeServiceUnavailableException:
      type: object
      properties:
        Code:
          type: string
          enum:
          - BadRequest
          - Conflict
          - Forbidden
          - NotFound
          - PreconditionFailed
          - ResourceLimitExceeded
          - ServiceFailure
          - AccessDenied
          - ServiceUnavailable
          - Throttled
          - Throttling
          - Unauthorized
          - Unprocessable
          - VoiceConnectorGroupAssociationsExist
          - PhoneNumberAssociationsExist
          - Gone
          - Validation
        Message:
          type: string
    VoiceChimeThrottledClientException:
      type: object
      properties:
        Code:
          type: string
          enum:
          - BadRequest
          - Conflict
          - Forbidden
          - NotFound
          - PreconditionFailed
          - ResourceLimitExceeded
          - ServiceFailure
          - AccessDenied
          - ServiceUnavailable
          - Throttled
          - Throttling
          - Unauthorized
          - Unprocessable
          - VoiceConnectorGroupAssociationsExist
          - PhoneNumberAssociationsExist
          - Gone
          - Validation
        Message:
          type: string
    VoiceChimeUnauthorizedClientException:
      type: object
      properties:
        Code:
          type: string
          enum:
          - BadRequest
          - Conflict
          - Forbidden
          - NotFound
          - PreconditionFailed
          - ResourceLimitExceeded
          - ServiceFailure
          - AccessDenied
          - ServiceUnavailable
          - Throttled
          - Throttling
          - Unauthorized
          - Unprocessable
          - VoiceConnectorGroupAssociationsExist
          - PhoneNumberAssociationsExist
          - Gone
          - Validation
        Message:
          type: string
    VoiceProfileDomain:
      type: object
      properties:
        VoiceProfileDomainId:
          type: string
          description: The ID of the voice profile domain.
        VoiceProfileDomainArn:
          type: string
          description: The voice profile domain's Amazon Resource Number (ARN).
        Name:
          type: string
          description: The name of the voice profile domain.
        Description:
          type: string
          description: The description of the voice profile domain.
        ServerSideEncryptionConfiguration:
          $ref: '#/components/schemas/ServerSideEncryptionConfiguration'
        CreatedTimestamp:
          type: string
          format: date-time
          description: The time at which the voice profile domain was created.
        UpdatedTimestamp:
          type: string
          format: date-time
          description: The time at which the voice profile was last updated.
    VoiceProfileDomainSummary:
      type: object
      properties:
        VoiceProfileDomainId:
          type: string
          description: The ID of the voice profile domain summary.
        VoiceProfileDomainArn:
          type: string
          description: The ARN of a voice profile in a voice profile domain summary.
        Name:
          type: string
          description: The name of the voice profile domain summary.
        Description:
          type: string
          description: Describes the voice profile domain summary.
        CreatedTimestamp:
          type: string
          format: date-time
          description: The time at which the voice profile domain summary was created.
        UpdatedTimestamp:
          type: string
          format: date-time
          description: The time at which the voice profile domain summary was last updated.
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/chime-sdk-voice/service/2022-08-03/chime-sdk-voice-2022-08-03.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)