Amazon Neptune Events API

openapi: 3.2.0
info:
  title: Amazon Neptune Management Events API
  description: Amazon Neptune Management API for creating, managing, and deleting Neptune DB clusters, instances, parameter groups, snapshots, and related infrastructure resources. This is an AWS Query API that uses HTTPS requests with Action and parameter query strings.
  version: '2014-10-31'
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/neptune/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: https://rds.{region}.amazonaws.com
  description: Amazon Neptune Management API regional endpoint
  variables:
    region:
      default: us-east-1
      description: AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-north-1
      - ap-southeast-1
      - ap-southeast-2
      - ap-northeast-1
      - ap-northeast-2
      - ap-south-1
      - ca-central-1
      - me-south-1
      - sa-east-1
security:
- aws_sigv4: []
tags:
- name: Events
  description: Operations for managing event subscriptions and viewing events
paths:
  /?Action=CreateEventSubscription:
    post:
      operationId: createEventSubscription
      summary: Amazon Neptune Create a Neptune Event Notification Subscription
      description: Creates an event notification subscription. This action requires an Amazon SNS topic ARN. Notifications are sent to the SNS topic when specified events occur.
      tags:
      - Events
      parameters:
      - name: Action
        in: query
        required: true
        schema:
          type: string
          enum:
          - CreateEventSubscription
      - name: SubscriptionName
        in: query
        required: true
        description: The name of the subscription.
        schema:
          type: string
      - name: SnsTopicArn
        in: query
        required: true
        description: The ARN of the SNS topic to send notifications to.
        schema:
          type: string
      - name: SourceType
        in: query
        description: The type of source that triggers notifications (db-instance, db-cluster, db-parameter-group, db-cluster-snapshot).
        schema:
          type: string
      - name: Enabled
        in: query
        description: Whether the subscription is enabled.
        schema:
          type: boolean
      - name: Version
        in: query
        required: true
        schema:
          type: string
          default: '2014-10-31'
      responses:
        '200':
          description: Event subscription created successfully.
        '400':
          description: Invalid request parameters.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /?Action=DescribeEvents:
    get:
      operationId: describeEvents
      summary: Amazon Neptune Describe Neptune Events
      description: Returns events related to DB instances, DB clusters, DB parameter groups, and DB cluster snapshots for the past 14 days.
      tags:
      - Events
      parameters:
      - name: Action
        in: query
        required: true
        schema:
          type: string
          enum:
          - DescribeEvents
      - name: SourceIdentifier
        in: query
        description: The identifier of the event source to filter events.
        schema:
          type: string
      - name: SourceType
        in: query
        description: The event source type to filter events.
        schema:
          type: string
      - name: Duration
        in: query
        description: The number of minutes to retrieve events for.
        schema:
          type: integer
      - name: MaxRecords
        in: query
        schema:
          type: integer
      - name: Marker
        in: query
        schema:
          type: string
      - name: Version
        in: query
        required: true
        schema:
          type: string
          default: '2014-10-31'
      responses:
        '200':
          description: Successful response with event details.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  securitySchemes:
    aws_sigv4:
      type: apiKey
      name: Authorization
      in: header
      description: AWS Signature Version 4 authentication