modify_event_subscription

modify_event_subscription(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.modify_event_subscription(
    SubscriptionName='string',
    SnsTopicArn='string',
    SourceType='string',
    EventCategories=[
        'string',
    ],
    Enabled=True|False
)
Parameters
  • SubscriptionName (string) --

    [REQUIRED]

    The name of the event notification subscription.

  • SnsTopicArn (string) -- 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 (string) --

    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 (list) --

    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.

    • (string) --
  • Enabled (boolean) -- A Boolean value; set to true to activate the subscription.
Return type

dict

Returns

Response Syntax

{
    'EventSubscription': {
        'CustomerAwsId': 'string',
        'CustSubscriptionId': 'string',
        'SnsTopicArn': 'string',
        'Status': 'string',
        'SubscriptionCreationTime': 'string',
        'SourceType': 'string',
        'SourceIdsList': [
            'string',
        ],
        'EventCategoriesList': [
            'string',
        ],
        'Enabled': True|False,
        'EventSubscriptionArn': 'string'
    }
}

Response Structure

  • (dict) --

    • EventSubscription (dict) --

      Contains the results of a successful invocation of the DescribeEventSubscriptions action.

      • CustomerAwsId (string) --

        The Amazon customer account associated with the event notification subscription.

      • CustSubscriptionId (string) --

        The event notification subscription Id.

      • SnsTopicArn (string) --

        The topic ARN of the event notification subscription.

      • Status (string) --

        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 (string) --

        The time the event notification subscription was created.

      • SourceType (string) --

        The source type for the event notification subscription.

      • SourceIdsList (list) --

        A list of source IDs for the event notification subscription.

        • (string) --
      • EventCategoriesList (list) --

        A list of event categories for the event notification subscription.

        • (string) --
      • Enabled (boolean) --

        A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.

      • EventSubscriptionArn (string) --

        The Amazon Resource Name (ARN) for the event subscription.

Exceptions

  • Neptune.Client.exceptions.EventSubscriptionQuotaExceededFault
  • Neptune.Client.exceptions.SubscriptionNotFoundFault
  • Neptune.Client.exceptions.SNSInvalidTopicFault
  • Neptune.Client.exceptions.SNSNoAuthorizationFault
  • Neptune.Client.exceptions.SNSTopicArnNotFoundFault
  • Neptune.Client.exceptions.SubscriptionCategoryNotFoundFault