Amazon Billing And Cost Management Billing And Cost Management Subscriber API

openapi: 3.2.0
info:
  title: AWS Cost Explorer Service Subscriber 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: []
tags:
- name: Subscriber
paths:
  /#CreateSubscriber:
    post:
      operationId: CreateSubscriber
      summary: Create Subscriber
      description: Creates a subscriber. You must create the associated budget and notification before you create the subscriber.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateSubscriberResponse'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '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.CreateSubscriber
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateSubscriberRequest'
      tags:
      - Subscriber
  /#DeleteSubscriber:
    post:
      operationId: DeleteSubscriber
      summary: Delete Subscriber
      description: Deletes a subscriber. Deleting the last subscriber to a notification also deletes the notification.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteSubscriberResponse'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '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.DeleteSubscriber
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteSubscriberRequest'
      tags:
      - Subscriber
  /#DescribeSubscribersForNotification:
    post:
      operationId: DescribeSubscribersForNotification
      summary: Describe Subscribers For Notification
      description: Lists the subscribers that are associated with a notification.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeSubscribersForNotificationResponse'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '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.DescribeSubscribersForNotification
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeSubscribersForNotificationRequest'
      tags:
      - Subscriber
  /#UpdateSubscriber:
    post:
      operationId: UpdateSubscriber
      summary: Update Subscriber
      description: Updates a subscriber.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateSubscriberResponse'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '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.UpdateSubscriber
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateSubscriberRequest'
      tags:
      - Subscriber
components:
  schemas:
    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
    DescribeSubscribersForNotificationRequest:
      type: object
      properties:
        AccountId:
          type: string
          description: The accountId that is associated with the budget whose subscribers you want descriptions of.
        BudgetName:
          type: string
          description: The name of the budget whose subscribers you want descriptions of.
        Notification:
          $ref: '#/components/schemas/Notification'
        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
      - Notification
    DeleteSubscriberRequest:
      type: object
      properties:
        AccountId:
          type: string
          description: The accountId that is associated with the budget whose subscriber you want to delete.
        BudgetName:
          type: string
          description: The name of the budget whose subscriber you want to delete.
        Notification:
          $ref: '#/components/schemas/Notification'
        Subscriber:
          $ref: '#/components/schemas/BudgetsSubscriber'
      required:
      - AccountId
      - BudgetName
      - Notification
      - Subscriber
    DescribeSubscribersForNotificationResponse:
      type: object
      properties:
        Subscribers:
          type: array
          items:
            $ref: '#/components/schemas/BudgetsSubscriber'
          description: A list of subscribers that are associated with a notification.
        NextToken:
          type: string
          description: The pagination token in the service response that indicates the next set of results that you can retrieve.
    CreationLimitExceededException:
      type: object
      properties:
        Message:
          type: string
    DeleteSubscriberResponse:
      type: object
      properties: {}
    DuplicateRecordException:
      type: object
      properties:
        Message:
          type: string
    ExpiredNextTokenException:
      type: object
      properties:
        Message:
          type: string
    CreateSubscriberRequest:
      type: object
      properties:
        AccountId:
          type: string
          description: The accountId that is associated with the budget that you want to create a subscriber for.
        BudgetName:
          type: string
          description: The name of the budget that you want to subscribe to. Budget names must be unique within an account.
        Notification:
          $ref: '#/components/schemas/Notification'
        Subscriber:
          $ref: '#/components/schemas/BudgetsSubscriber'
      required:
      - AccountId
      - BudgetName
      - Notification
      - Subscriber
    UpdateSubscriberResponse:
      type: object
      properties: {}
    InvalidParameterException:
      type: object
      properties:
        Message:
          type: string
    UpdateSubscriberRequest:
      type: object
      properties:
        AccountId:
          type: string
          description: The accountId that is associated with the budget whose subscriber you want to update.
        BudgetName:
          type: string
          description: The name of the budget whose subscriber you want to update.
        Notification:
          $ref: '#/components/schemas/Notification'
        OldSubscriber:
          $ref: '#/components/schemas/BudgetsSubscriber'
        NewSubscriber:
          $ref: '#/components/schemas/BudgetsSubscriber'
      required:
      - AccountId
      - BudgetName
      - Notification
      - OldSubscriber
      - NewSubscriber
    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
    InternalErrorException:
      type: object
      properties:
        Message:
          type: string
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
    NotFoundException:
      type: object
      properties:
        Message:
          type: string
    CreateSubscriberResponse:
      type: object
      properties: {}
  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
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/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)