Skip to content

List Available Resource Dimensions

pi_list_available_resource_dimensions R Documentation

Retrieve the dimensions that can be queried for each specified metric type on a specified DB instance

Description

Retrieve the dimensions that can be queried for each specified metric type on a specified DB instance.

Usage

pi_list_available_resource_dimensions(ServiceType, Identifier, Metrics,
  MaxResults, NextToken, AuthorizedActions)

Arguments

ServiceType

[required] The Amazon Web Services service for which Performance Insights returns metrics.

Identifier

[required] An immutable identifier for a data source that is unique within an Amazon Web Services Region. Performance Insights gathers metrics from this data source. To use an Amazon RDS DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VWZ.

Metrics

[required] The types of metrics for which to retrieve dimensions. Valid values include db.load.

MaxResults

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.

NextToken

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.

AuthorizedActions

The actions to discover the dimensions you are authorized to access. If you specify multiple actions, then the response will contain the dimensions common for all the actions.

When you don't specify this request parameter or provide an empty list, the response contains all the available dimensions for the target database engine whether or not you are authorized to access them.

Value

A list with the following syntax: 

list(
  MetricDimensions = list(
    list(
      Metric = "string",
      Groups = list(
        list(
          Group = "string",
          Dimensions = list(
            list(
              Identifier = "string"
            )
          )
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_available_resource_dimensions(
  ServiceType = "RDS"|"DOCDB",
  Identifier = "string",
  Metrics = list(
    "string"
  ),
  MaxResults = 123,
  NextToken = "string",
  AuthorizedActions = list(
    "DescribeDimensionKeys"|"GetDimensionKeyDetails"|"GetResourceMetrics"
  )
)