PI / Client / list_available_resource_metrics

list_available_resource_metrics#

PI.Client.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

  • PI.Client.exceptions.InvalidArgumentException

  • PI.Client.exceptions.InternalServiceError

  • PI.Client.exceptions.NotAuthorizedException