Amazon Compute Optimizer #X Amz Target=ComputeOptimizerService.GetECSServiceRecommendationProjectedMetrics API

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.GetECSServiceRecommendationProjectedMetrics 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.GetECSServiceRecommendationProjectedMetrics'
paths:
  /#X-Amz-Target=ComputeOptimizerService.GetECSServiceRecommendationProjectedMetrics:
    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: GetECSServiceRecommendationProjectedMetrics
      description: ' Returns the projected metrics of Amazon ECS service recommendations. '
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetECSServiceRecommendationProjectedMetricsResponse'
              examples:
                GetECSServiceRecommendationProjectedMetrics200Example:
                  summary: Default GetECSServiceRecommendationProjectedMetrics 200
                  x-microcks-default: true
                  value:
                    recommendedOptionProjectedMetrics: example
        '480':
          description: OptInRequiredException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OptInRequiredException'
              examples:
                GetECSServiceRecommendationProjectedMetrics480Example:
                  summary: Default GetECSServiceRecommendationProjectedMetrics 480
                  x-microcks-default: true
                  value: example
        '481':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
              examples:
                GetECSServiceRecommendationProjectedMetrics481Example:
                  summary: Default GetECSServiceRecommendationProjectedMetrics 481
                  x-microcks-default: true
                  value: example
        '482':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
              examples:
                GetECSServiceRecommendationProjectedMetrics482Example:
                  summary: Default GetECSServiceRecommendationProjectedMetrics 482
                  x-microcks-default: true
                  value: example
        '483':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
              examples:
                GetECSServiceRecommendationProjectedMetrics483Example:
                  summary: Default GetECSServiceRecommendationProjectedMetrics 483
                  x-microcks-default: true
                  value: example
        '484':
          description: InvalidParameterValueException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
              examples:
                GetECSServiceRecommendationProjectedMetrics484Example:
                  summary: Default GetECSServiceRecommendationProjectedMetrics 484
                  x-microcks-default: true
                  value: example
        '485':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
              examples:
                GetECSServiceRecommendationProjectedMetrics485Example:
                  summary: Default GetECSServiceRecommendationProjectedMetrics 485
                  x-microcks-default: true
                  value: example
        '486':
          description: MissingAuthenticationToken
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MissingAuthenticationToken'
              examples:
                GetECSServiceRecommendationProjectedMetrics486Example:
                  summary: Default GetECSServiceRecommendationProjectedMetrics 486
                  x-microcks-default: true
                  value: example
        '487':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
              examples:
                GetECSServiceRecommendationProjectedMetrics487Example:
                  summary: Default GetECSServiceRecommendationProjectedMetrics 487
                  x-microcks-default: true
                  value: example
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetECSServiceRecommendationProjectedMetricsRequest'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - ComputeOptimizerService.GetECSServiceRecommendationProjectedMetrics
      summary: Amazon Compute Optimizer Get E C S Service Recommendation Projected Metrics
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=ComputeOptimizerService.GetECSServiceRecommendationProjectedMetrics'
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:
    Period:
      type: integer
    InternalServerException: {}
    MetricValues:
      type: array
      items:
        $ref: '#/components/schemas/MetricValue'
    ThrottlingException: {}
    ServiceUnavailableException: {}
    ECSServiceProjectedMetric:
      type: object
      properties:
        name:
          allOf:
          - $ref: '#/components/schemas/ECSServiceMetricName'
          - description: <p> The name of the projected metric. </p> <p>The following 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>
        timestamps:
          allOf:
          - $ref: '#/components/schemas/Timestamps'
          - description: ' The timestamps of the projected metric. '
        upperBoundValues:
          allOf:
          - $ref: '#/components/schemas/MetricValues'
          - description: ' The upper bound values for the projected metric. '
        lowerBoundValues:
          allOf:
          - $ref: '#/components/schemas/MetricValues'
          - description: ' The lower bound values for the projected metric. '
      description: <p> Describes the projected 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 metric data of your service against its projected metric data.</p>
    MemorySize:
      type: integer
    MissingAuthenticationToken: {}
    MetricValue:
      type: number
      format: double
    GetECSServiceRecommendationProjectedMetricsRequest:
      type: object
      required:
      - serviceArn
      - stat
      - period
      - startTime
      - endTime
      title: GetECSServiceRecommendationProjectedMetricsRequest
      properties:
        serviceArn:
          allOf:
          - $ref: '#/components/schemas/ServiceArn'
          - 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>'
        stat:
          allOf:
          - $ref: '#/components/schemas/MetricStatistic'
          - description: ' The statistic of the projected metrics. '
        period:
          allOf:
          - $ref: '#/components/schemas/Period'
          - description: ' The granularity, in seconds, of the projected metrics data points. '
        startTime:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: ' The timestamp of the first projected metrics data point to return. '
        endTime:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: ' The timestamp of the last projected metrics data point to return. '
    ECSServiceProjectedMetrics:
      type: array
      items:
        $ref: '#/components/schemas/ECSServiceProjectedMetric'
    OptInRequiredException: {}
    MetricStatistic:
      type: string
      enum:
      - Maximum
      - Average
    InvalidParameterValueException: {}
    ECSServiceRecommendedOptionProjectedMetrics:
      type: array
      items:
        $ref: '#/components/schemas/ECSServiceRecommendedOptionProjectedMetric'
    ResourceNotFoundException: {}
    AccessDeniedException: {}
    ECSServiceRecommendedOptionProjectedMetric:
      type: object
      properties:
        recommendedCpuUnits:
          allOf:
          - $ref: '#/components/schemas/CpuSize'
          - description: ' The recommended CPU size for the Amazon ECS service. '
        recommendedMemorySize:
          allOf:
          - $ref: '#/components/schemas/MemorySize'
          - description: ' The recommended memory size for the Amazon ECS service. '
        projectedMetrics:
          allOf:
          - $ref: '#/components/schemas/ECSServiceProjectedMetrics'
          - description: ' An array of objects that describe the projected metric. '
      description: <p> Describes the projected 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 metric data of your service against its projected metric data.</p>
    Timestamp:
      type: string
      format: date-time
    ServiceArn:
      type: string
    GetECSServiceRecommendationProjectedMetricsResponse:
      type: object
      properties:
        recommendedOptionProjectedMetrics:
          allOf:
          - $ref: '#/components/schemas/ECSServiceRecommendedOptionProjectedMetrics'
          - description: ' An array of objects that describes the projected metrics. '
    Timestamps:
      type: array
      items:
        $ref: '#/components/schemas/Timestamp'
    ECSServiceMetricName:
      type: string
      enum:
      - Cpu
      - Memory
    CpuSize:
      type: integer
  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