Amazon Security Lake Subscribers API

openapi: 3.1.0
info:
  title: Amazon Security Lake Data Lakes Subscribers API
  description: Amazon Security Lake is a service that automatically centralizes an organization's security data from cloud, on-premises, and custom sources into a purpose-built data lake stored in your own Amazon S3. It manages the data lifecycle and supports OCSF (Open Cybersecurity Schema Framework) for normalized security data analysis.
  version: 2018-05-10
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/security-lake/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  x-generated-from: documentation
servers:
- url: https://securitylake.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
      description: The AWS region.
security:
- AWSSignatureV4: []
tags:
- name: Subscribers
  description: Subscriber management for data access
paths:
  /v1/subscribers:
    post:
      operationId: CreateSubscriber
      summary: Amazon Security Lake Create Subscriber
      description: Creates a subscriber for accounts that are already enabled in Amazon Security Lake.
      tags:
      - Subscribers
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSubscriberRequest'
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Subscriber'
              examples:
                CreateSubscriber200Example:
                  summary: Default CreateSubscriber 200 response
                  x-microcks-default: true
                  value:
                    subscriberId: sub-a1b2c3d4
                    subscriberArn: arn:aws:securitylake:us-east-1:123456789012:subscriber/sub-a1b2c3d4
                    subscriberName: MySubscriber
                    subscriberStatus: ACTIVE
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    get:
      operationId: ListSubscribers
      summary: Amazon Security Lake List Subscribers
      description: Lists all subscribers for the specific Amazon Security Lake account ID.
      tags:
      - Subscribers
      parameters:
      - name: maxResults
        in: query
        description: Maximum number of results to return.
        schema:
          type: integer
      - name: nextToken
        in: query
        description: Pagination token.
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                properties:
                  subscribers:
                    type: array
                    items:
                      $ref: '#/components/schemas/Subscriber'
                  nextToken:
                    type: string
              examples:
                ListSubscribers200Example:
                  summary: Default ListSubscribers 200 response
                  x-microcks-default: true
                  value:
                    subscribers: []
                    nextToken: null
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /v1/subscribers/{subscriberId}:
    get:
      operationId: GetSubscriber
      summary: Amazon Security Lake Get Subscriber
      description: Gets information about a specific subscriber created in the current Amazon Web Services Region.
      tags:
      - Subscribers
      parameters:
      - name: subscriberId
        in: path
        required: true
        description: The ID of the subscriber to retrieve.
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Subscriber'
              examples:
                GetSubscriber200Example:
                  summary: Default GetSubscriber 200 response
                  x-microcks-default: true
                  value:
                    subscriberId: sub-a1b2c3d4
                    subscriberArn: arn:aws:securitylake:us-east-1:123456789012:subscriber/sub-a1b2c3d4
                    subscriberName: MySubscriber
                    subscriberStatus: ACTIVE
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    put:
      operationId: UpdateSubscriber
      summary: Amazon Security Lake Update Subscriber
      description: Updates an existing subscriber for the specific Amazon Security Lake account ID and Region.
      tags:
      - Subscribers
      parameters:
      - name: subscriberId
        in: path
        required: true
        description: The ID of the subscriber to update.
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                subscriberDescription:
                  type: string
                  description: Updated description for the subscriber.
                subscriberName:
                  type: string
                  description: Updated name for the subscriber.
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Subscriber'
              examples:
                UpdateSubscriber200Example:
                  summary: Default UpdateSubscriber 200 response
                  x-microcks-default: true
                  value:
                    subscriberId: sub-a1b2c3d4
                    subscriberName: MyUpdatedSubscriber
                    subscriberStatus: ACTIVE
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: DeleteSubscriber
      summary: Amazon Security Lake Delete Subscriber
      description: Deletes the specified subscriber and removes them from Amazon Security Lake.
      tags:
      - Subscribers
      parameters:
      - name: subscriberId
        in: path
        required: true
        description: The ID of the subscriber to delete.
        schema:
          type: string
      responses:
        '204':
          description: Successfully deleted.
        '400':
          description: Bad request.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    CreateSubscriberRequest:
      type: object
      required:
      - sources
      - subscriberIdentity
      - subscriberName
      properties:
        sources:
          type: array
          description: The supported AWS log sources and log types to subscribe to.
          items:
            type: object
        subscriberDescription:
          type: string
          description: A description of the subscriber.
        subscriberIdentity:
          type: object
          description: The identity of the subscriber for data access.
          properties:
            externalId:
              type: string
            principal:
              type: string
        subscriberName:
          type: string
          description: The name of the subscriber.
        accessTypes:
          type: array
          items:
            type: string
            enum:
            - LAKEFORMATION
            - S3
    Subscriber:
      type: object
      description: Represents a subscriber for Amazon Security Lake data.
      properties:
        subscriberId:
          type: string
          description: The unique identifier for the subscriber.
          example: sub-a1b2c3d4
        subscriberArn:
          type: string
          description: The ARN of the subscriber.
          example: arn:aws:securitylake:us-east-1:123456789012:subscriber/sub-a1b2c3d4
        subscriberName:
          type: string
          description: The name of the subscriber.
          example: MySIEMSubscriber
        subscriberDescription:
          type: string
          description: A description of the subscriber.
        subscriberStatus:
          type: string
          description: The status of the subscriber.
          enum:
          - ACTIVE
          - DEACTIVATED
          - PENDING
          - READY
          example: ACTIVE
        accessTypes:
          type: array
          description: The access types granted to the subscriber.
          items:
            type: string
            enum:
            - LAKEFORMATION
            - S3
        resourceShareArn:
          type: string
          description: The ARN of the resource share for AWS RAM-based access.
        createdAt:
          type: string
          format: date-time
          description: Timestamp when the subscriber was created.
        updatedAt:
          type: string
          format: date-time
          description: Timestamp when the subscriber was last updated.
  securitySchemes:
    AWSSignatureV4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4 authentication