aws_sdk_iam/client/create_login_profile.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3 /// Constructs a fluent builder for the [`CreateLoginProfile`](crate::operation::create_login_profile::builders::CreateLoginProfileFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`user_name(impl Into<String>)`](crate::operation::create_login_profile::builders::CreateLoginProfileFluentBuilder::user_name) / [`set_user_name(Option<String>)`](crate::operation::create_login_profile::builders::CreateLoginProfileFluentBuilder::set_user_name):<br>required: **false**<br><p>The name of the IAM user to create a password for. The user must already exist.</p> <p>This parameter is optional. If no user name is included, it defaults to the principal making the request. When you make this request with root user credentials, you must use an <a href="https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRoot.html">AssumeRoot</a> session to omit the user name.</p> <p>This parameter allows (through its <a href="http://wikipedia.org/wiki/regex">regex pattern</a>) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-</p><br>
7 /// - [`password(impl Into<String>)`](crate::operation::create_login_profile::builders::CreateLoginProfileFluentBuilder::password) / [`set_password(Option<String>)`](crate::operation::create_login_profile::builders::CreateLoginProfileFluentBuilder::set_password):<br>required: **false**<br><p>The new password for the user.</p> <p>This parameter must be omitted when you make the request with an <a href="https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRoot.html">AssumeRoot</a> session. It is required in all other cases.</p> <p>The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> that is used to validate this parameter is a string of characters. That string can include almost any printable ASCII character from the space (<code>\u0020</code>) through the end of the ASCII character range (<code>\u00FF</code>). You can also include the tab (<code>\u0009</code>), line feed (<code>\u000A</code>), and carriage return (<code>\u000D</code>) characters. Any of these characters are valid in a password. However, many tools, such as the Amazon Web Services Management Console, might restrict the ability to type certain characters because they have special meaning within that tool.</p><br>
8 /// - [`password_reset_required(bool)`](crate::operation::create_login_profile::builders::CreateLoginProfileFluentBuilder::password_reset_required) / [`set_password_reset_required(Option<bool>)`](crate::operation::create_login_profile::builders::CreateLoginProfileFluentBuilder::set_password_reset_required):<br>required: **false**<br><p>Specifies whether the user is required to set a new password on next sign-in.</p><br>
9 /// - On success, responds with [`CreateLoginProfileOutput`](crate::operation::create_login_profile::CreateLoginProfileOutput) with field(s):
10 /// - [`login_profile(Option<LoginProfile>)`](crate::operation::create_login_profile::CreateLoginProfileOutput::login_profile): <p>A structure containing the user name and password create date.</p>
11 /// - On failure, responds with [`SdkError<CreateLoginProfileError>`](crate::operation::create_login_profile::CreateLoginProfileError)
12 pub fn create_login_profile(&self) -> crate::operation::create_login_profile::builders::CreateLoginProfileFluentBuilder {
13 crate::operation::create_login_profile::builders::CreateLoginProfileFluentBuilder::new(self.handle.clone())
14 }
15}