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 DescribeLogStreams operation. Lists the log streams for the specified log group. You can list all the log streams or filter the results by prefix. You can also control how the results are ordered.

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.

This operation has a limit of 25 transactions per second, after which transactions are throttled.

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.

Inheritance Hierarchy

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

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

Syntax

C# 
public class DescribeLogStreamsRequest : AmazonCloudWatchLogsRequest
         IAmazonWebServiceRequest

The DescribeLogStreamsRequest type exposes the following members

Constructors

NameDescription
Public Method DescribeLogStreamsRequest()

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

Public Method DescribeLogStreamsRequest(string)

Instantiates DescribeLogStreamsRequest with the parameterized properties

Properties

NameTypeDescription
Public Property Descending System.Boolean

Gets and sets the property Descending.

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.

Public Property Limit System.Int32

Gets and sets the property Limit.

The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

Public Property LogGroupIdentifier System.String

Gets and sets the property LogGroupIdentifier.

Specify either the name or ARN of the log group to view. 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.

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

Public Property LogStreamNamePrefix System.String

Gets and sets the property LogStreamNamePrefix.

The prefix to match.

If orderBy is LastEventTime, you cannot specify this parameter.

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 OrderBy Amazon.CloudWatchLogs.OrderBy

Gets and sets the property OrderBy.

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.

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