AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the GetLogEvents operation. Lists log events from the specified log stream. You can list all 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.

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

C#
public class GetLogEventsRequest : AmazonCloudWatchLogsRequest
         IAmazonWebServiceRequest

The GetLogEventsRequest type exposes the following members

Constructors

NameDescription
Public Method GetLogEventsRequest()

Empty constructor used to set properties independently even when a simple constructor is available

Public Method GetLogEventsRequest(string, string)

Instantiates GetLogEventsRequest with the parameterized properties

Properties

NameTypeDescription
Public Property 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 time stamp later than this time are not included.

Public Property Limit System.Int32

Gets and sets the property Limit.

The maximum number of log events returned. If you don't specify a value, the maximum is as many log events as can fit in a response size of 1 MB, up to 10,000 log events.

Public Property LogGroupName System.String

Gets and sets the property LogGroupName.

The name of the log group.

Public Property LogStreamName System.String

Gets and sets the property LogStreamName.

The name of the log stream.

Public Property 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.)

Public Property 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.

Public Property 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 time stamp earlier than this time are not included.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms