Get Subscriber

securitylake_get_subscriber

R Documentation

Retrieves the subscription information for the specified subscription ID

Description

Retrieves the subscription information for the specified subscription ID. You can get information about a specific subscriber.

Usage

securitylake_get_subscriber(subscriberId)

Arguments

subscriberId

[required] A value created by Amazon Security Lake that uniquely identifies your get_subscriber API request.

Value

A list with the following syntax:

list(
  subscriber = list(
    accessTypes = list(
      "LAKEFORMATION"|"S3"
    ),
    createdAt = as.POSIXct(
      "2015-01-01"
    ),
    resourceShareArn = "string",
    resourceShareName = "string",
    roleArn = "string",
    s3BucketArn = "string",
    sources = list(
      list(
        awsLogSource = list(
          sourceName = "ROUTE53"|"VPC_FLOW"|"SH_FINDINGS"|"CLOUD_TRAIL_MGMT"|"LAMBDA_EXECUTION"|"S3_DATA"|"EKS_AUDIT"|"WAF",
          sourceVersion = "string"
        ),
        customLogSource = list(
          attributes = list(
            crawlerArn = "string",
            databaseArn = "string",
            tableArn = "string"
          ),
          provider = list(
            location = "string",
            roleArn = "string"
          ),
          sourceName = "string",
          sourceVersion = "string"
        )
      )
    ),
    subscriberArn = "string",
    subscriberDescription = "string",
    subscriberEndpoint = "string",
    subscriberId = "string",
    subscriberIdentity = list(
      externalId = "string",
      principal = "string"
    ),
    subscriberName = "string",
    subscriberStatus = "ACTIVE"|"DEACTIVATED"|"PENDING"|"READY",
    updatedAt = as.POSIXct(
      "2015-01-01"
    )
  )
)

Request syntax

svc$get_subscriber(
  subscriberId = "string"
)