:doc:`SecurityLake <../../securitylake>` / Client / create_subscriber_notification

******************************
create_subscriber_notification
******************************



.. py:method:: SecurityLake.Client.create_subscriber_notification(**kwargs)

  

  Notifies the subscriber when new data is written to the data lake for the sources that the subscriber consumes in Security Lake. You can create only one subscriber notification per subscriber.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/CreateSubscriberNotification>`_  


  **Request Syntax**
  ::

    response = client.create_subscriber_notification(
        configuration={
            'httpsNotificationConfiguration': {
                'authorizationApiKeyName': 'string',
                'authorizationApiKeyValue': 'string',
                'endpoint': 'string',
                'httpMethod': 'POST'|'PUT',
                'targetRoleArn': 'string'
            },
            'sqsNotificationConfiguration': {}
            
        },
        subscriberId='string'
    )
    
  :type configuration: dict
  :param configuration: **[REQUIRED]** 

    Specify the configuration using which you want to create the subscriber notification.

    .. note::    This is a Tagged Union structure. Only one of the     following top level keys can be set: ``httpsNotificationConfiguration``, ``sqsNotificationConfiguration``. 

  
    - **httpsNotificationConfiguration** *(dict) --* 

      The configurations used for HTTPS subscriber notification.

      

    
      - **authorizationApiKeyName** *(string) --* 

        The key name for the notification subscription.

        

      
      - **authorizationApiKeyValue** *(string) --* 

        The key value for the notification subscription.

        

      
      - **endpoint** *(string) --* **[REQUIRED]** 

        The subscription endpoint in Security Lake. If you prefer notification with an HTTPs endpoint, populate this field.

        

      
      - **httpMethod** *(string) --* 

        The HTTPS method used for the notification subscription.

        

      
      - **targetRoleArn** *(string) --* **[REQUIRED]** 

        The Amazon Resource Name (ARN) of the EventBridge API destinations IAM role that you created. For more information about ARNs and how to use them in policies, see `Managing data access <https://docs.aws.amazon.com//security-lake/latest/userguide/subscriber-data-access.html>`__ and `Amazon Web Services Managed Policies <https://docs.aws.amazon.com/security-lake/latest/userguide/security-iam-awsmanpol.html>`__ in the *Amazon Security Lake User Guide*.

        

      
    
    - **sqsNotificationConfiguration** *(dict) --* 

      The configurations for SQS subscriber notification.

      

    
    
  
  :type subscriberId: string
  :param subscriberId: **[REQUIRED]** 

    The subscriber ID for the notification subscription.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'subscriberEndpoint': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **subscriberEndpoint** *(string) --* 

        The subscriber endpoint to which exception messages are posted.

        
  
  **Exceptions**
  
  *   :py:class:`SecurityLake.Client.exceptions.BadRequestException`

  
  *   :py:class:`SecurityLake.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`SecurityLake.Client.exceptions.InternalServerException`

  
  *   :py:class:`SecurityLake.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`SecurityLake.Client.exceptions.ConflictException`

  
  *   :py:class:`SecurityLake.Client.exceptions.ThrottlingException`

  