ComputeOptimizer / Client / get_rds_database_recommendation_projected_metrics

get_rds_database_recommendation_projected_metrics#

ComputeOptimizer.Client.get_rds_database_recommendation_projected_metrics(**kwargs)#

Returns the projected metrics of Amazon RDS recommendations.

See also: AWS API Documentation

Request Syntax

response = client.get_rds_database_recommendation_projected_metrics(
    resourceArn='string',
    stat='Maximum'|'Average',
    period=123,
    startTime=datetime(2015, 1, 1),
    endTime=datetime(2015, 1, 1),
    recommendationPreferences={
        'cpuVendorArchitectures': [
            'AWS_ARM64'|'CURRENT',
        ]
    }
)
Parameters:

  • resourceArn (string) –

    [REQUIRED]

    The ARN that identifies the Amazon RDS.

    The following is the format of the ARN:

    arn:aws:rds:{region}:{accountId}:db:{resourceName}

  • stat (string) –

    [REQUIRED]

    The statistic of the projected metrics.

  • period (integer) –

    [REQUIRED]

    The granularity, in seconds, of the projected metrics data points.

  • startTime (datetime) –

    [REQUIRED]

    The timestamp of the first projected metrics data point to return.

  • endTime (datetime) –

    [REQUIRED]

    The timestamp of the last projected metrics data point to return.

  • recommendationPreferences (dict) –

    Describes the recommendation preferences to return in the response of a GetAutoScalingGroupRecommendations, GetEC2InstanceRecommendations, GetEC2RecommendationProjectedMetrics, GetRDSDatabaseRecommendations, and GetRDSDatabaseRecommendationProjectedMetrics request.

    • cpuVendorArchitectures (list) –

      Specifies the CPU vendor and architecture for Amazon EC2 instance and Auto Scaling group recommendations.

      For example, when you specify AWS_ARM64 with:

      • A GetEC2InstanceRecommendations or GetAutoScalingGroupRecommendations request, Compute Optimizer returns recommendations that consist of Graviton instance types only.

      • A GetEC2RecommendationProjectedMetrics request, Compute Optimizer returns projected utilization metrics for Graviton instance type recommendations only.

      • A ExportEC2InstanceRecommendations or ExportAutoScalingGroupRecommendations request, Compute Optimizer exports recommendations that consist of Graviton instance types only.

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'recommendedOptionProjectedMetrics': [
        {
            'recommendedDBInstanceClass': 'string',
            'rank': 123,
            'projectedMetrics': [
                {
                    'name': 'CPU'|'Memory'|'EBSVolumeStorageSpaceUtilization'|'NetworkReceiveThroughput'|'NetworkTransmitThroughput'|'EBSVolumeReadIOPS'|'EBSVolumeWriteIOPS'|'EBSVolumeReadThroughput'|'EBSVolumeWriteThroughput'|'DatabaseConnections',
                    'timestamps': [
                        datetime(2015, 1, 1),
                    ],
                    'values': [
                        123.0,
                    ]
                },
            ]
        },
    ]
}

Response Structure

  • (dict) –

    • recommendedOptionProjectedMetrics (list) –

      An array of objects that describes the projected metrics.

      • (dict) –

        Describes the projected metrics of an Amazon RDS recommendation option.

        To determine the performance difference between your current Amazon RDS and the recommended option, compare the metric data of your service against its projected metric data.

        • recommendedDBInstanceClass (string) –

          The recommended DB instance class for the Amazon RDS.

        • rank (integer) –

          The rank identifier of the RDS instance recommendation option.

        • projectedMetrics (list) –

          An array of objects that describe the projected metric.

          • (dict) –

            Describes the projected metrics of an Amazon RDS recommendation option.

            To determine the performance difference between your current Amazon RDS and the recommended option, compare the metric data of your service against its projected metric data.

            • name (string) –

              The name of the projected metric.

            • timestamps (list) –

              The timestamps of the projected metric.

              • (datetime) –

            • values (list) –

              The values for the projected metric.

              • (float) –

Exceptions