DeleteRecommendationPreferences

$result = $client->deleteRecommendationPreferences([/* ... */]);
$promise = $client->deleteRecommendationPreferencesAsync([/* ... */]);

Deletes a recommendation preference, such as enhanced infrastructure metrics.

For more information, see Activating enhanced infrastructure metrics in the Compute Optimizer User Guide.

Parameter Syntax

$result = $client->deleteRecommendationPreferences([
    'recommendationPreferenceNames' => ['<string>', ...], // REQUIRED
    'resourceType' => 'Ec2Instance|AutoScalingGroup|EbsVolume|LambdaFunction|NotApplicable|EcsService|License|RdsDBInstance', // REQUIRED
    'scope' => [
        'name' => 'Organization|AccountId|ResourceArn',
        'value' => '<string>',
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

OptInRequiredException:

The account is not opted in to Compute Optimizer.

InternalServerException:

An internal error has occurred. Try your call again.

ServiceUnavailableException:

The request has failed due to a temporary failure of the server.

AccessDeniedException:

You do not have sufficient access to perform this action.

InvalidParameterValueException:

The value supplied for the input parameter is out of range or not valid.

ResourceNotFoundException:

A resource that is required for the action doesn't exist.

MissingAuthenticationToken:

The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.

ThrottlingException:

The request was denied due to request throttling.

DescribeRecommendationExportJobs

$result = $client->describeRecommendationExportJobs([/* ... */]);
$promise = $client->describeRecommendationExportJobsAsync([/* ... */]);

Describes recommendation export jobs created in the last seven days.

Use the ExportAutoScalingGroupRecommendations or ExportEC2InstanceRecommendations actions to request an export of your recommendations. Then use the DescribeRecommendationExportJobs action to view your export jobs.

Parameter Syntax

$result = $client->describeRecommendationExportJobs([
    'filters' => [
        [
            'name' => 'ResourceType|JobStatus',
            'values' => ['<string>', ...],
        ],
        // ...
    ],
    'jobIds' => ['<string>', ...],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'recommendationExportJobs' => [
        [
            'creationTimestamp' => <DateTime>,
            'destination' => [
                's3' => [
                    'bucket' => '<string>',
                    'key' => '<string>',
                    'metadataKey' => '<string>',
                ],
            ],
            'failureReason' => '<string>',
            'jobId' => '<string>',
            'lastUpdatedTimestamp' => <DateTime>,
            'resourceType' => 'Ec2Instance|AutoScalingGroup|EbsVolume|LambdaFunction|NotApplicable|EcsService|License|RdsDBInstance',
            'status' => 'Queued|InProgress|Complete|Failed',
        ],
        // ...
    ],
]

Result Details

Errors

OptInRequiredException:

The account is not opted in to Compute Optimizer.

InternalServerException:

An internal error has occurred. Try your call again.

ServiceUnavailableException:

The request has failed due to a temporary failure of the server.

AccessDeniedException:

You do not have sufficient access to perform this action.

InvalidParameterValueException:

The value supplied for the input parameter is out of range or not valid.

ResourceNotFoundException:

A resource that is required for the action doesn't exist.

MissingAuthenticationToken:

The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.

ThrottlingException:

The request was denied due to request throttling.

ExportAutoScalingGroupRecommendations

$result = $client->exportAutoScalingGroupRecommendations([/* ... */]);
$promise = $client->exportAutoScalingGroupRecommendationsAsync([/* ... */]);

Exports optimization recommendations for Auto Scaling groups.

Recommendations are exported in a comma-separated values (.csv) file, and its metadata in a JavaScript Object Notation (JSON) (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting Recommendations in the Compute Optimizer User Guide.

You can have only one Auto Scaling group export job in progress per Amazon Web Services Region.

Parameter Syntax

$result = $client->exportAutoScalingGroupRecommendations([
    'accountIds' => ['<string>', ...],
    'fieldsToExport' => ['<string>', ...],
    'fileFormat' => 'Csv',
    'filters' => [
        [
            'name' => 'Finding|FindingReasonCodes|RecommendationSourceType|InferredWorkloadTypes',
            'values' => ['<string>', ...],
        ],
        // ...
    ],
    'includeMemberAccounts' => true || false,
    'recommendationPreferences' => [
        'cpuVendorArchitectures' => ['<string>', ...],
    ],
    's3DestinationConfig' => [ // REQUIRED
        'bucket' => '<string>',
        'keyPrefix' => '<string>',
    ],
]);

Parameter Details

Result Syntax

[
    'jobId' => '<string>',
    's3Destination' => [
        'bucket' => '<string>',
        'key' => '<string>',
        'metadataKey' => '<string>',
    ],
]

Result Details

Errors

OptInRequiredException:

The account is not opted in to Compute Optimizer.

InternalServerException:

An internal error has occurred. Try your call again.

ServiceUnavailableException:

The request has failed due to a temporary failure of the server.

AccessDeniedException:

You do not have sufficient access to perform this action.

InvalidParameterValueException:

The value supplied for the input parameter is out of range or not valid.

MissingAuthenticationToken:

The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.

ThrottlingException:

The request was denied due to request throttling.

LimitExceededException:

The request exceeds a limit of the service.

ExportEBSVolumeRecommendations

$result = $client->exportEBSVolumeRecommendations([/* ... */]);
$promise = $client->exportEBSVolumeRecommendationsAsync([/* ... */]);

Exports optimization recommendations for Amazon EBS volumes.

Recommendations are exported in a comma-separated values (.csv) file, and its metadata in a JavaScript Object Notation (JSON) (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting Recommendations in the Compute Optimizer User Guide.

You can have only one Amazon EBS volume export job in progress per Amazon Web Services Region.

Parameter Syntax

$result = $client->exportEBSVolumeRecommendations([
    'accountIds' => ['<string>', ...],
    'fieldsToExport' => ['<string>', ...],
    'fileFormat' => 'Csv',
    'filters' => [
        [
            'name' => 'Finding',
            'values' => ['<string>', ...],
        ],
        // ...
    ],
    'includeMemberAccounts' => true || false,
    's3DestinationConfig' => [ // REQUIRED
        'bucket' => '<string>',
        'keyPrefix' => '<string>',
    ],
]);

Parameter Details

Result Syntax

[
    'jobId' => '<string>',
    's3Destination' => [
        'bucket' => '<string>',
        'key' => '<string>',
        'metadataKey' => '<string>',
    ],
]

Result Details

Errors

OptInRequiredException:

The account is not opted in to Compute Optimizer.

InternalServerException:

An internal error has occurred. Try your call again.

ServiceUnavailableException:

The request has failed due to a temporary failure of the server.

AccessDeniedException:

You do not have sufficient access to perform this action.

InvalidParameterValueException:

The value supplied for the input parameter is out of range or not valid.

MissingAuthenticationToken:

The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.

ThrottlingException:

The request was denied due to request throttling.

LimitExceededException:

The request exceeds a limit of the service.

ExportEC2InstanceRecommendations

$result = $client->exportEC2InstanceRecommendations([/* ... */]);
$promise = $client->exportEC2InstanceRecommendationsAsync([/* ... */]);

Exports optimization recommendations for Amazon EC2 instances.

Recommendations are exported in a comma-separated values (.csv) file, and its metadata in a JavaScript Object Notation (JSON) (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting Recommendations in the Compute Optimizer User Guide.

You can have only one Amazon EC2 instance export job in progress per Amazon Web Services Region.

Parameter Syntax

$result = $client->exportEC2InstanceRecommendations([
    'accountIds' => ['<string>', ...],
    'fieldsToExport' => ['<string>', ...],
    'fileFormat' => 'Csv',
    'filters' => [
        [
            'name' => 'Finding|FindingReasonCodes|RecommendationSourceType|InferredWorkloadTypes',
            'values' => ['<string>', ...],
        ],
        // ...
    ],
    'includeMemberAccounts' => true || false,
    'recommendationPreferences' => [
        'cpuVendorArchitectures' => ['<string>', ...],
    ],
    's3DestinationConfig' => [ // REQUIRED
        'bucket' => '<string>',
        'keyPrefix' => '<string>',
    ],
]);

Parameter Details

Result Syntax

[
    'jobId' => '<string>',
    's3Destination' => [
        'bucket' => '<string>',
        'key' => '<string>',
        'metadataKey' => '<string>',
    ],
]

Result Details

Errors

OptInRequiredException:

The account is not opted in to Compute Optimizer.

InternalServerException:

An internal error has occurred. Try your call again.

ServiceUnavailableException:

The request has failed due to a temporary failure of the server.

AccessDeniedException:

You do not have sufficient access to perform this action.

InvalidParameterValueException:

The value supplied for the input parameter is out of range or not valid.

MissingAuthenticationToken:

The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.

ThrottlingException:

The request was denied due to request throttling.

LimitExceededException:

The request exceeds a limit of the service.

ExportECSServiceRecommendations

$result = $client->exportECSServiceRecommendations([/* ... */]);
$promise = $client->exportECSServiceRecommendationsAsync([/* ... */]);

Exports optimization recommendations for Amazon ECS services on Fargate.

Recommendations are exported in a CSV file, and its metadata in a JSON file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting Recommendations in the Compute Optimizer User Guide.

You can only have one Amazon ECS service export job in progress per Amazon Web Services Region.

Parameter Syntax

$result = $client->exportECSServiceRecommendations([
    'accountIds' => ['<string>', ...],
    'fieldsToExport' => ['<string>', ...],
    'fileFormat' => 'Csv',
    'filters' => [
        [
            'name' => 'Finding|FindingReasonCode',
            'values' => ['<string>', ...],
        ],
        // ...
    ],
    'includeMemberAccounts' => true || false,
    's3DestinationConfig' => [ // REQUIRED
        'bucket' => '<string>',
        'keyPrefix' => '<string>',
    ],
]);

Parameter Details

Result Syntax

[
    'jobId' => '<string>',
    's3Destination' => [
        'bucket' => '<string>',
        'key' => '<string>',
        'metadataKey' => '<string>',
    ],
]

Result Details

Errors

OptInRequiredException:

The account is not opted in to Compute Optimizer.

InternalServerException:

An internal error has occurred. Try your call again.

ServiceUnavailableException:

The request has failed due to a temporary failure of the server.

AccessDeniedException:

You do not have sufficient access to perform this action.

InvalidParameterValueException:

The value supplied for the input parameter is out of range or not valid.

MissingAuthenticationToken:

The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.

ThrottlingException:

The request was denied due to request throttling.

LimitExceededException:

The request exceeds a limit of the service.

ExportLambdaFunctionRecommendations

$result = $client->exportLambdaFunctionRecommendations([/* ... */]);
$promise = $client->exportLambdaFunctionRecommendationsAsync([/* ... */]);

Exports optimization recommendations for Lambda functions.

Recommendations are exported in a comma-separated values (.csv) file, and its metadata in a JavaScript Object Notation (JSON) (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting Recommendations in the Compute Optimizer User Guide.

You can have only one Lambda function export job in progress per Amazon Web Services Region.

Parameter Syntax

$result = $client->exportLambdaFunctionRecommendations([
    'accountIds' => ['<string>', ...],
    'fieldsToExport' => ['<string>', ...],
    'fileFormat' => 'Csv',
    'filters' => [
        [
            'name' => 'Finding|FindingReasonCode',
            'values' => ['<string>', ...],
        ],
        // ...
    ],
    'includeMemberAccounts' => true || false,
    's3DestinationConfig' => [ // REQUIRED
        'bucket' => '<string>',
        'keyPrefix' => '<string>',
    ],
]);

Parameter Details

Result Syntax

[
    'jobId' => '<string>',
    's3Destination' => [
        'bucket' => '<string>',
        'key' => '<string>',
        'metadataKey' => '<string>',
    ],
]

Result Details

Errors

OptInRequiredException:

The account is not opted in to Compute Optimizer.

InternalServerException:

An internal error has occurred. Try your call again.

ServiceUnavailableException:

The request has failed due to a temporary failure of the server.

AccessDeniedException:

You do not have sufficient access to perform this action.

InvalidParameterValueException:

The value supplied for the input parameter is out of range or not valid.

MissingAuthenticationToken:

The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.

ThrottlingException:

The request was denied due to request throttling.

LimitExceededException:

The request exceeds a limit of the service.

ExportLicenseRecommendations

$result = $client->exportLicenseRecommendations([/* ... */]);
$promise = $client->exportLicenseRecommendationsAsync([/* ... */]);

Export optimization recommendations for your licenses.

Recommendations are exported in a comma-separated values (CSV) file, and its metadata in a JavaScript Object Notation (JSON) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting Recommendations in the Compute Optimizer User Guide.

You can have only one license export job in progress per Amazon Web Services Region.

Parameter Syntax

$result = $client->exportLicenseRecommendations([
    'accountIds' => ['<string>', ...],
    'fieldsToExport' => ['<string>', ...],
    'fileFormat' => 'Csv',
    'filters' => [
        [
            'name' => 'Finding|FindingReasonCode|LicenseName',
            'values' => ['<string>', ...],
        ],
        // ...
    ],
    'includeMemberAccounts' => true || false,
    's3DestinationConfig' => [ // REQUIRED
        'bucket' => '<string>',
        'keyPrefix' => '<string>',
    ],
]);

Parameter Details

Result Syntax

[
    'jobId' => '<string>',
    's3Destination' => [
        'bucket' => '<string>',
        'key' => '<string>',
        'metadataKey' => '<string>',
    ],
]

Result Details

Errors

OptInRequiredException:

The account is not opted in to Compute Optimizer.

InternalServerException:

An internal error has occurred. Try your call again.

ServiceUnavailableException:

The request has failed due to a temporary failure of the server.

AccessDeniedException:

You do not have sufficient access to perform this action.

InvalidParameterValueException:

The value supplied for the input parameter is out of range or not valid.

MissingAuthenticationToken:

The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.

ThrottlingException:

The request was denied due to request throttling.

LimitExceededException:

The request exceeds a limit of the service.

ExportRDSDatabaseRecommendations

$result = $client->exportRDSDatabaseRecommendations([/* ... */]);
$promise = $client->exportRDSDatabaseRecommendationsAsync([/* ... */]);

Export optimization recommendations for your Amazon Relational Database Service (Amazon RDS).

Recommendations are exported in a comma-separated values (CSV) file, and its metadata in a JavaScript Object Notation (JSON) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting Recommendations in the Compute Optimizer User Guide.

You can have only one Amazon RDS export job in progress per Amazon Web Services Region.

Parameter Syntax

$result = $client->exportRDSDatabaseRecommendations([
    'accountIds' => ['<string>', ...],
    'fieldsToExport' => ['<string>', ...],
    'fileFormat' => 'Csv',
    'filters' => [
        [
            'name' => 'InstanceFinding|InstanceFindingReasonCode|StorageFinding|StorageFindingReasonCode|Idle',
            'values' => ['<string>', ...],
        ],
        // ...
    ],
    'includeMemberAccounts' => true || false,
    'recommendationPreferences' => [
        'cpuVendorArchitectures' => ['<string>', ...],
    ],
    's3DestinationConfig' => [ // REQUIRED
        'bucket' => '<string>',
        'keyPrefix' => '<string>',
    ],
]);

Parameter Details

Result Syntax

[
    'jobId' => '<string>',
    's3Destination' => [
        'bucket' => '<string>',
        'key' => '<string>',
        'metadataKey' => '<string>',
    ],
]

Result Details

Errors

OptInRequiredException:

The account is not opted in to Compute Optimizer.

InternalServerException:

An internal error has occurred. Try your call again.

ServiceUnavailableException:

The request has failed due to a temporary failure of the server.

AccessDeniedException:

You do not have sufficient access to perform this action.

InvalidParameterValueException:

The value supplied for the input parameter is out of range or not valid.

MissingAuthenticationToken:

The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.

ThrottlingException:

The request was denied due to request throttling.

LimitExceededException:

The request exceeds a limit of the service.

GetAutoScalingGroupRecommendations

$result = $client->getAutoScalingGroupRecommendations([/* ... */]);
$promise = $client->getAutoScalingGroupRecommendationsAsync([/* ... */]);

Returns Auto Scaling group recommendations.

Compute Optimizer generates recommendations for Amazon EC2 Auto Scaling groups that meet a specific set of requirements. For more information, see the Supported resources and requirements in the Compute Optimizer User Guide.

Parameter Syntax

$result = $client->getAutoScalingGroupRecommendations([
    'accountIds' => ['<string>', ...],
    'autoScalingGroupArns' => ['<string>', ...],
    'filters' => [
        [
            'name' => 'Finding|FindingReasonCodes|RecommendationSourceType|InferredWorkloadTypes',
            'values' => ['<string>', ...],
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'recommendationPreferences' => [
        'cpuVendorArchitectures' => ['<string>', ...],
    ],
]);

Parameter Details

Result Syntax

[
    'autoScalingGroupRecommendations' => [
        [
            'accountId' => '<string>',
            'autoScalingGroupArn' => '<string>',
            'autoScalingGroupName' => '<string>',
            'currentConfiguration' => [
                'desiredCapacity' => <integer>,
                'instanceType' => '<string>',
                'maxSize' => <integer>,
                'minSize' => <integer>,
            ],
            'currentInstanceGpuInfo' => [
                'gpus' => [
                    [
                        'gpuCount' => <integer>,
                        'gpuMemorySizeInMiB' => <integer>,
                    ],
                    // ...
                ],
            ],
            'currentPerformanceRisk' => 'VeryLow|Low|Medium|High',
            'effectiveRecommendationPreferences' => [
                'cpuVendorArchitectures' => ['<string>', ...],
                'enhancedInfrastructureMetrics' => 'Active|Inactive',
                'externalMetricsPreference' => [
                    'source' => 'Datadog|Dynatrace|NewRelic|Instana',
                ],
                'inferredWorkloadTypes' => 'Active|Inactive',
                'lookBackPeriod' => 'DAYS_14|DAYS_32|DAYS_93',
                'preferredResources' => [
                    [
                        'effectiveIncludeList' => ['<string>', ...],
                        'excludeList' => ['<string>', ...],
                        'includeList' => ['<string>', ...],
                        'name' => 'Ec2InstanceTypes',
                    ],
                    // ...
                ],
                'savingsEstimationMode' => [
                    'source' => 'PublicPricing|CostExplorerRightsizing|CostOptimizationHub',
                ],
                'utilizationPreferences' => [
                    [
                        'metricName' => 'CpuUtilization|MemoryUtilization',
                        'metricParameters' => [
                            'headroom' => 'PERCENT_30|PERCENT_20|PERCENT_10|PERCENT_0',
                            'threshold' => 'P90|P95|P99_5',
                        ],
                    ],
                    // ...
                ],
            ],
            'finding' => 'Underprovisioned|Overprovisioned|Optimized|NotOptimized',
            'inferredWorkloadTypes' => ['<string>', ...],
            'lastRefreshTimestamp' => <DateTime>,
            'lookBackPeriodInDays' => <float>,
            'recommendationOptions' => [
                [
                    'configuration' => [
                        'desiredCapacity' => <integer>,
                        'instanceType' => '<string>',
                        'maxSize' => <integer>,
                        'minSize' => <integer>,
                    ],
                    'instanceGpuInfo' => [
                        'gpus' => [
                            [
                                'gpuCount' => <integer>,
                                'gpuMemorySizeInMiB' => <integer>,
                            ],
                            // ...
                        ],
                    ],
                    'migrationEffort' => 'VeryLow|Low|Medium|High',
                    'performanceRisk' => <float>,
                    'projectedUtilizationMetrics' => [
                        [
                            'name' => 'Cpu|Memory|EBS_READ_OPS_PER_SECOND|EBS_WRITE_OPS_PER_SECOND|EBS_READ_BYTES_PER_SECOND|EBS_WRITE_BYTES_PER_SECOND|DISK_READ_OPS_PER_SECOND|DISK_WRITE_OPS_PER_SECOND|DISK_READ_BYTES_PER_SECOND|DISK_WRITE_BYTES_PER_SECOND|NETWORK_IN_BYTES_PER_SECOND|NETWORK_OUT_BYTES_PER_SECOND|NETWORK_PACKETS_IN_PER_SECOND|NETWORK_PACKETS_OUT_PER_SECOND|GPU_PERCENTAGE|GPU_MEMORY_PERCENTAGE',
                            'statistic' => 'Maximum|Average',
                            'value' => <float>,
                        ],
                        // ...
                    ],
                    'rank' => <integer>,
                    'savingsOpportunity' => [
                        'estimatedMonthlySavings' => [
                            'currency' => 'USD|CNY',
                            'value' => <float>,
                        ],
                        'savingsOpportunityPercentage' => <float>,
                    ],
                    'savingsOpportunityAfterDiscounts' => [
                        'estimatedMonthlySavings' => [
                            'currency' => 'USD|CNY',
                            'value' => <float>,
                        ],
                        'savingsOpportunityPercentage' => <float>,
                    ],
                ],
                // ...
            ],
            'utilizationMetrics' => [
                [
                    'name' => 'Cpu|Memory|EBS_READ_OPS_PER_SECOND|EBS_WRITE_OPS_PER_SECOND|EBS_READ_BYTES_PER_SECOND|EBS_WRITE_BYTES_PER_SECOND|DISK_READ_OPS_PER_SECOND|DISK_WRITE_OPS_PER_SECOND|DISK_READ_BYTES_PER_SECOND|DISK_WRITE_BYTES_PER_SECOND|NETWORK_IN_BYTES_PER_SECOND|NETWORK_OUT_BYTES_PER_SECOND|NETWORK_PACKETS_IN_PER_SECOND|NETWORK_PACKETS_OUT_PER_SECOND|GPU_PERCENTAGE|GPU_MEMORY_PERCENTAGE',
                    'statistic' => 'Maximum|Average',
                    'value' => <float>,
                ],
                // ...
            ],
        ],
        // ...
    ],
    'errors' => [
        [
            'code' => '<string>',
            'identifier' => '<string>',
            'message' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

OptInRequiredException:

The account is not opted in to Compute Optimizer.

InternalServerException:

An internal error has occurred. Try your call again.

ServiceUnavailableException:

The request has failed due to a temporary failure of the server.

AccessDeniedException:

You do not have sufficient access to perform this action.

InvalidParameterValueException:

The value supplied for the input parameter is out of range or not valid.

ResourceNotFoundException:

A resource that is required for the action doesn't exist.

MissingAuthenticationToken:

The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.

ThrottlingException:

The request was denied due to request throttling.

GetEBSVolumeRecommendations

$result = $client->getEBSVolumeRecommendations([/* ... */]);
$promise = $client->getEBSVolumeRecommendationsAsync([/* ... */]);

Returns Amazon Elastic Block Store (Amazon EBS) volume recommendations.

Compute Optimizer generates recommendations for Amazon EBS volumes that meet a specific set of requirements. For more information, see the Supported resources and requirements in the Compute Optimizer User Guide.

Parameter Syntax

$result = $client->getEBSVolumeRecommendations([
    'accountIds' => ['<string>', ...],
    'filters' => [
        [
            'name' => 'Finding',
            'values' => ['<string>', ...],
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'volumeArns' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'errors' => [
        [
            'code' => '<string>',
            'identifier' => '<string>',
            'message' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
    'volumeRecommendations' => [
        [
            'accountId' => '<string>',
            'currentConfiguration' => [
                'rootVolume' => true || false,
                'volumeBaselineIOPS' => <integer>,
                'volumeBaselineThroughput' => <integer>,
                'volumeBurstIOPS' => <integer>,
                'volumeBurstThroughput' => <integer>,
                'volumeSize' => <integer>,
                'volumeType' => '<string>',
            ],
            'currentPerformanceRisk' => 'VeryLow|Low|Medium|High',
            'effectiveRecommendationPreferences' => [
                'savingsEstimationMode' => [
                    'source' => 'PublicPricing|CostExplorerRightsizing|CostOptimizationHub',
                ],
            ],
            'finding' => 'Optimized|NotOptimized',
            'lastRefreshTimestamp' => <DateTime>,
            'lookBackPeriodInDays' => <float>,
            'tags' => [
                [
                    'key' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'utilizationMetrics' => [
                [
                    'name' => 'VolumeReadOpsPerSecond|VolumeWriteOpsPerSecond|VolumeReadBytesPerSecond|VolumeWriteBytesPerSecond',
                    'statistic' => 'Maximum|Average',
                    'value' => <float>,
                ],
                // ...
            ],
            'volumeArn' => '<string>',
            'volumeRecommendationOptions' => [
                [
                    'configuration' => [
                        'rootVolume' => true || false,
                        'volumeBaselineIOPS' => <integer>,
                        'volumeBaselineThroughput' => <integer>,
                        'volumeBurstIOPS' => <integer>,
                        'volumeBurstThroughput' => <integer>,
                        'volumeSize' => <integer>,
                        'volumeType' => '<string>',
                    ],
                    'performanceRisk' => <float>,
                    'rank' => <integer>,
                    'savingsOpportunity' => [
                        'estimatedMonthlySavings' => [
                            'currency' => 'USD|CNY',
                            'value' => <float>,
                        ],
                        'savingsOpportunityPercentage' => <float>,
                    ],
                    'savingsOpportunityAfterDiscounts' => [
                        'estimatedMonthlySavings' => [
                            'currency' => 'USD|CNY',
                            'value' => <float>,
                        ],
                        'savingsOpportunityPercentage' => <float>,
                    ],
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Errors

OptInRequiredException:

The account is not opted in to Compute Optimizer.

InternalServerException:

An internal error has occurred. Try your call again.

ServiceUnavailableException:

The request has failed due to a temporary failure of the server.

AccessDeniedException:

You do not have sufficient access to perform this action.

InvalidParameterValueException:

The value supplied for the input parameter is out of range or not valid.

ResourceNotFoundException:

A resource that is required for the action doesn't exist.

MissingAuthenticationToken:

The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.

ThrottlingException:

The request was denied due to request throttling.

GetEC2InstanceRecommendations

$result = $client->getEC2InstanceRecommendations([/* ... */]);
$promise = $client->getEC2InstanceRecommendationsAsync([/* ... */]);

Returns Amazon EC2 instance recommendations.

Compute Optimizer generates recommendations for Amazon Elastic Compute Cloud (Amazon EC2) instances that meet a specific set of requirements. For more information, see the Supported resources and requirements in the Compute Optimizer User Guide.

Parameter Syntax

$result = $client->getEC2InstanceRecommendations([
    'accountIds' => ['<string>', ...],
    'filters' => [
        [
            'name' => 'Finding|FindingReasonCodes|RecommendationSourceType|InferredWorkloadTypes',
            'values' => ['<string>', ...],
        ],
        // ...
    ],
    'instanceArns' => ['<string>', ...],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'recommendationPreferences' => [
        'cpuVendorArchitectures' => ['<string>', ...],
    ],
]);

Parameter Details

Result Syntax

[
    'errors' => [
        [
            'code' => '<string>',
            'identifier' => '<string>',
            'message' => '<string>',
        ],
        // ...
    ],
    'instanceRecommendations' => [
        [
            'accountId' => '<string>',
            'currentInstanceGpuInfo' => [
                'gpus' => [
                    [
                        'gpuCount' => <integer>,
                        'gpuMemorySizeInMiB' => <integer>,
                    ],
                    // ...
                ],
            ],
            'currentInstanceType' => '<string>',
            'currentPerformanceRisk' => 'VeryLow|Low|Medium|High',
            'effectiveRecommendationPreferences' => [
                'cpuVendorArchitectures' => ['<string>', ...],
                'enhancedInfrastructureMetrics' => 'Active|Inactive',
                'externalMetricsPreference' => [
                    'source' => 'Datadog|Dynatrace|NewRelic|Instana',
                ],
                'inferredWorkloadTypes' => 'Active|Inactive',
                'lookBackPeriod' => 'DAYS_14|DAYS_32|DAYS_93',
                'preferredResources' => [
                    [
                        'effectiveIncludeList' => ['<string>', ...],
                        'excludeList' => ['<string>', ...],
                        'includeList' => ['<string>', ...],
                        'name' => 'Ec2InstanceTypes',
                    ],
                    // ...
                ],
                'savingsEstimationMode' => [
                    'source' => 'PublicPricing|CostExplorerRightsizing|CostOptimizationHub',
                ],
                'utilizationPreferences' => [
                    [
                        'metricName' => 'CpuUtilization|MemoryUtilization',
                        'metricParameters' => [
                            'headroom' => 'PERCENT_30|PERCENT_20|PERCENT_10|PERCENT_0',
                            'threshold' => 'P90|P95|P99_5',
                        ],
                    ],
                    // ...
                ],
            ],
            'externalMetricStatus' => [
                'statusCode' => 'NO_EXTERNAL_METRIC_SET|INTEGRATION_SUCCESS|DATADOG_INTEGRATION_ERROR|DYNATRACE_INTEGRATION_ERROR|NEWRELIC_INTEGRATION_ERROR|INSTANA_INTEGRATION_ERROR|INSUFFICIENT_DATADOG_METRICS|INSUFFICIENT_DYNATRACE_METRICS|INSUFFICIENT_NEWRELIC_METRICS|INSUFFICIENT_INSTANA_METRICS',
                'statusReason' => '<string>',
            ],
            'finding' => 'Underprovisioned|Overprovisioned|Optimized|NotOptimized',
            'findingReasonCodes' => ['<string>', ...],
            'idle' => 'True|False',
            'inferredWorkloadTypes' => ['<string>', ...],
            'instanceArn' => '<string>',
            'instanceName' => '<string>',
            'instanceState' => 'pending|running|shutting-down|terminated|stopping|stopped',
            'lastRefreshTimestamp' => <DateTime>,
            'lookBackPeriodInDays' => <float>,
            'recommendationOptions' => [
                [
                    'instanceGpuInfo' => [
                        'gpus' => [
                            [
                                'gpuCount' => <integer>,
                                'gpuMemorySizeInMiB' => <integer>,
                            ],
                            // ...
                        ],
                    ],
                    'instanceType' => '<string>',
                    'migrationEffort' => 'VeryLow|Low|Medium|High',
                    'performanceRisk' => <float>,
                    'platformDifferences' => ['<string>', ...],
                    'projectedUtilizationMetrics' => [
                        [
                            'name' => 'Cpu|Memory|EBS_READ_OPS_PER_SECOND|EBS_WRITE_OPS_PER_SECOND|EBS_READ_BYTES_PER_SECOND|EBS_WRITE_BYTES_PER_SECOND|DISK_READ_OPS_PER_SECOND|DISK_WRITE_OPS_PER_SECOND|DISK_READ_BYTES_PER_SECOND|DISK_WRITE_BYTES_PER_SECOND|NETWORK_IN_BYTES_PER_SECOND|NETWORK_OUT_BYTES_PER_SECOND|NETWORK_PACKETS_IN_PER_SECOND|NETWORK_PACKETS_OUT_PER_SECOND|GPU_PERCENTAGE|GPU_MEMORY_PERCENTAGE',
                            'statistic' => 'Maximum|Average',
                            'value' => <float>,
                        ],
                        // ...
                    ],
                    'rank' => <integer>,
                    'savingsOpportunity' => [
                        'estimatedMonthlySavings' => [
                            'currency' => 'USD|CNY',
                            'value' => <float>,
                        ],
                        'savingsOpportunityPercentage' => <float>,
                    ],
                    'savingsOpportunityAfterDiscounts' => [
                        'estimatedMonthlySavings' => [
                            'currency' => 'USD|CNY',
                            'value' => <float>,
                        ],
                        'savingsOpportunityPercentage' => <float>,
                    ],
                ],
                // ...
            ],
            'recommendationSources' => [
                [
                    'recommendationSourceArn' => '<string>',
                    'recommendationSourceType' => 'Ec2Instance|AutoScalingGroup|EbsVolume|LambdaFunction|EcsService|License|RdsDBInstance|RdsDBInstanceStorage',
                ],
                // ...
            ],
            'tags' => [
                [
                    'key' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'utilizationMetrics' => [
                [
                    'name' => 'Cpu|Memory|EBS_READ_OPS_PER_SECOND|EBS_WRITE_OPS_PER_SECOND|EBS_READ_BYTES_PER_SECOND|EBS_WRITE_BYTES_PER_SECOND|DISK_READ_OPS_PER_SECOND|DISK_WRITE_OPS_PER_SECOND|DISK_READ_BYTES_PER_SECOND|DISK_WRITE_BYTES_PER_SECOND|NETWORK_IN_BYTES_PER_SECOND|NETWORK_OUT_BYTES_PER_SECOND|NETWORK_PACKETS_IN_PER_SECOND|NETWORK_PACKETS_OUT_PER_SECOND|GPU_PERCENTAGE|GPU_MEMORY_PERCENTAGE',
                    'statistic' => 'Maximum|Average',
                    'value' => <float>,
                ],
                // ...
            ],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

OptInRequiredException:

The account is not opted in to Compute Optimizer.

InternalServerException:

An internal error has occurred. Try your call again.

ServiceUnavailableException:

The request has failed due to a temporary failure of the server.

AccessDeniedException:

You do not have sufficient access to perform this action.

InvalidParameterValueException:

The value supplied for the input parameter is out of range or not valid.

ResourceNotFoundException:

A resource that is required for the action doesn't exist.

MissingAuthenticationToken:

The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.

ThrottlingException:

The request was denied due to request throttling.

GetEC2RecommendationProjectedMetrics

$result = $client->getEC2RecommendationProjectedMetrics([/* ... */]);
$promise = $client->getEC2RecommendationProjectedMetricsAsync([/* ... */]);

Returns the projected utilization metrics of Amazon EC2 instance recommendations.

Parameter Syntax

$result = $client->getEC2RecommendationProjectedMetrics([
    'endTime' => <integer || string || DateTime>, // REQUIRED
    'instanceArn' => '<string>', // REQUIRED
    'period' => <integer>, // REQUIRED
    'recommendationPreferences' => [
        'cpuVendorArchitectures' => ['<string>', ...],
    ],
    'startTime' => <integer || string || DateTime>, // REQUIRED
    'stat' => 'Maximum|Average', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'recommendedOptionProjectedMetrics' => [
        [
            'projectedMetrics' => [
                [
                    'name' => 'Cpu|Memory|EBS_READ_OPS_PER_SECOND|EBS_WRITE_OPS_PER_SECOND|EBS_READ_BYTES_PER_SECOND|EBS_WRITE_BYTES_PER_SECOND|DISK_READ_OPS_PER_SECOND|DISK_WRITE_OPS_PER_SECOND|DISK_READ_BYTES_PER_SECOND|DISK_WRITE_BYTES_PER_SECOND|NETWORK_IN_BYTES_PER_SECOND|NETWORK_OUT_BYTES_PER_SECOND|NETWORK_PACKETS_IN_PER_SECOND|NETWORK_PACKETS_OUT_PER_SECOND|GPU_PERCENTAGE|GPU_MEMORY_PERCENTAGE',
                    'timestamps' => [<DateTime>, ...],
                    'values' => [<float>, ...],
                ],
                // ...
            ],
            'rank' => <integer>,
            'recommendedInstanceType' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

OptInRequiredException:

The account is not opted in to Compute Optimizer.

InternalServerException:

An internal error has occurred. Try your call again.

ServiceUnavailableException:

The request has failed due to a temporary failure of the server.

AccessDeniedException:

You do not have sufficient access to perform this action.

InvalidParameterValueException:

The value supplied for the input parameter is out of range or not valid.

ResourceNotFoundException:

A resource that is required for the action doesn't exist.

MissingAuthenticationToken:

The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.

ThrottlingException:

The request was denied due to request throttling.

GetECSServiceRecommendationProjectedMetrics

$result = $client->getECSServiceRecommendationProjectedMetrics([/* ... */]);
$promise = $client->getECSServiceRecommendationProjectedMetricsAsync([/* ... */]);

Returns the projected metrics of Amazon ECS service recommendations.

Parameter Syntax

$result = $client->getECSServiceRecommendationProjectedMetrics([
    'endTime' => <integer || string || DateTime>, // REQUIRED
    'period' => <integer>, // REQUIRED
    'serviceArn' => '<string>', // REQUIRED
    'startTime' => <integer || string || DateTime>, // REQUIRED
    'stat' => 'Maximum|Average', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'recommendedOptionProjectedMetrics' => [
        [
            'projectedMetrics' => [
                [
                    'lowerBoundValues' => [<float>, ...],
                    'name' => 'Cpu|Memory',
                    'timestamps' => [<DateTime>, ...],
                    'upperBoundValues' => [<float>, ...],
                ],
                // ...
            ],
            'recommendedCpuUnits' => <integer>,
            'recommendedMemorySize' => <integer>,
        ],
        // ...
    ],
]

Result Details

Errors

OptInRequiredException:

The account is not opted in to Compute Optimizer.

InternalServerException:

An internal error has occurred. Try your call again.

ServiceUnavailableException:

The request has failed due to a temporary failure of the server.

AccessDeniedException:

You do not have sufficient access to perform this action.

InvalidParameterValueException:

The value supplied for the input parameter is out of range or not valid.

ResourceNotFoundException:

A resource that is required for the action doesn't exist.

MissingAuthenticationToken:

The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.

ThrottlingException:

The request was denied due to request throttling.

GetECSServiceRecommendations

$result = $client->getECSServiceRecommendations([/* ... */]);
$promise = $client->getECSServiceRecommendationsAsync([/* ... */]);

Returns Amazon ECS service recommendations.

Compute Optimizer generates recommendations for Amazon ECS services on Fargate that meet a specific set of requirements. For more information, see the Supported resources and requirements in the Compute Optimizer User Guide.

Parameter Syntax

$result = $client->getECSServiceRecommendations([
    'accountIds' => ['<string>', ...],
    'filters' => [
        [
            'name' => 'Finding|FindingReasonCode',
            'values' => ['<string>', ...],
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'serviceArns' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'ecsServiceRecommendations' => [
        [
            'accountId' => '<string>',
            'currentPerformanceRisk' => 'VeryLow|Low|Medium|High',
            'currentServiceConfiguration' => [
                'autoScalingConfiguration' => 'TargetTrackingScalingCpu|TargetTrackingScalingMemory',
                'containerConfigurations' => [
                    [
                        'containerName' => '<string>',
                        'cpu' => <integer>,
                        'memorySizeConfiguration' => [
                            'memory' => <integer>,
                            'memoryReservation' => <integer>,
                        ],
                    ],
                    // ...
                ],
                'cpu' => <integer>,
                'memory' => <integer>,
                'taskDefinitionArn' => '<string>',
            ],
            'effectiveRecommendationPreferences' => [
                'savingsEstimationMode' => [
                    'source' => 'PublicPricing|CostExplorerRightsizing|CostOptimizationHub',
                ],
            ],
            'finding' => 'Optimized|Underprovisioned|Overprovisioned',
            'findingReasonCodes' => ['<string>', ...],
            'lastRefreshTimestamp' => <DateTime>,
            'launchType' => 'EC2|Fargate',
            'lookbackPeriodInDays' => <float>,
            'serviceArn' => '<string>',
            'serviceRecommendationOptions' => [
                [
                    'containerRecommendations' => [
                        [
                            'containerName' => '<string>',
                            'cpu' => <integer>,
                            'memorySizeConfiguration' => [
                                'memory' => <integer>,
                                'memoryReservation' => <integer>,
                            ],
                        ],
                        // ...
                    ],
                    'cpu' => <integer>,
                    'memory' => <integer>,
                    'projectedUtilizationMetrics' => [
                        [
                            'lowerBoundValue' => <float>,
                            'name' => 'Cpu|Memory',
                            'statistic' => 'Maximum|Average',
                            'upperBoundValue' => <float>,
                        ],
                        // ...
                    ],
                    'savingsOpportunity' => [
                        'estimatedMonthlySavings' => [
                            'currency' => 'USD|CNY',
                            'value' => <float>,
                        ],
                        'savingsOpportunityPercentage' => <float>,
                    ],
                    'savingsOpportunityAfterDiscounts' => [
                        'estimatedMonthlySavings' => [
                            'currency' => 'USD|CNY',
                            'value' => <float>,
                        ],
                        'savingsOpportunityPercentage' => <float>,
                    ],
                ],
                // ...
            ],
            'tags' => [
                [
                    'key' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'utilizationMetrics' => [
                [
                    'name' => 'Cpu|Memory',
                    'statistic' => 'Maximum|Average',
                    'value' => <float>,
                ],
                // ...
            ],
        ],
        // ...
    ],
    'errors' => [
        [
            'code' => '<string>',
            'identifier' => '<string>',
            'message' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

OptInRequiredException:

The account is not opted in to Compute Optimizer.

InternalServerException:

An internal error has occurred. Try your call again.

ServiceUnavailableException:

The request has failed due to a temporary failure of the server.

AccessDeniedException:

You do not have sufficient access to perform this action.

InvalidParameterValueException:

The value supplied for the input parameter is out of range or not valid.

ResourceNotFoundException:

A resource that is required for the action doesn't exist.

MissingAuthenticationToken:

The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.

ThrottlingException:

The request was denied due to request throttling.

GetEffectiveRecommendationPreferences

$result = $client->getEffectiveRecommendationPreferences([/* ... */]);
$promise = $client->getEffectiveRecommendationPreferencesAsync([/* ... */]);

Returns the recommendation preferences that are in effect for a given resource, such as enhanced infrastructure metrics. Considers all applicable preferences that you might have set at the resource, account, and organization level.

When you create a recommendation preference, you can set its status to Active or Inactive. Use this action to view the recommendation preferences that are in effect, or Active.

Parameter Syntax

$result = $client->getEffectiveRecommendationPreferences([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'enhancedInfrastructureMetrics' => 'Active|Inactive',
    'externalMetricsPreference' => [
        'source' => 'Datadog|Dynatrace|NewRelic|Instana',
    ],
    'lookBackPeriod' => 'DAYS_14|DAYS_32|DAYS_93',
    'preferredResources' => [
        [
            'effectiveIncludeList' => ['<string>', ...],
            'excludeList' => ['<string>', ...],
            'includeList' => ['<string>', ...],
            'name' => 'Ec2InstanceTypes',
        ],
        // ...
    ],
    'utilizationPreferences' => [
        [
            'metricName' => 'CpuUtilization|MemoryUtilization',
            'metricParameters' => [
                'headroom' => 'PERCENT_30|PERCENT_20|PERCENT_10|PERCENT_0',
                'threshold' => 'P90|P95|P99_5',
            ],
        ],
        // ...
    ],
]

Result Details

Errors

OptInRequiredException:

The account is not opted in to Compute Optimizer.

InternalServerException:

An internal error has occurred. Try your call again.

ServiceUnavailableException:

The request has failed due to a temporary failure of the server.

AccessDeniedException:

You do not have sufficient access to perform this action.

InvalidParameterValueException:

The value supplied for the input parameter is out of range or not valid.

ResourceNotFoundException:

A resource that is required for the action doesn't exist.

MissingAuthenticationToken:

The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.

ThrottlingException:

The request was denied due to request throttling.

GetEnrollmentStatus

$result = $client->getEnrollmentStatus([/* ... */]);
$promise = $client->getEnrollmentStatusAsync([/* ... */]);

Returns the enrollment (opt in) status of an account to the Compute Optimizer service.

If the account is the management account of an organization, this action also confirms the enrollment status of member accounts of the organization. Use the GetEnrollmentStatusesForOrganization action to get detailed information about the enrollment status of member accounts of an organization.

Parameter Syntax

$result = $client->getEnrollmentStatus([
]);

Parameter Details

Result Syntax

[
    'lastUpdatedTimestamp' => <DateTime>,
    'memberAccountsEnrolled' => true || false,
    'numberOfMemberAccountsOptedIn' => <integer>,
    'status' => 'Active|Inactive|Pending|Failed',
    'statusReason' => '<string>',
]

Result Details

Errors

InternalServerException:

An internal error has occurred. Try your call again.

ServiceUnavailableException:

The request has failed due to a temporary failure of the server.

AccessDeniedException:

You do not have sufficient access to perform this action.

InvalidParameterValueException:

The value supplied for the input parameter is out of range or not valid.

MissingAuthenticationToken:

The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.

ThrottlingException:

The request was denied due to request throttling.

GetEnrollmentStatusesForOrganization

$result = $client->getEnrollmentStatusesForOrganization([/* ... */]);
$promise = $client->getEnrollmentStatusesForOrganizationAsync([/* ... */]);

Returns the Compute Optimizer enrollment (opt-in) status of organization member accounts, if your account is an organization management account.

To get the enrollment status of standalone accounts, use the GetEnrollmentStatus action.

Parameter Syntax

$result = $client->getEnrollmentStatusesForOrganization([
    'filters' => [
        [
            'name' => 'Status',
            'values' => ['<string>', ...],
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'accountEnrollmentStatuses' => [
        [
            'accountId' => '<string>',
            'lastUpdatedTimestamp' => <DateTime>,
            'status' => 'Active|Inactive|Pending|Failed',
            'statusReason' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

InternalServerException:

An internal error has occurred. Try your call again.

ServiceUnavailableException:

The request has failed due to a temporary failure of the server.

AccessDeniedException:

You do not have sufficient access to perform this action.

InvalidParameterValueException:

The value supplied for the input parameter is out of range or not valid.

MissingAuthenticationToken:

The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.

ThrottlingException:

The request was denied due to request throttling.

GetLambdaFunctionRecommendations

$result = $client->getLambdaFunctionRecommendations([/* ... */]);
$promise = $client->getLambdaFunctionRecommendationsAsync([/* ... */]);

Returns Lambda function recommendations.

Compute Optimizer generates recommendations for functions that meet a specific set of requirements. For more information, see the Supported resources and requirements in the Compute Optimizer User Guide.

Parameter Syntax

$result = $client->getLambdaFunctionRecommendations([
    'accountIds' => ['<string>', ...],
    'filters' => [
        [
            'name' => 'Finding|FindingReasonCode',
            'values' => ['<string>', ...],
        ],
        // ...
    ],
    'functionArns' => ['<string>', ...],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'lambdaFunctionRecommendations' => [
        [
            'accountId' => '<string>',
            'currentMemorySize' => <integer>,
            'currentPerformanceRisk' => 'VeryLow|Low|Medium|High',
            'effectiveRecommendationPreferences' => [
                'savingsEstimationMode' => [
                    'source' => 'PublicPricing|CostExplorerRightsizing|CostOptimizationHub',
                ],
            ],
            'finding' => 'Optimized|NotOptimized|Unavailable',
            'findingReasonCodes' => ['<string>', ...],
            'functionArn' => '<string>',
            'functionVersion' => '<string>',
            'lastRefreshTimestamp' => <DateTime>,
            'lookbackPeriodInDays' => <float>,
            'memorySizeRecommendationOptions' => [
                [
                    'memorySize' => <integer>,
                    'projectedUtilizationMetrics' => [
                        [
                            'name' => 'Duration',
                            'statistic' => 'LowerBound|UpperBound|Expected',
                            'value' => <float>,
                        ],
                        // ...
                    ],
                    'rank' => <integer>,
                    'savingsOpportunity' => [
                        'estimatedMonthlySavings' => [
                            'currency' => 'USD|CNY',
                            'value' => <float>,
                        ],
                        'savingsOpportunityPercentage' => <float>,
                    ],
                    'savingsOpportunityAfterDiscounts' => [
                        'estimatedMonthlySavings' => [
                            'currency' => 'USD|CNY',
                            'value' => <float>,
                        ],
                        'savingsOpportunityPercentage' => <float>,
                    ],
                ],
                // ...
            ],
            'numberOfInvocations' => <integer>,
            'tags' => [
                [
                    'key' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'utilizationMetrics' => [
                [
                    'name' => 'Duration|Memory',
                    'statistic' => 'Maximum|Average',
                    'value' => <float>,
                ],
                // ...
            ],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

OptInRequiredException:

The account is not opted in to Compute Optimizer.

InternalServerException:

An internal error has occurred. Try your call again.

ServiceUnavailableException:

The request has failed due to a temporary failure of the server.

AccessDeniedException:

You do not have sufficient access to perform this action.

InvalidParameterValueException:

The value supplied for the input parameter is out of range or not valid.

MissingAuthenticationToken:

The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.

ThrottlingException:

The request was denied due to request throttling.

LimitExceededException:

The request exceeds a limit of the service.

GetLicenseRecommendations

$result = $client->getLicenseRecommendations([/* ... */]);
$promise = $client->getLicenseRecommendationsAsync([/* ... */]);

Returns license recommendations for Amazon EC2 instances that run on a specific license.

Compute Optimizer generates recommendations for licenses that meet a specific set of requirements. For more information, see the Supported resources and requirements in the Compute Optimizer User Guide.

Parameter Syntax

$result = $client->getLicenseRecommendations([
    'accountIds' => ['<string>', ...],
    'filters' => [
        [
            'name' => 'Finding|FindingReasonCode|LicenseName',
            'values' => ['<string>', ...],
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'resourceArns' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'errors' => [
        [
            'code' => '<string>',
            'identifier' => '<string>',
            'message' => '<string>',
        ],
        // ...
    ],
    'licenseRecommendations' => [
        [
            'accountId' => '<string>',
            'currentLicenseConfiguration' => [
                'instanceType' => '<string>',
                'licenseEdition' => 'Enterprise|Standard|Free|NoLicenseEditionFound',
                'licenseModel' => 'LicenseIncluded|BringYourOwnLicense',
                'licenseName' => 'SQLServer',
                'licenseVersion' => '<string>',
                'metricsSource' => [
                    [
                        'provider' => 'CloudWatchApplicationInsights',
                        'providerArn' => '<string>',
                    ],
                    // ...
                ],
                'numberOfCores' => <integer>,
                'operatingSystem' => '<string>',
            ],
            'finding' => 'InsufficientMetrics|Optimized|NotOptimized',
            'findingReasonCodes' => ['<string>', ...],
            'lastRefreshTimestamp' => <DateTime>,
            'licenseRecommendationOptions' => [
                [
                    'licenseEdition' => 'Enterprise|Standard|Free|NoLicenseEditionFound',
                    'licenseModel' => 'LicenseIncluded|BringYourOwnLicense',
                    'operatingSystem' => '<string>',
                    'rank' => <integer>,
                    'savingsOpportunity' => [
                        'estimatedMonthlySavings' => [
                            'currency' => 'USD|CNY',
                            'value' => <float>,
                        ],
                        'savingsOpportunityPercentage' => <float>,
                    ],
                ],
                // ...
            ],
            'lookbackPeriodInDays' => <float>,
            'resourceArn' => '<string>',
            'tags' => [
                [
                    'key' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

OptInRequiredException:

The account is not opted in to Compute Optimizer.

InternalServerException:

An internal error has occurred. Try your call again.

ServiceUnavailableException:

The request has failed due to a temporary failure of the server.

AccessDeniedException:

You do not have sufficient access to perform this action.

InvalidParameterValueException:

The value supplied for the input parameter is out of range or not valid.

ResourceNotFoundException:

A resource that is required for the action doesn't exist.

MissingAuthenticationToken:

The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.

ThrottlingException:

The request was denied due to request throttling.

GetRDSDatabaseRecommendationProjectedMetrics

$result = $client->getRDSDatabaseRecommendationProjectedMetrics([/* ... */]);
$promise = $client->getRDSDatabaseRecommendationProjectedMetricsAsync([/* ... */]);

Returns the projected metrics of Amazon RDS recommendations.

Parameter Syntax

$result = $client->getRDSDatabaseRecommendationProjectedMetrics([
    'endTime' => <integer || string || DateTime>, // REQUIRED
    'period' => <integer>, // REQUIRED
    'recommendationPreferences' => [
        'cpuVendorArchitectures' => ['<string>', ...],
    ],
    'resourceArn' => '<string>', // REQUIRED
    'startTime' => <integer || string || DateTime>, // REQUIRED
    'stat' => 'Maximum|Average', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'recommendedOptionProjectedMetrics' => [
        [
            'projectedMetrics' => [
                [
                    'name' => 'CPU|Memory|EBSVolumeStorageSpaceUtilization|NetworkReceiveThroughput|NetworkTransmitThroughput|EBSVolumeReadIOPS|EBSVolumeWriteIOPS|EBSVolumeReadThroughput|EBSVolumeWriteThroughput|DatabaseConnections',
                    'timestamps' => [<DateTime>, ...],
                    'values' => [<float>, ...],
                ],
                // ...
            ],
            'rank' => <integer>,
            'recommendedDBInstanceClass' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

OptInRequiredException:

The account is not opted in to Compute Optimizer.

InternalServerException:

An internal error has occurred. Try your call again.

ServiceUnavailableException:

The request has failed due to a temporary failure of the server.

AccessDeniedException:

You do not have sufficient access to perform this action.

InvalidParameterValueException:

The value supplied for the input parameter is out of range or not valid.

ResourceNotFoundException:

A resource that is required for the action doesn't exist.

MissingAuthenticationToken:

The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.

ThrottlingException:

The request was denied due to request throttling.

GetRDSDatabaseRecommendations

$result = $client->getRDSDatabaseRecommendations([/* ... */]);
$promise = $client->getRDSDatabaseRecommendationsAsync([/* ... */]);

Returns Amazon RDS recommendations.

Compute Optimizer generates recommendations for Amazon RDS that meet a specific set of requirements. For more information, see the Supported resources and requirements in the Compute Optimizer User Guide.

Parameter Syntax

$result = $client->getRDSDatabaseRecommendations([
    'accountIds' => ['<string>', ...],
    'filters' => [
        [
            'name' => 'InstanceFinding|InstanceFindingReasonCode|StorageFinding|StorageFindingReasonCode|Idle',
            'values' => ['<string>', ...],
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'recommendationPreferences' => [
        'cpuVendorArchitectures' => ['<string>', ...],
    ],
    'resourceArns' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'errors' => [
        [
            'code' => '<string>',
            'identifier' => '<string>',
            'message' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
    'rdsDBRecommendations' => [
        [
            'accountId' => '<string>',
            'currentDBInstanceClass' => '<string>',
            'currentStorageConfiguration' => [
                'allocatedStorage' => <integer>,
                'iops' => <integer>,
                'maxAllocatedStorage' => <integer>,
                'storageThroughput' => <integer>,
                'storageType' => '<string>',
            ],
            'effectiveRecommendationPreferences' => [
                'cpuVendorArchitectures' => ['<string>', ...],
                'enhancedInfrastructureMetrics' => 'Active|Inactive',
                'lookBackPeriod' => 'DAYS_14|DAYS_32|DAYS_93',
                'savingsEstimationMode' => [
                    'source' => 'PublicPricing|CostExplorerRightsizing|CostOptimizationHub',
                ],
            ],
            'engine' => '<string>',
            'engineVersion' => '<string>',
            'idle' => 'True|False',
            'instanceFinding' => 'Optimized|Underprovisioned|Overprovisioned',
            'instanceFindingReasonCodes' => ['<string>', ...],
            'instanceRecommendationOptions' => [
                [
                    'dbInstanceClass' => '<string>',
                    'performanceRisk' => <float>,
                    'projectedUtilizationMetrics' => [
                        [
                            'name' => 'CPU|Memory|EBSVolumeStorageSpaceUtilization|NetworkReceiveThroughput|NetworkTransmitThroughput|EBSVolumeReadIOPS|EBSVolumeWriteIOPS|EBSVolumeReadThroughput|EBSVolumeWriteThroughput|DatabaseConnections',
                            'statistic' => 'Maximum|Minimum|Average',
                            'value' => <float>,
                        ],
                        // ...
                    ],
                    'rank' => <integer>,
                    'savingsOpportunity' => [
                        'estimatedMonthlySavings' => [
                            'currency' => 'USD|CNY',
                            'value' => <float>,
                        ],
                        'savingsOpportunityPercentage' => <float>,
                    ],
                    'savingsOpportunityAfterDiscounts' => [
                        'estimatedMonthlySavings' => [
                            'currency' => 'USD|CNY',
                            'value' => <float>,
                        ],
                        'savingsOpportunityPercentage' => <float>,
                    ],
                ],
                // ...
            ],
            'lastRefreshTimestamp' => <DateTime>,
            'lookbackPeriodInDays' => <float>,
            'resourceArn' => '<string>',
            'storageFinding' => 'Optimized|Underprovisioned|Overprovisioned',
            'storageFindingReasonCodes' => ['<string>', ...],
            'storageRecommendationOptions' => [
                [
                    'rank' => <integer>,
                    'savingsOpportunity' => [
                        'estimatedMonthlySavings' => [
                            'currency' => 'USD|CNY',
                            'value' => <float>,
                        ],
                        'savingsOpportunityPercentage' => <float>,
                    ],
                    'savingsOpportunityAfterDiscounts' => [
                        'estimatedMonthlySavings' => [
                            'currency' => 'USD|CNY',
                            'value' => <float>,
                        ],
                        'savingsOpportunityPercentage' => <float>,
                    ],
                    'storageConfiguration' => [
                        'allocatedStorage' => <integer>,
                        'iops' => <integer>,
                        'maxAllocatedStorage' => <integer>,
                        'storageThroughput' => <integer>,
                        'storageType' => '<string>',
                    ],
                ],
                // ...
            ],
            'tags' => [
                [
                    'key' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'utilizationMetrics' => [
                [
                    'name' => 'CPU|Memory|EBSVolumeStorageSpaceUtilization|NetworkReceiveThroughput|NetworkTransmitThroughput|EBSVolumeReadIOPS|EBSVolumeWriteIOPS|EBSVolumeReadThroughput|EBSVolumeWriteThroughput|DatabaseConnections',
                    'statistic' => 'Maximum|Minimum|Average',
                    'value' => <float>,
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Errors

OptInRequiredException:

The account is not opted in to Compute Optimizer.

InternalServerException:

An internal error has occurred. Try your call again.

ServiceUnavailableException:

The request has failed due to a temporary failure of the server.

AccessDeniedException:

You do not have sufficient access to perform this action.

InvalidParameterValueException:

The value supplied for the input parameter is out of range or not valid.

ResourceNotFoundException:

A resource that is required for the action doesn't exist.

MissingAuthenticationToken:

The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.

ThrottlingException:

The request was denied due to request throttling.

GetRecommendationPreferences

$result = $client->getRecommendationPreferences([/* ... */]);
$promise = $client->getRecommendationPreferencesAsync([/* ... */]);

Returns existing recommendation preferences, such as enhanced infrastructure metrics.

Use the scope parameter to specify which preferences to return. You can specify to return preferences for an organization, a specific account ID, or a specific EC2 instance or Auto Scaling group Amazon Resource Name (ARN).

For more information, see Activating enhanced infrastructure metrics in the Compute Optimizer User Guide.

Parameter Syntax

$result = $client->getRecommendationPreferences([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'resourceType' => 'Ec2Instance|AutoScalingGroup|EbsVolume|LambdaFunction|NotApplicable|EcsService|License|RdsDBInstance', // REQUIRED
    'scope' => [
        'name' => 'Organization|AccountId|ResourceArn',
        'value' => '<string>',
    ],
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'recommendationPreferencesDetails' => [
        [
            'enhancedInfrastructureMetrics' => 'Active|Inactive',
            'externalMetricsPreference' => [
                'source' => 'Datadog|Dynatrace|NewRelic|Instana',
            ],
            'inferredWorkloadTypes' => 'Active|Inactive',
            'lookBackPeriod' => 'DAYS_14|DAYS_32|DAYS_93',
            'preferredResources' => [
                [
                    'effectiveIncludeList' => ['<string>', ...],
                    'excludeList' => ['<string>', ...],
                    'includeList' => ['<string>', ...],
                    'name' => 'Ec2InstanceTypes',
                ],
                // ...
            ],
            'resourceType' => 'Ec2Instance|AutoScalingGroup|EbsVolume|LambdaFunction|NotApplicable|EcsService|License|RdsDBInstance',
            'savingsEstimationMode' => 'AfterDiscounts|BeforeDiscounts',
            'scope' => [
                'name' => 'Organization|AccountId|ResourceArn',
                'value' => '<string>',
            ],
            'utilizationPreferences' => [
                [
                    'metricName' => 'CpuUtilization|MemoryUtilization',
                    'metricParameters' => [
                        'headroom' => 'PERCENT_30|PERCENT_20|PERCENT_10|PERCENT_0',
                        'threshold' => 'P90|P95|P99_5',
                    ],
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Errors

OptInRequiredException:

The account is not opted in to Compute Optimizer.

InternalServerException:

An internal error has occurred. Try your call again.

ServiceUnavailableException:

The request has failed due to a temporary failure of the server.

AccessDeniedException:

You do not have sufficient access to perform this action.

InvalidParameterValueException:

The value supplied for the input parameter is out of range or not valid.

ResourceNotFoundException:

A resource that is required for the action doesn't exist.

MissingAuthenticationToken:

The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.

ThrottlingException:

The request was denied due to request throttling.

GetRecommendationSummaries

$result = $client->getRecommendationSummaries([/* ... */]);
$promise = $client->getRecommendationSummariesAsync([/* ... */]);

Returns the optimization findings for an account.

It returns the number of:

• Amazon EC2 instances in an account that are Underprovisioned, Overprovisioned, or Optimized.

• Auto Scaling groups in an account that are NotOptimized, or Optimized.

• Amazon EBS volumes in an account that are NotOptimized, or Optimized.

• Lambda functions in an account that are NotOptimized, or Optimized.

• Amazon ECS services in an account that are Underprovisioned, Overprovisioned, or Optimized.

Parameter Syntax

$result = $client->getRecommendationSummaries([
    'accountIds' => ['<string>', ...],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'recommendationSummaries' => [
        [
            'accountId' => '<string>',
            'currentPerformanceRiskRatings' => [
                'high' => <integer>,
                'low' => <integer>,
                'medium' => <integer>,
                'veryLow' => <integer>,
            ],
            'inferredWorkloadSavings' => [
                [
                    'estimatedMonthlySavings' => [
                        'currency' => 'USD|CNY',
                        'value' => <float>,
                    ],
                    'inferredWorkloadTypes' => ['<string>', ...],
                ],
                // ...
            ],
            'recommendationResourceType' => 'Ec2Instance|AutoScalingGroup|EbsVolume|LambdaFunction|EcsService|License|RdsDBInstance|RdsDBInstanceStorage',
            'savingsOpportunity' => [
                'estimatedMonthlySavings' => [
                    'currency' => 'USD|CNY',
                    'value' => <float>,
                ],
                'savingsOpportunityPercentage' => <float>,
            ],
            'summaries' => [
                [
                    'name' => 'Underprovisioned|Overprovisioned|Optimized|NotOptimized',
                    'reasonCodeSummaries' => [
                        [
                            'name' => 'MemoryOverprovisioned|MemoryUnderprovisioned',
                            'value' => <float>,
                        ],
                        // ...
                    ],
                    'value' => <float>,
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Errors

OptInRequiredException:

The account is not opted in to Compute Optimizer.

InternalServerException:

An internal error has occurred. Try your call again.

ServiceUnavailableException:

The request has failed due to a temporary failure of the server.

AccessDeniedException:

You do not have sufficient access to perform this action.

InvalidParameterValueException:

The value supplied for the input parameter is out of range or not valid.

MissingAuthenticationToken:

The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.

ThrottlingException:

The request was denied due to request throttling.

PutRecommendationPreferences

$result = $client->putRecommendationPreferences([/* ... */]);
$promise = $client->putRecommendationPreferencesAsync([/* ... */]);

Creates a new recommendation preference or updates an existing recommendation preference, such as enhanced infrastructure metrics.

For more information, see Activating enhanced infrastructure metrics in the Compute Optimizer User Guide.

Parameter Syntax

$result = $client->putRecommendationPreferences([
    'enhancedInfrastructureMetrics' => 'Active|Inactive',
    'externalMetricsPreference' => [
        'source' => 'Datadog|Dynatrace|NewRelic|Instana',
    ],
    'inferredWorkloadTypes' => 'Active|Inactive',
    'lookBackPeriod' => 'DAYS_14|DAYS_32|DAYS_93',
    'preferredResources' => [
        [
            'excludeList' => ['<string>', ...],
            'includeList' => ['<string>', ...],
            'name' => 'Ec2InstanceTypes',
        ],
        // ...
    ],
    'resourceType' => 'Ec2Instance|AutoScalingGroup|EbsVolume|LambdaFunction|NotApplicable|EcsService|License|RdsDBInstance', // REQUIRED
    'savingsEstimationMode' => 'AfterDiscounts|BeforeDiscounts',
    'scope' => [
        'name' => 'Organization|AccountId|ResourceArn',
        'value' => '<string>',
    ],
    'utilizationPreferences' => [
        [
            'metricName' => 'CpuUtilization|MemoryUtilization',
            'metricParameters' => [
                'headroom' => 'PERCENT_30|PERCENT_20|PERCENT_10|PERCENT_0',
                'threshold' => 'P90|P95|P99_5',
            ],
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

OptInRequiredException:

The account is not opted in to Compute Optimizer.

InternalServerException:

An internal error has occurred. Try your call again.

ServiceUnavailableException:

The request has failed due to a temporary failure of the server.

AccessDeniedException:

You do not have sufficient access to perform this action.

InvalidParameterValueException:

The value supplied for the input parameter is out of range or not valid.

ResourceNotFoundException:

A resource that is required for the action doesn't exist.

MissingAuthenticationToken:

The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.

ThrottlingException:

The request was denied due to request throttling.

UpdateEnrollmentStatus

$result = $client->updateEnrollmentStatus([/* ... */]);
$promise = $client->updateEnrollmentStatusAsync([/* ... */]);

Updates the enrollment (opt in and opt out) status of an account to the Compute Optimizer service.

If the account is a management account of an organization, this action can also be used to enroll member accounts of the organization.

You must have the appropriate permissions to opt in to Compute Optimizer, to view its recommendations, and to opt out. For more information, see Controlling access with Amazon Web Services Identity and Access Management in the Compute Optimizer User Guide.

When you opt in, Compute Optimizer automatically creates a service-linked role in your account to access its data. For more information, see Using Service-Linked Roles for Compute Optimizer in the Compute Optimizer User Guide.

Parameter Syntax

$result = $client->updateEnrollmentStatus([
    'includeMemberAccounts' => true || false,
    'status' => 'Active|Inactive|Pending|Failed', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'status' => 'Active|Inactive|Pending|Failed',
    'statusReason' => '<string>',
]

Result Details

Errors

InternalServerException:

An internal error has occurred. Try your call again.

ServiceUnavailableException:

The request has failed due to a temporary failure of the server.

AccessDeniedException:

You do not have sufficient access to perform this action.

InvalidParameterValueException:

The value supplied for the input parameter is out of range or not valid.

MissingAuthenticationToken:

The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.

ThrottlingException:

The request was denied due to request throttling.