Amazon Billing And Cost Management

Amazon Billing And Cost Management Billing And Cost Management Workload Estimate API

The Billing And Cost Management Workload Estimate API from Amazon Billing And Cost Management — 5 operation(s) for billing and cost management workload estimate.

GitHub OpenAPI

Operations 5

POST /#CreateWorkloadEstimate Create Workload Estimate #
POST /#GetWorkloadEstimate Get Workload Estimate #
POST /#UpdateWorkloadEstimate Update Workload Estimate #
POST /#DeleteWorkloadEstimate Delete Workload Estimate #
POST /#ListWorkloadEstimates List Workload Estimates #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/amazon-billing-and-cost-management/openapi/amazon-billing-and-cost-management-workload-estimate-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/amazon-billing-and-cost-management/json-schema/amazon-billing-and-cost-management-update-workload-estimate-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/amazon-billing-and-cost-management/json-schema/amazon-billing-and-cost-management-get-workload-estimate-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/amazon-billing-and-cost-management/json-schema/amazon-billing-and-cost-management-create-workload-estimate-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/amazon-billing-and-cost-management/json-schema/amazon-billing-and-cost-management-create-workload-estimate-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/amazon-billing-and-cost-management/json-schema/amazon-billing-and-cost-management-list-workload-estimates-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/amazon-billing-and-cost-management/json-schema/amazon-billing-and-cost-management-update-workload-estimate-request-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/amazon-billing-and-cost-management:amazon-billing-and-cost-management-workload-estimate-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amazon-billing-and-cost-management-workload-estimate-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: AWS Cost Explorer Service Workload Estimate API
  version: '2017-10-25'
  description: Generated from AWS's published Smithy model for AWS Cost Explorer Service. 5 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://bcm-pricing-calculator.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /#CreateWorkloadEstimate:
    post:
      operationId: CreateWorkloadEstimate
      summary: Create Workload Estimate
      description: Creates a new workload estimate to model costs for a specific workload.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/CreateWorkloadEstimateResponse'
        '409':
          description: ConflictException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/BcmPricingCalculatorConflictException'
        '400':
          description: DataUnavailableException; ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/BcmPricingCalculatorDataUnavailableException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/BcmPricingCalculatorServiceQuotaExceededException'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/BcmPricingCalculatorInternalServerException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/BcmPricingCalculatorThrottlingException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSBCMPricingCalculator.CreateWorkloadEstimate
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/CreateWorkloadEstimateRequest'
      tags:
      - Workload Estimate
  /#GetWorkloadEstimate:
    post:
      operationId: GetWorkloadEstimate
      summary: Get Workload Estimate
      description: Retrieves details of a specific workload estimate.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/GetWorkloadEstimateResponse'
        '400':
          description: DataUnavailableException; ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/BcmPricingCalculatorDataUnavailableException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/BcmPricingCalculatorResourceNotFoundException'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/BcmPricingCalculatorInternalServerException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/BcmPricingCalculatorThrottlingException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSBCMPricingCalculator.GetWorkloadEstimate
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/GetWorkloadEstimateRequest'
      tags:
      - Workload Estimate
  /#UpdateWorkloadEstimate:
    post:
      operationId: UpdateWorkloadEstimate
      summary: Update Workload Estimate
      description: Updates an existing workload estimate.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/UpdateWorkloadEstimateResponse'
        '409':
          description: ConflictException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/BcmPricingCalculatorConflictException'
        '400':
          description: DataUnavailableException; ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/BcmPricingCalculatorDataUnavailableException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/BcmPricingCalculatorResourceNotFoundException'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/BcmPricingCalculatorInternalServerException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/BcmPricingCalculatorThrottlingException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSBCMPricingCalculator.UpdateWorkloadEstimate
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/UpdateWorkloadEstimateRequest'
      tags:
      - Workload Estimate
  /#DeleteWorkloadEstimate:
    post:
      operationId: DeleteWorkloadEstimate
      summary: Delete Workload Estimate
      description: Deletes an existing workload estimate.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/DeleteWorkloadEstimateResponse'
        '400':
          description: DataUnavailableException; ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/BcmPricingCalculatorDataUnavailableException'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/BcmPricingCalculatorInternalServerException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/BcmPricingCalculatorThrottlingException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSBCMPricingCalculator.DeleteWorkloadEstimate
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/DeleteWorkloadEstimateRequest'
      tags:
      - Workload Estimate
  /#ListWorkloadEstimates:
    post:
      operationId: ListWorkloadEstimates
      summary: List Workload Estimates
      description: Lists all workload estimates for the account.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ListWorkloadEstimatesResponse'
        '400':
          description: DataUnavailableException; ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/BcmPricingCalculatorDataUnavailableException'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/BcmPricingCalculatorInternalServerException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/BcmPricingCalculatorThrottlingException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSBCMPricingCalculator.ListWorkloadEstimates
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/ListWorkloadEstimatesRequest'
      tags:
      - Workload 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: bcm-pricing-calculator
  schemas:
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    BcmPricingCalculatorConflictException:
      type: object
      properties:
        message:
          type: string
        resourceId:
          type: string
          description: The identifier of the resource that was not found.
        resourceType:
          type: string
          description: The type of the resource that was not found.
      required:
      - message
      - resourceId
      - resourceType
    BcmPricingCalculatorDataUnavailableException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    BcmPricingCalculatorInternalServerException:
      type: object
      properties:
        message:
          type: string
        retryAfterSeconds:
          type: integer
          description: An internal error has occurred. Retry your request, but if the problem persists, contact Amazon Web
            Services support.
      required:
      - message
    BcmPricingCalculatorResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
        resourceId:
          type: string
          description: The identifier of the resource that was not found.
        resourceType:
          type: string
          description: The type of the resource that was not found.
      required:
      - message
      - resourceId
      - resourceType
    BcmPricingCalculatorServiceQuotaExceededException:
      type: object
      properties:
        message:
          type: string
        resourceId:
          type: string
          description: The identifier of the resource that exceeded quota.
        resourceType:
          type: string
          description: The type of the resource that exceeded quota.
        serviceCode:
          type: string
          description: The service code that exceeded quota.
        quotaCode:
          type: string
          description: The quota code that was exceeded.
      required:
      - message
      - resourceId
      - resourceType
    BcmPricingCalculatorThrottlingException:
      type: object
      properties:
        message:
          type: string
        serviceCode:
          type: string
          description: The service code that exceeded the throttling limit.
        quotaCode:
          type: string
          description: The quota code that exceeded the throttling limit.
        retryAfterSeconds:
          type: integer
          description: The service code that exceeded the throttling limit. Retry your request, but if the problem persists,
            contact Amazon Web Services support.
      required:
      - message
    CreateWorkloadEstimateRequest:
      type: object
      properties:
        name:
          type: string
          description: A descriptive name for the workload estimate.
        clientToken:
          type: string
          description: A unique, case-sensitive identifier to ensure idempotency of the request.
        rateType:
          type: string
          enum:
          - BEFORE_DISCOUNTS
          - AFTER_DISCOUNTS
          - AFTER_DISCOUNTS_AND_COMMITMENTS
          description: The type of pricing rates to use for the estimate.
        tags:
          type: object
          additionalProperties:
            type: string
          description: The tags to apply to the workload estimate.
      required:
      - name
    CreateWorkloadEstimateResponse:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for the created workload estimate.
        name:
          type: string
          description: The name of the created workload estimate.
        createdAt:
          type: string
          description: The timestamp when the workload estimate was created.
        expiresAt:
          type: string
          description: The timestamp when the workload estimate will expire.
        rateType:
          type: string
          enum:
          - BEFORE_DISCOUNTS
          - AFTER_DISCOUNTS
          - AFTER_DISCOUNTS_AND_COMMITMENTS
          description: The type of pricing rates used for the estimate.
        rateTimestamp:
          type: string
          description: The timestamp of the pricing rates used for the estimate.
        status:
          type: string
          enum:
          - UPDATING
          - VALID
          - INVALID
          - ACTION_NEEDED
          description: The current status of the workload estimate.
        totalCost:
          type: number
          description: The total estimated cost for the workload.
        costCurrency:
          type: string
          enum:
          - USD
          description: The currency of the estimated cost.
        failureMessage:
          type: string
          description: An error message if the workload estimate creation failed.
      required:
      - id
    DeleteWorkloadEstimateRequest:
      type: object
      properties:
        identifier:
          type: string
          description: The unique identifier of the workload estimate to delete.
      required:
      - identifier
    DeleteWorkloadEstimateResponse:
      type: object
      properties: {}
    FilterTimestamp:
      type: object
      properties:
        afterTimestamp:
          type: string
          description: Include results after this timestamp.
        beforeTimestamp:
          type: string
          description: Include results before this timestamp.
    GetWorkloadEstimateRequest:
      type: object
      properties:
        identifier:
          type: string
          description: The unique identifier of the workload estimate to retrieve.
      required:
      - identifier
    GetWorkloadEstimateResponse:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the retrieved workload estimate.
        name:
          type: string
          description: The name of the retrieved workload estimate.
        createdAt:
          type: string
          description: The timestamp when the workload estimate was created.
        expiresAt:
          type: string
          description: The timestamp when the workload estimate will expire.
        rateType:
          type: string
          enum:
          - BEFORE_DISCOUNTS
          - AFTER_DISCOUNTS
          - AFTER_DISCOUNTS_AND_COMMITMENTS
          description: The type of pricing rates used for the estimate.
        rateTimestamp:
          type: string
          description: The timestamp of the pricing rates used for the estimate.
        status:
          type: string
          enum:
          - UPDATING
          - VALID
          - INVALID
          - ACTION_NEEDED
          description: The current status of the workload estimate.
        totalCost:
          type: number
          description: The total estimated cost for the workload.
        costCurrency:
          type: string
          enum:
          - USD
          description: The currency of the estimated cost.
        failureMessage:
          type: string
          description: An error message if the workload estimate retrieval failed.
      required:
      - id
    ListWorkloadEstimatesFilter:
      type: object
      properties:
        name:
          type: string
          enum:
          - STATUS
          - NAME
          description: The name of the filter attribute.
        values:
          type: array
          items:
            type: string
          description: The values to filter by.
        matchOption:
          type: string
          enum:
          - EQUALS
          - STARTS_WITH
          - CONTAINS
          description: The match option for the filter (e.g., equals, contains).
      required:
      - name
      - values
    ListWorkloadEstimatesRequest:
      type: object
      properties:
        createdAtFilter:
          $ref: '#/components/schemas/FilterTimestamp'
        expiresAtFilter:
          $ref: '#/components/schemas/FilterTimestamp'
        filters:
          type: array
          items:
            $ref: '#/components/schemas/ListWorkloadEstimatesFilter'
          description: Filters to apply to the list of workload estimates.
        nextToken:
          type: string
          description: A token to retrieve the next page of results.
        maxResults:
          type: integer
          description: The maximum number of results to return per page.
    ListWorkloadEstimatesResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/WorkloadEstimateSummary'
          description: The list of workload estimates for the account.
        nextToken:
          type: string
          description: A token to retrieve the next page of results, if any.
    UpdateWorkloadEstimateRequest:
      type: object
      properties:
        identifier:
          type: string
          description: The unique identifier of the workload estimate to update.
        name:
          type: string
          description: The new name for the workload estimate.
        expiresAt:
          type: string
          description: The new expiration date for the workload estimate.
      required:
      - identifier
    UpdateWorkloadEstimateResponse:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the updated workload estimate.
        name:
          type: string
          description: The updated name of the workload estimate.
        createdAt:
          type: string
          description: The timestamp when the workload estimate was originally created.
        expiresAt:
          type: string
          description: The updated expiration timestamp for the workload estimate.
        rateType:
          type: string
          enum:
          - BEFORE_DISCOUNTS
          - AFTER_DISCOUNTS
          - AFTER_DISCOUNTS_AND_COMMITMENTS
          description: The type of pricing rates used for the updated estimate.
        rateTimestamp:
          type: string
          description: The timestamp of the pricing rates used for the updated estimate.
        status:
          type: string
          enum:
          - UPDATING
          - VALID
          - INVALID
          - ACTION_NEEDED
          description: The current status of the updated workload estimate.
        totalCost:
          type: number
          description: The updated total estimated cost for the workload.
        costCurrency:
          type: string
          enum:
          - USD
          description: The currency of the updated estimated cost.
        failureMessage:
          type: string
          description: An error message if the workload estimate update failed.
      required:
      - id
    WorkloadEstimateSummary:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the workload estimate.
        name:
          type: string
          description: The name of the workload estimate.
        createdAt:
          type: string
          description: The timestamp when the workload estimate was created.
        expiresAt:
          type: string
          description: The timestamp when the workload estimate will expire.
        rateType:
          type: string
          enum:
          - BEFORE_DISCOUNTS
          - AFTER_DISCOUNTS
          - AFTER_DISCOUNTS_AND_COMMITMENTS
          description: The type of pricing rates used for the estimate.
        rateTimestamp:
          type: string
          description: The timestamp of the pricing rates used for the estimate.
        status:
          type: string
          enum:
          - UPDATING
          - VALID
          - INVALID
          - ACTION_NEEDED
          description: The current status of the workload estimate.
        totalCost:
          type: number
          description: The total estimated cost for the workload.
        costCurrency:
          type: string
          enum:
          - USD
          description: The currency of the estimated cost.
        failureMessage:
          type: string
          description: An error message if the workload estimate creation or processing failed.
      required:
      - id
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/bcm-pricing-calculator/service/2024-06-19/bcm-pricing-calculator-2024-06-19.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)