SecurityLake / Client / update_subscriber_notification

update_subscriber_notification#

SecurityLake.Client.update_subscriber_notification(**kwargs)#

Updates an existing notification method for the subscription (SQS or HTTPs endpoint) or switches the notification subscription endpoint for a subscriber.

See also: AWS API Documentation

Request Syntax

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

    },
    subscriberId='string'
)
Parameters:

  • configuration (dict) –

    [REQUIRED]

    The configuration for 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 subscription ID for which the subscription notification is specified.

Return type:

dict

Returns:

Response Syntax

{
    'subscriberEndpoint': 'string'
}

Response Structure

  • (dict) –

    • subscriberEndpoint (string) –

      The subscriber endpoint to which exception messages are posted.

Exceptions