List Members

securityhub_list_members

R Documentation

Lists details about all member accounts for the current Security Hub administrator account¶

Description¶

Lists details about all member accounts for the current Security Hub administrator account.

The results include both member accounts that belong to an organization and member accounts that were invited manually.

Usage¶

securityhub_list_members(OnlyAssociated, MaxResults, NextToken)

Arguments¶

OnlyAssociated

Specifies which member accounts to include in the response based on their relationship status with the administrator account. The default value is TRUE.

If OnlyAssociated is set to TRUE, the response includes member accounts whose relationship status with the administrator account is set to ENABLED.

If OnlyAssociated is set to FALSE, the response includes all existing member accounts.

MaxResults

The maximum number of items to return in the response.

NextToken

The token that is required for pagination. On your first call to the list_members operation, set the value of this parameter to NULL.

For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.

Value¶

A list with the following syntax:

list(
  Members = list(
    list(
      AccountId = "string",
      Email = "string",
      MasterId = "string",
      AdministratorId = "string",
      MemberStatus = "string",
      InvitedAt = as.POSIXct(
        "2015-01-01"
      ),
      UpdatedAt = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$list_members(
  OnlyAssociated = TRUE|FALSE,
  MaxResults = 123,
  NextToken = "string"
)

Examples¶

## Not run: 
# The following example returns details about member accounts for the
# calling Security Hub administrator account. The response includes member
# accounts that are managed through AWS Organizations and those that were
# invited manually.
svc$list_members()

## End(Not run)