Amazon Neptune Neptune Event Subscription API

openapi: 3.1.0
info:
  title: Amazon Neptune Event Subscription API
  version: '2014-10-31'
  description: Generated from AWS's published Smithy model for Amazon Neptune. 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://rds.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /?Action=CreateEventSubscription:
    post:
      operationId: CreateEventSubscription
      summary: Create Event Subscription
      description: Creates an event notification subscription. This action requires a topic ARN (Amazon Resource Name) created
        by either the Neptune console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic
        in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console. You can specify the type of source
        (SourceType) you want to be notified of, provide a list of Neptune sources (SourceIds) that triggers the events, and
        provide a list of event categories (EventCategories) for events you want to be notified of. For example, you can specify
        SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup. If
        you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier = myDBInstance1,
        you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify
        a SourceIdentifier, you receive notice of the events for that source type for all your Neptune sources. If you do
        not specify either the SourceType nor the SourceIdentifier, you are notified of events generated from all Neptune
        sources belonging to your customer accoun
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateEventSubscriptionResult'
        '400':
          description: EventSubscriptionQuotaExceededFault; SNSInvalidTopicFault; SNSNoAuthorizationFault; SubscriptionAlreadyExistFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/EventSubscriptionQuotaExceededFault'
        '404':
          description: SNSTopicArnNotFoundFault; SourceNotFoundFault; SubscriptionCategoryNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/SNSTopicArnNotFoundFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CreateEventSubscription
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/CreateEventSubscriptionMessage'
      tags:
      - Event Subscription
  /?Action=DeleteEventSubscription:
    post:
      operationId: DeleteEventSubscription
      summary: Delete Event Subscription
      description: Deletes an event notification subscription.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DeleteEventSubscriptionResult'
        '400':
          description: InvalidEventSubscriptionStateFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidEventSubscriptionStateFault'
        '404':
          description: SubscriptionNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/SubscriptionNotFoundFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteEventSubscription
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/DeleteEventSubscriptionMessage'
      tags:
      - Event Subscription
  /?Action=DescribeEventSubscriptions:
    post:
      operationId: DescribeEventSubscriptions
      summary: Describe Event Subscriptions
      description: Lists all the subscription descriptions for a customer account. The description for a subscription includes
        SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status. If you specify a SubscriptionName,
        lists the description for that subscription.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/EventSubscriptionsMessage'
        '404':
          description: SubscriptionNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/SubscriptionNotFoundFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeEventSubscriptions
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/DescribeEventSubscriptionsMessage'
      tags:
      - Event Subscription
  /?Action=ModifyEventSubscription:
    post:
      operationId: ModifyEventSubscription
      summary: Modify Event Subscription
      description: Modifies an existing event notification subscription. Note that you can't modify the source identifiers
        using this call; to change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription
        calls. You can see a list of the event categories for a given SourceType by using the DescribeEventCategories action.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ModifyEventSubscriptionResult'
        '400':
          description: EventSubscriptionQuotaExceededFault; SNSInvalidTopicFault; SNSNoAuthorizationFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/EventSubscriptionQuotaExceededFault'
        '404':
          description: SNSTopicArnNotFoundFault; SubscriptionCategoryNotFoundFault; SubscriptionNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/SNSTopicArnNotFoundFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: ModifyEventSubscription
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/ModifyEventSubscriptionMessage'
      tags:
      - Event Subscription
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: rds
  schemas:
    CreateEventSubscriptionMessage:
      type: object
      properties:
        SubscriptionName:
          type: string
          description: 'The name of the subscription. Constraints: The name must be less than 255 characters.'
        SnsTopicArn:
          type: string
          description: The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created
            by Amazon SNS when you create a topic and subscribe to it.
        SourceType:
          type: string
          description: 'The type of source that is generating the events. For example, if you want to be notified of events
            generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events
            are returned. Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot |
            db-cluster-snapshot'
        EventCategories:
          type: array
          items:
            type: string
          description: A list of event categories for a SourceType that you want to subscribe to. You can see a list of the
            categories for a given SourceType by using the DescribeEventCategories action.
        SourceIds:
          type: array
          items:
            type: string
          description: 'The list of identifiers of the event sources for which events are returned. If not specified, then
            all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters,
            digits, and hyphens; it can''t end with a hyphen or contain two consecutive hyphens. Constraints: If SourceIds
            are supplied, SourceType must also be provided. If the source type is a DB instance, then a DBInstanceIdentifier
            must be supplied. If the source type is a DB security group, a DBSecurityGroupName must be supplied. If the source
            type is a DB parameter group, a DBParameterGr'
        Enabled:
          type: boolean
          description: A Boolean value; set to true to activate the subscription, set to false to create the subscription
            but not activate it.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The tags to be applied to the new event subscription.
      required:
      - SubscriptionName
      - SnsTopicArn
    CreateEventSubscriptionResult:
      type: object
      properties:
        EventSubscription:
          $ref: '#/components/schemas/EventSubscription'
    DeleteEventSubscriptionMessage:
      type: object
      properties:
        SubscriptionName:
          type: string
          description: The name of the event notification subscription you want to delete.
      required:
      - SubscriptionName
    DeleteEventSubscriptionResult:
      type: object
      properties:
        EventSubscription:
          $ref: '#/components/schemas/EventSubscription'
    DescribeEventSubscriptionsMessage:
      type: object
      properties:
        SubscriptionName:
          type: string
          description: The name of the event notification subscription you want to describe.
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
          description: This parameter is not currently supported.
        MaxRecords:
          type: integer
          description: 'The maximum number of records to include in the response. If more records exist than the specified
            MaxRecords value, a pagination token called a marker is included in the response so that the remaining results
            can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100.'
        Marker:
          type: string
          description: An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If
            this parameter is specified, the response includes only records beyond the marker, up to the value specified by
            MaxRecords .
    EventSubscription:
      type: object
      properties:
        CustomerAwsId:
          type: string
          description: The Amazon customer account associated with the event notification subscription.
        CustSubscriptionId:
          type: string
          description: The event notification subscription Id.
        SnsTopicArn:
          type: string
          description: The topic ARN of the event notification subscription.
        Status:
          type: string
          description: 'The status of the event notification subscription. Constraints: Can be one of the following: creating
            | modifying | deleting | active | no-permission | topic-not-exist The status "no-permission" indicates that Neptune
            no longer has permission to post to the SNS topic. The status "topic-not-exist" indicates that the topic was deleted
            after the subscription was created.'
        SubscriptionCreationTime:
          type: string
          description: The time the event notification subscription was created.
        SourceType:
          type: string
          description: The source type for the event notification subscription.
        SourceIdsList:
          type: array
          items:
            type: string
          description: A list of source IDs for the event notification subscription.
        EventCategoriesList:
          type: array
          items:
            type: string
          description: A list of event categories for the event notification subscription.
        Enabled:
          type: boolean
          description: A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.
        EventSubscriptionArn:
          type: string
          description: The Amazon Resource Name (ARN) for the event subscription.
    EventSubscriptionQuotaExceededFault:
      type: object
      properties:
        message:
          type: string
          description: A message describing the details of the problem.
    EventSubscriptionsMessage:
      type: object
      properties:
        Marker:
          type: string
          description: An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If
            this parameter is specified, the response includes only records beyond the marker, up to the value specified by
            MaxRecords.
        EventSubscriptionsList:
          type: array
          items:
            $ref: '#/components/schemas/EventSubscription'
          description: A list of EventSubscriptions data types.
    Filter:
      type: object
      properties:
        Name:
          type: string
          description: This parameter is not currently supported.
        Values:
          type: array
          items:
            type: string
          description: This parameter is not currently supported.
      required:
      - Name
      - Values
    InvalidEventSubscriptionStateFault:
      type: object
      properties:
        message:
          type: string
          description: A message describing the details of the problem.
    ModifyEventSubscriptionMessage:
      type: object
      properties:
        SubscriptionName:
          type: string
          description: The name of the event notification subscription.
        SnsTopicArn:
          type: string
          description: The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created
            by Amazon SNS when you create a topic and subscribe to it.
        SourceType:
          type: string
          description: 'The type of source that is generating the events. For example, if you want to be notified of events
            generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events
            are returned. Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot'
        EventCategories:
          type: array
          items:
            type: string
          description: A list of event categories for a SourceType that you want to subscribe to. You can see a list of the
            categories for a given SourceType by using the DescribeEventCategories action.
        Enabled:
          type: boolean
          description: A Boolean value; set to true to activate the subscription.
      required:
      - SubscriptionName
    ModifyEventSubscriptionResult:
      type: object
      properties:
        EventSubscription:
          $ref: '#/components/schemas/EventSubscription'
    SNSTopicArnNotFoundFault:
      type: object
      properties:
        message:
          type: string
          description: A message describing the details of the problem.
    SubscriptionNotFoundFault:
      type: object
      properties:
        message:
          type: string
          description: A message describing the details of the problem.
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: 'A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in
            length and can''t be prefixed with aws: or rds:. The string can only contain the set of Unicode letters, digits,
            white-space, ''_'', ''.'', ''/'', ''='', ''+'', ''-'' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").'
        Value:
          type: string
          description: 'A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters
            in length and can''t be prefixed with aws: or rds:. The string can only contain the set of Unicode letters, digits,
            white-space, ''_'', ''.'', ''/'', ''='', ''+'', ''-'' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").'
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/neptune/service/2014-10-31/neptune-2014-10-31.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)