Struct aws_sdk_cognitoidentityprovider::operation::admin_add_user_to_group::builders::AdminAddUserToGroupFluentBuilder
source · pub struct AdminAddUserToGroupFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to AdminAddUserToGroup
.
Adds a user to a group. A user who is in a group can present a preferred-role claim to an identity pool, and populates a cognito:groups
claim to their access and identity tokens.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Implementations§
source§impl AdminAddUserToGroupFluentBuilder
impl AdminAddUserToGroupFluentBuilder
sourcepub fn as_input(&self) -> &AdminAddUserToGroupInputBuilder
pub fn as_input(&self) -> &AdminAddUserToGroupInputBuilder
Access the AdminAddUserToGroup as a reference.
sourcepub async fn send(
self,
) -> Result<AdminAddUserToGroupOutput, SdkError<AdminAddUserToGroupError, HttpResponse>>
pub async fn send( self, ) -> Result<AdminAddUserToGroupOutput, SdkError<AdminAddUserToGroupError, 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<AdminAddUserToGroupOutput, AdminAddUserToGroupError, Self>
pub fn customize( self, ) -> CustomizableOperation<AdminAddUserToGroupOutput, AdminAddUserToGroupError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn user_pool_id(self, input: impl Into<String>) -> Self
pub fn user_pool_id(self, input: impl Into<String>) -> Self
The user pool ID for the user pool.
sourcepub fn set_user_pool_id(self, input: Option<String>) -> Self
pub fn set_user_pool_id(self, input: Option<String>) -> Self
The user pool ID for the user pool.
sourcepub fn get_user_pool_id(&self) -> &Option<String>
pub fn get_user_pool_id(&self) -> &Option<String>
The user pool ID for the user pool.
sourcepub fn username(self, input: impl Into<String>) -> Self
pub fn username(self, input: impl Into<String>) -> Self
The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username
isn't an alias attribute in your user pool, this value must be the sub
of a local user or the username of a user from a third-party IdP.
sourcepub fn set_username(self, input: Option<String>) -> Self
pub fn set_username(self, input: Option<String>) -> Self
The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username
isn't an alias attribute in your user pool, this value must be the sub
of a local user or the username of a user from a third-party IdP.
sourcepub fn get_username(&self) -> &Option<String>
pub fn get_username(&self) -> &Option<String>
The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username
isn't an alias attribute in your user pool, this value must be the sub
of a local user or the username of a user from a third-party IdP.
sourcepub fn group_name(self, input: impl Into<String>) -> Self
pub fn group_name(self, input: impl Into<String>) -> Self
The name of the group that you want to add your user to.
sourcepub fn set_group_name(self, input: Option<String>) -> Self
pub fn set_group_name(self, input: Option<String>) -> Self
The name of the group that you want to add your user to.
sourcepub fn get_group_name(&self) -> &Option<String>
pub fn get_group_name(&self) -> &Option<String>
The name of the group that you want to add your user to.
Trait Implementations§
source§impl Clone for AdminAddUserToGroupFluentBuilder
impl Clone for AdminAddUserToGroupFluentBuilder
source§fn clone(&self) -> AdminAddUserToGroupFluentBuilder
fn clone(&self) -> AdminAddUserToGroupFluentBuilder
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 AdminAddUserToGroupFluentBuilder
impl !RefUnwindSafe for AdminAddUserToGroupFluentBuilder
impl Send for AdminAddUserToGroupFluentBuilder
impl Sync for AdminAddUserToGroupFluentBuilder
impl Unpin for AdminAddUserToGroupFluentBuilder
impl !UnwindSafe for AdminAddUserToGroupFluentBuilder
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