AWS Backup

AWS Backup Backup Notification Configuration API

The Backup Notification Configuration API from AWS Backup — 1 operation(s) for backup notification configuration.

GitHub OpenAPI

Operations 3

DELETE /backup-vaults/{BackupVaultName}/notification-configuration Delete Backup Vault Notifications #
GET /backup-vaults/{BackupVaultName}/notification-configuration Get Backup Vault Notifications #
PUT /backup-vaults/{BackupVaultName}/notification-configuration Put Backup Vault Notifications #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/aws-backup/openapi/aws-backup-notification-configuration-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/aws-backup:aws-backup-notification-configuration-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

aws-backup-notification-configuration-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: AWS Backup Notification Configuration API
  version: '2018-11-15'
  description: Generated from AWS's published Smithy model for AWS Backup. 3 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://backup.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Notification Configuration
paths:
  /backup-vaults/{BackupVaultName}/notification-configuration:
    delete:
      operationId: DeleteBackupVaultNotifications
      summary: Delete Backup Vault Notifications
      description: Deletes event notifications for the specified backup vault.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '400':
          description: InvalidParameterValueException; MissingParameterValueException; ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '500':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteBackupVaultNotificationsInput'
      tags:
      - Notification Configuration
    get:
      operationId: GetBackupVaultNotifications
      summary: Get Backup Vault Notifications
      description: Returns event notifications for the specified backup vault.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetBackupVaultNotificationsOutput'
        '400':
          description: InvalidParameterValueException; MissingParameterValueException; ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '500':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetBackupVaultNotificationsInput'
      tags:
      - Notification Configuration
    put:
      operationId: PutBackupVaultNotifications
      summary: Put Backup Vault Notifications
      description: Turns on notifications on a backup vault for the specified topic and events.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '400':
          description: InvalidParameterValueException; MissingParameterValueException; ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '500':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutBackupVaultNotificationsInput'
      tags:
      - Notification Configuration
components:
  schemas:
    ServiceUnavailableException:
      type: object
      properties:
        Code:
          type: string
        Message:
          type: string
        Type:
          type: string
        Context:
          type: string
    InvalidParameterValueException:
      type: object
      properties:
        Code:
          type: string
        Message:
          type: string
        Type:
          type: string
        Context:
          type: string
    GetBackupVaultNotificationsInput:
      type: object
      properties:
        BackupVaultName:
          type: string
          description: The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.
      required:
      - BackupVaultName
    DeleteBackupVaultNotificationsInput:
      type: object
      properties:
        BackupVaultName:
          type: string
          description: The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created.
      required:
      - BackupVaultName
    PutBackupVaultNotificationsInput:
      type: object
      properties:
        BackupVaultName:
          type: string
          description: The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.
        SNSTopicArn:
          type: string
          description: The Amazon Resource Name (ARN) that specifies the topic for a backup vault’s events; for example, arn:aws:sns:us-west-2:111122223333:MyVaultTopic.
        BackupVaultEvents:
          type: array
          items:
            type: string
            enum:
            - BACKUP_JOB_STARTED
            - BACKUP_JOB_COMPLETED
            - BACKUP_JOB_SUCCESSFUL
            - BACKUP_JOB_FAILED
            - BACKUP_JOB_EXPIRED
            - RESTORE_JOB_STARTED
            - RESTORE_JOB_COMPLETED
            - RESTORE_JOB_SUCCESSFUL
            - RESTORE_JOB_FAILED
            - COPY_JOB_STARTED
            - COPY_JOB_SUCCESSFUL
            - COPY_JOB_FAILED
            - RECOVERY_POINT_MODIFIED
            - BACKUP_PLAN_CREATED
            - BACKUP_PLAN_MODIFIED
            - S3_BACKUP_OBJECT_FAILED
            - S3_RESTORE_OBJECT_FAILED
            - CONTINUOUS_BACKUP_INTERRUPTED
            - RECOVERY_POINT_INDEX_COMPLETED
            - RECOVERY_POINT_INDEX_DELETED
            - RECOVERY_POINT_INDEXING_FAILED
            - EKS_RESTORE_OBJECT_FAILED
            - EKS_RESTORE_OBJECT_SKIPPED
            - EKS_BACKUP_OBJECT_FAILED
            - ACCESS_POINT_AVAILABLE
            - ACCESS_POINT_CREATION_FAILED
            - ACCESS_POINT_DELETED
            - ACCESS_POINT_DELETION_FAILED
            - ACCESS_POINT_EXPIRED
            - ACCESS_POINT_DISASSOCIATED
          description: An array of events that indicate the status of jobs to back up resources to the backup vault. For the list of supported events, common use cases, and code samples, see Notification options with Backup.
      required:
      - BackupVaultName
      - SNSTopicArn
      - BackupVaultEvents
    GetBackupVaultNotificationsOutput:
      type: object
      properties:
        BackupVaultName:
          type: string
          description: The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created.
        BackupVaultArn:
          type: string
          description: An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
        SNSTopicArn:
          type: string
          description: An ARN that uniquely identifies an Amazon Simple Notification Service (Amazon SNS) topic; for example, arn:aws:sns:us-west-2:111122223333:MyTopic.
        BackupVaultEvents:
          type: array
          items:
            type: string
            enum:
            - BACKUP_JOB_STARTED
            - BACKUP_JOB_COMPLETED
            - BACKUP_JOB_SUCCESSFUL
            - BACKUP_JOB_FAILED
            - BACKUP_JOB_EXPIRED
            - RESTORE_JOB_STARTED
            - RESTORE_JOB_COMPLETED
            - RESTORE_JOB_SUCCESSFUL
            - RESTORE_JOB_FAILED
            - COPY_JOB_STARTED
            - COPY_JOB_SUCCESSFUL
            - COPY_JOB_FAILED
            - RECOVERY_POINT_MODIFIED
            - BACKUP_PLAN_CREATED
            - BACKUP_PLAN_MODIFIED
            - S3_BACKUP_OBJECT_FAILED
            - S3_RESTORE_OBJECT_FAILED
            - CONTINUOUS_BACKUP_INTERRUPTED
            - RECOVERY_POINT_INDEX_COMPLETED
            - RECOVERY_POINT_INDEX_DELETED
            - RECOVERY_POINT_INDEXING_FAILED
            - EKS_RESTORE_OBJECT_FAILED
            - EKS_RESTORE_OBJECT_SKIPPED
            - EKS_BACKUP_OBJECT_FAILED
            - ACCESS_POINT_AVAILABLE
            - ACCESS_POINT_CREATION_FAILED
            - ACCESS_POINT_DELETED
            - ACCESS_POINT_DELETION_FAILED
            - ACCESS_POINT_EXPIRED
            - ACCESS_POINT_DISASSOCIATED
          description: An array of events that indicate the status of jobs to back up resources to the backup vault.
  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: backup
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/backup/service/2018-11-15/backup-2018-11-15.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)