Get Members

detective_get_members

R Documentation

Returns the membership details for specified member accounts for a behavior graph

Description

Returns the membership details for specified member accounts for a behavior graph.

Usage

detective_get_members(GraphArn, AccountIds)

Arguments

GraphArn

[required] The ARN of the behavior graph for which to request the member details.

AccountIds

[required] The list of Amazon Web Services account identifiers for the member account for which to return member details. You can request details for up to 50 member accounts at a time.

You cannot use get_members to retrieve information about member accounts that were removed from the behavior graph.

Value

A list with the following syntax:

list(
  MemberDetails = list(
    list(
      AccountId = "string",
      EmailAddress = "string",
      GraphArn = "string",
      MasterId = "string",
      AdministratorId = "string",
      Status = "INVITED"|"VERIFICATION_IN_PROGRESS"|"VERIFICATION_FAILED"|"ENABLED"|"ACCEPTED_BUT_DISABLED",
      DisabledReason = "VOLUME_TOO_HIGH"|"VOLUME_UNKNOWN",
      InvitedTime = as.POSIXct(
        "2015-01-01"
      ),
      UpdatedTime = as.POSIXct(
        "2015-01-01"
      ),
      VolumeUsageInBytes = 123,
      VolumeUsageUpdatedTime = as.POSIXct(
        "2015-01-01"
      ),
      PercentOfGraphUtilization = 123.0,
      PercentOfGraphUtilizationUpdatedTime = as.POSIXct(
        "2015-01-01"
      ),
      InvitationType = "INVITATION"|"ORGANIZATION",
      VolumeUsageByDatasourcePackage = list(
        list(
          VolumeUsageInBytes = 123,
          VolumeUsageUpdateTime = as.POSIXct(
            "2015-01-01"
          )
        )
      ),
      DatasourcePackageIngestStates = list(
        "STARTED"|"STOPPED"|"DISABLED"
      )
    )
  ),
  UnprocessedAccounts = list(
    list(
      AccountId = "string",
      Reason = "string"
    )
  )
)

Request syntax

svc$get_members(
  GraphArn = "string",
  AccountIds = list(
    "string"
  )
)