PI

Client

class PI.Client

A low-level client representing AWS Performance Insights (PI)

Amazon RDS Performance Insights enables you to monitor and explore different dimensions of database load based on data captured from a running DB instance. The guide provides detailed information about Performance Insights data types, parameters and errors.

When Performance Insights is enabled, the Amazon RDS Performance Insights API provides visibility into the performance of your DB instance. Amazon CloudWatch provides the authoritative source for Amazon Web Services service-vended monitoring metrics. Performance Insights offers a domain-specific view of DB load.

DB load is measured as average active sessions. Performance Insights provides the data to API consumers as a two-dimensional time-series dataset. The time dimension provides DB load data for each time point in the queried time range. Each time point decomposes overall load in relation to the requested dimensions, measured at that time point. Examples include SQL, Wait event, User, and Host.

client = session.create_client('pi')

These are the available methods:

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
close()

Closes underlying endpoint connections.

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.

See also: AWS API Documentation

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

get_dimension_key_details(**kwargs)

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

Request Syntax

response = client.get_dimension_key_details(
    ServiceType='RDS'|'DOCDB',
    Identifier='string',
    Group='string',
    GroupIdentifier='string',
    RequestedDimensions=[
        'string',
    ]
)
Parameters
  • ServiceType (string) --

    [REQUIRED]

    The Amazon Web Services service for which Performance Insights returns data. The only valid value is RDS .

  • Identifier (string) --

    [REQUIRED]

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

    [REQUIRED]

    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)
  • GroupIdentifier (string) --

    [REQUIRED]

    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)
  • RequestedDimensions (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) --
Return type

dict

Returns

Response Syntax

{
    'Dimensions': [
        {
            'Value': 'string',
            'Dimension': 'string',
            'Status': 'AVAILABLE'|'PROCESSING'|'UNAVAILABLE'
        },
    ]
}

Response Structure

  • (dict) --

    • Dimensions (list) --

      The details for the requested dimensions.

      • (dict) --

        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.

Exceptions

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_resource_metadata(**kwargs)

Retrieve the metadata for different features. For example, the metadata might indicate that a feature is turned on or off on a specific DB instance.

See also: AWS API Documentation

Request Syntax

response = client.get_resource_metadata(
    ServiceType='RDS'|'DOCDB',
    Identifier='string'
)
Parameters
  • ServiceType (string) --

    [REQUIRED]

    The Amazon Web Services service for which Performance Insights returns metrics.

  • Identifier (string) --

    [REQUIRED]

    An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. To use a DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X .

Return type

dict

Returns

Response Syntax

{
    'Identifier': 'string',
    'Features': {
        'string': {
            'Status': 'ENABLED'|'DISABLED'|'UNSUPPORTED'|'ENABLED_PENDING_REBOOT'|'DISABLED_PENDING_REBOOT'|'UNKNOWN'
        }
    }
}

Response Structure

  • (dict) --

    • Identifier (string) --

      An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. To use a DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X .

    • Features (dict) --

      The metadata for different features. For example, the metadata might indicate that a feature is turned on or off on a specific DB instance.

      • (string) --

        • (dict) --

          The metadata for a feature. For example, the metadata might indicate that a feature is turned on or off on a specific DB instance.

          • Status (string) --

            The status of the feature on the DB instance. Possible values include the following:

            • ENABLED - The feature is enabled on the instance.
            • DISABLED - The feature is disabled on the instance.
            • UNSUPPORTED - The feature isn't supported on the instance.
            • ENABLED_PENDING_REBOOT - The feature is enabled on the instance but requires a reboot to take effect.
            • DISABLED_PENDING_REBOOT - The feature is disabled on the instance but requires a reboot to take effect.
            • UNKNOWN - The feature status couldn't be determined.

Exceptions

get_resource_metrics(**kwargs)

Retrieve Performance Insights metrics for a set of data sources over a time period. You can provide specific dimension groups and dimensions, and provide aggregation and filtering criteria for each group.

Note

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

See also: AWS API Documentation

Request Syntax

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

    [REQUIRED]

    The Amazon Web Services service for which Performance Insights returns metrics. Valid values are as follows:

    • RDS
    • DOCDB
  • Identifier (string) --

    [REQUIRED]

    An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. In the console, the identifier is shown as ResourceID . When you call DescribeDBInstances , the identifier is returned as DbiResourceId .

    To use a DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X .

  • MetricQueries (list) --

    [REQUIRED]

    An array of one or more queries to perform. Each query must specify a Performance Insights metric, and can optionally specify aggregation and filtering criteria.

    • (dict) --

      A single query to be processed. You must provide the metric to query. If no other parameters are specified, Performance Insights returns all data points for the specified metric. Optionally, you can request that the data points be aggregated by dimension group ( GroupBy ), and return only those data points that match your criteria ( Filter ).

      • 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.
        • The counter metrics listed in Performance Insights operating system counters in the Amazon Aurora User Guide .

        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.

      • GroupBy (dict) --

        A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights will return all of the dimensions within that group, unless you provide the names of specific dimensions within that 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.

      • 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 parameter.
        • A single filter for any other dimension in this dimension group.
        • (string) --
          • (string) --
  • StartTime (datetime) --

    [REQUIRED]

    The date and time specifying the beginning of the requested time series query range. You can't specify a StartTime that is earlier than 7 days ago. By default, Performance Insights has 7 days of retention, but you can extend this range up to 2 years. The value specified is inclusive . Thus, the command returns data points equal to or greater than StartTime .

    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 query range. The value specified is exclusive . Thus, the command returns data points less than (but not equal to) EndTime .

    The value for EndTime must be later than the value for StartTime .

  • 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 will choose a value for you, with a goal of returning roughly 100-200 data points in the response.

  • 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),
    'Identifier': 'string',
    'MetricList': [
        {
            'Key': {
                'Metric': 'string',
                'Dimensions': {
                    'string': 'string'
                }
            },
            'DataPoints': [
                {
                    'Timestamp': datetime(2015, 1, 1),
                    'Value': 123.0
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • AlignedStartTime (datetime) --

      The start time for the returned metrics, 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 metrics, 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 .

    • Identifier (string) --

      An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. In the console, the identifier is shown as ResourceID . When you call DescribeDBInstances , the identifier is returned as DbiResourceId .

    • MetricList (list) --

      An array of metric results, where each array element contains all of the data points for a particular dimension.

      • (dict) --

        A time-ordered series of data points, corresponding to a dimension of a Performance Insights metric.

        • Key (dict) --

          The dimensions to which the data points apply.

          • Metric (string) --

            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.
            • The counter metrics listed in Performance Insights operating system counters in the Amazon Aurora User Guide .

            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.

          • Dimensions (dict) --

            The valid dimensions for the metric.

            • (string) --
              • (string) --
        • DataPoints (list) --

          An array of timestamp-value pairs, representing measurements over a period of time.

          • (dict) --

            A timestamp, and a single numerical value, which together represent a measurement at a particular point in time.

            • Timestamp (datetime) --

              The time, in epoch format, associated with a particular Value .

            • Value (float) --

              The actual value associated with a particular Timestamp .

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

Exceptions

get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
list_available_resource_dimensions(**kwargs)

Retrieve the dimensions that can be queried for each specified metric type on a specified DB instance.

See also: AWS API Documentation

Request Syntax

response = client.list_available_resource_dimensions(
    ServiceType='RDS'|'DOCDB',
    Identifier='string',
    Metrics=[
        'string',
    ],
    MaxResults=123,
    NextToken='string'
)
Parameters
  • ServiceType (string) --

    [REQUIRED]

    The Amazon Web Services service for which Performance Insights returns metrics.

  • Identifier (string) --

    [REQUIRED]

    An immutable identifier for a data source that is unique within an Amazon Web Services Region. Performance Insights gathers metrics from this data source. To use an Amazon RDS DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VWZ .

  • Metrics (list) --

    [REQUIRED]

    The types of metrics for which to retrieve dimensions. Valid values include db.load .

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

{
    'MetricDimensions': [
        {
            'Metric': 'string',
            'Groups': [
                {
                    'Group': 'string',
                    'Dimensions': [
                        {
                            'Identifier': 'string'
                        },
                    ]
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • MetricDimensions (list) --

      The dimension information returned for requested metric types.

      • (dict) --

        The available dimension information for a metric type.

        • Metric (string) --

          The metric type to which the dimension information belongs.

        • Groups (list) --

          The available dimension groups for a metric type.

          • (dict) --

            Information about dimensions within a dimension group.

            • Group (string) --

              The name of the dimension group.

            • Dimensions (list) --

              The dimensions within a dimension group.

              • (dict) --

                The information about a dimension.

                • Identifier (string) --

                  The identifier of a dimension.

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

Exceptions

list_available_resource_metrics(**kwargs)

Retrieve metrics of the specified types that can be queried for a specified DB instance.

See also: AWS API Documentation

Request Syntax

response = client.list_available_resource_metrics(
    ServiceType='RDS'|'DOCDB',
    Identifier='string',
    MetricTypes=[
        'string',
    ],
    NextToken='string',
    MaxResults=123
)
Parameters
  • ServiceType (string) --

    [REQUIRED]

    The Amazon Web Services service for which Performance Insights returns metrics.

  • Identifier (string) --

    [REQUIRED]

    An immutable identifier for a data source that is unique within an Amazon Web Services Region. Performance Insights gathers metrics from this data source. To use an Amazon RDS DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VWZ .

  • MetricTypes (list) --

    [REQUIRED]

    The types of metrics to return in the response. Valid values in the array include the following:

    • os (OS counter metrics) - All engines
    • db (DB load metrics) - All engines except for Amazon DocumentDB
    • db.sql.stats (per-SQL metrics) - All engines except for Amazon DocumentDB
    • db.sql_tokenized.stats (per-SQL digest metrics) - All engines except for Amazon DocumentDB
    • (string) --
  • 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 .
  • MaxResults (integer) -- The maximum number of items to return. If the MaxRecords value is less than the number of existing items, the response includes a pagination token.
Return type

dict

Returns

Response Syntax

{
    'Metrics': [
        {
            'Metric': 'string',
            'Description': 'string',
            'Unit': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Metrics (list) --

      An array of metrics available to query. Each array element contains the full name, description, and unit of the metric.

      • (dict) --

        An object that contains the full name, description, and unit of a metric.

        • Metric (string) --

          The full name of the metric.

        • Description (string) --

          The description of the metric.

        • Unit (string) --

          The unit of the metric.

    • 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

Client Exceptions

Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.

The available client exceptions are:

class PI.Client.exceptions.InternalServiceError

The request failed due to an unknown error.

Example

try:
  ...
except client.exceptions.InternalServiceError as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request failed due to an unknown error.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class PI.Client.exceptions.InvalidArgumentException

One of the arguments provided is invalid for this request.

Example

try:
  ...
except client.exceptions.InvalidArgumentException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    One of the arguments provided is invalid for this request.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class PI.Client.exceptions.NotAuthorizedException

The user is not authorized to perform this request.

Example

try:
  ...
except client.exceptions.NotAuthorizedException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The user is not authorized to perform this request.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.

Paginators

The available paginators are: