awswrangler.cloudwatch.describe_log_streams¶
- awswrangler.cloudwatch.describe_log_streams(log_group_name: str, log_stream_name_prefix: str | None = None, order_by: str | None = 'LogStreamName', descending: bool | None = False, limit: int | None = 50, boto3_session: Session | None = None) DataFrame ¶
List the log streams for the specified log group, return results as a Pandas DataFrame.
- Parameters:
log_group_name (str) – The name of the log group.
log_stream_name_prefix (str) – The prefix to match log streams’ name
order_by (str) – 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 .
descending (bool) – 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 (int, optional) – The maximum number of items returned. The default is up to 50 items.
boto3_session (boto3.Session(), optional) – Boto3 Session. The default boto3 session will be used if boto3_session receive None.
- Returns:
Result as a Pandas DataFrame.
- Return type:
pandas.DataFrame
Examples
>>> import awswrangler as wr >>> df = wr.cloudwatch.describe_log_streams( ... log_group_name="aws_sdk_pandas_log_group", ... log_stream_name_prefix="aws_sdk_pandas_log_stream", ... )