PI / Client / list_available_resource_dimensions

list_available_resource_dimensions#

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

  • PI.Client.exceptions.InvalidArgumentException

  • PI.Client.exceptions.InternalServiceError

  • PI.Client.exceptions.NotAuthorizedException