costoptimizationhub/aws.sdk.kotlin.services.costoptimizationhub.model/ListEfficiencyMetricsRequest/Builder

Builder

Properties

The time granularity for the cost efficiency metrics. Specify Daily for metrics aggregated by day, or Monthly for metrics aggregated by month.

groupBy

var groupBy: String?

The dimension by which to group the cost efficiency metrics. Valid values include account ID, Amazon Web Services Region. When no grouping is specified, metrics are aggregated across all resources in the specified time period.

maxResults

var maxResults: Int?

The maximum number of groups to return in the response. Valid values range from 0 to 1000. Use in conjunction with nextToken to paginate through results when the total number of groups exceeds this limit.

nextToken

var nextToken: String?

The token to retrieve the next page of results. This value is returned in the response when the number of groups exceeds the specified maxResults value.

orderBy

var orderBy: OrderBy?

The ordering specification for the results. Defines which dimension to sort by and whether to sort in ascending or descending order.

timePeriod

var timePeriod: TimePeriod?

The time period for which to retrieve the cost efficiency metrics. The start date is inclusive and the end date is exclusive. Dates can be specified in either YYYY-MM-DD format or YYYY-MM format depending on the desired granularity.

Functions

orderBy

fun orderBy(block: OrderBy.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.costoptimizationhub.model.OrderBy inside the given block

timePeriod

fun timePeriod(block: TimePeriod.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.costoptimizationhub.model.TimePeriod inside the given block