pub struct CreateMembersFluentBuilder { /* private fields */ }
Expand description
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§
source§impl CreateMembersFluentBuilder
impl CreateMembersFluentBuilder
sourcepub fn as_input(&self) -> &CreateMembersInputBuilder
pub fn as_input(&self) -> &CreateMembersInputBuilder
Access the CreateMembers as a reference.
sourcepub async fn send(
self
) -> Result<CreateMembersOutput, SdkError<CreateMembersError, HttpResponse>>
pub async fn send( self ) -> Result<CreateMembersOutput, SdkError<CreateMembersError, HttpResponse>>
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.
sourcepub fn customize(
self
) -> CustomizableOperation<CreateMembersOutput, CreateMembersError, Self>
pub fn customize( self ) -> CustomizableOperation<CreateMembersOutput, CreateMembersError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn set_graph_arn(self, input: Option<String>) -> Self
pub fn set_graph_arn(self, input: Option<String>) -> Self
The ARN of the behavior graph.
sourcepub fn get_graph_arn(&self) -> &Option<String>
pub fn get_graph_arn(&self) -> &Option<String>
The ARN of the behavior graph.
sourcepub fn message(self, input: impl Into<String>) -> Self
pub fn message(self, input: impl Into<String>) -> Self
Customized message text to include in the invitation email message to the invited member accounts.
sourcepub fn set_message(self, input: Option<String>) -> Self
pub fn set_message(self, input: Option<String>) -> Self
Customized message text to include in the invitation email message to the invited member accounts.
sourcepub fn get_message(&self) -> &Option<String>
pub fn get_message(&self) -> &Option<String>
Customized message text to include in the invitation email message to the invited member accounts.
sourcepub fn disable_email_notification(self, input: bool) -> Self
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.
sourcepub fn set_disable_email_notification(self, input: Option<bool>) -> Self
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.
sourcepub fn get_disable_email_notification(&self) -> &Option<bool>
pub fn get_disable_email_notification(&self) -> &Option<bool>
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.
sourcepub fn accounts(self, input: Account) -> Self
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.
sourcepub fn set_accounts(self, input: Option<Vec<Account>>) -> Self
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.
sourcepub fn get_accounts(&self) -> &Option<Vec<Account>>
pub fn get_accounts(&self) -> &Option<Vec<Account>>
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§
source§impl Clone for CreateMembersFluentBuilder
impl Clone for CreateMembersFluentBuilder
source§fn clone(&self) -> CreateMembersFluentBuilder
fn clone(&self) -> CreateMembersFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for CreateMembersFluentBuilder
impl !RefUnwindSafe for CreateMembersFluentBuilder
impl Send for CreateMembersFluentBuilder
impl Sync for CreateMembersFluentBuilder
impl Unpin for CreateMembersFluentBuilder
impl !UnwindSafe for CreateMembersFluentBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more