cloudtrail/aws.sdk.kotlin.services.cloudtrail.model/ListInsightsMetricDataRequest/Builder

Builder

Properties

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

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.

errorCode

var errorCode: String?

Conditionally required if the InsightType parameter is set to ApiErrorRateInsight.

eventName

var eventName: String?

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

eventSource

var eventSource: String?

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

insightType

var insightType: InsightType?

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.

maxResults

var maxResults: Int?

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

nextToken

var nextToken: String?

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

period

var period: Int?

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.

startTime

var startTime: Instant?

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

trailName

var trailName: String?

The Amazon Resource Name(ARN) or name of the trail for which you want to retrieve Insights metrics data. This parameter should only be provided to fetch Insights metrics data generated on trails logging data events. This parameter is not required for Insights metric data generated on trails logging management events.