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

ListInsightsMetricDataRequest

class ListInsightsMetricDataRequest

Types

Builder

class Builder

Companion

object Companion

Properties

dataType

val dataType: InsightsMetricDataType?

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

endTime

val endTime: Instant?

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

val errorCode: String?

Conditionally required if the InsightType parameter is set to ApiErrorRateInsight.

eventName

val eventName: String?

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

eventSource

val eventSource: String?

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

insightType

val 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

val maxResults: Int?

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

nextToken

val nextToken: String?

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

period

val 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

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

Functions

copy

inline fun copy(block: ListInsightsMetricDataRequest.Builder.() -> Unit = {}): ListInsightsMetricDataRequest

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String