paws.management: cloudwatchlogs_describe_log_streams – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

cloudwatchlogs_describe_log_streams

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.

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

Usage

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

Arguments

`logGroupName`	[required] The name of the log group.
`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",
  logStreamNamePrefix = "string",
  orderBy = "LogStreamName"|"LastEventTime",
  descending = TRUE|FALSE,
  nextToken = "string",
  limit = 123
)

paws.management

Amazon Web Services Management & Governance Services

v0.1.11

Apache License (>= 2.0)

Authors

David Kretch [aut, cre], Adam Banker [aut], Amazon.com, Inc. [cph]

Initial release