Class GetLogEventsCommandProtected

Lists log events from the specified log stream. You can list all of the log events or filter using a time range.

By default, this operation returns as many log events as can fit in a response size of 1MB (up to 10,000 log events). You can get additional log events by specifying one of the tokens in a subsequent call. This operation can return empty results while there are more log events available through the token.

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.

You can specify the log group to search by using either logGroupIdentifier or logGroupName. You must include one of these two parameters, but you can't include both.

Example

Use a bare-bones client and the command you need to make an API call.

import { CloudWatchLogsClient, GetLogEventsCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import
// const { CloudWatchLogsClient, GetLogEventsCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import
const client = new CloudWatchLogsClient(config);
const input = { // GetLogEventsRequest
  logGroupName: "STRING_VALUE",
  logGroupIdentifier: "STRING_VALUE",
  logStreamName: "STRING_VALUE", // required
  startTime: Number("long"),
  endTime: Number("long"),
  nextToken: "STRING_VALUE",
  limit: Number("int"),
  startFromHead: true || false,
  unmask: true || false,
};
const command = new GetLogEventsCommand(input);
const response = await client.send(command);
// { // GetLogEventsResponse
//   events: [ // OutputLogEvents
//     { // OutputLogEvent
//       timestamp: Number("long"),
//       message: "STRING_VALUE",
//       ingestionTime: Number("long"),
//     },
//   ],
//   nextForwardToken: "STRING_VALUE",
//   nextBackwardToken: "STRING_VALUE",
// };

Param

GetLogEventsCommandInput

Returns

GetLogEventsCommandOutput

See

• GetLogEventsCommandInput for command's input shape.
• GetLogEventsCommandOutput for command's response shape.
• config for CloudWatchLogsClient's config shape.

Throws

InvalidParameterException (client fault)

A parameter is specified incorrectly.

Throws

ResourceNotFoundException (client fault)

The specified resource does not exist.

Throws

ServiceUnavailableException (server fault)

The service cannot complete the request.

Throws

CloudWatchLogsServiceException

Base exception class for all service exceptions from CloudWatchLogs service.