Skip to content

Commit fd0d301

Browse files
Updated readme docs
1 parent 06d3c4f commit fd0d301

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

apigw-kinesis-lambda-ddb/README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,10 +51,14 @@ Once the application is deployed:
5151
- Retrieve the username and password from Secrets Manager in AWS Console.
5252
- Invoke the endpoint from Postman using some json payload and verify the payload saved in DynamoDB.
5353
54-
Example POST Request: https://{RestApiEndpoint}.execute-api.us-east-1.amazonaws.com/submit/{streamName}/{eventId}
54+
Request:
55+
- Request URL: https://{RestApiEndpoint}.execute-api.us-east-1.amazonaws.com/submit/{streamName}/{eventId}
56+
- streamName - This is the name of kinesis stream created i.e., GatewayEventsStream
57+
- eventId - Value in this attribute is used to choose PartitionKey in Kinesis stream. This example uses a single shard but when multiple shards are used, this eventId should be unique to share the load with multiple shards. Example: 55ad376f-86bf-4b06-9d3a-23237464dbd4
58+
- Request Method: POST
5559
- Request Header: "Content-Type: application/json"
5660
- Request Header: "Authorization: Basic <credentials>" (where credentials is the Base64 encoding of ID and password joined by a single colon :)
57-
- Request Body: {"eventId":"value1", "message":"event message for testing"}
61+
- Request Body: {"eventId":"value1", "message":"event message for testing"} (This could be any JSON payload)
5862
5963
## Cleanup
6064

0 commit comments

Comments
 (0)