LiveTailSessionStart - Amazon CloudWatch Logs
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

LiveTailSessionStart

This object contains information about this Live Tail session, including the log groups included and the log stream filters, if any.

Contents

logEventFilterPattern

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.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Required: No

logGroupIdentifiers

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

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: [\w#+=/:,.@-]*

Required: No

logStreamNamePrefixes

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.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: [^:*]*

Required: No

logStreamNames

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

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: [^:*]*

Required: No

requestId

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

sessionId

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: