SecurityLake / Client / create_subscriber_notification

create_subscriber_notification#

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

Request Syntax

response = client.create_subscriber_notification(
    configuration={
        'httpsNotificationConfiguration': {
            'authorizationApiKeyName': 'string',
            'authorizationApiKeyValue': 'string',
            'endpoint': 'string',
            'httpMethod': 'POST'|'PUT',
            'targetRoleArn': 'string'
        },
        'sqsNotificationConfiguration': {}

    },
    subscriberId='string'
)
Parameters:

  • configuration (dict) –

    [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 and Amazon Web Services Managed Policies in the Amazon Security Lake User Guide.

    • sqsNotificationConfiguration (dict) –

      The configurations for SQS subscriber notification.

  • subscriberId (string) –

    [REQUIRED]

    The subscriber ID for the notification subscription.

Return type:

dict

Returns:

Response Syntax

{
    'subscriberEndpoint': 'string'
}

Response Structure

  • (dict) –

    • subscriberEndpoint (string) –

      The subscriber endpoint to which exception messages are posted.

Exceptions