[ aws . devops-guru ]

list-anomalous-log-groups

Description

Returns the list of log groups that contain log anomalies.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

list-anomalous-log-groups is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: InsightId, AnomalousLogGroups

Synopsis

  list-anomalous-log-groups
--insight-id <value>
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--insight-id (string)

The ID of the insight containing the log groups.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

InsightId -> (string)

The ID of the insight containing the log groups.

AnomalousLogGroups -> (list)

The list of Amazon CloudWatch log groups that are related to an insight.

(structure)

An Amazon CloudWatch log group that contains log anomalies and is used to generate an insight.

LogGroupName -> (string)

The name of the CloudWatch log group.

ImpactStartTime -> (timestamp)

The time the anomalous log events began. The impact start time indicates the time of the first log anomaly event that occurs.

ImpactEndTime -> (timestamp)

The time the anomalous log events stopped.

NumberOfLogLinesScanned -> (integer)

The number of log lines that were scanned for anomalous log events.

LogAnomalyShowcases -> (list)

The log anomalies in the log group. Each log anomaly displayed represents a cluster of similar anomalous log events.

(structure)

A cluster of similar anomalous log events found within a log group.

LogAnomalyClasses -> (list)

A list of anomalous log events that may be related.

(structure)

Information about an anomalous log event found within a log group.

LogStreamName -> (string)

The name of the Amazon CloudWatch log stream that the anomalous log event belongs to. A log stream is a sequence of log events that share the same source.

LogAnomalyType -> (string)

The type of log anomaly that has been detected.

LogAnomalyToken -> (string)

The token where the anomaly was detected. This may refer to an exception or another location, or it may be blank for log anomalies such as format anomalies.

LogEventId -> (string)

The ID of the log event.

Explanation -> (string)

The explanation for why the log event is considered an anomaly.

NumberOfLogLinesOccurrences -> (integer)

The number of log lines where this anomalous log event occurs.

LogEventTimestamp -> (timestamp)

The time of the first occurrence of the anomalous log event.

NextToken -> (string)

The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.