Skip to content

List Insights Metric Data

cloudtrail_list_insights_metric_data R Documentation

Returns Insights metrics data for trails that have enabled Insights

Description

Returns Insights metrics data for trails that have enabled Insights. The request must include the EventSource, EventName, and InsightType parameters.

If the InsightType is set to ApiErrorRateInsight, the request must also include the ErrorCode parameter.

The following are the available time periods for list_insights_metric_data. Each cutoff is inclusive.

  • Data points with a period of 60 seconds (1-minute) are available for 15 days.

  • Data points with a period of 300 seconds (5-minute) are available for 63 days.

  • Data points with a period of 3600 seconds (1 hour) are available for 90 days.

Access to the list_insights_metric_data API operation is linked to the cloudtrail:LookupEvents action. To use this operation, you must have permissions to perform the cloudtrail:LookupEvents action.

Usage

cloudtrail_list_insights_metric_data(EventSource, EventName,
  InsightType, ErrorCode, StartTime, EndTime, Period, DataType,
  MaxResults, NextToken)

Arguments

EventSource

[required] The Amazon Web Services service to which the request was made, such as iam.amazonaws.com or s3.amazonaws.com.

EventName

[required] The name of the event, typically the Amazon Web Services API on which unusual levels of activity were recorded.

InsightType

[required] The type of CloudTrail Insights event, which is either ApiCallRateInsight or ApiErrorRateInsight. The ApiCallRateInsight Insights type analyzes write-only management API calls that are aggregated per minute against a baseline API call volume. The ApiErrorRateInsight Insights type analyzes management API calls that result in error codes.

ErrorCode

Conditionally required if the InsightType parameter is set to ApiErrorRateInsight.

If returning metrics for the ApiErrorRateInsight Insights type, this is the error to retrieve data for. For example, AccessDenied.

StartTime

Specifies, in UTC, the start time for time-series data. The value specified is inclusive; results include data points with the specified time stamp.

The default is 90 days before the time of request.

EndTime

Specifies, in UTC, the end time for time-series data. The value specified is exclusive; results include data points up to the specified time stamp.

The default is the time of request.

Period

Granularity of data to retrieve, in seconds. Valid values are 60, 300, and 3600. If you specify any other value, you will get an error. The default is 3600 seconds.

DataType

Type of datapoints to return. Valid values are NonZeroData and FillWithZeros. The default is NonZeroData.

MaxResults

The maximum number of datapoints to return. Valid values are integers from 1 to 21600. The default value is 21600.

NextToken

Returned if all datapoints can't be returned in a single call. For example, due to reaching MaxResults.

Add this parameter to the request to continue retrieving results starting from the last evaluated point.

Value

A list with the following syntax: 

list(
  EventSource = "string",
  EventName = "string",
  InsightType = "ApiCallRateInsight"|"ApiErrorRateInsight",
  ErrorCode = "string",
  Timestamps = list(
    as.POSIXct(
      "2015-01-01"
    )
  ),
  Values = list(
    123.0
  ),
  NextToken = "string"
)

Request syntax

svc$list_insights_metric_data(
  EventSource = "string",
  EventName = "string",
  InsightType = "ApiCallRateInsight"|"ApiErrorRateInsight",
  ErrorCode = "string",
  StartTime = as.POSIXct(
    "2015-01-01"
  ),
  EndTime = as.POSIXct(
    "2015-01-01"
  ),
  Period = 123,
  DataType = "FillWithZeros"|"NonZeroData",
  MaxResults = 123,
  NextToken = "string"
)