Skip to content

Commit

Permalink
docs(client-pi): Added a description for the Dimension db.sql.tokeniz…
Browse files Browse the repository at this point in the history 
…ed_id on the DimensionGroup data type page.
  • Loading branch information
awstools committed Aug 5, 2024
1 parent 91b2561 commit 4078ba5
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
5 changes: 3 additions & 2 deletions clients/client-pi/src/models/models_0.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -608,8 +608,9 @@ export interface DimensionGroup {
* </li>
* <li>
* <p>
* <code>db.sql.tokenized_id</code>
* </p>
* <code>db.sql.tokenized_id</code> - The hash of the SQL digest generated by Performance Insights (all engines except Amazon DocumentDB). The <code>db.sql.tokenized_id</code> dimension
* fetches the value of the <code>db.sql_tokenized.id</code> dimension. Amazon RDS returns <code>db.sql.tokenized_id</code> from the <code>db.sql</code> dimension group.
* </p>
* </li>
* <li>
* <p>
Expand Down
2 changes: 1 addition & 1 deletion codegen/sdk-codegen/aws-models/pi.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -665,7 +665,7 @@
"Dimensions": {
"target": "com.amazonaws.pi#SanitizedStringList",
"traits": {
"smithy.api#documentation": "<p>A list of specific dimensions from a dimension group. If this parameter is not present,\n then it signifies that all of the dimensions in the group were requested, or are present in\n the response.</p>\n <p>Valid values for elements in the <code>Dimensions</code> array are:</p>\n <ul>\n <li>\n <p>\n <code>db.application.name</code> - The name of the application that is connected to the database. Valid values are as follows: </p>\n <ul>\n <li>\n <p>Aurora PostgreSQL</p>\n </li>\n <li>\n <p>Amazon RDS PostgreSQL</p>\n </li>\n <li>\n <p>Amazon DocumentDB</p>\n </li>\n </ul>\n </li>\n <li>\n <p>\n <code>db.host.id</code> - The host ID of the connected client (all engines).</p>\n </li>\n <li>\n <p>\n <code>db.host.name</code> - The host name of the connected client (all engines).</p>\n </li>\n <li>\n <p>\n <code>db.name</code> - The name of the database to which the client is connected. Valid values are as follows:</p>\n <ul>\n <li>\n <p>Aurora PostgreSQL</p>\n </li>\n <li>\n <p>Amazon RDS PostgreSQL</p>\n </li>\n <li>\n <p>Aurora MySQL</p>\n </li>\n <li>\n <p>Amazon RDS MySQL</p>\n </li>\n <li>\n <p>Amazon RDS MariaDB</p>\n </li>\n <li>\n <p>Amazon DocumentDB</p>\n </li>\n </ul>\n </li>\n <li>\n <p>\n <code>db.query.id</code> - The query ID generated by Performance Insights (only Amazon DocumentDB).</p>\n </li>\n <li>\n <p>\n <code>db.query.db_id</code> - The query ID generated by the database (only Amazon DocumentDB).</p>\n </li>\n <li>\n <p>\n <code>db.query.statement</code> - The text of the query that is being run (only Amazon DocumentDB).</p>\n </li>\n <li>\n <p>\n <code>db.query.tokenized_id</code>\n </p>\n </li>\n <li>\n <p>\n <code>db.query.tokenized.id</code> - The query digest ID generated by Performance Insights (only Amazon DocumentDB).</p>\n </li>\n <li>\n <p>\n <code>db.query.tokenized.db_id</code> - The query digest ID generated by Performance Insights (only Amazon DocumentDB).</p>\n </li>\n <li>\n <p>\n <code>db.query.tokenized.statement</code> - The text of the query digest (only Amazon DocumentDB).</p>\n </li>\n <li>\n <p>\n <code>db.session_type.name</code> - The type of the current session (only Amazon DocumentDB).</p>\n </li>\n <li>\n <p>\n <code>db.sql.id</code> - The hash of the full, non-tokenized SQL statement generated by Performance Insights (all engines except Amazon DocumentDB).</p>\n </li>\n <li>\n <p>\n <code>db.sql.db_id</code> - Either the SQL ID generated by the database engine, or a value generated by Performance Insights that begins with\n <code>pi-</code> (all engines except Amazon DocumentDB).</p>\n </li>\n <li>\n <p>\n <code>db.sql.statement</code> - The full text of the SQL statement that is running, as in <code>SELECT * FROM employees</code>\n (all engines except Amazon DocumentDB)</p>\n </li>\n <li>\n <p>\n <code>db.sql.tokenized_id</code>\n </p>\n </li>\n <li>\n <p>\n <code>db.sql_tokenized.id</code> - The hash of the SQL digest generated by Performance Insights (all engines except Amazon DocumentDB). In the console,\n <code>db.sql_tokenized.id</code> is called the Support ID because Amazon Web Services Support can look at this data to help you troubleshoot\n database issues.</p>\n </li>\n <li>\n <p>\n <code>db.sql_tokenized.db_id</code> - Either the native database ID used to refer to the SQL statement, or a synthetic ID such as\n <code>pi-2372568224</code> that Performance Insights generates if the native database ID isn't available (all engines except Amazon DocumentDB).</p>\n </li>\n <li>\n <p>\n <code>db.sql_tokenized.statement</code> - The text of the SQL digest, as in <code>SELECT * FROM employees WHERE employee_id =\n ?</code> (all engines except Amazon DocumentDB)</p>\n </li>\n <li>\n <p>\n <code>db.user.id</code> - The ID of the user logged in to the database (all engines except Amazon DocumentDB).</p>\n </li>\n <li>\n <p>\n <code>db.user.name</code> - The name of the user logged in to the database (all engines except Amazon DocumentDB).</p>\n </li>\n <li>\n <p>\n <code>db.wait_event.name</code> - The event for which the backend is waiting (all engines except Amazon DocumentDB).</p>\n </li>\n <li>\n <p>\n <code>db.wait_event.type</code> - The type of event for which the backend is waiting (all engines except Amazon DocumentDB).</p>\n </li>\n <li>\n <p>\n <code>db.wait_event_type.name</code> - The name of the event type for which the backend is waiting (all engines except\n Amazon DocumentDB).</p>\n </li>\n <li>\n <p>\n <code>db.wait_state.name</code> - The event for which the backend is waiting (only Amazon DocumentDB).</p>\n </li>\n </ul>"
"smithy.api#documentation": "<p>A list of specific dimensions from a dimension group. If this parameter is not present,\n then it signifies that all of the dimensions in the group were requested, or are present in\n the response.</p>\n <p>Valid values for elements in the <code>Dimensions</code> array are:</p>\n <ul>\n <li>\n <p>\n <code>db.application.name</code> - The name of the application that is connected to the database. Valid values are as follows: </p>\n <ul>\n <li>\n <p>Aurora PostgreSQL</p>\n </li>\n <li>\n <p>Amazon RDS PostgreSQL</p>\n </li>\n <li>\n <p>Amazon DocumentDB</p>\n </li>\n </ul>\n </li>\n <li>\n <p>\n <code>db.host.id</code> - The host ID of the connected client (all engines).</p>\n </li>\n <li>\n <p>\n <code>db.host.name</code> - The host name of the connected client (all engines).</p>\n </li>\n <li>\n <p>\n <code>db.name</code> - The name of the database to which the client is connected. Valid values are as follows:</p>\n <ul>\n <li>\n <p>Aurora PostgreSQL</p>\n </li>\n <li>\n <p>Amazon RDS PostgreSQL</p>\n </li>\n <li>\n <p>Aurora MySQL</p>\n </li>\n <li>\n <p>Amazon RDS MySQL</p>\n </li>\n <li>\n <p>Amazon RDS MariaDB</p>\n </li>\n <li>\n <p>Amazon DocumentDB</p>\n </li>\n </ul>\n </li>\n <li>\n <p>\n <code>db.query.id</code> - The query ID generated by Performance Insights (only Amazon DocumentDB).</p>\n </li>\n <li>\n <p>\n <code>db.query.db_id</code> - The query ID generated by the database (only Amazon DocumentDB).</p>\n </li>\n <li>\n <p>\n <code>db.query.statement</code> - The text of the query that is being run (only Amazon DocumentDB).</p>\n </li>\n <li>\n <p>\n <code>db.query.tokenized_id</code>\n </p>\n </li>\n <li>\n <p>\n <code>db.query.tokenized.id</code> - The query digest ID generated by Performance Insights (only Amazon DocumentDB).</p>\n </li>\n <li>\n <p>\n <code>db.query.tokenized.db_id</code> - The query digest ID generated by Performance Insights (only Amazon DocumentDB).</p>\n </li>\n <li>\n <p>\n <code>db.query.tokenized.statement</code> - The text of the query digest (only Amazon DocumentDB).</p>\n </li>\n <li>\n <p>\n <code>db.session_type.name</code> - The type of the current session (only Amazon DocumentDB).</p>\n </li>\n <li>\n <p>\n <code>db.sql.id</code> - The hash of the full, non-tokenized SQL statement generated by Performance Insights (all engines except Amazon DocumentDB).</p>\n </li>\n <li>\n <p>\n <code>db.sql.db_id</code> - Either the SQL ID generated by the database engine, or a value generated by Performance Insights that begins with\n <code>pi-</code> (all engines except Amazon DocumentDB).</p>\n </li>\n <li>\n <p>\n <code>db.sql.statement</code> - The full text of the SQL statement that is running, as in <code>SELECT * FROM employees</code>\n (all engines except Amazon DocumentDB)</p>\n </li>\n <li>\n <p>\n <code>db.sql.tokenized_id</code> - The hash of the SQL digest generated by Performance Insights (all engines except Amazon DocumentDB). The <code>db.sql.tokenized_id</code> dimension \n fetches the value of the <code>db.sql_tokenized.id</code> dimension. Amazon RDS returns <code>db.sql.tokenized_id</code> from the <code>db.sql</code> dimension group.\n </p>\n </li>\n <li>\n <p>\n <code>db.sql_tokenized.id</code> - The hash of the SQL digest generated by Performance Insights (all engines except Amazon DocumentDB). In the console,\n <code>db.sql_tokenized.id</code> is called the Support ID because Amazon Web Services Support can look at this data to help you troubleshoot\n database issues.</p>\n </li>\n <li>\n <p>\n <code>db.sql_tokenized.db_id</code> - Either the native database ID used to refer to the SQL statement, or a synthetic ID such as\n <code>pi-2372568224</code> that Performance Insights generates if the native database ID isn't available (all engines except Amazon DocumentDB).</p>\n </li>\n <li>\n <p>\n <code>db.sql_tokenized.statement</code> - The text of the SQL digest, as in <code>SELECT * FROM employees WHERE employee_id =\n ?</code> (all engines except Amazon DocumentDB)</p>\n </li>\n <li>\n <p>\n <code>db.user.id</code> - The ID of the user logged in to the database (all engines except Amazon DocumentDB).</p>\n </li>\n <li>\n <p>\n <code>db.user.name</code> - The name of the user logged in to the database (all engines except Amazon DocumentDB).</p>\n </li>\n <li>\n <p>\n <code>db.wait_event.name</code> - The event for which the backend is waiting (all engines except Amazon DocumentDB).</p>\n </li>\n <li>\n <p>\n <code>db.wait_event.type</code> - The type of event for which the backend is waiting (all engines except Amazon DocumentDB).</p>\n </li>\n <li>\n <p>\n <code>db.wait_event_type.name</code> - The name of the event type for which the backend is waiting (all engines except\n Amazon DocumentDB).</p>\n </li>\n <li>\n <p>\n <code>db.wait_state.name</code> - The event for which the backend is waiting (only Amazon DocumentDB).</p>\n </li>\n </ul>"
}
},
"Limit": {
Expand Down

0 comments on commit 4078ba5

Please sign in to comment.