Amazon Billing And Cost Management Billing And Cost Management Billing View API

openapi: 3.1.0
info:
  title: AWS Cost Explorer Service Billing View 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://billing.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /#CreateBillingView:
    post:
      operationId: CreateBillingView
      summary: Create Billing View
      description: Creates a billing view with the specified billing view attributes.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/CreateBillingViewResponse'
              example:
                arn: arn:aws:billing::123456789101:billingview/custom-46f47cb2-a11d-43f3-983d-470b5708a899
                createdAt: 1719792001
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: BillingViewHealthStatusException; ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/BillingBillingViewHealthStatusException'
        '409':
          description: ConflictException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/BillingResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/BillingServiceQuotaExceededException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSBilling.CreateBillingView
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/CreateBillingViewRequest'
            example:
              name: Example Custom Billing View
              sourceViews:
              - arn:aws:billing::123456789101:billingview/primary
              description: Custom Billing View Example
              dataFilterExpression:
                dimensions:
                  key: LINKED_ACCOUNT
                  values:
                  - '000000000000'
      tags:
      - Billing View
  /#DeleteBillingView:
    post:
      operationId: DeleteBillingView
      summary: Delete Billing View
      description: Deletes the specified billing view.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/DeleteBillingViewResponse'
              example:
                arn: arn:aws:billing::123456789101:billingview/custom-46f47cb2-a11d-43f3-983d-470b5708a899
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSBilling.DeleteBillingView
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/DeleteBillingViewRequest'
            example:
              arn: arn:aws:billing::123456789101:billingview/custom-46f47cb2-a11d-43f3-983d-470b5708a899
      tags:
      - Billing View
  /#GetBillingView:
    post:
      operationId: GetBillingView
      summary: Get Billing View
      description: Returns the metadata associated to the specified billing view ARN.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/GetBillingViewResponse'
              example:
                billingView:
                  arn: arn:aws:billing::123456789101:billingview/custom-46f47cb2-a11d-43f3-983d-470b5708a899
                  name: Example Custom Billing View
                  description: Custom Billing View Example -- updated description
                  dataFilterExpression:
                    dimensions:
                      key: LINKED_ACCOUNT
                      values:
                      - '000000000000'
                  ownerAccountId: '123456789101'
                  billingViewType: CUSTOM
        '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/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/BillingResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSBilling.GetBillingView
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/GetBillingViewRequest'
            example:
              arn: arn:aws:billing::123456789101:billingview/custom-46f47cb2-a11d-43f3-983d-470b5708a899
      tags:
      - Billing View
  /#ListBillingViews:
    post:
      operationId: ListBillingViews
      summary: List Billing Views
      description: Lists the billing views available for a given time period. Every Amazon Web Services account has a unique
        PRIMARY billing view that represents the billing data available by default. Accounts that use Billing Conductor also
        have BILLING_GROUP billing views representing pro forma costs associated with each created billing group.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ListBillingViewsResponse'
              example:
                billingViews:
                - arn: arn:aws:billing::123456789101:billingview/primary
                  billingViewType: PRIMARY
                  name: Primary Billing View Account 123456789101
                  ownerAccountId: '123456789101'
        '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/InternalServerException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSBilling.ListBillingViews
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/ListBillingViewsRequest'
            example:
              activeTimeRange:
                activeAfterInclusive: 1719792000
                activeBeforeInclusive: 1722470399.999
      tags:
      - Billing View
  /#UpdateBillingView:
    post:
      operationId: UpdateBillingView
      summary: Update Billing View
      description: An API to update the attributes of the billing view.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/UpdateBillingViewResponse'
              example:
                arn: arn:aws:billing::123456789101:billingview/custom-46f47cb2-a11d-43f3-983d-470b5708a899
                updatedAt: 1719792001
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: BillingViewHealthStatusException; ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/BillingBillingViewHealthStatusException'
        '409':
          description: ConflictException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/BillingResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/BillingServiceQuotaExceededException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSBilling.UpdateBillingView
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/UpdateBillingViewRequest'
            example:
              name: Example Custom Billing View
              arn: arn:aws:billing::123456789101:billingview/custom-46f47cb2-a11d-43f3-983d-470b5708a899
              description: Custom Billing View Example -- updated description
              dataFilterExpression:
                dimensions:
                  key: LINKED_ACCOUNT
                  values:
                  - '000000000000'
      tags:
      - Billing View
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: billing
  schemas:
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ActiveTimeRange:
      type: object
      properties:
        activeAfterInclusive:
          type: string
          description: The inclusive time range start date.
        activeBeforeInclusive:
          type: string
          description: The inclusive time range end date.
      required:
      - activeAfterInclusive
      - activeBeforeInclusive
    BillingBillingViewHealthStatusException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    BillingCostCategoryValues:
      type: object
      properties:
        key:
          type: string
          description: The unique name of the Cost Category.
        values:
          type: array
          items:
            type: string
          description: The specific value of the Cost Category.
      required:
      - key
      - values
    BillingDimensionValues:
      type: object
      properties:
        key:
          type: string
          enum:
          - LINKED_ACCOUNT
          description: The names of the metadata types that you can use to filter and group your results.
        values:
          type: array
          items:
            type: string
          description: The metadata values that you can use to filter and group your results.
      required:
      - key
      - values
    BillingExpression:
      type: object
      properties:
        dimensions:
          $ref: '#/components/schemas/BillingDimensionValues'
        tags:
          $ref: '#/components/schemas/BillingTagValues'
        costCategories:
          $ref: '#/components/schemas/BillingCostCategoryValues'
        timeRange:
          $ref: '#/components/schemas/TimeRange'
    BillingResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
        resourceId:
          type: string
          description: Value is a list of resource IDs that were not found.
        resourceType:
          type: string
          description: Value is the type of resource that was not found.
      required:
      - message
      - resourceId
      - resourceType
    BillingResourceTag:
      type: object
      properties:
        key:
          type: string
          description: The key that's associated with the tag.
        value:
          type: string
          description: The value that's associated with the tag.
      required:
      - key
    BillingServiceQuotaExceededException:
      type: object
      properties:
        message:
          type: string
        resourceId:
          type: string
          description: The ID of the resource.
        resourceType:
          type: string
          description: The type of Amazon Web Services resource.
        serviceCode:
          type: string
          description: The container for the serviceCode.
        quotaCode:
          type: string
          description: The container for the quotaCode.
      required:
      - message
      - resourceId
      - resourceType
      - serviceCode
      - quotaCode
    BillingTagValues:
      type: object
      properties:
        key:
          type: string
          description: The key for the tag.
        values:
          type: array
          items:
            type: string
          description: The specific value of the tag.
      required:
      - key
      - values
    BillingViewElement:
      type: object
      properties:
        arn:
          type: string
          description: The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.
        name:
          type: string
          description: The account name of the billing view.
        description:
          type: string
          description: The description of the billing view.
        billingViewType:
          type: string
          enum:
          - PRIMARY
          - BILLING_GROUP
          - CUSTOM
          - BILLING_TRANSFER
          - BILLING_TRANSFER_SHOWBACK
          description: The type of billing group.
        ownerAccountId:
          type: string
          description: The account owner of the billing view.
        sourceAccountId:
          type: string
          description: The Amazon Web Services account ID that owns the source billing view, if this is a derived billing
            view.
        dataFilterExpression:
          $ref: '#/components/schemas/BillingExpression'
        createdAt:
          type: string
          description: The time when the billing view was created.
        updatedAt:
          type: string
          description: The time when the billing view was last updated.
        derivedViewCount:
          type: integer
          description: The number of billing views that use this billing view as a source.
        sourceViewCount:
          type: integer
          description: The number of source views associated with this billing view.
        viewDefinitionLastUpdatedAt:
          type: string
          description: The timestamp of when the billing view definition was last updated.
        healthStatus:
          $ref: '#/components/schemas/BillingViewHealthStatus'
    BillingViewHealthStatus:
      type: object
      properties:
        statusCode:
          type: string
          enum:
          - HEALTHY
          - UNHEALTHY
          - CREATING
          - UPDATING
          description: The current health status code of the billing view.
        statusReasons:
          type: array
          items:
            type: string
            enum:
            - SOURCE_VIEW_UNHEALTHY
            - SOURCE_VIEW_UPDATING
            - SOURCE_VIEW_ACCESS_DENIED
            - SOURCE_VIEW_NOT_FOUND
            - CYCLIC_DEPENDENCY
            - SOURCE_VIEW_DEPTH_EXCEEDED
            - AGGREGATE_SOURCE
            - VIEW_OWNER_NOT_MANAGEMENT_ACCOUNT
          description: A list of reasons explaining the current health status, if applicable.
    BillingViewListElement:
      type: object
      properties:
        arn:
          type: string
          description: The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.
        name:
          type: string
          description: A list of names of the Billing view.
        description:
          type: string
          description: The description of the billing view.
        ownerAccountId:
          type: string
          description: The list of owners of the Billing view.
        sourceAccountId:
          type: string
          description: The Amazon Web Services account ID that owns the source billing view, if this is a derived billing
            view.
        billingViewType:
          type: string
          enum:
          - PRIMARY
          - BILLING_GROUP
          - CUSTOM
          - BILLING_TRANSFER
          - BILLING_TRANSFER_SHOWBACK
          description: The type of billing view.
        healthStatus:
          $ref: '#/components/schemas/BillingViewHealthStatus'
    ConflictException:
      type: object
      properties:
        message:
          type: string
        resourceId:
          type: string
          description: The identifier for the service resource associated with the request.
        resourceType:
          type: string
          description: The type of resource associated with the request.
      required:
      - message
      - resourceId
      - resourceType
    CreateBillingViewRequest:
      type: object
      properties:
        name:
          type: string
          description: The name of the billing view.
        description:
          type: string
          description: The description of the billing view.
        sourceViews:
          type: array
          items:
            type: string
          description: A list of billing views used as the data source for the custom billing view.
        dataFilterExpression:
          $ref: '#/components/schemas/BillingExpression'
        clientToken:
          type: string
          description: A unique, case-sensitive identifier you specify to ensure idempotency of the request. Idempotency ensures
            that an API request completes no more than one time. If the original request completes successfully, any subsequent
            retries complete successfully without performing any further actions with an idempotent request.
        resourceTags:
          type: array
          items:
            $ref: '#/components/schemas/BillingResourceTag'
          description: A list of key value map specifying tags associated to the billing view being created.
      required:
      - name
      - sourceViews
    CreateBillingViewResponse:
      type: object
      properties:
        arn:
          type: string
          description: The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.
        createdAt:
          type: string
          description: The time when the billing view was created.
      required:
      - arn
    DeleteBillingViewRequest:
      type: object
      properties:
        arn:
          type: string
          description: The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.
        force:
          type: boolean
          description: If set to true, forces deletion of the billing view even if it has derived resources (e.g. other billing
            views or budgets). Use with caution as this may break dependent resources.
      required:
      - arn
    DeleteBillingViewResponse:
      type: object
      properties:
        arn:
          type: string
          description: The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.
      required:
      - arn
    GetBillingViewRequest:
      type: object
      properties:
        arn:
          type: string
          description: The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.
      required:
      - arn
    GetBillingViewResponse:
      type: object
      properties:
        billingView:
          $ref: '#/components/schemas/BillingViewElement'
      required:
      - billingView
    InternalServerException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ListBillingViewsRequest:
      type: object
      properties:
        activeTimeRange:
          $ref: '#/components/schemas/ActiveTimeRange'
        arns:
          type: array
          items:
            type: string
          description: The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.
        billingViewTypes:
          type: array
          items:
            type: string
            enum:
            - PRIMARY
            - BILLING_GROUP
            - CUSTOM
            - BILLING_TRANSFER
            - BILLING_TRANSFER_SHOWBACK
          description: The type of billing view.
        names:
          type: array
          items:
            $ref: '#/components/schemas/StringSearch'
          description: Filters the list of billing views by name. You can specify search criteria to match billing view names
            based on the search option provided.
        ownerAccountId:
          type: string
          description: The list of owners of the billing view.
        sourceAccountId:
          type: string
          description: Filters the results to include only billing views that use the specified account as a source.
        maxResults:
          type: integer
          description: The maximum number of billing views to retrieve. Default is 100.
        nextToken:
          type: string
          description: The pagination token that is used on subsequent calls to list billing views.
    ListBillingViewsResponse:
      type: object
      properties:
        billingViews:
          type: array
          items:
            $ref: '#/components/schemas/BillingViewListElement'
          description: A list of BillingViewListElement retrieved.
        nextToken:
          type: string
          description: The pagination token to use on subsequent calls to list billing views.
      required:
      - billingViews
    StringSearch:
      type: object
      properties:
        searchOption:
          type: string
          enum:
          - STARTS_WITH
          description: The type of search operation to perform on the string value. Determines how the search value is matched
            against the target field.
        searchValue:
          type: string
          description: The string value to use in the search operation. This value is compared against the target field using
            the specified search option.
      required:
      - searchOption
      - searchValue
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    TimeRange:
      type: object
      properties:
        beginDateInclusive:
          type: string
          description: The inclusive start date of the time range.
        endDateInclusive:
          type: string
          description: The inclusive end date of the time range.
    UpdateBillingViewRequest:
      type: object
      properties:
        arn:
          type: string
          description: The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.
        name:
          type: string
          description: The name of the billing view.
        description:
          type: string
          description: The description of the billing view.
        dataFilterExpression:
          $ref: '#/components/schemas/BillingExpression'
      required:
      - arn
    UpdateBillingViewResponse:
      type: object
      properties:
        arn:
          type: string
          description: The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.
        updatedAt:
          type: string
          description: The time when the billing view was last updated.
      required:
      - arn
    ValidationException:
      type: object
      properties:
        message:
          type: string
        reason:
          type: string
          enum:
          - unknownOperation
          - cannotParse
          - fieldValidationFailed
          - other
          description: The input fails to satisfy the constraints specified by an Amazon Web Services service.
        fieldList:
          type: array
          items:
            $ref: '#/components/schemas/ValidationExceptionField'
          description: The input fails to satisfy the constraints specified by an Amazon Web Services service.
      required:
      - message
      - reason
    ValidationExceptionField:
      type: object
      properties:
        name:
          type: string
          description: The name of the field.
        message:
          type: string
          description: The message describing why the field failed validation.
      required:
      - name
      - message
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/billing/service/2023-09-07/billing-2023-09-07.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)