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.GetECSServiceRecommendations 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.GetECSServiceRecommendations'
paths:
  /#X-Amz-Target=ComputeOptimizerService.GetECSServiceRecommendations:
    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: GetECSServiceRecommendations
      description: <p> Returns Amazon ECS service recommendations. </p> <p> Compute Optimizer generates recommendations for Amazon ECS services on Fargate 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/GetECSServiceRecommendationsResponse'
              examples:
                GetECSServiceRecommendations200Example:
                  summary: Default GetECSServiceRecommendations 200
                  x-microcks-default: true
                  value:
                    nextToken: example
                    ecsServiceRecommendations: example
                    errors: example
        '480':
          description: OptInRequiredException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OptInRequiredException'
              examples:
                GetECSServiceRecommendations480Example:
                  summary: Default GetECSServiceRecommendations 480
                  x-microcks-default: true
                  value: example
        '481':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
              examples:
                GetECSServiceRecommendations481Example:
                  summary: Default GetECSServiceRecommendations 481
                  x-microcks-default: true
                  value: example
        '482':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
              examples:
                GetECSServiceRecommendations482Example:
                  summary: Default GetECSServiceRecommendations 482
                  x-microcks-default: true
                  value: example
        '483':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
              examples:
                GetECSServiceRecommendations483Example:
                  summary: Default GetECSServiceRecommendations 483
                  x-microcks-default: true
                  value: example
        '484':
          description: InvalidParameterValueException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
              examples:
                GetECSServiceRecommendations484Example:
                  summary: Default GetECSServiceRecommendations 484
                  x-microcks-default: true
                  value: example
        '485':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
              examples:
                GetECSServiceRecommendations485Example:
                  summary: Default GetECSServiceRecommendations 485
                  x-microcks-default: true
                  value: example
        '486':
          description: MissingAuthenticationToken
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MissingAuthenticationToken'
              examples:
                GetECSServiceRecommendations486Example:
                  summary: Default GetECSServiceRecommendations 486
                  x-microcks-default: true
                  value: example
        '487':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
              examples:
                GetECSServiceRecommendations487Example:
                  summary: Default GetECSServiceRecommendations 487
                  x-microcks-default: true
                  value: example
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetECSServiceRecommendationsRequest'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - ComputeOptimizerService.GetECSServiceRecommendations
      summary: Amazon Compute Optimizer Get E C S Service Recommendations
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=ComputeOptimizerService.GetECSServiceRecommendations'
components:
  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
  schemas:
    ContainerRecommendation:
      type: object
      properties:
        containerName:
          allOf:
          - $ref: '#/components/schemas/ContainerName'
          - description: ' The name of the container. '
        memorySizeConfiguration:
          allOf:
          - $ref: '#/components/schemas/MemorySizeConfiguration'
          - description: ' The recommended memory size configurations for the container. '
        cpu:
          allOf:
          - $ref: '#/components/schemas/NullableCpu'
          - description: ' The recommended number of CPU units reserved for the container. '
      description: ' The CPU and memory recommendations for a container within the tasks of your Amazon ECS service. '
    ECSServiceRecommendationFindingReasonCodes:
      type: array
      items:
        $ref: '#/components/schemas/ECSServiceRecommendationFindingReasonCode'
    InternalServerException: {}
    ECSServiceRecommendationFilter:
      type: object
      properties:
        name:
          allOf:
          - $ref: '#/components/schemas/ECSServiceRecommendationFilterName'
          - description: <p> The name of the filter. </p> <p> Specify <code>Finding</code> to return recommendations with a specific finding classification. </p> <p> Specify <code>FindingReasonCode</code> to return recommendations with a specific finding reason code. </p> <p>You can filter your Amazon ECS service 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 Amazon ECS service recommendations. Use the tag key in the filter name and the tag value as the filter value. For example, to find all Amazon ECS service 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 Amazon ECS service recommendations. Use this filter to find all of your Amazon ECS service recommendations that have a tag with a specific key. This doesn’t consider the tag value. For example, you can find your Amazon ECS service 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:</p> <ul> <li> <p>If you specify the <code>name</code> parameter as <code>Finding</code>, specify <code>Optimized</code>, <code>NotOptimized</code>, or <code>Unavailable</code>.</p> </li> <li> <p>If you specify the <code>name</code> parameter as <code>FindingReasonCode</code>, specify <code>CPUUnderprovisioned</code>, <code>CPUOverprovisioned</code>, <code>MemoryUnderprovisioned</code>, or <code>MemoryOverprovisioned</code>.</p> </li> </ul>
      description: ' Describes a filter that returns a more specific list of Amazon ECS service recommendations. Use this filter with the <a>GetECSServiceRecommendations</a> action. '
    ECSServiceRecommendationFilters:
      type: array
      items:
        $ref: '#/components/schemas/ECSServiceRecommendationFilter'
    ThrottlingException: {}
    Message:
      type: string
    LookBackPeriodInDays:
      type: number
      format: double
    AccountId:
      type: string
    ServiceUnavailableException: {}
    TagValue:
      type: string
    ContainerConfigurations:
      type: array
      items:
        $ref: '#/components/schemas/ContainerConfiguration'
    Currency:
      type: string
      enum:
      - USD
      - CNY
    GetECSServiceRecommendationsRequest:
      type: object
      title: GetECSServiceRecommendationsRequest
      properties:
        serviceArns:
          allOf:
          - $ref: '#/components/schemas/ServiceArns'
          - description: '<p> The ARN that identifies the Amazon ECS service. </p> <p> The following is the format of the ARN: </p> <p> <code>arn:aws:ecs:region:aws_account_id:service/cluster-name/service-name</code> </p>'
        nextToken:
          allOf:
          - $ref: '#/components/schemas/NextToken'
          - description: ' The token to advance to the next page of Amazon ECS service recommendations. '
        maxResults:
          allOf:
          - $ref: '#/components/schemas/MaxResults'
          - description: <p> The maximum number of Amazon ECS service 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/ECSServiceRecommendationFilters'
          - description: ' An array of objects to specify a filter that returns a more specific list of Amazon ECS service recommendations. '
        accountIds:
          allOf:
          - $ref: '#/components/schemas/AccountIds'
          - description: <p> Return the Amazon ECS service recommendations to the specified Amazon Web Services account IDs. </p> <p>If your account is the management account or the delegated administrator of an organization, use this parameter to return the Amazon ECS service recommendations to specific member accounts.</p> <p>You can only specify one account ID per request.</p>
    ECSServiceLaunchType:
      type: string
      enum:
      - EC2
      - Fargate
    Tag:
      type: object
      properties:
        key:
          allOf:
          - $ref: '#/components/schemas/TagKey'
          - description: ' One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values. '
        value:
          allOf:
          - $ref: '#/components/schemas/TagValue'
          - description: ' One part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key). The value can be empty or null. '
      description: ' A list of tag key and value pairs that you define. '
    LowerBoundValue:
      type: number
      format: double
    ContainerRecommendations:
      type: array
      items:
        $ref: '#/components/schemas/ContainerRecommendation'
    MissingAuthenticationToken: {}
    MetricValue:
      type: number
      format: double
    NullableMemory:
      type: integer
    ECSServiceUtilizationMetrics:
      type: array
      items:
        $ref: '#/components/schemas/ECSServiceUtilizationMetric'
    ContainerConfiguration:
      type: object
      properties:
        containerName:
          allOf:
          - $ref: '#/components/schemas/ContainerName'
          - description: ' The name of the container. '
        memorySizeConfiguration:
          allOf:
          - $ref: '#/components/schemas/MemorySizeConfiguration'
          - description: ' The memory size configurations for the container. '
        cpu:
          allOf:
          - $ref: '#/components/schemas/NullableCpu'
          - description: ' The number of CPU units reserved for the container. '
      description: ' Describes the container configurations within the tasks of your Amazon ECS service. '
    NullableMemoryReservation:
      type: integer
    AccountIds:
      type: array
      items:
        $ref: '#/components/schemas/AccountId'
    AutoScalingConfiguration:
      type: string
      enum:
      - TargetTrackingScalingCpu
      - TargetTrackingScalingMemory
    GetECSServiceRecommendationsResponse:
      type: object
      properties:
        nextToken:
          allOf:
          - $ref: '#/components/schemas/NextToken'
          - description: ' The token to advance to the next page of Amazon ECS service recommendations. '
        ecsServiceRecommendations:
          allOf:
          - $ref: '#/components/schemas/ECSServiceRecommendations'
          - description: ' An array of objects that describe the Amazon ECS service recommendations. '
        errors:
          allOf:
          - $ref: '#/components/schemas/GetRecommendationErrors'
          - description: ' An array of objects that describe errors of the request. '
    ECSServiceRecommendationOption:
      type: object
      properties:
        memory:
          allOf:
          - $ref: '#/components/schemas/NullableMemory'
          - description: ' The memory size of the Amazon ECS service recommendation option. '
        cpu:
          allOf:
          - $ref: '#/components/schemas/NullableCpu'
          - description: ' The CPU size of the Amazon ECS service recommendation option. '
        savingsOpportunity:
          $ref: '#/components/schemas/SavingsOpportunity'
        projectedUtilizationMetrics:
          allOf:
          - $ref: '#/components/schemas/ECSServiceProjectedUtilizationMetrics'
          - description: ' An array of objects that describe the projected utilization metrics of the Amazon ECS service recommendation option. '
        containerRecommendations:
          allOf:
          - $ref: '#/components/schemas/ContainerRecommendations'
          - description: ' The CPU and memory size recommendations for the containers within the task of your Amazon ECS service. '
      description: ' Describes the recommendation options for an Amazon ECS service. '
    ECSServiceRecommendationOptions:
      type: array
      items:
        $ref: '#/components/schemas/ECSServiceRecommendationOption'
    ECSServiceProjectedUtilizationMetrics:
      type: array
      items:
        $ref: '#/components/schemas/ECSServiceProjectedUtilizationMetric'
    FilterValues:
      type: array
      items:
        $ref: '#/components/schemas/FilterValue'
    ECSServiceRecommendations:
      type: array
      items:
        $ref: '#/components/schemas/ECSServiceRecommendation'
    MaxResults:
      type: integer
      minimum: 0
      maximum: 1000
    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
    InvalidParameterValueException: {}
    OptInRequiredException: {}
    TaskDefinitionArn:
      type: string
    CurrentPerformanceRisk:
      type: string
      enum:
      - VeryLow
      - Low
      - Medium
      - High
    NullableCpu:
      type: integer
    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>
    ECSServiceMetricStatistic:
      type: string
      enum:
      - Maximum
      - Average
    ResourceNotFoundException: {}
    LastRefreshTimestamp:
      type: string
      format: date-time
    SavingsOpportunityPercentage:
      type: number
      format: double
    UpperBoundValue:
      type: number
      format: double
    Code:
      type: string
    AccessDeniedException: {}
    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>
    ServiceArns:
      type: array
      items:
        $ref: '#/components/schemas/ServiceArn'
    ECSServiceRecommendationFinding:
      type: string
      enum:
      - Optimized
      - Underprovisioned
      - Overprovisioned
    ECSServiceUtilizationMetric:
      type: object
      properties:
        name:
          allOf:
          - $ref: '#/components/schemas/ECSServiceMetricName'
          - description: <p> The name of the utilization metric. </p> <p>The following utilization metrics are available:</p> <ul> <li> <p> <code>Cpu</code> — The amount of CPU capacity that's used in the service.</p> </li> <li> <p> <code>Memory</code> — The amount of memory that's used in the service.</p> </li> </ul>
        statistic:
          allOf:
          - $ref: '#/components/schemas/ECSServiceMetricStatistic'
          - 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 the utilization metric of an Amazon ECS service. </p> <p>To determine the performance difference between your current Amazon ECS service and the recommended option, compare the utilization metric data of your service against its projected utilization metric data.</p>
    ServiceConfiguration:
      type: object
      properties:
        memory:
          allOf:
          - $ref: '#/components/schemas/NullableMemory'
          - description: ' The amount of memory used by the tasks in the Amazon ECS service. '
        cpu:
          allOf:
          - $ref: '#/components/schemas/NullableCpu'
          - description: ' The number of CPU units used by the tasks in the Amazon ECS service. '
        containerConfigurations:
          allOf:
          - $ref: '#/components/schemas/ContainerConfigurations'
          - description: ' The container configurations within a task of an Amazon ECS service. '
        autoScalingConfiguration:
          allOf:
          - $ref: '#/components/schemas/AutoScalingConfiguration'
          - description: <p> Describes the Auto Scaling configuration methods for an Amazon ECS service. This affects the generated recommendations. For example, if Auto Scaling is configured on a service’s CPU, then Compute Optimizer doesn’t generate CPU size recommendations. </p> <p>The Auto Scaling configuration methods include:</p> <ul> <li> <p> <code>TARGET_TRACKING_SCALING_CPU</code> — If the Amazon ECS service is configured to use target scaling on CPU, Compute Optimizer doesn't generate CPU recommendations.</p> </li> <li> <p> <code>TARGET_TRACKING_SCALING_MEMORY</code> — If the Amazon ECS service is configured to use target scaling on memory, Compute Optimizer doesn't generate memory recommendations.</p> </li> </ul> <p>For more information about step scaling and target scaling, see <a href="https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html"> Step scaling policies for Application Auto Scaling</a> and <a href="https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html"> Target tracking scaling policies for Application Auto Scaling</a> in the <i>Application Auto Scaling User Guide</i>.</p>
        taskDefinitionArn:
          allOf:
          - $ref: '#/components/schemas/TaskDefinitionArn'
          - description: ' The task definition ARN used by the tasks in the Amazon ECS service. '
      description: ' The Amazon ECS service configurations used for recommendations. '
    NextToken:
      type: string
    Tags:
      type: array
      items:
        $ref: '#/components/schemas/Tag'
    ServiceArn:
      type: string
    GetRecommendationErrors:
      type: array
      items:
        $ref: '#/components/schemas/GetRecommendationError'
    Identifier:
      type: string
    ContainerName:
      type: string
    ECSServiceProjectedUtilizationMetric:
      type: object
      properties:
        name:
          allOf:
          - $ref: '#/components/schemas/ECSServiceMetricName'
          - description: <p> The name of the projected utilization metric. </p> <p>The following utilization metrics are available:</p> <ul> <li> <p> <code>Cpu</code> — The percentage of allocated compute units that are currently in use on the service tasks.</p> </li> <li> <p> <code>Memory</code> — The percentage of memory that's currently in use on the service tasks.</p> </li> </ul>
        statistic:
          allOf:
          - $ref: '#/components/schemas/ECSServiceMetricStatistic'
          - description: <p>The statistic of the projected 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>
        lowerBoundValue:
          allOf:
          - $ref: '#/components/schemas/LowerBoundValue'
          - description: ' The lower bound values for the projected utilization metrics. '
        upperBoundValue:
          allOf:
          - $ref: '#/components/schemas/UpperBoundValue'
          - description: ' The upper bound values for the projected utilization metrics. '
      description: <p> Describes the projected utilization metrics of an Amazon ECS service recommendation option. </p> <p>To determine the performance difference between your current Amazon ECS service and the recommended option, compare the utilization metric data of your service against its projected utilization metric data.</p>
    FilterValue:
      type: string
    ECSServiceRecommendation:
      type: object
      properties:
        serviceArn:
          allOf:
          - $ref: '#/components/schemas/ServiceArn'
          - description: '<p> The Amazon Resource Name (ARN) of the current Amazon ECS service. </p> <p> The following is the format of the ARN: </p> <p> <code>arn:aws:ecs:region:aws_account_id:service/cluster-name/service-name</code> </p>'
        accountId:
          allOf:
          - $ref: '#/components/schemas/AccountId'
          - description: ' The Amazon Web Services account ID of the Amazon ECS service. '
        currentServiceConfiguration:
          allOf:
          - $ref: '#/components/schemas/ServiceConfiguration'
          - description: ' The configuration of the current Amazon ECS service. '
        utilizationMetrics:
          allOf:
          - $ref: '#/components/schemas/ECSServiceUtilizationMetrics'
          - description: ' An array of objects that describe the utilization metrics of the Amazon ECS service. '
        lookbackPeriodInDays:
          allOf:
          - $ref: '#/components/schemas/LookBackPeriodInDays'
          - description: ' The number of days the Amazon ECS service utilization metrics were analyzed. '
        launchType:
          allOf:
          - $ref: '#/components/schemas/ECSServiceLaunchType'
          - description: <p> The launch type the Amazon ECS service is using. </p> <note> <p>Compute Optimizer only supports the Fargate launch type.</p> </note>
        lastRefreshTimestamp:
          allOf:
          - $ref: '#/components/schemas/LastRefreshTimestamp'
          - description: ' The timestamp of when the Amazon ECS service recommendation was last generated. '
        finding:
          allOf:
          - $ref: '#/components/schemas/ECSServiceRecommendationFinding'
          - description: <p> The finding classification of an Amazon ECS service. </p> <p>Findings for Amazon ECS services include:</p> <ul> <li> <p> <b> <code>Underprovisioned</code> </b> — When Compute Optimizer detects that there’s not enough memory or CPU, an Amazon ECS service is considered under-provisioned. An under-provisioned service might result in poor application performance.</p> </li> <li> <p> <b> <code>Overprovisioned</code> </b> — When Compute Optimizer detects that there’s excessive memory or CPU, an Amazon ECS service is considered over-provisioned. An over-provisioned service might result in additional infrastructure costs. </p> </li> <li> <p> <b> <code>Optimized</code> </b> — When both the CPU and memory of your Amazon ECS service meet the performance requirements of your workload, the service is considered optimized.</p> </li> </ul>
        findingReasonCodes:
          allOf:
          - $ref: '#/components/schemas/ECSServiceRecommendationFindingReasonCodes'
          - description: <p> The reason for the finding classification of an Amazon ECS service. </p> <p>Finding reason codes for Amazon ECS services include:</p> <ul> <li> <p> <b> <code>CPUUnderprovisioned</code> </b> — The service CPU configuration can be sized up to enhance the performance of your workload. This is identified by analyzing the <code>CPUUtilization</code> metric of the current service during the look-back period.</p> </li> <li> <p> <b> <code>CPUOverprovisioned</code> </b> — The service CPU configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the <code>CPUUtilization</code> metric of the current service during the look-back period. </p> </li> <li> <p> <b> <code>MemoryUnderprovisioned</code> </b> — The service memory configuration can be sized up to enhance the performance of your workload. This is identified by analyzing the <code>MemoryUtilization</code> metric of the current service during the look-back period.</p> </li> <li> <p> <b> <code>MemoryOverprovisioned</code> </b> — The service memory configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the <code>MemoryUtilization</code> metric of the current service during the look-back period.</p> </li> </ul>
        serviceRecommendationOptions:
          allOf:
          - $ref: '#/components/schemas/ECSServiceRecommendationOptions'
          - description: ' An array of objects that describe the recommendation options for the Amazon ECS service. '
        currentPerformanceRisk:
          allOf:
          - $ref: '#/components/schemas/CurrentPerformanceRisk'
          - description: ' The risk of the current Amazon ECS service not meeting the performance needs of its workloads. The higher the risk, the more likely the current service can''t meet the performance requirements of its workload. '
        tags:
          allOf:
          - $ref: '#/components/schemas/Tags'
          - description: ' A list of tags assigned to your Amazon ECS service recommendations. '
      description: ' Describes an Amazon ECS service recommendation. '
    TagKey:
      type: string
    MemorySizeConfiguration:
      type: object
      properties:
        memory:
          allOf:
          - $ref: '#/components/schemas/NullableMemory'
          - description: ' The amount of memory in the container. '
        memoryReservation:
          allOf:
          - $ref: '#/components/schemas/NullableMemoryReservation'
          - description: ' The limit of memory reserve for the container. '
      description: ' The memory size configurations of a container. '
    ECSServiceMetricName:
      type: string
      enum:
      - Cpu
      - Memory
    ECSServiceRecommendationFilterName:
      type: string
      enum:
      - Finding
      - FindingReasonCode
    ECSServiceRecommendationFindingReasonCode:
      type: string
      enum:
      - MemoryOverprovisioned
      - MemoryUnderprovisioned
      - CPUOverprovisioned
      - CPUUnderprovisioned
  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