Amazon Billing And Cost Management Notifications API

openapi: 3.1.0
info:
  title: AWS Cost Explorer Service Notifications 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://budgets.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /#CreateNotification:
    post:
      operationId: CreateNotification
      summary: Create Notification
      description: Creates a notification. You must create the budget before you create the associated notification.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateNotificationResponse'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/BudgetsAccessDeniedException'
        '405':
          description: CreationLimitExceededException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreationLimitExceededException'
        '409':
          description: DuplicateRecordException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DuplicateRecordException'
        '500':
          description: InternalErrorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalErrorException'
        '400':
          description: InvalidParameterException; ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '404':
          description: NotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/NotFoundException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSBudgetServiceGateway.CreateNotification
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateNotificationRequest'
      tags:
      - Notifications
  /#DeleteNotification:
    post:
      operationId: DeleteNotification
      summary: Delete Notification
      description: Deletes a notification. Deleting a notification also deletes the subscribers that are associated with the
        notification.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteNotificationResponse'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/BudgetsAccessDeniedException'
        '500':
          description: InternalErrorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalErrorException'
        '400':
          description: InvalidParameterException; ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '404':
          description: NotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/NotFoundException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSBudgetServiceGateway.DeleteNotification
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteNotificationRequest'
      tags:
      - Notifications
  /#DescribeNotificationsForBudget:
    post:
      operationId: DescribeNotificationsForBudget
      summary: Describe Notifications For Budget
      description: Lists the notifications that are associated with a budget.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeNotificationsForBudgetResponse'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/BudgetsAccessDeniedException'
        '400':
          description: ExpiredNextTokenException; InvalidNextTokenException; InvalidParameterException; ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ExpiredNextTokenException'
        '500':
          description: InternalErrorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalErrorException'
        '404':
          description: NotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/NotFoundException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSBudgetServiceGateway.DescribeNotificationsForBudget
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeNotificationsForBudgetRequest'
      tags:
      - Notifications
  /#UpdateNotification:
    post:
      operationId: UpdateNotification
      summary: Update Notification
      description: Updates a notification.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateNotificationResponse'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/BudgetsAccessDeniedException'
        '409':
          description: DuplicateRecordException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DuplicateRecordException'
        '500':
          description: InternalErrorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalErrorException'
        '400':
          description: InvalidParameterException; ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '404':
          description: NotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/NotFoundException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSBudgetServiceGateway.UpdateNotification
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateNotificationRequest'
      tags:
      - Notifications
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: budgets
  schemas:
    BudgetsAccessDeniedException:
      type: object
      properties:
        Message:
          type: string
    BudgetsSubscriber:
      type: object
      properties:
        SubscriptionType:
          type: string
          enum:
          - SNS
          - EMAIL
          description: The type of notification that Amazon Web Services sends to a subscriber.
        Address:
          type: string
          description: The address that Amazon Web Services sends budget notifications to, either an SNS topic or an email.
            When you create a subscriber, the value of Address can't contain line breaks.
      required:
      - SubscriptionType
      - Address
    CreateNotificationRequest:
      type: object
      properties:
        AccountId:
          type: string
          description: The accountId that is associated with the budget that you want to create a notification for.
        BudgetName:
          type: string
          description: The name of the budget that you want Amazon Web Services to notify you about. Budget names must be
            unique within an account.
        Notification:
          $ref: '#/components/schemas/Notification'
        Subscribers:
          type: array
          items:
            $ref: '#/components/schemas/BudgetsSubscriber'
          description: A list of subscribers that you want to associate with the notification. Each notification can have
            one SNS subscriber and up to 10 email subscribers.
      required:
      - AccountId
      - BudgetName
      - Notification
      - Subscribers
    CreateNotificationResponse:
      type: object
      properties: {}
    CreationLimitExceededException:
      type: object
      properties:
        Message:
          type: string
    DeleteNotificationRequest:
      type: object
      properties:
        AccountId:
          type: string
          description: The accountId that is associated with the budget whose notification you want to delete.
        BudgetName:
          type: string
          description: The name of the budget whose notification you want to delete.
        Notification:
          $ref: '#/components/schemas/Notification'
      required:
      - AccountId
      - BudgetName
      - Notification
    DeleteNotificationResponse:
      type: object
      properties: {}
    DescribeNotificationsForBudgetRequest:
      type: object
      properties:
        AccountId:
          type: string
          description: The accountId that is associated with the budget whose notifications you want descriptions of.
        BudgetName:
          type: string
          description: The name of the budget whose notifications you want descriptions of.
        MaxResults:
          type: integer
          description: An optional integer that represents how many entries a paginated response contains.
        NextToken:
          type: string
          description: The pagination token that you include in your request to indicate the next set of results that you
            want to retrieve.
      required:
      - AccountId
      - BudgetName
    DescribeNotificationsForBudgetResponse:
      type: object
      properties:
        Notifications:
          type: array
          items:
            $ref: '#/components/schemas/Notification'
          description: A list of notifications that are associated with a budget.
        NextToken:
          type: string
          description: The pagination token in the service response that indicates the next set of results that you can retrieve.
    DuplicateRecordException:
      type: object
      properties:
        Message:
          type: string
    ExpiredNextTokenException:
      type: object
      properties:
        Message:
          type: string
    InternalErrorException:
      type: object
      properties:
        Message:
          type: string
    InvalidParameterException:
      type: object
      properties:
        Message:
          type: string
    NotFoundException:
      type: object
      properties:
        Message:
          type: string
    Notification:
      type: object
      properties:
        NotificationType:
          type: string
          enum:
          - ACTUAL
          - FORECASTED
          description: Specifies whether the notification is for how much you have spent (ACTUAL) or for how much that you're
            forecasted to spend (FORECASTED).
        ComparisonOperator:
          type: string
          enum:
          - GREATER_THAN
          - LESS_THAN
          - EQUAL_TO
          description: The comparison that's used for this notification.
        Threshold:
          type: number
          description: The threshold that's associated with a notification. Thresholds are always a percentage, and many customers
            find value being alerted between 50% - 200% of the budgeted amount. The maximum limit for your threshold is 1,000,000%
            above the budgeted amount.
        ThresholdType:
          type: string
          enum:
          - PERCENTAGE
          - ABSOLUTE_VALUE
          description: The type of threshold for a notification. For ABSOLUTE_VALUE thresholds, Amazon Web Services notifies
            you when you go over or are forecasted to go over your total cost threshold. For PERCENTAGE thresholds, Amazon
            Web Services notifies you when you go over or are forecasted to go over a certain percentage of your forecasted
            spend. For example, if you have a budget for 200 dollars and you have a PERCENTAGE threshold of 80%, Amazon Web
            Services notifies you when you go over 160 dollars.
        NotificationState:
          type: string
          enum:
          - OK
          - ALARM
          description: Specifies whether this notification is in alarm. If a budget notification is in the ALARM state, you
            passed the set threshold for the budget.
      required:
      - NotificationType
      - ComparisonOperator
      - Threshold
    UpdateNotificationRequest:
      type: object
      properties:
        AccountId:
          type: string
          description: The accountId that is associated with the budget whose notification you want to update.
        BudgetName:
          type: string
          description: The name of the budget whose notification you want to update.
        OldNotification:
          $ref: '#/components/schemas/Notification'
        NewNotification:
          $ref: '#/components/schemas/Notification'
      required:
      - AccountId
      - BudgetName
      - OldNotification
      - NewNotification
    UpdateNotificationResponse:
      type: object
      properties: {}
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/budgets/service/2016-10-20/budgets-2016-10-20.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)