You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::CloudWatchLogs::Types::GetLogEventsRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::CloudWatchLogs::Types::GetLogEventsRequest
- Defined in:
- (unknown)
Overview
When passing GetLogEventsRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
log_group_name: "LogGroupName", # required
log_stream_name: "LogStreamName", # required
start_time: 1,
end_time: 1,
next_token: "NextToken",
limit: 1,
start_from_head: false,
}
Instance Attribute Summary collapse
-
#end_time ⇒ Integer
The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
-
#limit ⇒ Integer
The maximum number of log events returned.
-
#log_group_name ⇒ String
The name of the log group.
-
#log_stream_name ⇒ String
The name of the log stream.
-
#next_token ⇒ String
The token for the next set of items to return.
-
#start_from_head ⇒ Boolean
If the value is true, the earliest log events are returned first.
-
#start_time ⇒ Integer
The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
Instance Attribute Details
#end_time ⇒ Integer
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 ⇒ Integer
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.
#log_group_name ⇒ String
The name of the log group.
#log_stream_name ⇒ String
The name of the log stream.
#next_token ⇒ String
The token for the next set of items to return. (You received this token from a previous call.)
Using this token works only when you specify true
for startFromHead
.
#start_from_head ⇒ Boolean
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 nextToken
in this operation, you must specify true
for startFromHead
.
#start_time ⇒ Integer
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.