Class DescribeLogStreamsCommandProtected

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.

Example

Use a bare-bones client and the command you need to make an API call.

import { CloudWatchLogsClient, DescribeLogStreamsCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import
// const { CloudWatchLogsClient, DescribeLogStreamsCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import
const client = new CloudWatchLogsClient(config);
const input = { // DescribeLogStreamsRequest
  logGroupName: "STRING_VALUE",
  logGroupIdentifier: "STRING_VALUE",
  logStreamNamePrefix: "STRING_VALUE",
  orderBy: "LogStreamName" || "LastEventTime",
  descending: true || false,
  nextToken: "STRING_VALUE",
  limit: Number("int"),
};
const command = new DescribeLogStreamsCommand(input);
const response = await client.send(command);
// { // DescribeLogStreamsResponse
//   logStreams: [ // LogStreams
//     { // LogStream
//       logStreamName: "STRING_VALUE",
//       creationTime: Number("long"),
//       firstEventTimestamp: Number("long"),
//       lastEventTimestamp: Number("long"),
//       lastIngestionTime: Number("long"),
//       uploadSequenceToken: "STRING_VALUE",
//       arn: "STRING_VALUE",
//       storedBytes: Number("long"),
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

Param

DescribeLogStreamsCommandInput

Returns

DescribeLogStreamsCommandOutput

See

• DescribeLogStreamsCommandInput for command's input shape.
• DescribeLogStreamsCommandOutput for command's response shape.
• config for CloudWatchLogsClient's config shape.

Throws

InvalidParameterException (client fault)

A parameter is specified incorrectly.

Throws

ResourceNotFoundException (client fault)

The specified resource does not exist.

Throws

ServiceUnavailableException (server fault)

The service cannot complete the request.

Throws

CloudWatchLogsServiceException

Base exception class for all service exceptions from CloudWatchLogs service.