Subscriber

Represents a subscriber for Amazon Security Lake data.

Data LakeSecuritySIEMThreat Detection

Properties

Name	Type	Description
subscriberId	string	The unique identifier for the subscriber.
subscriberArn	string	The ARN of the subscriber.
subscriberName	string	The name of the subscriber.
subscriberDescription	string	A description of the subscriber.
subscriberStatus	string	The status of the subscriber.
accessTypes	array	The access types granted to the subscriber.
resourceShareArn	string	The ARN of the resource share for AWS RAM-based access.
createdAt	string	Timestamp when the subscriber was created.
updatedAt	string	Timestamp when the subscriber was last updated.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-security-lake/refs/heads/main/json-schema/amazon-security-lake-subscriber-schema.json",
  "title": "Subscriber",
  "description": "Represents a subscriber for Amazon Security Lake data.",
  "type": "object",
  "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."
    }
  }
}