Amazon Billing And Cost Management Billing And Cost Management Bill Scenario Usage Modification API

openapi: 3.1.0
info:
  title: AWS Cost Explorer Service Bill Scenario Usage Modification 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:
  /#BatchCreateBillScenarioUsageModification:
    post:
      operationId: BatchCreateBillScenarioUsageModification
      summary: Batch Create Bill Scenario Usage Modification
      description: Create Amazon Web Services service usage that you want to model in a Bill Scenario. The BatchCreateBillScenarioUsageModification
        operation doesn't have its own IAM permission. To authorize this operation for Amazon Web Services principals, include
        the permission bcm-pricing-calculator:CreateBillScenarioUsageModification in your policies.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/BatchCreateBillScenarioUsageModificationResponse'
        '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.BatchCreateBillScenarioUsageModification
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/BatchCreateBillScenarioUsageModificationRequest'
      tags:
      - Bill Scenario Usage Modification
  /#BatchDeleteBillScenarioUsageModification:
    post:
      operationId: BatchDeleteBillScenarioUsageModification
      summary: Batch Delete Bill Scenario Usage Modification
      description: Delete usage that you have created in a Bill Scenario. 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 BatchUpdateBillScenarioUsageModification.
        The BatchDeleteBillScenarioUsageModification operation doesn't have its own IAM permission. To authorize this operation
        for Amazon Web Services principals, include the permission bcm-pricing-calculator:DeleteBillScenarioUsageModification
        in your policies.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/BatchDeleteBillScenarioUsageModificationResponse'
        '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.BatchDeleteBillScenarioUsageModification
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/BatchDeleteBillScenarioUsageModificationRequest'
      tags:
      - Bill Scenario Usage Modification
  /#BatchUpdateBillScenarioUsageModification:
    post:
      operationId: BatchUpdateBillScenarioUsageModification
      summary: Batch Update Bill Scenario Usage Modification
      description: Update a newly added or existing usage lines. You can update the usage amounts, usage hour, and usage group
        based on a usage ID and a Bill scenario ID. The BatchUpdateBillScenarioUsageModification operation doesn't have its
        own IAM permission. To authorize this operation for Amazon Web Services principals, include the permission bcm-pricing-calculator:UpdateBillScenarioUsageModification
        in your policies.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/BatchUpdateBillScenarioUsageModificationResponse'
        '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.BatchUpdateBillScenarioUsageModification
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/BatchUpdateBillScenarioUsageModificationRequest'
      tags:
      - Bill Scenario Usage Modification
  /#ListBillScenarioUsageModifications:
    post:
      operationId: ListBillScenarioUsageModifications
      summary: List Bill Scenario Usage Modifications
      description: Lists the usage modifications associated with a bill scenario.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ListBillScenarioUsageModificationsResponse'
        '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.ListBillScenarioUsageModifications
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/ListBillScenarioUsageModificationsRequest'
      tags:
      - Bill Scenario Usage Modification
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
    BatchCreateBillScenarioUsageModificationEntry:
      type: object
      properties:
        serviceCode:
          type: string
          description: The Amazon Web Services service code for this usage modification. This identifies the specific Amazon
            Web Services service to the customer as a unique short abbreviation. For example, AmazonEC2 and AWSKMS.
        usageType:
          type: string
          description: Describes the usage details of the usage line item.
        operation:
          type: string
          description: The specific operation associated with this usage modification. Describes the specific Amazon Web Services
            operation that this usage line models. For example, RunInstances indicates the operation of an Amazon EC2 instance.
        availabilityZone:
          type: string
          description: The Availability Zone that this usage line uses.
        key:
          type: string
          description: A unique identifier for this entry in the batch operation. This can be any valid string. This key is
            useful to identify errors associated with any usage entry as any error is returned with this key.
        group:
          type: string
          description: An optional group identifier for the usage modification.
        usageAccountId:
          type: string
          description: The Amazon Web Services account ID to which this usage will be applied to.
        amounts:
          type: array
          items:
            $ref: '#/components/schemas/UsageAmount'
          description: The amount of usage you want to create for the service use you are modeling.
        historicalUsage:
          $ref: '#/components/schemas/HistoricalUsageEntity'
      required:
      - serviceCode
      - usageType
      - operation
      - key
      - usageAccountId
    BatchCreateBillScenarioUsageModificationError:
      type: object
      properties:
        key:
          type: string
          description: The key of the entry that caused the error.
        errorMessage:
          type: string
          description: A descriptive message for the error that occurred.
        errorCode:
          type: string
          enum:
          - BAD_REQUEST
          - NOT_FOUND
          - CONFLICT
          - INTERNAL_SERVER_ERROR
          description: The error code associated with the failed operation.
    BatchCreateBillScenarioUsageModificationItem:
      type: object
      properties:
        serviceCode:
          type: string
          description: The Amazon Web Services service code for this usage modification.
        usageType:
          type: string
          description: The type of usage that was modified.
        operation:
          type: string
          description: The specific operation associated with this usage modification.
        location:
          type: string
          description: The location associated with this usage modification.
        availabilityZone:
          type: string
          description: The availability zone associated with this usage modification, if applicable.
        id:
          type: string
          description: The unique identifier assigned to the created usage modification.
        group:
          type: string
          description: The group identifier for the created usage modification.
        usageAccountId:
          type: string
          description: The Amazon Web Services account ID associated with the created usage modification.
        quantities:
          type: array
          items:
            $ref: '#/components/schemas/UsageQuantity'
          description: The modified usage quantities.
        historicalUsage:
          $ref: '#/components/schemas/HistoricalUsageEntity'
        key:
          type: string
          description: The key of the successfully created entry.
      required:
      - serviceCode
      - usageType
      - operation
    BatchCreateBillScenarioUsageModificationRequest:
      type: object
      properties:
        billScenarioId:
          type: string
          description: The ID of the Bill Scenario for which you want to create the modeled usage.
        usageModifications:
          type: array
          items:
            $ref: '#/components/schemas/BatchCreateBillScenarioUsageModificationEntry'
          description: List of usage that you want to model in the Bill Scenario.
        clientToken:
          type: string
          description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
      required:
      - billScenarioId
      - usageModifications
    BatchCreateBillScenarioUsageModificationResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/BatchCreateBillScenarioUsageModificationItem'
          description: Returns the list of successful usage line items that were created for the Bill Scenario.
        errors:
          type: array
          items:
            $ref: '#/components/schemas/BatchCreateBillScenarioUsageModificationError'
          description: Returns the list of errors reason and the usage item keys that cannot be created in the Bill Scenario.
    BatchDeleteBillScenarioUsageModificationError:
      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
          - CONFLICT
          - INTERNAL_SERVER_ERROR
          description: The code associated with the error.
    BatchDeleteBillScenarioUsageModificationRequest:
      type: object
      properties:
        billScenarioId:
          type: string
          description: The ID of the Bill Scenario 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 Bill Scenario.
      required:
      - billScenarioId
      - ids
    BatchDeleteBillScenarioUsageModificationResponse:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/BatchDeleteBillScenarioUsageModificationError'
          description: Returns the list of errors reason and the usage item keys that cannot be deleted from the Bill Scenario.
    BatchUpdateBillScenarioUsageModificationEntry:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the usage modification to update.
        group:
          type: string
          description: The updated group identifier for the usage modification.
        amounts:
          type: array
          items:
            $ref: '#/components/schemas/UsageAmount'
          description: The updated usage amounts for the modification.
      required:
      - id
    BatchUpdateBillScenarioUsageModificationError:
      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.
    BatchUpdateBillScenarioUsageModificationRequest:
      type: object
      properties:
        billScenarioId:
          type: string
          description: The ID of the Bill Scenario for which you want to modify the usage lines.
        usageModifications:
          type: array
          items:
            $ref: '#/components/schemas/BatchUpdateBillScenarioUsageModificationEntry'
          description: List of usage lines that you want to update in a Bill Scenario identified by the usage ID.
      required:
      - billScenarioId
      - usageModifications
    BatchUpdateBillScenarioUsageModificationResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/BillScenarioUsageModificationItem'
          description: Returns the list of successful usage line items that were updated for a Bill Scenario.
        errors:
          type: array
          items:
            $ref: '#/components/schemas/BatchUpdateBillScenarioUsageModificationError'
          description: Returns the list of error reasons and usage line item IDs that could not be updated for the Bill Scenario.
    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.
    BillScenarioUsageModificationItem:
      type: object
      properties:
        serviceCode:
          type: string
          description: The Amazon Web Services service code for this usage modification.
        usageType:
          type: string
          description: The type of usage being modified.
        operation:
          type: string
          description: The specific operation associated with this usage modification.
        location:
          type: string
          description: The location associated with this usage modification.
        availabilityZone:
          type: string
          description: The availability zone associated with this usage modification, if applicable.
        id:
          type: string
          description: The unique identifier of the usage modification.
        group:
          type: string
          description: The group identifier for the usage modification.
        usageAccountId:
          type: string
          description: The Amazon Web Services account ID associated with this usage modification.
        quantities:
          type: array
          items:
            $ref: '#/components/schemas/UsageQuantity'
          description: The modified usage quantities.
        historicalUsage:
          $ref: '#/components/schemas/HistoricalUsageEntity'
      required:
      - serviceCode
      - usageType
      - operation
    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
    ListBillScenarioUsageModificationsRequest:
      type: object
      properties:
        billScenarioId:
          type: string
          description: The unique identifier of the bill scenario to list usage modifications for.
        filters:
          type: array
          items:
            $ref: '#/components/schemas/ListUsageFilter'
          description: Filters to apply to the list of usage modifications.
        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:
      - billScenarioId
    ListBillScenarioUsageModificationsResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/BillScenarioUsageModificationItem'
          description: The list of usage modifications associated with the bill scenario.
        nextToken:
          type: string
          description: A token to retrieve the next page of results, if any.
    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
    UsageAmount:
      type: object
      properties:
        startHour:
          type: string
          description: The start hour of the usage period.
        amount:
          type: number
          description: The usage amount for the period.
      required:
      - startHour
      - amount
    UsageQuantity:
      type: object
      properties:
        startHour:
          type: string
          description: The start hour of the usage period.
        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)