:doc:`DocDB <../../docdb>` / Client / modify_event_subscription

*************************
modify_event_subscription
*************************



.. py:method:: DocDB.Client.modify_event_subscription(**kwargs)

  

  Modifies an existing Amazon DocumentDB event notification subscription.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyEventSubscription>`_  


  **Request Syntax**
  ::

    response = client.modify_event_subscription(
        SubscriptionName='string',
        SnsTopicArn='string',
        SourceType='string',
        EventCategories=[
            'string',
        ],
        Enabled=True|False
    )
    
  :type SubscriptionName: string
  :param SubscriptionName: **[REQUIRED]** 

    The name of the Amazon DocumentDB event notification subscription.

    

  
  :type SnsTopicArn: string
  :param SnsTopicArn: 

    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.

    

  
  :type SourceType: string
  :param SourceType: 

    The type of source that is generating the events. For example, if you want to be notified of events generated by an instance, 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``

    

  
  :type EventCategories: list
  :param EventCategories: 

    A list of event categories for a ``SourceType`` that you want to subscribe to.

    

  
    - *(string) --* 

    

  :type Enabled: boolean
  :param Enabled: 

    A Boolean value; set to ``true`` to activate the subscription.

    

  
  
  :rtype: 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) --* 

        Detailed information about an event to which you have subscribed.

        
        

        - **CustomerAwsId** *(string) --* 

          The Amazon Web Services customer account that is associated with the Amazon DocumentDB event notification subscription.

          
        

        - **CustSubscriptionId** *(string) --* 

          The Amazon DocumentDB event notification subscription ID.

          
        

        - **SnsTopicArn** *(string) --* 

          The topic ARN of the Amazon DocumentDB event notification subscription.

          
        

        - **Status** *(string) --* 

          The status of the Amazon DocumentDB event notification subscription.

           

          Constraints:

           

          Can be one of the following: ``creating``, ``modifying``, ``deleting``, ``active``, ``no-permission``, ``topic-not-exist``

           

          The ``no-permission`` status indicates that Amazon DocumentDB no longer has permission to post to the SNS topic. The ``topic-not-exist`` status indicates that the topic was deleted after the subscription was created.

          
        

        - **SubscriptionCreationTime** *(string) --* 

          The time at which the Amazon DocumentDB event notification subscription was created.

          
        

        - **SourceType** *(string) --* 

          The source type for the Amazon DocumentDB event notification subscription.

          
        

        - **SourceIdsList** *(list) --* 

          A list of source IDs for the Amazon DocumentDB event notification subscription.

          
          

          - *(string) --* 
      
        

        - **EventCategoriesList** *(list) --* 

          A list of event categories for the Amazon DocumentDB event notification subscription.

          
          

          - *(string) --* 
      
        

        - **Enabled** *(boolean) --* 

          A Boolean value indicating whether the subscription is enabled. A value of ``true`` indicates that the subscription is enabled.

          
        

        - **EventSubscriptionArn** *(string) --* 

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

          
    
  
  **Exceptions**
  
  *   :py:class:`DocDB.Client.exceptions.EventSubscriptionQuotaExceededFault`

  
  *   :py:class:`DocDB.Client.exceptions.SubscriptionNotFoundFault`

  
  *   :py:class:`DocDB.Client.exceptions.SNSInvalidTopicFault`

  
  *   :py:class:`DocDB.Client.exceptions.SNSNoAuthorizationFault`

  
  *   :py:class:`DocDB.Client.exceptions.SNSTopicArnNotFoundFault`

  
  *   :py:class:`DocDB.Client.exceptions.SubscriptionCategoryNotFoundFault`

  