connect/aws.sdk.kotlin.services.connect.model/GetCurrentMetricDataRequest

GetCurrentMetricDataRequest

class GetCurrentMetricDataRequest

Types

Builder

class Builder

Companion

object Companion

Properties

currentMetrics

val currentMetrics: List<CurrentMetric>?

The metrics to retrieve. Specify the name and unit for each metric. The following metrics are available. For a description of all the metrics, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.

filters

val filters: Filters?

The filters to apply to returned metrics. You can filter up to the following limits:

groupings

val groupings: List<Grouping>?

The grouping applied to the metrics returned. For example, when grouped by QUEUE, the metrics returned apply to each queue rather than aggregated for all queues.

instanceId

val instanceId: String?

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

maxResults

val maxResults: Int?

The maximum number of results to return per page.

nextToken

val nextToken: String?

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

sortCriteria

val sortCriteria: List<CurrentMetricSortCriteria>?

The way to sort the resulting response based on metrics. You can enter one sort criteria. By default resources are sorted based on AGENTS_ONLINE, DESCENDING. The metric collection is sorted based on the input metrics.

Functions

copy

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

equals

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

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String