Amazon Security Lake

Amazon Security Lake Security Lake Notification API

The Security Lake Notification API from Amazon Security Lake — 1 operation(s) for security lake notification.

Documentation GitHub OpenAPI

Operations 3

POST /v1/subscribers/{subscriberId}/notification Create Subscriber Notification #

DELETE /v1/subscribers/{subscriberId}/notification Delete Subscriber Notification #

PUT /v1/subscribers/{subscriberId}/notification Update Subscriber Notification #

Specifications

⚙

OpenAPI

https://artifacts.apis.io/amazon-security-lake/openapi/amazon-security-lake-notification-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/amazon-security-lake:amazon-security-lake-notification-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.1.0
info:
  title: Amazon Security Lake Notification API
  version: '2018-05-10'
  description: Generated from AWS's published Smithy model for Amazon Security Lake. 3 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://securitylake.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /v1/subscribers/{subscriberId}/notification:
    post:
      operationId: CreateSubscriberNotification
      summary: Create Subscriber Notification
      description: 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.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateSubscriberNotificationResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSubscriberNotificationRequest'
      tags:
      - Notification
    delete:
      operationId: DeleteSubscriberNotification
      summary: Delete Subscriber Notification
      description: Deletes the specified subscription notification in Amazon Security Lake for the organization you specify.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteSubscriberNotificationResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteSubscriberNotificationRequest'
      tags:
      - Notification
    put:
      operationId: UpdateSubscriberNotification
      summary: Update Subscriber Notification
      description: Updates an existing notification method for the subscription (SQS or HTTPs endpoint) or switches the notification
        subscription endpoint for a subscriber.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateSubscriberNotificationResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateSubscriberNotificationRequest'
      tags:
      - Notification
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: securitylake
  schemas:
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
        errorCode:
          type: string
          description: A coded string to provide more information about the access denied exception. You can use the error
            code to check the exception type.
    BadRequestException:
      type: object
      properties:
        message:
          type: string
    ConflictException:
      type: object
      properties:
        message:
          type: string
        resourceName:
          type: string
          description: The resource name.
        resourceType:
          type: string
          description: The resource type.
    CreateSubscriberNotificationRequest:
      type: object
      properties:
        subscriberId:
          type: string
          description: The subscriber ID for the notification subscription.
        configuration:
          $ref: '#/components/schemas/NotificationConfiguration'
      required:
      - subscriberId
      - configuration
    CreateSubscriberNotificationResponse:
      type: object
      properties:
        subscriberEndpoint:
          type: string
          description: The subscriber endpoint to which exception messages are posted.
    DeleteSubscriberNotificationRequest:
      type: object
      properties:
        subscriberId:
          type: string
          description: The ID of the Security Lake subscriber account.
      required:
      - subscriberId
    DeleteSubscriberNotificationResponse:
      type: object
      properties: {}
    HttpsNotificationConfiguration:
      type: object
      properties:
        endpoint:
          type: string
          description: The subscription endpoint in Security Lake. If you prefer notification with an HTTPs endpoint, populate
            this field.
        authorizationApiKeyName:
          type: string
          description: The key name for the notification subscription.
        authorizationApiKeyValue:
          type: string
          description: The key value for the notification subscription.
        httpMethod:
          type: string
          enum:
          - POST
          - PUT
          description: The HTTPS method used for the notification subscription.
        targetRoleArn:
          type: string
          description: 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.
      required:
      - endpoint
      - targetRoleArn
    InternalServerException:
      type: object
      properties:
        message:
          type: string
    NotificationConfiguration:
      type: object
      properties:
        sqsNotificationConfiguration:
          $ref: '#/components/schemas/SqsNotificationConfiguration'
        httpsNotificationConfiguration:
          $ref: '#/components/schemas/HttpsNotificationConfiguration'
      description: Exactly one member is set.
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
        resourceName:
          type: string
          description: The name of the resource that could not be found.
        resourceType:
          type: string
          description: The type of the resource that could not be found.
    SqsNotificationConfiguration:
      type: object
      properties: {}
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
        serviceCode:
          type: string
          description: The code for the service in Service Quotas.
        quotaCode:
          type: string
          description: That the rate of requests to Security Lake is exceeding the request quotas for your Amazon Web Services
            account.
        retryAfterSeconds:
          type: integer
          description: Retry the request after the specified time.
    UpdateSubscriberNotificationRequest:
      type: object
      properties:
        subscriberId:
          type: string
          description: The subscription ID for which the subscription notification is specified.
        configuration:
          $ref: '#/components/schemas/NotificationConfiguration'
      required:
      - subscriberId
      - configuration
    UpdateSubscriberNotificationResponse:
      type: object
      properties:
        subscriberEndpoint:
          type: string
          description: The subscriber endpoint to which exception messages are posted.
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/securitylake/service/2018-05-10/securitylake-2018-05-10.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)