GetLogEventsRequest Class | AWS SDK for .NET V3

Container for the parameters to the GetLogEvents operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.CloudWatchLogs.AmazonCloudWatchLogsRequest
      Amazon.CloudWatchLogs.Model.GetLogEventsRequest

Namespace: Amazon.CloudWatchLogs.Model
Assembly: AWSSDK.CloudWatchLogs.dll
Version: 3.x.y.z

Syntax

public class GetLogEventsRequest : AmazonCloudWatchLogsRequest
         IAmazonWebServiceRequest

The GetLogEventsRequest type exposes the following members

Constructors

	Name	Description
	GetLogEventsRequest()	Empty constructor used to set properties independently even when a simple constructor is available
	GetLogEventsRequest(string, string)	Instantiates GetLogEventsRequest with the parameterized properties

Properties

Name	Type	Description
EndTime	System.DateTime	Gets and sets the property 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 equal to or later than this time are not included.
Limit	System.Int32	Gets and sets the property Limit. The maximum number of log events returned. If you don't specify a limit, the default is as many log events as can fit in a response size of 1 MB (up to 10,000 log events).
LogGroupIdentifier	System.String	Gets and sets the property LogGroupIdentifier. Specify either the name or ARN of the log group to view events from. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN. You must include either `logGroupIdentifier` or `logGroupName`, but not both.
LogGroupName	System.String	Gets and sets the property LogGroupName. The name of the log group. You must include either `logGroupIdentifier` or `logGroupName`, but not both.
LogStreamName	System.String	Gets and sets the property LogStreamName. The name of the log stream.
NextToken	System.String	Gets and sets the property NextToken. The token for the next set of items to return. (You received this token from a previous call.)
StartFromHead	System.Boolean	Gets and sets the property StartFromHead. If the value is true, the earliest log events are returned first. If the value is false, the latest log events are returned first. The default value is false. If you are using a previous `nextForwardToken` value as the `nextToken` in this operation, you must specify `true` for `startFromHead`.
StartTime	System.DateTime	Gets and sets the property 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 equal to this time or later than this time are included. Events with a timestamp earlier than this time are not included.
Unmask	System.Boolean	Gets and sets the property Unmask. Specify `true` to display the log event fields with all sensitive data unmasked and visible. The default is `false`. To use this operation with this parameter, you must be signed into an account with the `logs:Unmask` permission.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5