Class: Aws::ComputeOptimizer::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::ComputeOptimizer::Client
- Includes:
- Aws::ClientStubs
- Defined in:
- gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/client.rb
Overview
An API client for ComputeOptimizer. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::ComputeOptimizer::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#delete_recommendation_preferences(params = {}) ⇒ Struct
Deletes a recommendation preference, such as enhanced infrastructure metrics.
-
#describe_recommendation_export_jobs(params = {}) ⇒ Types::DescribeRecommendationExportJobsResponse
Describes recommendation export jobs created in the last seven days.
-
#export_auto_scaling_group_recommendations(params = {}) ⇒ Types::ExportAutoScalingGroupRecommendationsResponse
Exports optimization recommendations for Auto Scaling groups.
-
#export_ebs_volume_recommendations(params = {}) ⇒ Types::ExportEBSVolumeRecommendationsResponse
Exports optimization recommendations for Amazon EBS volumes.
-
#export_ec2_instance_recommendations(params = {}) ⇒ Types::ExportEC2InstanceRecommendationsResponse
Exports optimization recommendations for Amazon EC2 instances.
-
#export_ecs_service_recommendations(params = {}) ⇒ Types::ExportECSServiceRecommendationsResponse
Exports optimization recommendations for Amazon ECS services on Fargate.
-
#export_lambda_function_recommendations(params = {}) ⇒ Types::ExportLambdaFunctionRecommendationsResponse
Exports optimization recommendations for Lambda functions.
-
#export_license_recommendations(params = {}) ⇒ Types::ExportLicenseRecommendationsResponse
Export optimization recommendations for your licenses.
-
#export_rds_database_recommendations(params = {}) ⇒ Types::ExportRDSDatabaseRecommendationsResponse
Export optimization recommendations for your Amazon Relational Database Service (Amazon RDS).
-
#get_auto_scaling_group_recommendations(params = {}) ⇒ Types::GetAutoScalingGroupRecommendationsResponse
Returns Auto Scaling group recommendations.
-
#get_ebs_volume_recommendations(params = {}) ⇒ Types::GetEBSVolumeRecommendationsResponse
Returns Amazon Elastic Block Store (Amazon EBS) volume recommendations.
-
#get_ec2_instance_recommendations(params = {}) ⇒ Types::GetEC2InstanceRecommendationsResponse
Returns Amazon EC2 instance recommendations.
-
#get_ec2_recommendation_projected_metrics(params = {}) ⇒ Types::GetEC2RecommendationProjectedMetricsResponse
Returns the projected utilization metrics of Amazon EC2 instance recommendations.
-
#get_ecs_service_recommendation_projected_metrics(params = {}) ⇒ Types::GetECSServiceRecommendationProjectedMetricsResponse
Returns the projected metrics of Amazon ECS service recommendations.
-
#get_ecs_service_recommendations(params = {}) ⇒ Types::GetECSServiceRecommendationsResponse
Returns Amazon ECS service recommendations.
-
#get_effective_recommendation_preferences(params = {}) ⇒ Types::GetEffectiveRecommendationPreferencesResponse
Returns the recommendation preferences that are in effect for a given resource, such as enhanced infrastructure metrics.
-
#get_enrollment_status(params = {}) ⇒ Types::GetEnrollmentStatusResponse
Returns the enrollment (opt in) status of an account to the Compute Optimizer service.
-
#get_enrollment_statuses_for_organization(params = {}) ⇒ Types::GetEnrollmentStatusesForOrganizationResponse
Returns the Compute Optimizer enrollment (opt-in) status of organization member accounts, if your account is an organization management account.
-
#get_lambda_function_recommendations(params = {}) ⇒ Types::GetLambdaFunctionRecommendationsResponse
Returns Lambda function recommendations.
-
#get_license_recommendations(params = {}) ⇒ Types::GetLicenseRecommendationsResponse
Returns license recommendations for Amazon EC2 instances that run on a specific license.
-
#get_rds_database_recommendation_projected_metrics(params = {}) ⇒ Types::GetRDSDatabaseRecommendationProjectedMetricsResponse
Returns the projected metrics of Amazon RDS recommendations.
-
#get_rds_database_recommendations(params = {}) ⇒ Types::GetRDSDatabaseRecommendationsResponse
Returns Amazon RDS recommendations.
-
#get_recommendation_preferences(params = {}) ⇒ Types::GetRecommendationPreferencesResponse
Returns existing recommendation preferences, such as enhanced infrastructure metrics.
-
#get_recommendation_summaries(params = {}) ⇒ Types::GetRecommendationSummariesResponse
Returns the optimization findings for an account.
-
#put_recommendation_preferences(params = {}) ⇒ Struct
Creates a new recommendation preference or updates an existing recommendation preference, such as enhanced infrastructure metrics.
-
#update_enrollment_status(params = {}) ⇒ Types::UpdateEnrollmentStatusResponse
Updates the enrollment (opt in and opt out) status of an account to the Compute Optimizer service.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from Aws::ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
420 421 422 |
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/client.rb', line 420 def initialize(*args) super end |
Instance Method Details
#delete_recommendation_preferences(params = {}) ⇒ Struct
Deletes a recommendation preference, such as enhanced infrastructure metrics.
For more information, see Activating enhanced infrastructure metrics in the Compute Optimizer User Guide.
478 479 480 481 |
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/client.rb', line 478 def delete_recommendation_preferences(params = {}, = {}) req = build_request(:delete_recommendation_preferences, params) req.send_request() end |
#describe_recommendation_export_jobs(params = {}) ⇒ Types::DescribeRecommendationExportJobsResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
552 553 554 555 |
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/client.rb', line 552 def describe_recommendation_export_jobs(params = {}, = {}) req = build_request(:describe_recommendation_export_jobs, params) req.send_request() end |
#export_auto_scaling_group_recommendations(params = {}) ⇒ Types::ExportAutoScalingGroupRecommendationsResponse
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.
690 691 692 693 |
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/client.rb', line 690 def export_auto_scaling_group_recommendations(params = {}, = {}) req = build_request(:export_auto_scaling_group_recommendations, params) req.send_request() end |
#export_ebs_volume_recommendations(params = {}) ⇒ Types::ExportEBSVolumeRecommendationsResponse
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.
821 822 823 824 |
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/client.rb', line 821 def export_ebs_volume_recommendations(params = {}, = {}) req = build_request(:export_ebs_volume_recommendations, params) req.send_request() end |
#export_ec2_instance_recommendations(params = {}) ⇒ Types::ExportEC2InstanceRecommendationsResponse
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.
956 957 958 959 |
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/client.rb', line 956 def export_ec2_instance_recommendations(params = {}, = {}) req = build_request(:export_ec2_instance_recommendations, params) req.send_request() end |
#export_ecs_service_recommendations(params = {}) ⇒ Types::ExportECSServiceRecommendationsResponse
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.
1086 1087 1088 1089 |
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/client.rb', line 1086 def export_ecs_service_recommendations(params = {}, = {}) req = build_request(:export_ecs_service_recommendations, params) req.send_request() end |
#export_lambda_function_recommendations(params = {}) ⇒ Types::ExportLambdaFunctionRecommendationsResponse
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.
1217 1218 1219 1220 |
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/client.rb', line 1217 def export_lambda_function_recommendations(params = {}, = {}) req = build_request(:export_lambda_function_recommendations, params) req.send_request() end |
#export_license_recommendations(params = {}) ⇒ Types::ExportLicenseRecommendationsResponse
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.
1345 1346 1347 1348 |
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/client.rb', line 1345 def export_license_recommendations(params = {}, = {}) req = build_request(:export_license_recommendations, params) req.send_request() end |
#export_rds_database_recommendations(params = {}) ⇒ Types::ExportRDSDatabaseRecommendationsResponse
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.
1485 1486 1487 1488 |
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/client.rb', line 1485 def export_rds_database_recommendations(params = {}, = {}) req = build_request(:export_rds_database_recommendations, params) req.send_request() end |
#get_auto_scaling_group_recommendations(params = {}) ⇒ Types::GetAutoScalingGroupRecommendationsResponse
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.
1631 1632 1633 1634 |
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/client.rb', line 1631 def get_auto_scaling_group_recommendations(params = {}, = {}) req = build_request(:get_auto_scaling_group_recommendations, params) req.send_request() end |
#get_ebs_volume_recommendations(params = {}) ⇒ Types::GetEBSVolumeRecommendationsResponse
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.
1747 1748 1749 1750 |
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/client.rb', line 1747 def get_ebs_volume_recommendations(params = {}, = {}) req = build_request(:get_ebs_volume_recommendations, params) req.send_request() end |
#get_ec2_instance_recommendations(params = {}) ⇒ Types::GetEC2InstanceRecommendationsResponse
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.
1900 1901 1902 1903 |
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/client.rb', line 1900 def get_ec2_instance_recommendations(params = {}, = {}) req = build_request(:get_ec2_instance_recommendations, params) req.send_request() end |
#get_ec2_recommendation_projected_metrics(params = {}) ⇒ Types::GetEC2RecommendationProjectedMetricsResponse
Returns the projected utilization metrics of Amazon EC2 instance recommendations.
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.
1973 1974 1975 1976 |
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/client.rb', line 1973 def get_ec2_recommendation_projected_metrics(params = {}, = {}) req = build_request(:get_ec2_recommendation_projected_metrics, params) req.send_request() end |
#get_ecs_service_recommendation_projected_metrics(params = {}) ⇒ Types::GetECSServiceRecommendationProjectedMetricsResponse
Returns the projected metrics of Amazon ECS service recommendations.
2031 2032 2033 2034 |
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/client.rb', line 2031 def get_ecs_service_recommendation_projected_metrics(params = {}, = {}) req = build_request(:get_ecs_service_recommendation_projected_metrics, params) req.send_request() end |
#get_ecs_service_recommendations(params = {}) ⇒ Types::GetECSServiceRecommendationsResponse
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.
2158 2159 2160 2161 |
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/client.rb', line 2158 def get_ecs_service_recommendations(params = {}, = {}) req = build_request(:get_ecs_service_recommendations, params) req.send_request() end |
#get_effective_recommendation_preferences(params = {}) ⇒ Types::GetEffectiveRecommendationPreferencesResponse
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
.
2213 2214 2215 2216 |
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/client.rb', line 2213 def get_effective_recommendation_preferences(params = {}, = {}) req = build_request(:get_effective_recommendation_preferences, params) req.send_request() end |
#get_enrollment_status(params = {}) ⇒ Types::GetEnrollmentStatusResponse
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.
2247 2248 2249 2250 |
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/client.rb', line 2247 def get_enrollment_status(params = {}, = {}) req = build_request(:get_enrollment_status, params) req.send_request() end |
#get_enrollment_statuses_for_organization(params = {}) ⇒ Types::GetEnrollmentStatusesForOrganizationResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2307 2308 2309 2310 |
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/client.rb', line 2307 def get_enrollment_statuses_for_organization(params = {}, = {}) req = build_request(:get_enrollment_statuses_for_organization, params) req.send_request() end |
#get_lambda_function_recommendations(params = {}) ⇒ Types::GetLambdaFunctionRecommendationsResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2425 2426 2427 2428 |
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/client.rb', line 2425 def get_lambda_function_recommendations(params = {}, = {}) req = build_request(:get_lambda_function_recommendations, params) req.send_request() end |
#get_license_recommendations(params = {}) ⇒ Types::GetLicenseRecommendationsResponse
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.
2534 2535 2536 2537 |
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/client.rb', line 2534 def get_license_recommendations(params = {}, = {}) req = build_request(:get_license_recommendations, params) req.send_request() end |
#get_rds_database_recommendation_projected_metrics(params = {}) ⇒ Types::GetRDSDatabaseRecommendationProjectedMetricsResponse
Returns the projected metrics of Amazon RDS recommendations.
2599 2600 2601 2602 |
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/client.rb', line 2599 def get_rds_database_recommendation_projected_metrics(params = {}, = {}) req = build_request(:get_rds_database_recommendation_projected_metrics, params) req.send_request() end |
#get_rds_database_recommendations(params = {}) ⇒ Types::GetRDSDatabaseRecommendationsResponse
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.
2750 2751 2752 2753 |
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/client.rb', line 2750 def get_rds_database_recommendations(params = {}, = {}) req = build_request(:get_rds_database_recommendations, params) req.send_request() end |
#get_recommendation_preferences(params = {}) ⇒ Types::GetRecommendationPreferencesResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2851 2852 2853 2854 |
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/client.rb', line 2851 def get_recommendation_preferences(params = {}, = {}) req = build_request(:get_recommendation_preferences, params) req.send_request() end |
#get_recommendation_summaries(params = {}) ⇒ Types::GetRecommendationSummariesResponse
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
.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2939 2940 2941 2942 |
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/client.rb', line 2939 def get_recommendation_summaries(params = {}, = {}) req = build_request(:get_recommendation_summaries, params) req.send_request() end |
#put_recommendation_preferences(params = {}) ⇒ Struct
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.
3140 3141 3142 3143 |
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/client.rb', line 3140 def put_recommendation_preferences(params = {}, = {}) req = build_request(:put_recommendation_preferences, params) req.send_request() end |
#update_enrollment_status(params = {}) ⇒ Types::UpdateEnrollmentStatusResponse
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.
3216 3217 3218 3219 |
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/client.rb', line 3216 def update_enrollment_status(params = {}, = {}) req = build_request(:update_enrollment_status, params) req.send_request() end |