AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . logs ]

start-live-tail

Description

Starts a Live Tail streaming session for one or more log groups. A Live Tail session provides a near real-time streaming of log events as they are ingested into selected log groups. A session can go on for a maximum of 3 hours.

You must have logs:StartLiveTail permission to perform this operation. If the log events matching the filters are more than 500 events per second, we sample the events to provide the real-time tailing experience.

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and start tailing on Log Group(s) present in the linked source accounts. For more information, see https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html.

Live Tail sessions incur charges by session usage time, per minute. For pricing details, please refer to https://aws.amazon.com/cloudwatch/pricing/.

Synopsis

  start-live-tail
--log-group-identifiers <value> [<value>...]
[--log-stream-names <value> [<value>...]]
[--log-stream-name-prefixes <value> [<value>...]]
[--log-event-filter-pattern <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--log-group-identifiers (list) The Log Group Identifiers are the ARNs for the CloudWatch Logs groups to tail. You can provide up to 10 Log Group Identifiers. Logs can be filtered by Log Stream(s) by providing --log-stream-names or --log-stream-name-prefixes. If more than one Log Group is provided --log-stream-names and --log-stream-name-prefixes is disabled. --log-stream-names and --log-stream-name-prefixes can't be provided simultaneously. Note - The Log Group ARN must be in the following format. Replace REGION and ACCOUNT_ID with your Region and account ID. arn:aws:logs:REGION :ACCOUNT_ID :log-group:LOG_GROUP_NAME. A :* after the ARN is prohibited.For more information about ARN format, see CloudWatch Logs resources and operations .(string)

Syntax:

"string" "string" ...

--log-stream-names (list) The list of stream names to filter logs by. This parameter cannot be specified when --log-stream-name-prefixes are also specified. This parameter cannot be specified when multiple log-group-identifiers are specified(string)

Syntax:

"string" "string" ...

--log-stream-name-prefixes (list) The prefix to filter logs by. Only events from log streams with names beginning with this prefix will be returned. This parameter cannot be specified when --log-stream-names is also specified. This parameter cannot be specified when multiple log-group-identifiers are specified(string)

Syntax:

"string" "string" ...

--log-event-filter-pattern (string) The filter pattern to use. See Filter and Pattern Syntax for details. If not provided, all the events are matched. This option can be used to include or exclude log events patterns. Additionally, when multiple filter patterns are provided, they must be encapsulated by quotes.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.