AWS Compute Optimizer 2019-11-01
- Client: Aws\ComputeOptimizer\ComputeOptimizerClient
- Service ID: compute-optimizer
- Version: 2019-11-01
This page describes the parameters and results for the operations of the AWS Compute Optimizer (2019-11-01), and shows how to use the Aws\ComputeOptimizer\ComputeOptimizerClient object to call the described operations. This documentation is specific to the 2019-11-01 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName')
, where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */)
.
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */)
.
- DeleteRecommendationPreferences ( array $params = [] )
- Deletes a recommendation preference, such as enhanced infrastructure metrics.
- DescribeRecommendationExportJobs ( array $params = [] )
- Describes recommendation export jobs created in the last seven days.
- ExportAutoScalingGroupRecommendations ( array $params = [] )
- Exports optimization recommendations for Auto Scaling groups.
- ExportEBSVolumeRecommendations ( array $params = [] )
- Exports optimization recommendations for Amazon EBS volumes.
- ExportEC2InstanceRecommendations ( array $params = [] )
- Exports optimization recommendations for Amazon EC2 instances.
- ExportECSServiceRecommendations ( array $params = [] )
- Exports optimization recommendations for Amazon ECS services on Fargate.
- ExportLambdaFunctionRecommendations ( array $params = [] )
- Exports optimization recommendations for Lambda functions.
- ExportLicenseRecommendations ( array $params = [] )
- Export optimization recommendations for your licenses.
- ExportRDSDatabaseRecommendations ( array $params = [] )
- Export optimization recommendations for your Amazon Relational Database Service (Amazon RDS).
- GetAutoScalingGroupRecommendations ( array $params = [] )
- Returns Auto Scaling group recommendations.
- GetEBSVolumeRecommendations ( array $params = [] )
- Returns Amazon Elastic Block Store (Amazon EBS) volume recommendations.
- GetEC2InstanceRecommendations ( array $params = [] )
- Returns Amazon EC2 instance recommendations.
- GetEC2RecommendationProjectedMetrics ( array $params = [] )
- Returns the projected utilization metrics of Amazon EC2 instance recommendations.
- GetECSServiceRecommendationProjectedMetrics ( array $params = [] )
- Returns the projected metrics of Amazon ECS service recommendations.
- GetECSServiceRecommendations ( array $params = [] )
- Returns Amazon ECS service recommendations.
- GetEffectiveRecommendationPreferences ( array $params = [] )
- Returns the recommendation preferences that are in effect for a given resource, such as enhanced infrastructure metrics.
- GetEnrollmentStatus ( array $params = [] )
- Returns the enrollment (opt in) status of an account to the Compute Optimizer service.
- GetEnrollmentStatusesForOrganization ( array $params = [] )
- Returns the Compute Optimizer enrollment (opt-in) status of organization member accounts, if your account is an organization management account.
- GetLambdaFunctionRecommendations ( array $params = [] )
- Returns Lambda function recommendations.
- GetLicenseRecommendations ( array $params = [] )
- Returns license recommendations for Amazon EC2 instances that run on a specific license.
- GetRDSDatabaseRecommendationProjectedMetrics ( array $params = [] )
- Returns the projected metrics of Amazon RDS recommendations.
- GetRDSDatabaseRecommendations ( array $params = [] )
- Returns Amazon RDS recommendations.
- GetRecommendationPreferences ( array $params = [] )
- Returns existing recommendation preferences, such as enhanced infrastructure metrics.
- GetRecommendationSummaries ( array $params = [] )
- Returns the optimization findings for an account.
- PutRecommendationPreferences ( array $params = [] )
- Creates a new recommendation preference or updates an existing recommendation preference, such as enhanced infrastructure metrics.
- UpdateEnrollmentStatus ( array $params = [] )
- Updates the enrollment (opt in and opt out) status of an account to the Compute Optimizer service.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
- DescribeRecommendationExportJobs
- GetEnrollmentStatusesForOrganization
- GetLambdaFunctionRecommendations
- GetRecommendationPreferences
- GetRecommendationSummaries
Operations
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
Members
- recommendationPreferenceNames
-
- Required: Yes
- Type: Array of strings
The name of the recommendation preference to delete.
- resourceType
-
- Required: Yes
- Type: string
The target resource type of the recommendation preference to delete.
The
Ec2Instance
option encompasses standalone instances and instances that are part of Auto Scaling groups. TheAutoScalingGroup
option encompasses only instances that are part of an Auto Scaling group. - scope
-
- Type: Scope structure
An object that describes the scope of the recommendation preference to delete.
You can delete recommendation preferences that are created at the organization level (for management accounts of an organization only), account level, and resource level. For more information, see Activating enhanced infrastructure metrics in the Compute Optimizer User Guide.
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
Members
- filters
-
- Type: Array of JobFilter structures
An array of objects to specify a filter that returns a more specific list of export jobs.
- jobIds
-
- Type: Array of strings
The identification numbers of the export jobs to return.
An export job ID is returned when you create an export using the ExportAutoScalingGroupRecommendations or ExportEC2InstanceRecommendations actions.
All export jobs created in the last seven days are returned if this parameter is omitted.
- maxResults
-
- Type: int
The maximum number of export jobs to return with a single request.
To retrieve the remaining results, make another request with the returned
nextToken
value. - nextToken
-
- Type: string
The token to advance to the next page of export jobs.
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
Members
- nextToken
-
- Type: string
The token to use to advance to the next page of export jobs.
This value is null when there are no more pages of export jobs to return.
- recommendationExportJobs
-
- Type: Array of RecommendationExportJob structures
An array of objects that describe recommendation export jobs.
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
Members
- accountIds
-
- Type: Array of strings
The IDs of the Amazon Web Services accounts for which to export Auto Scaling group recommendations.
If your account is the management account of an organization, use this parameter to specify the member account for which you want to export recommendations.
This parameter cannot be specified together with the include member accounts parameter. The parameters are mutually exclusive.
Recommendations for member accounts are not included in the export if this parameter, or the include member accounts parameter, is omitted.
You can specify multiple account IDs per request.
- fieldsToExport
-
- Type: Array of strings
The recommendations data to include in the export file. For more information about the fields that can be exported, see Exported files in the Compute Optimizer User Guide.
- fileFormat
-
- Type: string
The format of the export file.
The only export file format currently supported is
Csv
. - filters
-
- Type: Array of Filter structures
An array of objects to specify a filter that exports a more specific set of Auto Scaling group recommendations.
- includeMemberAccounts
-
- Type: boolean
Indicates whether to include recommendations for resources in all member accounts of the organization if your account is the management account of an organization.
The member accounts must also be opted in to Compute Optimizer, and trusted access for Compute Optimizer must be enabled in the organization account. For more information, see Compute Optimizer and Amazon Web Services Organizations trusted access in the Compute Optimizer User Guide.
Recommendations for member accounts of the organization are not included in the export file if this parameter is omitted.
This parameter cannot be specified together with the account IDs parameter. The parameters are mutually exclusive.
Recommendations for member accounts are not included in the export if this parameter, or the account IDs parameter, is omitted.
- recommendationPreferences
-
- Type: RecommendationPreferences structure
An object to specify the preferences for the Auto Scaling group recommendations to export.
- s3DestinationConfig
-
- Required: Yes
- Type: S3DestinationConfig structure
An object to specify the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for the export job.
You must create the destination Amazon S3 bucket for your recommendations export before you create the export job. Compute Optimizer does not create the S3 bucket for you. After you create the S3 bucket, ensure that it has the required permissions policy to allow Compute Optimizer to write the export file to it. If you plan to specify an object prefix when you create the export job, you must include the object prefix in the policy that you add to the S3 bucket. For more information, see Amazon S3 Bucket Policy for Compute Optimizer in the Compute Optimizer User Guide.
Result Syntax
[ 'jobId' => '<string>', 's3Destination' => [ 'bucket' => '<string>', 'key' => '<string>', 'metadataKey' => '<string>', ], ]
Result Details
Members
- jobId
-
- Type: string
The identification number of the export job.
Use the DescribeRecommendationExportJobs action, and specify the job ID to view the status of an export job.
- s3Destination
-
- Type: S3Destination structure
An object that describes the destination Amazon S3 bucket of a recommendations export file.
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
Members
- accountIds
-
- Type: Array of strings
The IDs of the Amazon Web Services accounts for which to export Amazon EBS volume recommendations.
If your account is the management account of an organization, use this parameter to specify the member account for which you want to export recommendations.
This parameter cannot be specified together with the include member accounts parameter. The parameters are mutually exclusive.
Recommendations for member accounts are not included in the export if this parameter, or the include member accounts parameter, is omitted.
You can specify multiple account IDs per request.
- fieldsToExport
-
- Type: Array of strings
The recommendations data to include in the export file. For more information about the fields that can be exported, see Exported files in the Compute Optimizer User Guide.
- fileFormat
-
- Type: string
The format of the export file.
The only export file format currently supported is
Csv
. - filters
-
- Type: Array of EBSFilter structures
An array of objects to specify a filter that exports a more specific set of Amazon EBS volume recommendations.
- includeMemberAccounts
-
- Type: boolean
Indicates whether to include recommendations for resources in all member accounts of the organization if your account is the management account of an organization.
The member accounts must also be opted in to Compute Optimizer, and trusted access for Compute Optimizer must be enabled in the organization account. For more information, see Compute Optimizer and Amazon Web Services Organizations trusted access in the Compute Optimizer User Guide.
Recommendations for member accounts of the organization are not included in the export file if this parameter is omitted.
This parameter cannot be specified together with the account IDs parameter. The parameters are mutually exclusive.
Recommendations for member accounts are not included in the export if this parameter, or the account IDs parameter, is omitted.
- s3DestinationConfig
-
- Required: Yes
- Type: S3DestinationConfig structure
Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for a recommendations export job.
You must create the destination Amazon S3 bucket for your recommendations export before you create the export job. Compute Optimizer does not create the S3 bucket for you. After you create the S3 bucket, ensure that it has the required permission policy to allow Compute Optimizer to write the export file to it. If you plan to specify an object prefix when you create the export job, you must include the object prefix in the policy that you add to the S3 bucket. For more information, see Amazon S3 Bucket Policy for Compute Optimizer in the Compute Optimizer User Guide.
Result Syntax
[ 'jobId' => '<string>', 's3Destination' => [ 'bucket' => '<string>', 'key' => '<string>', 'metadataKey' => '<string>', ], ]
Result Details
Members
- jobId
-
- Type: string
The identification number of the export job.
Use the DescribeRecommendationExportJobs action, and specify the job ID to view the status of an export job.
- s3Destination
-
- Type: S3Destination structure
Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and object keys of a recommendations export file, and its associated metadata file.
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
Members
- accountIds
-
- Type: Array of strings
The IDs of the Amazon Web Services accounts for which to export instance recommendations.
If your account is the management account of an organization, use this parameter to specify the member account for which you want to export recommendations.
This parameter cannot be specified together with the include member accounts parameter. The parameters are mutually exclusive.
Recommendations for member accounts are not included in the export if this parameter, or the include member accounts parameter, is omitted.
You can specify multiple account IDs per request.
- fieldsToExport
-
- Type: Array of strings
The recommendations data to include in the export file. For more information about the fields that can be exported, see Exported files in the Compute Optimizer User Guide.
- fileFormat
-
- Type: string
The format of the export file.
The only export file format currently supported is
Csv
. - filters
-
- Type: Array of Filter structures
An array of objects to specify a filter that exports a more specific set of instance recommendations.
- includeMemberAccounts
-
- Type: boolean
Indicates whether to include recommendations for resources in all member accounts of the organization if your account is the management account of an organization.
The member accounts must also be opted in to Compute Optimizer, and trusted access for Compute Optimizer must be enabled in the organization account. For more information, see Compute Optimizer and Amazon Web Services Organizations trusted access in the Compute Optimizer User Guide.
Recommendations for member accounts of the organization are not included in the export file if this parameter is omitted.
Recommendations for member accounts are not included in the export if this parameter, or the account IDs parameter, is omitted.
- recommendationPreferences
-
- Type: RecommendationPreferences structure
An object to specify the preferences for the Amazon EC2 instance recommendations to export.
- s3DestinationConfig
-
- Required: Yes
- Type: S3DestinationConfig structure
An object to specify the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for the export job.
You must create the destination Amazon S3 bucket for your recommendations export before you create the export job. Compute Optimizer does not create the S3 bucket for you. After you create the S3 bucket, ensure that it has the required permissions policy to allow Compute Optimizer to write the export file to it. If you plan to specify an object prefix when you create the export job, you must include the object prefix in the policy that you add to the S3 bucket. For more information, see Amazon S3 Bucket Policy for Compute Optimizer in the Compute Optimizer User Guide.
Result Syntax
[ 'jobId' => '<string>', 's3Destination' => [ 'bucket' => '<string>', 'key' => '<string>', 'metadataKey' => '<string>', ], ]
Result Details
Members
- jobId
-
- Type: string
The identification number of the export job.
Use the DescribeRecommendationExportJobs action, and specify the job ID to view the status of an export job.
- s3Destination
-
- Type: S3Destination structure
An object that describes the destination Amazon S3 bucket of a recommendations export file.
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
Members
- accountIds
-
- Type: Array of strings
The Amazon Web Services account IDs for the export Amazon ECS service recommendations.
If your account is the management account or the delegated administrator of an organization, use this parameter to specify the member account you want to export recommendations to.
This parameter can't be specified together with the include member accounts parameter. The parameters are mutually exclusive.
If this parameter or the include member accounts parameter is omitted, the recommendations for member accounts aren't included in the export.
You can specify multiple account IDs per request.
- fieldsToExport
-
- Type: Array of strings
The recommendations data to include in the export file. For more information about the fields that can be exported, see Exported files in the Compute Optimizer User Guide.
- fileFormat
-
- Type: string
The format of the export file.
The CSV file is the only export file format currently supported.
- filters
-
- Type: Array of ECSServiceRecommendationFilter structures
An array of objects to specify a filter that exports a more specific set of Amazon ECS service recommendations.
- includeMemberAccounts
-
- Type: boolean
If your account is the management account or the delegated administrator of an organization, this parameter indicates whether to include recommendations for resources in all member accounts of the organization.
The member accounts must also be opted in to Compute Optimizer, and trusted access for Compute Optimizer must be enabled in the organization account. For more information, see Compute Optimizer and Amazon Web Services Organizations trusted access in the Compute Optimizer User Guide.
If this parameter is omitted, recommendations for member accounts of the organization aren't included in the export file.
If this parameter or the account ID parameter is omitted, recommendations for member accounts aren't included in the export.
- s3DestinationConfig
-
- Required: Yes
- Type: S3DestinationConfig structure
Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for a recommendations export job.
You must create the destination Amazon S3 bucket for your recommendations export before you create the export job. Compute Optimizer does not create the S3 bucket for you. After you create the S3 bucket, ensure that it has the required permission policy to allow Compute Optimizer to write the export file to it. If you plan to specify an object prefix when you create the export job, you must include the object prefix in the policy that you add to the S3 bucket. For more information, see Amazon S3 Bucket Policy for Compute Optimizer in the Compute Optimizer User Guide.
Result Syntax
[ 'jobId' => '<string>', 's3Destination' => [ 'bucket' => '<string>', 'key' => '<string>', 'metadataKey' => '<string>', ], ]
Result Details
Members
- jobId
-
- Type: string
The identification number of the export job.
To view the status of an export job, use the DescribeRecommendationExportJobs action and specify the job ID.
- s3Destination
-
- Type: S3Destination structure
Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and object keys of a recommendations export file, and its associated metadata file.
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
Members
- accountIds
-
- Type: Array of strings
The IDs of the Amazon Web Services accounts for which to export Lambda function recommendations.
If your account is the management account of an organization, use this parameter to specify the member account for which you want to export recommendations.
This parameter cannot be specified together with the include member accounts parameter. The parameters are mutually exclusive.
Recommendations for member accounts are not included in the export if this parameter, or the include member accounts parameter, is omitted.
You can specify multiple account IDs per request.
- fieldsToExport
-
- Type: Array of strings
The recommendations data to include in the export file. For more information about the fields that can be exported, see Exported files in the Compute Optimizer User Guide.
- fileFormat
-
- Type: string
The format of the export file.
The only export file format currently supported is
Csv
. - filters
-
- Type: Array of LambdaFunctionRecommendationFilter structures
An array of objects to specify a filter that exports a more specific set of Lambda function recommendations.
- includeMemberAccounts
-
- Type: boolean
Indicates whether to include recommendations for resources in all member accounts of the organization if your account is the management account of an organization.
The member accounts must also be opted in to Compute Optimizer, and trusted access for Compute Optimizer must be enabled in the organization account. For more information, see Compute Optimizer and Amazon Web Services Organizations trusted access in the Compute Optimizer User Guide.
Recommendations for member accounts of the organization are not included in the export file if this parameter is omitted.
This parameter cannot be specified together with the account IDs parameter. The parameters are mutually exclusive.
Recommendations for member accounts are not included in the export if this parameter, or the account IDs parameter, is omitted.
- s3DestinationConfig
-
- Required: Yes
- Type: S3DestinationConfig structure
Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for a recommendations export job.
You must create the destination Amazon S3 bucket for your recommendations export before you create the export job. Compute Optimizer does not create the S3 bucket for you. After you create the S3 bucket, ensure that it has the required permission policy to allow Compute Optimizer to write the export file to it. If you plan to specify an object prefix when you create the export job, you must include the object prefix in the policy that you add to the S3 bucket. For more information, see Amazon S3 Bucket Policy for Compute Optimizer in the Compute Optimizer User Guide.
Result Syntax
[ 'jobId' => '<string>', 's3Destination' => [ 'bucket' => '<string>', 'key' => '<string>', 'metadataKey' => '<string>', ], ]
Result Details
Members
- jobId
-
- Type: string
The identification number of the export job.
Use the DescribeRecommendationExportJobs action, and specify the job ID to view the status of an export job.
- s3Destination
-
- Type: S3Destination structure
Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and object keys of a recommendations export file, and its associated metadata file.
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
Members
- accountIds
-
- Type: Array of strings
The IDs of the Amazon Web Services accounts for which to export license recommendations.
If your account is the management account of an organization, use this parameter to specify the member account for which you want to export recommendations.
This parameter can't be specified together with the include member accounts parameter. The parameters are mutually exclusive.
If this parameter is omitted, recommendations for member accounts aren't included in the export.
You can specify multiple account IDs per request.
- fieldsToExport
-
- Type: Array of strings
The recommendations data to include in the export file. For more information about the fields that can be exported, see Exported files in the Compute Optimizer User Guide.
- fileFormat
-
- Type: string
The format of the export file.
A CSV file is the only export format currently supported.
- filters
-
- Type: Array of LicenseRecommendationFilter structures
An array of objects to specify a filter that exports a more specific set of license recommendations.
- includeMemberAccounts
-
- Type: boolean
Indicates whether to include recommendations for resources in all member accounts of the organization if your account is the management account of an organization.
The member accounts must also be opted in to Compute Optimizer, and trusted access for Compute Optimizer must be enabled in the organization account. For more information, see Compute Optimizer and Amazon Web Services Organizations trusted access in the Compute Optimizer User Guide.
If this parameter is omitted, recommendations for member accounts of the organization aren't included in the export file .
This parameter cannot be specified together with the account IDs parameter. The parameters are mutually exclusive.
- s3DestinationConfig
-
- Required: Yes
- Type: S3DestinationConfig structure
Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for a recommendations export job.
You must create the destination Amazon S3 bucket for your recommendations export before you create the export job. Compute Optimizer does not create the S3 bucket for you. After you create the S3 bucket, ensure that it has the required permission policy to allow Compute Optimizer to write the export file to it. If you plan to specify an object prefix when you create the export job, you must include the object prefix in the policy that you add to the S3 bucket. For more information, see Amazon S3 Bucket Policy for Compute Optimizer in the Compute Optimizer User Guide.
Result Syntax
[ 'jobId' => '<string>', 's3Destination' => [ 'bucket' => '<string>', 'key' => '<string>', 'metadataKey' => '<string>', ], ]
Result Details
Members
- jobId
-
- Type: string
The identification number of the export job.
To view the status of an export job, use the DescribeRecommendationExportJobs action and specify the job ID.
- s3Destination
-
- Type: S3Destination structure
Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and object keys of a recommendations export file, and its associated metadata file.
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
Members
- accountIds
-
- Type: Array of strings
The Amazon Web Services account IDs for the export Amazon RDS recommendations.
If your account is the management account or the delegated administrator of an organization, use this parameter to specify the member account you want to export recommendations to.
This parameter can't be specified together with the include member accounts parameter. The parameters are mutually exclusive.
If this parameter or the include member accounts parameter is omitted, the recommendations for member accounts aren't included in the export.
You can specify multiple account IDs per request.
- fieldsToExport
-
- Type: Array of strings
The recommendations data to include in the export file. For more information about the fields that can be exported, see Exported files in the Compute Optimizer User Guide.
- fileFormat
-
- Type: string
The format of the export file.
The CSV file is the only export file format currently supported.
- filters
-
- Type: Array of RDSDBRecommendationFilter structures
An array of objects to specify a filter that exports a more specific set of Amazon RDS recommendations.
- includeMemberAccounts
-
- Type: boolean
If your account is the management account or the delegated administrator of an organization, this parameter indicates whether to include recommendations for resources in all member accounts of the organization.
The member accounts must also be opted in to Compute Optimizer, and trusted access for Compute Optimizer must be enabled in the organization account. For more information, see Compute Optimizer and Amazon Web Services Organizations trusted access in the Compute Optimizer User Guide.
If this parameter is omitted, recommendations for member accounts of the organization aren't included in the export file.
If this parameter or the account ID parameter is omitted, recommendations for member accounts aren't included in the export.
- recommendationPreferences
-
- Type: RecommendationPreferences structure
Describes the recommendation preferences to return in the response of a GetAutoScalingGroupRecommendations, GetEC2InstanceRecommendations, GetEC2RecommendationProjectedMetrics, GetRDSDatabaseRecommendations, and GetRDSDatabaseRecommendationProjectedMetrics request.
- s3DestinationConfig
-
- Required: Yes
- Type: S3DestinationConfig structure
Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for a recommendations export job.
You must create the destination Amazon S3 bucket for your recommendations export before you create the export job. Compute Optimizer does not create the S3 bucket for you. After you create the S3 bucket, ensure that it has the required permission policy to allow Compute Optimizer to write the export file to it. If you plan to specify an object prefix when you create the export job, you must include the object prefix in the policy that you add to the S3 bucket. For more information, see Amazon S3 Bucket Policy for Compute Optimizer in the Compute Optimizer User Guide.
Result Syntax
[ 'jobId' => '<string>', 's3Destination' => [ 'bucket' => '<string>', 'key' => '<string>', 'metadataKey' => '<string>', ], ]
Result Details
Members
- jobId
-
- Type: string
The identification number of the export job.
To view the status of an export job, use the DescribeRecommendationExportJobs action and specify the job ID.
- s3Destination
-
- Type: S3Destination structure
Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and object keys of a recommendations export file, and its associated metadata file.
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
Members
- accountIds
-
- Type: Array of strings
The ID of the Amazon Web Services account for which to return Auto Scaling group recommendations.
If your account is the management account of an organization, use this parameter to specify the member account for which you want to return Auto Scaling group recommendations.
Only one account ID can be specified per request.
- autoScalingGroupArns
-
- Type: Array of strings
The Amazon Resource Name (ARN) of the Auto Scaling groups for which to return recommendations.
- filters
-
- Type: Array of Filter structures
An array of objects to specify a filter that returns a more specific list of Auto Scaling group recommendations.
- maxResults
-
- Type: int
The maximum number of Auto Scaling group recommendations to return with a single request.
To retrieve the remaining results, make another request with the returned
nextToken
value. - nextToken
-
- Type: string
The token to advance to the next page of Auto Scaling group recommendations.
- recommendationPreferences
-
- Type: RecommendationPreferences structure
An object to specify the preferences for the Auto Scaling group recommendations to return in the response.
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
Members
- autoScalingGroupRecommendations
-
- Type: Array of AutoScalingGroupRecommendation structures
An array of objects that describe Auto Scaling group recommendations.
- errors
-
- Type: Array of GetRecommendationError structures
An array of objects that describe errors of the request.
For example, an error is returned if you request recommendations for an unsupported Auto Scaling group.
- nextToken
-
- Type: string
The token to use to advance to the next page of Auto Scaling group recommendations.
This value is null when there are no more pages of Auto Scaling group recommendations to return.
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
Members
- accountIds
-
- Type: Array of strings
The ID of the Amazon Web Services account for which to return volume recommendations.
If your account is the management account of an organization, use this parameter to specify the member account for which you want to return volume recommendations.
Only one account ID can be specified per request.
- filters
-
- Type: Array of EBSFilter structures
An array of objects to specify a filter that returns a more specific list of volume recommendations.
- maxResults
-
- Type: int
The maximum number of volume recommendations to return with a single request.
To retrieve the remaining results, make another request with the returned
nextToken
value. - nextToken
-
- Type: string
The token to advance to the next page of volume recommendations.
- volumeArns
-
- Type: Array of strings
The Amazon Resource Name (ARN) of the volumes for which to return recommendations.
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
Members
- errors
-
- Type: Array of GetRecommendationError structures
An array of objects that describe errors of the request.
For example, an error is returned if you request recommendations for an unsupported volume.
- nextToken
-
- Type: string
The token to use to advance to the next page of volume recommendations.
This value is null when there are no more pages of volume recommendations to return.
- volumeRecommendations
-
- Type: Array of VolumeRecommendation structures
An array of objects that describe volume recommendations.
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
Members
- accountIds
-
- Type: Array of strings
The ID of the Amazon Web Services account for which to return instance recommendations.
If your account is the management account of an organization, use this parameter to specify the member account for which you want to return instance recommendations.
Only one account ID can be specified per request.
- filters
-
- Type: Array of Filter structures
An array of objects to specify a filter that returns a more specific list of instance recommendations.
- instanceArns
-
- Type: Array of strings
The Amazon Resource Name (ARN) of the instances for which to return recommendations.
- maxResults
-
- Type: int
The maximum number of instance recommendations to return with a single request.
To retrieve the remaining results, make another request with the returned
nextToken
value. - nextToken
-
- Type: string
The token to advance to the next page of instance recommendations.
- recommendationPreferences
-
- Type: RecommendationPreferences structure
An object to specify the preferences for the Amazon EC2 instance recommendations to return in the response.
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
Members
- errors
-
- Type: Array of GetRecommendationError structures
An array of objects that describe errors of the request.
For example, an error is returned if you request recommendations for an instance of an unsupported instance family.
- instanceRecommendations
-
- Type: Array of InstanceRecommendation structures
An array of objects that describe instance recommendations.
- nextToken
-
- Type: string
The token to use to advance to the next page of instance recommendations.
This value is null when there are no more pages of instance recommendations to return.
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.
The Cpu
and Memory
metrics are the only projected utilization metrics returned when you run this action. Additionally, the Memory
metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent.
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
Members
- endTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of the last projected metrics data point to return.
- instanceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the instances for which to return recommendation projected metrics.
- period
-
- Required: Yes
- Type: int
The granularity, in seconds, of the projected metrics data points.
- recommendationPreferences
-
- Type: RecommendationPreferences structure
An object to specify the preferences for the Amazon EC2 recommendation projected metrics to return in the response.
- startTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of the first projected metrics data point to return.
- stat
-
- Required: Yes
- Type: string
The statistic of the projected metrics.
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
Members
- recommendedOptionProjectedMetrics
-
- Type: Array of RecommendedOptionProjectedMetric structures
An array of objects that describes projected metrics.
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
Members
- endTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of the last projected metrics data point to return.
- period
-
- Required: Yes
- Type: int
The granularity, in seconds, of the projected metrics data points.
- serviceArn
-
- Required: Yes
- Type: string
The ARN that identifies the Amazon ECS service.
The following is the format of the ARN:
arn:aws:ecs:region:aws_account_id:service/cluster-name/service-name
- startTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of the first projected metrics data point to return.
- stat
-
- Required: Yes
- Type: string
The statistic of the projected metrics.
Result Syntax
[ 'recommendedOptionProjectedMetrics' => [ [ 'projectedMetrics' => [ [ 'lowerBoundValues' => [<float>, ...], 'name' => 'Cpu|Memory', 'timestamps' => [<DateTime>, ...], 'upperBoundValues' => [<float>, ...], ], // ... ], 'recommendedCpuUnits' => <integer>, 'recommendedMemorySize' => <integer>, ], // ... ], ]
Result Details
Members
- recommendedOptionProjectedMetrics
-
- Type: Array of ECSServiceRecommendedOptionProjectedMetric structures
An array of objects that describes the projected metrics.
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
Members
- accountIds
-
- Type: Array of strings
Return the Amazon ECS service recommendations to the specified Amazon Web Services account IDs.
If your account is the management account or the delegated administrator of an organization, use this parameter to return the Amazon ECS service recommendations to specific member accounts.
You can only specify one account ID per request.
- filters
-
- Type: Array of ECSServiceRecommendationFilter structures
An array of objects to specify a filter that returns a more specific list of Amazon ECS service recommendations.
- maxResults
-
- Type: int
The maximum number of Amazon ECS service recommendations to return with a single request.
To retrieve the remaining results, make another request with the returned
nextToken
value. - nextToken
-
- Type: string
The token to advance to the next page of Amazon ECS service recommendations.
- serviceArns
-
- Type: Array of strings
The ARN that identifies the Amazon ECS service.
The following is the format of the ARN:
arn:aws:ecs:region:aws_account_id:service/cluster-name/service-name
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
Members
- ecsServiceRecommendations
-
- Type: Array of ECSServiceRecommendation structures
An array of objects that describe the Amazon ECS service recommendations.
- errors
-
- Type: Array of GetRecommendationError structures
An array of objects that describe errors of the request.
- nextToken
-
- Type: string
The token to advance to the next page of Amazon ECS service recommendations.
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
Members
- resourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the resource for which to confirm effective recommendation preferences. Only EC2 instance and Auto Scaling group ARNs are currently supported.
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
Members
- enhancedInfrastructureMetrics
-
- Type: string
The status of the enhanced infrastructure metrics recommendation preference. Considers all applicable preferences that you might have set at the resource, account, and organization level.
A status of
Active
confirms that the preference is applied in the latest recommendation refresh, and a status ofInactive
confirms that it's not yet applied to recommendations.To validate whether the preference is applied to your last generated set of recommendations, review the
effectiveRecommendationPreferences
value in the response of the GetAutoScalingGroupRecommendations and GetEC2InstanceRecommendations actions.For more information, see Enhanced infrastructure metrics in the Compute Optimizer User Guide.
- externalMetricsPreference
-
- Type: ExternalMetricsPreference structure
The provider of the external metrics recommendation preference. Considers all applicable preferences that you might have set at the account and organization level.
If the preference is applied in the latest recommendation refresh, an object with a valid
source
value appears in the response. If the preference isn't applied to the recommendations already, then this object doesn't appear in the response.To validate whether the preference is applied to your last generated set of recommendations, review the
effectiveRecommendationPreferences
value in the response of the GetEC2InstanceRecommendations actions.For more information, see Enhanced infrastructure metrics in the Compute Optimizer User Guide.
- lookBackPeriod
-
- Type: string
The number of days the utilization metrics of the Amazon Web Services resource are analyzed.
To validate that the preference is applied to your last generated set of recommendations, review the
effectiveRecommendationPreferences
value in the response of the GetAutoScalingGroupRecommendations or GetEC2InstanceRecommendations actions. - preferredResources
-
- Type: Array of EffectivePreferredResource structures
The resource type values that are considered as candidates when generating rightsizing recommendations. This object resolves any wildcard expressions and returns the effective list of candidate resource type values. It also considers all applicable preferences that you set at the resource, account, and organization level.
To validate that the preference is applied to your last generated set of recommendations, review the
effectiveRecommendationPreferences
value in the response of the GetAutoScalingGroupRecommendations or GetEC2InstanceRecommendations actions. - utilizationPreferences
-
- Type: Array of UtilizationPreference structures
The resource’s CPU and memory utilization preferences, such as threshold and headroom, that were used to generate rightsizing recommendations. It considers all applicable preferences that you set at the resource, account, and organization level.
To validate that the preference is applied to your last generated set of recommendations, review the
effectiveRecommendationPreferences
value in the response of the GetAutoScalingGroupRecommendations or GetEC2InstanceRecommendations actions.
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
Members
Result Syntax
[ 'lastUpdatedTimestamp' => <DateTime>, 'memberAccountsEnrolled' => true || false, 'numberOfMemberAccountsOptedIn' => <integer>, 'status' => 'Active|Inactive|Pending|Failed', 'statusReason' => '<string>', ]
Result Details
Members
- lastUpdatedTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The Unix epoch timestamp, in seconds, of when the account enrollment status was last updated.
- memberAccountsEnrolled
-
- Type: boolean
Confirms the enrollment status of member accounts of the organization, if the account is a management account of an organization.
- numberOfMemberAccountsOptedIn
-
- Type: int
The count of organization member accounts that are opted in to the service, if your account is an organization management account.
- status
-
- Type: string
The enrollment status of the account.
- statusReason
-
- Type: string
The reason for the enrollment status of the account.
For example, an account might show a status of
Pending
because member accounts of an organization require more time to be enrolled in the service.
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
Members
- filters
-
- Type: Array of EnrollmentFilter structures
An array of objects to specify a filter that returns a more specific list of account enrollment statuses.
- maxResults
-
- Type: int
The maximum number of account enrollment statuses to return with a single request. You can specify up to 100 statuses to return with each request.
To retrieve the remaining results, make another request with the returned
nextToken
value. - nextToken
-
- Type: string
The token to advance to the next page of account enrollment statuses.
Result Syntax
[ 'accountEnrollmentStatuses' => [ [ 'accountId' => '<string>', 'lastUpdatedTimestamp' => <DateTime>, 'status' => 'Active|Inactive|Pending|Failed', 'statusReason' => '<string>', ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- accountEnrollmentStatuses
-
- Type: Array of AccountEnrollmentStatus structures
An array of objects that describe the enrollment statuses of organization member accounts.
- nextToken
-
- Type: string
The token to use to advance to the next page of account enrollment statuses.
This value is null when there are no more pages of account enrollment statuses to return.
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
Members
- accountIds
-
- Type: Array of strings
The ID of the Amazon Web Services account for which to return function recommendations.
If your account is the management account of an organization, use this parameter to specify the member account for which you want to return function recommendations.
Only one account ID can be specified per request.
- filters
-
- Type: Array of LambdaFunctionRecommendationFilter structures
An array of objects to specify a filter that returns a more specific list of function recommendations.
- functionArns
-
- Type: Array of strings
The Amazon Resource Name (ARN) of the functions for which to return recommendations.
You can specify a qualified or unqualified ARN. If you specify an unqualified ARN without a function version suffix, Compute Optimizer will return recommendations for the latest (
$LATEST
) version of the function. If you specify a qualified ARN with a version suffix, Compute Optimizer will return recommendations for the specified function version. For more information about using function versions, see Using versions in the Lambda Developer Guide. - maxResults
-
- Type: int
The maximum number of function recommendations to return with a single request.
To retrieve the remaining results, make another request with the returned
nextToken
value. - nextToken
-
- Type: string
The token to advance to the next page of function recommendations.
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
Members
- lambdaFunctionRecommendations
-
- Type: Array of LambdaFunctionRecommendation structures
An array of objects that describe function recommendations.
- nextToken
-
- Type: string
The token to use to advance to the next page of function recommendations.
This value is null when there are no more pages of function recommendations to return.
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
Members
- accountIds
-
- Type: Array of strings
The ID of the Amazon Web Services account for which to return license recommendations.
If your account is the management account of an organization, use this parameter to specify the member account for which you want to return license recommendations.
Only one account ID can be specified per request.
- filters
-
- Type: Array of LicenseRecommendationFilter structures
An array of objects to specify a filter that returns a more specific list of license recommendations.
- maxResults
-
- Type: int
The maximum number of license recommendations to return with a single request.
To retrieve the remaining results, make another request with the returned
nextToken
value. - nextToken
-
- Type: string
The token to advance to the next page of license recommendations.
- resourceArns
-
- Type: Array of strings
The ARN that identifies the Amazon EC2 instance.
The following is the format of the ARN:
arn:aws:ec2:region:aws_account_id:instance/instance-id
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
Members
- errors
-
- Type: Array of GetRecommendationError structures
An array of objects that describe errors of the request.
- licenseRecommendations
-
- Type: Array of LicenseRecommendation structures
An array of objects that describe license recommendations.
- nextToken
-
- Type: string
The token to use to advance to the next page of license recommendations.
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
Members
- endTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of the last projected metrics data point to return.
- period
-
- Required: Yes
- Type: int
The granularity, in seconds, of the projected metrics data points.
- recommendationPreferences
-
- Type: RecommendationPreferences structure
Describes the recommendation preferences to return in the response of a GetAutoScalingGroupRecommendations, GetEC2InstanceRecommendations, GetEC2RecommendationProjectedMetrics, GetRDSDatabaseRecommendations, and GetRDSDatabaseRecommendationProjectedMetrics request.
- resourceArn
-
- Required: Yes
- Type: string
The ARN that identifies the Amazon RDS.
The following is the format of the ARN:
arn:aws:rds:{region}:{accountId}:db:{resourceName}
- startTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of the first projected metrics data point to return.
- stat
-
- Required: Yes
- Type: string
The statistic of the projected metrics.
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
Members
- recommendedOptionProjectedMetrics
-
- Type: Array of RDSDatabaseRecommendedOptionProjectedMetric structures
An array of objects that describes the projected metrics.
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
Members
- accountIds
-
- Type: Array of strings
Return the Amazon RDS recommendations to the specified Amazon Web Services account IDs.
If your account is the management account or the delegated administrator of an organization, use this parameter to return the Amazon RDS recommendations to specific member accounts.
You can only specify one account ID per request.
- filters
-
- Type: Array of RDSDBRecommendationFilter structures
An array of objects to specify a filter that returns a more specific list of Amazon RDS recommendations.
- maxResults
-
- Type: int
The maximum number of Amazon RDS recommendations to return with a single request.
To retrieve the remaining results, make another request with the returned
nextToken
value. - nextToken
-
- Type: string
The token to advance to the next page of Amazon RDS recommendations.
- recommendationPreferences
-
- Type: RecommendationPreferences structure
Describes the recommendation preferences to return in the response of a GetAutoScalingGroupRecommendations, GetEC2InstanceRecommendations, GetEC2RecommendationProjectedMetrics, GetRDSDatabaseRecommendations, and GetRDSDatabaseRecommendationProjectedMetrics request.
- resourceArns
-
- Type: Array of strings
The ARN that identifies the Amazon RDS.
The following is the format of the ARN:
arn:aws:rds:{region}:{accountId}:db:{resourceName}
The following is the format of a DB Cluster ARN:
arn:aws:rds:{region}:{accountId}:cluster:{resourceName}
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
Members
- errors
-
- Type: Array of GetRecommendationError structures
An array of objects that describe errors of the request.
- nextToken
-
- Type: string
The token to advance to the next page of Amazon RDS recommendations.
- rdsDBRecommendations
-
- Type: Array of RDSDBRecommendation structures
An array of objects that describe the Amazon RDS recommendations.
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
Members
- maxResults
-
- Type: int
The maximum number of recommendation preferences to return with a single request.
To retrieve the remaining results, make another request with the returned
nextToken
value. - nextToken
-
- Type: string
The token to advance to the next page of recommendation preferences.
- resourceType
-
- Required: Yes
- Type: string
The target resource type of the recommendation preference for which to return preferences.
The
Ec2Instance
option encompasses standalone instances and instances that are part of Auto Scaling groups. TheAutoScalingGroup
option encompasses only instances that are part of an Auto Scaling group. - scope
-
- Type: Scope structure
An object that describes the scope of the recommendation preference to return.
You can return recommendation preferences that are created at the organization level (for management accounts of an organization only), account level, and resource level. For more information, see Activating enhanced infrastructure metrics in the Compute Optimizer User Guide.
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
Members
- nextToken
-
- Type: string
The token to use to advance to the next page of recommendation preferences.
This value is null when there are no more pages of recommendation preferences to return.
- recommendationPreferencesDetails
-
- Type: Array of RecommendationPreferencesDetail structures
An array of objects that describe recommendation preferences.
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
, orOptimized
. -
Auto Scaling groups in an account that are
NotOptimized
, orOptimized
. -
Amazon EBS volumes in an account that are
NotOptimized
, orOptimized
. -
Lambda functions in an account that are
NotOptimized
, orOptimized
. -
Amazon ECS services in an account that are
Underprovisioned
,Overprovisioned
, orOptimized
.
Parameter Syntax
$result = $client->getRecommendationSummaries([ 'accountIds' => ['<string>', ...], 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- accountIds
-
- Type: Array of strings
The ID of the Amazon Web Services account for which to return recommendation summaries.
If your account is the management account of an organization, use this parameter to specify the member account for which you want to return recommendation summaries.
Only one account ID can be specified per request.
- maxResults
-
- Type: int
The maximum number of recommendation summaries to return with a single request.
To retrieve the remaining results, make another request with the returned
nextToken
value. - nextToken
-
- Type: string
The token to advance to the next page of recommendation summaries.
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
Members
- nextToken
-
- Type: string
The token to use to advance to the next page of recommendation summaries.
This value is null when there are no more pages of recommendation summaries to return.
- recommendationSummaries
-
- Type: Array of RecommendationSummary structures
An array of objects that summarize a recommendation.
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
Members
- enhancedInfrastructureMetrics
-
- Type: string
The status of the enhanced infrastructure metrics recommendation preference to create or update.
Specify the
Active
status to activate the preference, or specifyInactive
to deactivate the preference.For more information, see Enhanced infrastructure metrics in the Compute Optimizer User Guide.
- externalMetricsPreference
-
- Type: ExternalMetricsPreference structure
The provider of the external metrics recommendation preference to create or update.
Specify a valid provider in the
source
field to activate the preference. To delete this preference, see the DeleteRecommendationPreferences action.This preference can only be set for the
Ec2Instance
resource type.For more information, see External metrics ingestion in the Compute Optimizer User Guide.
- inferredWorkloadTypes
-
- Type: string
The status of the inferred workload types recommendation preference to create or update.
The inferred workload type feature is active by default. To deactivate it, create a recommendation preference.
Specify the
Inactive
status to deactivate the feature, or specifyActive
to activate it.For more information, see Inferred workload types in the Compute Optimizer User Guide.
- lookBackPeriod
-
- Type: string
The preference to control the number of days the utilization metrics of the Amazon Web Services resource are analyzed. When this preference isn't specified, we use the default value
DAYS_14
.You can only set this preference for the Amazon EC2 instance and Auto Scaling group resource types.
-
Amazon EC2 instance lookback preferences can be set at the organization, account, and resource levels.
-
Auto Scaling group lookback preferences can only be set at the resource level.
- preferredResources
-
- Type: Array of PreferredResource structures
The preference to control which resource type values are considered when generating rightsizing recommendations. You can specify this preference as a combination of include and exclude lists. You must specify either an
includeList
orexcludeList
. If the preference is an empty set of resource type values, an error occurs.You can only set this preference for the Amazon EC2 instance and Auto Scaling group resource types.
- resourceType
-
- Required: Yes
- Type: string
The target resource type of the recommendation preference to create.
The
Ec2Instance
option encompasses standalone instances and instances that are part of Auto Scaling groups. TheAutoScalingGroup
option encompasses only instances that are part of an Auto Scaling group. - savingsEstimationMode
-
- Type: string
The status of the savings estimation mode preference to create or update.
Specify the
AfterDiscounts
status to activate the preference, or specifyBeforeDiscounts
to deactivate the preference.Only the account manager or delegated administrator of your organization can activate this preference.
For more information, see Savings estimation mode in the Compute Optimizer User Guide.
- scope
-
- Type: Scope structure
An object that describes the scope of the recommendation preference to create.
You can create recommendation preferences at the organization level (for management accounts of an organization only), account level, and resource level. For more information, see Activating enhanced infrastructure metrics in the Compute Optimizer User Guide.
You cannot create recommendation preferences for Auto Scaling groups at the organization and account levels. You can create recommendation preferences for Auto Scaling groups only at the resource level by specifying a scope name of
ResourceArn
and a scope value of the Auto Scaling group Amazon Resource Name (ARN). This will configure the preference for all instances that are part of the specified Auto Scaling group. You also cannot create recommendation preferences at the resource level for instances that are part of an Auto Scaling group. You can create recommendation preferences at the resource level only for standalone instances. - utilizationPreferences
-
- Type: Array of UtilizationPreference structures
The preference to control the resource’s CPU utilization threshold, CPU utilization headroom, and memory utilization headroom. When this preference isn't specified, we use the following default values.
CPU utilization:
-
P99_5
for threshold -
PERCENT_20
for headroom
Memory utilization:
-
PERCENT_20
for headroom
-
You can only set CPU and memory utilization preferences for the Amazon EC2 instance resource type.
-
The threshold setting isn’t available for memory utilization.
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
Members
- includeMemberAccounts
-
- Type: boolean
Indicates whether to enroll member accounts of the organization if the account is the management account of an organization.
- status
-
- Required: Yes
- Type: string
The new enrollment status of the account.
The following status options are available:
-
Active
- Opts in your account to the Compute Optimizer service. Compute Optimizer begins analyzing the configuration and utilization metrics of your Amazon Web Services resources after you opt in. For more information, see Metrics analyzed by Compute Optimizer in the Compute Optimizer User Guide. -
Inactive
- Opts out your account from the Compute Optimizer service. Your account's recommendations and related metrics data will be deleted from Compute Optimizer after you opt out.
The
Pending
andFailed
options cannot be used to update the enrollment status of an account. They are returned in the response of a request to update the enrollment status of an account.
Result Syntax
[ 'status' => 'Active|Inactive|Pending|Failed', 'statusReason' => '<string>', ]
Result Details
Members
- status
-
- Type: string
The enrollment status of the account.
- statusReason
-
- Type: string
The reason for the enrollment status of the account. For example, an account might show a status of
Pending
because member accounts of an organization require more time to be enrolled in the service.
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.
Shapes
AccessDeniedException
Description
You do not have sufficient access to perform this action.
Members
- message
-
- Type: string
AccountEnrollmentStatus
Description
Describes the enrollment status of an organization's member accounts in Compute Optimizer.
Members
- accountId
-
- Type: string
The Amazon Web Services account ID.
- lastUpdatedTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The Unix epoch timestamp, in seconds, of when the account enrollment status was last updated.
- status
-
- Type: string
The account enrollment status.
- statusReason
-
- Type: string
The reason for the account enrollment status.
For example, an account might show a status of
Pending
because member accounts of an organization require more time to be enrolled in the service.
AutoScalingGroupConfiguration
Description
Describes the configuration of an Auto Scaling group.
Members
- desiredCapacity
-
- Type: int
The desired capacity, or number of instances, for the Auto Scaling group.
- instanceType
-
- Type: string
The instance type for the Auto Scaling group.
- maxSize
-
- Type: int
The maximum size, or maximum number of instances, for the Auto Scaling group.
- minSize
-
- Type: int
The minimum size, or minimum number of instances, for the Auto Scaling group.
AutoScalingGroupEstimatedMonthlySavings
Description
An object that describes the estimated monthly savings possible by adopting Compute Optimizer’s Auto Scaling group recommendations. This is based on the Savings Plans and Reserved Instances discounts.
Members
- currency
-
- Type: string
The currency of the estimated monthly savings.
- value
-
- Type: double
The value of the estimated monthly savings.
AutoScalingGroupRecommendation
Description
Describes an Auto Scaling group recommendation.
Members
- accountId
-
- Type: string
The Amazon Web Services account ID of the Auto Scaling group.
- autoScalingGroupArn
-
- Type: string
The Amazon Resource Name (ARN) of the Auto Scaling group.
- autoScalingGroupName
-
- Type: string
The name of the Auto Scaling group.
- currentConfiguration
-
- Type: AutoScalingGroupConfiguration structure
An array of objects that describe the current configuration of the Auto Scaling group.
- currentInstanceGpuInfo
-
- Type: GpuInfo structure
Describes the GPU accelerator settings for the current instance type of the Auto Scaling group.
- currentPerformanceRisk
-
- Type: string
The risk of the current Auto Scaling group not meeting the performance needs of its workloads. The higher the risk, the more likely the current Auto Scaling group configuration has insufficient capacity and cannot meet workload requirements.
- effectiveRecommendationPreferences
-
- Type: EffectiveRecommendationPreferences structure
An object that describes the effective recommendation preferences for the Auto Scaling group.
- finding
-
- Type: string
The finding classification of the Auto Scaling group.
Findings for Auto Scaling groups include:
-
NotOptimized
—An Auto Scaling group is considered not optimized when Compute Optimizer identifies a recommendation that can provide better performance for your workload. -
Optimized
—An Auto Scaling group is considered optimized when Compute Optimizer determines that the group is correctly provisioned to run your workload based on the chosen instance type. For optimized resources, Compute Optimizer might recommend a new generation instance type.
- inferredWorkloadTypes
-
- Type: Array of strings
The applications that might be running on the instances in the Auto Scaling group as inferred by Compute Optimizer.
Compute Optimizer can infer if one of the following applications might be running on the instances:
-
AmazonEmr
- Infers that Amazon EMR might be running on the instances. -
ApacheCassandra
- Infers that Apache Cassandra might be running on the instances. -
ApacheHadoop
- Infers that Apache Hadoop might be running on the instances. -
Memcached
- Infers that Memcached might be running on the instances. -
NGINX
- Infers that NGINX might be running on the instances. -
PostgreSql
- Infers that PostgreSQL might be running on the instances. -
Redis
- Infers that Redis might be running on the instances. -
Kafka
- Infers that Kafka might be running on the instance. -
SQLServer
- Infers that SQLServer might be running on the instance.
- lastRefreshTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of when the Auto Scaling group recommendation was last generated.
- lookBackPeriodInDays
-
- Type: double
The number of days for which utilization metrics were analyzed for the Auto Scaling group.
- recommendationOptions
-
- Type: Array of AutoScalingGroupRecommendationOption structures
An array of objects that describe the recommendation options for the Auto Scaling group.
- utilizationMetrics
-
- Type: Array of UtilizationMetric structures
An array of objects that describe the utilization metrics of the Auto Scaling group.
AutoScalingGroupRecommendationOption
Description
Describes a recommendation option for an Auto Scaling group.
Members
- configuration
-
- Type: AutoScalingGroupConfiguration structure
An array of objects that describe an Auto Scaling group configuration.
- instanceGpuInfo
-
- Type: GpuInfo structure
Describes the GPU accelerator settings for the recommended instance type of the Auto Scaling group.
- migrationEffort
-
- Type: string
The level of effort required to migrate from the current instance type to the recommended instance type.
For example, the migration effort is
Low
if Amazon EMR is the inferred workload type and an Amazon Web Services Graviton instance type is recommended. The migration effort isMedium
if a workload type couldn't be inferred but an Amazon Web Services Graviton instance type is recommended. The migration effort isVeryLow
if both the current and recommended instance types are of the same CPU architecture. - performanceRisk
-
- Type: double
The performance risk of the Auto Scaling group configuration recommendation.
Performance risk indicates the likelihood of the recommended instance type not meeting the resource needs of your workload. Compute Optimizer calculates an individual performance risk score for each specification of the recommended instance, including CPU, memory, EBS throughput, EBS IOPS, disk throughput, disk IOPS, network throughput, and network PPS. The performance risk of the recommended instance is calculated as the maximum performance risk score across the analyzed resource specifications.
The value ranges from
0
-4
, with0
meaning that the recommended resource is predicted to always provide enough hardware capability. The higher the performance risk is, the more likely you should validate whether the recommendation will meet the performance requirements of your workload before migrating your resource. - projectedUtilizationMetrics
-
- Type: Array of UtilizationMetric structures
An array of objects that describe the projected utilization metrics of the Auto Scaling group recommendation option.
The
Cpu
andMemory
metrics are the only projected utilization metrics returned. Additionally, theMemory
metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent. - rank
-
- Type: int
The rank of the Auto Scaling group recommendation option.
The top recommendation option is ranked as
1
. - savingsOpportunity
-
- Type: SavingsOpportunity structure
An object that describes the savings opportunity for the Auto Scaling group recommendation option. Savings opportunity includes the estimated monthly savings amount and percentage.
- savingsOpportunityAfterDiscounts
-
- Type: AutoScalingGroupSavingsOpportunityAfterDiscounts structure
An object that describes the savings opportunity for the Auto Scaling group recommendation option that includes Savings Plans and Reserved Instances discounts. Savings opportunity includes the estimated monthly savings and percentage.
AutoScalingGroupSavingsOpportunityAfterDiscounts
Description
Describes the savings opportunity for Auto Scaling group recommendations after applying the Savings Plans and Reserved Instances discounts.
Savings opportunity represents the estimated monthly savings you can achieve by implementing Compute Optimizer recommendations.
Members
- estimatedMonthlySavings
-
- Type: AutoScalingGroupEstimatedMonthlySavings structure
An object that describes the estimated monthly savings possible by adopting Compute Optimizer’s Auto Scaling group recommendations. This is based on the Savings Plans and Reserved Instances pricing discounts.
- savingsOpportunityPercentage
-
- Type: double
The estimated monthly savings possible as a percentage of monthly cost after applying the Savings Plans and Reserved Instances discounts. This saving can be achieved by adopting Compute Optimizer’s Auto Scaling group recommendations.
ContainerConfiguration
Description
Describes the container configurations within the tasks of your Amazon ECS service.
Members
- containerName
-
- Type: string
The name of the container.
- cpu
-
- Type: int
The number of CPU units reserved for the container.
- memorySizeConfiguration
-
- Type: MemorySizeConfiguration structure
The memory size configurations for the container.
ContainerRecommendation
Description
The CPU and memory recommendations for a container within the tasks of your Amazon ECS service.
Members
- containerName
-
- Type: string
The name of the container.
- cpu
-
- Type: int
The recommended number of CPU units reserved for the container.
- memorySizeConfiguration
-
- Type: MemorySizeConfiguration structure
The recommended memory size configurations for the container.
CurrentPerformanceRiskRatings
Description
Describes the performance risk ratings for a given resource type.
Resources with a high
or medium
rating are at risk of not meeting the performance needs of their workloads, while resources with a low
rating are performing well in their workloads.
Members
- high
-
- Type: long (int|float)
A count of the applicable resource types with a high performance risk rating.
- low
-
- Type: long (int|float)
A count of the applicable resource types with a low performance risk rating.
- medium
-
- Type: long (int|float)
A count of the applicable resource types with a medium performance risk rating.
- veryLow
-
- Type: long (int|float)
A count of the applicable resource types with a very low performance risk rating.
CustomizableMetricParameters
Description
Defines the various metric parameters that can be customized, such as threshold and headroom.
Members
- headroom
-
- Type: string
The headroom value in percentage used for the specified metric parameter.
The following lists the valid values for CPU and memory utilization.
-
CPU utilization:
PERCENT_30 | PERCENT_20 | PERCENT_0
-
Memory utilization:
PERCENT_30 | PERCENT_20 | PERCENT_10
- threshold
-
- Type: string
The threshold value used for the specified metric parameter.
You can only specify the threshold value for CPU utilization.
DBStorageConfiguration
Description
The configuration of the recommended RDS storage.
Members
- allocatedStorage
-
- Type: int
The size of the RDS storage in gigabytes (GB).
- iops
-
- Type: int
The provisioned IOPs of the RDS storage.
- maxAllocatedStorage
-
- Type: int
The maximum limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the RDS instance.
- storageThroughput
-
- Type: int
The storage throughput of the RDS storage.
- storageType
-
- Type: string
The type of RDS storage.
EBSEffectiveRecommendationPreferences
Description
Describes the effective recommendation preferences for Amazon EBS volumes.
Members
- savingsEstimationMode
-
- Type: EBSSavingsEstimationMode structure
Describes the savings estimation mode preference applied for calculating savings opportunity for Amazon EBS volumes.
EBSEstimatedMonthlySavings
Description
An object that describes the estimated monthly savings possible by adopting Compute Optimizer’s Amazon EBS volume recommendations. This includes any applicable discounts.
Members
- currency
-
- Type: string
The currency of the estimated monthly savings.
- value
-
- Type: double
The value of the estimated monthly savings.
EBSFilter
Description
Describes a filter that returns a more specific list of Amazon Elastic Block Store (Amazon EBS) volume recommendations. Use this filter with the GetEBSVolumeRecommendations action.
You can use LambdaFunctionRecommendationFilter
with the GetLambdaFunctionRecommendations action, JobFilter
with the DescribeRecommendationExportJobs action, and Filter
with the GetAutoScalingGroupRecommendations and GetEC2InstanceRecommendations actions.
Members
- name
-
- Type: string
The name of the filter.
Specify
Finding
to return recommendations with a specific finding classification (for example,NotOptimized
).You can filter your Amazon EBS volume recommendations by
tag:key
andtag-key
tags.A
tag:key
is a key and value combination of a tag assigned to your Amazon EBS volume recommendations. Use the tag key in the filter name and the tag value as the filter value. For example, to find all Amazon EBS volume recommendations that have a tag with the key ofOwner
and the value ofTeamA
, specifytag:Owner
for the filter name andTeamA
for the filter value.A
tag-key
is the key of a tag assigned to your Amazon EBS volume recommendations. Use this filter to find all of your Amazon EBS volume recommendations that have a tag with a specific key. This doesn’t consider the tag value. For example, you can find your Amazon EBS volume recommendations with a tag key value ofOwner
or without any tag keys assigned. - values
-
- Type: Array of strings
The value of the filter.
The valid values are
Optimized
, orNotOptimized
.
EBSSavingsEstimationMode
Description
Describes the savings estimation mode used for calculating savings opportunity for Amazon EBS volumes.
Members
- source
-
- Type: string
Describes the source for calculating the savings opportunity for Amazon EBS volumes.
EBSSavingsOpportunityAfterDiscounts
Description
Describes the savings opportunity for Amazon EBS volume recommendations after applying specific discounts.
Members
- estimatedMonthlySavings
-
- Type: EBSEstimatedMonthlySavings structure
The estimated monthly savings possible as a percentage of monthly cost by adopting Compute Optimizer’s Amazon EBS volume recommendations. This saving includes any applicable discounts.
- savingsOpportunityPercentage
-
- Type: double
The estimated monthly savings possible as a percentage of monthly cost after applying the specific discounts. This saving can be achieved by adopting Compute Optimizer’s Amazon EBS volume recommendations.
EBSUtilizationMetric
Description
Describes a utilization metric of an Amazon Elastic Block Store (Amazon EBS) volume.
Compare the utilization metric data of your resource against its projected utilization metric data to determine the performance difference between your current resource and the recommended option.
Members
- name
-
- Type: string
The name of the utilization metric.
The following utilization metrics are available:
-
VolumeReadOpsPerSecond
- The completed read operations per second from the volume in a specified period of time.Unit: Count
-
VolumeWriteOpsPerSecond
- The completed write operations per second to the volume in a specified period of time.Unit: Count
-
VolumeReadBytesPerSecond
- The bytes read per second from the volume in a specified period of time.Unit: Bytes
-
VolumeWriteBytesPerSecond
- The bytes written to the volume in a specified period of time.Unit: Bytes
- statistic
-
- Type: string
The statistic of the utilization metric.
The Compute Optimizer API, Command Line Interface (CLI), and SDKs return utilization metrics using only the
Maximum
statistic, which is the highest value observed during the specified period.The Compute Optimizer console displays graphs for some utilization metrics using the
Average
statistic, which is the value ofSum
/SampleCount
during the specified period. For more information, see Viewing resource recommendations in the Compute Optimizer User Guide. You can also get averaged utilization metric data for your resources using Amazon CloudWatch. For more information, see the Amazon CloudWatch User Guide. - value
-
- Type: double
The value of the utilization metric.
ECSEffectiveRecommendationPreferences
Description
Describes the effective recommendation preferences for Amazon ECS services.
Members
- savingsEstimationMode
-
- Type: ECSSavingsEstimationMode structure
Describes the savings estimation mode preference applied for calculating savings opportunity for Amazon ECS services.
ECSEstimatedMonthlySavings
Description
Describes the estimated monthly savings possible for Amazon ECS services by adopting Compute Optimizer recommendations. This is based on Amazon ECS service pricing after applying Savings Plans discounts.
Members
- currency
-
- Type: string
The currency of the estimated monthly savings.
- value
-
- Type: double
The value of the estimated monthly savings for Amazon ECS services.
ECSSavingsEstimationMode
Description
Describes the savings estimation mode used for calculating savings opportunity for Amazon ECS services.
Members
- source
-
- Type: string
Describes the source for calculating the savings opportunity for Amazon ECS services.
ECSSavingsOpportunityAfterDiscounts
Description
Describes the savings opportunity for Amazon ECS service recommendations after applying Savings Plans discounts.
Savings opportunity represents the estimated monthly savings after applying Savings Plans discounts. You can achieve this by implementing a given Compute Optimizer recommendation.
Members
- estimatedMonthlySavings
-
- Type: ECSEstimatedMonthlySavings structure
The estimated monthly savings possible by adopting Compute Optimizer’s Amazon ECS service recommendations. This includes any applicable Savings Plans discounts.
- savingsOpportunityPercentage
-
- Type: double
The estimated monthly savings possible as a percentage of monthly cost by adopting Compute Optimizer’s Amazon ECS service recommendations. This includes any applicable Savings Plans discounts.
ECSServiceProjectedMetric
Description
Describes the projected metrics of an Amazon ECS service recommendation option.
To determine the performance difference between your current Amazon ECS service and the recommended option, compare the metric data of your service against its projected metric data.
Members
- lowerBoundValues
-
- Type: Array of doubles
The lower bound values for the projected metric.
- name
-
- Type: string
The name of the projected metric.
The following metrics are available:
-
Cpu
— The percentage of allocated compute units that are currently in use on the service tasks. -
Memory
— The percentage of memory that's currently in use on the service tasks.
- timestamps
-
- Type: Array of timestamp (string|DateTime or anything parsable by strtotime)s
The timestamps of the projected metric.
- upperBoundValues
-
- Type: Array of doubles
The upper bound values for the projected metric.
ECSServiceProjectedUtilizationMetric
Description
Describes the projected utilization metrics of an Amazon ECS service recommendation option.
To determine the performance difference between your current Amazon ECS service and the recommended option, compare the utilization metric data of your service against its projected utilization metric data.
Members
- lowerBoundValue
-
- Type: double
The lower bound values for the projected utilization metrics.
- name
-
- Type: string
The name of the projected utilization metric.
The following utilization metrics are available:
-
Cpu
— The percentage of allocated compute units that are currently in use on the service tasks. -
Memory
— The percentage of memory that's currently in use on the service tasks.
- statistic
-
- Type: string
The statistic of the projected utilization metric.
The Compute Optimizer API, Command Line Interface (CLI), and SDKs return utilization metrics using only the
Maximum
statistic, which is the highest value observed during the specified period.The Compute Optimizer console displays graphs for some utilization metrics using the
Average
statistic, which is the value ofSum
/SampleCount
during the specified period. For more information, see Viewing resource recommendations in the Compute Optimizer User Guide. You can also get averaged utilization metric data for your resources using Amazon CloudWatch. For more information, see the Amazon CloudWatch User Guide. - upperBoundValue
-
- Type: double
The upper bound values for the projected utilization metrics.
ECSServiceRecommendation
Description
Describes an Amazon ECS service recommendation.
Members
- accountId
-
- Type: string
The Amazon Web Services account ID of the Amazon ECS service.
- currentPerformanceRisk
-
- Type: string
The risk of the current Amazon ECS service not meeting the performance needs of its workloads. The higher the risk, the more likely the current service can't meet the performance requirements of its workload.
- currentServiceConfiguration
-
- Type: ServiceConfiguration structure
The configuration of the current Amazon ECS service.
- effectiveRecommendationPreferences
-
- Type: ECSEffectiveRecommendationPreferences structure
Describes the effective recommendation preferences for Amazon ECS services.
- finding
-
- Type: string
The finding classification of an Amazon ECS service.
Findings for Amazon ECS services include:
-
Underprovisioned
— When Compute Optimizer detects that there’s not enough memory or CPU, an Amazon ECS service is considered under-provisioned. An under-provisioned service might result in poor application performance. -
Overprovisioned
— When Compute Optimizer detects that there’s excessive memory or CPU, an Amazon ECS service is considered over-provisioned. An over-provisioned service might result in additional infrastructure costs. -
Optimized
— When both the CPU and memory of your Amazon ECS service meet the performance requirements of your workload, the service is considered optimized.
- findingReasonCodes
-
- Type: Array of strings
The reason for the finding classification of an Amazon ECS service.
Finding reason codes for Amazon ECS services include:
-
CPUUnderprovisioned
— The service CPU configuration can be sized up to enhance the performance of your workload. This is identified by analyzing theCPUUtilization
metric of the current service during the look-back period. -
CPUOverprovisioned
— The service CPU configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing theCPUUtilization
metric of the current service during the look-back period. -
MemoryUnderprovisioned
— The service memory configuration can be sized up to enhance the performance of your workload. This is identified by analyzing theMemoryUtilization
metric of the current service during the look-back period. -
MemoryOverprovisioned
— The service memory configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing theMemoryUtilization
metric of the current service during the look-back period.
- lastRefreshTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of when the Amazon ECS service recommendation was last generated.
- launchType
-
- Type: string
The launch type the Amazon ECS service is using.
Compute Optimizer only supports the Fargate launch type.
- lookbackPeriodInDays
-
- Type: double
The number of days the Amazon ECS service utilization metrics were analyzed.
- serviceArn
-
- Type: string
The Amazon Resource Name (ARN) of the current Amazon ECS service.
The following is the format of the ARN:
arn:aws:ecs:region:aws_account_id:service/cluster-name/service-name
- serviceRecommendationOptions
-
- Type: Array of ECSServiceRecommendationOption structures
An array of objects that describe the recommendation options for the Amazon ECS service.
- tags
-
- Type: Array of Tag structures
A list of tags assigned to your Amazon ECS service recommendations.
- utilizationMetrics
-
- Type: Array of ECSServiceUtilizationMetric structures
An array of objects that describe the utilization metrics of the Amazon ECS service.
ECSServiceRecommendationFilter
Description
Describes a filter that returns a more specific list of Amazon ECS service recommendations. Use this filter with the GetECSServiceRecommendations action.
Members
- name
-
- Type: string
The name of the filter.
Specify
Finding
to return recommendations with a specific finding classification.Specify
FindingReasonCode
to return recommendations with a specific finding reason code.You can filter your Amazon ECS service recommendations by
tag:key
andtag-key
tags.A
tag:key
is a key and value combination of a tag assigned to your Amazon ECS service recommendations. Use the tag key in the filter name and the tag value as the filter value. For example, to find all Amazon ECS service recommendations that have a tag with the key ofOwner
and the value ofTeamA
, specifytag:Owner
for the filter name andTeamA
for the filter value.A
tag-key
is the key of a tag assigned to your Amazon ECS service recommendations. Use this filter to find all of your Amazon ECS service recommendations that have a tag with a specific key. This doesn’t consider the tag value. For example, you can find your Amazon ECS service recommendations with a tag key value ofOwner
or without any tag keys assigned. - values
-
- Type: Array of strings
The value of the filter.
The valid values for this parameter are as follows:
-
If you specify the
name
parameter asFinding
, specifyOptimized
,Underprovisioned
, orOverprovisioned
. -
If you specify the
name
parameter asFindingReasonCode
, specifyCPUUnderprovisioned
,CPUOverprovisioned
,MemoryUnderprovisioned
, orMemoryOverprovisioned
.
ECSServiceRecommendationOption
Description
Describes the recommendation options for an Amazon ECS service.
Members
- containerRecommendations
-
- Type: Array of ContainerRecommendation structures
The CPU and memory size recommendations for the containers within the task of your Amazon ECS service.
- cpu
-
- Type: int
The CPU size of the Amazon ECS service recommendation option.
- memory
-
- Type: int
The memory size of the Amazon ECS service recommendation option.
- projectedUtilizationMetrics
-
- Type: Array of ECSServiceProjectedUtilizationMetric structures
An array of objects that describe the projected utilization metrics of the Amazon ECS service recommendation option.
- savingsOpportunity
-
- Type: SavingsOpportunity structure
Describes the savings opportunity for recommendations of a given resource type or for the recommendation option of an individual resource.
Savings opportunity represents the estimated monthly savings you can achieve by implementing a given Compute Optimizer recommendation.
Savings opportunity data requires that you opt in to Cost Explorer, as well as activate Receive Amazon EC2 resource recommendations in the Cost Explorer preferences page. That creates a connection between Cost Explorer and Compute Optimizer. With this connection, Cost Explorer generates savings estimates considering the price of existing resources, the price of recommended resources, and historical usage data. Estimated monthly savings reflects the projected dollar savings associated with each of the recommendations generated. For more information, see Enabling Cost Explorer and Optimizing your cost with Rightsizing Recommendations in the Cost Management User Guide.
- savingsOpportunityAfterDiscounts
-
- Type: ECSSavingsOpportunityAfterDiscounts structure
Describes the savings opportunity for Amazon ECS service recommendations or for the recommendation option.
Savings opportunity represents the estimated monthly savings after applying Savings Plans discounts. You can achieve this by implementing a given Compute Optimizer recommendation.
ECSServiceRecommendedOptionProjectedMetric
Description
Describes the projected metrics of an Amazon ECS service recommendation option.
To determine the performance difference between your current Amazon ECS service and the recommended option, compare the metric data of your service against its projected metric data.
Members
- projectedMetrics
-
- Type: Array of ECSServiceProjectedMetric structures
An array of objects that describe the projected metric.
- recommendedCpuUnits
-
- Type: int
The recommended CPU size for the Amazon ECS service.
- recommendedMemorySize
-
- Type: int
The recommended memory size for the Amazon ECS service.
ECSServiceUtilizationMetric
Description
Describes the utilization metric of an Amazon ECS service.
To determine the performance difference between your current Amazon ECS service and the recommended option, compare the utilization metric data of your service against its projected utilization metric data.
Members
- name
-
- Type: string
The name of the utilization metric.
The following utilization metrics are available:
-
Cpu
— The amount of CPU capacity that's used in the service. -
Memory
— The amount of memory that's used in the service.
- statistic
-
- Type: string
The statistic of the utilization metric.
The Compute Optimizer API, Command Line Interface (CLI), and SDKs return utilization metrics using only the
Maximum
statistic, which is the highest value observed during the specified period.The Compute Optimizer console displays graphs for some utilization metrics using the
Average
statistic, which is the value ofSum
/SampleCount
during the specified period. For more information, see Viewing resource recommendations in the Compute Optimizer User Guide. You can also get averaged utilization metric data for your resources using Amazon CloudWatch. For more information, see the Amazon CloudWatch User Guide. - value
-
- Type: double
The value of the utilization metric.
EffectivePreferredResource
Description
Describes the effective preferred resources that Compute Optimizer considers as rightsizing recommendation candidates.
Compute Optimizer only supports Amazon EC2 instance types.
Members
- effectiveIncludeList
-
- Type: Array of strings
The expanded version of your preferred resource's include list.
- excludeList
-
- Type: Array of strings
The list of preferred resources values that you want excluded from rightsizing recommendation candidates.
- includeList
-
- Type: Array of strings
The list of preferred resource values that you want considered as rightsizing recommendation candidates.
- name
-
- Type: string
The name of the preferred resource list.
EffectiveRecommendationPreferences
Description
Describes the effective recommendation preferences for a resource.
Members
- cpuVendorArchitectures
-
- Type: Array of strings
Describes the CPU vendor and architecture for an instance or 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.
- enhancedInfrastructureMetrics
-
- Type: string
Describes the activation status of the enhanced infrastructure metrics preference.
A status of
Active
confirms that the preference is applied in the latest recommendation refresh, and a status ofInactive
confirms that it's not yet applied to recommendations.For more information, see Enhanced infrastructure metrics in the Compute Optimizer User Guide.
- externalMetricsPreference
-
- Type: ExternalMetricsPreference structure
An object that describes the external metrics recommendation preference.
If the preference is applied in the latest recommendation refresh, an object with a valid
source
value appears in the response. If the preference isn't applied to the recommendations already, then this object doesn't appear in the response. - inferredWorkloadTypes
-
- Type: string
Describes the activation status of the inferred workload types preference.
A status of
Active
confirms that the preference is applied in the latest recommendation refresh. A status ofInactive
confirms that it's not yet applied to recommendations. - lookBackPeriod
-
- Type: string
The number of days the utilization metrics of the Amazon Web Services resource are analyzed.
- preferredResources
-
- Type: Array of EffectivePreferredResource structures
The resource type values that are considered as candidates when generating rightsizing recommendations.
- savingsEstimationMode
-
- Type: InstanceSavingsEstimationMode structure
Describes the savings estimation mode applied for calculating savings opportunity for a resource.
- utilizationPreferences
-
- Type: Array of UtilizationPreference structures
The resource’s CPU and memory utilization preferences, such as threshold and headroom, that are used to generate rightsizing recommendations.
This preference is only available for the Amazon EC2 instance resource type.
EnrollmentFilter
Description
Describes a filter that returns a more specific list of account enrollment statuses. Use this filter with the GetEnrollmentStatusesForOrganization action.
Members
- name
-
- Type: string
The name of the filter.
Specify
Status
to return accounts with a specific enrollment status (for example,Active
). - values
-
- Type: Array of strings
The value of the filter.
The valid values are
Active
,Inactive
,Pending
, andFailed
.
EstimatedMonthlySavings
Description
Describes the estimated monthly savings amount possible, based on On-Demand instance pricing, by adopting Compute Optimizer recommendations for a given resource.
For more information, see Estimated monthly savings and savings opportunities in the Compute Optimizer User Guide.
Members
- currency
-
- Type: string
The currency of the estimated monthly savings.
- value
-
- Type: double
The value of the estimated monthly savings.
ExportDestination
Description
Describes the destination of the recommendations export and metadata files.
Members
- s3
-
- Type: S3Destination structure
An object that describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and object keys of a recommendations export file, and its associated metadata file.
ExternalMetricStatus
Description
Describes Compute Optimizer's integration status with your chosen external metric provider. For example, Datadog.
Members
- statusCode
-
- Type: string
The status code for Compute Optimizer's integration with an external metrics provider.
- statusReason
-
- Type: string
The reason for Compute Optimizer's integration status with your external metric provider.
ExternalMetricsPreference
Description
Describes the external metrics preferences for EC2 rightsizing recommendations.
Members
- source
-
- Type: string
Contains the source options for external metrics preferences.
Filter
Description
Describes a filter that returns a more specific list of recommendations. Use this filter with the GetAutoScalingGroupRecommendations and GetEC2InstanceRecommendations actions.
You can use EBSFilter
with the GetEBSVolumeRecommendations action, LambdaFunctionRecommendationFilter
with the GetLambdaFunctionRecommendations action, and JobFilter
with the DescribeRecommendationExportJobs action.
Members
- name
-
- Type: string
The name of the filter.
Specify
Finding
to return recommendations with a specific finding classification. For example,Underprovisioned
.Specify
RecommendationSourceType
to return recommendations of a specific resource type. For example,Ec2Instance
.Specify
FindingReasonCodes
to return recommendations with a specific finding reason code. For example,CPUUnderprovisioned
.Specify
InferredWorkloadTypes
to return recommendations of a specific inferred workload. For example,Redis
.You can filter your EC2 instance recommendations by
tag:key
andtag-key
tags.A
tag:key
is a key and value combination of a tag assigned to your recommendations. Use the tag key in the filter name and the tag value as the filter value. For example, to find all recommendations that have a tag with the key ofOwner
and the value ofTeamA
, specifytag:Owner
for the filter name andTeamA
for the filter value.A
tag-key
is the key of a tag assigned to your recommendations. Use this filter to find all of your recommendations that have a tag with a specific key. This doesn’t consider the tag value. For example, you can find your recommendations with a tag key value ofOwner
or without any tag keys assigned. - values
-
- Type: Array of strings
The value of the filter.
The valid values for this parameter are as follows, depending on what you specify for the
name
parameter and the resource type that you wish to filter results for:-
Specify
Optimized
orNotOptimized
if you specify thename
parameter asFinding
and you want to filter results for Auto Scaling groups. -
Specify
Underprovisioned
,Overprovisioned
, orOptimized
if you specify thename
parameter asFinding
and you want to filter results for EC2 instances. -
Specify
Ec2Instance
orAutoScalingGroup
if you specify thename
parameter asRecommendationSourceType
. -
Specify one of the following options if you specify the
name
parameter asFindingReasonCodes
:-
CPUOverprovisioned
— The instance’s CPU configuration can be sized down while still meeting the performance requirements of your workload. -
CPUUnderprovisioned
— The instance’s CPU configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better CPU performance. -
MemoryOverprovisioned
— The instance’s memory configuration can be sized down while still meeting the performance requirements of your workload. -
MemoryUnderprovisioned
— The instance’s memory configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better memory performance. -
EBSThroughputOverprovisioned
— The instance’s EBS throughput configuration can be sized down while still meeting the performance requirements of your workload. -
EBSThroughputUnderprovisioned
— The instance’s EBS throughput configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better EBS throughput performance. -
EBSIOPSOverprovisioned
— The instance’s EBS IOPS configuration can be sized down while still meeting the performance requirements of your workload. -
EBSIOPSUnderprovisioned
— The instance’s EBS IOPS configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better EBS IOPS performance. -
NetworkBandwidthOverprovisioned
— The instance’s network bandwidth configuration can be sized down while still meeting the performance requirements of your workload. -
NetworkBandwidthUnderprovisioned
— The instance’s network bandwidth configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better network bandwidth performance. This finding reason happens when theNetworkIn
orNetworkOut
performance of an instance is impacted. -
NetworkPPSOverprovisioned
— The instance’s network PPS (packets per second) configuration can be sized down while still meeting the performance requirements of your workload. -
NetworkPPSUnderprovisioned
— The instance’s network PPS (packets per second) configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better network PPS performance. -
DiskIOPSOverprovisioned
— The instance’s disk IOPS configuration can be sized down while still meeting the performance requirements of your workload. -
DiskIOPSUnderprovisioned
— The instance’s disk IOPS configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better disk IOPS performance. -
DiskThroughputOverprovisioned
— The instance’s disk throughput configuration can be sized down while still meeting the performance requirements of your workload. -
DiskThroughputUnderprovisioned
— The instance’s disk throughput configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better disk throughput performance.
-
GetRecommendationError
Description
Describes an error experienced when getting recommendations.
For example, an error is returned if you request recommendations for an unsupported Auto Scaling group, or if you request recommendations for an instance of an unsupported instance family.
Members
- code
-
- Type: string
The error code.
- identifier
-
- Type: string
The ID of the error.
- message
-
- Type: string
The message, or reason, for the error.
Gpu
Description
Describes the GPU accelerators for the instance type.
Members
- gpuCount
-
- Type: int
The number of GPUs for the instance type.
- gpuMemorySizeInMiB
-
- Type: int
The total size of the memory for the GPU accelerators for the instance type, in MiB.
GpuInfo
Description
Describes the GPU accelerator settings for the instance type.
Members
- gpus
-
- Type: Array of Gpu structures
Describes the GPU accelerators for the instance type.
InferredWorkloadSaving
Description
The estimated monthly savings after you adjust the configurations of your instances running on the inferred workload types to the recommended configurations. If the inferredWorkloadTypes
list contains multiple entries, then the savings are the sum of the monthly savings from instances that run the exact combination of the inferred workload types.
Members
- estimatedMonthlySavings
-
- Type: EstimatedMonthlySavings structure
An object that describes the estimated monthly savings amount possible by adopting Compute Optimizer recommendations for a given resource. This is based on the On-Demand instance pricing.
- inferredWorkloadTypes
-
- Type: Array of strings
The applications that might be running on the instance as inferred by Compute Optimizer.
Compute Optimizer can infer if one of the following applications might be running on the instance:
-
AmazonEmr
- Infers that Amazon EMR might be running on the instance. -
ApacheCassandra
- Infers that Apache Cassandra might be running on the instance. -
ApacheHadoop
- Infers that Apache Hadoop might be running on the instance. -
Memcached
- Infers that Memcached might be running on the instance. -
NGINX
- Infers that NGINX might be running on the instance. -
PostgreSql
- Infers that PostgreSQL might be running on the instance. -
Redis
- Infers that Redis might be running on the instance. -
Kafka
- Infers that Kafka might be running on the instance. -
SQLServer
- Infers that SQLServer might be running on the instance.
InstanceEstimatedMonthlySavings
Description
An object that describes the estimated monthly savings possible by adopting Compute Optimizer’s Amazon EC2 instance recommendations. This is based on the Savings Plans and Reserved Instances pricing discounts.
Members
- currency
-
- Type: string
The currency of the estimated monthly savings.
- value
-
- Type: double
The value of the estimated monthly savings.
InstanceRecommendation
Description
Describes an Amazon EC2 instance recommendation.
Members
- accountId
-
- Type: string
The Amazon Web Services account ID of the instance.
- currentInstanceGpuInfo
-
- Type: GpuInfo structure
Describes the GPU accelerator settings for the current instance type.
- currentInstanceType
-
- Type: string
The instance type of the current instance.
- currentPerformanceRisk
-
- Type: string
The risk of the current instance not meeting the performance needs of its workloads. The higher the risk, the more likely the current instance cannot meet the performance requirements of its workload.
- effectiveRecommendationPreferences
-
- Type: EffectiveRecommendationPreferences structure
An object that describes the effective recommendation preferences for the instance.
- externalMetricStatus
-
- Type: ExternalMetricStatus structure
An object that describes Compute Optimizer's integration status with your external metrics provider.
- finding
-
- Type: string
The finding classification of the instance.
Findings for instances include:
-
Underprovisioned
—An instance is considered under-provisioned when at least one specification of your instance, such as CPU, memory, or network, does not meet the performance requirements of your workload. Under-provisioned instances may lead to poor application performance. -
Overprovisioned
—An instance is considered over-provisioned when at least one specification of your instance, such as CPU, memory, or network, can be sized down while still meeting the performance requirements of your workload, and no specification is under-provisioned. Over-provisioned instances may lead to unnecessary infrastructure cost. -
Optimized
—An instance is considered optimized when all specifications of your instance, such as CPU, memory, and network, meet the performance requirements of your workload and is not over provisioned. For optimized resources, Compute Optimizer might recommend a new generation instance type.
The valid values in your API responses appear as OVER_PROVISIONED, UNDER_PROVISIONED, or OPTIMIZED.
- findingReasonCodes
-
- Type: Array of strings
The reason for the finding classification of the instance.
Finding reason codes for instances include:
-
CPUOverprovisioned
— The instance’s CPU configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing theCPUUtilization
metric of the current instance during the look-back period. -
CPUUnderprovisioned
— The instance’s CPU configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better CPU performance. This is identified by analyzing theCPUUtilization
metric of the current instance during the look-back period. -
MemoryOverprovisioned
— The instance’s memory configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the memory utilization metric of the current instance during the look-back period. -
MemoryUnderprovisioned
— The instance’s memory configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better memory performance. This is identified by analyzing the memory utilization metric of the current instance during the look-back period.Memory utilization is analyzed only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling memory utilization with the Amazon CloudWatch Agent in the Compute Optimizer User Guide. On Linux instances, Compute Optimizer analyses the
mem_used_percent
metric in theCWAgent
namespace, or the legacyMemoryUtilization
metric in theSystem/Linux
namespace. On Windows instances, Compute Optimizer analyses theMemory % Committed Bytes In Use
metric in theCWAgent
namespace. -
EBSThroughputOverprovisioned
— The instance’s EBS throughput configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing theVolumeReadBytes
andVolumeWriteBytes
metrics of EBS volumes attached to the current instance during the look-back period. -
EBSThroughputUnderprovisioned
— The instance’s EBS throughput configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better EBS throughput performance. This is identified by analyzing theVolumeReadBytes
andVolumeWriteBytes
metrics of EBS volumes attached to the current instance during the look-back period. -
EBSIOPSOverprovisioned
— The instance’s EBS IOPS configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing theVolumeReadOps
andVolumeWriteOps
metric of EBS volumes attached to the current instance during the look-back period. -
EBSIOPSUnderprovisioned
— The instance’s EBS IOPS configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better EBS IOPS performance. This is identified by analyzing theVolumeReadOps
andVolumeWriteOps
metric of EBS volumes attached to the current instance during the look-back period. -
NetworkBandwidthOverprovisioned
— The instance’s network bandwidth configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing theNetworkIn
andNetworkOut
metrics of the current instance during the look-back period. -
NetworkBandwidthUnderprovisioned
— The instance’s network bandwidth configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better network bandwidth performance. This is identified by analyzing theNetworkIn
andNetworkOut
metrics of the current instance during the look-back period. This finding reason happens when theNetworkIn
orNetworkOut
performance of an instance is impacted. -
NetworkPPSOverprovisioned
— The instance’s network PPS (packets per second) configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing theNetworkPacketsIn
andNetworkPacketsIn
metrics of the current instance during the look-back period. -
NetworkPPSUnderprovisioned
— The instance’s network PPS (packets per second) configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better network PPS performance. This is identified by analyzing theNetworkPacketsIn
andNetworkPacketsIn
metrics of the current instance during the look-back period. -
DiskIOPSOverprovisioned
— The instance’s disk IOPS configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing theDiskReadOps
andDiskWriteOps
metrics of the current instance during the look-back period. -
DiskIOPSUnderprovisioned
— The instance’s disk IOPS configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better disk IOPS performance. This is identified by analyzing theDiskReadOps
andDiskWriteOps
metrics of the current instance during the look-back period. -
DiskThroughputOverprovisioned
— The instance’s disk throughput configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing theDiskReadBytes
andDiskWriteBytes
metrics of the current instance during the look-back period. -
DiskThroughputUnderprovisioned
— The instance’s disk throughput configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better disk throughput performance. This is identified by analyzing theDiskReadBytes
andDiskWriteBytes
metrics of the current instance during the look-back period.
For more information about instance metrics, see List the available CloudWatch metrics for your instances in the Amazon Elastic Compute Cloud User Guide. For more information about EBS volume metrics, see Amazon CloudWatch metrics for Amazon EBS in the Amazon Elastic Compute Cloud User Guide.
- idle
-
- Type: string
Describes if an Amazon EC2 instance is idle.
- inferredWorkloadTypes
-
- Type: Array of strings
The applications that might be running on the instance as inferred by Compute Optimizer.
Compute Optimizer can infer if one of the following applications might be running on the instance:
-
AmazonEmr
- Infers that Amazon EMR might be running on the instance. -
ApacheCassandra
- Infers that Apache Cassandra might be running on the instance. -
ApacheHadoop
- Infers that Apache Hadoop might be running on the instance. -
Memcached
- Infers that Memcached might be running on the instance. -
NGINX
- Infers that NGINX might be running on the instance. -
PostgreSql
- Infers that PostgreSQL might be running on the instance. -
Redis
- Infers that Redis might be running on the instance. -
Kafka
- Infers that Kafka might be running on the instance. -
SQLServer
- Infers that SQLServer might be running on the instance.
- instanceArn
-
- Type: string
The Amazon Resource Name (ARN) of the current instance.
- instanceName
-
- Type: string
The name of the current instance.
- instanceState
-
- Type: string
The state of the instance when the recommendation was generated.
- lastRefreshTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of when the instance recommendation was last generated.
- lookBackPeriodInDays
-
- Type: double
The number of days for which utilization metrics were analyzed for the instance.
- recommendationOptions
-
- Type: Array of InstanceRecommendationOption structures
An array of objects that describe the recommendation options for the instance.
- recommendationSources
-
- Type: Array of RecommendationSource structures
An array of objects that describe the source resource of the recommendation.
- tags
-
- Type: Array of Tag structures
A list of tags assigned to your Amazon EC2 instance recommendations.
- utilizationMetrics
-
- Type: Array of UtilizationMetric structures
An array of objects that describe the utilization metrics of the instance.
InstanceRecommendationOption
Description
Describes a recommendation option for an Amazon EC2 instance.
Members
- instanceGpuInfo
-
- Type: GpuInfo structure
Describes the GPU accelerator settings for the recommended instance type.
- instanceType
-
- Type: string
The instance type of the instance recommendation.
- migrationEffort
-
- Type: string
The level of effort required to migrate from the current instance type to the recommended instance type.
For example, the migration effort is
Low
if Amazon EMR is the inferred workload type and an Amazon Web Services Graviton instance type is recommended. The migration effort isMedium
if a workload type couldn't be inferred but an Amazon Web Services Graviton instance type is recommended. The migration effort isVeryLow
if both the current and recommended instance types are of the same CPU architecture. - performanceRisk
-
- Type: double
The performance risk of the instance recommendation option.
Performance risk indicates the likelihood of the recommended instance type not meeting the resource needs of your workload. Compute Optimizer calculates an individual performance risk score for each specification of the recommended instance, including CPU, memory, EBS throughput, EBS IOPS, disk throughput, disk IOPS, network throughput, and network PPS. The performance risk of the recommended instance is calculated as the maximum performance risk score across the analyzed resource specifications.
The value ranges from
0
-4
, with0
meaning that the recommended resource is predicted to always provide enough hardware capability. The higher the performance risk is, the more likely you should validate whether the recommendation will meet the performance requirements of your workload before migrating your resource. - platformDifferences
-
- Type: Array of strings
Describes the configuration differences between the current instance and the recommended instance type. You should consider the configuration differences before migrating your workloads from the current instance to the recommended instance type. The Change the instance type guide for Linux and Change the instance type guide for Windows provide general guidance for getting started with an instance migration.
Platform differences include:
-
Hypervisor
— The hypervisor of the recommended instance type is different than that of the current instance. For example, the recommended instance type uses a Nitro hypervisor and the current instance uses a Xen hypervisor. The differences that you should consider between these hypervisors are covered in the Nitro Hypervisor section of the Amazon EC2 frequently asked questions. For more information, see Instances built on the Nitro System in the Amazon EC2 User Guide for Linux, or Instances built on the Nitro System in the Amazon EC2 User Guide for Windows. -
NetworkInterface
— The network interface of the recommended instance type is different than that of the current instance. For example, the recommended instance type supports enhanced networking and the current instance might not. To enable enhanced networking for the recommended instance type, you must install the Elastic Network Adapter (ENA) driver or the Intel 82599 Virtual Function driver. For more information, see Networking and storage features and Enhanced networking on Linux in the Amazon EC2 User Guide for Linux, or Networking and storage features and Enhanced networking on Windows in the Amazon EC2 User Guide for Windows. -
StorageInterface
— The storage interface of the recommended instance type is different than that of the current instance. For example, the recommended instance type uses an NVMe storage interface and the current instance does not. To access NVMe volumes for the recommended instance type, you will need to install or upgrade the NVMe driver. For more information, see Networking and storage features and Amazon EBS and NVMe on Linux instances in the Amazon EC2 User Guide for Linux, or Networking and storage features and Amazon EBS and NVMe on Windows instances in the Amazon EC2 User Guide for Windows. -
InstanceStoreAvailability
— The recommended instance type does not support instance store volumes and the current instance does. Before migrating, you might need to back up the data on your instance store volumes if you want to preserve them. For more information, see How do I back up an instance store volume on my Amazon EC2 instance to Amazon EBS? in the Amazon Web Services Premium Support Knowledge Base. For more information, see Networking and storage features and Amazon EC2 instance store in the Amazon EC2 User Guide for Linux, or see Networking and storage features and Amazon EC2 instance store in the Amazon EC2 User Guide for Windows. -
VirtualizationType
— The recommended instance type uses the hardware virtual machine (HVM) virtualization type and the current instance uses the paravirtual (PV) virtualization type. For more information about the differences between these virtualization types, see Linux AMI virtualization types in the Amazon EC2 User Guide for Linux, or Windows AMI virtualization types in the Amazon EC2 User Guide for Windows. -
Architecture
— The CPU architecture between the recommended instance type and the current instance is different. For example, the recommended instance type might use an Arm CPU architecture and the current instance type might use a different one, such as x86. Before migrating, you should consider recompiling the software on your instance for the new architecture. Alternatively, you might switch to an Amazon Machine Image (AMI) that supports the new architecture. For more information about the CPU architecture for each instance type, see Amazon EC2 Instance Types.
- projectedUtilizationMetrics
-
- Type: Array of UtilizationMetric structures
An array of objects that describe the projected utilization metrics of the instance recommendation option.
The
Cpu
andMemory
metrics are the only projected utilization metrics returned. Additionally, theMemory
metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent. - rank
-
- Type: int
The rank of the instance recommendation option.
The top recommendation option is ranked as
1
. - savingsOpportunity
-
- Type: SavingsOpportunity structure
An object that describes the savings opportunity for the instance recommendation option. Savings opportunity includes the estimated monthly savings amount and percentage.
- savingsOpportunityAfterDiscounts
-
- Type: InstanceSavingsOpportunityAfterDiscounts structure
An object that describes the savings opportunity for the instance recommendation option that includes Savings Plans and Reserved Instances discounts. Savings opportunity includes the estimated monthly savings and percentage.
InstanceSavingsEstimationMode
Description
Describes the savings estimation mode used for calculating savings opportunity for Amazon EC2 instances.
Members
- source
-
- Type: string
Describes the source for calculating the savings opportunity for Amazon EC2 instances.
InstanceSavingsOpportunityAfterDiscounts
Description
Describes the savings opportunity for instance recommendations after applying the Savings Plans and Reserved Instances discounts.
Savings opportunity after discounts represents the estimated monthly savings you can achieve by implementing Compute Optimizer recommendations.
Members
- estimatedMonthlySavings
-
- Type: InstanceEstimatedMonthlySavings structure
An object that describes the estimated monthly savings possible by adopting Compute Optimizer’s Amazon EC2 instance recommendations. This is based on pricing after applying the Savings Plans and Reserved Instances discounts.
- savingsOpportunityPercentage
-
- Type: double
The estimated monthly savings possible as a percentage of monthly cost after applying the Savings Plans and Reserved Instances discounts. This saving can be achieved by adopting Compute Optimizer’s EC2 instance recommendations.
InternalServerException
Description
An internal error has occurred. Try your call again.
Members
- message
-
- Type: string
InvalidParameterValueException
Description
The value supplied for the input parameter is out of range or not valid.
Members
- message
-
- Type: string
JobFilter
Description
Describes a filter that returns a more specific list of recommendation export jobs. Use this filter with the DescribeRecommendationExportJobs action.
You can use EBSFilter
with the GetEBSVolumeRecommendations action, LambdaFunctionRecommendationFilter
with the GetLambdaFunctionRecommendations action, and Filter
with the GetAutoScalingGroupRecommendations and GetEC2InstanceRecommendations actions.
Members
- name
-
- Type: string
The name of the filter.
Specify
ResourceType
to return export jobs of a specific resource type (for example,Ec2Instance
).Specify
JobStatus
to return export jobs with a specific status (e.g,Complete
). - values
-
- Type: Array of strings
The value of the filter.
The valid values for this parameter are as follows, depending on what you specify for the
name
parameter:-
Specify
Ec2Instance
orAutoScalingGroup
if you specify thename
parameter asResourceType
. There is no filter for EBS volumes because volume recommendations cannot be exported at this time. -
Specify
Queued
,InProgress
,Complete
, orFailed
if you specify thename
parameter asJobStatus
.
LambdaEffectiveRecommendationPreferences
Description
Describes the effective recommendation preferences for Lambda functions.
Members
- savingsEstimationMode
-
- Type: LambdaSavingsEstimationMode structure
Describes the savings estimation mode applied for calculating savings opportunity for Lambda functions.
LambdaEstimatedMonthlySavings
Description
Describes the estimated monthly savings possible for Lambda functions by adopting Compute Optimizer recommendations. This is based on Lambda functions pricing after applying Savings Plans discounts.
Members
- currency
-
- Type: string
The currency of the estimated monthly savings.
- value
-
- Type: double
The value of the estimated monthly savings.
LambdaFunctionMemoryProjectedMetric
Description
Describes a projected utilization metric of an Lambda function recommendation option.
Members
- name
-
- Type: string
The name of the projected utilization metric.
- statistic
-
- Type: string
The statistic of the projected utilization metric.
- value
-
- Type: double
The values of the projected utilization metrics.
LambdaFunctionMemoryRecommendationOption
Description
Describes a recommendation option for an Lambda function.
Members
- memorySize
-
- Type: int
The memory size, in MB, of the function recommendation option.
- projectedUtilizationMetrics
-
- Type: Array of LambdaFunctionMemoryProjectedMetric structures
An array of objects that describe the projected utilization metrics of the function recommendation option.
- rank
-
- Type: int
The rank of the function recommendation option.
The top recommendation option is ranked as
1
. - savingsOpportunity
-
- Type: SavingsOpportunity structure
An object that describes the savings opportunity for the Lambda function recommendation option. Savings opportunity includes the estimated monthly savings amount and percentage.
- savingsOpportunityAfterDiscounts
-
- Type: LambdaSavingsOpportunityAfterDiscounts structure
An object that describes the savings opportunity for the Lambda recommendation option which includes Saving Plans discounts. Savings opportunity includes the estimated monthly savings and percentage.
LambdaFunctionRecommendation
Description
Describes an Lambda function recommendation.
Members
- accountId
-
- Type: string
The Amazon Web Services account ID of the function.
- currentMemorySize
-
- Type: int
The amount of memory, in MB, that's allocated to the current function.
- currentPerformanceRisk
-
- Type: string
The risk of the current Lambda function not meeting the performance needs of its workloads. The higher the risk, the more likely the current Lambda function requires more memory.
- effectiveRecommendationPreferences
-
- Type: LambdaEffectiveRecommendationPreferences structure
Describes the effective recommendation preferences for Lambda functions.
- finding
-
- Type: string
The finding classification of the function.
Findings for functions include:
-
Optimized
— The function is correctly provisioned to run your workload based on its current configuration and its utilization history. This finding classification does not include finding reason codes. -
NotOptimized
— The function is performing at a higher level (over-provisioned) or at a lower level (under-provisioned) than required for your workload because its current configuration is not optimal. Over-provisioned resources might lead to unnecessary infrastructure cost, and under-provisioned resources might lead to poor application performance. This finding classification can include theMemoryUnderprovisioned
andMemoryUnderprovisioned
finding reason codes. -
Unavailable
— Compute Optimizer was unable to generate a recommendation for the function. This could be because the function has not accumulated sufficient metric data, or the function does not qualify for a recommendation. This finding classification can include theInsufficientData
andInconclusive
finding reason codes.Functions with a finding of unavailable are not returned unless you specify the
filter
parameter with a value ofUnavailable
in yourGetLambdaFunctionRecommendations
request.
- findingReasonCodes
-
- Type: Array of strings
The reason for the finding classification of the function.
Functions that have a finding classification of
Optimized
don't have a finding reason code.Finding reason codes for functions include:
-
MemoryOverprovisioned
— The function is over-provisioned when its memory configuration can be sized down while still meeting the performance requirements of your workload. An over-provisioned function might lead to unnecessary infrastructure cost. This finding reason code is part of theNotOptimized
finding classification. -
MemoryUnderprovisioned
— The function is under-provisioned when its memory configuration doesn't meet the performance requirements of the workload. An under-provisioned function might lead to poor application performance. This finding reason code is part of theNotOptimized
finding classification. -
InsufficientData
— The function does not have sufficient metric data for Compute Optimizer to generate a recommendation. For more information, see the Supported resources and requirements in the Compute Optimizer User Guide. This finding reason code is part of theUnavailable
finding classification. -
Inconclusive
— The function does not qualify for a recommendation because Compute Optimizer cannot generate a recommendation with a high degree of confidence. This finding reason code is part of theUnavailable
finding classification.
- functionArn
-
- Type: string
The Amazon Resource Name (ARN) of the current function.
- functionVersion
-
- Type: string
The version number of the current function.
- lastRefreshTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of when the function recommendation was last generated.
- lookbackPeriodInDays
-
- Type: double
The number of days for which utilization metrics were analyzed for the function.
- memorySizeRecommendationOptions
-
- Type: Array of LambdaFunctionMemoryRecommendationOption structures
An array of objects that describe the memory configuration recommendation options for the function.
- numberOfInvocations
-
- Type: long (int|float)
The number of times your function code was applied during the look-back period.
- tags
-
- Type: Array of Tag structures
A list of tags assigned to your Lambda function recommendations.
- utilizationMetrics
-
- Type: Array of LambdaFunctionUtilizationMetric structures
An array of objects that describe the utilization metrics of the function.
LambdaFunctionRecommendationFilter
Description
Describes a filter that returns a more specific list of Lambda function recommendations. Use this filter with the GetLambdaFunctionRecommendations action.
You can use EBSFilter
with the GetEBSVolumeRecommendations action, JobFilter
with the DescribeRecommendationExportJobs action, and Filter
with the GetAutoScalingGroupRecommendations and GetEC2InstanceRecommendations actions.
Members
- name
-
- Type: string
The name of the filter.
Specify
Finding
to return recommendations with a specific finding classification (for example,NotOptimized
).Specify
FindingReasonCode
to return recommendations with a specific finding reason code (for example,MemoryUnderprovisioned
).You can filter your Lambda function recommendations by
tag:key
andtag-key
tags.A
tag:key
is a key and value combination of a tag assigned to your Lambda function recommendations. Use the tag key in the filter name and the tag value as the filter value. For example, to find all Lambda function recommendations that have a tag with the key ofOwner
and the value ofTeamA
, specifytag:Owner
for the filter name andTeamA
for the filter value.A
tag-key
is the key of a tag assigned to your Lambda function recommendations. Use this filter to find all of your Lambda function recommendations that have a tag with a specific key. This doesn’t consider the tag value. For example, you can find your Lambda function recommendations with a tag key value ofOwner
or without any tag keys assigned. - values
-
- Type: Array of strings
The value of the filter.
The valid values for this parameter are as follows, depending on what you specify for the
name
parameter:-
Specify
Optimized
,NotOptimized
, orUnavailable
if you specify thename
parameter asFinding
. -
Specify
MemoryOverprovisioned
,MemoryUnderprovisioned
,InsufficientData
, orInconclusive
if you specify thename
parameter asFindingReasonCode
.
LambdaFunctionUtilizationMetric
Description
Describes a utilization metric of an Lambda function.
Members
- name
-
- Type: string
The name of the utilization metric.
The following utilization metrics are available:
-
Duration
- The amount of time that your function code spends processing an event. -
Memory
- The amount of memory used per invocation.
- statistic
-
- Type: string
The statistic of the utilization metric.
The Compute Optimizer API, Command Line Interface (CLI), and SDKs return utilization metrics using only the
Maximum
statistic, which is the highest value observed during the specified period.The Compute Optimizer console displays graphs for some utilization metrics using the
Average
statistic, which is the value ofSum
/SampleCount
during the specified period. For more information, see Viewing resource recommendations in the Compute Optimizer User Guide. You can also get averaged utilization metric data for your resources using Amazon CloudWatch. For more information, see the Amazon CloudWatch User Guide. - value
-
- Type: double
The value of the utilization metric.
LambdaSavingsEstimationMode
Description
Describes the savings estimation used for calculating savings opportunity for Lambda functions.
Members
- source
-
- Type: string
Describes the source for calculation of savings opportunity for Lambda functions.
LambdaSavingsOpportunityAfterDiscounts
Description
Describes the savings opportunity for Lambda functions recommendations after applying Savings Plans discounts.
Savings opportunity represents the estimated monthly savings after applying Savings Plans discounts. You can achieve this by implementing a given Compute Optimizer recommendation.
Members
- estimatedMonthlySavings
-
- Type: LambdaEstimatedMonthlySavings structure
The estimated monthly savings possible by adopting Compute Optimizer’s Lambda function recommendations. This includes any applicable Savings Plans discounts.
- savingsOpportunityPercentage
-
- Type: double
The estimated monthly savings possible as a percentage of monthly cost by adopting Compute Optimizer’s Lambda function recommendations. This includes any applicable Savings Plans discounts.
LicenseConfiguration
Description
Describes the configuration of a license for an Amazon EC2 instance.
Members
- instanceType
-
- Type: string
The instance type used in the license.
- licenseEdition
-
- Type: string
The edition of the license for the application that runs on the instance.
- licenseModel
-
- Type: string
The license type associated with the instance.
- licenseName
-
- Type: string
The name of the license for the application that runs on the instance.
- licenseVersion
-
- Type: string
The version of the license for the application that runs on the instance.
- metricsSource
-
- Type: Array of MetricSource structures
The list of metric sources required to generate recommendations for commercial software licenses.
- numberOfCores
-
- Type: int
The current number of cores associated with the instance.
- operatingSystem
-
- Type: string
The operating system of the instance.
LicenseRecommendation
Description
Describes a license recommendation for an EC2 instance.
Members
- accountId
-
- Type: string
The Amazon Web Services account ID of the license.
- currentLicenseConfiguration
-
- Type: LicenseConfiguration structure
An object that describes the current configuration of an instance that runs on a license.
- finding
-
- Type: string
The finding classification for an instance that runs on a license.
Findings include:
-
InsufficentMetrics
— When Compute Optimizer detects that your CloudWatch Application Insights isn't enabled or is enabled with insufficient permissions. -
NotOptimized
— When Compute Optimizer detects that your EC2 infrastructure isn't using any of the SQL server license features you're paying for, a license is considered not optimized. -
Optimized
— When Compute Optimizer detects that all specifications of your license meet the performance requirements of your workload.
- findingReasonCodes
-
- Type: Array of strings
The reason for the finding classification for an instance that runs on a license.
Finding reason codes include:
-
Optimized
— All specifications of your license meet the performance requirements of your workload. -
LicenseOverprovisioned
— A license is considered over-provisioned when your license can be downgraded while still meeting the performance requirements of your workload. -
InvalidCloudwatchApplicationInsights
— CloudWatch Application Insights isn't configured properly. -
CloudwatchApplicationInsightsError
— There is a CloudWatch Application Insights error.
- lastRefreshTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of when the license recommendation was last generated.
- licenseRecommendationOptions
-
- Type: Array of LicenseRecommendationOption structures
An array of objects that describe the license recommendation options.
- lookbackPeriodInDays
-
- Type: double
The number of days for which utilization metrics were analyzed for an instance that runs on a license.
- resourceArn
-
- Type: string
The ARN that identifies the Amazon EC2 instance.
- tags
-
- Type: Array of Tag structures
A list of tags assigned to an EC2 instance.
LicenseRecommendationFilter
Description
Describes a filter that returns a more specific list of license recommendations. Use this filter with the GetLicenseRecommendation
action.
Members
- name
-
- Type: string
The name of the filter.
Specify
Finding
to return recommendations with a specific finding classification.Specify
FindingReasonCode
to return recommendations with a specific finding reason code.You can filter your license recommendations by
tag:key
andtag-key
tags.A
tag:key
is a key and value combination of a tag assigned to your license recommendations. Use the tag key in the filter name and the tag value as the filter value. For example, to find all license recommendations that have a tag with the key ofOwner
and the value ofTeamA
, specifytag:Owner
for the filter name andTeamA
for the filter value.A
tag-key
is the key of a tag assigned to your license recommendations. Use this filter to find all of your license recommendations that have a tag with a specific key. This doesn’t consider the tag value. For example, you can find your license recommendations with a tag key value ofOwner
or without any tag keys assigned. - values
-
- Type: Array of strings
The value of the filter.
The valid values for this parameter are as follows, depending on what you specify for the
name
parameter:-
If you specify the
name
parameter asFinding
, then specifyOptimized
,NotOptimized
, orInsufficentMetrics
. -
If you specify the
name
parameter asFindingReasonCode
, then specifyOptimized
,LicenseOverprovisioned
,InvalidCloudwatchApplicationInsights
, orCloudwatchApplicationInsightsError
.
LicenseRecommendationOption
Description
Describes the recommendation options for licenses.
Members
- licenseEdition
-
- Type: string
The recommended edition of the license for the application that runs on the instance.
- licenseModel
-
- Type: string
The recommended license type associated with the instance.
- operatingSystem
-
- Type: string
The operating system of a license recommendation option.
- rank
-
- Type: int
The rank of the license recommendation option.
The top recommendation option is ranked as
1
. - savingsOpportunity
-
- Type: SavingsOpportunity structure
Describes the savings opportunity for recommendations of a given resource type or for the recommendation option of an individual resource.
Savings opportunity represents the estimated monthly savings you can achieve by implementing a given Compute Optimizer recommendation.
Savings opportunity data requires that you opt in to Cost Explorer, as well as activate Receive Amazon EC2 resource recommendations in the Cost Explorer preferences page. That creates a connection between Cost Explorer and Compute Optimizer. With this connection, Cost Explorer generates savings estimates considering the price of existing resources, the price of recommended resources, and historical usage data. Estimated monthly savings reflects the projected dollar savings associated with each of the recommendations generated. For more information, see Enabling Cost Explorer and Optimizing your cost with Rightsizing Recommendations in the Cost Management User Guide.
LimitExceededException
Description
The request exceeds a limit of the service.
Members
- message
-
- Type: string
MemorySizeConfiguration
Description
The memory size configurations of a container.
Members
- memory
-
- Type: int
The amount of memory in the container.
- memoryReservation
-
- Type: int
The limit of memory reserve for the container.
MetricSource
Description
The list of metric sources required to generate recommendations for commercial software licenses.
Members
- provider
-
- Type: string
The name of the metric source provider.
- providerArn
-
- Type: string
The ARN of the metric source provider.
MissingAuthenticationToken
Description
The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.
Members
- message
-
- Type: string
OptInRequiredException
Description
The account is not opted in to Compute Optimizer.
Members
- message
-
- Type: string
PreferredResource
Description
The preference to control which resource type values are considered when generating rightsizing recommendations. You can specify this preference as a combination of include and exclude lists. You must specify either an includeList
or excludeList
. If the preference is an empty set of resource type values, an error occurs. For more information, see Rightsizing recommendation preferences in the Compute Optimizer User Guide.
-
This preference is only available for the Amazon EC2 instance and Auto Scaling group resource types.
-
Compute Optimizer only supports the customization of
Ec2InstanceTypes
.
Members
- excludeList
-
- Type: Array of strings
The preferred resource type values to exclude from the recommendation candidates. If this isn’t specified, all supported resources are included by default. You can specify up to 1000 values in this list.
- includeList
-
- Type: Array of strings
The preferred resource type values to include in the recommendation candidates. You can specify the exact resource type value, such as m5.large, or use wild card expressions, such as m5. If this isn’t specified, all supported resources are included by default. You can specify up to 1000 values in this list.
- name
-
- Type: string
The type of preferred resource to customize.
Compute Optimizer only supports the customization of
Ec2InstanceTypes
.
ProjectedMetric
Description
Describes a projected utilization metric of a recommendation option, such as an Amazon EC2 instance. This represents the projected utilization of a recommendation option had you used that resource during the analyzed period.
Compare the utilization metric data of your resource against its projected utilization metric data to determine the performance difference between your current resource and the recommended option.
The Cpu
, Memory
, GPU
, and GPU_MEMORY
metrics are the only projected utilization metrics returned when you run the GetEC2RecommendationProjectedMetrics action. Additionally, these metrics are only returned for resources with the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent and Enabling NVIDIA GPU utilization with the CloudWatch Agent.
Members
- name
-
- Type: string
The name of the projected utilization metric.
The following projected utilization metrics are returned:
-
Cpu
- The projected percentage of allocated EC2 compute units that would be in use on the recommendation option had you used that resource during the analyzed period. This metric identifies the processing power required to run an application on the recommendation option.Depending on the instance type, tools in your operating system can show a lower percentage than CloudWatch when the instance is not allocated a full processor core.
-
Memory
- The percentage of memory that would be in use on the recommendation option had you used that resource during the analyzed period. This metric identifies the amount of memory required to run an application on the recommendation option.Units: Percent
The
Memory
metric is only returned for resources with the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent. -
GPU
- The projected percentage of allocated GPUs if you adjust your configurations to Compute Optimizer's recommendation option. -
GPU_MEMORY
- The projected percentage of total GPU memory if you adjust your configurations to Compute Optimizer's recommendation option.The
GPU
andGPU_MEMORY
metrics are only returned for resources with the unified CloudWatch Agent installed on them. For more information, see Enabling NVIDIA GPU utilization with the CloudWatch Agent.
- timestamps
-
- Type: Array of timestamp (string|DateTime or anything parsable by strtotime)s
The timestamps of the projected utilization metric.
- values
-
- Type: Array of doubles
The values of the projected utilization metrics.
RDSDBInstanceRecommendationOption
Description
Describes the recommendation options for an Amazon RDS instance.
Members
- dbInstanceClass
-
- Type: string
Describes the DB instance class recommendation option for your Amazon RDS instance.
- performanceRisk
-
- Type: double
The performance risk of the RDS instance recommendation option.
- projectedUtilizationMetrics
-
- Type: Array of RDSDBUtilizationMetric structures
An array of objects that describe the projected utilization metrics of the RDS instance recommendation option.
- rank
-
- Type: int
The rank identifier of the RDS instance recommendation option.
- savingsOpportunity
-
- Type: SavingsOpportunity structure
Describes the savings opportunity for recommendations of a given resource type or for the recommendation option of an individual resource.
Savings opportunity represents the estimated monthly savings you can achieve by implementing a given Compute Optimizer recommendation.
Savings opportunity data requires that you opt in to Cost Explorer, as well as activate Receive Amazon EC2 resource recommendations in the Cost Explorer preferences page. That creates a connection between Cost Explorer and Compute Optimizer. With this connection, Cost Explorer generates savings estimates considering the price of existing resources, the price of recommended resources, and historical usage data. Estimated monthly savings reflects the projected dollar savings associated with each of the recommendations generated. For more information, see Enabling Cost Explorer and Optimizing your cost with Rightsizing Recommendations in the Cost Management User Guide.
- savingsOpportunityAfterDiscounts
-
- Type: RDSInstanceSavingsOpportunityAfterDiscounts structure
Describes the savings opportunity for Amazon RDS recommendations or for the recommendation option.
Savings opportunity represents the estimated monthly savings after applying Savings Plans discounts. You can achieve this by implementing a given Compute Optimizer recommendation.
RDSDBRecommendation
Description
Describes an Amazon RDS recommendation.
Members
- accountId
-
- Type: string
The Amazon Web Services account ID of the Amazon RDS.
- currentDBInstanceClass
-
- Type: string
The DB instance class of the current RDS instance.
- currentStorageConfiguration
-
- Type: DBStorageConfiguration structure
The configuration of the current RDS storage.
- effectiveRecommendationPreferences
-
- Type: RDSEffectiveRecommendationPreferences structure
Describes the effective recommendation preferences for Amazon RDS.
- engine
-
- Type: string
The engine of the RDS instance.
- engineVersion
-
- Type: string
The database engine version.
- idle
-
- Type: string
This indicates if the RDS instance is idle or not.
- instanceFinding
-
- Type: string
The finding classification of an Amazon RDS instance.
Findings for Amazon RDS instance include:
-
Underprovisioned
— When Compute Optimizer detects that there’s not enough resource specifications, an Amazon RDS is considered under-provisioned. -
Overprovisioned
— When Compute Optimizer detects that there’s excessive resource specifications, an Amazon RDS is considered over-provisioned. -
Optimized
— When the specifications of your Amazon RDS instance meet the performance requirements of your workload, the service is considered optimized.
- instanceFindingReasonCodes
-
- Type: Array of strings
The reason for the finding classification of an Amazon RDS instance.
- instanceRecommendationOptions
-
- Type: Array of RDSDBInstanceRecommendationOption structures
An array of objects that describe the recommendation options for the Amazon RDS instance.
- lastRefreshTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of when the Amazon RDS recommendation was last generated.
- lookbackPeriodInDays
-
- Type: double
The number of days the Amazon RDS utilization metrics were analyzed.
- resourceArn
-
- Type: string
The ARN of the current Amazon RDS.
The following is the format of the ARN:
arn:aws:rds:{region}:{accountId}:db:{resourceName}
- storageFinding
-
- Type: string
The finding classification of Amazon RDS storage.
Findings for Amazon RDS instance include:
-
Underprovisioned
— When Compute Optimizer detects that there’s not enough storage, an Amazon RDS is considered under-provisioned. -
Overprovisioned
— When Compute Optimizer detects that there’s excessive storage, an Amazon RDS is considered over-provisioned. -
Optimized
— When the storage of your Amazon RDS meet the performance requirements of your workload, the service is considered optimized.
- storageFindingReasonCodes
-
- Type: Array of strings
The reason for the finding classification of Amazon RDS storage.
- storageRecommendationOptions
-
- Type: Array of RDSDBStorageRecommendationOption structures
An array of objects that describe the recommendation options for Amazon RDS storage.
- tags
-
- Type: Array of Tag structures
A list of tags assigned to your Amazon RDS recommendations.
- utilizationMetrics
-
- Type: Array of RDSDBUtilizationMetric structures
An array of objects that describe the utilization metrics of the Amazon RDS.
RDSDBRecommendationFilter
Description
Describes a filter that returns a more specific list of Amazon RDS recommendations. Use this filter with the GetECSServiceRecommendations action.
Members
- name
-
- Type: string
The name of the filter.
Specify
Finding
to return recommendations with a specific finding classification.You can filter your Amazon RDS recommendations by
tag:key
andtag-key
tags.A
tag:key
is a key and value combination of a tag assigned to your Amazon RDS recommendations. Use the tag key in the filter name and the tag value as the filter value. For example, to find all Amazon RDS service recommendations that have a tag with the key ofOwner
and the value ofTeamA
, specifytag:Owner
for the filter name andTeamA
for the filter value.A
tag-key
is the key of a tag assigned to your Amazon RDS recommendations. Use this filter to find all of your Amazon RDS recommendations that have a tag with a specific key. This doesn’t consider the tag value. For example, you can find your Amazon RDS service recommendations with a tag key value ofOwner
or without any tag keys assigned. - values
-
- Type: Array of strings
The value of the filter.
RDSDBStorageRecommendationOption
Description
Describes the recommendation options for Amazon RDS storage.
Members
- rank
-
- Type: int
The rank identifier of the RDS storage recommendation option.
- savingsOpportunity
-
- Type: SavingsOpportunity structure
Describes the savings opportunity for recommendations of a given resource type or for the recommendation option of an individual resource.
Savings opportunity represents the estimated monthly savings you can achieve by implementing a given Compute Optimizer recommendation.
Savings opportunity data requires that you opt in to Cost Explorer, as well as activate Receive Amazon EC2 resource recommendations in the Cost Explorer preferences page. That creates a connection between Cost Explorer and Compute Optimizer. With this connection, Cost Explorer generates savings estimates considering the price of existing resources, the price of recommended resources, and historical usage data. Estimated monthly savings reflects the projected dollar savings associated with each of the recommendations generated. For more information, see Enabling Cost Explorer and Optimizing your cost with Rightsizing Recommendations in the Cost Management User Guide.
- savingsOpportunityAfterDiscounts
-
- Type: RDSStorageSavingsOpportunityAfterDiscounts structure
Describes the savings opportunity for Amazon RDS storage recommendations or for the recommendation option.
Savings opportunity represents the estimated monthly savings after applying Savings Plans discounts. You can achieve this by implementing a given Compute Optimizer recommendation.
- storageConfiguration
-
- Type: DBStorageConfiguration structure
The recommended storage configuration.
RDSDBUtilizationMetric
Description
Describes the utilization metric of an Amazon RDS.
To determine the performance difference between your current Amazon RDS and the recommended option, compare the utilization metric data of your service against its projected utilization metric data.
Members
- name
-
- Type: string
The name of the utilization metric.
- statistic
-
- Type: string
The statistic of the utilization metric.
The Compute Optimizer API, Command Line Interface (CLI), and SDKs return utilization metrics using only the
Maximum
statistic, which is the highest value observed during the specified period.The Compute Optimizer console displays graphs for some utilization metrics using the
Average
statistic, which is the value ofSum
/SampleCount
during the specified period. For more information, see Viewing resource recommendations in the Compute Optimizer User Guide. You can also get averaged utilization metric data for your resources using Amazon CloudWatch. For more information, see the Amazon CloudWatch User Guide. - value
-
- Type: double
The value of the utilization metric.
RDSDatabaseProjectedMetric
Description
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.
Members
- name
-
- Type: string
The name of the projected metric.
- timestamps
-
- Type: Array of timestamp (string|DateTime or anything parsable by strtotime)s
The timestamps of the projected metric.
- values
-
- Type: Array of doubles
The values for the projected metric.
RDSDatabaseRecommendedOptionProjectedMetric
Description
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.
Members
- projectedMetrics
-
- Type: Array of RDSDatabaseProjectedMetric structures
An array of objects that describe the projected metric.
- rank
-
- Type: int
The rank identifier of the RDS instance recommendation option.
- recommendedDBInstanceClass
-
- Type: string
The recommended DB instance class for the Amazon RDS.
RDSEffectiveRecommendationPreferences
Description
Describes the effective recommendation preferences for Amazon RDS.
Members
- cpuVendorArchitectures
-
- Type: Array of strings
Describes the CPU vendor and architecture for Amazon RDS recommendations.
- enhancedInfrastructureMetrics
-
- Type: string
Describes the activation status of the enhanced infrastructure metrics preference.
A status of
Active
confirms that the preference is applied in the latest recommendation refresh, and a status ofInactive
confirms that it's not yet applied to recommendations.For more information, see Enhanced infrastructure metrics in the Compute Optimizer User Guide.
- lookBackPeriod
-
- Type: string
The number of days the utilization metrics of the Amazon RDS are analyzed.
- savingsEstimationMode
-
- Type: RDSSavingsEstimationMode structure
Describes the savings estimation mode preference applied for calculating savings opportunity for Amazon RDS.
RDSInstanceEstimatedMonthlySavings
Description
Describes the estimated monthly savings possible for Amazon RDS instances by adopting Compute Optimizer recommendations. This is based on Amazon RDS pricing after applying Savings Plans discounts.
Members
- currency
-
- Type: string
The currency of the estimated monthly savings.
- value
-
- Type: double
The value of the estimated monthly savings for Amazon RDS instances.
RDSInstanceSavingsOpportunityAfterDiscounts
Description
Describes the savings opportunity for Amazon RDS instance recommendations after applying Savings Plans discounts.
Savings opportunity represents the estimated monthly savings after applying Savings Plans discounts. You can achieve this by implementing a given Compute Optimizer recommendation.
Members
- estimatedMonthlySavings
-
- Type: RDSInstanceEstimatedMonthlySavings structure
The estimated monthly savings possible by adopting Compute Optimizer’s Amazon RDS instance recommendations. This includes any applicable Savings Plans discounts.
- savingsOpportunityPercentage
-
- Type: double
The estimated monthly savings possible as a percentage of monthly cost by adopting Compute Optimizer’s Amazon RDS instance recommendations. This includes any applicable Savings Plans discounts.
RDSSavingsEstimationMode
Description
Describes the savings estimation mode used for calculating savings opportunity for Amazon RDS.
Members
- source
-
- Type: string
Describes the source for calculating the savings opportunity for Amazon RDS.
RDSStorageEstimatedMonthlySavings
Description
Describes the estimated monthly savings possible for Amazon RDS storage by adopting Compute Optimizer recommendations. This is based on Amazon RDS pricing after applying Savings Plans discounts.
Members
- currency
-
- Type: string
The currency of the estimated monthly savings.
- value
-
- Type: double
The value of the estimated monthly savings for Amazon RDS storage.
RDSStorageSavingsOpportunityAfterDiscounts
Description
Describes the savings opportunity for Amazon RDS storage recommendations after applying Savings Plans discounts.
Savings opportunity represents the estimated monthly savings after applying Savings Plans discounts. You can achieve this by implementing a given Compute Optimizer recommendation.
Members
- estimatedMonthlySavings
-
- Type: RDSStorageEstimatedMonthlySavings structure
The estimated monthly savings possible by adopting Compute Optimizer’s Amazon RDS storage recommendations. This includes any applicable Savings Plans discounts.
- savingsOpportunityPercentage
-
- Type: double
The estimated monthly savings possible as a percentage of monthly cost by adopting Compute Optimizer’s Amazon RDS storage recommendations. This includes any applicable Savings Plans discounts.
ReasonCodeSummary
Description
A summary of a finding reason code.
Members
- name
-
- Type: string
The name of the finding reason code.
- value
-
- Type: double
The value of the finding reason code summary.
RecommendationExportJob
Description
Describes a recommendation export job.
Use the DescribeRecommendationExportJobs action to view your recommendation export jobs.
Use the ExportAutoScalingGroupRecommendations or ExportEC2InstanceRecommendations actions to request an export of your recommendations.
Members
- creationTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of when the export job was created.
- destination
-
- Type: ExportDestination structure
An object that describes the destination of the export file.
- failureReason
-
- Type: string
The reason for an export job failure.
- jobId
-
- Type: string
The identification number of the export job.
- lastUpdatedTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of when the export job was last updated.
- resourceType
-
- Type: string
The resource type of the exported recommendations.
- status
-
- Type: string
The status of the export job.
RecommendationPreferences
Description
Describes the recommendation preferences to return in the response of a GetAutoScalingGroupRecommendations, GetEC2InstanceRecommendations, GetEC2RecommendationProjectedMetrics, GetRDSDatabaseRecommendations, and GetRDSDatabaseRecommendationProjectedMetrics request.
Members
- cpuVendorArchitectures
-
- Type: Array of strings
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.
RecommendationPreferencesDetail
Description
Describes a recommendation preference.
Members
- enhancedInfrastructureMetrics
-
- Type: string
The status of the enhanced infrastructure metrics recommendation preference.
When the recommendations page is refreshed, a status of
Active
confirms that the preference is applied to the recommendations, and a status ofInactive
confirms that the preference isn't yet applied to recommendations.For more information, see Enhanced infrastructure metrics in the Compute Optimizer User Guide.
- externalMetricsPreference
-
- Type: ExternalMetricsPreference structure
An object that describes the external metrics recommendation preference.
If the preference is applied in the latest recommendation refresh, an object with a valid
source
value appears in the response. If the preference isn't applied to the recommendations already, then this object doesn't appear in the response. - inferredWorkloadTypes
-
- Type: string
The status of the inferred workload types recommendation preference.
When the recommendations page is refreshed, a status of
Active
confirms that the preference is applied to the recommendations, and a status ofInactive
confirms that the preference isn't yet applied to recommendations. - lookBackPeriod
-
- Type: string
The preference to control the number of days the utilization metrics of the Amazon Web Services resource are analyzed. If the preference isn’t set, this object is null.
- preferredResources
-
- Type: Array of EffectivePreferredResource structures
The preference to control which resource type values are considered when generating rightsizing recommendations. This object resolves any wildcard expressions and returns the effective list of candidate resource type values. If the preference isn’t set, this object is null.
- resourceType
-
- Type: string
The target resource type of the recommendation preference to create.
The
Ec2Instance
option encompasses standalone instances and instances that are part of Auto Scaling groups. TheAutoScalingGroup
option encompasses only instances that are part of an Auto Scaling group. - savingsEstimationMode
-
- Type: string
Describes the savings estimation mode used for calculating savings opportunity.
Only the account manager or delegated administrator of your organization can activate this preference.
- scope
-
- Type: Scope structure
An object that describes the scope of the recommendation preference.
Recommendation preferences can be created at the organization level (for management accounts of an organization only), account level, and resource level. For more information, see Activating enhanced infrastructure metrics in the Compute Optimizer User Guide.
- utilizationPreferences
-
- Type: Array of UtilizationPreference structures
The preference to control the resource’s CPU utilization threshold, CPU utilization headroom, and memory utilization headroom. If the preference isn’t set, this object is null.
This preference is only available for the Amazon EC2 instance resource type.
RecommendationSource
Description
Describes the source of a recommendation, such as an Amazon EC2 instance or Auto Scaling group.
Members
- recommendationSourceArn
-
- Type: string
The Amazon Resource Name (ARN) of the recommendation source.
- recommendationSourceType
-
- Type: string
The resource type of the recommendation source.
RecommendationSummary
Description
A summary of a recommendation.
Members
- accountId
-
- Type: string
The Amazon Web Services account ID of the recommendation summary.
- currentPerformanceRiskRatings
-
- Type: CurrentPerformanceRiskRatings structure
An object that describes the performance risk ratings for a given resource type.
- inferredWorkloadSavings
-
- Type: Array of InferredWorkloadSaving structures
An array of objects that describes the estimated monthly saving amounts for the instances running on the specified
inferredWorkloadTypes
. The array contains the top five savings opportunites for the instances that run inferred workload types. - recommendationResourceType
-
- Type: string
The resource type that the recommendation summary applies to.
- savingsOpportunity
-
- Type: SavingsOpportunity structure
An object that describes the savings opportunity for a given resource type. Savings opportunity includes the estimated monthly savings amount and percentage.
- summaries
-
- Type: Array of Summary structures
An array of objects that describe a recommendation summary.
RecommendedOptionProjectedMetric
Description
Describes a projected utilization metric of a recommendation option.
The Cpu
and Memory
metrics are the only projected utilization metrics returned when you run the GetEC2RecommendationProjectedMetrics action. Additionally, the Memory
metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent.
Members
- projectedMetrics
-
- Type: Array of ProjectedMetric structures
An array of objects that describe a projected utilization metric.
- rank
-
- Type: int
The rank of the recommendation option projected metric.
The top recommendation option is ranked as
1
.The projected metric rank correlates to the recommendation option rank. For example, the projected metric ranked as
1
is related to the recommendation option that is also ranked as1
in the same response. - recommendedInstanceType
-
- Type: string
The recommended instance type.
ResourceNotFoundException
Description
A resource that is required for the action doesn't exist.
Members
- message
-
- Type: string
S3Destination
Description
Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and object keys of a recommendations export file, and its associated metadata file.
Members
- bucket
-
- Type: string
The name of the Amazon S3 bucket used as the destination of an export file.
- key
-
- Type: string
The Amazon S3 bucket key of an export file.
The key uniquely identifies the object, or export file, in the S3 bucket.
- metadataKey
-
- Type: string
The Amazon S3 bucket key of a metadata file.
The key uniquely identifies the object, or metadata file, in the S3 bucket.
S3DestinationConfig
Description
Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for a recommendations export job.
You must create the destination Amazon S3 bucket for your recommendations export before you create the export job. Compute Optimizer does not create the S3 bucket for you. After you create the S3 bucket, ensure that it has the required permission policy to allow Compute Optimizer to write the export file to it. If you plan to specify an object prefix when you create the export job, you must include the object prefix in the policy that you add to the S3 bucket. For more information, see Amazon S3 Bucket Policy for Compute Optimizer in the Compute Optimizer User Guide.
Members
- bucket
-
- Type: string
The name of the Amazon S3 bucket to use as the destination for an export job.
- keyPrefix
-
- Type: string
The Amazon S3 bucket prefix for an export job.
SavingsOpportunity
Description
Describes the savings opportunity for recommendations of a given resource type or for the recommendation option of an individual resource.
Savings opportunity represents the estimated monthly savings you can achieve by implementing a given Compute Optimizer recommendation.
Savings opportunity data requires that you opt in to Cost Explorer, as well as activate Receive Amazon EC2 resource recommendations in the Cost Explorer preferences page. That creates a connection between Cost Explorer and Compute Optimizer. With this connection, Cost Explorer generates savings estimates considering the price of existing resources, the price of recommended resources, and historical usage data. Estimated monthly savings reflects the projected dollar savings associated with each of the recommendations generated. For more information, see Enabling Cost Explorer and Optimizing your cost with Rightsizing Recommendations in the Cost Management User Guide.
Members
- estimatedMonthlySavings
-
- Type: EstimatedMonthlySavings structure
An object that describes the estimated monthly savings amount possible by adopting Compute Optimizer recommendations for a given resource. This is based on the On-Demand instance pricing..
- savingsOpportunityPercentage
-
- Type: double
The estimated monthly savings possible as a percentage of monthly cost by adopting Compute Optimizer recommendations for a given resource.
Scope
Description
Describes the scope of a recommendation preference.
Recommendation preferences can be created at the organization level (for management accounts of an organization only), account level, and resource level. For more information, see Activating enhanced infrastructure metrics in the Compute Optimizer User Guide.
You cannot create recommendation preferences for Auto Scaling groups at the organization and account levels. You can create recommendation preferences for Auto Scaling groups only at the resource level by specifying a scope name of ResourceArn
and a scope value of the Auto Scaling group Amazon Resource Name (ARN). This will configure the preference for all instances that are part of the specified Auto Scaling group. You also cannot create recommendation preferences at the resource level for instances that are part of an Auto Scaling group. You can create recommendation preferences at the resource level only for standalone instances.
Members
- name
-
- Type: string
The name of the scope.
The following scopes are possible:
-
Organization
- Specifies that the recommendation preference applies at the organization level, for all member accounts of an organization. -
AccountId
- Specifies that the recommendation preference applies at the account level, for all resources of a given resource type in an account. -
ResourceArn
- Specifies that the recommendation preference applies at the individual resource level.
- value
-
- Type: string
The value of the scope.
If you specified the
name
of the scope as:-
Organization
- Thevalue
must beALL_ACCOUNTS
. -
AccountId
- Thevalue
must be a 12-digit Amazon Web Services account ID. -
ResourceArn
- Thevalue
must be the Amazon Resource Name (ARN) of an EC2 instance or an Auto Scaling group.
Only EC2 instance and Auto Scaling group ARNs are currently supported.
ServiceConfiguration
Description
The Amazon ECS service configurations used for recommendations.
Members
- autoScalingConfiguration
-
- Type: string
Describes the Auto Scaling configuration methods for an Amazon ECS service. This affects the generated recommendations. For example, if Auto Scaling is configured on a service’s CPU, then Compute Optimizer doesn’t generate CPU size recommendations.
The Auto Scaling configuration methods include:
-
TARGET_TRACKING_SCALING_CPU
— If the Amazon ECS service is configured to use target scaling on CPU, Compute Optimizer doesn't generate CPU recommendations. -
TARGET_TRACKING_SCALING_MEMORY
— If the Amazon ECS service is configured to use target scaling on memory, Compute Optimizer doesn't generate memory recommendations.
For more information about step scaling and target scaling, see Step scaling policies for Application Auto Scaling and Target tracking scaling policies for Application Auto Scaling in the Application Auto Scaling User Guide.
- containerConfigurations
-
- Type: Array of ContainerConfiguration structures
The container configurations within a task of an Amazon ECS service.
- cpu
-
- Type: int
The number of CPU units used by the tasks in the Amazon ECS service.
- memory
-
- Type: int
The amount of memory used by the tasks in the Amazon ECS service.
- taskDefinitionArn
-
- Type: string
The task definition ARN used by the tasks in the Amazon ECS service.
ServiceUnavailableException
Description
The request has failed due to a temporary failure of the server.
Members
- message
-
- Type: string
Summary
Description
The summary of a recommendation.
Members
- name
-
- Type: string
The finding classification of the recommendation.
- reasonCodeSummaries
-
- Type: Array of ReasonCodeSummary structures
An array of objects that summarize a finding reason code.
- value
-
- Type: double
The value of the recommendation summary.
Tag
Description
A list of tag key and value pairs that you define.
Members
- key
-
- Type: string
One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.
- value
-
- Type: string
One part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key). The value can be empty or null.
ThrottlingException
Description
The request was denied due to request throttling.
Members
- message
-
- Required: Yes
- Type: string
UtilizationMetric
Description
Describes a utilization metric of a resource, such as an Amazon EC2 instance.
Compare the utilization metric data of your resource against its projected utilization metric data to determine the performance difference between your current resource and the recommended option.
Members
- name
-
- Type: string
The name of the utilization metric.
The following utilization metrics are available:
-
Cpu
- The percentage of allocated EC2 compute units that are currently in use on the instance. This metric identifies the processing power required to run an application on the instance.Depending on the instance type, tools in your operating system can show a lower percentage than CloudWatch when the instance is not allocated a full processor core.
Units: Percent
-
Memory
- The percentage of memory that is currently in use on the instance. This metric identifies the amount of memory required to run an application on the instance.Units: Percent
The
Memory
metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent. -
GPU
- The percentage of allocated GPUs that currently run on the instance. -
GPU_MEMORY
- The percentage of total GPU memory that currently runs on the instance.The
GPU
andGPU_MEMORY
metrics are only returned for resources with the unified CloudWatch Agent installed on them. For more information, see Enabling NVIDIA GPU utilization with the CloudWatch Agent. -
EBS_READ_OPS_PER_SECOND
- The completed read operations from all EBS volumes attached to the instance in a specified period of time.Unit: Count
-
EBS_WRITE_OPS_PER_SECOND
- The completed write operations to all EBS volumes attached to the instance in a specified period of time.Unit: Count
-
EBS_READ_BYTES_PER_SECOND
- The bytes read from all EBS volumes attached to the instance in a specified period of time.Unit: Bytes
-
EBS_WRITE_BYTES_PER_SECOND
- The bytes written to all EBS volumes attached to the instance in a specified period of time.Unit: Bytes
-
DISK_READ_OPS_PER_SECOND
- The completed read operations from all instance store volumes available to the instance in a specified period of time.If there are no instance store volumes, either the value is
0
or the metric is not reported. -
DISK_WRITE_OPS_PER_SECOND
- The completed write operations from all instance store volumes available to the instance in a specified period of time.If there are no instance store volumes, either the value is
0
or the metric is not reported. -
DISK_READ_BYTES_PER_SECOND
- The bytes read from all instance store volumes available to the instance. This metric is used to determine the volume of the data the application reads from the disk of the instance. This can be used to determine the speed of the application.If there are no instance store volumes, either the value is
0
or the metric is not reported. -
DISK_WRITE_BYTES_PER_SECOND
- The bytes written to all instance store volumes available to the instance. This metric is used to determine the volume of the data the application writes onto the disk of the instance. This can be used to determine the speed of the application.If there are no instance store volumes, either the value is
0
or the metric is not reported. -
NETWORK_IN_BYTES_PER_SECOND
- The number of bytes received by the instance on all network interfaces. This metric identifies the volume of incoming network traffic to a single instance. -
NETWORK_OUT_BYTES_PER_SECOND
- The number of bytes sent out by the instance on all network interfaces. This metric identifies the volume of outgoing network traffic from a single instance. -
NETWORK_PACKETS_IN_PER_SECOND
- The number of packets received by the instance on all network interfaces. This metric identifies the volume of incoming traffic in terms of the number of packets on a single instance. -
NETWORK_PACKETS_OUT_PER_SECOND
- The number of packets sent out by the instance on all network interfaces. This metric identifies the volume of outgoing traffic in terms of the number of packets on a single instance.
- statistic
-
- Type: string
The statistic of the utilization metric.
The Compute Optimizer API, Command Line Interface (CLI), and SDKs return utilization metrics using only the
Maximum
statistic, which is the highest value observed during the specified period.The Compute Optimizer console displays graphs for some utilization metrics using the
Average
statistic, which is the value ofSum
/SampleCount
during the specified period. For more information, see Viewing resource recommendations in the Compute Optimizer User Guide. You can also get averaged utilization metric data for your resources using Amazon CloudWatch. For more information, see the Amazon CloudWatch User Guide. - value
-
- Type: double
The value of the utilization metric.
UtilizationPreference
Description
The preference to control the resource’s CPU utilization threshold, CPU utilization headroom, and memory utilization headroom.
This preference is only available for the Amazon EC2 instance resource type.
Members
- metricName
-
- Type: string
The name of the resource utilization metric name to customize.
- metricParameters
-
- Type: CustomizableMetricParameters structure
The parameters to set when customizing the resource utilization thresholds.
VolumeConfiguration
Description
Describes the configuration of an Amazon Elastic Block Store (Amazon EBS) volume.
Members
- rootVolume
-
- Type: boolean
Contains the image used to boot the instance during launch.
- volumeBaselineIOPS
-
- Type: int
The baseline IOPS of the volume.
- volumeBaselineThroughput
-
- Type: int
The baseline throughput of the volume.
- volumeBurstIOPS
-
- Type: int
The burst IOPS of the volume.
- volumeBurstThroughput
-
- Type: int
The burst throughput of the volume.
- volumeSize
-
- Type: int
The size of the volume, in GiB.
- volumeType
-
- Type: string
The volume type.
This can be
gp2
for General Purpose SSD,io1
orio2
for Provisioned IOPS SSD,st1
for Throughput Optimized HDD,sc1
for Cold HDD, orstandard
for Magnetic volumes.
VolumeRecommendation
Description
Describes an Amazon Elastic Block Store (Amazon EBS) volume recommendation.
Members
- accountId
-
- Type: string
The Amazon Web Services account ID of the volume.
- currentConfiguration
-
- Type: VolumeConfiguration structure
An array of objects that describe the current configuration of the volume.
- currentPerformanceRisk
-
- Type: string
The risk of the current EBS volume not meeting the performance needs of its workloads. The higher the risk, the more likely the current EBS volume doesn't have sufficient capacity.
- effectiveRecommendationPreferences
-
- Type: EBSEffectiveRecommendationPreferences structure
Describes the effective recommendation preferences for Amazon EBS volume.
- finding
-
- Type: string
The finding classification of the volume.
Findings for volumes include:
-
NotOptimized
—A volume is considered not optimized when Compute Optimizer identifies a recommendation that can provide better performance for your workload. -
Optimized
—An volume is considered optimized when Compute Optimizer determines that the volume is correctly provisioned to run your workload based on the chosen volume type. For optimized resources, Compute Optimizer might recommend a new generation volume type.
- lastRefreshTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of when the volume recommendation was last generated.
- lookBackPeriodInDays
-
- Type: double
The number of days for which utilization metrics were analyzed for the volume.
- tags
-
- Type: Array of Tag structures
A list of tags assigned to your Amazon EBS volume recommendations.
- utilizationMetrics
-
- Type: Array of EBSUtilizationMetric structures
An array of objects that describe the utilization metrics of the volume.
- volumeArn
-
- Type: string
The Amazon Resource Name (ARN) of the current volume.
- volumeRecommendationOptions
-
- Type: Array of VolumeRecommendationOption structures
An array of objects that describe the recommendation options for the volume.
VolumeRecommendationOption
Description
Describes a recommendation option for an Amazon Elastic Block Store (Amazon EBS) instance.
Members
- configuration
-
- Type: VolumeConfiguration structure
An array of objects that describe a volume configuration.
- performanceRisk
-
- Type: double
The performance risk of the volume recommendation option.
Performance risk is the likelihood of the recommended volume type meeting the performance requirement of your workload.
The value ranges from
0
-4
, with0
meaning that the recommended resource is predicted to always provide enough hardware capability. The higher the performance risk is, the more likely you should validate whether the recommendation will meet the performance requirements of your workload before migrating your resource. - rank
-
- Type: int
The rank of the volume recommendation option.
The top recommendation option is ranked as
1
. - savingsOpportunity
-
- Type: SavingsOpportunity structure
An object that describes the savings opportunity for the EBS volume recommendation option. Savings opportunity includes the estimated monthly savings amount and percentage.
- savingsOpportunityAfterDiscounts
-
- Type: EBSSavingsOpportunityAfterDiscounts structure
An object that describes the savings opportunity for the Amazon EBS volume recommendation option with specific discounts. Savings opportunity includes the estimated monthly savings and percentage.