Create Members

detective_create_members

R Documentation

CreateMembers is used to send invitations to accounts

Description

create_members is used to send invitations to accounts. For the organization behavior graph, the Detective administrator account uses create_members to enable organization accounts as member accounts.

For invited accounts, create_members sends a request to invite the specified Amazon Web Services accounts to be member accounts in the behavior graph. This operation can only be called by the administrator account for a behavior graph.

create_members verifies the accounts and then invites the verified accounts. The administrator can optionally specify to not send invitation emails to the member accounts. This would be used when the administrator manages their member accounts centrally.

For organization accounts in the organization behavior graph, create_members attempts to enable the accounts. The organization accounts do not receive invitations.

The request provides the behavior graph ARN and the list of accounts to invite or to enable.

The response separates the requested accounts into two lists:

• The accounts that create_members was able to process. For invited accounts, includes member accounts that are being verified, that have passed verification and are to be invited, and that have failed verification. For organization accounts in the organization behavior graph, includes accounts that can be enabled and that cannot be enabled.

• The accounts that create_members was unable to process. This list includes accounts that were already invited to be member accounts in the behavior graph.

Usage

detective_create_members(GraphArn, Message, DisableEmailNotification,
  Accounts)

Arguments

GraphArn

[required] The ARN of the behavior graph.

Message

Customized message text to include in the invitation email message to the invited member accounts.

DisableEmailNotification

if set to true, then the invited accounts do not receive email notifications. By default, this is set to false, and the invited accounts receive email notifications.

Organization accounts in the organization behavior graph do not receive email notifications.

Accounts

[required] The list of Amazon Web Services accounts to invite or to enable. You can invite or enable up to 50 accounts at a time. For each invited account, the account list contains the account identifier and the Amazon Web Services account root user email address. For organization accounts in the organization behavior graph, the email address is not required.

Value

A list with the following syntax:

list(
  Members = 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$create_members(
  GraphArn = "string",
  Message = "string",
  DisableEmailNotification = TRUE|FALSE,
  Accounts = list(
    list(
      AccountId = "string",
      EmailAddress = "string"
    )
  )
)