Amazon Lightsail Cost Estimate API

openapi: 3.1.0
info:
  title: Amazon Lightsail Cost Estimate API
  version: '2016-11-28'
  description: Generated from AWS's published Smithy model for Amazon Lightsail. 1 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://lightsail.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /#GetCostEstimate:
    post:
      operationId: GetCostEstimate
      summary: Get Cost Estimate
      description: Retrieves information about the cost estimate for a specified resource. A cost estimate will not generate
        for a resource that has been deleted.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/GetCostEstimateResult'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: InvalidInputException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidInputException'
        '404':
          description: NotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '428':
          description: RegionSetupInProgressException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/RegionSetupInProgressException'
        '500':
          description: ServiceException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ServiceException'
        '401':
          description: UnauthenticatedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UnauthenticatedException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - Lightsail_20161128.GetCostEstimate
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/GetCostEstimateRequest'
      tags:
      - Cost Estimate
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: lightsail
  schemas:
    AccessDeniedException:
      type: object
      properties:
        code:
          type: string
        docs:
          type: string
        message:
          type: string
        tip:
          type: string
    CostEstimate:
      type: object
      properties:
        usageType:
          type: string
          description: The types of usage that are included in the estimate, such as costs, usage, or data transfer.
        resultsByTime:
          type: array
          items:
            $ref: '#/components/schemas/EstimateByTime'
          description: The cost estimate result that's associated with a time period.
    EstimateByTime:
      type: object
      properties:
        usageCost:
          type: number
          description: The amount of cost or usage that's measured for the cost estimate.
        pricingUnit:
          type: string
          enum:
          - GB
          - Hrs
          - GB-Mo
          - Bundles
          - Queries
          description: The unit of measurement that's used for the cost estimate.
        unit:
          type: number
          description: The number of pricing units used to calculate the total number of hours. For example, 1 unit equals
            1 hour.
        currency:
          type: string
          enum:
          - USD
          description: The currency of the estimate in USD.
        timePeriod:
          $ref: '#/components/schemas/TimePeriod'
    GetCostEstimateRequest:
      type: object
      properties:
        resourceName:
          type: string
          description: The resource name.
        startTime:
          type: string
          format: date-time
          description: 'The cost estimate start time. Constraints: Specified in Coordinated Universal Time (UTC). Specified
            in the Unix time format. For example, if you want to use a start time of October 1, 2018, at 8 PM UTC, specify
            1538424000 as the start time. You can convert a human-friendly time to Unix time format using a converter like
            Epoch converter.'
        endTime:
          type: string
          format: date-time
          description: 'The cost estimate end time. Constraints: Specified in Coordinated Universal Time (UTC). Specified
            in the Unix time format. For example, if you want to use an end time of October 1, 2018, at 9 PM UTC, specify
            1538427600 as the end time. You can convert a human-friendly time to Unix time format using a converter like Epoch
            converter.'
      required:
      - resourceName
      - startTime
      - endTime
    GetCostEstimateResult:
      type: object
      properties:
        resourcesBudgetEstimate:
          type: array
          items:
            $ref: '#/components/schemas/ResourceBudgetEstimate'
          description: Returns the estimate's forecasted cost or usage.
    InvalidInputException:
      type: object
      properties:
        code:
          type: string
        docs:
          type: string
        message:
          type: string
        tip:
          type: string
    NotFoundException:
      type: object
      properties:
        code:
          type: string
        docs:
          type: string
        message:
          type: string
        tip:
          type: string
    RegionSetupInProgressException:
      type: object
      properties:
        code:
          type: string
        docs:
          type: string
          description: Regions and Availability Zones for Lightsail
        message:
          type: string
        tip:
          type: string
          description: Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait
            a few minutes and try again.
    ResourceBudgetEstimate:
      type: object
      properties:
        resourceName:
          type: string
          description: The resource name.
        resourceType:
          type: string
          enum:
          - ContainerService
          - Instance
          - StaticIp
          - KeyPair
          - InstanceSnapshot
          - Domain
          - PeeredVpc
          - LoadBalancer
          - LoadBalancerTlsCertificate
          - Disk
          - DiskSnapshot
          - RelationalDatabase
          - RelationalDatabaseSnapshot
          - ExportSnapshotRecord
          - CloudFormationStackRecord
          - Alarm
          - ContactMethod
          - Distribution
          - Certificate
          - Bucket
          description: The type of resource the budget will track.
        costEstimates:
          type: array
          items:
            $ref: '#/components/schemas/CostEstimate'
          description: The cost estimate for the specified budget.
        startTime:
          type: string
          format: date-time
          description: The estimate start time.
        endTime:
          type: string
          format: date-time
          description: The estimate end time.
    ServiceException:
      type: object
      properties:
        code:
          type: string
        docs:
          type: string
        message:
          type: string
        tip:
          type: string
    TimePeriod:
      type: object
      properties:
        start:
          type: string
          format: date-time
          description: The beginning of the time period. The start date is inclusive. For example, if start is 2017-01-01,
            Lightsail for Research retrieves cost and usage data starting at 2017-01-01 up to the end date. The start date
            must be equal to or no later than the current date to avoid a validation error.
        end:
          type: string
          format: date-time
          description: The end of the time period. The end date is exclusive. For example, if end is 2017-05-01, Lightsail
            for Research retrieves cost and usage data from the start date up to, but not including, 2017-05-01.
    UnauthenticatedException:
      type: object
      properties:
        code:
          type: string
        docs:
          type: string
        message:
          type: string
        tip:
          type: string
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/lightsail/service/2016-11-28/lightsail-2016-11-28.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)