Struct aws_sdk_detective::client::fluent_builders::CreateMembers

pub struct CreateMembers { /* private fields */ }

Fluent builder constructing a request to CreateMembers.

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

For invited accounts, CreateMembers 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.

CreateMembers 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, CreateMembers 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 CreateMembers 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 CreateMembers was unable to process. This list includes accounts that were already invited to be member accounts in the behavior graph.

Implementations

impl CreateMembers

pub async fn send(
    self
) -> Result<CreateMembersOutput, SdkError<CreateMembersError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn graph_arn(self, input: impl Into<String>) -> Self

The ARN of the behavior graph.

pub fn set_graph_arn(self, input: Option<String>) -> Self

The ARN of the behavior graph.

pub fn message(self, input: impl Into<String>) -> Self

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

pub fn set_message(self, input: Option<String>) -> Self

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

pub fn disable_email_notification(self, input: bool) -> Self

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.

pub fn set_disable_email_notification(self, input: Option<bool>) -> Self

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.

pub fn accounts(self, input: Account) -> Self

Appends an item to Accounts.

To override the contents of this collection use set_accounts.

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.

pub fn set_accounts(self, input: Option<Vec<Account>>) -> Self

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.

Trait Implementations

impl Clone for CreateMembers

fn clone(&self) -> CreateMembers

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateMembers

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.