ec2/aws.sdk.kotlin.services.ec2.model/GetCapacityManagerMetricDataRequest

GetCapacityManagerMetricDataRequest

class GetCapacityManagerMetricDataRequest

Types

Builder

class Builder

Companion

object Companion

Properties

dryRun

val dryRun: Boolean?

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

endTime

val endTime: Instant?

The end time for the metric data query, in ISO 8601 format. If the end time is beyond the latest ingested data, it will be automatically adjusted to the latest available data point.

filterBy

val filterBy: List<CapacityManagerCondition>?

Conditions to filter the metric data. Each filter specifies a dimension, comparison operator ('equals', 'in'), and values to match against.

groupBy

val groupBy: List<GroupBy>?

The dimensions by which to group the metric data. This determines how the data is aggregated and returned.

maxResults

val maxResults: Int?

The maximum number of data points to return. Valid range is 1 to 100,000. Use with NextToken for pagination of large result sets.

metricNames

val metricNames: List<Metric>?

The names of the metrics to retrieve. Maximum of 10 metrics per request.

nextToken

val nextToken: String?

The token for the next page of results. Use this value in a subsequent call to retrieve additional data points.

period

val period: Int?

The granularity, in seconds, of the returned data points.

startTime

val startTime: Instant?

The start time for the metric data query, in ISO 8601 format. The time range (end time - start time) must be a multiple of the specified period.

Functions

copy

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

equals

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

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String