Amazon CloudWatch Logs
API Reference (API Version 2014-03-28)

FilterLogEvents

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.

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 time range that you specify. If the results include a token, then there are more log events available, and you can get additional results by specifying the token in a subsequent call.

Request Syntax

{ "endTime": number, "filterPattern": "string", "interleaved": boolean, "limit": number, "logGroupName": "string", "logStreamNamePrefix": "string", "logStreamNames": [ "string" ], "nextToken": "string", "startTime": number }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

endTime

The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than this time are not returned.

Type: Long

Valid Range: Minimum value of 0.

Required: No

filterPattern

The filter pattern to use. For more information, see Filter and Pattern Syntax.

If not provided, all the events are matched.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Required: No

interleaved

If the value is true, the operation makes a best effort to provide responses that contain events from multiple log streams within the log group, interleaved in a single response. If the value is false, all the matched log events in the first log stream are searched first, then those in the next log stream, and so on. The default is false.

Type: Boolean

Required: No

limit

The maximum number of events to return. The default is 10,000 events.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 10000.

Required: No

logGroupName

The name of the log group to search.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: [\.\-_/#A-Za-z0-9]+

Required: Yes

logStreamNamePrefix

Filters the results to include only events from log streams that have names starting with this prefix.

If you specify a value for both logStreamNamePrefix and logStreamNames, but the value for logStreamNamePrefix does not match any log stream names specified in logStreamNames, the action returns an InvalidParameterException error.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: [^:*]*

Required: No

logStreamNames

Filters the results to only logs from the log streams in this list.

If you specify a value for both logStreamNamePrefix and logStreamNames, the action returns an InvalidParameterException error.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: [^:*]*

Required: No

nextToken

The token for the next set of events to return. (You received this token from a previous call.)

Type: String

Length Constraints: Minimum length of 1.

Required: No

startTime

The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp before this time are not returned.

Type: Long

Valid Range: Minimum value of 0.

Required: No

Response Syntax

{ "events": [ { "eventId": "string", "ingestionTime": number, "logStreamName": "string", "message": "string", "timestamp": number } ], "nextToken": "string", "searchedLogStreams": [ { "logStreamName": "string", "searchedCompletely": boolean } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

events

The matched events.

Type: Array of FilteredLogEvent objects

nextToken

The token to use when requesting the next set of items. The token expires after 24 hours.

Type: String

Length Constraints: Minimum length of 1.

searchedLogStreams

Indicates which log streams have been searched and whether each has been searched completely.

Type: Array of SearchedLogStream objects

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidParameterException

A parameter is specified incorrectly.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource does not exist.

HTTP Status Code: 400

ServiceUnavailableException

The service cannot complete the request.

HTTP Status Code: 500

Example

To list the events in a log group that contain a pattern

The following example lists the events for the specified log group that contain 'ERROR'.

Sample Request

POST / HTTP/1.1 Host: logs.<region>.<domain> X-Amz-Date: <DATE> Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature> User-Agent: <UserAgentString> Accept: application/json Content-Type: application/x-amz-json-1.1 Content-Length: <PayloadSizeBytes> Connection: Keep-Alive X-Amz-Target: Logs_20140328.FilterLogEvents { "logGroupName": "my-log-group", "filterPattern": "ERROR" }

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: <RequestId> Content-Type: application/x-amz-json-1.1 Content-Length: <PayloadSizeBytes> Date: <Date> { "events": [ { "ingestionTime": 1396035394997, "timestamp": 1396035378988, "message": "ERROR Event 1", "logStreamName": "my-log-stream-1", "eventId": "31132629274945519779805322857203735586714454643391594505" }, { "ingestionTime": 1396035394997, "timestamp": 1396035378988, "message": "ERROR Event 2", "logStreamName": "my-log-stream-2", "eventId": "31132629274945519779805322857203735586814454643391594505" }, { "ingestionTime": 1396035394997, "timestamp": 1396035378989, "message": "ERROR Event 3", "logStreamName": "my-log-stream-3" "eventId": "31132629274945519779805322857203735586824454643391594505" } ], "searchedLogStreams": [ { "searchedCompletely": true, "logStreamName": "my-log-stream-1" }, { "searchedCompletely": true, "logStreamName": "my-log-stream-2" }, { "searchedCompletely": false, "logStreamName": "my-log-stream-3" }, ], "nextToken": "ZNUEPl7FcQuXbIH4Swk9D9eFu2XBg-ijZIZlvzz4ea9zZRjw-MMtQtvcoMdmq4T29K7Q6Y1e_KvyfpcT_f_tUw" }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: