Amazon RDS Rds Event Subscription API

openapi: 3.2.0
info:
  title: Amazon Relational Database Service Event Subscription API
  version: '2014-10-31'
  description: Generated from AWS's published Smithy model for Amazon Relational Database 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://rds.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Event Subscription
paths:
  /?Action=CreateEventSubscription:
    post:
      operationId: CreateEventSubscription
      summary: Create Event Subscription
      description: Creates an RDS event notification subscription. This operation requires a topic Amazon Resource Name (ARN) created by either the RDS 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) that you want to be notified of and provide a list of RDS sources (SourceIds) that triggers the events. You can also provide a list of event categories (EventCategories) for events that 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 SourceIds = myDBInstance1, you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify SourceIds, you receive notice of the events for that source type for all your RDS sources. If you don't specify either the SourceType or the SourceIds, you are notified of events generated from all RDS sources belonging to your customer account. For more
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateEventSubscriptionResult'
              example:
                EventSubscription:
                  Status: creating
                  CustSubscriptionId: my-instance-events
                  SubscriptionCreationTime: Tue Jul 31 23:22:01 UTC 2018
                  EventCategoriesList:
                  - backup
                  - recovery
                  SnsTopicArn: arn:aws:sns:us-east-1:123456789012:interesting-events
                  CustomerAwsId: '123456789012'
                  EventSubscriptionArn: arn:aws:rds:us-east-1:123456789012:es:my-instance-events
                  SourceType: db-instance
                  Enabled: true
        '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'
            example:
              SubscriptionName: my-instance-events
              SnsTopicArn: arn:aws:sns:us-east-1:123456789012:interesting-events
              SourceType: db-instance
              EventCategories:
              - backup
              - recovery
      tags:
      - Event Subscription
  /?Action=DeleteEventSubscription:
    post:
      operationId: DeleteEventSubscription
      summary: Delete Event Subscription
      description: Deletes an RDS event notification subscription.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DeleteEventSubscriptionResult'
              example:
                EventSubscription:
                  EventSubscriptionArn: arn:aws:rds:us-east-1:123456789012:es:my-instance-events
                  CustomerAwsId: '123456789012'
                  Enabled: false
                  SourceIdsList:
                  - test-instance
                  SourceType: db-instance
                  EventCategoriesList:
                  - backup
                  - recovery
                  SubscriptionCreationTime: '2018-07-31 23:22:01.893'
                  CustSubscriptionId: my-instance-events
                  SnsTopicArn: arn:aws:sns:us-east-1:123456789012:interesting-events
                  Status: deleting
        '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'
            example:
              SubscriptionName: my-instance-events
      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'
              example:
                EventSubscriptionsList:
                - EventCategoriesList:
                  - backup
                  - recovery
                  Enabled: true
                  EventSubscriptionArn: arn:aws:rds:us-east-1:123456789012:es:my-instance-events
                  Status: creating
                  SourceType: db-instance
                  CustomerAwsId: '123456789012'
                  SubscriptionCreationTime: '2018-07-31 23:22:01.893'
                  CustSubscriptionId: my-instance-events
                  SnsTopicArn: arn:aws:sns:us-east-1:123456789012:interesting-events
        '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 RDS event notification subscription. 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 source type (SourceType) in Events in the Amazon RDS User Guide or by using the DescribeEventCategories operation.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ModifyEventSubscriptionResult'
              example:
                EventSubscription:
                  EventCategoriesList:
                  - backup
                  - recovery
                  CustomerAwsId: '123456789012'
                  SourceType: db-instance
                  SubscriptionCreationTime: Tue Jul 31 23:22:01 UTC 2018
                  EventSubscriptionArn: arn:aws:rds:us-east-1:123456789012:es:my-instance-events
                  SnsTopicArn: arn:aws:sns:us-east-1:123456789012:interesting-events
                  CustSubscriptionId: my-instance-events
                  Status: modifying
                  Enabled: false
        '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'
            example:
              SubscriptionName: my-instance-events
              Enabled: false
      tags:
      - Event Subscription
components:
  schemas:
    DeleteEventSubscriptionMessage:
      type: object
      properties:
        SubscriptionName:
          type: string
          description: The name of the RDS event notification subscription you want to delete.
      required:
      - SubscriptionName
    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 only 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 only the set of Unicode letters, digits, white-space, ''_'', ''.'', '':'', ''/'', ''='', ''+'', ''-'', ''@'' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$").'
    EventSubscriptionQuotaExceededFault:
      type: object
      properties:
        message:
          type: string
    ModifyEventSubscriptionMessage:
      type: object
      properties:
        SubscriptionName:
          type: string
          description: The name of the RDS 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. For RDS Proxy events, specify db-proxy. If this value isn''t specified, all events are returned. Valid Values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy | zero-etl | custom-engine-version | blue-green-deployment'
        EventCategories:
          type: array
          items:
            type: string
          description: A list of event categories for a source type (SourceType) that you want to subscribe to. You can see a list of the categories for a given source type in Events in the Amazon RDS User Guide or by using the DescribeEventCategories operation.
        Enabled:
          type: boolean
          description: Specifies whether to activate the subscription.
      required:
      - SubscriptionName
    Filter:
      type: object
      properties:
        Name:
          type: string
          description: The name of the filter. Filter names are case-sensitive.
        Values:
          type: array
          items:
            type: string
          description: One or more filter values. Filter values are case-sensitive.
      required:
      - Name
      - Values
    DeleteEventSubscriptionResult:
      type: object
      properties:
        EventSubscription:
          $ref: '#/components/schemas/EventSubscription'
    ModifyEventSubscriptionResult:
      type: object
      properties:
        EventSubscription:
          $ref: '#/components/schemas/EventSubscription'
    SubscriptionNotFoundFault:
      type: object
      properties:
        message:
          type: string
    CreateEventSubscriptionResult:
      type: object
      properties:
        EventSubscription:
          $ref: '#/components/schemas/EventSubscription'
    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. SNS automatically creates the ARN when you create a topic and subscribe to it. RDS doesn't support FIFO (first in, first out) topics. For more information, see Message ordering and deduplication (FIFO topics) in the Amazon Simple Notification Service Developer Guide.
        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 set this parameter to db-instance. For RDS Proxy events, specify db-proxy. If this value isn''t specified, all events are returned. Valid Values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy | zero-etl | custom-engine-version | blue-green-deployment'
        EventCategories:
          type: array
          items:
            type: string
          description: A list of event categories for a particular source type (SourceType) that you want to subscribe to. You can see a list of the categories for a given source type in the "Amazon RDS event categories and event messages" section of the Amazon RDS User Guide or the Amazon Aurora User Guide . You can also see this list by using the DescribeEventCategories operation.
        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, a DBInstanceIdentifier value must be supplied. If the source type is a DB cluster, a DBClusterIdentifier value must be supplied. If the source type is a DB parameter group, a DBParameterGr'
        Enabled:
          type: boolean
          description: Specifies whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
      required:
      - SubscriptionName
      - SnsTopicArn
    DescribeEventSubscriptionsMessage:
      type: object
      properties:
        SubscriptionName:
          type: string
          description: The name of the RDS event notification subscription you want to describe.
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
          description: This parameter isn't 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 you can retrieve the remaining results. 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 Web Services customer account associated with the RDS event notification subscription.
        CustSubscriptionId:
          type: string
          description: The RDS event notification subscription Id.
        SnsTopicArn:
          type: string
          description: The topic ARN of the RDS event notification subscription.
        Status:
          type: string
          description: 'The status of the RDS 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 RDS 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 RDS event notification subscription was created.
        SourceType:
          type: string
          description: The source type for the RDS event notification subscription.
        SourceIdsList:
          type: array
          items:
            type: string
          description: A list of source IDs for the RDS event notification subscription.
        EventCategoriesList:
          type: array
          items:
            type: string
          description: A list of event categories for the RDS event notification subscription.
        Enabled:
          type: boolean
          description: Specifies whether the subscription is enabled. True indicates the subscription is enabled.
        EventSubscriptionArn:
          type: string
          description: The Amazon Resource Name (ARN) for the event subscription.
    SNSTopicArnNotFoundFault:
      type: object
      properties:
        message:
          type: string
    InvalidEventSubscriptionStateFault:
      type: object
      properties:
        message:
          type: string
    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.
  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
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/rds/service/2014-10-31/rds-2014-10-31.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)