Skip to content

LiveTailSessionStart

Source code in docs_src/capo_cloudwatch_logs/types/live_tail_session_start.py
class LiveTailSessionStart(TypedDict, closed=True):
    request_id: NotRequired["capo_cloudwatch_logs.types.request_id.RequestId"]
    """<p>The unique ID generated by CloudWatch Logs to identify this Live Tail session request.</p>"""
    session_id: NotRequired["capo_cloudwatch_logs.types.session_id.SessionId"]
    """<p>The unique ID generated by CloudWatch Logs to identify this Live Tail session.</p>"""
    log_group_identifiers: NotRequired[
        "capo_cloudwatch_logs.types.start_live_tail_log_group_identifiers.StartLiveTailLogGroupIdentifiers"
    ]
    """<p>An array of the names and ARNs of the log groups included in this Live Tail session.</p>"""
    log_stream_names: NotRequired[
        "capo_cloudwatch_logs.types.input_log_stream_names.InputLogStreamNames"
    ]
    """<p>If your StartLiveTail operation request included a <code>logStreamNames</code> parameter that filtered the session to only include certain log streams, these streams are listed here.</p>"""
    log_stream_name_prefixes: NotRequired[
        "capo_cloudwatch_logs.types.input_log_stream_names.InputLogStreamNames"
    ]
    """<p>If your StartLiveTail operation request included a <code>logStreamNamePrefixes</code> parameter that filtered the session to only include log streams that have names that start with certain prefixes, these prefixes are listed here.</p>"""
    log_event_filter_pattern: NotRequired[
        "capo_cloudwatch_logs.types.filter_pattern.FilterPattern"
    ]
    """<p>An optional pattern to filter the results to include only log events that match the pattern. For example, a filter pattern of <code>error 404</code> displays only log events that include both <code>error</code> and <code>404</code>.</p> <p>For more information about filter pattern syntax, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html">Filter and Pattern Syntax</a>.</p>"""

log_event_filter_pattern instance-attribute

log_event_filter_pattern: NotRequired[FilterPattern]

An optional pattern to filter the results to include only log events that match the pattern. For example, a filter pattern of error 404 displays only log events that include both error and 404.

For more information about filter pattern syntax, see Filter and Pattern Syntax.

log_group_identifiers instance-attribute

log_group_identifiers: NotRequired[StartLiveTailLogGroupIdentifiers]

An array of the names and ARNs of the log groups included in this Live Tail session.

log_stream_name_prefixes instance-attribute

log_stream_name_prefixes: NotRequired[InputLogStreamNames]

If your StartLiveTail operation request included a logStreamNamePrefixes parameter that filtered the session to only include log streams that have names that start with certain prefixes, these prefixes are listed here.

log_stream_names instance-attribute

log_stream_names: NotRequired[InputLogStreamNames]

If your StartLiveTail operation request included a logStreamNames parameter that filtered the session to only include certain log streams, these streams are listed here.

request_id instance-attribute

request_id: NotRequired[RequestId]

The unique ID generated by CloudWatch Logs to identify this Live Tail session request.

session_id instance-attribute

session_id: NotRequired[SessionId]

The unique ID generated by CloudWatch Logs to identify this Live Tail session.