Amazon Billing And Cost Management Billing And Cost Management Report Definition API

openapi: 3.1.0
info:
  title: AWS Cost Explorer Service Report Definition 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://cur.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /#DeleteReportDefinition:
    post:
      operationId: DeleteReportDefinition
      summary: Delete Report Definition
      description: Deletes the specified report. Any tags associated with the report are also deleted.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteReportDefinitionResponse'
        '500':
          description: InternalErrorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalErrorException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CurValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSOrigamiServiceGatewayService.DeleteReportDefinition
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteReportDefinitionRequest'
            example:
              ReportName: ExampleReport
      tags:
      - Report Definition
  /#DescribeReportDefinitions:
    post:
      operationId: DescribeReportDefinitions
      summary: Describe Report Definitions
      description: Lists the Amazon Web Services Cost and Usage Report available to this account.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeReportDefinitionsResponse'
              example:
                ReportDefinitions:
                - AdditionalArtifacts:
                  - QUICKSIGHT
                  AdditionalSchemaElements:
                  - RESOURCES
                  Compression: GZIP
                  Format: textORcsv
                  ReportName: ExampleReport
                  S3Bucket: example-s3-bucket
                  S3Prefix: exampleprefix
                  S3Region: us-east-1
                  TimeUnit: HOURLY
                - AdditionalArtifacts:
                  - QUICKSIGHT
                  AdditionalSchemaElements:
                  - RESOURCES
                  Compression: GZIP
                  Format: textORcsv
                  ReportName: ExampleReport2
                  S3Bucket: example-s3-bucket
                  S3Prefix: exampleprefix
                  S3Region: us-east-1
                  TimeUnit: HOURLY
        '500':
          description: InternalErrorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalErrorException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSOrigamiServiceGatewayService.DescribeReportDefinitions
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeReportDefinitionsRequest'
            example:
              MaxResults: 5
      tags:
      - Report Definition
  /#ModifyReportDefinition:
    post:
      operationId: ModifyReportDefinition
      summary: Modify Report Definition
      description: Allows you to programmatically update your report preferences.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ModifyReportDefinitionResponse'
        '500':
          description: InternalErrorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalErrorException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CurValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSOrigamiServiceGatewayService.ModifyReportDefinition
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ModifyReportDefinitionRequest'
      tags:
      - Report Definition
  /#PutReportDefinition:
    post:
      operationId: PutReportDefinition
      summary: Put Report Definition
      description: Creates a new report using the description that you provide.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/PutReportDefinitionResponse'
        '400':
          description: DuplicateReportNameException; ReportLimitReachedException; ResourceNotFoundException; ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DuplicateReportNameException'
        '500':
          description: InternalErrorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalErrorException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSOrigamiServiceGatewayService.PutReportDefinition
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/PutReportDefinitionRequest'
            example:
              ReportDefinition:
                ReportName: ExampleReport
                TimeUnit: DAILY
                Format: textORcsv
                Compression: ZIP
                AdditionalSchemaElements:
                - RESOURCES
                S3Bucket: example-s3-bucket
                S3Prefix: exampleprefix
                S3Region: us-east-1
                AdditionalArtifacts:
                - REDSHIFT
                - QUICKSIGHT
      tags:
      - Report Definition
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: cur
  schemas:
    CurValidationException:
      type: object
      properties:
        Message:
          type: string
    DeleteReportDefinitionRequest:
      type: object
      properties:
        ReportName:
          type: string
          description: The name of the report that you want to delete. The name must be unique, is case sensitive, and can't
            include spaces.
      required:
      - ReportName
    DeleteReportDefinitionResponse:
      type: object
      properties:
        ResponseMessage:
          type: string
    DescribeReportDefinitionsRequest:
      type: object
      properties:
        MaxResults:
          type: integer
        NextToken:
          type: string
    DescribeReportDefinitionsResponse:
      type: object
      properties:
        ReportDefinitions:
          type: array
          items:
            $ref: '#/components/schemas/ReportDefinition'
          description: An Amazon Web Services Cost and Usage Report list owned by the account.
        NextToken:
          type: string
    DuplicateReportNameException:
      type: object
      properties:
        Message:
          type: string
    InternalErrorException:
      type: object
      properties:
        Message:
          type: string
    ModifyReportDefinitionRequest:
      type: object
      properties:
        ReportName:
          type: string
        ReportDefinition:
          $ref: '#/components/schemas/ReportDefinition'
      required:
      - ReportName
      - ReportDefinition
    ModifyReportDefinitionResponse:
      type: object
      properties: {}
    PutReportDefinitionRequest:
      type: object
      properties:
        ReportDefinition:
          $ref: '#/components/schemas/ReportDefinition'
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The tags to be assigned to the report definition resource.
      required:
      - ReportDefinition
    PutReportDefinitionResponse:
      type: object
      properties: {}
    ReportDefinition:
      type: object
      properties:
        ReportName:
          type: string
        TimeUnit:
          type: string
          enum:
          - HOURLY
          - DAILY
          - MONTHLY
        Format:
          type: string
          enum:
          - textORcsv
          - Parquet
        Compression:
          type: string
          enum:
          - ZIP
          - GZIP
          - Parquet
        AdditionalSchemaElements:
          type: array
          items:
            type: string
            enum:
            - RESOURCES
            - SPLIT_COST_ALLOCATION_DATA
            - MANUAL_DISCOUNT_COMPATIBILITY
          description: A list of strings that indicate additional content that Amazon Web Services includes in the report,
            such as individual resource IDs.
        S3Bucket:
          type: string
        S3Prefix:
          type: string
        S3Region:
          type: string
          enum:
          - af-south-1
          - ap-east-1
          - ap-south-1
          - ap-south-2
          - ap-southeast-1
          - ap-southeast-2
          - ap-southeast-3
          - ap-northeast-1
          - ap-northeast-2
          - ap-northeast-3
          - ca-central-1
          - eu-central-1
          - eu-central-2
          - eu-west-1
          - eu-west-2
          - eu-west-3
          - eu-north-1
          - eu-south-1
          - eu-south-2
          - me-central-1
          - me-south-1
          - sa-east-1
          - us-east-1
          - us-east-2
          - us-west-1
          - us-west-2
          - cn-north-1
          - cn-northwest-1
        AdditionalArtifacts:
          type: array
          items:
            type: string
            enum:
            - REDSHIFT
            - QUICKSIGHT
            - ATHENA
          description: A list of manifests that you want Amazon Web Services to create for this report.
        RefreshClosedReports:
          type: boolean
          description: Whether you want Amazon Web Services to update your reports after they have been finalized if Amazon
            Web Services detects charges related to previous months. These charges can include refunds, credits, or support
            fees.
        ReportVersioning:
          type: string
          enum:
          - CREATE_NEW_REPORT
          - OVERWRITE_REPORT
          description: Whether you want Amazon Web Services to overwrite the previous version of each report or to deliver
            the report in addition to the previous versions.
        BillingViewArn:
          type: string
          description: 'The Amazon resource name of the billing view. The BillingViewArn is needed to create Amazon Web Services
            Cost and Usage Report for each billing group maintained in the Amazon Web Services Billing Conductor service.
            The BillingViewArn for a billing group can be constructed as: arn:aws:billing::payer-account-id:billingview/billing-group-primary-account-id'
        ReportStatus:
          $ref: '#/components/schemas/ReportStatus'
      required:
      - ReportName
      - TimeUnit
      - Format
      - Compression
      - AdditionalSchemaElements
      - S3Bucket
      - S3Prefix
      - S3Region
    ReportStatus:
      type: object
      properties:
        lastDelivery:
          type: string
          description: A timestamp that gives the date of a report delivery.
        lastStatus:
          type: string
          enum:
          - SUCCESS
          - ERROR_PERMISSIONS
          - ERROR_NO_BUCKET
          description: An enum that gives the status of a report delivery.
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: The key of the tag. Tag keys are case sensitive. Each report definition can only have up to one tag
            with the same key. If you try to add an existing tag with the same key, the existing tag value will be updated
            to the new value.
        Value:
          type: string
          description: The value of the tag. Tag values are case-sensitive. This can be an empty string.
      required:
      - Key
      - Value
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/cost-and-usage-report-service/service/2017-01-06/cost-and-usage-report-service-2017-01-06.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)