[ aws . pi ]

list-available-resource-dimensions

Description

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  list-available-resource-dimensions
--service-type <value>
--identifier <value>
--metrics <value>
[--max-results <value>]
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--service-type (string)

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

Possible values:

• RDS

• DOCDB

--identifier (string)

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 (list)

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

(string)

Syntax:

"string" "string" ...

--max-results (integer)

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.

--next-token (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 .

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

MetricDimensions -> (list)

The dimension information returned for requested metric types.

(structure)

The available dimension information for a metric type.

Metric -> (string)

The metric type to which the dimension information belongs.

Groups -> (list)

The available dimension groups for a metric type.

(structure)

Information about dimensions within a dimension group.

Group -> (string)

The name of the dimension group.

Dimensions -> (list)

The dimensions within a dimension group.

(structure)

The information about a dimension.

Identifier -> (string)

The identifier of a dimension.

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 .