[ aws . devops-guru ]

list-events

Description

Returns a list of the events emitted by the resources that are evaluated by DevOps Guru. You can use filters to specify which events are returned.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

list-events 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: Events

Synopsis

  list-events
--filters <value>
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--filters (structure)

A ListEventsFilters object used to specify which events to return.

InsightId -> (string)

An ID of an insight that is related to the events you want to filter for.

EventTimeRange -> (structure)

A time range during which you want the filtered events to have occurred.

FromTime -> (timestamp)

The time when the event started.

ToTime -> (timestamp)

The time when the event ended.

EventClass -> (string)

The class of the events you want to filter for, such as an infrastructure change, a deployment, or a schema change.

EventSource -> (string)

The AWS source that emitted the events you want to filter for.

DataSource -> (string)

The source, AWS_CLOUD_TRAIL or AWS_CODE_DEPLOY , of the events you want returned.

ResourceCollection -> (structure)

A collection of AWS resources supported by DevOps Guru. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks.

CloudFormation -> (structure)

An array of the names of AWS CloudFormation stacks. The stacks define AWS resources that DevOps Guru analyzes.

StackNames -> (list)

An array of CloudFormation stack names.

(string)

JSON Syntax:

{
  "InsightId": "string",
  "EventTimeRange": {
    "FromTime": timestamp,
    "ToTime": timestamp
  },
  "EventClass": "INFRASTRUCTURE"|"DEPLOYMENT"|"SECURITY_CHANGE"|"CONFIG_CHANGE"|"SCHEMA_CHANGE",
  "EventSource": "string",
  "DataSource": "AWS_CLOUD_TRAIL"|"AWS_CODE_DEPLOY",
  "ResourceCollection": {
    "CloudFormation": {
      "StackNames": ["string", ...]
    }
  }
}

--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.

See ‘aws help’ for descriptions of global parameters.

Output

Events -> (list)

A list of the requested events.

(structure)

An AWS resource event. AWS resource events and metrics are analyzed by DevOps Guru to find anomalous behavior and provide recommendations to improve your operational solutions.

ResourceCollection -> (structure)

A collection of AWS resources supported by DevOps Guru. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks.

CloudFormation -> (structure)

An array of the names of AWS CloudFormation stacks. The stacks define AWS resources that DevOps Guru analyzes.

StackNames -> (list)

An array of CloudFormation stack names.

(string)

Id -> (string)

The ID of the event.

Time -> (timestamp)

A Timestamp that specifies the time the event occurred.

EventSource -> (string)

The AWS source that emitted the event.

Name -> (string)

The name of the event.

DataSource -> (string)

The source, AWS_CLOUD_TRAIL or AWS_CODE_DEPLOY , where DevOps Guru analysis found the event.

EventClass -> (string)

The class of the event. The class specifies what the event is related to, such as an infrastructure change, a deployment, or a schema change.

Resources -> (list)

An EventResource object that contains information about the resource that emitted the event.

(structure)

The AWS resource that emitted an event. AWS resource events and metrics are analyzed by DevOps Guru to find anomalous behavior and provide recommendations to improve your operational solutions.

Type -> (string)

The type of resource that emitted an event.

Name -> (string)

The name of the resource that emitted an event.

Arn -> (string)

The Amazon Resource Name (ARN) of the resource that emitted an 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.