ComputeOptimizer

import { ComputeOptimizer } from "https://aws-api.deno.dev/v0.3/services/computeoptimizer.ts?docs=full";

class ComputeOptimizer {

constructor(apiFactory: client.ApiFactory);

async deleteRecommendationPreferences(params: DeleteRecommendationPreferencesRequest, opts?: client.RequestOptions): Promise<void>;

async describeRecommendationExportJobs(params?: DescribeRecommendationExportJobsRequest, opts?: client.RequestOptions): Promise<DescribeRecommendationExportJobsResponse>;

async exportAutoScalingGroupRecommendations(params: ExportAutoScalingGroupRecommendationsRequest, opts?: client.RequestOptions): Promise<ExportAutoScalingGroupRecommendationsResponse>;

async exportEBSVolumeRecommendations(params: ExportEBSVolumeRecommendationsRequest, opts?: client.RequestOptions): Promise<ExportEBSVolumeRecommendationsResponse>;

async exportEC2InstanceRecommendations(params: ExportEC2InstanceRecommendationsRequest, opts?: client.RequestOptions): Promise<ExportEC2InstanceRecommendationsResponse>;

async exportLambdaFunctionRecommendations(params: ExportLambdaFunctionRecommendationsRequest, opts?: client.RequestOptions): Promise<ExportLambdaFunctionRecommendationsResponse>;

async getAutoScalingGroupRecommendations(params?: GetAutoScalingGroupRecommendationsRequest, opts?: client.RequestOptions): Promise<GetAutoScalingGroupRecommendationsResponse>;

async getEBSVolumeRecommendations(params?: GetEBSVolumeRecommendationsRequest, opts?: client.RequestOptions): Promise<GetEBSVolumeRecommendationsResponse>;

async getEC2InstanceRecommendations(params?: GetEC2InstanceRecommendationsRequest, opts?: client.RequestOptions): Promise<GetEC2InstanceRecommendationsResponse>;

async getEC2RecommendationProjectedMetrics(params: GetEC2RecommendationProjectedMetricsRequest, opts?: client.RequestOptions): Promise<GetEC2RecommendationProjectedMetricsResponse>;

async getEffectiveRecommendationPreferences(params: GetEffectiveRecommendationPreferencesRequest, opts?: client.RequestOptions): Promise<GetEffectiveRecommendationPreferencesResponse>;

async getEnrollmentStatus(opts?: client.RequestOptions): Promise<GetEnrollmentStatusResponse>;

async getEnrollmentStatusesForOrganization(params?: GetEnrollmentStatusesForOrganizationRequest, opts?: client.RequestOptions): Promise<GetEnrollmentStatusesForOrganizationResponse>;

async getLambdaFunctionRecommendations(params?: GetLambdaFunctionRecommendationsRequest, opts?: client.RequestOptions): Promise<GetLambdaFunctionRecommendationsResponse>;

async getRecommendationPreferences(params: GetRecommendationPreferencesRequest, opts?: client.RequestOptions): Promise<GetRecommendationPreferencesResponse>;

async getRecommendationSummaries(params?: GetRecommendationSummariesRequest, opts?: client.RequestOptions): Promise<GetRecommendationSummariesResponse>;

async putRecommendationPreferences(params: PutRecommendationPreferencesRequest, opts?: client.RequestOptions): Promise<void>;

async updateEnrollmentStatus(params: UpdateEnrollmentStatusRequest, opts?: client.RequestOptions): Promise<UpdateEnrollmentStatusResponse>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new ComputeOptimizer(apiFactory: client.ApiFactory)

[src]

§Methods

deleteRecommendationPreferences(params: DeleteRecommendationPreferencesRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes a recommendation preference, such as enhanced infrastructure metrics.

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

describeRecommendationExportJobs(params?: DescribeRecommendationExportJobsRequest, opts?: client.RequestOptions): Promise<DescribeRecommendationExportJobsResponse>

[src]

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.

exportAutoScalingGroupRecommendations(params: ExportAutoScalingGroupRecommendationsRequest, opts?: client.RequestOptions): Promise<ExportAutoScalingGroupRecommendationsResponse>

[src]

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.

exportEBSVolumeRecommendations(params: ExportEBSVolumeRecommendationsRequest, opts?: client.RequestOptions): Promise<ExportEBSVolumeRecommendationsResponse>

[src]

Exports optimization recommendations for Amazon EBS volumes.

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

exportEC2InstanceRecommendations(params: ExportEC2InstanceRecommendationsRequest, opts?: client.RequestOptions): Promise<ExportEC2InstanceRecommendationsResponse>

[src]

Exports optimization recommendations for Amazon EC2 instances.

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

exportLambdaFunctionRecommendations(params: ExportLambdaFunctionRecommendationsRequest, opts?: client.RequestOptions): Promise<ExportLambdaFunctionRecommendationsResponse>

[src]

Exports optimization recommendations for Lambda functions.

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

getAutoScalingGroupRecommendations(params?: GetAutoScalingGroupRecommendationsRequest, opts?: client.RequestOptions): Promise<GetAutoScalingGroupRecommendationsResponse>

[src]

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.

getEBSVolumeRecommendations(params?: GetEBSVolumeRecommendationsRequest, opts?: client.RequestOptions): Promise<GetEBSVolumeRecommendationsResponse>

[src]

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.

getEC2InstanceRecommendations(params?: GetEC2InstanceRecommendationsRequest, opts?: client.RequestOptions): Promise<GetEC2InstanceRecommendationsResponse>

[src]

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.

getEC2RecommendationProjectedMetrics(params: GetEC2RecommendationProjectedMetricsRequest, opts?: client.RequestOptions): Promise<GetEC2RecommendationProjectedMetricsResponse>

[src]

Returns the projected utilization metrics of Amazon EC2 instance recommendations.

Note: 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.

getEffectiveRecommendationPreferences(params: GetEffectiveRecommendationPreferencesRequest, opts?: client.RequestOptions): Promise<GetEffectiveRecommendationPreferencesResponse>

[src]

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.

getEnrollmentStatus(opts?: client.RequestOptions): Promise<GetEnrollmentStatusResponse>

[src]

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.

getEnrollmentStatusesForOrganization(params?: GetEnrollmentStatusesForOrganizationRequest, opts?: client.RequestOptions): Promise<GetEnrollmentStatusesForOrganizationResponse>

[src]

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.

getLambdaFunctionRecommendations(params?: GetLambdaFunctionRecommendationsRequest, opts?: client.RequestOptions): Promise<GetLambdaFunctionRecommendationsResponse>

[src]

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.

getRecommendationPreferences(params: GetRecommendationPreferencesRequest, opts?: client.RequestOptions): Promise<GetRecommendationPreferencesResponse>

[src]

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.

getRecommendationSummaries(params?: GetRecommendationSummariesRequest, opts?: client.RequestOptions): Promise<GetRecommendationSummariesResponse>

[src]

Returns the optimization findings for an account.

It returns the number of:

Amazon EC2 instances in an account that are Underprovisioned, Overprovisioned, or Optimized.
Auto Scaling groups in an account that are NotOptimized, or Optimized.
Amazon EBS volumes in an account that are NotOptimized, or Optimized.
Lambda functions in an account that are NotOptimized, or Optimized.

putRecommendationPreferences(params: PutRecommendationPreferencesRequest, opts?: client.RequestOptions): Promise<void>

[src]

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.

updateEnrollmentStatus(params: UpdateEnrollmentStatusRequest, opts?: client.RequestOptions): Promise<UpdateEnrollmentStatusResponse>

[src]

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.

§Static Properties

ApiMetadata: client.ApiMetadata

[src]