View API Gateway log events in the CloudWatch console
The following section explains the necessary prerequisites and how to view API Gateway log events in the CloudWatch console.
Prerequisites
-
You must have an API created in API Gateway. Follow the instructions in Develop REST APIs in API Gateway.
-
You must have the API deployed and invoked at least once. Follow the instructions in Deploy REST APIs in API Gateway and Invoke REST APIs in API Gateway.
-
You must have CloudWatch Logs enabled for a stage. Follow the instructions in Set up CloudWatch logging for REST APIs in API Gateway.
To view logged API requests and responses using the CloudWatch console
Open the CloudWatch console at https://console.aws.amazon.com/cloudwatch/
. -
If necessary, change the AWS Region. From the navigation bar, select the Region where your AWS resources reside. For more information, see Regions and Endpoints.
-
In the navigation pane, choose Logs, Log groups.
-
Under the Log Groups table, choose a log group of the API-Gateway-Execution-Logs_{rest-api-id}/{stage-name} name.
-
Under the Log Streams table, choose a log stream. You can use the timestamp to help locate the log stream of your interest.
-
Choose Text to view raw text or choose Row to view the event row by row.
Important
CloudWatch lets you delete log groups or streams. Do not manually delete API Gateway API log groups or streams; let API Gateway manage these resources. Manually deleting log groups or streams may cause API requests and responses not to be logged. If that happens, you can delete the entire log group for the API and redeploy the API. This is because API Gateway creates log groups or log streams for an API stage at the time when it is deployed.
