Skip to content

Commit cec8cda

Browse files
authored
Update README.md
1 parent f45789d commit cec8cda

File tree

1 file changed

+8
-17
lines changed

1 file changed

+8
-17
lines changed

apigw-lambda-transcribe-sam-js/README.md

Lines changed: 8 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# Amazon API Gateway to AWS Lambda to Amazon Transcribe using AWS SAM
1+
# Amazon AS3 to AWS Lambda to Amazon Transcribe using AWS SAM
22

3-
This pattern facilitates audio transcription by using Amazon Transcribe service through a serverless API endpoint. When audio files are uploaded to S3, they can be transcribed using Amazon Transcribe via an API Gateway endpoint backed by Lambda.
3+
This pattern facilitates automatic audio transcription by using the Amazon Transcribe service through a serverless event-driven architecture. When audio files are uploaded to S3, they are automatically transcribed using Amazon Transcribe via a Lambda function triggered by S3 events.
44

5-
This pattern enables speech-to-text transcription use cases by providing a serverless API endpoint that can process audio files stored in S3. The pattern uses AWS Lambda to coordinate with Amazon Transcribe service, making it easy to integrate transcription capabilities into your applications.
5+
This pattern enables speech-to-text transcription use cases by providing a serverless event-based pipeline that can process audio files uploaded to S3. The pattern uses AWS Lambda to coordinate with the Amazon Transcribe service, making it easy to integrate transcription capabilities into your applications without the need to manage infrastructure or manually initiate transcription jobs.
66

77
Important: this application uses various AWS services and there are costs associated with these services after the Free Tier usage - please see the [AWS Pricing page](https://aws.amazon.com/pricing/) for details. You are responsible for any AWS costs incurred. No warranty is implied in this example.
88

@@ -21,7 +21,7 @@ Important: this application uses various AWS services and there are costs associ
2121
```
2222
1. Change directory to the pattern directory:
2323
```
24-
cd apigw-lambda-transcribe-sam-js
24+
cd lambda-transcribe-sam-js
2525
```
2626
1. From the command line, use AWS SAM to deploy the AWS resources for the pattern as specified in the template.yaml file:
2727
```
@@ -54,21 +54,12 @@ To test the deployed API endpoint:
5454
aws s3 cp audio.mp3 s3://your-bucket-name/
5555
```
5656
2. Get the S3 URL of the uploaded audio file
57-
3. Make a POST request to the API Gateway endpoint with the following JSON payload:
57+
3. You can list all transcription jobs using:
5858
5959
```bash
60-
curl -X POST https://your-api-endpoint/Prod/transcribe \
61-
-H "Content-Type: application/json" \
62-
-d '{"audio_url": "s3://your-bucket-name/audio.mp3"}'
60+
aws transcribe list-transcription-jobs
6361
```
64-
4. The API will return a response with the transcription job name and status
65-
```json
66-
{
67-
"job_name": "transcribe-12345678-1234-5678-1234-567812345678",
68-
"status": "IN_PROGRESS"
69-
}
70-
```
71-
5. You can check the transcription results in the S3 bucket once the job is complete:
62+
4. You can check the transcription results in the S3 bucket once the job is complete:
7263

7364
```bash
7465
aws transcribe get-transcription-job --transcription-job-name "job-name-from-response"
@@ -83,4 +74,4 @@ aws transcribe get-transcription-job --transcription-job-name "job-name-from-res
8374
----
8475
Copyright 2025 Amazon.com, Inc. or its affiliates. All Rights Reserved.
8576

86-
SPDX-License-Identifier: MIT-0
77+
SPDX-License-Identifier: MIT-0

0 commit comments

Comments
 (0)