[ aws . pi ]

get-dimension-key-details

Description

Get the attributes of the specified dimension group for a DB instance or data source. For example, if you specify a SQL ID, GetDimensionKeyDetails retrieves the full text of the dimension db.sql.statement associated with this ID. This operation is useful because GetResourceMetrics and DescribeDimensionKeys don’t support retrieval of large SQL statement text.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-dimension-key-details
--service-type <value>
--identifier <value>
--group <value>
--group-identifier <value>
[--requested-dimensions <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 data. The only valid value is RDS .

Possible values:

• RDS

• DOCDB

--identifier (string)

The ID for a data source from which to gather dimension data. This ID must be immutable and unique within an Amazon Web Services Region. When a DB instance is the data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X .

--group (string)

The name of the dimension group. Performance Insights searches the specified group for the dimension group ID. The following group name values are valid:

• db.query (Amazon DocumentDB only)

• db.sql (Amazon RDS and Aurora only)

--group-identifier (string)

The ID of the dimension group from which to retrieve dimension details. For dimension group db.sql , the group ID is db.sql.id . The following group ID values are valid:

• db.sql.id for dimension group db.sql (Aurora and RDS only)

• db.query.id for dimension group db.query (DocumentDB only)

--requested-dimensions (list)

A list of dimensions to retrieve the detail data for within the given dimension group. If you don’t specify this parameter, Performance Insights returns all dimension data within the specified dimension group. Specify dimension names for the following dimension groups:

• db.sql - Specify either the full dimension name db.sql.statement or the short dimension name statement (Aurora and RDS only).

• db.query - Specify either the full dimension name db.query.statement or the short dimension name statement (DocumentDB only).

(string)

Syntax:

"string" "string" ...

--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

Dimensions -> (list)

The details for the requested dimensions.

(structure)

An object that describes the details for a specified dimension.

Value -> (string)

The value of the dimension detail data. Depending on the return status, this value is either the full or truncated SQL query for the following dimensions:

• db.query.statement (Amazon DocumentDB)

• db.sql.statement (Amazon RDS and Aurora)

Dimension -> (string)

The full name of the dimension. The full name includes the group name and key name. The following values are valid:

• db.query.statement (Amazon DocumentDB)

• db.sql.statement (Amazon RDS and Aurora)

Status -> (string)

The status of the dimension detail data. Possible values include the following:

• AVAILABLE - The dimension detail data is ready to be retrieved.

• PROCESSING - The dimension detail data isn’t ready to be retrieved because more processing time is required. If the requested detail data has the status PROCESSING , Performance Insights returns the truncated query.

• UNAVAILABLE - The dimension detail data could not be collected successfully.