Client

computeoptimizer

R Documentation

AWS Compute Optimizer¶

Description¶

Compute Optimizer is a service that analyzes the configuration and utilization metrics of your Amazon Web Services compute resources, such as Amazon EC2 instances, Amazon EC2 Auto Scaling groups, Lambda functions, Amazon EBS volumes, and Amazon ECS services on Fargate. It reports whether your resources are optimal, and generates optimization recommendations to reduce the cost and improve the performance of your workloads. Compute Optimizer also provides recent utilization metric data, in addition to projected utilization metric data for the recommendations, which you can use to evaluate which recommendation provides the best price-performance trade-off. The analysis of your usage patterns can help you decide when to move or resize your running resources, and still meet your performance and capacity requirements. For more information about Compute Optimizer, including the required permissions to use the service, see the Compute Optimizer User Guide.

Usage¶

computeoptimizer(
  config = list(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

Arguments¶

config

Optional configuration of credentials, endpoint, and/or region.

credentials:
- creds:
  - access_key_id: AWS access key ID
  - secret_access_key: AWS secret access key
  - session_token: AWS temporary session token
- profile: The name of a profile to use. If not given, then the default profile is used.
- anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.
sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

creds:
- access_key_id: AWS access key ID
- secret_access_key: AWS secret access key
- session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

Value¶

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax¶

svc <- computeoptimizer(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations¶

delete_recommendation_preferences: Deletes a recommendation preference, such as enhanced infrastructure metrics
describe_recommendation_export_jobs: Describes recommendation export jobs created in the last seven days; Exports optimization recommendations for Auto Scaling groups
export_ebs_volume_recommendations: Exports optimization recommendations for Amazon EBS volumes
export_ec2_instance_recommendations: Exports optimization recommendations for Amazon EC2 instances
export_ecs_service_recommendations: Exports optimization recommendations for Amazon ECS services on Fargate; Exports optimization recommendations for Lambda functions
export_license_recommendations: Export optimization recommendations for your licenses
export_rds_database_recommendations: Export optimization recommendations for your Amazon Relational Database Service (Amazon RDS); Returns Auto Scaling group recommendations
get_ebs_volume_recommendations: Returns Amazon Elastic Block Store (Amazon EBS) volume recommendations
get_ec2_instance_recommendations: Returns Amazon EC2 instance recommendations; Returns the projected utilization metrics of Amazon EC2 instance recommendations; Returns the projected metrics of Amazon ECS service recommendations
get_ecs_service_recommendations: Returns Amazon ECS service recommendations; Returns the recommendation preferences that are in effect for a given resource, such as enhanced infrastructure metrics
get_enrollment_status: Returns the enrollment (opt in) status of an account to the Compute Optimizer service; Returns the Compute Optimizer enrollment (opt-in) status of organization member accounts, if your account is an organization management account
get_lambda_function_recommendations: Returns Lambda function recommendations
get_license_recommendations: Returns license recommendations for Amazon EC2 instances that run on a specific license; Returns the projected metrics of Amazon RDS recommendations
get_rds_database_recommendations: Returns Amazon RDS recommendations
get_recommendation_preferences: Returns existing recommendation preferences, such as enhanced infrastructure metrics
get_recommendation_summaries: Returns the optimization findings for an account
put_recommendation_preferences: Creates a new recommendation preference or updates an existing recommendation preference, such as enhanced infrastructure metrics
update_enrollment_status: Updates the enrollment (opt in and opt out) status of an account to the Compute Optimizer service

Examples¶

## Not run: 
svc <- computeoptimizer()
svc$delete_recommendation_preferences(
  Foo = 123
)

## End(Not run)