Skip to content

Commit e0bd8ae

Browse files
author
awstools
committed
docs(client-pi): Documentation only update for RDS Performance Insights dimensions for execution plans and locking analysis.
1 parent dc054bb commit e0bd8ae

File tree

2 files changed

+16
-4
lines changed

2 files changed

+16
-4
lines changed

‎clients/client-pi/src/models/models_0.ts

+13-1
Original file line numberDiff line numberDiff line change
@@ -1149,6 +1149,10 @@ export interface GetDimensionKeyDetailsRequest {
11491149
* <ul>
11501150
* <li>
11511151
* <p>
1152+
* <code>db.execution_plan</code> (Amazon RDS and Aurora only)</p>
1153+
* </li>
1154+
* <li>
1155+
* <p>
11521156
* <code>db.lock_snapshot</code> (Aurora only)</p>
11531157
* </li>
11541158
* <li>
@@ -1170,6 +1174,10 @@ export interface GetDimensionKeyDetailsRequest {
11701174
* <ul>
11711175
* <li>
11721176
* <p>
1177+
* <code>db.execution_plan.id</code> for dimension group <code>db.execution_plan</code> (Aurora and RDS only)</p>
1178+
* </li>
1179+
* <li>
1180+
* <p>
11731181
* <code>db.sql.id</code> for dimension group <code>db.sql</code> (Aurora and RDS only)</p>
11741182
* </li>
11751183
* <li>
@@ -1191,7 +1199,11 @@ export interface GetDimensionKeyDetailsRequest {
11911199
* <ul>
11921200
* <li>
11931201
* <p>
1194-
* <code>db.lock_trees</code> - Specify the dimension name <code>db.lock_trees</code>. (Aurora only)</p>
1202+
* <code>db.execution_plan</code> - Specify the dimension name <code>db.execution_plan.raw_plan</code> or the short dimension name <code>raw_plan</code> (Amazon RDS and Aurora only)</p>
1203+
* </li>
1204+
* <li>
1205+
* <p>
1206+
* <code>db.lock_snapshot</code> - Specify the dimension name <code>db.lock_snapshot.lock_trees</code> or the short dimension name <code>lock_trees</code>. (Aurora only)</p>
11951207
* </li>
11961208
* <li>
11971209
* <p>

‎codegen/sdk-codegen/aws-models/pi.json

+3-3
Original file line numberDiff line numberDiff line change
@@ -932,21 +932,21 @@
932932
"Group": {
933933
"target": "com.amazonaws.pi#RequestString",
934934
"traits": {
935-
"smithy.api#documentation": "<p>The name of the dimension group. Performance Insights searches the specified group for the dimension group ID. The following group name values are\n valid:</p>\n <ul>\n <li>\n <p>\n <code>db.lock_snapshot</code> (Aurora only)</p>\n </li>\n <li>\n <p>\n <code>db.query</code> (Amazon DocumentDB only)</p>\n </li>\n <li>\n <p>\n <code>db.sql</code> (Amazon RDS and Aurora only)</p>\n </li>\n </ul>",
935+
"smithy.api#documentation": "<p>The name of the dimension group. Performance Insights searches the specified group for the dimension group ID. The following group name values are\n valid:</p>\n <ul>\n <li>\n <p>\n <code>db.execution_plan</code> (Amazon RDS and Aurora only)</p>\n </li>\n <li>\n <p>\n <code>db.lock_snapshot</code> (Aurora only)</p>\n </li>\n <li>\n <p>\n <code>db.query</code> (Amazon DocumentDB only)</p>\n </li>\n <li>\n <p>\n <code>db.sql</code> (Amazon RDS and Aurora only)</p>\n </li>\n </ul>",
936936
"smithy.api#required": {}
937937
}
938938
},
939939
"GroupIdentifier": {
940940
"target": "com.amazonaws.pi#RequestString",
941941
"traits": {
942-
"smithy.api#documentation": "<p>The ID of the dimension group from which to retrieve dimension details. For dimension group <code>db.sql</code>, the group ID is\n <code>db.sql.id</code>. The following group ID values are valid:</p>\n <ul>\n <li>\n <p>\n <code>db.sql.id</code> for dimension group <code>db.sql</code> (Aurora and RDS only)</p>\n </li>\n <li>\n <p>\n <code>db.query.id</code> for dimension group <code>db.query</code> (DocumentDB only)</p>\n </li>\n <li>\n <p>For the dimension group <code>db.lock_snapshot</code>, the <code>GroupIdentifier</code> is the epoch timestamp when Performance Insights captured the snapshot, in seconds. \n You can retrieve this value with the <code>GetResourceMetrics</code> operation for a 1 second period.</p>\n </li>\n </ul>",
942+
"smithy.api#documentation": "<p>The ID of the dimension group from which to retrieve dimension details. For dimension group <code>db.sql</code>, the group ID is\n <code>db.sql.id</code>. The following group ID values are valid:</p>\n <ul>\n <li>\n <p>\n <code>db.execution_plan.id</code> for dimension group <code>db.execution_plan</code> (Aurora and RDS only)</p>\n </li>\n <li>\n <p>\n <code>db.sql.id</code> for dimension group <code>db.sql</code> (Aurora and RDS only)</p>\n </li>\n <li>\n <p>\n <code>db.query.id</code> for dimension group <code>db.query</code> (DocumentDB only)</p>\n </li>\n <li>\n <p>For the dimension group <code>db.lock_snapshot</code>, the <code>GroupIdentifier</code> is the epoch timestamp when Performance Insights captured the snapshot, in seconds. \n You can retrieve this value with the <code>GetResourceMetrics</code> operation for a 1 second period.</p>\n </li>\n </ul>",
943943
"smithy.api#required": {}
944944
}
945945
},
946946
"RequestedDimensions": {
947947
"target": "com.amazonaws.pi#RequestedDimensionList",
948948
"traits": {
949-
"smithy.api#documentation": "<p>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\n all dimension data within the specified dimension group. Specify dimension names for the following dimension groups:</p>\n <ul>\n <li>\n <p>\n <code>db.lock_trees</code> - Specify the dimension name <code>db.lock_trees</code>. (Aurora only)</p>\n </li>\n <li>\n <p>\n <code>db.sql</code> - Specify either the full dimension name <code>db.sql.statement</code> or the short dimension name\n <code>statement</code> (Aurora and RDS only).</p>\n </li>\n <li>\n <p>\n <code>db.query</code> - Specify either the full dimension name <code>db.query.statement</code> or the short dimension name\n <code>statement</code> (DocumentDB only).</p>\n </li>\n </ul>"
949+
"smithy.api#documentation": "<p>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\n all dimension data within the specified dimension group. Specify dimension names for the following dimension groups:</p>\n <ul>\n <li>\n <p>\n <code>db.execution_plan</code> - Specify the dimension name <code>db.execution_plan.raw_plan</code> or the short dimension name <code>raw_plan</code> (Amazon RDS and Aurora only)</p>\n </li>\n <li>\n <p>\n <code>db.lock_snapshot</code> - Specify the dimension name <code>db.lock_snapshot.lock_trees</code> or the short dimension name <code>lock_trees</code>. (Aurora only)</p>\n </li>\n <li>\n <p>\n <code>db.sql</code> - Specify either the full dimension name <code>db.sql.statement</code> or the short dimension name\n <code>statement</code> (Aurora and RDS only).</p>\n </li>\n <li>\n <p>\n <code>db.query</code> - Specify either the full dimension name <code>db.query.statement</code> or the short dimension name\n <code>statement</code> (DocumentDB only).</p>\n </li>\n </ul>"
950950
}
951951
}
952952
},

0 commit comments

Comments
 (0)