List Subscribers

securitylake_list_subscribers

R Documentation

Lists all subscribers for the specific Amazon Security Lake account ID¶

Description¶

Lists all subscribers for the specific Amazon Security Lake account ID. You can retrieve a list of subscriptions associated with a specific organization or Amazon Web Services account.

Usage¶

securitylake_list_subscribers(maxResults, nextToken)

Arguments¶

maxResults

The maximum number of accounts for which the configuration is displayed.

nextToken

If nextToken is returned, there are more results available. You can repeat the call using the returned token to retrieve the next page.

Value¶

A list with the following syntax:

list(
  nextToken = "string",
  subscribers = list(
    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$list_subscribers(
  maxResults = 123,
  nextToken = "string"
)