GetDimensionKeyDetails

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, lock snapshots, and execution plans.

Request Syntax

{
   "Group": "string",
   "GroupIdentifier": "string",
   "Identifier": "string",
   "RequestedDimensions": [ "string" ],
   "ServiceType": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Response Syntax

{
   "Dimensions": [ 
      { 
         "Dimension": "string",
         "Status": "string",
         "Value": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Errors

For information about the errors that are common to all actions, see Common Errors.

Examples

Retrieve the full SQL text for a query

The following example requests the full text for the SQL query with the ID example-group-identifier, which is a placeholder for a SQL ID that you retrieved by calling GetResourceMetrics or DescribeDimensionKeys. Because the dimension details are available, the response shows the full SQL text.

Sample Request

{
    "ServiceType":"RDS",
    "Identifier":"db-ABC1DEFGHIJKL2MNOPQRSTUV3W",
    "Group": "db.sql",
    "GroupIdentifier": "example-group-identifier",
    "RequestedDimensions": ["statement"]
}

Sample Response

{
    "Dimensions":[
    {
        "Value": "SELECT e.last_name, d.department_name FROM employees e, departments d WHERE e.department_id=d.department_id",
        "Dimension": "db.sql.statement",
        "Status": "AVAILABLE"
    },
    ...
    ]
}

Retrieve locking data for a database at a point in time

The following example requests locking data at the epoch timestamp 1730231303. You can retrieve the epoch timestamp with the GetResourceMetrics operation for a 1 second period.

Note that Performance Insights uses the comma-separated values format for the response. Each column value is enclosed in double quotation marks (" ") and separated by a comma. Each line is separated by a new line. The first line in the response describes the column names, and each of the following lines represents session data from a blocking or blocked session. The value level is the level of the session in the blocking tree hierarchy. For example, the session at level 0 is blocking the sessions at level 1.

Sample Request

{
    "ServiceType":"RDS",
    "Identifier":"db-ABC1DEFGHIJKL2MNOPQRSTUV3W",
    "Group": "db.lock_snapshot",
    "GroupIdentifier": "1730231303",
    "RequestedDimensions": ["lock_trees"]
}

Sample Response

{
    "Dimensions":[
    {
        "Value": "\"level\",\"blocked_sessions_count\",\"pid\",\"session_id\",\"blocking_mode\",\"waiting_mode\",\"last_query_executed\",\"application\",\"blocking_txn_start_time\",\"waiting_start_time\",\"session_start_time\",\"state\",\"wait_event_type\",\"wait_event\",\"last_query_exec_time\",\"user\",\"host\",\"port\",\"client_address\",\"granted\",\"waiting_tuple\",\"waiting_page\",\"waiting_transaction_id\",\"waiting_relation\",\"waiting_object_id\",\"waiting_database_id\",\"waiting_database_name\",\"waiting_locktype\",\"blocking_time_(In_Seconds)\"\n\"0\",\"4\",\"28599\",\"63bcb300.6fb7\",\"\",\"\",\"update sbtest1 set id = 200000 where id=1;\",\"psql\",\"\",\"\",\"1672533380000\",\"idle in transaction\",\"Client\",\"ClientRead\",\"1672533380000\",\"postgres\",\"\",\"37444\",\"34.222.155.102\",\"t\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"42\"\n\"1\",\"3\",\"30877\",\"63bcbc21.789d\",\"ExclusiveLock\",\"ShareLock\",\"update sbtest1 set id=20000 where id=1;\",\"psql\",\"1672533380000\",\"1672535758000\",\"1672535758000\",\"active\",\"Lock\",\"transactionid\",\"1672535758000\",\"postgres\",\"\",\"35064\",\"34.222.155.102\",\"f\",\"\",\"\",\"569470\",\"\",\"\",\"\",\"sbtest\",\"transactionid\",\"2430\"\n\"2\",\"2\",\"30937\",\"63bcbc5c.78d9\",\"AccessExclusiveLock\",\"AccessExclusiveLock\",\"update sbtest1 set id = 200000 where id=1;\",\"psql\",\"1672535758000\",\"1672533370000\",\"1672533370000\",\"active\",\"Lock\",\"tuple\",\"1672533370000\",\"postgres\",\"\",\"37398\",\"34.222.155.102\",\"f\",\"1\",\"0\",\"\",\"16946\",\"\",\"16839\",\"sbtest\",\"tuple\",\"2470\"\n\"3\",\"1\",\"31029\",\"63bcbcbf.7935\",\"AccessExclusiveLock\",\"AccessExclusiveLock\",\"update sbtest1 set id = 200000 where id=1;\",\"psql\",\"1672533370000\",\"1672533330000\",\"1672533330000\",\"active\",\"Lock\",\"tuple\",\"1672533330000\",\"postgres\",\"\",\"36266\",\"34.222.155.102\",\"f\",\"1\",\"0\",\"\",\"16946\",\"\",\"16839\",\"sbtest\",\"tuple\",\"2440\"\n\"4\",\"0\",\"31062\",\"63bcbcd8.7956\",\"AccessExclusiveLock\",\"AccessExclusiveLock\",\"update sbtest1 set id = 200000 where id=1;\",\"psql\",\"1672533330000\",\"1672533360000\",\"1672533360000\",\"active\",\"Lock\",\"tuple\",\"1672533360000\",\"postgres\",\"\",\"56694\",\"34.222.155.102\",\"f\",\"1\",\"0\",\"\",\"16946\",\"\",\"16839\",\"sbtest\",\"tuple\",\"\"\n",
        "Dimension": "db.lock_snapshot",
        "Status": "AVAILABLE"
    },
    ...
    ]
}

Retrieve execution plans for a database

The following example requests execution plans for a database, where the plan ID is 435345209.

Sample Request

{
      "ServiceType": "RDS",
      "Identifier": "db-ABC1DEFGHIJKL2MNOPQRSTUV3W",
      "GroupIdentifier": "435345209",
      "Group": "db.execution_plan",
      "RequestedDimensions": ["raw_plan"]
}

Sample Response

{
      "Dimensions":[
      {
         "Value": "Update on orders  (cost=0.43..8.46 rows=0 width=0)\n  ->  Index Scan using orders_pk on orders  (cost=0.43..8.46 rows=1 width=14)\n        Index Cond: (order_id = 200)"
         "Dimension": "db.execution_plan.raw_plan",
         "Status": "AVAILABLE",
      }
      ]
}

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: