Skip to content

List Metrics

resiliencehub_list_metrics R Documentation

Lists the metrics that can be exported

Description

Lists the metrics that can be exported.

Usage

resiliencehub_list_metrics(conditions, dataSource, fields, maxResults,
  nextToken, sorts)

Arguments

conditions

Indicates the list of all the conditions that were applied on the metrics.

dataSource

Indicates the data source of the metrics.

fields

Indicates the list of fields in the data source.

maxResults

Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

nextToken

Null, or the token from a previous call to get the next set of results.

sorts

(Optional) Indicates the order in which you want to sort the fields in the metrics. By default, the fields are sorted in the ascending order.

Value

A list with the following syntax:

list(
  nextToken = "string",
  rows = list(
    list(
      "string"
    )
  )
)

Request syntax

svc$list_metrics(
  conditions = list(
    list(
      field = "string",
      operator = "Equals"|"NotEquals"|"GreaterThen"|"GreaterOrEquals"|"LessThen"|"LessOrEquals",
      value = "string"
    )
  ),
  dataSource = "string",
  fields = list(
    list(
      aggregation = "Min"|"Max"|"Sum"|"Avg"|"Count",
      name = "string"
    )
  ),
  maxResults = 123,
  nextToken = "string",
  sorts = list(
    list(
      ascending = TRUE|FALSE,
      field = "string"
    )
  )
)