pub struct CreateUserFluentBuilder { /* private fields */ }Expand description
Fluent builder constructing a request to CreateUser.
Creates a user account for the specified Amazon Connect instance.
Certain UserIdentityInfo parameters are required in some situations. For example, Email is required if you are using SAML for identity management. FirstName and LastName are required if you are using Amazon Connect or SAML for identity management.
For information about how to create users using the Amazon Connect admin website, see Add Users in the Amazon Connect Administrator Guide.
Implementations§
Source§impl CreateUserFluentBuilder
impl CreateUserFluentBuilder
Sourcepub fn as_input(&self) -> &CreateUserInputBuilder
pub fn as_input(&self) -> &CreateUserInputBuilder
Access the CreateUser as a reference.
Sourcepub async fn send(
self,
) -> Result<CreateUserOutput, SdkError<CreateUserError, HttpResponse>>
pub async fn send( self, ) -> Result<CreateUserOutput, SdkError<CreateUserError, 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<CreateUserOutput, CreateUserError, Self>
pub fn customize( self, ) -> CustomizableOperation<CreateUserOutput, CreateUserError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn username(self, input: impl Into<String>) -> Self
pub fn username(self, input: impl Into<String>) -> Self
The user name for the account. For instances not using SAML for identity management, the user name can include up to 20 characters. If you are using SAML for identity management, the user name can include up to 64 characters from \[a-zA-Z0-9_-.\@\]+.
Username can include @ only if used in an email format. For example:
-
Correct: testuser
-
Correct: testuser@example.com
-
Incorrect: testuser@example
Sourcepub fn set_username(self, input: Option<String>) -> Self
pub fn set_username(self, input: Option<String>) -> Self
The user name for the account. For instances not using SAML for identity management, the user name can include up to 20 characters. If you are using SAML for identity management, the user name can include up to 64 characters from \[a-zA-Z0-9_-.\@\]+.
Username can include @ only if used in an email format. For example:
-
Correct: testuser
-
Correct: testuser@example.com
-
Incorrect: testuser@example
Sourcepub fn get_username(&self) -> &Option<String>
pub fn get_username(&self) -> &Option<String>
The user name for the account. For instances not using SAML for identity management, the user name can include up to 20 characters. If you are using SAML for identity management, the user name can include up to 64 characters from \[a-zA-Z0-9_-.\@\]+.
Username can include @ only if used in an email format. For example:
-
Correct: testuser
-
Correct: testuser@example.com
-
Incorrect: testuser@example
Sourcepub fn password(self, input: impl Into<String>) -> Self
pub fn password(self, input: impl Into<String>) -> Self
The password for the user account. A password is required if you are using Amazon Connect for identity management. Otherwise, it is an error to include a password.
Sourcepub fn set_password(self, input: Option<String>) -> Self
pub fn set_password(self, input: Option<String>) -> Self
The password for the user account. A password is required if you are using Amazon Connect for identity management. Otherwise, it is an error to include a password.
Sourcepub fn get_password(&self) -> &Option<String>
pub fn get_password(&self) -> &Option<String>
The password for the user account. A password is required if you are using Amazon Connect for identity management. Otherwise, it is an error to include a password.
Sourcepub fn identity_info(self, input: UserIdentityInfo) -> Self
pub fn identity_info(self, input: UserIdentityInfo) -> Self
The information about the identity of the user.
Sourcepub fn set_identity_info(self, input: Option<UserIdentityInfo>) -> Self
pub fn set_identity_info(self, input: Option<UserIdentityInfo>) -> Self
The information about the identity of the user.
Sourcepub fn get_identity_info(&self) -> &Option<UserIdentityInfo>
pub fn get_identity_info(&self) -> &Option<UserIdentityInfo>
The information about the identity of the user.
Sourcepub fn phone_config(self, input: UserPhoneConfig) -> Self
pub fn phone_config(self, input: UserPhoneConfig) -> Self
The phone settings for the user.
Sourcepub fn set_phone_config(self, input: Option<UserPhoneConfig>) -> Self
pub fn set_phone_config(self, input: Option<UserPhoneConfig>) -> Self
The phone settings for the user.
Sourcepub fn get_phone_config(&self) -> &Option<UserPhoneConfig>
pub fn get_phone_config(&self) -> &Option<UserPhoneConfig>
The phone settings for the user.
Sourcepub fn directory_user_id(self, input: impl Into<String>) -> Self
pub fn directory_user_id(self, input: impl Into<String>) -> Self
The identifier of the user account in the directory used for identity management. If Amazon Connect cannot access the directory, you can specify this identifier to authenticate users. If you include the identifier, we assume that Amazon Connect cannot access the directory. Otherwise, the identity information is used to authenticate users from your directory.
This parameter is required if you are using an existing directory for identity management in Amazon Connect when Amazon Connect cannot access your directory to authenticate users. If you are using SAML for identity management and include this parameter, an error is returned.
Sourcepub fn set_directory_user_id(self, input: Option<String>) -> Self
pub fn set_directory_user_id(self, input: Option<String>) -> Self
The identifier of the user account in the directory used for identity management. If Amazon Connect cannot access the directory, you can specify this identifier to authenticate users. If you include the identifier, we assume that Amazon Connect cannot access the directory. Otherwise, the identity information is used to authenticate users from your directory.
This parameter is required if you are using an existing directory for identity management in Amazon Connect when Amazon Connect cannot access your directory to authenticate users. If you are using SAML for identity management and include this parameter, an error is returned.
Sourcepub fn get_directory_user_id(&self) -> &Option<String>
pub fn get_directory_user_id(&self) -> &Option<String>
The identifier of the user account in the directory used for identity management. If Amazon Connect cannot access the directory, you can specify this identifier to authenticate users. If you include the identifier, we assume that Amazon Connect cannot access the directory. Otherwise, the identity information is used to authenticate users from your directory.
This parameter is required if you are using an existing directory for identity management in Amazon Connect when Amazon Connect cannot access your directory to authenticate users. If you are using SAML for identity management and include this parameter, an error is returned.
Sourcepub fn security_profile_ids(self, input: impl Into<String>) -> Self
pub fn security_profile_ids(self, input: impl Into<String>) -> Self
Appends an item to SecurityProfileIds.
To override the contents of this collection use set_security_profile_ids.
The identifier of the security profile for the user.
Sourcepub fn set_security_profile_ids(self, input: Option<Vec<String>>) -> Self
pub fn set_security_profile_ids(self, input: Option<Vec<String>>) -> Self
The identifier of the security profile for the user.
Sourcepub fn get_security_profile_ids(&self) -> &Option<Vec<String>>
pub fn get_security_profile_ids(&self) -> &Option<Vec<String>>
The identifier of the security profile for the user.
Sourcepub fn routing_profile_id(self, input: impl Into<String>) -> Self
pub fn routing_profile_id(self, input: impl Into<String>) -> Self
The identifier of the routing profile for the user.
Sourcepub fn set_routing_profile_id(self, input: Option<String>) -> Self
pub fn set_routing_profile_id(self, input: Option<String>) -> Self
The identifier of the routing profile for the user.
Sourcepub fn get_routing_profile_id(&self) -> &Option<String>
pub fn get_routing_profile_id(&self) -> &Option<String>
The identifier of the routing profile for the user.
Sourcepub fn hierarchy_group_id(self, input: impl Into<String>) -> Self
pub fn hierarchy_group_id(self, input: impl Into<String>) -> Self
The identifier of the hierarchy group for the user.
Sourcepub fn set_hierarchy_group_id(self, input: Option<String>) -> Self
pub fn set_hierarchy_group_id(self, input: Option<String>) -> Self
The identifier of the hierarchy group for the user.
Sourcepub fn get_hierarchy_group_id(&self) -> &Option<String>
pub fn get_hierarchy_group_id(&self) -> &Option<String>
The identifier of the hierarchy group for the user.
Sourcepub fn instance_id(self, input: impl Into<String>) -> Self
pub fn instance_id(self, input: impl Into<String>) -> Self
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Sourcepub fn set_instance_id(self, input: Option<String>) -> Self
pub fn set_instance_id(self, input: Option<String>) -> Self
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Sourcepub fn get_instance_id(&self) -> &Option<String>
pub fn get_instance_id(&self) -> &Option<String>
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Adds a key-value pair to Tags.
To override the contents of this collection use set_tags.
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Trait Implementations§
Source§impl Clone for CreateUserFluentBuilder
impl Clone for CreateUserFluentBuilder
Source§fn clone(&self) -> CreateUserFluentBuilder
fn clone(&self) -> CreateUserFluentBuilder
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 CreateUserFluentBuilder
impl !RefUnwindSafe for CreateUserFluentBuilder
impl Send for CreateUserFluentBuilder
impl Sync for CreateUserFluentBuilder
impl Unpin for CreateUserFluentBuilder
impl !UnwindSafe for CreateUserFluentBuilder
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> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
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 moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Returns self with the
fg()
set to
Color::BrightBlack.
§Example
println!("{}", value.bright_black());Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Returns self with the
fg()
set to
Color::BrightGreen.
§Example
println!("{}", value.bright_green());Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self with the
fg()
set to
Color::BrightYellow.
§Example
println!("{}", value.bright_yellow());Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Returns self with the
fg()
set to
Color::BrightMagenta.
§Example
println!("{}", value.bright_magenta());Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Returns self with the
fg()
set to
Color::BrightWhite.
§Example
println!("{}", value.bright_white());Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightBlack.
§Example
println!("{}", value.on_bright_black());Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightGreen.
§Example
println!("{}", value.on_bright_green());Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightYellow.
§Example
println!("{}", value.on_bright_yellow());Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightBlue.
§Example
println!("{}", value.on_bright_blue());Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightMagenta.
§Example
println!("{}", value.on_bright_magenta());Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightCyan.
§Example
println!("{}", value.on_bright_cyan());Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightWhite.
§Example
println!("{}", value.on_bright_white());Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self with the
attr()
set to
Attribute::Underline.
§Example
println!("{}", value.underline());Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self with the
attr()
set to
Attribute::RapidBlink.
§Example
println!("{}", value.rapid_blink());Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);