Amazon Billing And Cost Management Billing And Cost Management Export API

openapi: 3.1.0
info:
  title: AWS Cost Explorer Service Export 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-data-exports.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /#CreateExport:
    post:
      operationId: CreateExport
      summary: Create Export
      description: Creates a data export and specifies the data query, the delivery preference, and any optional resource
        tags. A DataQuery consists of both a QueryStatement and TableConfigurations. The QueryStatement is an SQL statement.
        Data Exports only supports a limited subset of the SQL syntax. For more information on the SQL syntax that is supported,
        see Data query. To view the available tables and columns, see the Data Exports table dictionary. The TableConfigurations
        is a collection of specified TableProperties for the table being queried in the QueryStatement. TableProperties are
        additional configurations you can provide to change the data and schema of a table. Each table can have different
        TableProperties. However, tables are not required to have any TableProperties. Each table property has a default value
        that it assumes if not specified. For more information on table configurations, see Data query. To view the table
        properties available for each table, see the Data Exports table dictionary or use the ListTables API to get a response
        of all tables and their available properties.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateExportResponse'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/BcmDataExportsAccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/BcmDataExportsInternalServerException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/BcmDataExportsServiceQuotaExceededException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/BcmDataExportsThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/BcmDataExportsValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSBillingAndCostManagementDataExports.CreateExport
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateExportRequest'
      tags:
      - Export
  /#GetExport:
    post:
      operationId: GetExport
      summary: Get Export
      description: Views the definition of an existing data export.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/GetExportResponse'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/BcmDataExportsInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/BcmDataExportsResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/BcmDataExportsThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/BcmDataExportsValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSBillingAndCostManagementDataExports.GetExport
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/GetExportRequest'
      tags:
      - Export
  /#UpdateExport:
    post:
      operationId: UpdateExport
      summary: Update Export
      description: Updates an existing data export by overwriting all export parameters. All export parameters must be provided
        in the UpdateExport request.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateExportResponse'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/BcmDataExportsInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/BcmDataExportsResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/BcmDataExportsThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/BcmDataExportsValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSBillingAndCostManagementDataExports.UpdateExport
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateExportRequest'
      tags:
      - Export
  /#DeleteExport:
    post:
      operationId: DeleteExport
      summary: Delete Export
      description: Deletes an existing data export.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteExportResponse'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/BcmDataExportsInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/BcmDataExportsResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/BcmDataExportsThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/BcmDataExportsValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSBillingAndCostManagementDataExports.DeleteExport
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteExportRequest'
      tags:
      - Export
  /#ListExports:
    post:
      operationId: ListExports
      summary: List Exports
      description: Lists all data export definitions.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListExportsResponse'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/BcmDataExportsInternalServerException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/BcmDataExportsThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/BcmDataExportsValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSBillingAndCostManagementDataExports.ListExports
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListExportsRequest'
      tags:
      - Export
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-data-exports
  schemas:
    BcmDataExportsAccessDeniedException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    BcmDataExportsInternalServerException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    BcmDataExportsResourceNotFoundException:
      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
    BcmDataExportsServiceQuotaExceededException:
      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.
        QuotaCode:
          type: string
          description: The quota code that was exceeded.
        ServiceCode:
          type: string
          description: The service code that exceeded quota. It will always be “AWSBillingAndCostManagementDataExports”.
      required:
      - Message
      - QuotaCode
      - ServiceCode
    BcmDataExportsThrottlingException:
      type: object
      properties:
        Message:
          type: string
        QuotaCode:
          type: string
          description: The quota code that exceeded the throttling limit.
        ServiceCode:
          type: string
          description: The service code that exceeded the throttling limit. It will always be “AWSBillingAndCostManagementDataExports”.
      required:
      - Message
    BcmDataExportsValidationException:
      type: object
      properties:
        Message:
          type: string
        Reason:
          type: string
          enum:
          - unknownOperation
          - cannotParse
          - fieldValidationFailed
          - other
          description: The reason for the validation exception.
        Fields:
          type: array
          items:
            $ref: '#/components/schemas/BcmDataExportsValidationExceptionField'
          description: The list of fields that are invalid.
      required:
      - Message
    BcmDataExportsValidationExceptionField:
      type: object
      properties:
        Name:
          type: string
          description: The field name where the invalid entry was detected.
        Message:
          type: string
          description: A message with the reason for the validation exception error.
      required:
      - Name
      - Message
    CreateExportRequest:
      type: object
      properties:
        Export:
          $ref: '#/components/schemas/Export'
        ResourceTags:
          type: array
          items:
            $ref: '#/components/schemas/ResourceTag'
          description: An optional list of tags to associate with the specified export. Each tag consists of a key and a value,
            and each key must be unique for the resource.
      required:
      - Export
    CreateExportResponse:
      type: object
      properties:
        ExportArn:
          type: string
          description: The Amazon Resource Name (ARN) for this export.
    DataQuery:
      type: object
      properties:
        QueryStatement:
          type: string
          description: The query statement.
        TableConfigurations:
          type: object
          additionalProperties:
            type: object
            additionalProperties:
              type: string
          description: The table configuration.
      required:
      - QueryStatement
    DeleteExportRequest:
      type: object
      properties:
        ExportArn:
          type: string
          description: The Amazon Resource Name (ARN) for this export.
      required:
      - ExportArn
    DeleteExportResponse:
      type: object
      properties:
        ExportArn:
          type: string
          description: The Amazon Resource Name (ARN) for this export.
    DestinationConfigurations:
      type: object
      properties:
        S3Destination:
          $ref: '#/components/schemas/S3Destination'
      required:
      - S3Destination
    Export:
      type: object
      properties:
        ExportArn:
          type: string
          description: The Amazon Resource Name (ARN) for this export.
        Name:
          type: string
          description: The name of this specific data export.
        Description:
          type: string
          description: The description for this specific data export.
        DataQuery:
          $ref: '#/components/schemas/DataQuery'
        DestinationConfigurations:
          $ref: '#/components/schemas/DestinationConfigurations'
        RefreshCadence:
          $ref: '#/components/schemas/RefreshCadence'
      required:
      - Name
      - DataQuery
      - DestinationConfigurations
      - RefreshCadence
    ExportReference:
      type: object
      properties:
        ExportArn:
          type: string
          description: The Amazon Resource Name (ARN) for this export.
        ExportName:
          type: string
          description: The name of this specific data export.
        ExportStatus:
          $ref: '#/components/schemas/ExportStatus'
      required:
      - ExportArn
      - ExportName
      - ExportStatus
    ExportStatus:
      type: object
      properties:
        StatusCode:
          type: string
          enum:
          - HEALTHY
          - UNHEALTHY
          description: The status code for the request.
        StatusReason:
          type: string
          enum:
          - INSUFFICIENT_PERMISSION
          - BILL_OWNER_CHANGED
          - INTERNAL_FAILURE
          - DEPRECATED
          description: The description for the status code.
        CreatedAt:
          type: string
          description: The timestamp of when the export was created.
        LastUpdatedAt:
          type: string
          description: The timestamp of when the export was updated.
        LastRefreshedAt:
          type: string
          description: The timestamp of when the export was last generated.
    GetExportRequest:
      type: object
      properties:
        ExportArn:
          type: string
          description: The Amazon Resource Name (ARN) for this export.
      required:
      - ExportArn
    GetExportResponse:
      type: object
      properties:
        Export:
          $ref: '#/components/schemas/Export'
        ExportStatus:
          $ref: '#/components/schemas/ExportStatus'
    ListExportsRequest:
      type: object
      properties:
        MaxResults:
          type: integer
          description: The maximum number of objects that are returned for the request.
        NextToken:
          type: string
          description: The token to retrieve the next set of results.
    ListExportsResponse:
      type: object
      properties:
        Exports:
          type: array
          items:
            $ref: '#/components/schemas/ExportReference'
          description: The details of the exports, including name and export status.
        NextToken:
          type: string
          description: The token to retrieve the next set of results.
    RefreshCadence:
      type: object
      properties:
        Frequency:
          type: string
          enum:
          - SYNCHRONOUS
          description: The frequency that data exports are updated. The export refreshes each time the source data updates,
            up to three times daily.
      required:
      - Frequency
    ResourceTag:
      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
      - Value
    S3Destination:
      type: object
      properties:
        S3Bucket:
          type: string
          description: The name of the Amazon S3 bucket used as the destination of a data export file.
        S3BucketOwner:
          type: string
          description: The Amazon Web Services account ID that owns the S3 bucket used as the destination for the data export.
        S3Prefix:
          type: string
          description: The S3 path prefix you want prepended to the name of your data export.
        S3Region:
          type: string
          description: The S3 bucket Region.
        S3OutputConfigurations:
          $ref: '#/components/schemas/S3OutputConfigurations'
      required:
      - S3Bucket
      - S3Prefix
      - S3Region
      - S3OutputConfigurations
    S3OutputConfigurations:
      type: object
      properties:
        OutputType:
          type: string
          enum:
          - CUSTOM
          - ATHENA
          - REDSHIFT
          description: The output type for the data export.
        Format:
          type: string
          enum:
          - TEXT_OR_CSV
          - PARQUET
          description: The file format for the data export.
        Compression:
          type: string
          enum:
          - GZIP
          - PARQUET
          - ZIP
          description: The compression type for the data export.
        Overwrite:
          type: string
          enum:
          - CREATE_NEW_REPORT
          - OVERWRITE_REPORT
          description: The rule to follow when generating a version of the data export file. You have the choice to overwrite
            the previous version or to be delivered in addition to the previous versions. Overwriting exports can save on
            Amazon S3 storage costs. Creating new export versions allows you to track the changes in cost and usage data over
            time.
      required:
      - OutputType
      - Format
      - Compression
      - Overwrite
    UpdateExportRequest:
      type: object
      properties:
        ExportArn:
          type: string
          description: The Amazon Resource Name (ARN) for this export.
        Export:
          $ref: '#/components/schemas/Export'
      required:
      - ExportArn
      - Export
    UpdateExportResponse:
      type: object
      properties:
        ExportArn:
          type: string
          description: The Amazon Resource Name (ARN) for this export.
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/bcm-data-exports/service/2023-11-26/bcm-data-exports-2023-11-26.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)