You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.ComputeOptimizer

Inherits:
AWS.Service show all
Identifier:
computeoptimizer
API Version:
2019-11-01
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service 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, and Amazon EBS volumes. 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.

Sending a Request Using ComputeOptimizer

var computeoptimizer = new AWS.ComputeOptimizer();
computeoptimizer.deleteRecommendationPreferences(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the ComputeOptimizer object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var computeoptimizer = new AWS.ComputeOptimizer({apiVersion: '2019-11-01'});

You can also set the API version globally in AWS.config.apiVersions using the computeoptimizer service identifier:

AWS.config.apiVersions = {
  computeoptimizer: '2019-11-01',
  // other service API versions
};

var computeoptimizer = new AWS.ComputeOptimizer();

Version:

  • 2019-11-01

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.ComputeOptimizer(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a ComputeOptimizer object

var computeoptimizer = new AWS.ComputeOptimizer({apiVersion: '2019-11-01'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.ComputeOptimizer.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.ComputeOptimizer.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.ComputeOptimizer.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

  • useFipsEndpoint (Boolean)

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean)

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

deleteRecommendationPreferences(params = {}, callback) ⇒ AWS.Request

Deletes a recommendation preference, such as enhanced infrastructure metrics.

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

Service Reference:

Examples:

Calling the deleteRecommendationPreferences operation

var params = {
  recommendationPreferenceNames: [ /* required */
    EnhancedInfrastructureMetrics,
    /* more items */
  ],
  resourceType: Ec2Instance | AutoScalingGroup | EbsVolume | LambdaFunction, /* required */
  scope: {
    name: Organization | AccountId | ResourceArn,
    value: 'STRING_VALUE'
  }
};
computeoptimizer.deleteRecommendationPreferences(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceType — (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. The AutoScalingGroup option encompasses only instances that are part of an Auto Scaling group.

      Possible values include:
      • "Ec2Instance"
      • "AutoScalingGroup"
      • "EbsVolume"
      • "LambdaFunction"
    • scope — (map)

      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.

      • name — (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.

        Possible values include:
        • "Organization"
        • "AccountId"
        • "ResourceArn"
      • value — (String)

        The value of the scope.

        If you specified the name of the scope as:

        • Organization - The value must be ALL_ACCOUNTS.

        • AccountId - The value must be a 12-digit Amazon Web Services account ID.

        • ResourceArn - The value 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.

    • recommendationPreferenceNames — (Array<String>)

      The name of the recommendation preference to delete.

      Enhanced infrastructure metrics (EnhancedInfrastructureMetrics) is the only feature that can be activated through preferences. Therefore, it is also the only recommendation preference that can be deleted.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeRecommendationExportJobs(params = {}, callback) ⇒ AWS.Request

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.

Examples:

Calling the describeRecommendationExportJobs operation

var params = {
  filters: [
    {
      name: ResourceType | JobStatus,
      values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  jobIds: [
    'STRING_VALUE',
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
computeoptimizer.describeRecommendationExportJobs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • jobIds — (Array<String>)

      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.

    • filters — (Array<map>)

      An array of objects to specify a filter that returns a more specific list of export jobs.

      • name — (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).

        Possible values include:
        • "ResourceType"
        • "JobStatus"
      • values — (Array<String>)

        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 or AutoScalingGroup if you specify the name parameter as ResourceType. There is no filter for EBS volumes because volume recommendations cannot be exported at this time.

        • Specify Queued, InProgress, Complete, or Failed if you specify the name parameter as JobStatus.

    • nextToken — (String)

      The token to advance to the next page of export jobs.

    • maxResults — (Integer)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • recommendationExportJobs — (Array<map>)

        An array of objects that describe recommendation export jobs.

        • jobId — (String)

          The identification number of the export job.

        • destination — (map)

          An object that describes the destination of the export file.

          • s3 — (map)

            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.

            • bucket — (String)

              The name of the Amazon S3 bucket used as the destination of an export file.

            • key — (String)

              The Amazon S3 bucket key of an export file.

              The key uniquely identifies the object, or export file, in the S3 bucket.

            • metadataKey — (String)

              The Amazon S3 bucket key of a metadata file.

              The key uniquely identifies the object, or metadata file, in the S3 bucket.

        • resourceType — (String)

          The resource type of the exported recommendations.

          Possible values include:
          • "Ec2Instance"
          • "AutoScalingGroup"
          • "EbsVolume"
          • "LambdaFunction"
        • status — (String)

          The status of the export job.

          Possible values include:
          • "Queued"
          • "InProgress"
          • "Complete"
          • "Failed"
        • creationTimestamp — (Date)

          The timestamp of when the export job was created.

        • lastUpdatedTimestamp — (Date)

          The timestamp of when the export job was last updated.

        • failureReason — (String)

          The reason for an export job failure.

      • nextToken — (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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

exportAutoScalingGroupRecommendations(params = {}, callback) ⇒ AWS.Request

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.

Examples:

Calling the exportAutoScalingGroupRecommendations operation

var params = {
  s3DestinationConfig: { /* required */
    bucket: 'STRING_VALUE',
    keyPrefix: 'STRING_VALUE'
  },
  accountIds: [
    'STRING_VALUE',
    /* more items */
  ],
  fieldsToExport: [
    AccountId | AutoScalingGroupArn | AutoScalingGroupName | Finding | UtilizationMetricsCpuMaximum | UtilizationMetricsMemoryMaximum | UtilizationMetricsEbsReadOpsPerSecondMaximum | UtilizationMetricsEbsWriteOpsPerSecondMaximum | UtilizationMetricsEbsReadBytesPerSecondMaximum | UtilizationMetricsEbsWriteBytesPerSecondMaximum | UtilizationMetricsDiskReadOpsPerSecondMaximum | UtilizationMetricsDiskWriteOpsPerSecondMaximum | UtilizationMetricsDiskReadBytesPerSecondMaximum | UtilizationMetricsDiskWriteBytesPerSecondMaximum | UtilizationMetricsNetworkInBytesPerSecondMaximum | UtilizationMetricsNetworkOutBytesPerSecondMaximum | UtilizationMetricsNetworkPacketsInPerSecondMaximum | UtilizationMetricsNetworkPacketsOutPerSecondMaximum | LookbackPeriodInDays | CurrentConfigurationInstanceType | CurrentConfigurationDesiredCapacity | CurrentConfigurationMinSize | CurrentConfigurationMaxSize | CurrentOnDemandPrice | CurrentStandardOneYearNoUpfrontReservedPrice | CurrentStandardThreeYearNoUpfrontReservedPrice | CurrentVCpus | CurrentMemory | CurrentStorage | CurrentNetwork | RecommendationOptionsConfigurationInstanceType | RecommendationOptionsConfigurationDesiredCapacity | RecommendationOptionsConfigurationMinSize | RecommendationOptionsConfigurationMaxSize | RecommendationOptionsProjectedUtilizationMetricsCpuMaximum | RecommendationOptionsProjectedUtilizationMetricsMemoryMaximum | RecommendationOptionsPerformanceRisk | RecommendationOptionsOnDemandPrice | RecommendationOptionsStandardOneYearNoUpfrontReservedPrice | RecommendationOptionsStandardThreeYearNoUpfrontReservedPrice | RecommendationOptionsVcpus | RecommendationOptionsMemory | RecommendationOptionsStorage | RecommendationOptionsNetwork | LastRefreshTimestamp | CurrentPerformanceRisk | RecommendationOptionsSavingsOpportunityPercentage | RecommendationOptionsEstimatedMonthlySavingsCurrency | RecommendationOptionsEstimatedMonthlySavingsValue | EffectiveRecommendationPreferencesCpuVendorArchitectures | EffectiveRecommendationPreferencesEnhancedInfrastructureMetrics,
    /* more items */
  ],
  fileFormat: Csv,
  filters: [
    {
      name: Finding | FindingReasonCodes | RecommendationSourceType,
      values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  includeMemberAccounts: true || false,
  recommendationPreferences: {
    cpuVendorArchitectures: [
      AWS_ARM64 | CURRENT,
      /* more items */
    ]
  }
};
computeoptimizer.exportAutoScalingGroupRecommendations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • accountIds — (Array<String>)

      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.

    • filters — (Array<map>)

      An array of objects to specify a filter that exports a more specific set of Auto Scaling group recommendations.

      • name — (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).

        Possible values include:
        • "Finding"
        • "FindingReasonCodes"
        • "RecommendationSourceType"
      • values — (Array<String>)

        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 or NotOptimized if you specify the name parameter as Finding and you want to filter results for Auto Scaling groups.

        • Specify Underprovisioned, Overprovisioned, or Optimized if you specify the name parameter as Finding and you want to filter results for EC2 instances.

        • Specify Ec2Instance or AutoScalingGroup if you specify the name parameter as RecommendationSourceType.

        • Specify one of the following options if you specify the name parameter as FindingReasonCodes:

          • 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 the NetworkIn or NetworkOut 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.

    • fieldsToExport — (Array<String>)

      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.

    • s3DestinationConfig — (map)

      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.

      • bucket — (String)

        The name of the Amazon S3 bucket to use as the destination for an export job.

      • keyPrefix — (String)

        The Amazon S3 bucket prefix for an export job.

    • fileFormat — (String)

      The format of the export file.

      The only export file format currently supported is Csv.

      Possible values include:
      • "Csv"
    • includeMemberAccounts — (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 — (map)

      An object to specify the preferences for the Auto Scaling group recommendations to export.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • jobId — (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 — (map)

        An object that describes the destination Amazon S3 bucket of a recommendations export file.

        • bucket — (String)

          The name of the Amazon S3 bucket used as the destination of an export file.

        • key — (String)

          The Amazon S3 bucket key of an export file.

          The key uniquely identifies the object, or export file, in the S3 bucket.

        • metadataKey — (String)

          The Amazon S3 bucket key of a metadata file.

          The key uniquely identifies the object, or metadata file, in the S3 bucket.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

exportEBSVolumeRecommendations(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the exportEBSVolumeRecommendations operation

var params = {
  s3DestinationConfig: { /* required */
    bucket: 'STRING_VALUE',
    keyPrefix: 'STRING_VALUE'
  },
  accountIds: [
    'STRING_VALUE',
    /* more items */
  ],
  fieldsToExport: [
    AccountId | VolumeArn | Finding | UtilizationMetricsVolumeReadOpsPerSecondMaximum | UtilizationMetricsVolumeWriteOpsPerSecondMaximum | UtilizationMetricsVolumeReadBytesPerSecondMaximum | UtilizationMetricsVolumeWriteBytesPerSecondMaximum | LookbackPeriodInDays | CurrentConfigurationVolumeType | CurrentConfigurationVolumeBaselineIOPS | CurrentConfigurationVolumeBaselineThroughput | CurrentConfigurationVolumeBurstIOPS | CurrentConfigurationVolumeBurstThroughput | CurrentConfigurationVolumeSize | CurrentMonthlyPrice | RecommendationOptionsConfigurationVolumeType | RecommendationOptionsConfigurationVolumeBaselineIOPS | RecommendationOptionsConfigurationVolumeBaselineThroughput | RecommendationOptionsConfigurationVolumeBurstIOPS | RecommendationOptionsConfigurationVolumeBurstThroughput | RecommendationOptionsConfigurationVolumeSize | RecommendationOptionsMonthlyPrice | RecommendationOptionsPerformanceRisk | LastRefreshTimestamp | CurrentPerformanceRisk | RecommendationOptionsSavingsOpportunityPercentage | RecommendationOptionsEstimatedMonthlySavingsCurrency | RecommendationOptionsEstimatedMonthlySavingsValue,
    /* more items */
  ],
  fileFormat: Csv,
  filters: [
    {
      name: Finding,
      values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  includeMemberAccounts: true || false
};
computeoptimizer.exportEBSVolumeRecommendations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • accountIds — (Array<String>)

      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.

    • filters — (Array<map>)

      An array of objects to specify a filter that exports a more specific set of Amazon EBS volume recommendations.

      • name — (String)

        The name of the filter.

        Specify Finding to return recommendations with a specific finding classification (for example, NotOptimized).

        Possible values include:
        • "Finding"
      • values — (Array<String>)

        The value of the filter.

        The valid values are Optimized, or NotOptimized.

    • fieldsToExport — (Array<String>)

      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.

    • s3DestinationConfig — (map)

      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.

      • bucket — (String)

        The name of the Amazon S3 bucket to use as the destination for an export job.

      • keyPrefix — (String)

        The Amazon S3 bucket prefix for an export job.

    • fileFormat — (String)

      The format of the export file.

      The only export file format currently supported is Csv.

      Possible values include:
      • "Csv"
    • includeMemberAccounts — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • jobId — (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 — (map)

        Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and object keys of a recommendations export file, and its associated metadata file.

        • bucket — (String)

          The name of the Amazon S3 bucket used as the destination of an export file.

        • key — (String)

          The Amazon S3 bucket key of an export file.

          The key uniquely identifies the object, or export file, in the S3 bucket.

        • metadataKey — (String)

          The Amazon S3 bucket key of a metadata file.

          The key uniquely identifies the object, or metadata file, in the S3 bucket.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

exportEC2InstanceRecommendations(params = {}, callback) ⇒ AWS.Request

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.

Examples:

Calling the exportEC2InstanceRecommendations operation

var params = {
  s3DestinationConfig: { /* required */
    bucket: 'STRING_VALUE',
    keyPrefix: 'STRING_VALUE'
  },
  accountIds: [
    'STRING_VALUE',
    /* more items */
  ],
  fieldsToExport: [
    AccountId | InstanceArn | InstanceName | Finding | FindingReasonCodes | LookbackPeriodInDays | CurrentInstanceType | UtilizationMetricsCpuMaximum | UtilizationMetricsMemoryMaximum | UtilizationMetricsEbsReadOpsPerSecondMaximum | UtilizationMetricsEbsWriteOpsPerSecondMaximum | UtilizationMetricsEbsReadBytesPerSecondMaximum | UtilizationMetricsEbsWriteBytesPerSecondMaximum | UtilizationMetricsDiskReadOpsPerSecondMaximum | UtilizationMetricsDiskWriteOpsPerSecondMaximum | UtilizationMetricsDiskReadBytesPerSecondMaximum | UtilizationMetricsDiskWriteBytesPerSecondMaximum | UtilizationMetricsNetworkInBytesPerSecondMaximum | UtilizationMetricsNetworkOutBytesPerSecondMaximum | UtilizationMetricsNetworkPacketsInPerSecondMaximum | UtilizationMetricsNetworkPacketsOutPerSecondMaximum | CurrentOnDemandPrice | CurrentStandardOneYearNoUpfrontReservedPrice | CurrentStandardThreeYearNoUpfrontReservedPrice | CurrentVCpus | CurrentMemory | CurrentStorage | CurrentNetwork | RecommendationOptionsInstanceType | RecommendationOptionsProjectedUtilizationMetricsCpuMaximum | RecommendationOptionsProjectedUtilizationMetricsMemoryMaximum | RecommendationOptionsPlatformDifferences | RecommendationOptionsPerformanceRisk | RecommendationOptionsVcpus | RecommendationOptionsMemory | RecommendationOptionsStorage | RecommendationOptionsNetwork | RecommendationOptionsOnDemandPrice | RecommendationOptionsStandardOneYearNoUpfrontReservedPrice | RecommendationOptionsStandardThreeYearNoUpfrontReservedPrice | RecommendationsSourcesRecommendationSourceArn | RecommendationsSourcesRecommendationSourceType | LastRefreshTimestamp | CurrentPerformanceRisk | RecommendationOptionsSavingsOpportunityPercentage | RecommendationOptionsEstimatedMonthlySavingsCurrency | RecommendationOptionsEstimatedMonthlySavingsValue | EffectiveRecommendationPreferencesCpuVendorArchitectures | EffectiveRecommendationPreferencesEnhancedInfrastructureMetrics,
    /* more items */
  ],
  fileFormat: Csv,
  filters: [
    {
      name: Finding | FindingReasonCodes | RecommendationSourceType,
      values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  includeMemberAccounts: true || false,
  recommendationPreferences: {
    cpuVendorArchitectures: [
      AWS_ARM64 | CURRENT,
      /* more items */
    ]
  }
};
computeoptimizer.exportEC2InstanceRecommendations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • accountIds — (Array<String>)

      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.

    • filters — (Array<map>)

      An array of objects to specify a filter that exports a more specific set of instance recommendations.

      • name — (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).

        Possible values include:
        • "Finding"
        • "FindingReasonCodes"
        • "RecommendationSourceType"
      • values — (Array<String>)

        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 or NotOptimized if you specify the name parameter as Finding and you want to filter results for Auto Scaling groups.

        • Specify Underprovisioned, Overprovisioned, or Optimized if you specify the name parameter as Finding and you want to filter results for EC2 instances.

        • Specify Ec2Instance or AutoScalingGroup if you specify the name parameter as RecommendationSourceType.

        • Specify one of the following options if you specify the name parameter as FindingReasonCodes:

          • 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 the NetworkIn or NetworkOut 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.

    • fieldsToExport — (Array<String>)

      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.

    • s3DestinationConfig — (map)

      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.

      • bucket — (String)

        The name of the Amazon S3 bucket to use as the destination for an export job.

      • keyPrefix — (String)

        The Amazon S3 bucket prefix for an export job.

    • fileFormat — (String)

      The format of the export file.

      The only export file format currently supported is Csv.

      Possible values include:
      • "Csv"
    • includeMemberAccounts — (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 — (map)

      An object to specify the preferences for the Amazon EC2 instance recommendations to export.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • jobId — (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 — (map)

        An object that describes the destination Amazon S3 bucket of a recommendations export file.

        • bucket — (String)

          The name of the Amazon S3 bucket used as the destination of an export file.

        • key — (String)

          The Amazon S3 bucket key of an export file.

          The key uniquely identifies the object, or export file, in the S3 bucket.

        • metadataKey — (String)

          The Amazon S3 bucket key of a metadata file.

          The key uniquely identifies the object, or metadata file, in the S3 bucket.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

exportLambdaFunctionRecommendations(params = {}, callback) ⇒ AWS.Request

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.

Examples:

Calling the exportLambdaFunctionRecommendations operation

var params = {
  s3DestinationConfig: { /* required */
    bucket: 'STRING_VALUE',
    keyPrefix: 'STRING_VALUE'
  },
  accountIds: [
    'STRING_VALUE',
    /* more items */
  ],
  fieldsToExport: [
    AccountId | FunctionArn | FunctionVersion | Finding | FindingReasonCodes | NumberOfInvocations | UtilizationMetricsDurationMaximum | UtilizationMetricsDurationAverage | UtilizationMetricsMemoryMaximum | UtilizationMetricsMemoryAverage | LookbackPeriodInDays | CurrentConfigurationMemorySize | CurrentConfigurationTimeout | CurrentCostTotal | CurrentCostAverage | RecommendationOptionsConfigurationMemorySize | RecommendationOptionsCostLow | RecommendationOptionsCostHigh | RecommendationOptionsProjectedUtilizationMetricsDurationLowerBound | RecommendationOptionsProjectedUtilizationMetricsDurationUpperBound | RecommendationOptionsProjectedUtilizationMetricsDurationExpected | LastRefreshTimestamp | CurrentPerformanceRisk | RecommendationOptionsSavingsOpportunityPercentage | RecommendationOptionsEstimatedMonthlySavingsCurrency | RecommendationOptionsEstimatedMonthlySavingsValue,
    /* more items */
  ],
  fileFormat: Csv,
  filters: [
    {
      name: Finding | FindingReasonCode,
      values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  includeMemberAccounts: true || false
};
computeoptimizer.exportLambdaFunctionRecommendations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • accountIds — (Array<String>)

      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.

    • filters — (Array<map>)

      An array of objects to specify a filter that exports a more specific set of Lambda function recommendations.

      • name — (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).

        Possible values include:
        • "Finding"
        • "FindingReasonCode"
      • values — (Array<String>)

        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, or Unavailable if you specify the name parameter as Finding.

        • Specify MemoryOverprovisioned, MemoryUnderprovisioned, InsufficientData, or Inconclusive if you specify the name parameter as FindingReasonCode.

    • fieldsToExport — (Array<String>)

      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.

    • s3DestinationConfig — (map)

      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.

      • bucket — (String)

        The name of the Amazon S3 bucket to use as the destination for an export job.

      • keyPrefix — (String)

        The Amazon S3 bucket prefix for an export job.

    • fileFormat — (String)

      The format of the export file.

      The only export file format currently supported is Csv.

      Possible values include:
      • "Csv"
    • includeMemberAccounts — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • jobId — (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 — (map)

        Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and object keys of a recommendations export file, and its associated metadata file.

        • bucket — (String)

          The name of the Amazon S3 bucket used as the destination of an export file.

        • key — (String)

          The Amazon S3 bucket key of an export file.

          The key uniquely identifies the object, or export file, in the S3 bucket.

        • metadataKey — (String)

          The Amazon S3 bucket key of a metadata file.

          The key uniquely identifies the object, or metadata file, in the S3 bucket.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getAutoScalingGroupRecommendations(params = {}, callback) ⇒ AWS.Request

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.

Examples:

Calling the getAutoScalingGroupRecommendations operation

var params = {
  accountIds: [
    'STRING_VALUE',
    /* more items */
  ],
  autoScalingGroupArns: [
    'STRING_VALUE',
    /* more items */
  ],
  filters: [
    {
      name: Finding | FindingReasonCodes | RecommendationSourceType,
      values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  recommendationPreferences: {
    cpuVendorArchitectures: [
      AWS_ARM64 | CURRENT,
      /* more items */
    ]
  }
};
computeoptimizer.getAutoScalingGroupRecommendations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • accountIds — (Array<String>)

      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 — (Array<String>)

      The Amazon Resource Name (ARN) of the Auto Scaling groups for which to return recommendations.

    • nextToken — (String)

      The token to advance to the next page of Auto Scaling group recommendations.

    • maxResults — (Integer)

      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.

    • filters — (Array<map>)

      An array of objects to specify a filter that returns a more specific list of Auto Scaling group recommendations.

      • name — (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).

        Possible values include:
        • "Finding"
        • "FindingReasonCodes"
        • "RecommendationSourceType"
      • values — (Array<String>)

        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 or NotOptimized if you specify the name parameter as Finding and you want to filter results for Auto Scaling groups.

        • Specify Underprovisioned, Overprovisioned, or Optimized if you specify the name parameter as Finding and you want to filter results for EC2 instances.

        • Specify Ec2Instance or AutoScalingGroup if you specify the name parameter as RecommendationSourceType.

        • Specify one of the following options if you specify the name parameter as FindingReasonCodes:

          • 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 the NetworkIn or NetworkOut 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.

    • recommendationPreferences — (map)

      An object to specify the preferences for the Auto Scaling group recommendations to return in the response.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • nextToken — (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.

      • autoScalingGroupRecommendations — (Array<map>)

        An array of objects that describe Auto Scaling group recommendations.

        • accountId — (String)

          The Amazon Web Services account ID of the Auto Scaling group.

        • autoScalingGroupArn — (String)

          The Amazon Resource Name (ARN) of the Auto Scaling group.

        • autoScalingGroupName — (String)

          The name of the Auto Scaling group.

        • finding — (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.

          Possible values include:
          • "Underprovisioned"
          • "Overprovisioned"
          • "Optimized"
          • "NotOptimized"
        • utilizationMetrics — (Array<map>)

          An array of objects that describe the utilization metrics of the Auto Scaling group.

          • name — (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

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

            Possible values include:
            • "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"
          • statistic — (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 of Sum / 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.

            Possible values include:
            • "Maximum"
            • "Average"
          • value — (Float)

            The value of the utilization metric.

        • lookBackPeriodInDays — (Float)

          The number of days for which utilization metrics were analyzed for the Auto Scaling group.

        • currentConfiguration — (map)

          An array of objects that describe the current configuration of the Auto Scaling group.

          • desiredCapacity — (Integer)

            The desired capacity, or number of instances, for the Auto Scaling group.

          • minSize — (Integer)

            The minimum size, or minimum number of instances, for the Auto Scaling group.

          • maxSize — (Integer)

            The maximum size, or maximum number of instances, for the Auto Scaling group.

          • instanceType — (String)

            The instance type for the Auto Scaling group.

        • recommendationOptions — (Array<map>)

          An array of objects that describe the recommendation options for the Auto Scaling group.

          • configuration — (map)

            An array of objects that describe an Auto Scaling group configuration.

            • desiredCapacity — (Integer)

              The desired capacity, or number of instances, for the Auto Scaling group.

            • minSize — (Integer)

              The minimum size, or minimum number of instances, for the Auto Scaling group.

            • maxSize — (Integer)

              The maximum size, or maximum number of instances, for the Auto Scaling group.

            • instanceType — (String)

              The instance type for the Auto Scaling group.

          • projectedUtilizationMetrics — (Array<map>)

            An array of objects that describe the projected utilization metrics of the Auto Scaling group recommendation option.

            Note: The Cpu and Memory metrics are the only projected utilization metrics returned. 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.
            • name — (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

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

              Possible values include:
              • "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"
            • statistic — (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 of Sum / 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.

              Possible values include:
              • "Maximum"
              • "Average"
            • value — (Float)

              The value of the utilization metric.

          • performanceRisk — (Float)

            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, with 0 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 — (Integer)

            The rank of the Auto Scaling group recommendation option.

            The top recommendation option is ranked as 1.

          • savingsOpportunity — (map)

            An object that describes the savings opportunity for the Auto Scaling group recommendation option. Savings opportunity includes the estimated monthly savings amount and percentage.

            • savingsOpportunityPercentage — (Float)

              The estimated monthly savings possible as a percentage of monthly cost.

            • estimatedMonthlySavings — (map)

              An object that describes the estimated monthly savings amount possible based on On-Demand instance pricing.

              • currency — (String)

                The currency of the estimated monthly savings.

                Possible values include:
                • "USD"
                • "CNY"
              • value — (Float)

                The value of the estimated monthly savings.

        • lastRefreshTimestamp — (Date)

          The timestamp of when the Auto Scaling group recommendation was last generated.

        • currentPerformanceRisk — (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.

          Possible values include:
          • "VeryLow"
          • "Low"
          • "Medium"
          • "High"
        • effectiveRecommendationPreferences — (map)

          An object that describes the effective recommendation preferences for the Auto Scaling group.

          • cpuVendorArchitectures — (Array<String>)

            Describes the CPU vendor and architecture for an instance or Auto Scaling group recommendations.

            For example, when you specify AWS_ARM64 with:

          • enhancedInfrastructureMetrics — (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 of Inactive confirms that it's not yet applied.

            Possible values include:
            • "Active"
            • "Inactive"
      • errors — (Array<map>)

        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.

        • identifier — (String)

          The ID of the error.

        • code — (String)

          The error code.

        • message — (String)

          The message, or reason, for the error.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getEBSVolumeRecommendations(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the getEBSVolumeRecommendations operation

var params = {
  accountIds: [
    'STRING_VALUE',
    /* more items */
  ],
  filters: [
    {
      name: Finding,
      values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  volumeArns: [
    'STRING_VALUE',
    /* more items */
  ]
};
computeoptimizer.getEBSVolumeRecommendations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • volumeArns — (Array<String>)

      The Amazon Resource Name (ARN) of the volumes for which to return recommendations.

    • nextToken — (String)

      The token to advance to the next page of volume recommendations.

    • maxResults — (Integer)

      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.

    • filters — (Array<map>)

      An array of objects to specify a filter that returns a more specific list of volume recommendations.

      • name — (String)

        The name of the filter.

        Specify Finding to return recommendations with a specific finding classification (for example, NotOptimized).

        Possible values include:
        • "Finding"
      • values — (Array<String>)

        The value of the filter.

        The valid values are Optimized, or NotOptimized.

    • accountIds — (Array<String>)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • nextToken — (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 — (Array<map>)

        An array of objects that describe volume recommendations.

        • volumeArn — (String)

          The Amazon Resource Name (ARN) of the current volume.

        • accountId — (String)

          The Amazon Web Services account ID of the volume.

        • currentConfiguration — (map)

          An array of objects that describe the current configuration of the volume.

          • volumeType — (String)

            The volume type.

            This can be gp2 for General Purpose SSD, io1 or io2 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.

          • volumeSize — (Integer)

            The size of the volume, in GiB.

          • volumeBaselineIOPS — (Integer)

            The baseline IOPS of the volume.

          • volumeBurstIOPS — (Integer)

            The burst IOPS of the volume.

          • volumeBaselineThroughput — (Integer)

            The baseline throughput of the volume.

          • volumeBurstThroughput — (Integer)

            The burst throughput of the volume.

        • finding — (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.

          Possible values include:
          • "Optimized"
          • "NotOptimized"
        • utilizationMetrics — (Array<map>)

          An array of objects that describe the utilization metrics of the volume.

          • name — (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

            Possible values include:
            • "VolumeReadOpsPerSecond"
            • "VolumeWriteOpsPerSecond"
            • "VolumeReadBytesPerSecond"
            • "VolumeWriteBytesPerSecond"
          • statistic — (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 of Sum / 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.

            Possible values include:
            • "Maximum"
            • "Average"
          • value — (Float)

            The value of the utilization metric.

        • lookBackPeriodInDays — (Float)

          The number of days for which utilization metrics were analyzed for the volume.

        • volumeRecommendationOptions — (Array<map>)

          An array of objects that describe the recommendation options for the volume.

          • configuration — (map)

            An array of objects that describe a volume configuration.

            • volumeType — (String)

              The volume type.

              This can be gp2 for General Purpose SSD, io1 or io2 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.

            • volumeSize — (Integer)

              The size of the volume, in GiB.

            • volumeBaselineIOPS — (Integer)

              The baseline IOPS of the volume.

            • volumeBurstIOPS — (Integer)

              The burst IOPS of the volume.

            • volumeBaselineThroughput — (Integer)

              The baseline throughput of the volume.

            • volumeBurstThroughput — (Integer)

              The burst throughput of the volume.

          • performanceRisk — (Float)

            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, with 0 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 — (Integer)

            The rank of the volume recommendation option.

            The top recommendation option is ranked as 1.

          • savingsOpportunity — (map)

            An object that describes the savings opportunity for the EBS volume recommendation option. Savings opportunity includes the estimated monthly savings amount and percentage.

            • savingsOpportunityPercentage — (Float)

              The estimated monthly savings possible as a percentage of monthly cost.

            • estimatedMonthlySavings — (map)

              An object that describes the estimated monthly savings amount possible based on On-Demand instance pricing.

              • currency — (String)

                The currency of the estimated monthly savings.

                Possible values include:
                • "USD"
                • "CNY"
              • value — (Float)

                The value of the estimated monthly savings.

        • lastRefreshTimestamp — (Date)

          The timestamp of when the volume recommendation was last generated.

        • currentPerformanceRisk — (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.

          Possible values include:
          • "VeryLow"
          • "Low"
          • "Medium"
          • "High"
      • errors — (Array<map>)

        An array of objects that describe errors of the request.

        For example, an error is returned if you request recommendations for an unsupported volume.

        • identifier — (String)

          The ID of the error.

        • code — (String)

          The error code.

        • message — (String)

          The message, or reason, for the error.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getEC2InstanceRecommendations(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the getEC2InstanceRecommendations operation

var params = {
  accountIds: [
    'STRING_VALUE',
    /* more items */
  ],
  filters: [
    {
      name: Finding | FindingReasonCodes | RecommendationSourceType,
      values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  instanceArns: [
    'STRING_VALUE',
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  recommendationPreferences: {
    cpuVendorArchitectures: [
      AWS_ARM64 | CURRENT,
      /* more items */
    ]
  }
};
computeoptimizer.getEC2InstanceRecommendations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • instanceArns — (Array<String>)

      The Amazon Resource Name (ARN) of the instances for which to return recommendations.

    • nextToken — (String)

      The token to advance to the next page of instance recommendations.

    • maxResults — (Integer)

      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.

    • filters — (Array<map>)

      An array of objects to specify a filter that returns a more specific list of instance recommendations.

      • name — (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).

        Possible values include:
        • "Finding"
        • "FindingReasonCodes"
        • "RecommendationSourceType"
      • values — (Array<String>)

        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 or NotOptimized if you specify the name parameter as Finding and you want to filter results for Auto Scaling groups.

        • Specify Underprovisioned, Overprovisioned, or Optimized if you specify the name parameter as Finding and you want to filter results for EC2 instances.

        • Specify Ec2Instance or AutoScalingGroup if you specify the name parameter as RecommendationSourceType.

        • Specify one of the following options if you specify the name parameter as FindingReasonCodes:

          • 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 the NetworkIn or NetworkOut 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.

    • accountIds — (Array<String>)

      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.

    • recommendationPreferences — (map)

      An object to specify the preferences for the Amazon EC2 instance recommendations to return in the response.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • nextToken — (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.

      • instanceRecommendations — (Array<map>)

        An array of objects that describe instance recommendations.

        • instanceArn — (String)

          The Amazon Resource Name (ARN) of the current instance.

        • accountId — (String)

          The Amazon Web Services account ID of the instance.

        • instanceName — (String)

          The name of the current instance.

        • currentInstanceType — (String)

          The instance type of the current instance.

        • finding — (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.

          Possible values include:
          • "Underprovisioned"
          • "Overprovisioned"
          • "Optimized"
          • "NotOptimized"
        • findingReasonCodes — (Array<String>)

          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 the CPUUtilization 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 the CPUUtilization 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.

            Note: 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 the CWAgent namespace, or the legacy MemoryUtilization metric in the System/Linux namespace. On Windows instances, Compute Optimizer analyses the Memory % Committed Bytes In Use metric in the CWAgent 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 the VolumeReadOps and VolumeWriteOps 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 the VolumeReadOps and VolumeWriteOps 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 the VolumeReadBytes and VolumeWriteBytes 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 the VolumeReadBytes and VolumeWriteBytes 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 the NetworkIn and NetworkOut 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 the NetworkIn and NetworkOut metrics of the current instance during the look-back period. This finding reason happens when the NetworkIn or NetworkOut 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 the NetworkPacketsIn and NetworkPacketsIn 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 the NetworkPacketsIn and NetworkPacketsIn 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 the DiskReadOps and DiskWriteOps 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 the DiskReadOps and DiskWriteOps 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 the DiskReadBytes and DiskWriteBytes 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 the DiskReadBytes and DiskWriteBytes metrics of the current instance during the look-back period.

          Note: 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.
        • utilizationMetrics — (Array<map>)

          An array of objects that describe the utilization metrics of the instance.

          • name — (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

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

            Possible values include:
            • "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"
          • statistic — (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 of Sum / 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.

            Possible values include:
            • "Maximum"
            • "Average"
          • value — (Float)

            The value of the utilization metric.

        • lookBackPeriodInDays — (Float)

          The number of days for which utilization metrics were analyzed for the instance.

        • recommendationOptions — (Array<map>)

          An array of objects that describe the recommendation options for the instance.

          • instanceType — (String)

            The instance type of the instance recommendation.

          • projectedUtilizationMetrics — (Array<map>)

            An array of objects that describe the projected utilization metrics of the instance recommendation option.

            Note: The Cpu and Memory metrics are the only projected utilization metrics returned. 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.
            • name — (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

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

              Possible values include:
              • "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"
            • statistic — (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 of Sum / 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.

              Possible values include:
              • "Maximum"
              • "Average"
            • value — (Float)

              The value of the utilization metric.

          • platformDifferences — (Array<String>)

            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.

          • performanceRisk — (Float)

            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, with 0 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 — (Integer)

            The rank of the instance recommendation option.

            The top recommendation option is ranked as 1.

          • savingsOpportunity — (map)

            An object that describes the savings opportunity for the instance recommendation option. Savings opportunity includes the estimated monthly savings amount and percentage.

            • savingsOpportunityPercentage — (Float)

              The estimated monthly savings possible as a percentage of monthly cost.

            • estimatedMonthlySavings — (map)

              An object that describes the estimated monthly savings amount possible based on On-Demand instance pricing.

              • currency — (String)

                The currency of the estimated monthly savings.

                Possible values include:
                • "USD"
                • "CNY"
              • value — (Float)

                The value of the estimated monthly savings.

        • recommendationSources — (Array<map>)

          An array of objects that describe the source resource of the recommendation.

          • recommendationSourceArn — (String)

            The Amazon Resource Name (ARN) of the recommendation source.

          • recommendationSourceType — (String)

            The resource type of the recommendation source.

            Possible values include:
            • "Ec2Instance"
            • "AutoScalingGroup"
            • "EbsVolume"
            • "LambdaFunction"
        • lastRefreshTimestamp — (Date)

          The timestamp of when the instance recommendation was last generated.

        • currentPerformanceRisk — (String)

          The risk of the current instance not meeting the performance needs of its workloads. The higher the risk, the more likely the current Lambda function requires more memory.

          Possible values include:
          • "VeryLow"
          • "Low"
          • "Medium"
          • "High"
        • effectiveRecommendationPreferences — (map)

          An object that describes the effective recommendation preferences for the instance.

          • cpuVendorArchitectures — (Array<String>)

            Describes the CPU vendor and architecture for an instance or Auto Scaling group recommendations.

            For example, when you specify AWS_ARM64 with:

          • enhancedInfrastructureMetrics — (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 of Inactive confirms that it's not yet applied.

            Possible values include:
            • "Active"
            • "Inactive"
      • errors — (Array<map>)

        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.

        • identifier — (String)

          The ID of the error.

        • code — (String)

          The error code.

        • message — (String)

          The message, or reason, for the error.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getEC2RecommendationProjectedMetrics(params = {}, callback) ⇒ AWS.Request

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.

Examples:

Calling the getEC2RecommendationProjectedMetrics operation

var params = {
  endTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  instanceArn: 'STRING_VALUE', /* required */
  period: 'NUMBER_VALUE', /* required */
  startTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  stat: Maximum | Average, /* required */
  recommendationPreferences: {
    cpuVendorArchitectures: [
      AWS_ARM64 | CURRENT,
      /* more items */
    ]
  }
};
computeoptimizer.getEC2RecommendationProjectedMetrics(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • instanceArn — (String)

      The Amazon Resource Name (ARN) of the instances for which to return recommendation projected metrics.

    • stat — (String)

      The statistic of the projected metrics.

      Possible values include:
      • "Maximum"
      • "Average"
    • period — (Integer)

      The granularity, in seconds, of the projected metrics data points.

    • startTime — (Date)

      The timestamp of the first projected metrics data point to return.

    • endTime — (Date)

      The timestamp of the last projected metrics data point to return.

    • recommendationPreferences — (map)

      An object to specify the preferences for the Amazon EC2 recommendation projected metrics to return in the response.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • recommendedOptionProjectedMetrics — (Array<map>)

        An array of objects that describes projected metrics.

        • recommendedInstanceType — (String)

          The recommended instance type.

        • rank — (Integer)

          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 as 1 in the same response.

        • projectedMetrics — (Array<map>)

          An array of objects that describe a projected utilization metric.

          • name — (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.

              Units: Percent

            • 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

              Note: 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.
            Possible values include:
            • "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"
          • timestamps — (Array<Date>)

            The timestamps of the projected utilization metric.

          • values — (Array<Float>)

            The values of the projected utilization metrics.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getEffectiveRecommendationPreferences(params = {}, callback) ⇒ AWS.Request

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.

Examples:

Calling the getEffectiveRecommendationPreferences operation

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
computeoptimizer.getEffectiveRecommendationPreferences(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • enhancedInfrastructureMetrics — (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 of Inactive confirms that it's not yet applied.

        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.

        Possible values include:
        • "Active"
        • "Inactive"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getEnrollmentStatus(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the getEnrollmentStatus operation

var params = {
};
computeoptimizer.getEnrollmentStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • status — (String)

        The enrollment status of the account.

        Possible values include:
        • "Active"
        • "Inactive"
        • "Pending"
        • "Failed"
      • statusReason — (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.

      • memberAccountsEnrolled — (Boolean)

        Confirms the enrollment status of member accounts of the organization, if the account is a management account of an organization.

      • lastUpdatedTimestamp — (Date)

        The Unix epoch timestamp, in seconds, of when the account enrollment status was last updated.

      • numberOfMemberAccountsOptedIn — (Integer)

        The count of organization member accounts that are opted in to the service, if your account is an organization management account.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getEnrollmentStatusesForOrganization(params = {}, callback) ⇒ AWS.Request

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.

Examples:

Calling the getEnrollmentStatusesForOrganization operation

var params = {
  filters: [
    {
      name: Status,
      values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
computeoptimizer.getEnrollmentStatusesForOrganization(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • filters — (Array<map>)

      An array of objects to specify a filter that returns a more specific list of account enrollment statuses.

      • name — (String)

        The name of the filter.

        Specify Status to return accounts with a specific enrollment status (for example, Active).

        Possible values include:
        • "Status"
      • values — (Array<String>)

        The value of the filter.

        The valid values are Active, Inactive, Pending, and Failed.

    • nextToken — (String)

      The token to advance to the next page of account enrollment statuses.

    • maxResults — (Integer)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • accountEnrollmentStatuses — (Array<map>)

        An array of objects that describe the enrollment statuses of organization member accounts.

        • accountId — (String)

          The Amazon Web Services account ID.

        • status — (String)

          The account enrollment status.

          Possible values include:
          • "Active"
          • "Inactive"
          • "Pending"
          • "Failed"
        • statusReason — (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.

        • lastUpdatedTimestamp — (Date)

          The Unix epoch timestamp, in seconds, of when the account enrollment status was last updated.

      • nextToken — (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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getLambdaFunctionRecommendations(params = {}, callback) ⇒ AWS.Request

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.

Examples:

Calling the getLambdaFunctionRecommendations operation

var params = {
  accountIds: [
    'STRING_VALUE',
    /* more items */
  ],
  filters: [
    {
      name: Finding | FindingReasonCode,
      values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  functionArns: [
    'STRING_VALUE',
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
computeoptimizer.getLambdaFunctionRecommendations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • functionArns — (Array<String>)

      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.

    • accountIds — (Array<String>)

      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 — (Array<map>)

      An array of objects to specify a filter that returns a more specific list of function recommendations.

      • name — (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).

        Possible values include:
        • "Finding"
        • "FindingReasonCode"
      • values — (Array<String>)

        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, or Unavailable if you specify the name parameter as Finding.

        • Specify MemoryOverprovisioned, MemoryUnderprovisioned, InsufficientData, or Inconclusive if you specify the name parameter as FindingReasonCode.

    • nextToken — (String)

      The token to advance to the next page of function recommendations.

    • maxResults — (Integer)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • nextToken — (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.

      • lambdaFunctionRecommendations — (Array<map>)

        An array of objects that describe function recommendations.

        • functionArn — (String)

          The Amazon Resource Name (ARN) of the current function.

        • functionVersion — (String)

          The version number of the current function.

        • accountId — (String)

          The Amazon Web Services account ID of the function.

        • currentMemorySize — (Integer)

          The amount of memory, in MB, that's allocated to the current function.

        • numberOfInvocations — (Integer)

          The number of times your function code was applied during the look-back period.

        • utilizationMetrics — (Array<map>)

          An array of objects that describe the utilization metrics of the function.

          • name — (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.

            Possible values include:
            • "Duration"
            • "Memory"
          • statistic — (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 of Sum / 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.

            Possible values include:
            • "Maximum"
            • "Average"
          • value — (Float)

            The value of the utilization metric.

        • lookbackPeriodInDays — (Float)

          The number of days for which utilization metrics were analyzed for the function.

        • lastRefreshTimestamp — (Date)

          The timestamp of when the function recommendation was last generated.

        • finding — (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 the MemoryUnderprovisioned and MemoryUnderprovisioned 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 the InsufficientData and Inconclusive finding reason codes.

            Note: Functions with a finding of unavailable are not returned unless you specify the filter parameter with a value of Unavailable in your GetLambdaFunctionRecommendations request.
          Possible values include:
          • "Optimized"
          • "NotOptimized"
          • "Unavailable"
        • findingReasonCodes — (Array<String>)

          The reason for the finding classification of the function.

          Note: 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 the NotOptimized 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 the NotOptimized 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 the Unavailable 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 the Unavailable finding classification.

        • memorySizeRecommendationOptions — (Array<map>)

          An array of objects that describe the memory configuration recommendation options for the function.

          • rank — (Integer)

            The rank of the function recommendation option.

            The top recommendation option is ranked as 1.

          • memorySize — (Integer)

            The memory size, in MB, of the function recommendation option.

          • projectedUtilizationMetrics — (Array<map>)

            An array of objects that describe the projected utilization metrics of the function recommendation option.

            • name — (String)

              The name of the projected utilization metric.

              Possible values include:
              • "Duration"
            • statistic — (String)

              The statistic of the projected utilization metric.

              Possible values include:
              • "LowerBound"
              • "UpperBound"
              • "Expected"
            • value — (Float)

              The values of the projected utilization metrics.

          • savingsOpportunity — (map)

            An object that describes the savings opportunity for the Lambda function recommendation option. Savings opportunity includes the estimated monthly savings amount and percentage.

            • savingsOpportunityPercentage — (Float)

              The estimated monthly savings possible as a percentage of monthly cost.

            • estimatedMonthlySavings — (map)

              An object that describes the estimated monthly savings amount possible based on On-Demand instance pricing.

              • currency — (String)

                The currency of the estimated monthly savings.

                Possible values include:
                • "USD"
                • "CNY"
              • value — (Float)

                The value of the estimated monthly savings.

        • currentPerformanceRisk — (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 configuration is underperforming in its workload.

          Possible values include:
          • "VeryLow"
          • "Low"
          • "Medium"
          • "High"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getRecommendationPreferences(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the getRecommendationPreferences operation

var params = {
  resourceType: Ec2Instance | AutoScalingGroup | EbsVolume | LambdaFunction, /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  scope: {
    name: Organization | AccountId | ResourceArn,
    value: 'STRING_VALUE'
  }
};
computeoptimizer.getRecommendationPreferences(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceType — (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. The AutoScalingGroup option encompasses only instances that are part of an Auto Scaling group.

      Possible values include:
      • "Ec2Instance"
      • "AutoScalingGroup"
      • "EbsVolume"
      • "LambdaFunction"
    • scope — (map)

      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.

      • name — (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.

        Possible values include:
        • "Organization"
        • "AccountId"
        • "ResourceArn"
      • value — (String)

        The value of the scope.

        If you specified the name of the scope as:

        • Organization - The value must be ALL_ACCOUNTS.

        • AccountId - The value must be a 12-digit Amazon Web Services account ID.

        • ResourceArn - The value 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.

    • nextToken — (String)

      The token to advance to the next page of recommendation preferences.

    • maxResults — (Integer)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • nextToken — (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 — (Array<map>)

        An array of objects that describe recommendation preferences.

        • scope — (map)

          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.

          • name — (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.

            Possible values include:
            • "Organization"
            • "AccountId"
            • "ResourceArn"
          • value — (String)

            The value of the scope.

            If you specified the name of the scope as:

            • Organization - The value must be ALL_ACCOUNTS.

            • AccountId - The value must be a 12-digit Amazon Web Services account ID.

            • ResourceArn - The value 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.

        • resourceType — (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. The AutoScalingGroup option encompasses only instances that are part of an Auto Scaling group.

          Possible values include:
          • "Ec2Instance"
          • "AutoScalingGroup"
          • "EbsVolume"
          • "LambdaFunction"
        • enhancedInfrastructureMetrics — (String)

          The status of the enhanced infrastructure metrics recommendation preference.

          A status of Active confirms that the preference is applied in the latest recommendation refresh, and a status of Inactive confirms that it's not yet applied.

          Possible values include:
          • "Active"
          • "Inactive"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getRecommendationSummaries(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the getRecommendationSummaries operation

var params = {
  accountIds: [
    'STRING_VALUE',
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
computeoptimizer.getRecommendationSummaries(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • accountIds — (Array<String>)

      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.

    • nextToken — (String)

      The token to advance to the next page of recommendation summaries.

    • maxResults — (Integer)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • nextToken — (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 — (Array<map>)

        An array of objects that summarize a recommendation.

        • summaries — (Array<map>)

          An array of objects that describe a recommendation summary.

          • name — (String)

            The finding classification of the recommendation.

            Possible values include:
            • "Underprovisioned"
            • "Overprovisioned"
            • "Optimized"
            • "NotOptimized"
          • value — (Float)

            The value of the recommendation summary.

          • reasonCodeSummaries — (Array<map>)

            An array of objects that summarize a finding reason code.

            • name — (String)

              The name of the finding reason code.

              Possible values include:
              • "MemoryOverprovisioned"
              • "MemoryUnderprovisioned"
            • value — (Float)

              The value of the finding reason code summary.

        • recommendationResourceType — (String)

          The resource type that the recommendation summary applies to.

          Possible values include:
          • "Ec2Instance"
          • "AutoScalingGroup"
          • "EbsVolume"
          • "LambdaFunction"
        • accountId — (String)

          The Amazon Web Services account ID of the recommendation summary.

        • savingsOpportunity — (map)

          An object that describes the savings opportunity for a given resource type. Savings opportunity includes the estimated monthly savings amount and percentage.

          • savingsOpportunityPercentage — (Float)

            The estimated monthly savings possible as a percentage of monthly cost.

          • estimatedMonthlySavings — (map)

            An object that describes the estimated monthly savings amount possible based on On-Demand instance pricing.

            • currency — (String)

              The currency of the estimated monthly savings.

              Possible values include:
              • "USD"
              • "CNY"
            • value — (Float)

              The value of the estimated monthly savings.

        • currentPerformanceRiskRatings — (map)

          An object that describes the performance risk ratings for a given resource type.

          • high — (Integer)

            A count of the applicable resource types with a high performance risk rating.

          • medium — (Integer)

            A count of the applicable resource types with a medium performance risk rating.

          • low — (Integer)

            A count of the applicable resource types with a low performance risk rating.

          • veryLow — (Integer)

            A count of the applicable resource types with a very low performance risk rating.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

putRecommendationPreferences(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the putRecommendationPreferences operation

var params = {
  resourceType: Ec2Instance | AutoScalingGroup | EbsVolume | LambdaFunction, /* required */
  enhancedInfrastructureMetrics: Active | Inactive,
  scope: {
    name: Organization | AccountId | ResourceArn,
    value: 'STRING_VALUE'
  }
};
computeoptimizer.putRecommendationPreferences(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceType — (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. The AutoScalingGroup option encompasses only instances that are part of an Auto Scaling group.

      Possible values include:
      • "Ec2Instance"
      • "AutoScalingGroup"
      • "EbsVolume"
      • "LambdaFunction"
    • scope — (map)

      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.

      Note: 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 the Auto Scaling group.
      • name — (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.

        Possible values include:
        • "Organization"
        • "AccountId"
        • "ResourceArn"
      • value — (String)

        The value of the scope.

        If you specified the name of the scope as:

        • Organization - The value must be ALL_ACCOUNTS.

        • AccountId - The value must be a 12-digit Amazon Web Services account ID.

        • ResourceArn - The value 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.

    • enhancedInfrastructureMetrics — (String)

      The status of the enhanced infrastructure metrics recommendation preference to create or update.

      A status of Active confirms that the preference is applied in the latest recommendation refresh, and a status of Inactive confirms that it's not yet applied.

      Possible values include:
      • "Active"
      • "Inactive"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateEnrollmentStatus(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the updateEnrollmentStatus operation

var params = {
  status: Active | Inactive | Pending | Failed, /* required */
  includeMemberAccounts: true || false
};
computeoptimizer.updateEnrollmentStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • status — (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.

      Note: The Pending and Failed 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.
      Possible values include:
      • "Active"
      • "Inactive"
      • "Pending"
      • "Failed"
    • includeMemberAccounts — (Boolean)

      Indicates whether to enroll member accounts of the organization if the account is the management account of an organization.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • status — (String)

        The enrollment status of the account.

        Possible values include:
        • "Active"
        • "Inactive"
        • "Pending"
        • "Failed"
      • statusReason — (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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.