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

openapi: 3.1.0
info:
  title: AWS Cost Explorer Service Workload Estimate Usage API
  version: '2017-10-25'
  description: Generated from AWS's published Smithy model for AWS Cost Explorer Service. 4 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:
  /#BatchCreateWorkloadEstimateUsage:
    post:
      operationId: BatchCreateWorkloadEstimateUsage
      summary: Batch Create Workload Estimate Usage
      description: Create Amazon Web Services service usage that you want to model in a Workload Estimate. The BatchCreateWorkloadEstimateUsage
        operation doesn't have its own IAM permission. To authorize this operation for Amazon Web Services principals, include
        the permission bcm-pricing-calculator:CreateWorkloadEstimateUsage in your policies.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/BatchCreateWorkloadEstimateUsageResponse'
        '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'
        '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.BatchCreateWorkloadEstimateUsage
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/BatchCreateWorkloadEstimateUsageRequest'
      tags:
      - Workload Estimate Usage
  /#BatchDeleteWorkloadEstimateUsage:
    post:
      operationId: BatchDeleteWorkloadEstimateUsage
      summary: Batch Delete Workload Estimate Usage
      description: Delete usage that you have created in a Workload estimate. You can only delete usage that you had added
        and cannot model deletion (or removal) of a existing usage. If you want model removal of an existing usage, see BatchUpdateWorkloadEstimateUsage.
        The BatchDeleteWorkloadEstimateUsage operation doesn't have its own IAM permission. To authorize this operation for
        Amazon Web Services principals, include the permission bcm-pricing-calculator:DeleteWorkloadEstimateUsage in your
        policies.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/BatchDeleteWorkloadEstimateUsageResponse'
        '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'
        '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.BatchDeleteWorkloadEstimateUsage
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/BatchDeleteWorkloadEstimateUsageRequest'
      tags:
      - Workload Estimate Usage
  /#BatchUpdateWorkloadEstimateUsage:
    post:
      operationId: BatchUpdateWorkloadEstimateUsage
      summary: Batch Update Workload Estimate Usage
      description: Update a newly added or existing usage lines. You can update the usage amounts and usage group based on
        a usage ID and a Workload estimate ID. The BatchUpdateWorkloadEstimateUsage operation doesn't have its own IAM permission.
        To authorize this operation for Amazon Web Services principals, include the permission bcm-pricing-calculator:UpdateWorkloadEstimateUsage
        in your policies.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/BatchUpdateWorkloadEstimateUsageResponse'
        '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'
        '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.BatchUpdateWorkloadEstimateUsage
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/BatchUpdateWorkloadEstimateUsageRequest'
      tags:
      - Workload Estimate Usage
  /#ListWorkloadEstimateUsage:
    post:
      operationId: ListWorkloadEstimateUsage
      summary: List Workload Estimate Usage
      description: Lists the usage associated with a workload estimate.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ListWorkloadEstimateUsageResponse'
        '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.ListWorkloadEstimateUsage
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/ListWorkloadEstimateUsageRequest'
      tags:
      - Workload Estimate Usage
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
    BatchCreateWorkloadEstimateUsageEntry:
      type: object
      properties:
        serviceCode:
          type: string
          description: The Amazon Web Services service code for this usage estimate.
        usageType:
          type: string
          description: The type of usage being estimated.
        operation:
          type: string
          description: The specific operation associated with this usage estimate.
        key:
          type: string
          description: A unique identifier for this entry in the batch operation.
        group:
          type: string
          description: An optional group identifier for the usage estimate.
        usageAccountId:
          type: string
          description: The Amazon Web Services account ID associated with this usage estimate.
        amount:
          type: number
          description: The estimated usage amount.
        historicalUsage:
          $ref: '#/components/schemas/HistoricalUsageEntity'
      required:
      - serviceCode
      - usageType
      - operation
      - key
      - usageAccountId
      - amount
    BatchCreateWorkloadEstimateUsageError:
      type: object
      properties:
        key:
          type: string
          description: The key of the entry that caused the error.
        errorCode:
          type: string
          enum:
          - BAD_REQUEST
          - NOT_FOUND
          - CONFLICT
          - INTERNAL_SERVER_ERROR
          description: The error code associated with the failed operation.
        errorMessage:
          type: string
          description: A descriptive message for the error that occurred.
    BatchCreateWorkloadEstimateUsageItem:
      type: object
      properties:
        serviceCode:
          type: string
          description: The Amazon Web Services service code for this usage estimate.
        usageType:
          type: string
          description: The type of usage that was estimated.
        operation:
          type: string
          description: The specific operation associated with this usage estimate.
        location:
          type: string
          description: The location associated with this usage estimate.
        id:
          type: string
          description: The unique identifier assigned to the created usage estimate.
        usageAccountId:
          type: string
          description: The Amazon Web Services account ID associated with the created usage estimate.
        group:
          type: string
          description: The group identifier for the created usage estimate.
        quantity:
          $ref: '#/components/schemas/WorkloadEstimateUsageQuantity'
        cost:
          type: number
          description: The estimated cost associated with this usage.
        currency:
          type: string
          enum:
          - USD
          description: The currency of the estimated cost.
        status:
          type: string
          enum:
          - VALID
          - INVALID
          - STALE
          description: The current status of the created usage estimate.
        historicalUsage:
          $ref: '#/components/schemas/HistoricalUsageEntity'
        key:
          type: string
          description: The key of the successfully created entry.
      required:
      - serviceCode
      - usageType
      - operation
    BatchCreateWorkloadEstimateUsageRequest:
      type: object
      properties:
        workloadEstimateId:
          type: string
          description: The ID of the Workload estimate for which you want to create the modeled usage.
        usage:
          type: array
          items:
            $ref: '#/components/schemas/BatchCreateWorkloadEstimateUsageEntry'
          description: List of usage that you want to model in the Workload estimate.
        clientToken:
          type: string
          description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
      required:
      - workloadEstimateId
      - usage
    BatchCreateWorkloadEstimateUsageResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/BatchCreateWorkloadEstimateUsageItem'
          description: Returns the list of successful usage line items that were created for the Workload estimate.
        errors:
          type: array
          items:
            $ref: '#/components/schemas/BatchCreateWorkloadEstimateUsageError'
          description: Returns the list of errors reason and the usage item keys that cannot be created in the Workload estimate.
    BatchDeleteWorkloadEstimateUsageError:
      type: object
      properties:
        id:
          type: string
          description: The ID of the error.
        errorMessage:
          type: string
          description: The message that describes the error.
        errorCode:
          type: string
          enum:
          - BAD_REQUEST
          - NOT_FOUND
          - CONFLICT
          - INTERNAL_SERVER_ERROR
          description: The code associated with the error.
    BatchDeleteWorkloadEstimateUsageRequest:
      type: object
      properties:
        workloadEstimateId:
          type: string
          description: The ID of the Workload estimate for which you want to delete the modeled usage.
        ids:
          type: array
          items:
            type: string
          description: List of usage that you want to delete from the Workload estimate.
      required:
      - workloadEstimateId
      - ids
    BatchDeleteWorkloadEstimateUsageResponse:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/BatchDeleteWorkloadEstimateUsageError'
          description: Returns the list of errors reason and the usage item keys that cannot be deleted from the Workload
            estimate.
    BatchUpdateWorkloadEstimateUsageEntry:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the usage estimate to update.
        group:
          type: string
          description: The updated group identifier for the usage estimate.
        amount:
          type: number
          description: The updated estimated usage amount.
      required:
      - id
    BatchUpdateWorkloadEstimateUsageError:
      type: object
      properties:
        id:
          type: string
          description: The ID of the error.
        errorMessage:
          type: string
          description: The message that describes the error.
        errorCode:
          type: string
          enum:
          - BAD_REQUEST
          - NOT_FOUND
          - CONFLICT
          - INTERNAL_SERVER_ERROR
          description: The code associated with the error.
    BatchUpdateWorkloadEstimateUsageRequest:
      type: object
      properties:
        workloadEstimateId:
          type: string
          description: The ID of the Workload estimate for which you want to modify the usage lines.
        usage:
          type: array
          items:
            $ref: '#/components/schemas/BatchUpdateWorkloadEstimateUsageEntry'
          description: List of usage line amounts and usage group that you want to update in a Workload estimate identified
            by the usage ID.
      required:
      - workloadEstimateId
      - usage
    BatchUpdateWorkloadEstimateUsageResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/WorkloadEstimateUsageItem'
          description: Returns the list of successful usage line items that were updated for a Workload estimate.
        errors:
          type: array
          items:
            $ref: '#/components/schemas/BatchUpdateWorkloadEstimateUsageError'
          description: Returns the list of error reasons and usage line item IDs that could not be updated for the Workload
            estimate.
    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
    BcmPricingCalculatorExpression:
      type: object
      properties:
        and:
          type: array
          items:
            $ref: '#/components/schemas/BcmPricingCalculatorExpression'
          description: A list of expressions to be combined with AND logic.
        or:
          type: array
          items:
            $ref: '#/components/schemas/BcmPricingCalculatorExpression'
          description: A list of expressions to be combined with OR logic.
        not:
          $ref: '#/components/schemas/BcmPricingCalculatorExpression'
        costCategories:
          $ref: '#/components/schemas/ExpressionFilter'
        dimensions:
          $ref: '#/components/schemas/ExpressionFilter'
        tags:
          $ref: '#/components/schemas/ExpressionFilter'
    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
    BillInterval:
      type: object
      properties:
        start:
          type: string
          description: The start date and time of the interval.
        end:
          type: string
          description: The end date and time of the interval.
    ExpressionFilter:
      type: object
      properties:
        key:
          type: string
          description: The key or attribute to filter on.
        matchOptions:
          type: array
          items:
            type: string
          description: The match options for the filter (e.g., equals, contains).
        values:
          type: array
          items:
            type: string
          description: The values to match against.
    HistoricalUsageEntity:
      type: object
      properties:
        serviceCode:
          type: string
          description: The Amazon Web Services service code associated with the usage.
        usageType:
          type: string
          description: The type of usage.
        operation:
          type: string
          description: The specific operation associated with the usage.
        location:
          type: string
          description: The location associated with the usage.
        usageAccountId:
          type: string
          description: The Amazon Web Services account ID associated with the usage.
        billInterval:
          $ref: '#/components/schemas/BillInterval'
        filterExpression:
          $ref: '#/components/schemas/BcmPricingCalculatorExpression'
      required:
      - serviceCode
      - usageType
      - operation
      - usageAccountId
      - billInterval
      - filterExpression
    ListUsageFilter:
      type: object
      properties:
        name:
          type: string
          enum:
          - USAGE_ACCOUNT_ID
          - SERVICE_CODE
          - USAGE_TYPE
          - OPERATION
          - LOCATION
          - USAGE_GROUP
          - HISTORICAL_USAGE_ACCOUNT_ID
          - HISTORICAL_SERVICE_CODE
          - HISTORICAL_USAGE_TYPE
          - HISTORICAL_OPERATION
          - HISTORICAL_LOCATION
          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
    ListWorkloadEstimateUsageRequest:
      type: object
      properties:
        workloadEstimateId:
          type: string
          description: The unique identifier of the workload estimate to list usage for.
        filters:
          type: array
          items:
            $ref: '#/components/schemas/ListUsageFilter'
          description: Filters to apply to the list of usage items.
        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.
      required:
      - workloadEstimateId
    ListWorkloadEstimateUsageResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/WorkloadEstimateUsageItem'
          description: The list of usage items associated with the workload estimate.
        nextToken:
          type: string
          description: A token to retrieve the next page of results, if any.
    WorkloadEstimateUsageItem:
      type: object
      properties:
        serviceCode:
          type: string
          description: The Amazon Web Services service code associated with this usage item.
        usageType:
          type: string
          description: The type of usage for this item.
        operation:
          type: string
          description: The specific operation associated with this usage item.
        location:
          type: string
          description: The location associated with this usage item.
        id:
          type: string
          description: The unique identifier of this usage item.
        usageAccountId:
          type: string
          description: The Amazon Web Services account ID associated with this usage item.
        group:
          type: string
          description: The group identifier for this usage item.
        quantity:
          $ref: '#/components/schemas/WorkloadEstimateUsageQuantity'
        cost:
          type: number
          description: The estimated cost for this usage item.
        currency:
          type: string
          enum:
          - USD
          description: The currency of the estimated cost.
        status:
          type: string
          enum:
          - VALID
          - INVALID
          - STALE
          description: The current status of this usage item.
        historicalUsage:
          $ref: '#/components/schemas/HistoricalUsageEntity'
      required:
      - serviceCode
      - usageType
      - operation
    WorkloadEstimateUsageQuantity:
      type: object
      properties:
        unit:
          type: string
          description: The unit of measurement for the usage quantity.
        amount:
          type: number
          description: The numeric value of the usage quantity.
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)