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

This API is no longer supported and will not be updated. We recommend using the latest version, StartMeetingTranscription, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
By default, Amazon Transcribe may use and store audio content processed by the service to develop and improve AWS AI/ML services as further described in section 50 of the AWS Service Terms. Using Amazon Transcribe may be subject to federal and state laws or regulations regarding the recording or interception of electronic communications. It is your and your end users’ responsibility to comply with all applicable laws regarding the recording, including properly notifying all participants in a recorded session or communication that the session or communication is being recorded, and obtaining all necessary consents. You can opt out from AWS using audio content to develop and improve AWS AI/ML services by configuring an AI services opt out policy using AWS Organizations.

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

NotFoundException

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

HTTP Status Code: 404

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

UnprocessableEntityException

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

HTTP Status Code: 422