openapi: 3.0.0
info:
  version: '2019-11-01'
  x-release: v4
  title: 'AWS Compute Optimizer #X Amz Target=ComputeOptimizerService.DeleteRecommendationPreferences #X Amz Target=ComputeOptimizerService.DeleteRecommendationPreferences #X Amz Target=ComputeOptimizerService.GetAutoScalingGroupRecommendations API'
  description: Compute Optimizer is a service that analyzes the configuration and utilization metrics of your Amazon Web Services compute resources, such as Amazon EC2 instances, Amazon EC2 Auto Scaling groups, Lambda functions, Amazon EBS volumes, and Amazon ECS services on Fargate. It reports whether your resources are optimal, and generates optimization recommendations to reduce the cost and improve the performance of your workloads. Compute Optimizer also provides recent utilization metric data, in addition to projected utilization metric data for the recommendations, which you can use to evaluate which recommendation provides the best price-performance trade-off. The analysis of your usage patterns can help you decide when to move or resize your running resources, and still meet your performance and capacity requirements. For more information about Compute Optimizer, including the required permissions to use the service, see the <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/">Compute Optimizer User Guide</a>.
  x-logo:
    url: https://twitter.com/awscloud/profile_image?size=original
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: compute-optimizer
  x-aws-signingName: compute-optimizer
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/compute-optimizer-2019-11-01.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
      version: 1.0.0
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://compute-optimizer.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The AWS Compute Optimizer multi-region endpoint
- url: https://compute-optimizer.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The AWS Compute Optimizer multi-region endpoint
- url: http://compute-optimizer.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWS Compute Optimizer endpoint for China (Beijing) and China (Ningxia)
- url: https://compute-optimizer.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWS Compute Optimizer endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=ComputeOptimizerService.GetAutoScalingGroupRecommendations'
paths:
  /#X-Amz-Target=ComputeOptimizerService.GetAutoScalingGroupRecommendations:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    post:
      operationId: GetAutoScalingGroupRecommendations
      description: <p>Returns Auto Scaling group recommendations.</p> <p>Compute Optimizer generates recommendations for Amazon EC2 Auto Scaling groups that meet a specific set of requirements. For more information, see the <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/requirements.html">Supported resources and requirements</a> in the <i>Compute Optimizer User Guide</i>.</p>
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAutoScalingGroupRecommendationsResponse'
              examples:
                GetAutoScalingGroupRecommendations200Example:
                  summary: Default GetAutoScalingGroupRecommendations 200
                  x-microcks-default: true
                  value:
                    nextToken: example
                    autoScalingGroupRecommendations: example
                    errors: example
        '480':
          description: OptInRequiredException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OptInRequiredException'
              examples:
                GetAutoScalingGroupRecommendations480Example:
                  summary: Default GetAutoScalingGroupRecommendations 480
                  x-microcks-default: true
                  value: example
        '481':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
              examples:
                GetAutoScalingGroupRecommendations481Example:
                  summary: Default GetAutoScalingGroupRecommendations 481
                  x-microcks-default: true
                  value: example
        '482':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
              examples:
                GetAutoScalingGroupRecommendations482Example:
                  summary: Default GetAutoScalingGroupRecommendations 482
                  x-microcks-default: true
                  value: example
        '483':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
              examples:
                GetAutoScalingGroupRecommendations483Example:
                  summary: Default GetAutoScalingGroupRecommendations 483
                  x-microcks-default: true
                  value: example
        '484':
          description: InvalidParameterValueException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
              examples:
                GetAutoScalingGroupRecommendations484Example:
                  summary: Default GetAutoScalingGroupRecommendations 484
                  x-microcks-default: true
                  value: example
        '485':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
              examples:
                GetAutoScalingGroupRecommendations485Example:
                  summary: Default GetAutoScalingGroupRecommendations 485
                  x-microcks-default: true
                  value: example
        '486':
          description: MissingAuthenticationToken
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MissingAuthenticationToken'
              examples:
                GetAutoScalingGroupRecommendations486Example:
                  summary: Default GetAutoScalingGroupRecommendations 486
                  x-microcks-default: true
                  value: example
        '487':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
              examples:
                GetAutoScalingGroupRecommendations487Example:
                  summary: Default GetAutoScalingGroupRecommendations 487
                  x-microcks-default: true
                  value: example
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetAutoScalingGroupRecommendationsRequest'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - ComputeOptimizerService.GetAutoScalingGroupRecommendations
      summary: Amazon Compute Optimizer Get Auto Scaling Group Recommendations
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=ComputeOptimizerService.GetAutoScalingGroupRecommendations'
components:
  schemas:
    InferredWorkloadTypes:
      type: array
      items:
        $ref: '#/components/schemas/InferredWorkloadType'
    ExternalMetricsPreference:
      type: object
      properties:
        source:
          allOf:
          - $ref: '#/components/schemas/ExternalMetricsSource'
          - description: ' Contains the source options for external metrics preferences. '
      description: ' Describes the external metrics preferences for EC2 rightsizing recommendations. '
    AutoScalingGroupArns:
      type: array
      items:
        $ref: '#/components/schemas/AutoScalingGroupArn'
    AutoScalingGroupRecommendations:
      type: array
      items:
        $ref: '#/components/schemas/AutoScalingGroupRecommendation'
    InternalServerException: {}
    ThrottlingException: {}
    Message:
      type: string
    ServiceUnavailableException: {}
    AccountId:
      type: string
    InstanceType:
      type: string
    MinSize:
      type: integer
    LookBackPeriodInDays:
      type: number
      format: double
    ProjectedUtilizationMetrics:
      type: array
      items:
        $ref: '#/components/schemas/UtilizationMetric'
    MigrationEffort:
      type: string
      enum:
      - VeryLow
      - Low
      - Medium
      - High
    Currency:
      type: string
      enum:
      - USD
      - CNY
    AutoScalingGroupRecommendation:
      type: object
      properties:
        accountId:
          allOf:
          - $ref: '#/components/schemas/AccountId'
          - description: The Amazon Web Services account ID of the Auto Scaling group.
        autoScalingGroupArn:
          allOf:
          - $ref: '#/components/schemas/AutoScalingGroupArn'
          - description: The Amazon Resource Name (ARN) of the Auto Scaling group.
        autoScalingGroupName:
          allOf:
          - $ref: '#/components/schemas/AutoScalingGroupName'
          - description: The name of the Auto Scaling group.
        finding:
          allOf:
          - $ref: '#/components/schemas/Finding'
          - description: <p>The finding classification of the Auto Scaling group.</p> <p>Findings for Auto Scaling groups include:</p> <ul> <li> <p> <b> <code>NotOptimized</code> </b>—An Auto Scaling group is considered not optimized when Compute Optimizer identifies a recommendation that can provide better performance for your workload.</p> </li> <li> <p> <b> <code>Optimized</code> </b>—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.</p> </li> </ul>
        utilizationMetrics:
          allOf:
          - $ref: '#/components/schemas/UtilizationMetrics'
          - description: An array of objects that describe the utilization metrics of the Auto Scaling group.
        lookBackPeriodInDays:
          allOf:
          - $ref: '#/components/schemas/LookBackPeriodInDays'
          - description: The number of days for which utilization metrics were analyzed for the Auto Scaling group.
        currentConfiguration:
          allOf:
          - $ref: '#/components/schemas/AutoScalingGroupConfiguration'
          - description: An array of objects that describe the current configuration of the Auto Scaling group.
        recommendationOptions:
          allOf:
          - $ref: '#/components/schemas/AutoScalingGroupRecommendationOptions'
          - description: An array of objects that describe the recommendation options for the Auto Scaling group.
        lastRefreshTimestamp:
          allOf:
          - $ref: '#/components/schemas/LastRefreshTimestamp'
          - description: The timestamp of when the Auto Scaling group recommendation was last generated.
        currentPerformanceRisk:
          allOf:
          - $ref: '#/components/schemas/CurrentPerformanceRisk'
          - description: 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.
        effectiveRecommendationPreferences:
          allOf:
          - $ref: '#/components/schemas/EffectiveRecommendationPreferences'
          - description: An object that describes the effective recommendation preferences for the Auto Scaling group.
        inferredWorkloadTypes:
          allOf:
          - $ref: '#/components/schemas/InferredWorkloadTypes'
          - description: <p>The applications that might be running on the instances in the Auto Scaling group as inferred by Compute Optimizer.</p> <p>Compute Optimizer can infer if one of the following applications might be running on the instances:</p> <ul> <li> <p> <code>AmazonEmr</code> - Infers that Amazon EMR might be running on the instances.</p> </li> <li> <p> <code>ApacheCassandra</code> - Infers that Apache Cassandra might be running on the instances.</p> </li> <li> <p> <code>ApacheHadoop</code> - Infers that Apache Hadoop might be running on the instances.</p> </li> <li> <p> <code>Memcached</code> - Infers that Memcached might be running on the instances.</p> </li> <li> <p> <code>NGINX</code> - Infers that NGINX might be running on the instances.</p> </li> <li> <p> <code>PostgreSql</code> - Infers that PostgreSQL might be running on the instances.</p> </li> <li> <p> <code>Redis</code> - Infers that Redis might be running on the instances.</p> </li> <li> <p> <code>Kafka</code> - Infers that Kafka might be running on the instance.</p> </li> <li> <p> <code>SQLServer</code> - Infers that SQLServer might be running on the instance.</p> </li> </ul>
      description: Describes an Auto Scaling group recommendation.
    MissingAuthenticationToken: {}
    CpuVendorArchitectures:
      type: array
      items:
        $ref: '#/components/schemas/CpuVendorArchitecture'
    MetricValue:
      type: number
      format: double
    Finding:
      type: string
      enum:
      - Underprovisioned
      - Overprovisioned
      - Optimized
      - NotOptimized
    MetricName:
      type: string
      enum:
      - 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
    AutoScalingGroupRecommendationOptions:
      type: array
      items:
        $ref: '#/components/schemas/AutoScalingGroupRecommendationOption'
    InferredWorkloadType:
      type: string
      enum:
      - AmazonEmr
      - ApacheCassandra
      - ApacheHadoop
      - Memcached
      - Nginx
      - PostgreSql
      - Redis
      - Kafka
      - SQLServer
    GetAutoScalingGroupRecommendationsResponse:
      type: object
      properties:
        nextToken:
          allOf:
          - $ref: '#/components/schemas/NextToken'
          - description: <p>The token to use to advance to the next page of Auto Scaling group recommendations.</p> <p>This value is null when there are no more pages of Auto Scaling group recommendations to return.</p>
        autoScalingGroupRecommendations:
          allOf:
          - $ref: '#/components/schemas/AutoScalingGroupRecommendations'
          - description: An array of objects that describe Auto Scaling group recommendations.
        errors:
          allOf:
          - $ref: '#/components/schemas/GetRecommendationErrors'
          - description: <p>An array of objects that describe errors of the request.</p> <p>For example, an error is returned if you request recommendations for an unsupported Auto Scaling group.</p>
    UtilizationMetrics:
      type: array
      items:
        $ref: '#/components/schemas/UtilizationMetric'
    Filter:
      type: object
      properties:
        name:
          allOf:
          - $ref: '#/components/schemas/FilterName'
          - description: <p>The name of the filter.</p> <p>Specify <code>Finding</code> to return recommendations with a specific finding classification. For example, <code>Underprovisioned</code>.</p> <p>Specify <code>RecommendationSourceType</code> to return recommendations of a specific resource type. For example, <code>Ec2Instance</code>.</p> <p>Specify <code>FindingReasonCodes</code> to return recommendations with a specific finding reason code. For example, <code>CPUUnderprovisioned</code>.</p> <p>Specify <code>InferredWorkloadTypes</code> to return recommendations of a specific inferred workload. For example, <code>Redis</code>.</p> <p>You can filter your EC2 instance recommendations by <code>tag:key</code> and <code>tag-key</code> tags.</p> <p>A <code>tag:key</code> is a key and value combination of a tag assigned to your recommendations. Use the tag key in the filter name and the tag value as the filter value. For example, to find all recommendations that have a tag with the key of <code>Owner</code> and the value of <code>TeamA</code>, specify <code>tag:Owner</code> for the filter name and <code>TeamA</code> for the filter value.</p> <p>A <code>tag-key</code> is the key of a tag assigned to your recommendations. Use this filter to find all of your recommendations that have a tag with a specific key. This doesn’t consider the tag value. For example, you can find your recommendations with a tag key value of <code>Owner</code> or without any tag keys assigned.</p>
        values:
          allOf:
          - $ref: '#/components/schemas/FilterValues'
          - description: <p>The value of the filter.</p> <p>The valid values for this parameter are as follows, depending on what you specify for the <code>name</code> parameter and the resource type that you wish to filter results for:</p> <ul> <li> <p>Specify <code>Optimized</code> or <code>NotOptimized</code> if you specify the <code>name</code> parameter as <code>Finding</code> and you want to filter results for Auto Scaling groups.</p> </li> <li> <p>Specify <code>Underprovisioned</code>, <code>Overprovisioned</code>, or <code>Optimized</code> if you specify the <code>name</code> parameter as <code>Finding</code> and you want to filter results for EC2 instances.</p> </li> <li> <p>Specify <code>Ec2Instance</code> or <code>AutoScalingGroup</code> if you specify the <code>name</code> parameter as <code>RecommendationSourceType</code>.</p> </li> <li> <p>Specify one of the following options if you specify the <code>name</code> parameter as <code>FindingReasonCodes</code>:</p> <ul> <li> <p> <b> <code>CPUOverprovisioned</code> </b> — The instance’s CPU configuration can be sized down while still meeting the performance requirements of your workload.</p> </li> <li> <p> <b> <code>CPUUnderprovisioned</code> </b> — 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.</p> </li> <li> <p> <b> <code>MemoryOverprovisioned</code> </b> — The instance’s memory configuration can be sized down while still meeting the performance requirements of your workload.</p> </li> <li> <p> <b> <code>MemoryUnderprovisioned</code> </b> — 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.</p> </li> <li> <p> <b> <code>EBSThroughputOverprovisioned</code> </b> — The instance’s EBS throughput configuration can be sized down while still meeting the performance requirements of your workload.</p> </li> <li> <p> <b> <code>EBSThroughputUnderprovisioned</code> </b> — 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.</p> </li> <li> <p> <b> <code>EBSIOPSOverprovisioned</code> </b> — The instance’s EBS IOPS configuration can be sized down while still meeting the performance requirements of your workload.</p> </li> <li> <p> <b> <code>EBSIOPSUnderprovisioned</code> </b> — 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.</p> </li> <li> <p> <b> <code>NetworkBandwidthOverprovisioned</code> </b> — The instance’s network bandwidth configuration can be sized down while still meeting the performance requirements of your workload.</p> </li> <li> <p> <b> <code>NetworkBandwidthUnderprovisioned</code> </b> — 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 <code>NetworkIn</code> or <code>NetworkOut</code> performance of an instance is impacted.</p> </li> <li> <p> <b> <code>NetworkPPSOverprovisioned</code> </b> — The instance’s network PPS (packets per second) configuration can be sized down while still meeting the performance requirements of your workload.</p> </li> <li> <p> <b> <code>NetworkPPSUnderprovisioned</code> </b> — 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.</p> </li> <li> <p> <b> <code>DiskIOPSOverprovisioned</code> </b> — The instance’s disk IOPS configuration can be sized down while still meeting the performance requirements of your workload.</p> </li> <li> <p> <b> <code>DiskIOPSUnderprovisioned</code> </b> — 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.</p> </li> <li> <p> <b> <code>DiskThroughputOverprovisioned</code> </b> — The instance’s disk throughput configuration can be sized down while still meeting the performance requirements of your workload.</p> </li> <li> <p> <b> <code>DiskThroughputUnderprovisioned</code> </b> — 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.</p> </li> </ul> </li> </ul>
      description: <p>Describes a filter that returns a more specific list of recommendations. Use this filter with the <a>GetAutoScalingGroupRecommendations</a> and <a>GetEC2InstanceRecommendations</a> actions.</p> <p>You can use <code>EBSFilter</code> with the <a>GetEBSVolumeRecommendations</a> action, <code>LambdaFunctionRecommendationFilter</code> with the <a>GetLambdaFunctionRecommendations</a> action, and <code>JobFilter</code> with the <a>DescribeRecommendationExportJobs</a> action.</p>
    AccountIds:
      type: array
      items:
        $ref: '#/components/schemas/AccountId'
    MaxSize:
      type: integer
    AutoScalingGroupArn:
      type: string
    DesiredCapacity:
      type: integer
    FilterName:
      type: string
      enum:
      - Finding
      - FindingReasonCodes
      - RecommendationSourceType
      - InferredWorkloadTypes
    FilterValues:
      type: array
      items:
        $ref: '#/components/schemas/FilterValue'
    CpuVendorArchitecture:
      type: string
      enum:
      - AWS_ARM64
      - CURRENT
    MaxResults:
      type: integer
      minimum: 0
      maximum: 1000
    MetricStatistic:
      type: string
      enum:
      - Maximum
      - Average
    SavingsOpportunity:
      type: object
      properties:
        savingsOpportunityPercentage:
          allOf:
          - $ref: '#/components/schemas/SavingsOpportunityPercentage'
          - description: The estimated monthly savings possible as a percentage of monthly cost by adopting Compute Optimizer recommendations for a given resource.
        estimatedMonthlySavings:
          allOf:
          - $ref: '#/components/schemas/EstimatedMonthlySavings'
          - description: An object that describes the estimated monthly savings amount possible by adopting Compute Optimizer recommendations for a given resource. This is based on the On-Demand instance pricing..
      description: <p>Describes the savings opportunity for recommendations of a given resource type or for the recommendation option of an individual resource.</p> <p>Savings opportunity represents the estimated monthly savings you can achieve by implementing a given Compute Optimizer recommendation.</p> <important> <p>Savings opportunity data requires that you opt in to Cost Explorer, as well as activate <b>Receive Amazon EC2 resource recommendations</b> in the Cost Explorer preferences page. That creates a connection between Cost Explorer and Compute Optimizer. With this connection, Cost Explorer generates savings estimates considering the price of existing resources, the price of recommended resources, and historical usage data. Estimated monthly savings reflects the projected dollar savings associated with each of the recommendations generated. For more information, see <a href="https://docs.aws.amazon.com/cost-management/latest/userguide/ce-enable.html">Enabling Cost Explorer</a> and <a href="https://docs.aws.amazon.com/cost-management/latest/userguide/ce-rightsizing.html">Optimizing your cost with Rightsizing Recommendations</a> in the <i>Cost Management User Guide</i>.</p> </important>
    Value:
      type: number
      format: double
    Filters:
      type: array
      items:
        $ref: '#/components/schemas/Filter'
    InferredWorkloadTypesPreference:
      type: string
      enum:
      - Active
      - Inactive
    InvalidParameterValueException: {}
    OptInRequiredException: {}
    EnhancedInfrastructureMetrics:
      type: string
      enum:
      - Active
      - Inactive
    CurrentPerformanceRisk:
      type: string
      enum:
      - VeryLow
      - Low
      - Medium
      - High
    AutoScalingGroupName:
      type: string
    EstimatedMonthlySavings:
      type: object
      properties:
        currency:
          allOf:
          - $ref: '#/components/schemas/Currency'
          - description: The currency of the estimated monthly savings.
        value:
          allOf:
          - $ref: '#/components/schemas/Value'
          - description: The value of the estimated monthly savings.
      description: <p>Describes the estimated monthly savings amount possible, based on On-Demand instance pricing, by adopting Compute Optimizer recommendations for a given resource.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/view-ec2-recommendations.html#ec2-savings-calculation">Estimated monthly savings and savings opportunities</a> in the <i>Compute Optimizer User Guide</i>.</p>
    ResourceNotFoundException: {}
    LastRefreshTimestamp:
      type: string
      format: date-time
    SavingsOpportunityPercentage:
      type: number
      format: double
    AccessDeniedException: {}
    Code:
      type: string
    GetRecommendationError:
      type: object
      properties:
        identifier:
          allOf:
          - $ref: '#/components/schemas/Identifier'
          - description: The ID of the error.
        code:
          allOf:
          - $ref: '#/components/schemas/Code'
          - description: The error code.
        message:
          allOf:
          - $ref: '#/components/schemas/Message'
          - description: The message, or reason, for the error.
      description: <p>Describes an error experienced when getting recommendations.</p> <p>For example, an error is returned if you request recommendations for an unsupported Auto Scaling group, or if you request recommendations for an instance of an unsupported instance family.</p>
    GetAutoScalingGroupRecommendationsRequest:
      type: object
      title: GetAutoScalingGroupRecommendationsRequest
      properties:
        accountIds:
          allOf:
          - $ref: '#/components/schemas/AccountIds'
          - description: <p>The ID of the Amazon Web Services account for which to return Auto Scaling group recommendations.</p> <p>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.</p> <p>Only one account ID can be specified per request.</p>
        autoScalingGroupArns:
          allOf:
          - $ref: '#/components/schemas/AutoScalingGroupArns'
          - description: The Amazon Resource Name (ARN) of the Auto Scaling groups for which to return recommendations.
        nextToken:
          allOf:
          - $ref: '#/components/schemas/NextToken'
          - description: The token to advance to the next page of Auto Scaling group recommendations.
        maxResults:
          allOf:
          - $ref: '#/components/schemas/MaxResults'
          - description: <p>The maximum number of Auto Scaling group recommendations to return with a single request.</p> <p>To retrieve the remaining results, make another request with the returned <code>nextToken</code> value.</p>
        filters:
          allOf:
          - $ref: '#/components/schemas/Filters'
          - description: An array of objects to specify a filter that returns a more specific list of Auto Scaling group recommendations.
        recommendationPreferences:
          allOf:
          - $ref: '#/components/schemas/RecommendationPreferences'
          - description: An object to specify the preferences for the Auto Scaling group recommendations to return in the response.
    UtilizationMetric:
      type: object
      properties:
        name:
          allOf:
          - $ref: '#/components/schemas/MetricName'
          - description: '<p>The name of the utilization metric.</p> <p>The following utilization metrics are available:</p> <ul> <li> <p> <code>Cpu</code> - 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.</p> <p>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.</p> <p>Units: Percent</p> </li> <li> <p> <code>Memory</code> - 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.</p> <p>Units: Percent</p> <note> <p>The <code>Memory</code> metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html#cw-agent">Enabling Memory Utilization with the CloudWatch Agent</a>.</p> </note> </li> <li> <p> <code>EBS_READ_OPS_PER_SECOND</code> - The completed read operations from all EBS volumes attached to the instance in a specified period of time.</p> <p>Unit: Count</p> </li> <li> <p> <code>EBS_WRITE_OPS_PER_SECOND</code> - The completed write operations to all EBS volumes attached to the instance in a specified period of time.</p> <p>Unit: Count</p> </li> <li> <p> <code>EBS_READ_BYTES_PER_SECOND</code> - The bytes read from all EBS volumes attached to the instance in a specified period of time.</p> <p>Unit: Bytes</p> </li> <li> <p> <code>EBS_WRITE_BYTES_PER_SECOND</code> - The bytes written to all EBS volumes attached to the instance in a specified period of time.</p> <p>Unit: Bytes</p> </li> <li> <p> <code>DISK_READ_OPS_PER_SECOND</code> - The completed read operations from all instance store volumes available to the instance in a specified period of time.</p> <p>If there are no instance store volumes, either the value is <code>0</code> or the metric is not reported.</p> </li> <li> <p> <code>DISK_WRITE_OPS_PER_SECOND</code> - The completed write operations from all instance store volumes available to the instance in a specified period of time.</p> <p>If there are no instance store volumes, either the value is <code>0</code> or the metric is not reported.</p> </li> <li> <p> <code>DISK_READ_BYTES_PER_SECOND</code> - 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.</p> <p>If there are no instance store volumes, either the value is <code>0</code> or the metric is not reported.</p> </li> <li> <p> <code>DISK_WRITE_BYTES_PER_SECOND</code> - 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.</p> <p>If there are no instance store volumes, either the value is <code>0</code> or the metric is not reported.</p> </li> <li> <p> <code>NETWORK_IN_BYTES_PER_SECOND</code> - 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.</p> </li> <li> <p> <code>NETWORK_OUT_BYTES_PER_SECOND</code> - 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.</p> </li> <li> <p> <code>NETWORK_PACKETS_IN_PER_SECOND</code> - 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.</p> </li> <li> <p> <code>NETWORK_PACKETS_OUT_PER_SECOND</code> - 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.</p> </li> </ul>'
        statistic:
          allOf:
          - $ref: '#/components/schemas/MetricStatistic'
          - description: <p>The statistic of the utilization metric.</p> <p>The Compute Optimizer API, Command Line Interface (CLI), and SDKs return utilization metrics using only the <code>Maximum</code> statistic, which is the highest value observed during the specified period.</p> <p>The Compute Optimizer console displays graphs for some utilization metrics using the <code>Average</code> statistic, which is the value of <code>Sum</code> / <code>SampleCount</code> during the specified period. For more information, see <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/viewing-recommendations.html">Viewing resource recommendations</a> in the <i>Compute Optimizer User Guide</i>. You can also get averaged utilization metric data for your resources using Amazon CloudWatch. For more information, see the <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html">Amazon CloudWatch User Guide</a>.</p>
        value:
          allOf:
          - $ref: '#/components/schemas/MetricValue'
          - description: The value of the utilization metric.
      description: <p>Describes a utilization metric of a resource, such as an Amazon EC2 instance.</p> <p>Compare the utilization metric data of your resource against its projected utilization metric data to determine the performance difference between your current resource and the recommended option.</p>
    EffectiveRecommendationPreferences:
      type: object
      properties:
        cpuVendorArchitectures:
          allOf:
          - $ref: '#/components/schemas/CpuVendorArchitectures'
          - description: <p>Describes the CPU vendor and architecture for an instance or Auto Scaling group recommendations.</p> <p>For example, when you specify <code>AWS_ARM64</code> with:</p> <ul> <li> <p>A <a>GetEC2InstanceRecommendations</a> or <a>GetAutoScalingGroupRecommendations</a> request, Compute Optimizer returns recommendations that consist of Graviton2 instance types only.</p> </li> <li> <p>A <a>GetEC2RecommendationProjectedMetrics</a> request, Compute Optimizer returns projected utilization metrics for Graviton2 instance type recommendations only.</p> </li> <li> <p>A <a>ExportEC2InstanceRecommendations</a> or <a>ExportAutoScalingGroupRecommendations</a> request, Compute Optimizer exports recommendations that consist of Graviton2 instance types only.</p> </li> </ul>
        enhancedInfrastructureMetrics:
          allOf:
          - $ref: '#/components/schemas/EnhancedInfrastructureMetrics'
          - description: <p>Describes the activation status of the enhanced infrastructure metrics preference.</p> <p>A status of <code>Active</code> confirms that the preference is applied in the latest recommendation refresh, and a status of <code>Inactive</code> confirms that it's not yet applied to recommendations.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/enhanced-infrastructure-metrics.html">Enhanced infrastructure metrics</a> in the <i>Compute Optimizer User Guide</i>.</p>
        inferredWorkloadTypes:
          allOf:
          - $ref: '#/components/schemas/InferredWorkloadTypesPreference'
          - description: <p>Describes the activation status of the inferred workload types preference.</p> <p>A status of <code>Active</code> confirms that the preference is applied in the latest recommendation refresh. A status of <code>Inactive</code> confirms that it's not yet applied to recommendations.</p>
        externalMetricsPreference:
          allOf:
          - $ref: '#/components/schemas/ExternalMetricsPreference'
          - description: <p> An object that describes the external metrics recommendation preference. </p> <p> If the preference is applied in the latest recommendation refresh, an object with a valid <code>source</code> value appears in the response. If the preference isn't applied to the recommendations already, then this object doesn't appear in the response. </p>
      description: Describes the effective recommendation preferences for a resource.
    NextToken:
      type: string
    AutoScalingGroupConfiguration:
      type: object
      properties:
        desiredCapacity:
          allOf:
          - $ref: '#/components/schemas/DesiredCapacity'
          - description: The desired capacity, or number of instances, for the Auto Scaling group.
        minSize:
          allOf:
          - $ref: '#/components/schemas/MinSize'
          - description: The minimum size, or minimum number of instances, for the Auto Scaling group.
        maxSize:
          allOf:
          - $ref: '#/components/schemas/MaxSize'
          - description: The maximum size, or maximum number of instances, for the Auto Scaling group.
        instanceType:
          allOf:
          - $ref: '#/components/schemas/InstanceType'
          - description: The instance type for the Auto Scaling group.
      description: Describes the configuration of an Auto Scaling group.
    GetRecommendationErrors:
      type: array
      items:
        $ref: '#/components/schemas/GetRecommendationError'
    Identifier:
      type: string
    FilterValue:
      type: string
    Rank:
      type: integer
    ExternalMetricsSource:
      type: string
      enum:
      - Datadog
      - Dynatrace
      - NewRelic
      - Instana
    PerformanceRisk:
      type: number
      format: double
      minimum: 0
      maximum: 4
    RecommendationPreferences:
      type: object
      properties:
        cpuVendorArchitectures:
          allOf:
          - $ref: '#/components/schemas/CpuVendorArchitectures'
          - description: <p>Specifies the CPU vendor and architecture for Amazon EC2 instance and Auto Scaling group recommendations.</p> <p>For example, when you specify <code>AWS_ARM64</code> with:</p> <ul> <li> <p>A <a>GetEC2InstanceRecommendations</a> or <a>GetAutoScalingGroupRecommendations</a> request, Compute Optimizer returns recommendations that consist of Graviton2 instance types only.</p> </li> <li> <p>A <a>GetEC2RecommendationProjectedMetrics</a> request, Compute Optimizer returns projected utilization metrics for Graviton2 instance type recommendations only.</p> </li> <li> <p>A <a>ExportEC2InstanceRecommendations</a> or <a>ExportAutoScalingGroupRecommendations</a> request, Compute Optimizer exports recommendations that consist of Graviton2 instance types only.</p> </li> </ul>
      description: Describes the recommendation preferences to return in the response of a <a>GetAutoScalingGroupRecommendations</a>, <a>GetEC2InstanceRecommendations</a>, and <a>GetEC2RecommendationProjectedMetrics</a> request.
    AutoScalingGroupRecommendationOption:
      type: object
      properties:
        configuration:
          allOf:
          - $ref: '#/components/schemas/AutoScalingGroupConfiguration'
          - description: An array of objects that describe an Auto Scaling group configuration.
        projectedUtilizationMetrics:
          allOf:
          - $ref: '#/components/schemas/ProjectedUtilizationMetrics'
          - description: <p>An array of objects that describe the projected utilization metrics of the Auto Scaling group recommendation option.</p> <note> <p>The <code>Cpu</code> and <code>Memory</code> metrics are the only projected utilization metrics returned. Additionally, the <code>Memory</code> metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html#cw-agent">Enabling Memory Utilization with the CloudWatch Agent</a>.</p> </note>
        performanceRisk:
          allOf:
          - $ref: '#/components/schemas/PerformanceRisk'
          - description: <p>The performance risk of the Auto Scaling group configuration recommendation.</p> <p>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.</p> <p>The value ranges from <code>0</code> - <code>4</code>, with <code>0</code> 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.</p>
        rank:
          allOf:
          - $ref: '#/components/schemas/Rank'
          - description: <p>The rank of the Auto Scaling group recommendation option.</p> <p>The top recommendation option is ranked as <code>1</code>.</p>
        savingsOpportunity:
          allOf:
          - $ref: '#/components/schemas/SavingsOpportunity'
          - description: An object that describes the savings opportunity for the Auto Scaling group recommendation option. Savings opportunity includes the estimated monthly savings amount and percentage.
        migrationEffort:
          allOf:
          - $ref: '#/components/schemas/MigrationEffort'
          - description: <p>The level of effort required to migrate from the current instance type to the recommended instance type.</p> <p>For example, the migration effort is <code>Low</code> if Amazon EMR is the inferred workload type and an Amazon Web Services Graviton instance type is recommended. The migration effort is <code>Medium</code> if a workload type couldn't be inferred but an Amazon Web Services Graviton instance type is recommended. The migration effort is <code>VeryLow</code> if both the current and recommended instance types are of the same CPU architecture.</p>
      description: Describes a recommendation option for an Auto Scaling group.
  parameters:
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/compute-optimizer/
x-hasEquivalentPaths: true