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.
-
#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_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.
419 420 421 |
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/client.rb', line 419 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.
482 483 484 485 |
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/client.rb', line 482 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.
556 557 558 559 |
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/client.rb', line 556 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.
694 695 696 697 |
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/client.rb', line 694 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.
825 826 827 828 |
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/client.rb', line 825 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.
960 961 962 963 |
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/client.rb', line 960 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.
1090 1091 1092 1093 |
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/client.rb', line 1090 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.
1221 1222 1223 1224 |
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/client.rb', line 1221 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.
1349 1350 1351 1352 |
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/client.rb', line 1349 def export_license_recommendations(params = {}, = {}) req = build_request(:export_license_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.
1495 1496 1497 1498 |
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/client.rb', line 1495 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.
1611 1612 1613 1614 |
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/client.rb', line 1611 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.
1764 1765 1766 1767 |
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/client.rb', line 1764 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.
1837 1838 1839 1840 |
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/client.rb', line 1837 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.
1895 1896 1897 1898 |
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/client.rb', line 1895 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.
2022 2023 2024 2025 |
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/client.rb', line 2022 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
.
2077 2078 2079 2080 |
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/client.rb', line 2077 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.
2111 2112 2113 2114 |
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/client.rb', line 2111 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.
2171 2172 2173 2174 |
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/client.rb', line 2171 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.
2289 2290 2291 2292 |
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/client.rb', line 2289 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.
2398 2399 2400 2401 |
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/client.rb', line 2398 def get_license_recommendations(params = {}, = {}) req = build_request(:get_license_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.
2504 2505 2506 2507 |
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/client.rb', line 2504 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.
2592 2593 2594 2595 |
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/client.rb', line 2592 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.
2798 2799 2800 2801 |
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/client.rb', line 2798 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.
2874 2875 2876 2877 |
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/client.rb', line 2874 def update_enrollment_status(params = {}, = {}) req = build_request(:update_enrollment_status, params) req.send_request() end |