pi/aws.sdk.kotlin.services.pi.model/DescribeDimensionKeysRequest/Builder

Builder

Properties

Additional metrics for the top N dimension keys. If the specified dimension group in the GroupBy parameter is db.sql_tokenized, you can specify per-SQL metrics to get the values for the top N SQL digests. The response syntax is as follows: "AdditionalMetrics" : { "<i>string</i>" : "<i>string</i>" }.

endTime

var endTime: Instant?

The date and time specifying the end of the requested time series data. The value specified is exclusive, which means that data points less than (but not equal to) EndTime are returned.

filter

var filter: Map<String, String>?

One or more filters to apply in the request. Restrictions:

groupBy

var groupBy: DimensionGroup?

A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights returns all dimensions within this group, unless you provide the names of specific dimensions within this group. You can also request that Performance Insights return a limited number of values for a dimension.

identifier

var identifier: String?

An immutable, Amazon Web Services Region-unique identifier for a data source. Performance Insights gathers metrics from this data source.

maxResults

var maxResults: Int?

The maximum number of items to return in the response. If more items exist than the specified MaxRecords value, a pagination token is included in the response so that the remaining results can be retrieved.

metric

var metric: String?

The name of a Performance Insights metric to be measured.

nextToken

var nextToken: String?

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxRecords.

partitionBy

var partitionBy: DimensionGroup?

For each dimension specified in GroupBy, specify a secondary dimension to further subdivide the partition keys in the response.

periodInSeconds

var periodInSeconds: Int?

The granularity, in seconds, of the data points returned from Performance Insights. A period can be as short as one second, or as long as one day (86400 seconds). Valid values are:

serviceType

var serviceType: ServiceType?

The Amazon Web Services service for which Performance Insights will return metrics. Valid values are as follows:

startTime

var startTime: Instant?

The date and time specifying the beginning of the requested time series data. You must specify a StartTime within the past 7 days. The value specified is inclusive, which means that data points equal to or greater than StartTime are returned.

Functions

groupBy

fun groupBy(block: DimensionGroup.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.pi.model.DimensionGroup inside the given block

partitionBy

fun partitionBy(block: DimensionGroup.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.pi.model.DimensionGroup inside the given block