Class FilterLogEventsCommandProtected

Lists log events from the specified log group. You can list all the log events or filter the results using a filter pattern, a time range, and the name of the log stream.

You must have the logs:FilterLogEvents permission to perform this operation.

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.

By default, this operation returns as many log events as can fit in 1 MB (up to 10,000 log events) or all the events found within the specified time range. If the results include a token, that means there are more log events available. You can get additional results by specifying the token in a subsequent call. This operation can return empty results while there are more log events available through the token.

The returned log events are sorted by event timestamp, the timestamp when the event was ingested by CloudWatch Logs, and the ID of the PutLogEvents request.

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.

Example

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

import { CloudWatchLogsClient, FilterLogEventsCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import
// const { CloudWatchLogsClient, FilterLogEventsCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import
const client = new CloudWatchLogsClient(config);
const input = { // FilterLogEventsRequest
  logGroupName: "STRING_VALUE",
  logGroupIdentifier: "STRING_VALUE",
  logStreamNames: [ // InputLogStreamNames
    "STRING_VALUE",
  ],
  logStreamNamePrefix: "STRING_VALUE",
  startTime: Number("long"),
  endTime: Number("long"),
  filterPattern: "STRING_VALUE",
  nextToken: "STRING_VALUE",
  limit: Number("int"),
  interleaved: true || false,
  unmask: true || false,
};
const command = new FilterLogEventsCommand(input);
const response = await client.send(command);
// { // FilterLogEventsResponse
//   events: [ // FilteredLogEvents
//     { // FilteredLogEvent
//       logStreamName: "STRING_VALUE",
//       timestamp: Number("long"),
//       message: "STRING_VALUE",
//       ingestionTime: Number("long"),
//       eventId: "STRING_VALUE",
//     },
//   ],
//   searchedLogStreams: [ // SearchedLogStreams
//     { // SearchedLogStream
//       logStreamName: "STRING_VALUE",
//       searchedCompletely: true || false,
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

Param

FilterLogEventsCommandInput

Returns

FilterLogEventsCommandOutput

See

• FilterLogEventsCommandInput for command's input shape.
• FilterLogEventsCommandOutput 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.