Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

StartMeetingTranscription

Starts transcription for the specified meetingId. For more information, refer to Using Amazon Chime SDK live transcription in the Amazon Chime SDK Developer Guide.

If you specify an invalid configuration, a TranscriptFailed event will be sent with the contents of the BadRequestException generated by Amazon Transcribe. For more information on each parameter and which combinations are valid, refer to the StartStreamTranscription API in the Amazon Transcribe Developer Guide.

Important

Amazon Chime SDK live transcription is powered by Amazon Transcribe. Use of Amazon Transcribe is subject to the AWS Service Terms, including the terms specific to the AWS Machine Learning and Artificial Intelligence Services.

Request Syntax


POST /meetings/MeetingId/transcription?operation=start HTTP/1.1
Content-type: application/json

{
   "TranscriptionConfiguration": { 
      "EngineTranscribeMedicalSettings": { 
         "ContentIdentificationType": "string",
         "LanguageCode": "string",
         "Region": "string",
         "Specialty": "string",
         "Type": "string",
         "VocabularyName": "string"
      },
      "EngineTranscribeSettings": { 
         "ContentIdentificationType": "string",
         "ContentRedactionType": "string",
         "EnablePartialResultsStabilization": boolean,
         "IdentifyLanguage": boolean,
         "LanguageCode": "string",
         "LanguageModelName": "string",
         "LanguageOptions": "string",
         "PartialResultsStability": "string",
         "PiiEntityTypes": "string",
         "PreferredLanguage": "string",
         "Region": "string",
         "VocabularyFilterMethod": "string",
         "VocabularyFilterName": "string",
         "VocabularyFilterNames": "string",
         "VocabularyName": "string",
         "VocabularyNames": "string"
      }
   }
}

URI Request Parameters

The request uses the following URI parameters.

MeetingId

The unique ID of the meeting being transcribed.

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: Yes

Request Body

The request accepts the following data in JSON format.

TranscriptionConfiguration

The configuration for the current transcription operation. Must contain EngineTranscribeSettings or EngineTranscribeMedicalSettings.

Type: TranscriptionConfiguration object

Required: Yes

Response Syntax


HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

LimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottlingException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedException

The user isn't authorized to request a resource.

HTTP Status Code: 401

UnprocessableEntityException

The request was well-formed but was unable to be followed due to semantic errors.

HTTP Status Code: 422