PI / Client / describe_dimension_keys

describe_dimension_keys#

PI.Client.describe_dimension_keys(**kwargs)#

For a specific time period, retrieve the top N dimension keys for a metric.

Note

Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.

Request Syntax

response = client.describe_dimension_keys(
    ServiceType='RDS'|'DOCDB',
    Identifier='string',
    StartTime=datetime(2015, 1, 1),
    EndTime=datetime(2015, 1, 1),
    Metric='string',
    PeriodInSeconds=123,
    GroupBy={
        'Group': 'string',
        'Dimensions': [
            'string',
        ],
        'Limit': 123
    },
    AdditionalMetrics=[
        'string',
    ],
    PartitionBy={
        'Group': 'string',
        'Dimensions': [
            'string',
        ],
        'Limit': 123
    },
    Filter={
        'string': 'string'
    },
    MaxResults=123,
    NextToken='string'
)

Parameters:

ServiceType (string) –
[REQUIRED]

The Amazon Web Services service for which Performance Insights will return metrics. Valid values are as follows:
- RDS
- DOCDB
Identifier (string) –
[REQUIRED]

An immutable, Amazon Web Services Region-unique identifier for a data source. Performance Insights gathers metrics from this data source.

To use an Amazon RDS instance as a data source, you specify its DbiResourceId value. For example, specify db-FAIHNTYBKTGAUSUZQYPDS2GW4A.
StartTime (datetime) –
[REQUIRED]

The date and time specifying the beginning of the requested time series data. You must specify a StartTime within the past 7 days. The value specified is inclusive, which means that data points equal to or greater than StartTime are returned.

The value for StartTime must be earlier than the value for EndTime.
EndTime (datetime) –
[REQUIRED]

The date and time specifying the end of the requested time series data. The value specified is exclusive, which means that data points less than (but not equal to) EndTime are returned.

The value for EndTime must be later than the value for StartTime.
Metric (string) –
[REQUIRED]

The name of a Performance Insights metric to be measured.

Valid values for Metric are:
- db.load.avg - A scaled representation of the number of active sessions for the database engine.
- db.sampledload.avg - The raw number of active sessions for the database engine.
If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg and db.sampledload.avg are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg showing the scaled values, db.sampledload.avg showing the raw values, and db.sampledload.avg less than db.load.avg. For most use cases, you can query db.load.avg only.
PeriodInSeconds (integer) –
The granularity, in seconds, of the data points returned from Performance Insights. A period can be as short as one second, or as long as one day (86400 seconds). Valid values are:
- 1 (one second)
- 60 (one minute)
- 300 (five minutes)
- 3600 (one hour)
- 86400 (twenty-four hours)
If you don’t specify PeriodInSeconds, then Performance Insights chooses a value for you, with a goal of returning roughly 100-200 data points in the response.
GroupBy (dict) –
[REQUIRED]

A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights returns all dimensions within this group, unless you provide the names of specific dimensions within this group. You can also request that Performance Insights return a limited number of values for a dimension.
- Group (string) – [REQUIRED]
  
  The name of the dimension group. Valid values are as follows:
  - db - The name of the database to which the client is connected. The following values are permitted:
    - Aurora PostgreSQL
    - Amazon RDS PostgreSQL
    - Aurora MySQL
    - Amazon RDS MySQL
    - Amazon RDS MariaDB
    - Amazon DocumentDB
  - db.application - The name of the application that is connected to the database. The following values are permitted:
    - Aurora PostgreSQL
    - Amazon RDS PostgreSQL
    - Amazon DocumentDB
  - db.host - The host name of the connected client (all engines).
  - db.query - The query that is currently running (only Amazon DocumentDB).
  - db.query_tokenized - The digest query (only Amazon DocumentDB).
  - db.session_type - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL).
  - db.sql - The text of the SQL statement that is currently running (all engines except Amazon DocumentDB).
  - db.sql_tokenized - The SQL digest (all engines except Amazon DocumentDB).
  - db.user - The user logged in to the database (all engines except Amazon DocumentDB).
  - db.wait_event - The event for which the database backend is waiting (all engines except Amazon DocumentDB).
  - db.wait_event_type - The type of event for which the database backend is waiting (all engines except Amazon DocumentDB).
  - db.wait_state - The event for which the database backend is waiting (only Amazon DocumentDB).
- Dimensions (list) –
  
  A list of specific dimensions from a dimension group. If this parameter is not present, then it signifies that all of the dimensions in the group were requested, or are present in the response.
  
  Valid values for elements in the Dimensions array are:
  - db.application.name - The name of the application that is connected to the database. Valid values are as follows:
    - Aurora PostgreSQL
    - Amazon RDS PostgreSQL
    - Amazon DocumentDB
  - db.host.id - The host ID of the connected client (all engines).
  - db.host.name - The host name of the connected client (all engines).
  - db.name - The name of the database to which the client is connected. Valid values are as follows:
    - Aurora PostgreSQL
    - Amazon RDS PostgreSQL
    - Aurora MySQL
    - Amazon RDS MySQL
    - Amazon RDS MariaDB
    - Amazon DocumentDB
  - db.query.id - The query ID generated by Performance Insights (only Amazon DocumentDB).
  - db.query.db_id - The query ID generated by the database (only Amazon DocumentDB).
  - db.query.statement - The text of the query that is being run (only Amazon DocumentDB).
  - db.query.tokenized_id
  - db.query.tokenized.id - The query digest ID generated by Performance Insights (only Amazon DocumentDB).
  - db.query.tokenized.db_id - The query digest ID generated by Performance Insights (only Amazon DocumentDB).
  - db.query.tokenized.statement - The text of the query digest (only Amazon DocumentDB).
  - db.session_type.name - The type of the current session (only Amazon DocumentDB).
  - db.sql.id - The hash of the full, non-tokenized SQL statement generated by Performance Insights (all engines except Amazon DocumentDB).
  - db.sql.db_id - Either the SQL ID generated by the database engine, or a value generated by Performance Insights that begins with pi- (all engines except Amazon DocumentDB).
  - db.sql.statement - The full text of the SQL statement that is running, as in SELECT * FROM employees (all engines except Amazon DocumentDB)
  - db.sql.tokenized_id
  - db.sql_tokenized.id - The hash of the SQL digest generated by Performance Insights (all engines except Amazon DocumentDB). In the console, db.sql_tokenized.id is called the Support ID because Amazon Web Services Support can look at this data to help you troubleshoot database issues.
  - db.sql_tokenized.db_id - Either the native database ID used to refer to the SQL statement, or a synthetic ID such as pi-2372568224 that Performance Insights generates if the native database ID isn’t available (all engines except Amazon DocumentDB).
  - db.sql_tokenized.statement - The text of the SQL digest, as in SELECT * FROM employees WHERE employee_id = ? (all engines except Amazon DocumentDB)
  - db.user.id - The ID of the user logged in to the database (all engines except Amazon DocumentDB).
  - db.user.name - The name of the user logged in to the database (all engines except Amazon DocumentDB).
  - db.wait_event.name - The event for which the backend is waiting (all engines except Amazon DocumentDB).
  - db.wait_event.type - The type of event for which the backend is waiting (all engines except Amazon DocumentDB).
  - db.wait_event_type.name - The name of the event type for which the backend is waiting (all engines except Amazon DocumentDB).
  - db.wait_state.name - The event for which the backend is waiting (only Amazon DocumentDB).
  - (string) –
- Limit (integer) –
  
  The maximum number of items to fetch for this dimension group.
AdditionalMetrics (list) –
Additional metrics for the top N dimension keys. If the specified dimension group in the GroupBy parameter is db.sql_tokenized, you can specify per-SQL metrics to get the values for the top N SQL digests. The response syntax is as follows: "AdditionalMetrics" : { "string" : "string" }.
- (string) –
PartitionBy (dict) –
For each dimension specified in GroupBy, specify a secondary dimension to further subdivide the partition keys in the response.
- Group (string) – [REQUIRED]
  
  The name of the dimension group. Valid values are as follows:
  - db - The name of the database to which the client is connected. The following values are permitted:
    - Aurora PostgreSQL
    - Amazon RDS PostgreSQL
    - Aurora MySQL
    - Amazon RDS MySQL
    - Amazon RDS MariaDB
    - Amazon DocumentDB
  - db.application - The name of the application that is connected to the database. The following values are permitted:
    - Aurora PostgreSQL
    - Amazon RDS PostgreSQL
    - Amazon DocumentDB
  - db.host - The host name of the connected client (all engines).
  - db.query - The query that is currently running (only Amazon DocumentDB).
  - db.query_tokenized - The digest query (only Amazon DocumentDB).
  - db.session_type - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL).
  - db.sql - The text of the SQL statement that is currently running (all engines except Amazon DocumentDB).
  - db.sql_tokenized - The SQL digest (all engines except Amazon DocumentDB).
  - db.user - The user logged in to the database (all engines except Amazon DocumentDB).
  - db.wait_event - The event for which the database backend is waiting (all engines except Amazon DocumentDB).
  - db.wait_event_type - The type of event for which the database backend is waiting (all engines except Amazon DocumentDB).
  - db.wait_state - The event for which the database backend is waiting (only Amazon DocumentDB).
- Dimensions (list) –
  
  A list of specific dimensions from a dimension group. If this parameter is not present, then it signifies that all of the dimensions in the group were requested, or are present in the response.
  
  Valid values for elements in the Dimensions array are:
  - db.application.name - The name of the application that is connected to the database. Valid values are as follows:
    - Aurora PostgreSQL
    - Amazon RDS PostgreSQL
    - Amazon DocumentDB
  - db.host.id - The host ID of the connected client (all engines).
  - db.host.name - The host name of the connected client (all engines).
  - db.name - The name of the database to which the client is connected. Valid values are as follows:
    - Aurora PostgreSQL
    - Amazon RDS PostgreSQL
    - Aurora MySQL
    - Amazon RDS MySQL
    - Amazon RDS MariaDB
    - Amazon DocumentDB
  - db.query.id - The query ID generated by Performance Insights (only Amazon DocumentDB).
  - db.query.db_id - The query ID generated by the database (only Amazon DocumentDB).
  - db.query.statement - The text of the query that is being run (only Amazon DocumentDB).
  - db.query.tokenized_id
  - db.query.tokenized.id - The query digest ID generated by Performance Insights (only Amazon DocumentDB).
  - db.query.tokenized.db_id - The query digest ID generated by Performance Insights (only Amazon DocumentDB).
  - db.query.tokenized.statement - The text of the query digest (only Amazon DocumentDB).
  - db.session_type.name - The type of the current session (only Amazon DocumentDB).
  - db.sql.id - The hash of the full, non-tokenized SQL statement generated by Performance Insights (all engines except Amazon DocumentDB).
  - db.sql.db_id - Either the SQL ID generated by the database engine, or a value generated by Performance Insights that begins with pi- (all engines except Amazon DocumentDB).
  - db.sql.statement - The full text of the SQL statement that is running, as in SELECT * FROM employees (all engines except Amazon DocumentDB)
  - db.sql.tokenized_id
  - db.sql_tokenized.id - The hash of the SQL digest generated by Performance Insights (all engines except Amazon DocumentDB). In the console, db.sql_tokenized.id is called the Support ID because Amazon Web Services Support can look at this data to help you troubleshoot database issues.
  - db.sql_tokenized.db_id - Either the native database ID used to refer to the SQL statement, or a synthetic ID such as pi-2372568224 that Performance Insights generates if the native database ID isn’t available (all engines except Amazon DocumentDB).
  - db.sql_tokenized.statement - The text of the SQL digest, as in SELECT * FROM employees WHERE employee_id = ? (all engines except Amazon DocumentDB)
  - db.user.id - The ID of the user logged in to the database (all engines except Amazon DocumentDB).
  - db.user.name - The name of the user logged in to the database (all engines except Amazon DocumentDB).
  - db.wait_event.name - The event for which the backend is waiting (all engines except Amazon DocumentDB).
  - db.wait_event.type - The type of event for which the backend is waiting (all engines except Amazon DocumentDB).
  - db.wait_event_type.name - The name of the event type for which the backend is waiting (all engines except Amazon DocumentDB).
  - db.wait_state.name - The event for which the backend is waiting (only Amazon DocumentDB).
  - (string) –
- Limit (integer) –
  
  The maximum number of items to fetch for this dimension group.
Filter (dict) –
One or more filters to apply in the request. Restrictions:
- Any number of filters by the same dimension, as specified in the GroupBy or Partition parameters.
- A single filter for any other dimension in this dimension group.
- (string) –
  - (string) –
MaxResults (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.
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.

Return type:

dict

Returns:

Response Syntax

{
    'AlignedStartTime': datetime(2015, 1, 1),
    'AlignedEndTime': datetime(2015, 1, 1),
    'PartitionKeys': [
        {
            'Dimensions': {
                'string': 'string'
            }
        },
    ],
    'Keys': [
        {
            'Dimensions': {
                'string': 'string'
            },
            'Total': 123.0,
            'AdditionalMetrics': {
                'string': 123.0
            },
            'Partitions': [
                123.0,
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- AlignedStartTime (datetime) –
  
  The start time for the returned dimension keys, after alignment to a granular boundary (as specified by PeriodInSeconds). AlignedStartTime will be less than or equal to the value of the user-specified StartTime.
- AlignedEndTime (datetime) –
  
  The end time for the returned dimension keys, after alignment to a granular boundary (as specified by PeriodInSeconds). AlignedEndTime will be greater than or equal to the value of the user-specified Endtime.
- PartitionKeys (list) –
  
  If PartitionBy was present in the request, PartitionKeys contains the breakdown of dimension keys by the specified partitions.
  - (dict) –
    
    If PartitionBy was specified in a DescribeDimensionKeys request, the dimensions are returned in an array. Each element in the array specifies one dimension.
    - Dimensions (dict) –
      
      A dimension map that contains the dimensions for this partition.
      - (string) –
        
        (string) –
- Keys (list) –
  
  The dimension keys that were requested.
  - (dict) –
    
    An object that includes the requested dimension key values and aggregated metric values within a dimension group.
    - Dimensions (dict) –
      
      A map of name-value pairs for the dimensions in the group.
      - (string) –
        
        (string) –
    - Total (float) –
      
      The aggregated metric value for the dimensions, over the requested time range.
    - AdditionalMetrics (dict) –
      
      A map that contains the value for each additional metric.
      - (string) –
        
        (float) –
    - Partitions (list) –
      
      If PartitionBy was specified, PartitionKeys contains the dimensions that were.
      - (float) –
- NextToken (string) –
  
  A pagination token that indicates the response didn’t return all available records because MaxRecords was specified in the previous request. To get the remaining records, specify NextToken in a separate request with this value.

Exceptions

PI.Client.exceptions.InvalidArgumentException
PI.Client.exceptions.InternalServiceError
PI.Client.exceptions.NotAuthorizedException