You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::CloudWatchLogs::Types::DescribeLogStreamsRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::CloudWatchLogs::Types::DescribeLogStreamsRequest
- Defined in:
- (unknown)
Overview
When passing DescribeLogStreamsRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
log_group_name: "LogGroupName", # required
log_stream_name_prefix: "LogStreamName",
order_by: "LogStreamName", # accepts LogStreamName, LastEventTime
descending: false,
next_token: "NextToken",
limit: 1,
}
Instance Attribute Summary collapse
-
#descending ⇒ Boolean
If the value is true, results are returned in descending order.
-
#limit ⇒ Integer
The maximum number of items returned.
-
#log_group_name ⇒ String
The name of the log group.
-
#log_stream_name_prefix ⇒ String
The prefix to match.
-
#next_token ⇒ String
The token for the next set of items to return.
-
#order_by ⇒ String
If the value is
LogStreamName
, the results are ordered by log stream name.
Instance Attribute Details
#descending ⇒ Boolean
If the value is true, results are returned in descending order. If the value is to false, results are returned in ascending order. The default value is false.
#limit ⇒ Integer
The maximum number of items returned. If you don\'t specify a value, the default is up to 50 items.
#log_group_name ⇒ String
The name of the log group.
#log_stream_name_prefix ⇒ String
The prefix to match.
If orderBy
is LastEventTime
, you cannot specify this parameter.
#next_token ⇒ String
The token for the next set of items to return. (You received this token from a previous call.)
#order_by ⇒ String
If the value is LogStreamName
, the results are ordered by log stream
name. If the value is LastEventTime
, the results are ordered by the
event time. The default value is LogStreamName
.
If you order the results by event time, you cannot specify the
logStreamNamePrefix
parameter.
lastEventTimeStamp
represents the time of the most recent log event in
the log stream in CloudWatch Logs. This number is expressed as the
number of milliseconds after Jan 1, 1970 00:00:00 UTC.
lastEventTimeStamp
updates on an eventual consistency basis. It
typically updates in less than an hour from ingestion, but in rare
situations might take longer.
Possible values:
- LogStreamName
- LastEventTime