SecurityLake / Client / create_subscription_notification_configuration

create_subscription_notification_configuration#

SecurityLake.Client.create_subscription_notification_configuration(**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_subscription_notification_configuration(
    createSqs=True|False,
    httpsApiKeyName='string',
    httpsApiKeyValue='string',
    httpsMethod='POST'|'PUT',
    roleArn='string',
    subscriptionEndpoint='string',
    subscriptionId='string'
)
Parameters:
  • createSqs (boolean) – Create an Amazon Simple Queue Service queue.

  • httpsApiKeyName (string) – The key name for the notification subscription.

  • httpsApiKeyValue (string) – The key value for the notification subscription.

  • httpsMethod (string) – The HTTPS method used for the notification subscription.

  • roleArn (string) – 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.

  • subscriptionEndpoint (string) – The subscription endpoint in Security Lake. If you prefer notification with an HTTPs endpoint, populate this field.

  • subscriptionId (string) –

    [REQUIRED]

    The subscription ID for the notification subscription.

Return type:

dict

Returns:

Response Syntax

{
    'queueArn': 'string'
}

Response Structure

  • (dict) –

    • queueArn (string) –

      Returns the Amazon Resource Name (ARN) of the queue.

Exceptions

  • SecurityLake.Client.exceptions.ConcurrentModificationException

  • SecurityLake.Client.exceptions.InternalServerException

  • SecurityLake.Client.exceptions.ValidationException

  • SecurityLake.Client.exceptions.AccessDeniedException

  • SecurityLake.Client.exceptions.ResourceNotFoundException

  • SecurityLake.Client.exceptions.AccountNotFoundException

  • SecurityLake.Client.exceptions.InvalidInputException