Skip to content

DescribeLogStreamsRequest

Source code in docs_src/capo_cloudwatch_logs/types/describe_log_streams_request.py
class DescribeLogStreamsRequest(TypedDict, closed=True):
    log_group_name: NotRequired[
        "capo_cloudwatch_logs.types.log_group_name.LogGroupName"
    ]
    """<p>The name of the log group.</p> <note> <p> You must include either <code>logGroupIdentifier</code> or <code>logGroupName</code>, but not both. </p> </note>"""
    log_group_identifier: NotRequired[
        "capo_cloudwatch_logs.types.log_group_identifier.LogGroupIdentifier"
    ]
    """<p>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.</p> <note> <p> You must include either <code>logGroupIdentifier</code> or <code>logGroupName</code>, but not both. </p> </note>"""
    log_stream_name_prefix: NotRequired[
        "capo_cloudwatch_logs.types.log_stream_name.LogStreamName"
    ]
    """<p>The prefix to match.</p> <p>If <code>orderBy</code> is <code>LastEventTime</code>, you cannot specify this parameter.</p>"""
    order_by: NotRequired["capo_cloudwatch_logs.types.order_by.OrderBy"]
    """<p>If the value is <code>LogStreamName</code>, the results are ordered by log stream name. If the value is <code>LastEventTime</code>, the results are ordered by the event time. The default value is <code>LogStreamName</code>.</p> <p>If you order the results by event time, you cannot specify the <code>logStreamNamePrefix</code> parameter.</p> <p> <code>lastEventTimestamp</code> 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 <code>Jan 1, 1970 00:00:00 UTC</code>. <code>lastEventTimestamp</code> updates on an eventual consistency basis. It typically updates in less than an hour from ingestion, but in rare situations might take longer.</p>"""
    descending: NotRequired["capo_cloudwatch_logs.types.descending.Descending"]
    """<p>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.</p>"""
    next_token: NotRequired["capo_cloudwatch_logs.types.next_token.NextToken"]
    """<p>The token for the next set of items to return. (You received this token from a previous call.)</p>"""
    limit: NotRequired["capo_cloudwatch_logs.types.describe_limit.DescribeLimit"]
    """<p>The maximum number of items returned. If you don't specify a value, the default is up to 50 items.</p>"""

descending instance-attribute

descending: NotRequired[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.

limit instance-attribute

limit: NotRequired[DescribeLimit]

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

log_group_identifier instance-attribute

log_group_identifier: NotRequired[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.

log_group_name instance-attribute

log_group_name: NotRequired[LogGroupName]

The name of the log group.

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

log_stream_name_prefix instance-attribute

log_stream_name_prefix: NotRequired[LogStreamName]

The prefix to match.

If orderBy is LastEventTime, you cannot specify this parameter.

next_token instance-attribute

next_token: NotRequired[NextToken]

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

order_by instance-attribute

order_by: NotRequired[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.