Skip to content

Describe Log Streams

cloudwatchlogs_describe_log_streams R Documentation

Lists the log streams for the specified log group

Description

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 five 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.

Usage

cloudwatchlogs_describe_log_streams(logGroupName, logGroupIdentifier,
  logStreamNamePrefix, orderBy, descending, nextToken, limit)

Arguments

logGroupName

The name of the log group.

You must include either logGroupIdentifier or logGroupName, but not both.

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.

logStreamNamePrefix

The prefix to match.

If orderBy is LastEventTime, you cannot specify this parameter.

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.

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.

nextToken

The token for the next set of items to return. (You received this token from a previous call.)

limit

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

Value

A list with the following syntax: 

list(
  logStreams = list(
    list(
      logStreamName = "string",
      creationTime = 123,
      firstEventTimestamp = 123,
      lastEventTimestamp = 123,
      lastIngestionTime = 123,
      uploadSequenceToken = "string",
      arn = "string",
      storedBytes = 123
    )
  ),
  nextToken = "string"
)

Request syntax

svc$describe_log_streams(
  logGroupName = "string",
  logGroupIdentifier = "string",
  logStreamNamePrefix = "string",
  orderBy = "LogStreamName"|"LastEventTime",
  descending = TRUE|FALSE,
  nextToken = "string",
  limit = 123
)